GET | /api/LocatorListing |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
LocationId | query | integer | No | If sent, only Locators for the given location will be returned |
Type | query | string | No | Can be INV (Inventory) or TIC (Ticket). Defaults to INV. |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Token | Header | string | No | |
DeviceId | Header | string | No | |
AppId | Header | string | Yes |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ApiKey | header | string | Yes | This is your AIM API Key provided by Tri-Tech |
OAuthToken | header | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
LocatorListing | form | List<LocatorInfo> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Status | body | BaseResponseResult | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
StatusCode | body | string | No | |
Login | body | string | No | |
ErrorCode | body | string | No | |
ErrorDisplayText | body | string | No | |
ErrorMessage | body | string | No | |
DomainName | body | string | No | |
IpAddress | body | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Locator | form | string | No | |
StLoc | form | string | No | |
Type | form | string | No | |
Notes | form | string | No | |
SingleItem | form | bool | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /api/LocatorListing HTTP/1.1 Host: active-ewebservice.biz Accept: application/xml
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <LocatorListingResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AIM.WebService"> <Status> <DomainName>String</DomainName> <ErrorCode>String</ErrorCode> <ErrorDisplayText>String</ErrorDisplayText> <ErrorMessage>String</ErrorMessage> <IpAddress>String</IpAddress> <Login>String</Login> <StatusCode>String</StatusCode> </Status> <LocatorListing> <LocatorInfo> <Locator>String</Locator> <Notes>String</Notes> <SingleItem>false</SingleItem> <StLoc>String</StLoc> <Type>String</Type> </LocatorInfo> </LocatorListing> </LocatorListingResponse>