JiwaAPI

<back to all web services

PO_ClassificationQuery

Requires Authentication
PO_ClassificationQuery Parameters:
NameParameterData TypeRequiredDescription
POClassificationIDquerystringNo
POClassificationIDStartsWithquerystringNo
POClassificationIDEndsWithquerystringNo
POClassificationIDContainsquerystringNo
POClassificationIDLikequerystringNo
POClassificationIDBetweenquerystring[]No
POClassificationIDInquerystring[]No
DescriptionquerystringNo
DescriptionStartsWithquerystringNo
DescriptionEndsWithquerystringNo
DescriptionContainsquerystringNo
DescriptionLikequerystringNo
DescriptionBetweenquerystring[]No
DescriptionInquerystring[]No
PurchClassLedgerIDquerystringNo
PurchClassLedgerIDStartsWithquerystringNo
PurchClassLedgerIDEndsWithquerystringNo
PurchClassLedgerIDContainsquerystringNo
PurchClassLedgerIDLikequerystringNo
PurchClassLedgerIDBetweenquerystring[]No
PurchClassLedgerIDInquerystring[]No
DefaultClassqueryshort?No
DefaultClassGreaterThanOrEqualToqueryshort?No
DefaultClassGreaterThanqueryshort?No
DefaultClassLessThanqueryshort?No
DefaultClassLessThanOrEqualToqueryshort?No
DefaultClassNotEqualToqueryshort?No
DefaultClassBetweenqueryNullable<Int16>[]No
DefaultClassInqueryNullable<Int16>[]No
LastSavedDateTimequeryDateTime?No
LastSavedDateTimeGreaterThanOrEqualToqueryDateTime?No
LastSavedDateTimeGreaterThanqueryDateTime?No
LastSavedDateTimeLessThanqueryDateTime?No
LastSavedDateTimeLessThanOrEqualToqueryDateTime?No
LastSavedDateTimeNotEqualToqueryDateTime?No
LastSavedDateTimeBetweenqueryNullable<DateTime>[]No
LastSavedDateTimeInqueryNullable<DateTime>[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
PO_Classification Parameters:
NameParameterData TypeRequiredDescription
POClassificationIDformstringNo
DescriptionformstringNo
PurchClassLedgerIDformstringNo
DefaultClassformshort?No
LastSavedDateTimeformDateTime?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 .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/PO_ClassificationQuery HTTP/1.1 
Host: api.jiwa.com.au 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"POClassificationID":"String","POClassificationIDStartsWith":"String","POClassificationIDEndsWith":"String","POClassificationIDContains":"String","POClassificationIDLike":"String","POClassificationIDBetween":["String"],"POClassificationIDIn":["String"],"Description":"String","DescriptionStartsWith":"String","DescriptionEndsWith":"String","DescriptionContains":"String","DescriptionLike":"String","DescriptionBetween":["String"],"DescriptionIn":["String"],"PurchClassLedgerID":"String","PurchClassLedgerIDStartsWith":"String","PurchClassLedgerIDEndsWith":"String","PurchClassLedgerIDContains":"String","PurchClassLedgerIDLike":"String","PurchClassLedgerIDBetween":["String"],"PurchClassLedgerIDIn":["String"],"DefaultClass":0,"DefaultClassGreaterThanOrEqualTo":0,"DefaultClassGreaterThan":0,"DefaultClassLessThan":0,"DefaultClassLessThanOrEqualTo":0,"DefaultClassNotEqualTo":0,"DefaultClassBetween":[0],"DefaultClassIn":[0],"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"],"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":[{"POClassificationID":"String","Description":"String","PurchClassLedgerID":"String","DefaultClass":0,"LastSavedDateTime":"0001-01-01T00:00:00.0000000"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}