| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| IN_LogicalID | query | string | No | |
| IN_LogicalIDStartsWith | query | string | No | |
| IN_LogicalIDEndsWith | query | string | No | |
| IN_LogicalIDContains | query | string | No | |
| IN_LogicalIDLike | query | string | No | |
| IN_LogicalIDBetween | query | string[] | No | |
| IN_LogicalIDIn | query | string[] | No | |
| IN_PhysicalID | query | string | No | |
| IN_PhysicalIDStartsWith | query | string | No | |
| IN_PhysicalIDEndsWith | query | string | No | |
| IN_PhysicalIDContains | query | string | No | |
| IN_PhysicalIDLike | query | string | No | |
| IN_PhysicalIDBetween | query | string[] | No | |
| IN_PhysicalIDIn | query | string[] | No | |
| IsDefault | query | int? | No | |
| IsDefaultGreaterThanOrEqualTo | query | int? | No | |
| IsDefaultGreaterThan | query | int? | No | |
| IsDefaultLessThan | query | int? | No | |
| IsDefaultLessThanOrEqualTo | query | int? | No | |
| IsDefaultNotEqualTo | query | int? | No | |
| IsDefaultBetween | query | int[] | No | |
| IsDefaultIn | 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 |
|---|---|---|---|---|
| IN_LogicalID | form | string | No | |
| IN_PhysicalID | form | string | No | |
| IsDefault | 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 .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/IN_InTransitWHQuery HTTP/1.1
Host: api.jiwa.com.au
Accept: application/json
Content-Type: application/json
Content-Length: length
{"IN_LogicalID":"String","IN_LogicalIDStartsWith":"String","IN_LogicalIDEndsWith":"String","IN_LogicalIDContains":"String","IN_LogicalIDLike":"String","IN_LogicalIDBetween":["String"],"IN_LogicalIDIn":["String"],"IN_PhysicalID":"String","IN_PhysicalIDStartsWith":"String","IN_PhysicalIDEndsWith":"String","IN_PhysicalIDContains":"String","IN_PhysicalIDLike":"String","IN_PhysicalIDBetween":["String"],"IN_PhysicalIDIn":["String"],"IsDefault":0,"IsDefaultGreaterThanOrEqualTo":0,"IsDefaultGreaterThan":0,"IsDefaultLessThan":0,"IsDefaultLessThanOrEqualTo":0,"IsDefaultNotEqualTo":0,"IsDefaultBetween":[0],"IsDefaultIn":[0],"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":[{"IN_LogicalID":"String","IN_PhysicalID":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}