| 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 | |
| SegmentNo | query | short? | No | |
| SegmentNoGreaterThanOrEqualTo | query | short? | No | |
| SegmentNoGreaterThan | query | short? | No | |
| SegmentNoLessThan | query | short? | No | |
| SegmentNoLessThanOrEqualTo | query | short? | No | |
| SegmentNoNotEqualTo | query | short? | No | |
| SegmentNoBetween | query | Nullable<Int16>[] | No | |
| SegmentNoIn | query | Nullable<Int16>[] | No | |
| Name | query | string | No | |
| NameStartsWith | query | string | No | |
| NameEndsWith | query | string | No | |
| NameContains | query | string | No | |
| NameLike | query | string | No | |
| NameBetween | query | string[] | No | |
| NameIn | query | string[] | No | |
| SegmentLength | query | short? | No | |
| SegmentLengthGreaterThanOrEqualTo | query | short? | No | |
| SegmentLengthGreaterThan | query | short? | No | |
| SegmentLengthLessThan | query | short? | No | |
| SegmentLengthLessThanOrEqualTo | query | short? | No | |
| SegmentLengthNotEqualTo | query | short? | No | |
| SegmentLengthBetween | query | Nullable<Int16>[] | No | |
| SegmentLengthIn | query | Nullable<Int16>[] | No | |
| SegmentType | query | short? | No | |
| SegmentTypeGreaterThanOrEqualTo | query | short? | No | |
| SegmentTypeGreaterThan | query | short? | No | |
| SegmentTypeLessThan | query | short? | No | |
| SegmentTypeLessThanOrEqualTo | query | short? | No | |
| SegmentTypeNotEqualTo | query | short? | No | |
| SegmentTypeBetween | query | Nullable<Int16>[] | No | |
| SegmentTypeIn | query | Nullable<Int16>[] | No | |
| RowHash | query | byte[] | 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 | |
| SegmentNo | form | short? | No | |
| Name | form | string | No | |
| SegmentLength | form | short? | No | |
| SegmentType | form | short? | No | |
| RowHash | form | byte[] | 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/GL_SegmentConfigurationQuery 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"],"SegmentNo":0,"SegmentNoGreaterThanOrEqualTo":0,"SegmentNoGreaterThan":0,"SegmentNoLessThan":0,"SegmentNoLessThanOrEqualTo":0,"SegmentNoNotEqualTo":0,"SegmentNoBetween":[0],"SegmentNoIn":[0],"Name":"String","NameStartsWith":"String","NameEndsWith":"String","NameContains":"String","NameLike":"String","NameBetween":["String"],"NameIn":["String"],"SegmentLength":0,"SegmentLengthGreaterThanOrEqualTo":0,"SegmentLengthGreaterThan":0,"SegmentLengthLessThan":0,"SegmentLengthLessThanOrEqualTo":0,"SegmentLengthNotEqualTo":0,"SegmentLengthBetween":[0],"SegmentLengthIn":[0],"SegmentType":0,"SegmentTypeGreaterThanOrEqualTo":0,"SegmentTypeGreaterThan":0,"SegmentTypeLessThan":0,"SegmentTypeLessThanOrEqualTo":0,"SegmentTypeNotEqualTo":0,"SegmentTypeBetween":[0],"SegmentTypeIn":[0],"RowHash":"AA==","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","SegmentNo":0,"Name":"String","SegmentLength":0,"SegmentType":0,"RowHash":"AA=="}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}