| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| DebtorID | query | string | No | |
| DebtorIDStartsWith | query | string | No | |
| DebtorIDEndsWith | query | string | No | |
| DebtorIDContains | query | string | No | |
| DebtorIDLike | query | string | No | |
| DebtorIDBetween | query | string[] | No | |
| DebtorIDIn | query | string[] | No | |
| SpecialHoursTotal | query | decimal? | No | |
| SpecialHoursTotalGreaterThanOrEqualTo | query | decimal? | No | |
| SpecialHoursTotalGreaterThan | query | decimal? | No | |
| SpecialHoursTotalLessThan | query | decimal? | No | |
| SpecialHoursTotalLessThanOrEqualTo | query | decimal? | No | |
| SpecialHoursTotalNotEqualTo | query | decimal? | No | |
| SpecialHoursTotalBetween | query | Nullable<Decimal>[] | No | |
| SpecialHoursTotalIn | query | Nullable<Decimal>[] | 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 |
|---|---|---|---|---|
| DebtorID | form | string | No | |
| SpecialHoursTotal | form | decimal? | 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/v_SupportPackSpecialHoursTotalByDebtorQuery HTTP/1.1
Host: api.jiwa.com.au
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"DebtorID":"String","DebtorIDStartsWith":"String","DebtorIDEndsWith":"String","DebtorIDContains":"String","DebtorIDLike":"String","DebtorIDBetween":["String"],"DebtorIDIn":["String"],"SpecialHoursTotal":0,"SpecialHoursTotalGreaterThanOrEqualTo":0,"SpecialHoursTotalGreaterThan":0,"SpecialHoursTotalLessThan":0,"SpecialHoursTotalLessThanOrEqualTo":0,"SpecialHoursTotalNotEqualTo":0,"SpecialHoursTotalBetween":[0],"SpecialHoursTotalIn":[0],"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":[{"DebtorID":"String","SpecialHoursTotal":0}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}