Antel API

<back to all web services

CloseOrderArrival

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 StockOperationSealItem
{
    public upliftNumber: string;
    public sealNumber: string;
    public principalName: string;
    public currentWeight: number;
    public weightDifference: number;
    public operatorName: string;
    public outletName: string;
    public upliftDate: string;
    public pausedAwaitingAuth: boolean;
    public upliftPdfLink: string;

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

export class StockOperationSummary
{
    public scannedSeals: StockOperationSealItem[];
    public missingSeals: StockOperationSealItem[];
    public unknownUpliftSeals: StockOperationSealItem[];
    public pausedSeals: StockOperationSealItem[];
    public weightDifferenceSeals: StockOperationSealItem[];
    public hasScannedSeals: boolean;
    public hasMissingSeals: boolean;
    public hasWeightDifferenceSeals: boolean;
    public hasUnknownUpliftSeals: boolean;
    public hasPausedSeals: boolean;
    public hasException: boolean;
    public totalSealsCount: number;
    public totalSealsWeight: number;

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

export class CloseOrderArrivalResponse extends ApiServiceResponse
{
    public orderNumber: string;
    public requestingOperatorName: string;
    public operatorName: string;
    public destinationDepot: string;
    public driverName: string;
    public companyName: string;
    public licensePlate: string;
    public orderId: number;
    public estimatedSeals: number;
    public operationSummary: StockOperationSummary;

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

export class CloseOrderArrival extends ApiServiceRequest
{
    public orderNumber: string;

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

TypeScript CloseOrderArrival DTOs

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

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

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

{
	orderNumber: String,
	requestingOperatorName: String,
	operatorName: String,
	destinationDepot: String,
	driverName: String,
	companyName: String,
	licensePlate: String,
	orderId: 0,
	estimatedSeals: 0,
	operationSummary: 
	{
		scannedSeals: 
		[
			{
				upliftNumber: String,
				sealNumber: String,
				principalName: String,
				currentWeight: 0,
				weightDifference: 0,
				operatorName: String,
				outletName: String,
				upliftDate: String,
				pausedAwaitingAuth: False,
				upliftPdfLink: String
			}
		],
		missingSeals: 
		[
			{
				upliftNumber: String,
				sealNumber: String,
				principalName: String,
				currentWeight: 0,
				weightDifference: 0,
				operatorName: String,
				outletName: String,
				upliftDate: String,
				pausedAwaitingAuth: False,
				upliftPdfLink: String
			}
		],
		unknownUpliftSeals: 
		[
			{
				upliftNumber: String,
				sealNumber: String,
				principalName: String,
				currentWeight: 0,
				weightDifference: 0,
				operatorName: String,
				outletName: String,
				upliftDate: String,
				pausedAwaitingAuth: False,
				upliftPdfLink: String
			}
		],
		pausedSeals: 
		[
			{
				upliftNumber: String,
				sealNumber: String,
				principalName: String,
				currentWeight: 0,
				weightDifference: 0,
				operatorName: String,
				outletName: String,
				upliftDate: String,
				pausedAwaitingAuth: False,
				upliftPdfLink: String
			}
		],
		weightDifferenceSeals: 
		[
			{
				upliftNumber: String,
				sealNumber: String,
				principalName: String,
				currentWeight: 0,
				weightDifference: 0,
				operatorName: String,
				outletName: String,
				upliftDate: String,
				pausedAwaitingAuth: False,
				upliftPdfLink: String
			}
		],
		hasScannedSeals: True,
		hasMissingSeals: True,
		hasWeightDifferenceSeals: True,
		hasUnknownUpliftSeals: True,
		hasPausedSeals: True,
		hasException: True,
		totalSealsCount: 4,
		totalSealsWeight: 0
	},
	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
		}
	}
}