AIM Web Services

<back to all web services

GetImageRequest

GetImage
Requires active-e Customer Service for Customer Images
Requires active-e Inventory Service for Inventory Images.

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

        '''<Summary>
        '''GetImageRequires active-e Customer Service for Customer ImagesRequires active-e Inventory Service for Inventory Images.
        '''</Summary>
        <DataContract>
        Public Partial Class GetImageRequest
            Inherits BaseRequest
            '''<Summary>
            '''If sent, image(s) for this customer will be returned.
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="integer", Description:="If sent, image(s) for this customer will be returned.", Format:="int32", Name:="CustomerAcct", ParameterType:="query")>
            Public Overridable Property CustomerAcct As Nullable(Of Integer)

            '''<Summary>
            '''If sent, image(s) for this inventory item will be returned.
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="integer", Description:="If sent, image(s) for this inventory item will be returned.", Format:="int64", Name:="InventoryPk", ParameterType:="query")>
            Public Overridable Property InventoryPk As Nullable(Of Long)
        End Class

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

            <DataMember>
            Public Overridable Property Images As List(Of ImageInfo)
        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
    End Namespace
End Namespace

VB.NET GetImageRequest 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.

GET /api/GetImage HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/xml

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

<GetImageResponse 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>
  <Images>
    <ImageInfo>
      <ErrorMessage>String</ErrorMessage>
      <ImageSize>String</ImageSize>
      <ImageStream>String</ImageStream>
      <UriPk>0</UriPk>
      <Url>String</Url>
    </ImageInfo>
  </Images>
</GetImageResponse>