Antel API

DepotDropOff

The following routes are available for this service:
POST	/stock/depotDropoff

"use strict";
export class ApiServiceRequest {
    /** @param {{apiKey?:string,latitude?:number,longitude?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description The API Key required for authentication */
    apiKey;
    /**
     * @type {number}
     * @description Latitude of the user making this request */
    latitude;
    /**
     * @type {number}
     * @description Longitude of the user making this request */
    longitude;
}
export class ApiServiceResponse {
    /** @param {{description?:string,heading?:string,wasSuccessful?:boolean,responseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description Information about the response. */
    description;
    /**
     * @type {string}
     * @description Heading or summary of the response. */
    heading;
    /**
     * @type {boolean}
     * @description Did the intended operation for this response complete successfully? */
    wasSuccessful;
    /** @type {ResponseStatus} */
    responseStatus;
}
export class AntelSealData {
    /** @param {{sealNumber?:string,principalName?:string,sealId?:number,operatorName?:string,outletName?:string,upliftDate?:string,sealExists?:boolean,isPaused?:boolean,pausedAwaitingAuth?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    sealNumber;
    /** @type {string} */
    principalName;
    /** @type {number} */
    sealId;
    /** @type {string} */
    operatorName;
    /** @type {string} */
    outletName;
    /** @type {string} */
    upliftDate;
    /** @type {boolean} */
    sealExists;
    /** @type {boolean} */
    isPaused;
    /** @type {boolean} */
    pausedAwaitingAuth;
}
export class DepotDropOffResponse extends ApiServiceResponse {
    /** @param {{sealData?:AntelSealData,weightRequired?:boolean,atDepot?:boolean,skipConfirm?:boolean,description?:string,heading?:string,wasSuccessful?:boolean,responseStatus?:ResponseStatus}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {AntelSealData} */
    sealData;
    /** @type {boolean} */
    weightRequired;
    /** @type {boolean} */
    atDepot;
    /** @type {boolean} */
    skipConfirm;
}
export class DepotDropOff extends ApiServiceRequest {
    /** @param {{sealNumber?:string,apiKey?:string,latitude?:number,longitude?:number}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {string} */
    sealNumber;
}

JavaScript DepotDropOff DTOs

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

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

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