AIM Web Services

<back to all web services

LocatorListingRequest

LocatorListing
Requires active-e Inventory Service.

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

public class dtos
{

    /**
    * LocatorListingRequires active-e Inventory Service.
    */
    @DataContract
    public static class LocatorListingRequest extends BaseSecureRequest
    {
        /**
        * If sent, only Locators for the given location will be returned
        */
        @DataMember
        @ApiMember(DataType="integer", Description="If sent, only Locators for the given location will be returned", Format="int64", Name="LocationId", ParameterType="query")
        public Long LocationId = null;

        /**
        * Can be INV (Inventory) or TIC (Ticket). Defaults to INV.
        */
        @DataMember
        @ApiMember(Description="Can be INV (Inventory) or TIC (Ticket). Defaults to INV.", Name="Type", ParameterType="query")
        public String Type = null;
        
        public Long getLocationId() { return LocationId; }
        public LocatorListingRequest setLocationId(Long value) { this.LocationId = value; return this; }
        public String getType() { return Type; }
        public LocatorListingRequest setType(String value) { this.Type = 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 LocatorListingResponse extends BaseResponse
    {
        @DataMember
        public ArrayList<LocatorInfo> LocatorListing = null;
        
        public ArrayList<LocatorInfo> getLocatorListing() { return LocatorListing; }
        public LocatorListingResponse setLocatorListing(ArrayList<LocatorInfo> value) { this.LocatorListing = 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 LocatorInfo
    {
        @DataMember
        public String Locator = null;

        @DataMember
        public String StLoc = null;

        @DataMember
        public String Type = null;

        @DataMember
        public String Notes = null;

        @DataMember
        public Boolean SingleItem = null;
        
        public String getLocator() { return Locator; }
        public LocatorInfo setLocator(String value) { this.Locator = value; return this; }
        public String getStLoc() { return StLoc; }
        public LocatorInfo setStLoc(String value) { this.StLoc = value; return this; }
        public String getType() { return Type; }
        public LocatorInfo setType(String value) { this.Type = value; return this; }
        public String getNotes() { return Notes; }
        public LocatorInfo setNotes(String value) { this.Notes = value; return this; }
        public Boolean isSingleItem() { return SingleItem; }
        public LocatorInfo setSingleItem(Boolean value) { this.SingleItem = value; return this; }
    }

}

Java LocatorListingRequest DTOs

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

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

{"LocatorListing":[{"Locator":"String","StLoc":"String","Type":"String","Notes":"String","SingleItem":false}],"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}