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.

import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    /**
    * GetImageRequires active-e Customer Service for Customer ImagesRequires active-e Inventory Service for Inventory Images.
    */
    @DataContract
    public static class GetImageRequest extends BaseRequest
    {
        /**
        * If sent, image(s) for this customer will be returned.
        */
        @DataMember
        @ApiMember(DataType="integer", Description="If sent, image(s) for this customer will be returned.", Format="int32", Name="CustomerAcct", ParameterType="query")
        public Integer CustomerAcct = null;

        /**
        * If sent, image(s) for this inventory item will be returned.
        */
        @DataMember
        @ApiMember(DataType="integer", Description="If sent, image(s) for this inventory item will be returned.", Format="int64", Name="InventoryPk", ParameterType="query")
        public Long InventoryPk = null;
        
        public Integer getCustomerAcct() { return CustomerAcct; }
        public GetImageRequest setCustomerAcct(Integer value) { this.CustomerAcct = value; return this; }
        public Long getInventoryPk() { return InventoryPk; }
        public GetImageRequest setInventoryPk(Long value) { this.InventoryPk = 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 GetImageResponse extends BaseResponse
    {
        @DataMember
        public ArrayList<ImageInfo> Images = null;
        
        public ArrayList<ImageInfo> getImages() { return Images; }
        public GetImageResponse 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 GetImageRequest DTOs

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

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"}}