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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<PhysicalInventoryCycleLookupResponse 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>
  <Cycle>
    <CreationDate>0001-01-01T00:00:00</CreationDate>
    <Description>String</Description>
    <EmployeeName>String</EmployeeName>
    <Id>0</Id>
    <LastUpdated>0001-01-01T00:00:00</LastUpdated>
  </Cycle>
  <LookupResult>String</LookupResult>
</PhysicalInventoryCycleLookupResponse>