Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
RecID | query | string | No | |
RecIDStartsWith | query | string | No | |
RecIDEndsWith | query | string | No | |
RecIDContains | query | string | No | |
RecIDLike | query | string | No | |
RecIDBetween | query | string[] | No | |
RecIDIn | 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 | |
ListOfSalesOrdersToProcessStoredProcedure | query | string | No | |
ListOfSalesOrdersToProcessStoredProcedureStartsWith | query | string | No | |
ListOfSalesOrdersToProcessStoredProcedureEndsWith | query | string | No | |
ListOfSalesOrdersToProcessStoredProcedureContains | query | string | No | |
ListOfSalesOrdersToProcessStoredProcedureLike | query | string | No | |
ListOfSalesOrdersToProcessStoredProcedureBetween | query | string[] | No | |
ListOfSalesOrdersToProcessStoredProcedureIn | query | string[] | No | |
PostProcessingStoredProcedure | query | string | No | |
PostProcessingStoredProcedureStartsWith | query | string | No | |
PostProcessingStoredProcedureEndsWith | query | string | No | |
PostProcessingStoredProcedureContains | query | string | No | |
PostProcessingStoredProcedureLike | query | string | No | |
PostProcessingStoredProcedureBetween | query | string[] | No | |
PostProcessingStoredProcedureIn | query | string[] | 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 |
---|---|---|---|---|
RecID | form | string | No | |
Description | form | string | No | |
ListOfSalesOrdersToProcessStoredProcedure | form | string | No | |
PostProcessingStoredProcedure | form | string | 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/SO_BatchProcessTypesQuery HTTP/1.1
Host: api.jiwa.com.au
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"RecID":"String","RecIDStartsWith":"String","RecIDEndsWith":"String","RecIDContains":"String","RecIDLike":"String","RecIDBetween":["String"],"RecIDIn":["String"],"Description":"String","DescriptionStartsWith":"String","DescriptionEndsWith":"String","DescriptionContains":"String","DescriptionLike":"String","DescriptionBetween":["String"],"DescriptionIn":["String"],"ListOfSalesOrdersToProcessStoredProcedure":"String","ListOfSalesOrdersToProcessStoredProcedureStartsWith":"String","ListOfSalesOrdersToProcessStoredProcedureEndsWith":"String","ListOfSalesOrdersToProcessStoredProcedureContains":"String","ListOfSalesOrdersToProcessStoredProcedureLike":"String","ListOfSalesOrdersToProcessStoredProcedureBetween":["String"],"ListOfSalesOrdersToProcessStoredProcedureIn":["String"],"PostProcessingStoredProcedure":"String","PostProcessingStoredProcedureStartsWith":"String","PostProcessingStoredProcedureEndsWith":"String","PostProcessingStoredProcedureContains":"String","PostProcessingStoredProcedureLike":"String","PostProcessingStoredProcedureBetween":["String"],"PostProcessingStoredProcedureIn":["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":[{"RecID":"String","Description":"String","ListOfSalesOrdersToProcessStoredProcedure":"String","PostProcessingStoredProcedure":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}