AIM Web Services

<back to all web services

PhysicalInventoryCycleLookupRequest

PhysicalInventoryCycleLookup
Requires active-e Inventory Service

The following routes are available for this service:
GET/api/PhysicalInventoryCycleLookup
PhysicalInventoryCycleLookupRequest Parameters:
NameParameterData TypeRequiredDescription
SkuPkqueryintegerNoExactly one of SkuPk+LocationId, SaqPk, and SasPk must be passed in.
LocationIdqueryintegerNoExactly one of SkuPk+LocationId, SaqPk, and SasPk must be passed in.
SaqPkqueryintegerNoExactly one of SkuPk+LocationId, SaqPk, and SasPk must be passed in.
SasPkqueryintegerNoExactly one of SkuPk+LocationId, SaqPk, and SasPk must be passed in.
BaseSecureRequest Parameters:
NameParameterData TypeRequiredDescription
TokenHeaderstringNo
DeviceIdHeaderstringNo
AppIdHeaderstringYes
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
ApiKeyheaderstringYesThis is your AIM API Key provided by Tri-Tech
OAuthTokenheaderstringNo
PhysicalInventoryCycleLookupResponse Parameters:
NameParameterData TypeRequiredDescription
LookupResultformstringNo
CycleformPhysicalInventoryCycleNo
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
StatusbodyBaseResponseResultNo
BaseResponseResult Parameters:
NameParameterData TypeRequiredDescription
StatusCodebodystringNo
LoginbodystringNo
ErrorCodebodystringNo
ErrorDisplayTextbodystringNo
ErrorMessagebodystringNo
DomainNamebodystringNo
IpAddressbodystringNo
PhysicalInventoryCycle Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
DescriptionformstringNo
EmployeeNameformstringNo
CreationDateformDateTimeNo
LastUpdatedformDateTime?No

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /api/PhysicalInventoryCycleLookup HTTP/1.1 
Host: active-ewebservice.biz 
Accept: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"LookupResult":"String","Cycle":{"Id":0,"Description":"String","EmployeeName":"String","LastUpdated":"0001-01-01T00:00:00.0000000"},"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}