AIM Web Services

<back to all web services

InventoryImageRequest

InventoryImage
Requires active-e Inventory Service

using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using AIM.WebService;

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 virtual string ApiKey { get; set; }

        [DataMember]
        [ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")]
        public virtual string OAuthToken { get; set; }
    }

    [DataContract]
    public partial class BaseResponse
    {
        ///<summary>
        ///
        ///</summary>
        [DataMember]
        [ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")]
        public virtual BaseResponseResult Status { get; set; }
        [DataContract]
        public partial class BaseResponseResult
        {
            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")]
            public virtual string StatusCode { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")]
            public virtual string Login { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")]
            public virtual string ErrorCode { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")]
            public virtual string ErrorDisplayText { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")]
            public virtual string ErrorMessage { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")]
            public virtual string DomainName { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")]
            public virtual string IpAddress { get; set; }
        }

    }

    [DataContract]
    public partial class BaseSecureRequest
        : BaseRequest
    {
        ///<summary>
        ///
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")]
        public virtual string Token { get; set; }

        ///<summary>
        ///
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="", Name="DeviceId", ParameterType="Header")]
        public virtual string DeviceId { get; set; }

        ///<summary>
        ///
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="", IsRequired=true, Name="AppId", ParameterType="Header")]
        public virtual string AppId { get; set; }
    }

    [DataContract]
    public partial class ImageInfo
    {
        [DataMember]
        public virtual string Url { get; set; }

        [DataMember]
        public virtual string ImageStream { get; set; }

        [DataMember]
        public virtual string ImageSize { get; set; }

        [DataMember]
        public virtual string ErrorMessage { get; set; }

        [DataMember]
        public virtual long? UriPk { get; set; }
    }

    ///<summary>
    ///InventoryImageRequires active-e Inventory Service
    ///</summary>
    [DataContract]
    public partial class InventoryImageRequest
        : BaseSecureRequest
    {
        public InventoryImageRequest()
        {
            NewImages = new List<NewImageInfo>{};
            UriImagePksToDelete = new List<long>{};
        }

        [DataMember]
        public virtual string Item { get; set; }

        [DataMember]
        public virtual long? ItemPk { 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")]
        public virtual string ItemType { 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")]
        public virtual List<NewImageInfo> NewImages { 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")]
        public virtual List<long> UriImagePksToDelete { get; set; }
        [DataContract]
        public partial class NewImageInfo
        {
            [DataMember]
            public virtual string FileName { get; set; }

            [DataMember]
            public virtual string Description { get; set; }

            [DataMember]
            public virtual string Base64Image { get; set; }
        }

    }

    [DataContract]
    public partial class InventoryImageResponse
        : BaseResponse
    {
        public InventoryImageResponse()
        {
            Images = new List<ImageInfo>{};
        }

        [DataMember]
        public virtual List<ImageInfo> Images { get; set; }
    }

}

C# InventoryImageRequest DTOs

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>