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
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using AIM.WebService;

namespace AIM.WebService
{
    [DataContract]
    public partial class BaseRequest
    {
        ///<summary>
        ///This is your AIM API Key provided by Tri-Tech
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="This is your AIM API Key provided by Tri-Tech", IsRequired=true, Name="ApiKey", ParameterType="header")]
        public virtual string ApiKey { get; set; }

        [DataMember]
        [ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")]
        public virtual string OAuthToken { get; set; }
    }

    [DataContract]
    public partial class BaseResponse
    {
        ///<summary>
        ///
        ///</summary>
        [DataMember]
        [ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")]
        public virtual BaseResponseResult Status { get; set; }
        [DataContract]
        public partial class BaseResponseResult
        {
            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")]
            public virtual string StatusCode { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")]
            public virtual string Login { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")]
            public virtual string ErrorCode { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")]
            public virtual string ErrorDisplayText { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")]
            public virtual string ErrorMessage { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")]
            public virtual string DomainName { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")]
            public virtual string IpAddress { get; set; }
        }

    }

    [DataContract]
    public partial class BaseSecureRequest
        : BaseRequest
    {
        ///<summary>
        ///
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")]
        public virtual string Token { get; set; }

        ///<summary>
        ///
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="", Name="DeviceId", ParameterType="Header")]
        public virtual string DeviceId { get; set; }

        ///<summary>
        ///
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="", IsRequired=true, Name="AppId", ParameterType="Header")]
        public virtual string AppId { get; set; }
    }

    [DataContract]
    public partial class PhysicalInventoryCycle
    {
        [DataMember]
        public virtual long Id { get; set; }

        [DataMember]
        public virtual string Description { get; set; }

        [DataMember]
        public virtual string EmployeeName { get; set; }

        [DataMember]
        public virtual DateTime CreationDate { get; set; }

        [DataMember]
        public virtual DateTime? LastUpdated { get; set; }
    }

    ///<summary>
    ///PhysicalInventoryCycleLookupRequires active-e Inventory Service
    ///</summary>
    [DataContract]
    public partial class PhysicalInventoryCycleLookupRequest
        : BaseSecureRequest
    {
        ///<summary>
        ///Exactly one of SkuPk+LocationId, SaqPk, and SasPk must be passed in.
        ///</summary>
        [DataMember]
        [ApiMember(DataType="integer", Description="Exactly one of SkuPk+LocationId, SaqPk, and SasPk must be passed in.", Format="int64", Name="SkuPk", ParameterType="query")]
        public virtual long? SkuPk { get; set; }

        ///<summary>
        ///Exactly one of SkuPk+LocationId, SaqPk, and SasPk must be passed in.
        ///</summary>
        [DataMember]
        [ApiMember(DataType="integer", Description="Exactly one of SkuPk+LocationId, SaqPk, and SasPk must be passed in.", Format="int64", Name="LocationId", ParameterType="query")]
        public virtual long? LocationId { get; set; }

        ///<summary>
        ///Exactly one of SkuPk+LocationId, SaqPk, and SasPk must be passed in.
        ///</summary>
        [DataMember]
        [ApiMember(DataType="integer", Description="Exactly one of SkuPk+LocationId, SaqPk, and SasPk must be passed in.", Format="int64", Name="SaqPk", ParameterType="query")]
        public virtual long? SaqPk { get; set; }

        ///<summary>
        ///Exactly one of SkuPk+LocationId, SaqPk, and SasPk must be passed in.
        ///</summary>
        [DataMember]
        [ApiMember(DataType="integer", Description="Exactly one of SkuPk+LocationId, SaqPk, and SasPk must be passed in.", Format="int64", Name="SasPk", ParameterType="query")]
        public virtual long? SasPk { get; set; }
    }

    [DataContract]
    public partial class PhysicalInventoryCycleLookupResponse
        : BaseResponse
    {
        [DataMember]
        public virtual string LookupResult { get; set; }

        [DataMember]
        public virtual PhysicalInventoryCycle Cycle { get; set; }
    }

}

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