| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| LinkID | query | string | No | |
| LinkIDStartsWith | query | string | No | |
| LinkIDEndsWith | query | string | No | |
| LinkIDContains | query | string | No | |
| LinkIDLike | query | string | No | |
| LinkIDBetween | query | string[] | No | |
| LinkIDIn | query | string[] | No | |
| InventoryID | query | string | No | |
| InventoryIDStartsWith | query | string | No | |
| InventoryIDEndsWith | query | string | No | |
| InventoryIDContains | query | string | No | |
| InventoryIDLike | query | string | No | |
| InventoryIDBetween | query | string[] | No | |
| InventoryIDIn | query | string[] | No | |
| LinkedInventoryID | query | string | No | |
| LinkedInventoryIDStartsWith | query | string | No | |
| LinkedInventoryIDEndsWith | query | string | No | |
| LinkedInventoryIDContains | query | string | No | |
| LinkedInventoryIDLike | query | string | No | |
| LinkedInventoryIDBetween | query | string[] | No | |
| LinkedInventoryIDIn | query | string[] | No | |
| Notes | query | string | No | |
| NotesStartsWith | query | string | No | |
| NotesEndsWith | query | string | No | |
| NotesContains | query | string | No | |
| NotesLike | query | string | No | |
| NotesBetween | query | string[] | No | |
| NotesIn | 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 |
|---|---|---|---|---|
| LinkID | form | string | No | |
| InventoryID | form | string | No | |
| LinkedInventoryID | form | string | No | |
| Notes | 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/IN_AlternateQuery HTTP/1.1
Host: api.jiwa.com.au
Accept: application/json
Content-Type: application/json
Content-Length: length
{"LinkID":"String","LinkIDStartsWith":"String","LinkIDEndsWith":"String","LinkIDContains":"String","LinkIDLike":"String","LinkIDBetween":["String"],"LinkIDIn":["String"],"InventoryID":"String","InventoryIDStartsWith":"String","InventoryIDEndsWith":"String","InventoryIDContains":"String","InventoryIDLike":"String","InventoryIDBetween":["String"],"InventoryIDIn":["String"],"LinkedInventoryID":"String","LinkedInventoryIDStartsWith":"String","LinkedInventoryIDEndsWith":"String","LinkedInventoryIDContains":"String","LinkedInventoryIDLike":"String","LinkedInventoryIDBetween":["String"],"LinkedInventoryIDIn":["String"],"Notes":"String","NotesStartsWith":"String","NotesEndsWith":"String","NotesContains":"String","NotesLike":"String","NotesBetween":["String"],"NotesIn":["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":[{"LinkID":"String","InventoryID":"String","LinkedInventoryID":"String","Notes":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}