Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
RunID | query | string | No | |
RunIDStartsWith | query | string | No | |
RunIDEndsWith | query | string | No | |
RunIDContains | query | string | No | |
RunIDLike | query | string | No | |
RunIDBetween | query | string[] | No | |
RunIDIn | query | string[] | 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 | |
RunBy | query | string | No | |
RunByStartsWith | query | string | No | |
RunByEndsWith | query | string | No | |
RunByContains | query | string | No | |
RunByLike | query | string | No | |
RunByBetween | query | string[] | No | |
RunByIn | query | string[] | No | |
RunNo | query | string | No | |
RunNoStartsWith | query | string | No | |
RunNoEndsWith | query | string | No | |
RunNoContains | query | string | No | |
RunNoLike | query | string | No | |
RunNoBetween | query | string[] | No | |
RunNoIn | 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 |
---|---|---|---|---|
RunID | form | string | No | |
LastSavedDateTime | form | DateTime | No | |
RunBy | form | string | No | |
RunNo | 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 .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /json/reply/SO_RunQuery HTTP/1.1
Host: api.jiwa.com.au
Accept: application/json
Content-Type: application/json
Content-Length: length
{"RunID":"String","RunIDStartsWith":"String","RunIDEndsWith":"String","RunIDContains":"String","RunIDLike":"String","RunIDBetween":["String"],"RunIDIn":["String"],"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"],"RunBy":"String","RunByStartsWith":"String","RunByEndsWith":"String","RunByContains":"String","RunByLike":"String","RunByBetween":["String"],"RunByIn":["String"],"RunNo":"String","RunNoStartsWith":"String","RunNoEndsWith":"String","RunNoContains":"String","RunNoLike":"String","RunNoBetween":["String"],"RunNoIn":["String"],"Skip":0,"Take":0,"OrderBy":"String","OrderByDesc":"String","Include":"String","Fields":"String","Meta":{"String":"String"}}
HTTP/1.1 200 OK Content-Type: application/json Content-Length: length {"Results":[{"RunID":"String","RunBy":"String","RunNo":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}