| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| RecID | query | Guid? | No | |
| RecIDIn | query | Guid[] | No | |
| Name | query | string | No | |
| NameStartsWith | query | string | No | |
| NameEndsWith | query | string | No | |
| NameContains | query | string | No | |
| NameLike | query | string | No | |
| NameBetween | query | string[] | No | |
| NameIn | 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 | |
| LogRetentionDays | query | int? | No | |
| LogRetentionDaysGreaterThanOrEqualTo | query | int? | No | |
| LogRetentionDaysGreaterThan | query | int? | No | |
| LogRetentionDaysLessThan | query | int? | No | |
| LogRetentionDaysLessThanOrEqualTo | query | int? | No | |
| LogRetentionDaysNotEqualTo | query | int? | No | |
| LogRetentionDaysBetween | query | int[] | No | |
| LogRetentionDaysIn | query | int[] | No | |
| CompletedQueueRetentionDays | query | int? | No | |
| CompletedQueueRetentionDaysGreaterThanOrEqualTo | query | int? | No | |
| CompletedQueueRetentionDaysGreaterThan | query | int? | No | |
| CompletedQueueRetentionDaysLessThan | query | int? | No | |
| CompletedQueueRetentionDaysLessThanOrEqualTo | query | int? | No | |
| CompletedQueueRetentionDaysNotEqualTo | query | int? | No | |
| CompletedQueueRetentionDaysBetween | query | int[] | No | |
| CompletedQueueRetentionDaysIn | query | int[] | 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 | DateTime[] | No | |
| LastSavedDateTimeIn | query | DateTime[] | 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 | |
| Name | form | string | No | |
| Description | form | string | No | |
| LogRetentionDays | form | int | No | |
| CompletedQueueRetentionDays | form | int | No | |
| LastSavedDateTime | form | DateTime | 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_IntegrationQuery 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"],"Name":"String","NameStartsWith":"String","NameEndsWith":"String","NameContains":"String","NameLike":"String","NameBetween":["String"],"NameIn":["String"],"Description":"String","DescriptionStartsWith":"String","DescriptionEndsWith":"String","DescriptionContains":"String","DescriptionLike":"String","DescriptionBetween":["String"],"DescriptionIn":["String"],"LogRetentionDays":0,"LogRetentionDaysGreaterThanOrEqualTo":0,"LogRetentionDaysGreaterThan":0,"LogRetentionDaysLessThan":0,"LogRetentionDaysLessThanOrEqualTo":0,"LogRetentionDaysNotEqualTo":0,"LogRetentionDaysBetween":[0],"LogRetentionDaysIn":[0],"CompletedQueueRetentionDays":0,"CompletedQueueRetentionDaysGreaterThanOrEqualTo":0,"CompletedQueueRetentionDaysGreaterThan":0,"CompletedQueueRetentionDaysLessThan":0,"CompletedQueueRetentionDaysLessThanOrEqualTo":0,"CompletedQueueRetentionDaysNotEqualTo":0,"CompletedQueueRetentionDaysBetween":[0],"CompletedQueueRetentionDaysIn":[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"],"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":[{"Name":"String","Description":"String","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"}}}