Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
POClassificationID | query | string | No | |
POClassificationIDStartsWith | query | string | No | |
POClassificationIDEndsWith | query | string | No | |
POClassificationIDContains | query | string | No | |
POClassificationIDLike | query | string | No | |
POClassificationIDBetween | query | string[] | No | |
POClassificationIDIn | query | string[] | No | |
Description | query | string | No | |
DescriptionStartsWith | query | string | No | |
DescriptionEndsWith | query | string | No | |
DescriptionContains | query | string | No | |
DescriptionLike | query | string | No | |
DescriptionBetween | query | string[] | No | |
DescriptionIn | query | string[] | No | |
PurchClassLedgerID | query | string | No | |
PurchClassLedgerIDStartsWith | query | string | No | |
PurchClassLedgerIDEndsWith | query | string | No | |
PurchClassLedgerIDContains | query | string | No | |
PurchClassLedgerIDLike | query | string | No | |
PurchClassLedgerIDBetween | query | string[] | No | |
PurchClassLedgerIDIn | query | string[] | No | |
DefaultClass | query | short? | No | |
DefaultClassGreaterThanOrEqualTo | query | short? | No | |
DefaultClassGreaterThan | query | short? | No | |
DefaultClassLessThan | query | short? | No | |
DefaultClassLessThanOrEqualTo | query | short? | No | |
DefaultClassNotEqualTo | query | short? | No | |
DefaultClassBetween | query | Nullable<Int16>[] | No | |
DefaultClassIn | query | Nullable<Int16>[] | No | |
LastSavedDateTime | query | DateTime? | No | |
LastSavedDateTimeGreaterThanOrEqualTo | query | DateTime? | No | |
LastSavedDateTimeGreaterThan | query | DateTime? | No | |
LastSavedDateTimeLessThan | query | DateTime? | No | |
LastSavedDateTimeLessThanOrEqualTo | query | DateTime? | No | |
LastSavedDateTimeNotEqualTo | query | DateTime? | No | |
LastSavedDateTimeBetween | query | Nullable<DateTime>[] | No | |
LastSavedDateTimeIn | query | Nullable<DateTime>[] | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Skip | form | int? | No | |
Take | form | int? | No | |
OrderBy | form | string | No | |
OrderByDesc | form | string | No | |
Include | form | string | No | |
Fields | form | string | No | |
Meta | form | Dictionary<string, string> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
POClassificationID | form | string | No | |
Description | form | string | No | |
PurchClassLedgerID | form | string | No | |
DefaultClass | form | short? | No | |
LastSavedDateTime | form | DateTime? | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Offset | form | int | No | |
Total | form | int | No | |
Results | form | List<T> | No | |
Meta | form | Dictionary<string, string> | No | |
ResponseStatus | form | ResponseStatus | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=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"}}}