| GET | /api/InventoryLookup |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Item | query | string | No | |
| LocationCode | query | string | No |
| 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 |
|---|---|---|---|---|
| Results | form | List<InventoryLookupObj> | 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 |
|---|---|---|---|---|
| ResultType | form | string | No | |
| Sku | form | string | No | |
| Serial | form | string | No | |
| Category | form | int | No | |
| SubCategory | form | int | No | |
| Description | form | string | No | |
| ComputerQty | form | decimal | No | |
| AvailableQty | form | decimal | No | |
| SadPk | form | long | No | |
| SkuPk | form | long | No | |
| SasPk | form | long? | No | |
| InventoryType | form | string | No | |
| NicsPrice | form | decimal? | No | |
| ADBookItem | form | bool | No | |
| LocationCode | form | string | 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/InventoryLookup HTTP/1.1 Host: active-ewebservice.biz Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<InventoryLookupResponse 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>
<Results>
<InventoryLookupObj>
<ADBookItem>false</ADBookItem>
<AvailableQty>0</AvailableQty>
<Category>0</Category>
<ComputerQty>0</ComputerQty>
<Description>String</Description>
<InventoryType>String</InventoryType>
<LocationCode>String</LocationCode>
<NicsPrice>0</NicsPrice>
<ResultType>String</ResultType>
<SadPk>0</SadPk>
<SasPk>0</SasPk>
<Serial>String</Serial>
<Sku>String</Sku>
<SkuPk>0</SkuPk>
<SubCategory>0</SubCategory>
</InventoryLookupObj>
</Results>
</InventoryLookupResponse>