Antel API

<back to all web services

DepotDropOff

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

public class dtos
{

    public static class DepotDropOff extends ApiServiceRequest
    {
        public String sealNumber = null;
        
        public String getSealNumber() { return sealNumber; }
        public DepotDropOff setSealNumber(String value) { this.sealNumber = value; return this; }
    }

    public static class ApiServiceRequest implements IServiceRequest, IHasApiKey, IHasDeviceInfo
    {
        /**
        * The API Key required for authentication
        */
        @ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)
        public String apiKey = null;

        /**
        * Latitude of the user making this request
        */
        @ApiMember(DataType="double", Description="Latitude of the user making this request")
        public Double latitude = null;

        /**
        * Longitude of the user making this request
        */
        @ApiMember(DataType="double", Description="Longitude of the user making this request")
        public Double longitude = null;
        
        public String getApiKey() { return apiKey; }
        public ApiServiceRequest setApiKey(String value) { this.apiKey = value; return this; }
        public Double getLatitude() { return latitude; }
        public ApiServiceRequest setLatitude(Double value) { this.latitude = value; return this; }
        public Double getLongitude() { return longitude; }
        public ApiServiceRequest setLongitude(Double value) { this.longitude = value; return this; }
    }

    public static class DepotDropOffResponse extends ApiServiceResponse
    {
        public AntelSealData sealData = null;
        public Boolean weightRequired = null;
        public Boolean atDepot = null;
        public Boolean skipConfirm = null;
        
        public AntelSealData getSealData() { return sealData; }
        public DepotDropOffResponse setSealData(AntelSealData value) { this.sealData = value; return this; }
        public Boolean isWeightRequired() { return weightRequired; }
        public DepotDropOffResponse setWeightRequired(Boolean value) { this.weightRequired = value; return this; }
        public Boolean isAtDepot() { return atDepot; }
        public DepotDropOffResponse setAtDepot(Boolean value) { this.atDepot = value; return this; }
        public Boolean isSkipConfirm() { return skipConfirm; }
        public DepotDropOffResponse setSkipConfirm(Boolean value) { this.skipConfirm = value; return this; }
    }

    public static class ApiServiceResponse implements IServiceResponse
    {
        /**
        * Information about the response.
        */
        @ApiMember(Description="Information about the response.", IsRequired=true)
        public String description = null;

        /**
        * Heading or summary of the response.
        */
        @ApiMember(Description="Heading or summary of the response.", IsRequired=true)
        public String heading = null;

        /**
        * Did the intended operation for this response complete successfully?
        */
        @ApiMember(DataType="boolean", Description="Did the intended operation for this response complete successfully?", IsRequired=true)
        public Boolean wasSuccessful = null;

        public ResponseStatus responseStatus = null;
        
        public String getDescription() { return description; }
        public ApiServiceResponse setDescription(String value) { this.description = value; return this; }
        public String getHeading() { return heading; }
        public ApiServiceResponse setHeading(String value) { this.heading = value; return this; }
        public Boolean isWasSuccessful() { return wasSuccessful; }
        public ApiServiceResponse setWasSuccessful(Boolean value) { this.wasSuccessful = value; return this; }
        public ResponseStatus getResponseStatus() { return responseStatus; }
        public ApiServiceResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
    }

    public static class AntelSealData
    {
        public String sealNumber = null;
        public String principalName = null;
        public Long sealId = null;
        public String operatorName = null;
        public String outletName = null;
        public String upliftDate = null;
        public Boolean sealExists = null;
        public Boolean isPaused = null;
        public Boolean pausedAwaitingAuth = null;
        
        public String getSealNumber() { return sealNumber; }
        public AntelSealData setSealNumber(String value) { this.sealNumber = value; return this; }
        public String getPrincipalName() { return principalName; }
        public AntelSealData setPrincipalName(String value) { this.principalName = value; return this; }
        public Long getSealId() { return sealId; }
        public AntelSealData setSealId(Long value) { this.sealId = value; return this; }
        public String getOperatorName() { return operatorName; }
        public AntelSealData setOperatorName(String value) { this.operatorName = value; return this; }
        public String getOutletName() { return outletName; }
        public AntelSealData setOutletName(String value) { this.outletName = value; return this; }
        public String getUpliftDate() { return upliftDate; }
        public AntelSealData setUpliftDate(String value) { this.upliftDate = value; return this; }
        public Boolean isSealExists() { return sealExists; }
        public AntelSealData setSealExists(Boolean value) { this.sealExists = value; return this; }
        public Boolean getIsPaused() { return isPaused; }
        public AntelSealData setIsPaused(Boolean value) { this.isPaused = value; return this; }
        public Boolean isPausedAwaitingAuth() { return pausedAwaitingAuth; }
        public AntelSealData setPausedAwaitingAuth(Boolean value) { this.pausedAwaitingAuth = value; return this; }
    }

}

Java DepotDropOff DTOs

POST /stock/depotDropoff HTTP/1.1 
Host: antel.api.dev.86degrees.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	sealNumber: String,
	apiKey: String,
	latitude: 0,
	longitude: 0
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	sealData: 
	{
		sealNumber: String,
		principalName: String,
		sealId: 0,
		operatorName: String,
		outletName: String,
		upliftDate: String,
		sealExists: False,
		isPaused: False,
		pausedAwaitingAuth: False
	},
	weightRequired: False,
	atDepot: False,
	skipConfirm: False,
	description: String,
	heading: String,
	wasSuccessful: False,
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}