| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| RecID | query | string | No | |
| RecIDStartsWith | query | string | No | |
| RecIDEndsWith | query | string | No | |
| RecIDContains | query | string | No | |
| RecIDLike | query | string | No | |
| RecIDBetween | query | string[] | No | |
| RecIDIn | query | string[] | No | |
| DialogNo | query | int? | No | |
| DialogNoGreaterThanOrEqualTo | query | int? | No | |
| DialogNoGreaterThan | query | int? | No | |
| DialogNoLessThan | query | int? | No | |
| DialogNoLessThanOrEqualTo | query | int? | No | |
| DialogNoNotEqualTo | query | int? | No | |
| DialogNoBetween | query | Nullable<Int32>[] | No | |
| DialogNoIn | query | Nullable<Int32>[] | No | |
| AssemblyName | query | string | No | |
| AssemblyNameStartsWith | query | string | No | |
| AssemblyNameEndsWith | query | string | No | |
| AssemblyNameContains | query | string | No | |
| AssemblyNameLike | query | string | No | |
| AssemblyNameBetween | query | string[] | No | |
| AssemblyNameIn | query | string[] | No | |
| ClassName | query | string | No | |
| ClassNameStartsWith | query | string | No | |
| ClassNameEndsWith | query | string | No | |
| ClassNameContains | query | string | No | |
| ClassNameLike | query | string | No | |
| ClassNameBetween | query | string[] | No | |
| ClassNameIn | query | string[] | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Skip | form | int? | No | |
| Take | form | int? | No | |
| OrderBy | form | string | No | |
| OrderByDesc | form | string | No | |
| Include | form | string | No | |
| Fields | form | string | No | |
| Meta | form | Dictionary<string, string> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| RecID | form | string | No | |
| DialogNo | form | int? | No | |
| AssemblyName | form | string | No | |
| ClassName | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Offset | form | int | No | |
| Total | form | int | No | |
| Results | form | List<T> | No | |
| Meta | form | Dictionary<string, string> | No | |
| ResponseStatus | form | ResponseStatus | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /csv/reply/SY_DialogsQuery HTTP/1.1
Host: api.jiwa.com.au
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"RecID":"String","RecIDStartsWith":"String","RecIDEndsWith":"String","RecIDContains":"String","RecIDLike":"String","RecIDBetween":["String"],"RecIDIn":["String"],"DialogNo":0,"DialogNoGreaterThanOrEqualTo":0,"DialogNoGreaterThan":0,"DialogNoLessThan":0,"DialogNoLessThanOrEqualTo":0,"DialogNoNotEqualTo":0,"DialogNoBetween":[0],"DialogNoIn":[0],"AssemblyName":"String","AssemblyNameStartsWith":"String","AssemblyNameEndsWith":"String","AssemblyNameContains":"String","AssemblyNameLike":"String","AssemblyNameBetween":["String"],"AssemblyNameIn":["String"],"ClassName":"String","ClassNameStartsWith":"String","ClassNameEndsWith":"String","ClassNameContains":"String","ClassNameLike":"String","ClassNameBetween":["String"],"ClassNameIn":["String"],"Skip":0,"Take":0,"OrderBy":"String","OrderByDesc":"String","Include":"String","Fields":"String","Meta":{"String":"String"}}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"Results":[{"RecID":"String","DialogNo":0,"AssemblyName":"String","ClassName":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}