JiwaAPI

<back to all web services

GL_SegmentsQuery

Requires Authentication
GL_SegmentsQuery Parameters:
NameParameterData TypeRequiredDescription
GLSegmentIDquerystringNo
GLSegmentIDStartsWithquerystringNo
GLSegmentIDEndsWithquerystringNo
GLSegmentIDContainsquerystringNo
GLSegmentIDLikequerystringNo
GLSegmentIDBetweenquerystring[]No
GLSegmentIDInquerystring[]No
LastSavedDateTimequeryDateTime?No
LastSavedDateTimeGreaterThanOrEqualToqueryDateTime?No
LastSavedDateTimeGreaterThanqueryDateTime?No
LastSavedDateTimeLessThanqueryDateTime?No
LastSavedDateTimeLessThanOrEqualToqueryDateTime?No
LastSavedDateTimeNotEqualToqueryDateTime?No
LastSavedDateTimeBetweenqueryNullable<DateTime>[]No
LastSavedDateTimeInqueryNullable<DateTime>[]No
SegmentNoqueryshort?No
SegmentNoGreaterThanOrEqualToqueryshort?No
SegmentNoGreaterThanqueryshort?No
SegmentNoLessThanqueryshort?No
SegmentNoLessThanOrEqualToqueryshort?No
SegmentNoNotEqualToqueryshort?No
SegmentNoBetweenqueryshort[]No
SegmentNoInqueryshort[]No
SegContentsquerystringNo
SegContentsStartsWithquerystringNo
SegContentsEndsWithquerystringNo
SegContentsContainsquerystringNo
SegContentsLikequerystringNo
SegContentsBetweenquerystring[]No
SegContentsInquerystring[]No
SegContentsDescquerystringNo
SegContentsDescStartsWithquerystringNo
SegContentsDescEndsWithquerystringNo
SegContentsDescContainsquerystringNo
SegContentsDescLikequerystringNo
SegContentsDescBetweenquerystring[]No
SegContentsDescInquerystring[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
GL_Segments Parameters:
NameParameterData TypeRequiredDescription
GLSegmentIDformstringNo
LastSavedDateTimeformDateTime?No
SegmentNoformshortNo
SegContentsformstringNo
SegContentsDescformstringNo
QueryResponse<T> Parameters:
NameParameterData TypeRequiredDescription
OffsetformintNo
TotalformintNo
ResultsformList<T>No
MetaformDictionary<string, string>No
ResponseStatusformResponseStatusNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + 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"}}}