| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| RecID | query | Guid? | No | |
| RecIDIn | query | Guid[] | No | |
| Magento_Integration_RecID | query | Guid? | No | |
| Magento_Integration_RecIDIn | query | Guid[] | No | |
| Action_RecID | query | Guid? | No | |
| Action_RecIDIn | query | Guid[] | No | |
| ExceptionPolicy | query | short? | No | |
| ExceptionPolicyGreaterThanOrEqualTo | query | short? | No | |
| ExceptionPolicyGreaterThan | query | short? | No | |
| ExceptionPolicyLessThan | query | short? | No | |
| ExceptionPolicyLessThanOrEqualTo | query | short? | No | |
| ExceptionPolicyNotEqualTo | query | short? | No | |
| ExceptionPolicyBetween | query | short[] | No | |
| ExceptionPolicyIn | query | short[] | No | |
| LogPolicy | query | short? | No | |
| LogPolicyGreaterThanOrEqualTo | query | short? | No | |
| LogPolicyGreaterThan | query | short? | No | |
| LogPolicyLessThan | query | short? | No | |
| LogPolicyLessThanOrEqualTo | query | short? | No | |
| LogPolicyNotEqualTo | query | short? | No | |
| LogPolicyBetween | query | short[] | No | |
| LogPolicyIn | query | short[] | No | |
| ItemNo | query | int? | No | |
| ItemNoGreaterThanOrEqualTo | query | int? | No | |
| ItemNoGreaterThan | query | int? | No | |
| ItemNoLessThan | query | int? | No | |
| ItemNoLessThanOrEqualTo | query | int? | No | |
| ItemNoNotEqualTo | query | int? | No | |
| ItemNoBetween | query | int[] | No | |
| ItemNoIn | query | int[] | No | |
| RowHash | query | byte[] | 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 | Guid | No | |
| Magento_Integration_RecID | form | Guid | No | |
| Action_RecID | form | Guid | No | |
| ExceptionPolicy | form | short | No | |
| LogPolicy | form | short | No | |
| ItemNo | form | int | No | |
| RowHash | form | byte[] | 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/Magento_Integration_SelectedActionQuery HTTP/1.1
Host: api.jiwa.com.au
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"RecID":"00000000000000000000000000000000","RecIDIn":["00000000-0000-0000-0000-000000000000"],"Magento_Integration_RecID":"00000000000000000000000000000000","Magento_Integration_RecIDIn":["00000000-0000-0000-0000-000000000000"],"Action_RecID":"00000000000000000000000000000000","Action_RecIDIn":["00000000-0000-0000-0000-000000000000"],"ExceptionPolicy":0,"ExceptionPolicyGreaterThanOrEqualTo":0,"ExceptionPolicyGreaterThan":0,"ExceptionPolicyLessThan":0,"ExceptionPolicyLessThanOrEqualTo":0,"ExceptionPolicyNotEqualTo":0,"ExceptionPolicyBetween":[0],"ExceptionPolicyIn":[0],"LogPolicy":0,"LogPolicyGreaterThanOrEqualTo":0,"LogPolicyGreaterThan":0,"LogPolicyLessThan":0,"LogPolicyLessThanOrEqualTo":0,"LogPolicyNotEqualTo":0,"LogPolicyBetween":[0],"LogPolicyIn":[0],"ItemNo":0,"ItemNoGreaterThanOrEqualTo":0,"ItemNoGreaterThan":0,"ItemNoLessThan":0,"ItemNoLessThanOrEqualTo":0,"ItemNoNotEqualTo":0,"ItemNoBetween":[0],"ItemNoIn":[0],"RowHash":"AA==","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":[{"RowHash":"AA=="}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}