GET | /Queries/IN_BinLocationLookup | Retrieves a list of bin locations. |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
INBinLookupID | query | string | No | |
INBinLookupIDStartsWith | query | string | No | |
INBinLookupIDEndsWith | query | string | No | |
INBinLookupIDContains | query | string | No | |
INBinLookupIDLike | query | string | No | |
INBinLookupIDBetween | query | string[] | No | |
INBinLookupIDIn | 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 | |
INLogicalID | query | string | No | |
INLogicalIDStartsWith | query | string | No | |
INLogicalIDEndsWith | query | string | No | |
INLogicalIDContains | query | string | No | |
INLogicalIDLike | query | string | No | |
INLogicalIDBetween | query | string[] | No | |
INLogicalIDIn | query | string[] | No | |
Description | query | string | No | |
DescriptionStartsWith | query | string | No | |
DescriptionEndsWith | query | string | No | |
DescriptionContains | query | string | No | |
DescriptionLike | query | string | No | |
DescriptionBetween | query | string[] | No | |
DescriptionIn | query | string[] | No | |
ShortName | query | string | No | |
ShortNameStartsWith | query | string | No | |
ShortNameEndsWith | query | string | No | |
ShortNameContains | query | string | No | |
ShortNameLike | query | string | No | |
ShortNameBetween | query | string[] | No | |
ShortNameIn | query | string[] | No | |
ItemNo | query | int? | No | |
ItemNoGreaterThanOrEqualTo | query | int? | No | |
ItemNoGreaterThan | query | int? | No | |
ItemNoLessThan | query | int? | No | |
ItemNoLessThanOrEqualTo | query | int? | No | |
ItemNoNotEqualTo | query | int? | No | |
ItemNoBetween | query | Nullable<Int32>[] | No | |
ItemNoIn | query | Nullable<Int32>[] | No | |
IsDefault | query | bool? | No | |
RowHash | query | byte[] | 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 |
---|---|---|---|---|
INBinLookupID | form | string | No | |
LastSavedDateTime | form | DateTime | No | |
INLogicalID | form | string | No | |
Description | form | string | No | |
ShortName | form | string | No | |
ItemNo | form | int? | No | |
IsDefault | form | bool? | No | |
RowHash | form | byte[] | 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.
GET /Queries/IN_BinLocationLookup HTTP/1.1 Host: api.jiwa.com.au Accept: application/json
HTTP/1.1 200 OK Content-Type: application/json Content-Length: length {"Results":[{"INBinLookupID":"String","INLogicalID":"String","Description":"String","ShortName":"String","ItemNo":0,"IsDefault":false,"RowHash":"AA=="}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}