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
namespace AIM.WebService

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<DataContract>]
    [<AllowNullLiteral>]
    type BaseResponseResult() = 
        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")>]
        member val StatusCode:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")>]
        member val Login:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")>]
        member val ErrorCode:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")>]
        member val ErrorDisplayText:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")>]
        member val ErrorMessage:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")>]
        member val DomainName:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")>]
        member val IpAddress:String = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type BaseResponse() = 
        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")>]
        member val Status:BaseResponseResult = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type ImageInfo() = 
        [<DataMember>]
        member val Url:String = null with get,set

        [<DataMember>]
        member val ImageStream:String = null with get,set

        [<DataMember>]
        member val ImageSize:String = null with get,set

        [<DataMember>]
        member val ErrorMessage:String = null with get,set

        [<DataMember>]
        member val UriPk:Nullable<Int64> = new Nullable<Int64>() with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type InventoryImageResponse() = 
        inherit BaseResponse()
        [<DataMember>]
        member val Images:ResizeArray<ImageInfo> = new ResizeArray<ImageInfo>() with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type 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")>]
        member val ApiKey:String = null with get,set

        [<DataMember>]
        [<ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")>]
        member val OAuthToken:String = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type BaseSecureRequest() = 
        inherit BaseRequest()
        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")>]
        member val Token:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="DeviceId", ParameterType="Header")>]
        member val DeviceId:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", IsRequired=true, Name="AppId", ParameterType="Header")>]
        member val AppId:String = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type NewImageInfo() = 
        [<DataMember>]
        member val FileName:String = null with get,set

        [<DataMember>]
        member val Description:String = null with get,set

        [<DataMember>]
        member val Base64Image:String = null with get,set

    ///<summary>
    ///InventoryImageRequires active-e Inventory Service
    ///</summary>
    [<DataContract>]
    [<AllowNullLiteral>]
    type InventoryImageRequest() = 
        inherit BaseSecureRequest()
        [<DataMember>]
        member val Item:String = null with get,set

        [<DataMember>]
        member val ItemPk:Nullable<Int64> = new Nullable<Int64>() with get,set

        ///<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")>]
        member val ItemType:String = null with get,set

        ///<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")>]
        member val NewImages:ResizeArray<NewImageInfo> = new ResizeArray<NewImageInfo>() with get,set

        ///<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")>]
        member val UriImagePksToDelete:ResizeArray<Int64> = new ResizeArray<Int64>() with get,set

F# InventoryImageRequest 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/InventoryImage HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<InventoryImageRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AIM.WebService">
  <ApiKey>String</ApiKey>
  <OAuthToken>String</OAuthToken>
  <AppId>String</AppId>
  <DeviceId>String</DeviceId>
  <Token>String</Token>
  <Item>String</Item>
  <ItemPk>0</ItemPk>
  <ItemType>String</ItemType>
  <NewImages>
    <InventoryImageRequest.NewImageInfo>
      <Base64Image>String</Base64Image>
      <Description>String</Description>
      <FileName>String</FileName>
    </InventoryImageRequest.NewImageInfo>
  </NewImages>
  <UriImagePksToDelete xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:long>0</d2p1:long>
  </UriImagePksToDelete>
</InventoryImageRequest>

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

<InventoryImageResponse 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>
</InventoryImageResponse>