| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| GLSegmentID | query | string | No | |
| GLSegmentIDStartsWith | query | string | No | |
| GLSegmentIDEndsWith | query | string | No | |
| GLSegmentIDContains | query | string | No | |
| GLSegmentIDLike | query | string | No | |
| GLSegmentIDBetween | query | string[] | No | |
| GLSegmentIDIn | query | string[] | No | |
| LastSavedDateTime | query | DateTime? | No | |
| LastSavedDateTimeGreaterThanOrEqualTo | query | DateTime? | No | |
| LastSavedDateTimeGreaterThan | query | DateTime? | No | |
| LastSavedDateTimeLessThan | query | DateTime? | No | |
| LastSavedDateTimeLessThanOrEqualTo | query | DateTime? | No | |
| LastSavedDateTimeNotEqualTo | query | DateTime? | No | |
| LastSavedDateTimeBetween | query | Nullable<DateTime>[] | No | |
| LastSavedDateTimeIn | query | Nullable<DateTime>[] | 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 | short[] | No | |
| SegmentNoIn | query | short[] | No | |
| SegContents | query | string | No | |
| SegContentsStartsWith | query | string | No | |
| SegContentsEndsWith | query | string | No | |
| SegContentsContains | query | string | No | |
| SegContentsLike | query | string | No | |
| SegContentsBetween | query | string[] | No | |
| SegContentsIn | query | string[] | No | |
| SegContentsDesc | query | string | No | |
| SegContentsDescStartsWith | query | string | No | |
| SegContentsDescEndsWith | query | string | No | |
| SegContentsDescContains | query | string | No | |
| SegContentsDescLike | query | string | No | |
| SegContentsDescBetween | query | string[] | No | |
| SegContentsDescIn | 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 |
|---|---|---|---|---|
| GLSegmentID | form | string | No | |
| LastSavedDateTime | form | DateTime? | No | |
| SegmentNo | form | short | No | |
| SegContents | form | string | No | |
| SegContentsDesc | 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/GL_SegmentsQuery HTTP/1.1
Host: api.jiwa.com.au
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"GLSegmentID":"String","GLSegmentIDStartsWith":"String","GLSegmentIDEndsWith":"String","GLSegmentIDContains":"String","GLSegmentIDLike":"String","GLSegmentIDBetween":["String"],"GLSegmentIDIn":["String"],"LastSavedDateTime":"0001-01-01T00:00:00.0000000","LastSavedDateTimeGreaterThanOrEqualTo":"0001-01-01T00:00:00.0000000","LastSavedDateTimeGreaterThan":"0001-01-01T00:00:00.0000000","LastSavedDateTimeLessThan":"0001-01-01T00:00:00.0000000","LastSavedDateTimeLessThanOrEqualTo":"0001-01-01T00:00:00.0000000","LastSavedDateTimeNotEqualTo":"0001-01-01T00:00:00.0000000","LastSavedDateTimeBetween":["0001-01-01T00:00:00.0000000"],"LastSavedDateTimeIn":["0001-01-01T00:00:00.0000000"],"SegmentNo":0,"SegmentNoGreaterThanOrEqualTo":0,"SegmentNoGreaterThan":0,"SegmentNoLessThan":0,"SegmentNoLessThanOrEqualTo":0,"SegmentNoNotEqualTo":0,"SegmentNoBetween":[0],"SegmentNoIn":[0],"SegContents":"String","SegContentsStartsWith":"String","SegContentsEndsWith":"String","SegContentsContains":"String","SegContentsLike":"String","SegContentsBetween":["String"],"SegContentsIn":["String"],"SegContentsDesc":"String","SegContentsDescStartsWith":"String","SegContentsDescEndsWith":"String","SegContentsDescContains":"String","SegContentsDescLike":"String","SegContentsDescBetween":["String"],"SegContentsDescIn":["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":[{"GLSegmentID":"String","LastSavedDateTime":"0001-01-01T00:00:00.0000000","SegContents":"String","SegContentsDesc":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}