JiwaAPI

<back to all web services

v_GL_Segment1Query

Requires Authentication
v_GL_Segment1Query Parameters:
NameParameterData TypeRequiredDescription
Seg1querystringNo
Seg1StartsWithquerystringNo
Seg1EndsWithquerystringNo
Seg1ContainsquerystringNo
Seg1LikequerystringNo
Seg1Betweenquerystring[]No
Seg1Inquerystring[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
v_GL_Segment1 Parameters:
NameParameterData TypeRequiredDescription
Seg1formstringNo
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/v_GL_Segment1Query HTTP/1.1 
Host: api.jiwa.com.au 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"Seg1":"String","Seg1StartsWith":"String","Seg1EndsWith":"String","Seg1Contains":"String","Seg1Like":"String","Seg1Between":["String"],"Seg1In":["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":[{"Seg1":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}