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
"use strict";
export class BaseRequest {
    /** @param {{ApiKey?:string,OAuthToken?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description This is your AIM API Key provided by Tri-Tech */
    ApiKey;
    /** @type {string} */
    OAuthToken;
}
export class BaseSecureRequest extends BaseRequest {
    /** @param {{Token?:string,DeviceId?:string,AppId?:string,ApiKey?:string,OAuthToken?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {string} */
    Token;
    /** @type {string} */
    DeviceId;
    /** @type {string} */
    AppId;
}
export class BaseResponseResult {
    /** @param {{StatusCode?:string,Login?:string,ErrorCode?:string,ErrorDisplayText?:string,ErrorMessage?:string,DomainName?:string,IpAddress?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    StatusCode;
    /** @type {string} */
    Login;
    /** @type {string} */
    ErrorCode;
    /** @type {string} */
    ErrorDisplayText;
    /** @type {string} */
    ErrorMessage;
    /** @type {string} */
    DomainName;
    /** @type {string} */
    IpAddress;
}
export class BaseResponse {
    /** @param {{Status?:BaseResponseResult}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {BaseResponseResult} */
    Status;
}
export class PhysicalInventoryCycle {
    /** @param {{Id?:number,Description?:string,EmployeeName?:string,CreationDate?:string,LastUpdated?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    Id;
    /** @type {string} */
    Description;
    /** @type {string} */
    EmployeeName;
    /** @type {string} */
    CreationDate;
    /** @type {?string} */
    LastUpdated;
}
export class PhysicalInventoryCycleLookupResponse extends BaseResponse {
    /** @param {{LookupResult?:string,Cycle?:PhysicalInventoryCycle,Status?:BaseResponseResult}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {string} */
    LookupResult;
    /** @type {PhysicalInventoryCycle} */
    Cycle;
}
export class PhysicalInventoryCycleLookupRequest extends BaseSecureRequest {
    /** @param {{SkuPk?:number,LocationId?:number,SaqPk?:number,SasPk?:number,Token?:string,DeviceId?:string,AppId?:string,ApiKey?:string,OAuthToken?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /**
     * @type {?number}
     * @description Exactly one of SkuPk+LocationId, SaqPk, and SasPk must be passed in. */
    SkuPk;
    /**
     * @type {?number}
     * @description Exactly one of SkuPk+LocationId, SaqPk, and SasPk must be passed in. */
    LocationId;
    /**
     * @type {?number}
     * @description Exactly one of SkuPk+LocationId, SaqPk, and SasPk must be passed in. */
    SaqPk;
    /**
     * @type {?number}
     * @description Exactly one of SkuPk+LocationId, SaqPk, and SasPk must be passed in. */
    SasPk;
}

JavaScript PhysicalInventoryCycleLookupRequest DTOs

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"}}