| POST | /stock/seal/details |
|---|
"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 FileDataItem {
/** @param {{fileName?:string,fileUrl?:string,thumbnailUrl?:string,fileId?:string,thumbnailId?:string,linkId?:number,createdDate?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
fileName;
/** @type {string} */
fileUrl;
/** @type {string} */
thumbnailUrl;
/** @type {string} */
fileId;
/** @type {string} */
thumbnailId;
/** @type {number} */
linkId;
/** @type {string} */
createdDate;
}
export class SealOrderHistoryItem {
/** @param {{createdDate?:string,orderId?:number,orderNumber?:string,orderRequestingOperator?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
createdDate;
/** @type {number} */
orderId;
/** @type {string} */
orderNumber;
/** @type {string} */
orderRequestingOperator;
}
export class SealMovementHistoryItem {
/** @param {{id?:number,eventDateTime?:string,actionUserName?:string,scannedDepotName?:string,assignedBucketName?:string,assignedOrderNumber?:string,assignedOperatorName?:string,orderDriverName?:string,orderDriverCompanyName?:string,orderDriverLicensePlate?:string,targetWeight?:number,currentWeight?:number,hadWeightIssue?:boolean,hadUnknownUplift?:boolean,wasPaused?:boolean,pausedWasAwaitingAuth?:boolean}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
id;
/** @type {string} */
eventDateTime;
/** @type {string} */
actionUserName;
/** @type {string} */
scannedDepotName;
/** @type {string} */
assignedBucketName;
/** @type {string} */
assignedOrderNumber;
/** @type {string} */
assignedOperatorName;
/** @type {string} */
orderDriverName;
/** @type {string} */
orderDriverCompanyName;
/** @type {string} */
orderDriverLicensePlate;
/** @type {number} */
targetWeight;
/** @type {number} */
currentWeight;
/** @type {boolean} */
hadWeightIssue;
/** @type {boolean} */
hadUnknownUplift;
/** @type {boolean} */
wasPaused;
/** @type {boolean} */
pausedWasAwaitingAuth;
}
export class SealDetailsResponse extends ApiServiceResponse {
/** @param {{principalName?:string,upliftNumber?:string,operatorName?:string,outletName?:string,upliftDate?:string,sealNumber?:string,currentWeight?:string,targetWeight?:string,hasWeightIssue?:boolean,bucketName?:string,claimNumbers?:string[],joinedClaimNumbers?:string,sealImages?:FileDataItem[],orderHistory?:SealOrderHistoryItem[],movementHistory?:SealMovementHistoryItem[],description?:string,heading?:string,wasSuccessful?:boolean,responseStatus?:ResponseStatus}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {string} */
principalName;
/** @type {string} */
upliftNumber;
/** @type {string} */
operatorName;
/** @type {string} */
outletName;
/** @type {string} */
upliftDate;
/** @type {string} */
sealNumber;
/** @type {string} */
currentWeight;
/** @type {string} */
targetWeight;
/** @type {boolean} */
hasWeightIssue;
/** @type {string} */
bucketName;
/** @type {string[]} */
claimNumbers;
/** @type {string} */
joinedClaimNumbers;
/** @type {FileDataItem[]} */
sealImages;
/** @type {SealOrderHistoryItem[]} */
orderHistory;
/** @type {SealMovementHistoryItem[]} */
movementHistory;
}
export class SealDetailsRequest extends ApiServiceRequest {
/** @param {{sealId?:number,apiKey?:string,latitude?:number,longitude?:number}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {number} */
sealId;
}
JavaScript SealDetailsRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /stock/seal/details HTTP/1.1
Host: antel.api.dev.86degrees.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
sealId: 0,
apiKey: String,
latitude: 0,
longitude: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
principalName: String,
upliftNumber: String,
operatorName: String,
outletName: String,
upliftDate: String,
sealNumber: String,
currentWeight: String,
targetWeight: String,
hasWeightIssue: False,
bucketName: String,
claimNumbers:
[
String
],
joinedClaimNumbers: String,
sealImages:
[
{
fileName: String,
fileUrl: String,
thumbnailUrl: String,
linkId: 0,
createdDate: 0001-01-01
}
],
orderHistory:
[
{
createdDate: String,
orderId: 0,
orderNumber: String,
orderRequestingOperator: String
}
],
movementHistory:
[
{
id: 0,
eventDateTime: String,
actionUserName: String,
scannedDepotName: String,
assignedBucketName: String,
assignedOrderNumber: String,
assignedOperatorName: String,
orderDriverName: String,
orderDriverCompanyName: String,
orderDriverLicensePlate: String,
targetWeight: 0,
currentWeight: 0,
hadWeightIssue: False,
hadUnknownUplift: False,
wasPaused: False,
pausedWasAwaitingAuth: 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
}
}
}