Antel API

<back to all web services

DepotDropOff

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

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

    /** @description Longitude of the user making this request */
    // @ApiMember(DataType="double", Description="Longitude of the user making this request")
    public longitude: number;

    public constructor(init?: Partial<ApiServiceRequest>) { (Object as any).assign(this, init); }
}

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

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

    /** @description 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 wasSuccessful: boolean;

    public responseStatus: ResponseStatus;

    public constructor(init?: Partial<ApiServiceResponse>) { (Object as any).assign(this, init); }
}

export class AntelSealData
{
    public sealNumber: string;
    public principalName: string;
    public sealId: number;
    public operatorName: string;
    public outletName: string;
    public upliftDate: string;
    public sealExists: boolean;
    public isPaused: boolean;
    public pausedAwaitingAuth: boolean;

    public constructor(init?: Partial<AntelSealData>) { (Object as any).assign(this, init); }
}

export class DepotDropOffResponse extends ApiServiceResponse
{
    public sealData: AntelSealData;
    public weightRequired: boolean;
    public atDepot: boolean;
    public skipConfirm: boolean;

    public constructor(init?: Partial<DepotDropOffResponse>) { super(init); (Object as any).assign(this, init); }
}

export class DepotDropOff extends ApiServiceRequest
{
    public sealNumber: string;

    public constructor(init?: Partial<DepotDropOff>) { super(init); (Object as any).assign(this, init); }
}

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