JiwaAPI

<back to all web services

v_GL_Segment5Query

Requires Authentication
v_GL_Segment5Query Parameters:
NameParameterData TypeRequiredDescription
Seg5querystringNo
Seg5StartsWithquerystringNo
Seg5EndsWithquerystringNo
Seg5ContainsquerystringNo
Seg5LikequerystringNo
Seg5Betweenquerystring[]No
Seg5Inquerystring[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
v_GL_Segment5 Parameters:
NameParameterData TypeRequiredDescription
Seg5formstringNo
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_Segment5Query HTTP/1.1 
Host: api.jiwa.com.au 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"Seg5":"String","Seg5StartsWith":"String","Seg5EndsWith":"String","Seg5Contains":"String","Seg5Like":"String","Seg5Between":["String"],"Seg5In":["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":[{"Seg5":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}