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
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    /**
    * PhysicalInventoryCycleLookupRequires active-e Inventory Service
    */
    @DataContract
    public static class PhysicalInventoryCycleLookupRequest extends BaseSecureRequest
    {
        /**
        * Exactly one of SkuPk+LocationId, SaqPk, and SasPk must be passed in.
        */
        @DataMember
        @ApiMember(DataType="integer", Description="Exactly one of SkuPk+LocationId, SaqPk, and SasPk must be passed in.", Format="int64", Name="SkuPk", ParameterType="query")
        public Long SkuPk = null;

        /**
        * Exactly one of SkuPk+LocationId, SaqPk, and SasPk must be passed in.
        */
        @DataMember
        @ApiMember(DataType="integer", Description="Exactly one of SkuPk+LocationId, SaqPk, and SasPk must be passed in.", Format="int64", Name="LocationId", ParameterType="query")
        public Long LocationId = null;

        /**
        * Exactly one of SkuPk+LocationId, SaqPk, and SasPk must be passed in.
        */
        @DataMember
        @ApiMember(DataType="integer", Description="Exactly one of SkuPk+LocationId, SaqPk, and SasPk must be passed in.", Format="int64", Name="SaqPk", ParameterType="query")
        public Long SaqPk = null;

        /**
        * Exactly one of SkuPk+LocationId, SaqPk, and SasPk must be passed in.
        */
        @DataMember
        @ApiMember(DataType="integer", Description="Exactly one of SkuPk+LocationId, SaqPk, and SasPk must be passed in.", Format="int64", Name="SasPk", ParameterType="query")
        public Long SasPk = null;
        
        public Long getSkuPk() { return SkuPk; }
        public PhysicalInventoryCycleLookupRequest setSkuPk(Long value) { this.SkuPk = value; return this; }
        public Long getLocationId() { return LocationId; }
        public PhysicalInventoryCycleLookupRequest setLocationId(Long value) { this.LocationId = value; return this; }
        public Long getSaqPk() { return SaqPk; }
        public PhysicalInventoryCycleLookupRequest setSaqPk(Long value) { this.SaqPk = value; return this; }
        public Long getSasPk() { return SasPk; }
        public PhysicalInventoryCycleLookupRequest setSasPk(Long value) { this.SasPk = value; return this; }
    }

    @DataContract
    public static class BaseSecureRequest extends BaseRequest
    {
        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")
        public String Token = null;

        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", Name="DeviceId", ParameterType="Header")
        public String DeviceId = null;

        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", IsRequired=true, Name="AppId", ParameterType="Header")
        public String AppId = null;
        
        public String getToken() { return Token; }
        public BaseSecureRequest setToken(String value) { this.Token = value; return this; }
        public String getDeviceId() { return DeviceId; }
        public BaseSecureRequest setDeviceId(String value) { this.DeviceId = value; return this; }
        public String getAppId() { return AppId; }
        public BaseSecureRequest setAppId(String value) { this.AppId = value; return this; }
    }

    @DataContract
    public static class BaseRequest
    {
        /**
        * This is your AIM API Key provided by Tri-Tech
        */
        @DataMember
        @ApiMember(DataType="string", Description="This is your AIM API Key provided by Tri-Tech", IsRequired=true, Name="ApiKey", ParameterType="header")
        public String ApiKey = null;

        @DataMember
        @ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")
        public String OAuthToken = null;
        
        public String getApiKey() { return ApiKey; }
        public BaseRequest setApiKey(String value) { this.ApiKey = value; return this; }
        public String getOAuthToken() { return OAuthToken; }
        public BaseRequest setOAuthToken(String value) { this.OAuthToken = value; return this; }
    }

    @DataContract
    public static class PhysicalInventoryCycleLookupResponse extends BaseResponse
    {
        @DataMember
        public String LookupResult = null;

        @DataMember
        public PhysicalInventoryCycle Cycle = null;
        
        public String getLookupResult() { return LookupResult; }
        public PhysicalInventoryCycleLookupResponse setLookupResult(String value) { this.LookupResult = value; return this; }
        public PhysicalInventoryCycle getCycle() { return Cycle; }
        public PhysicalInventoryCycleLookupResponse setCycle(PhysicalInventoryCycle value) { this.Cycle = value; return this; }
    }

    @DataContract
    public static class BaseResponse
    {
        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")
        public BaseResponseResult Status = null;
        
        public BaseResponseResult getStatus() { return Status; }
        public BaseResponse setStatus(BaseResponseResult value) { this.Status = value; return this; }
    }

    @DataContract
    public static class BaseResponseResult
    {
        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")
        public String StatusCode = null;

        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")
        public String Login = null;

        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")
        public String ErrorCode = null;

        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")
        public String ErrorDisplayText = null;

        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")
        public String ErrorMessage = null;

        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")
        public String DomainName = null;

        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")
        public String IpAddress = null;
        
        public String getStatusCode() { return StatusCode; }
        public BaseResponseResult setStatusCode(String value) { this.StatusCode = value; return this; }
        public String getLogin() { return Login; }
        public BaseResponseResult setLogin(String value) { this.Login = value; return this; }
        public String getErrorCode() { return ErrorCode; }
        public BaseResponseResult setErrorCode(String value) { this.ErrorCode = value; return this; }
        public String getErrorDisplayText() { return ErrorDisplayText; }
        public BaseResponseResult setErrorDisplayText(String value) { this.ErrorDisplayText = value; return this; }
        public String getErrorMessage() { return ErrorMessage; }
        public BaseResponseResult setErrorMessage(String value) { this.ErrorMessage = value; return this; }
        public String getDomainName() { return DomainName; }
        public BaseResponseResult setDomainName(String value) { this.DomainName = value; return this; }
        public String getIpAddress() { return IpAddress; }
        public BaseResponseResult setIpAddress(String value) { this.IpAddress = value; return this; }
    }

    @DataContract
    public static class PhysicalInventoryCycle
    {
        @DataMember
        public Long Id = null;

        @DataMember
        public String Description = null;

        @DataMember
        public String EmployeeName = null;

        @DataMember
        public Date CreationDate = null;

        @DataMember
        public Date LastUpdated = null;
        
        public Long getId() { return Id; }
        public PhysicalInventoryCycle setId(Long value) { this.Id = value; return this; }
        public String getDescription() { return Description; }
        public PhysicalInventoryCycle setDescription(String value) { this.Description = value; return this; }
        public String getEmployeeName() { return EmployeeName; }
        public PhysicalInventoryCycle setEmployeeName(String value) { this.EmployeeName = value; return this; }
        public Date getCreationDate() { return CreationDate; }
        public PhysicalInventoryCycle setCreationDate(Date value) { this.CreationDate = value; return this; }
        public Date getLastUpdated() { return LastUpdated; }
        public PhysicalInventoryCycle setLastUpdated(Date value) { this.LastUpdated = value; return this; }
    }

}

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