AIM Web Services

<back to all web services

SerialDetailRequest

SerialDetail
Requires active-e Inventory Service

The following routes are available for this service:
POST, GET/api/SerialDetail
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

            '''<Summary>
            '''The OAuthToken token return by AeServices30
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="string", Description:="The OAuthToken token return by AeServices30", IsRequired:=true, Name:="OAuthToken", ParameterType:="Header")>
            Public Overridable Property OAuthToken As String

            '''<Summary>
            '''The Device ID of the Mobile Device. Not used for non-mobile devices.
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="string", Description:="The Device ID of the Mobile Device. Not used for non-mobile devices.", Name:="DeviceId", ParameterType:="Header")>
            Public Overridable Property DeviceId As String

            '''<Summary>
            '''An identifier for your integration
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="string", Description:="An identifier for your integration", IsRequired:=true, Name:="AppId", ParameterType:="Header")>
            Public Overridable Property AppId 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>
            '''The Login Token return by the Security API. Required for secured calls.
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="string", Description:="The Login Token return by the Security API. Required for secured calls.", Name:="Token", ParameterType:="Header")>
            Public Overridable Property Token As String
        End Class

        <DataContract>
        Public Partial Class ImageInfo
            <DataMember>
            Public Overridable Property Url As String

            <DataMember>
            Public Overridable Property ImageStream As String

            <DataMember>
            Public Overridable Property ImageSize As String

            <DataMember>
            Public Overridable Property ErrorMessage As String

            <DataMember>
            Public Overridable Property UriPk As Nullable(Of Long)
        End Class

        <DataContract>
        Public Partial Class InventoryDetailAttribute
            <DataMember>
            Public Overridable Property Name As String

            <DataMember>
            Public Overridable Property Value As String

            <DataMember>
            Public Overridable Property Priority As Integer

            '''<Summary>
            '''1 is 'Don't Send to Web', 2 is 'Send To Web'
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="int", Description:="1 is 'Don't Send to Web', 2 is 'Send To Web'", Name:="WebType", ParameterType:="query")>
            Public Overridable Property WebType As Integer
        End Class

        <DataContract>
        Public Partial Class InventoryDetailBySerial
            Public Sub New()
                Attributes = New List(Of InventoryDetailAttribute)
                Images = New List(Of ImageInfo)
            End Sub

            <DataMember>
            Public Overridable Property SasPk As Long

            <DataMember>
            Public Overridable Property Serial As String

            <DataMember>
            Public Overridable Property Retail As Decimal

            <DataMember>
            Public Overridable Property OurPrice As Decimal

            <DataMember>
            Public Overridable Property SalePrice As Nullable(Of Decimal)

            <DataMember>
            Public Overridable Property Status As String

            <DataMember>
            Public Overridable Property SaleInfo As String

            <DataMember>
            Public Overridable Property PriceA As Decimal

            <DataMember>
            Public Overridable Property PriceB As Decimal

            <DataMember>
            Public Overridable Property PriceC As Decimal

            <DataMember>
            Public Overridable Property MinPrice As Decimal

            <DataMember>
            Public Overridable Property ActiveEPrice As Decimal

            <DataMember>
            Public Overridable Property AllowPriceChange As Boolean

            <DataMember>
            Public Overridable Property Cost As Nullable(Of Decimal)

            <DataMember>
            Public Overridable Property WeightedCost As Nullable(Of Decimal)

            <DataMember>
            Public Overridable Property Notes As String

            <DataMember>
            Public Overridable Property Attributes As List(Of InventoryDetailAttribute)

            <DataMember>
            Public Overridable Property Images As List(Of ImageInfo)

            <DataMember>
            Public Overridable Property HasImages As Boolean

            <DataMember>
            Public Overridable Property IsActiveeHoldback As Boolean

            <DataMember>
            Public Overridable Property CustomerAcct As Nullable(Of Integer)

            <DataMember>
            Public Overridable Property AvailableForSTR As Boolean
        End Class

        '''<Summary>
        '''SerialDetailRequires active-e Inventory Service
        '''</Summary>
        <DataContract>
        Public Partial Class SerialDetailRequest
            Inherits BaseSecureRequest
            '''<Summary>
            '''The PK being used for lookup. Do not use if Serial is passed in.
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="integer", Description:="The PK being used for lookup. Do not use if Serial is passed in.", Format:="int64", Name:="Pk", ParameterType:="query")>
            Public Overridable Property Pk As Nullable(Of Long)

            '''<Summary>
            '''The Serial# being used for lookup. Do not use if Pk is passed in.
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="string", Description:="The Serial# being used for lookup. Do not use if Pk is passed in.", Name:="Serial", ParameterType:="query")>
            Public Overridable Property Serial As String

            <DataMember>
            Public Overridable Property SkipImages As Boolean

            '''<Summary>
            '''If sent, the Customer Acct will be used for customer specific pricing.
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="integer", Description:="If sent, the Customer Acct will be used for customer specific pricing.", Format:="int32", Name:="CustomerAcct", ParameterType:="query")>
            Public Overridable Property CustomerAcct As Nullable(Of Integer)
        End Class

        <DataContract>
        Public Partial Class SerialDetailResponse
            Inherits BaseResponse
            <DataMember>
            Public Overridable Property SasPk As Long

            <DataMember>
            Public Overridable Property Serial As String

            <DataMember>
            Public Overridable Property SaqPk As Long

            <DataMember>
            Public Overridable Property LocPk As Long

            <DataMember>
            Public Overridable Property Location As String

            <DataMember>
            Public Overridable Property SkuPk As Long

            <DataMember>
            Public Overridable Property SKU As String

            <DataMember>
            Public Overridable Property SadPk As Long

            <DataMember>
            Public Overridable Property Model As String

            <DataMember>
            Public Overridable Property Details As InventoryDetailBySerial
        End Class
    End Namespace
End Namespace

VB.NET SerialDetailRequest DTOs

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.

POST /api/SerialDetail HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<SerialDetailRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AIM.WebService">
  <ApiKey>String</ApiKey>
  <AppId>String</AppId>
  <DeviceId>String</DeviceId>
  <OAuthToken>String</OAuthToken>
  <Token>String</Token>
  <CustomerAcct>0</CustomerAcct>
  <Pk>0</Pk>
  <Serial>String</Serial>
  <SkipImages>false</SkipImages>
</SerialDetailRequest>

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

<SerialDetailResponse 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>
  <Details i:nil="true" />
  <LocPk>0</LocPk>
  <Location>String</Location>
  <Model>String</Model>
  <SKU>String</SKU>
  <SadPk>0</SadPk>
  <SaqPk>0</SaqPk>
  <SasPk>0</SasPk>
  <Serial>String</Serial>
  <SkuPk>0</SkuPk>
</SerialDetailResponse>