JiwaAPI

<back to all web services

V_G_CategoryQuery

Requires Authentication
V_G_CategoryQuery Parameters:
NameParameterData TypeRequiredDescription
GLCategoryIDquerystringNo
GLCategoryIDStartsWithquerystringNo
GLCategoryIDEndsWithquerystringNo
GLCategoryIDContainsquerystringNo
GLCategoryIDLikequerystringNo
GLCategoryIDBetweenquerystring[]No
GLCategoryIDInquerystring[]No
DescriptionquerystringNo
DescriptionStartsWithquerystringNo
DescriptionEndsWithquerystringNo
DescriptionContainsquerystringNo
DescriptionLikequerystringNo
DescriptionBetweenquerystring[]No
DescriptionInquerystring[]No
Group1querystringNo
Group1StartsWithquerystringNo
Group1EndsWithquerystringNo
Group1ContainsquerystringNo
Group1LikequerystringNo
Group1Betweenquerystring[]No
Group1Inquerystring[]No
ExpSignquerystringNo
ExpSignStartsWithquerystringNo
ExpSignEndsWithquerystringNo
ExpSignContainsquerystringNo
ExpSignLikequerystringNo
ExpSignBetweenquerystring[]No
ExpSignInquerystring[]No
AccTypequerystringNo
AccTypeStartsWithquerystringNo
AccTypeEndsWithquerystringNo
AccTypeContainsquerystringNo
AccTypeLikequerystringNo
AccTypeBetweenquerystring[]No
AccTypeInquerystring[]No
Group2querystringNo
Group2StartsWithquerystringNo
Group2EndsWithquerystringNo
Group2ContainsquerystringNo
Group2LikequerystringNo
Group2Betweenquerystring[]No
Group2Inquerystring[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
V_G_Category Parameters:
NameParameterData TypeRequiredDescription
GLCategoryIDformstringNo
DescriptionformstringNo
Group1formstringNo
ExpSignformstringNo
AccTypeformstringNo
Group2formstringNo
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_G_CategoryQuery HTTP/1.1 
Host: api.jiwa.com.au 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"GLCategoryID":"String","GLCategoryIDStartsWith":"String","GLCategoryIDEndsWith":"String","GLCategoryIDContains":"String","GLCategoryIDLike":"String","GLCategoryIDBetween":["String"],"GLCategoryIDIn":["String"],"Description":"String","DescriptionStartsWith":"String","DescriptionEndsWith":"String","DescriptionContains":"String","DescriptionLike":"String","DescriptionBetween":["String"],"DescriptionIn":["String"],"Group1":"String","Group1StartsWith":"String","Group1EndsWith":"String","Group1Contains":"String","Group1Like":"String","Group1Between":["String"],"Group1In":["String"],"ExpSign":"String","ExpSignStartsWith":"String","ExpSignEndsWith":"String","ExpSignContains":"String","ExpSignLike":"String","ExpSignBetween":["String"],"ExpSignIn":["String"],"AccType":"String","AccTypeStartsWith":"String","AccTypeEndsWith":"String","AccTypeContains":"String","AccTypeLike":"String","AccTypeBetween":["String"],"AccTypeIn":["String"],"Group2":"String","Group2StartsWith":"String","Group2EndsWith":"String","Group2Contains":"String","Group2Like":"String","Group2Between":["String"],"Group2In":["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":[{"GLCategoryID":"String","Description":"String","Group1":"String","ExpSign":"String","AccType":"String","Group2":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}