AIM Web Services

<back to all web services

InventoryLookupRequest

InventoryLookup
Requires active-e Inventory Service

The following routes are available for this service:
GET/api/InventoryLookup
InventoryLookupRequest Parameters:
NameParameterData TypeRequiredDescription
ItemquerystringNo
LocationCodequerystringNo
BaseSecureRequest Parameters:
NameParameterData TypeRequiredDescription
TokenHeaderstringNo
DeviceIdHeaderstringNo
AppIdHeaderstringYes
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
ApiKeyheaderstringYesThis is your AIM API Key provided by Tri-Tech
OAuthTokenheaderstringNo
InventoryLookupResponse Parameters:
NameParameterData TypeRequiredDescription
ResultsformList<InventoryLookupObj>No
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
StatusbodyBaseResponseResultNo
BaseResponseResult Parameters:
NameParameterData TypeRequiredDescription
StatusCodebodystringNo
LoginbodystringNo
ErrorCodebodystringNo
ErrorDisplayTextbodystringNo
ErrorMessagebodystringNo
DomainNamebodystringNo
IpAddressbodystringNo
InventoryLookupObj Parameters:
NameParameterData TypeRequiredDescription
ResultTypeformstringNo
SkuformstringNo
SerialformstringNo
CategoryformintNo
SubCategoryformintNo
DescriptionformstringNo
ComputerQtyformdecimalNo
AvailableQtyformdecimalNo
SadPkformlongNo
SkuPkformlongNo
SasPkformlong?No
InventoryTypeformstringNo
NicsPriceformdecimal?No
ADBookItemformboolNo

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

HTTP + JSON

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/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Results":[{"ResultType":"String","Sku":"String","Serial":"String","Category":0,"SubCategory":0,"Description":"String","ComputerQty":0,"AvailableQty":0,"SadPk":0,"SkuPk":0,"SasPk":0,"InventoryType":"String","NicsPrice":0,"ADBookItem":false}],"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}