AIM Web Services

<back to all web services

InventoryImageRequest

InventoryImage
Requires active-e Inventory Service

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

        '''<Summary>
        '''InventoryImageRequires active-e Inventory Service
        '''</Summary>
        <DataContract>
        Public Partial Class InventoryImageRequest
            Inherits BaseSecureRequest
            Public Sub New()
                NewImages = New List(Of NewImageInfo)
                UriImagePksToDelete = New List(Of Long)
            End Sub

            <DataMember>
            Public Overridable Property Item As String

            <DataMember>
            Public Overridable Property ItemPk As Nullable(Of Long)

            '''<Summary>
            '''Model, SKU, or Serial. Defaults to Model.
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="string", Description:="Model, SKU, or Serial. Defaults to Model.", Name:="ItemType", ParameterType:="query")>
            Public Overridable Property ItemType As String

            '''<Summary>
            '''Images (in Base64) to add to the Item. Only for POST.
            '''</Summary>
            <DataMember>
            <ApiMember(Description:="Images (in Base64) to add to the Item. Only for POST.", Name:="NewImages", ParameterType:="query")>
            Public Overridable Property NewImages As List(Of NewImageInfo)

            '''<Summary>
            '''URI Image PKs to remove from the Item. Only for POST.
            '''</Summary>
            <DataMember>
            <ApiMember(Description:="URI Image PKs to remove from the Item. Only for POST.", Name:="UriImagePksToDelete", ParameterType:="query")>
            Public Overridable Property UriImagePksToDelete As List(Of Long)

            <DataContract>
            Public Partial Class NewImageInfo
                <DataMember>
                Public Overridable Property FileName As String

                <DataMember>
                Public Overridable Property Description As String

                <DataMember>
                Public Overridable Property Base64Image As String
            End Class
        End Class

        <DataContract>
        Public Partial Class InventoryImageResponse
            Inherits BaseResponse
            Public Sub New()
                Images = New List(Of ImageInfo)
            End Sub

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

VB.NET InventoryImageRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

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

{"Item":"String","ItemPk":0,"ItemType":"String","NewImages":[{"FileName":"String","Description":"String","Base64Image":"String"}],"UriImagePksToDelete":[0],"Token":"String","DeviceId":"String","AppId":"String","ApiKey":"String","OAuthToken":"String"}

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

{"Images":[{"Url":"String","ImageStream":"String","ImageSize":"String","ErrorMessage":"String","UriPk":0}],"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}