Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
PK | query | int? | No | |
PKGreaterThanOrEqualTo | query | int? | No | |
PKGreaterThan | query | int? | No | |
PKLessThan | query | int? | No | |
PKLessThanOrEqualTo | query | int? | No | |
PKNotEqualTo | query | int? | No | |
PKBetween | query | int[] | No | |
PKIn | query | int[] | No | |
DatabaseMajor | query | int? | No | |
DatabaseMajorGreaterThanOrEqualTo | query | int? | No | |
DatabaseMajorGreaterThan | query | int? | No | |
DatabaseMajorLessThan | query | int? | No | |
DatabaseMajorLessThanOrEqualTo | query | int? | No | |
DatabaseMajorNotEqualTo | query | int? | No | |
DatabaseMajorBetween | query | int[] | No | |
DatabaseMajorIn | query | int[] | No | |
DatabaseMinor | query | int? | No | |
DatabaseMinorGreaterThanOrEqualTo | query | int? | No | |
DatabaseMinorGreaterThan | query | int? | No | |
DatabaseMinorLessThan | query | int? | No | |
DatabaseMinorLessThanOrEqualTo | query | int? | No | |
DatabaseMinorNotEqualTo | query | int? | No | |
DatabaseMinorBetween | query | int[] | No | |
DatabaseMinorIn | query | int[] | No | |
DatabaseRelease | query | int? | No | |
DatabaseReleaseGreaterThanOrEqualTo | query | int? | No | |
DatabaseReleaseGreaterThan | query | int? | No | |
DatabaseReleaseLessThan | query | int? | No | |
DatabaseReleaseLessThanOrEqualTo | query | int? | No | |
DatabaseReleaseNotEqualTo | query | int? | No | |
DatabaseReleaseBetween | query | int[] | No | |
DatabaseReleaseIn | query | int[] | 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 |
---|---|---|---|---|
PK | form | int | No | |
DatabaseMajor | form | int | No | |
DatabaseMinor | form | int | No | |
DatabaseRelease | form | int | 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/SY_UpgradeLogQuery HTTP/1.1
Host: api.jiwa.com.au
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"PK":0,"PKGreaterThanOrEqualTo":0,"PKGreaterThan":0,"PKLessThan":0,"PKLessThanOrEqualTo":0,"PKNotEqualTo":0,"PKBetween":[0],"PKIn":[0],"DatabaseMajor":0,"DatabaseMajorGreaterThanOrEqualTo":0,"DatabaseMajorGreaterThan":0,"DatabaseMajorLessThan":0,"DatabaseMajorLessThanOrEqualTo":0,"DatabaseMajorNotEqualTo":0,"DatabaseMajorBetween":[0],"DatabaseMajorIn":[0],"DatabaseMinor":0,"DatabaseMinorGreaterThanOrEqualTo":0,"DatabaseMinorGreaterThan":0,"DatabaseMinorLessThan":0,"DatabaseMinorLessThanOrEqualTo":0,"DatabaseMinorNotEqualTo":0,"DatabaseMinorBetween":[0],"DatabaseMinorIn":[0],"DatabaseRelease":0,"DatabaseReleaseGreaterThanOrEqualTo":0,"DatabaseReleaseGreaterThan":0,"DatabaseReleaseLessThan":0,"DatabaseReleaseLessThanOrEqualTo":0,"DatabaseReleaseNotEqualTo":0,"DatabaseReleaseBetween":[0],"DatabaseReleaseIn":[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":[{}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}