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
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    /**
    * InventoryImageRequires active-e Inventory Service
    */
    @DataContract
    public static class InventoryImageRequest extends BaseSecureRequest
    {
        @DataMember
        public String Item = null;

        @DataMember
        public Long ItemPk = null;

        /**
        * Model, SKU, or Serial. Defaults to Model.
        */
        @DataMember
        @ApiMember(DataType="string", Description="Model, SKU, or Serial. Defaults to Model.", Name="ItemType", ParameterType="query")
        public String ItemType = null;

        /**
        * Images (in Base64) to add to the Item. Only for POST.
        */
        @DataMember
        @ApiMember(Description="Images (in Base64) to add to the Item. Only for POST.", Name="NewImages", ParameterType="query")
        public ArrayList<NewImageInfo> NewImages = null;

        /**
        * URI Image PKs to remove from the Item. Only for POST.
        */
        @DataMember
        @ApiMember(Description="URI Image PKs to remove from the Item. Only for POST.", Name="UriImagePksToDelete", ParameterType="query")
        public ArrayList<Long> UriImagePksToDelete = null;
        
        public String getItem() { return Item; }
        public InventoryImageRequest setItem(String value) { this.Item = value; return this; }
        public Long getItemPk() { return ItemPk; }
        public InventoryImageRequest setItemPk(Long value) { this.ItemPk = value; return this; }
        public String getItemType() { return ItemType; }
        public InventoryImageRequest setItemType(String value) { this.ItemType = value; return this; }
        public ArrayList<NewImageInfo> getNewImages() { return NewImages; }
        public InventoryImageRequest setNewImages(ArrayList<NewImageInfo> value) { this.NewImages = value; return this; }
        public ArrayList<Long> getUriImagePksToDelete() { return UriImagePksToDelete; }
        public InventoryImageRequest setUriImagePksToDelete(ArrayList<Long> value) { this.UriImagePksToDelete = value; return this; }
    }

    @DataContract
    public static class BaseSecureRequest extends BaseRequest
    {
        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")
        public String Token = null;

        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", Name="DeviceId", ParameterType="Header")
        public String DeviceId = null;

        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", IsRequired=true, Name="AppId", ParameterType="Header")
        public String AppId = null;
        
        public String getToken() { return Token; }
        public BaseSecureRequest setToken(String value) { this.Token = value; return this; }
        public String getDeviceId() { return DeviceId; }
        public BaseSecureRequest setDeviceId(String value) { this.DeviceId = value; return this; }
        public String getAppId() { return AppId; }
        public BaseSecureRequest setAppId(String value) { this.AppId = value; return this; }
    }

    @DataContract
    public static class BaseRequest
    {
        /**
        * This is your AIM API Key provided by Tri-Tech
        */
        @DataMember
        @ApiMember(DataType="string", Description="This is your AIM API Key provided by Tri-Tech", IsRequired=true, Name="ApiKey", ParameterType="header")
        public String ApiKey = null;

        @DataMember
        @ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")
        public String OAuthToken = null;
        
        public String getApiKey() { return ApiKey; }
        public BaseRequest setApiKey(String value) { this.ApiKey = value; return this; }
        public String getOAuthToken() { return OAuthToken; }
        public BaseRequest setOAuthToken(String value) { this.OAuthToken = value; return this; }
    }

    @DataContract
    public static class NewImageInfo
    {
        @DataMember
        public String FileName = null;

        @DataMember
        public String Description = null;

        @DataMember
        public String Base64Image = null;
        
        public String getFileName() { return FileName; }
        public NewImageInfo setFileName(String value) { this.FileName = value; return this; }
        public String getDescription() { return Description; }
        public NewImageInfo setDescription(String value) { this.Description = value; return this; }
        public String getBase64Image() { return Base64Image; }
        public NewImageInfo setBase64Image(String value) { this.Base64Image = value; return this; }
    }

    @DataContract
    public static class InventoryImageResponse extends BaseResponse
    {
        @DataMember
        public ArrayList<ImageInfo> Images = null;
        
        public ArrayList<ImageInfo> getImages() { return Images; }
        public InventoryImageResponse setImages(ArrayList<ImageInfo> value) { this.Images = value; return this; }
    }

    @DataContract
    public static class BaseResponse
    {
        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")
        public BaseResponseResult Status = null;
        
        public BaseResponseResult getStatus() { return Status; }
        public BaseResponse setStatus(BaseResponseResult value) { this.Status = value; return this; }
    }

    @DataContract
    public static class BaseResponseResult
    {
        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")
        public String StatusCode = null;

        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")
        public String Login = null;

        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")
        public String ErrorCode = null;

        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")
        public String ErrorDisplayText = null;

        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")
        public String ErrorMessage = null;

        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")
        public String DomainName = null;

        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")
        public String IpAddress = null;
        
        public String getStatusCode() { return StatusCode; }
        public BaseResponseResult setStatusCode(String value) { this.StatusCode = value; return this; }
        public String getLogin() { return Login; }
        public BaseResponseResult setLogin(String value) { this.Login = value; return this; }
        public String getErrorCode() { return ErrorCode; }
        public BaseResponseResult setErrorCode(String value) { this.ErrorCode = value; return this; }
        public String getErrorDisplayText() { return ErrorDisplayText; }
        public BaseResponseResult setErrorDisplayText(String value) { this.ErrorDisplayText = value; return this; }
        public String getErrorMessage() { return ErrorMessage; }
        public BaseResponseResult setErrorMessage(String value) { this.ErrorMessage = value; return this; }
        public String getDomainName() { return DomainName; }
        public BaseResponseResult setDomainName(String value) { this.DomainName = value; return this; }
        public String getIpAddress() { return IpAddress; }
        public BaseResponseResult setIpAddress(String value) { this.IpAddress = value; return this; }
    }

    @DataContract
    public static class ImageInfo
    {
        @DataMember
        public String Url = null;

        @DataMember
        public String ImageStream = null;

        @DataMember
        public String ImageSize = null;

        @DataMember
        public String ErrorMessage = null;

        @DataMember
        public Long UriPk = null;
        
        public String getUrl() { return Url; }
        public ImageInfo setUrl(String value) { this.Url = value; return this; }
        public String getImageStream() { return ImageStream; }
        public ImageInfo setImageStream(String value) { this.ImageStream = value; return this; }
        public String getImageSize() { return ImageSize; }
        public ImageInfo setImageSize(String value) { this.ImageSize = value; return this; }
        public String getErrorMessage() { return ErrorMessage; }
        public ImageInfo setErrorMessage(String value) { this.ErrorMessage = value; return this; }
        public Long getUriPk() { return UriPk; }
        public ImageInfo setUriPk(Long value) { this.UriPk = value; return this; }
    }

}

Java InventoryImageRequest DTOs

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

HTTP + OTHER

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: text/jsonl
Content-Type: text/jsonl
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: text/jsonl
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"}}