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

Namespace Global

    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 Overridable Property ApiKey As String

            <DataMember>
            <ApiMember(DataType:="string", Name:="OAuthToken", ParameterType:="header")>
            Public Overridable Property OAuthToken As String
        End Class

        <DataContract>
        Public Partial Class BaseResponse
            '''<Summary>
            '''
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="BaseResponseResult", Description:="", Name:="Status", ParameterType:="body")>
            Public Overridable Property Status As BaseResponseResult

            <DataContract>
            Public Partial Class BaseResponseResult
                '''<Summary>
                '''
                '''</Summary>
                <DataMember>
                <ApiMember(DataType:="string", Description:="", Name:="StatusCode", ParameterType:="body")>
                Public Overridable Property StatusCode As String

                '''<Summary>
                '''
                '''</Summary>
                <DataMember>
                <ApiMember(DataType:="string", Description:="", Name:="Login", ParameterType:="body")>
                Public Overridable Property Login As String

                '''<Summary>
                '''
                '''</Summary>
                <DataMember>
                <ApiMember(DataType:="string", Description:="", Name:="ErrorCode", ParameterType:="body")>
                Public Overridable Property ErrorCode As String

                '''<Summary>
                '''
                '''</Summary>
                <DataMember>
                <ApiMember(DataType:="string", Description:="", Name:="ErrorDisplayText", ParameterType:="body")>
                Public Overridable Property ErrorDisplayText As String

                '''<Summary>
                '''
                '''</Summary>
                <DataMember>
                <ApiMember(DataType:="string", Description:="", Name:="ErrorMessage", ParameterType:="body")>
                Public Overridable Property ErrorMessage As String

                '''<Summary>
                '''
                '''</Summary>
                <DataMember>
                <ApiMember(DataType:="string", Description:="", ExcludeInSchema:=true, Name:="DomainName", ParameterType:="body")>
                Public Overridable Property DomainName As String

                '''<Summary>
                '''
                '''</Summary>
                <DataMember>
                <ApiMember(DataType:="string", Description:="", ExcludeInSchema:=true, Name:="IPAddress", ParameterType:="body")>
                Public Overridable Property IpAddress As String
            End Class
        End Class

        <DataContract>
        Public Partial Class BaseSecureRequest
            Inherits BaseRequest
            '''<Summary>
            '''
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="string", Description:="", Name:="Token", ParameterType:="Header")>
            Public Overridable Property Token As String

            '''<Summary>
            '''
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="string", Description:="", Name:="DeviceId", ParameterType:="Header")>
            Public Overridable Property DeviceId As String

            '''<Summary>
            '''
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="string", Description:="", IsRequired:=true, Name:="AppId", ParameterType:="Header")>
            Public Overridable Property AppId As String
        End Class

        <DataContract>
        Public Partial Class PhysicalInventoryCycle
            <DataMember>
            Public Overridable Property Id As Long

            <DataMember>
            Public Overridable Property Description As String

            <DataMember>
            Public Overridable Property EmployeeName As String

            <DataMember>
            Public Overridable Property CreationDate As Date

            <DataMember>
            Public Overridable Property LastUpdated As Nullable(Of Date)
        End Class

        '''<Summary>
        '''PhysicalInventoryCycleLookupRequires active-e Inventory Service
        '''</Summary>
        <DataContract>
        Public Partial Class PhysicalInventoryCycleLookupRequest
            Inherits 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 Overridable Property SkuPk As Nullable(Of Long)

            '''<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 Overridable Property LocationId As Nullable(Of Long)

            '''<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 Overridable Property SaqPk As Nullable(Of Long)

            '''<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 Overridable Property SasPk As Nullable(Of Long)
        End Class

        <DataContract>
        Public Partial Class PhysicalInventoryCycleLookupResponse
            Inherits BaseResponse
            <DataMember>
            Public Overridable Property LookupResult As String

            <DataMember>
            Public Overridable Property Cycle As PhysicalInventoryCycle
        End Class
    End Namespace
End Namespace

VB.NET 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"}}