JiwaAPI

<back to all web services

GL_SegmentConfigurationQuery

Requires Authentication
GL_SegmentConfigurationQuery Parameters:
NameParameterData TypeRequiredDescription
RecIDquerystringNo
RecIDStartsWithquerystringNo
RecIDEndsWithquerystringNo
RecIDContainsquerystringNo
RecIDLikequerystringNo
RecIDBetweenquerystring[]No
RecIDInquerystring[]No
SegmentNoqueryshort?No
SegmentNoGreaterThanOrEqualToqueryshort?No
SegmentNoGreaterThanqueryshort?No
SegmentNoLessThanqueryshort?No
SegmentNoLessThanOrEqualToqueryshort?No
SegmentNoNotEqualToqueryshort?No
SegmentNoBetweenqueryNullable<Int16>[]No
SegmentNoInqueryNullable<Int16>[]No
NamequerystringNo
NameStartsWithquerystringNo
NameEndsWithquerystringNo
NameContainsquerystringNo
NameLikequerystringNo
NameBetweenquerystring[]No
NameInquerystring[]No
SegmentLengthqueryshort?No
SegmentLengthGreaterThanOrEqualToqueryshort?No
SegmentLengthGreaterThanqueryshort?No
SegmentLengthLessThanqueryshort?No
SegmentLengthLessThanOrEqualToqueryshort?No
SegmentLengthNotEqualToqueryshort?No
SegmentLengthBetweenqueryNullable<Int16>[]No
SegmentLengthInqueryNullable<Int16>[]No
SegmentTypequeryshort?No
SegmentTypeGreaterThanOrEqualToqueryshort?No
SegmentTypeGreaterThanqueryshort?No
SegmentTypeLessThanqueryshort?No
SegmentTypeLessThanOrEqualToqueryshort?No
SegmentTypeNotEqualToqueryshort?No
SegmentTypeBetweenqueryNullable<Int16>[]No
SegmentTypeInqueryNullable<Int16>[]No
RowHashquerybyte[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
GL_SegmentConfiguration Parameters:
NameParameterData TypeRequiredDescription
RecIDformstringNo
SegmentNoformshort?No
NameformstringNo
SegmentLengthformshort?No
SegmentTypeformshort?No
RowHashformbyte[]No
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 .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /json/reply/GL_SegmentConfigurationQuery HTTP/1.1 
Host: api.jiwa.com.au 
Accept: application/json
Content-Type: application/json
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: application/json
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"}}}