| GET | /upliftscedule |
|---|
"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;
}
/** @typedef {number} */
export var UpliftScheduleStatus;
(function (UpliftScheduleStatus) {
UpliftScheduleStatus[UpliftScheduleStatus["Unconfirmed"] = 0] = "Unconfirmed"
UpliftScheduleStatus[UpliftScheduleStatus["Confirmed"] = 1] = "Confirmed"
UpliftScheduleStatus[UpliftScheduleStatus["PortalCancelled"] = 4] = "PortalCancelled"
UpliftScheduleStatus[UpliftScheduleStatus["UserCancelled"] = 5] = "UserCancelled"
UpliftScheduleStatus[UpliftScheduleStatus["NoOperatorAssigned"] = 6] = "NoOperatorAssigned"
})(UpliftScheduleStatus || (UpliftScheduleStatus = {}));
export class ProductData {
/** @param {{productId?:number,principalId?:number,name?:string,category?:string,productCode?:string,unitBarcode?:string,cartonQuantity?:number,shrinkQuantity?:number,unitQuantity?:number,cartonMeasurement?:string,shrinkMeasurement?:string,unitMeasurement?:string,cartonWeight?:number,shrinkWeight?:number,unitWeight?:number,cartonPrice?:number,shrinkPrice?:number,unitPrice?:number,maxQuantity?:number,maxPrice?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
productId;
/** @type {number} */
principalId;
/** @type {string} */
name;
/** @type {string} */
category;
/** @type {string} */
productCode;
/** @type {string} */
unitBarcode;
/** @type {number} */
cartonQuantity;
/** @type {number} */
shrinkQuantity;
/** @type {number} */
unitQuantity;
/** @type {string} */
cartonMeasurement;
/** @type {string} */
shrinkMeasurement;
/** @type {string} */
unitMeasurement;
/** @type {number} */
cartonWeight;
/** @type {number} */
shrinkWeight;
/** @type {number} */
unitWeight;
/** @type {number} */
cartonPrice;
/** @type {number} */
shrinkPrice;
/** @type {number} */
unitPrice;
/** @type {number} */
maxQuantity;
/** @type {number} */
maxPrice;
}
export class ProductDataCategory {
/** @param {{unitBarcode?:string,products?:ProductData[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
unitBarcode;
/** @type {ProductData[]} */
products;
}
export class ProductExceptionData {
/** @param {{region?:string,channel?:string,productId?:number,stockStatusIds?:number[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
region;
/** @type {string} */
channel;
/** @type {number} */
productId;
/** @type {number[]} */
stockStatusIds;
}
export class PrincipalData {
/** @param {{principalId?:number,name?:string,authLetterFileUrl?:string[],logoImageUrl?:string,products?:ProductDataCategory[],upliftPrefix?:string,contactName?:string,contactNumber?:string,contactEmail?:string,allowProductLookup?:boolean,hasLogo?:boolean,hasAuthLetter?:boolean,sealNetWeightMandatory?:boolean,allowBillableSeals?:boolean,captureSerialNumber?:boolean,batchCodesMandatory?:boolean,captureManufactureAndExpiryDate?:boolean,productExceptions?:ProductExceptionData[],usesOwnSealNumbers?:boolean}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
principalId;
/** @type {string} */
name;
/** @type {string[]} */
authLetterFileUrl;
/** @type {string} */
logoImageUrl;
/** @type {ProductDataCategory[]} */
products;
/** @type {string} */
upliftPrefix;
/** @type {string} */
contactName;
/** @type {string} */
contactNumber;
/** @type {string} */
contactEmail;
/** @type {boolean} */
allowProductLookup;
/** @type {boolean} */
hasLogo;
/** @type {boolean} */
hasAuthLetter;
/** @type {boolean} */
sealNetWeightMandatory;
/** @type {boolean} */
allowBillableSeals;
/** @type {boolean} */
captureSerialNumber;
/** @type {boolean} */
batchCodesMandatory;
/** @type {boolean} */
captureManufactureAndExpiryDate;
/** @type {ProductExceptionData[]} */
productExceptions;
/** @type {boolean} */
usesOwnSealNumbers;
}
/** @typedef {number} */
export var ActionOutsideMaxDistanceType;
(function (ActionOutsideMaxDistanceType) {
ActionOutsideMaxDistanceType[ActionOutsideMaxDistanceType["Warn"] = 0] = "Warn"
ActionOutsideMaxDistanceType[ActionOutsideMaxDistanceType["Block"] = 1] = "Block"
})(ActionOutsideMaxDistanceType || (ActionOutsideMaxDistanceType = {}));
export class TemplateProductData {
/** @param {{name?:string,productCode?:string,barcode?:string,statusQty?:{ [index: number]: number; },returnValue?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
name;
/** @type {string} */
productCode;
/** @type {string} */
barcode;
/** @type {{ [index: number]: number; }} */
statusQty;
/** @type {number} */
returnValue;
}
export class UpliftRequestSealData {
/** @param {{number?:string,weight?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
number;
/** @type {number} */
weight;
}
export class UpliftTemplateData {
/** @param {{totalValue?:number,products?:TemplateProductData[],seals?:UpliftRequestSealData[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
totalValue;
/** @type {TemplateProductData[]} */
products;
/** @type {UpliftRequestSealData[]} */
seals;
}
export class StockStatusData {
/** @param {{id?:number,name?:string,photoRequired?:boolean,color?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
id;
/** @type {string} */
name;
/** @type {boolean} */
photoRequired;
/** @type {string} */
color;
}
export class SealTemplateProduct {
/** @param {{productId?:number,name?:string,productStockStatusId?:number,quantity?:number,serialNumber?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
productId;
/** @type {string} */
name;
/** @type {number} */
productStockStatusId;
/** @type {number} */
quantity;
/** @type {string} */
serialNumber;
}
export class SealTemplateItemData {
/** @param {{sealNumber?:string,productStockStatus?:number,products?:SealTemplateProduct[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
sealNumber;
/** @type {number} */
productStockStatus;
/** @type {SealTemplateProduct[]} */
products;
}
export class SealTemplateData {
/** @param {{items?:SealTemplateItemData[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {SealTemplateItemData[]} */
items;
}
export class AppointmentPrincipleData {
/** @param {{principle?:PrincipalData,scheduledDate?:string,upliftScheduleId?:number,upliftSchedulePrincipleId?:number,principleOutletId?:number,verificationCode?:string,goodsToCollect?:boolean,outletRegion?:string,outletName?:string,outletChannel?:string,outletLatitude?:number,outletLongitude?:number,maxSubmissionDistance?:number,actionOutsideMaxDistance?:ActionOutsideMaxDistanceType,completedDate?:string,cancelled?:boolean,completed?:boolean,upliftTemplate?:UpliftTemplateData,prePopulated?:boolean,allowedProductStockStatuses?:StockStatusData[],noteToOperator?:string,sealTemplate?:SealTemplateData,prePopulatedWithSeals?:boolean,preAuthed?:boolean,operatorName?:string,systemUserId?:number,productExceptions?:ProductExceptionData[],storeConfirmationDocumentUrl?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {PrincipalData} */
principle;
/** @type {string} */
scheduledDate;
/** @type {number} */
upliftScheduleId;
/** @type {number} */
upliftSchedulePrincipleId;
/** @type {number} */
principleOutletId;
/** @type {string} */
verificationCode;
/** @type {boolean} */
goodsToCollect;
/** @type {string} */
outletRegion;
/** @type {string} */
outletName;
/** @type {string} */
outletChannel;
/** @type {number} */
outletLatitude;
/** @type {number} */
outletLongitude;
/** @type {number} */
maxSubmissionDistance;
/** @type {ActionOutsideMaxDistanceType} */
actionOutsideMaxDistance;
/** @type {string} */
completedDate;
/** @type {boolean} */
cancelled;
/** @type {boolean} */
completed;
/** @type {UpliftTemplateData} */
upliftTemplate;
/** @type {boolean} */
prePopulated;
/** @type {StockStatusData[]} */
allowedProductStockStatuses;
/** @type {string} */
noteToOperator;
/** @type {SealTemplateData} */
sealTemplate;
/** @type {boolean} */
prePopulatedWithSeals;
/** @type {boolean} */
preAuthed;
/** @type {string} */
operatorName;
/** @type {number} */
systemUserId;
/** @type {ProductExceptionData[]} */
productExceptions;
/** @type {string} */
storeConfirmationDocumentUrl;
}
export class AppointmentData {
/** @param {{scheduleId?:number,appointmentDate?:string,outletName?:string,outletChannel?:string,upliftStatus?:UpliftScheduleStatus,isComplete?:boolean,inProgress?:boolean,isLate?:boolean,goodToCollectStatus?:boolean,principlesWithGoodsToCollect?:string,principleAppointments?:AppointmentPrincipleData[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
scheduleId;
/** @type {string} */
appointmentDate;
/** @type {string} */
outletName;
/** @type {string} */
outletChannel;
/** @type {UpliftScheduleStatus} */
upliftStatus;
/** @type {boolean} */
isComplete;
/** @type {boolean} */
inProgress;
/** @type {boolean} */
isLate;
/** @type {boolean} */
goodToCollectStatus;
/** @type {string} */
principlesWithGoodsToCollect;
/** @type {AppointmentPrincipleData[]} */
principleAppointments;
}
export class GetUpliftScheduleResponse extends ApiServiceResponse {
/** @param {{appointments?:AppointmentData[],description?:string,heading?:string,wasSuccessful?:boolean,responseStatus?:ResponseStatus}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {AppointmentData[]} */
appointments;
}
export class GetUpliftSchedule extends ApiServiceRequest {
/** @param {{apiKey?:string,latitude?:number,longitude?:number}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
}
JavaScript GetUpliftSchedule DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /upliftscedule HTTP/1.1 Host: antel.api.dev.86degrees.com Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<GetUpliftScheduleResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel">
<Description xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel.Base">String</Description>
<Heading xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel.Base">String</Heading>
<ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types" xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel.Base">
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:Message>String</d2p1:Message>
<d2p1:StackTrace>String</d2p1:StackTrace>
<d2p1:Errors>
<d2p1:ResponseError>
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:FieldName>String</d2p1:FieldName>
<d2p1:Message>String</d2p1:Message>
<d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringstring>
<d5p1:Key>String</d5p1:Key>
<d5p1:Value>String</d5p1:Value>
</d5p1:KeyValueOfstringstring>
</d2p1:Meta>
</d2p1:ResponseError>
</d2p1:Errors>
<d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:KeyValueOfstringstring>
<d3p1:Key>String</d3p1:Key>
<d3p1:Value>String</d3p1:Value>
</d3p1:KeyValueOfstringstring>
</d2p1:Meta>
</ResponseStatus>
<WasSuccessful xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel.Base">false</WasSuccessful>
<Appointments>
<AppointmentData>
<AppointmentDate>String</AppointmentDate>
<GoodToCollectStatus>false</GoodToCollectStatus>
<InProgress>false</InProgress>
<IsComplete>false</IsComplete>
<IsLate>false</IsLate>
<OutletChannel>String</OutletChannel>
<OutletName>String</OutletName>
<PrincipleAppointments>
<AppointmentPrincipleData>
<ActionOutsideMaxDistance>Warn</ActionOutsideMaxDistance>
<AllowedProductStockStatuses>
<StockStatusData>
<Color>String</Color>
<Id>0</Id>
<Name>String</Name>
<PhotoRequired>false</PhotoRequired>
</StockStatusData>
</AllowedProductStockStatuses>
<Cancelled>false</Cancelled>
<Completed>false</Completed>
<CompletedDate>String</CompletedDate>
<GoodsToCollect>false</GoodsToCollect>
<MaxSubmissionDistance>0</MaxSubmissionDistance>
<NoteToOperator>String</NoteToOperator>
<OperatorName>String</OperatorName>
<OutletChannel>String</OutletChannel>
<OutletLatitude>0</OutletLatitude>
<OutletLongitude>0</OutletLongitude>
<OutletName>String</OutletName>
<OutletRegion>String</OutletRegion>
<PreAuthed>false</PreAuthed>
<PrePopulated>false</PrePopulated>
<PrePopulatedWithSeals>false</PrePopulatedWithSeals>
<Principle>
<AllowBillableSeals>false</AllowBillableSeals>
<AllowProductLookup>false</AllowProductLookup>
<AuthLetterFileUrl xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d7p1:string>String</d7p1:string>
</AuthLetterFileUrl>
<BatchCodesMandatory>false</BatchCodesMandatory>
<CaptureManufactureAndExpiryDate>false</CaptureManufactureAndExpiryDate>
<CaptureSerialNumber>false</CaptureSerialNumber>
<ContactEmail>String</ContactEmail>
<ContactName>String</ContactName>
<ContactNumber>String</ContactNumber>
<HasAuthLetter>false</HasAuthLetter>
<HasLogo>false</HasLogo>
<LogoImageUrl>String</LogoImageUrl>
<Name>String</Name>
<PrincipalId>0</PrincipalId>
<ProductExceptions>
<ProductExceptionData>
<Channel>String</Channel>
<ProductId>0</ProductId>
<Region>String</Region>
<StockStatusIds xmlns:d9p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d9p1:int>0</d9p1:int>
</StockStatusIds>
</ProductExceptionData>
</ProductExceptions>
<Products>
<ProductDataCategory>
<Products>
<ProductData>
<CartonMeasurement>String</CartonMeasurement>
<CartonPrice>0</CartonPrice>
<CartonQuantity>0</CartonQuantity>
<CartonWeight>0</CartonWeight>
<Category>String</Category>
<MaxPrice>0</MaxPrice>
<MaxQuantity>0</MaxQuantity>
<Name>String</Name>
<PrincipalId>0</PrincipalId>
<ProductCode>String</ProductCode>
<ProductId>0</ProductId>
<ShrinkMeasurement>String</ShrinkMeasurement>
<ShrinkPrice>0</ShrinkPrice>
<ShrinkQuantity>0</ShrinkQuantity>
<ShrinkWeight>0</ShrinkWeight>
<UnitBarcode>String</UnitBarcode>
<UnitMeasurement>String</UnitMeasurement>
<UnitPrice>0</UnitPrice>
<UnitQuantity>0</UnitQuantity>
<UnitWeight>0</UnitWeight>
</ProductData>
</Products>
<UnitBarcode>String</UnitBarcode>
</ProductDataCategory>
</Products>
<SealNetWeightMandatory>false</SealNetWeightMandatory>
<UpliftPrefix>String</UpliftPrefix>
<UsesOwnSealNumbers>false</UsesOwnSealNumbers>
</Principle>
<PrincipleOutletId>0</PrincipleOutletId>
<ProductExceptions>
<ProductExceptionData>
<Channel>String</Channel>
<ProductId>0</ProductId>
<Region>String</Region>
<StockStatusIds xmlns:d8p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d8p1:int>0</d8p1:int>
</StockStatusIds>
</ProductExceptionData>
</ProductExceptions>
<ScheduledDate>String</ScheduledDate>
<SealTemplate>
<Items>
<SealTemplateData.SealTemplateItemData>
<ProductStockStatus>0</ProductStockStatus>
<Products xmlns:d9p1="http://schemas.datacontract.org/2004/07/BusinessLogic.Entities">
<d9p1:SealTemplateProduct>
<d9p1:Name>String</d9p1:Name>
<d9p1:ProductId>0</d9p1:ProductId>
<d9p1:ProductStockStatusId>0</d9p1:ProductStockStatusId>
<d9p1:Quantity>0</d9p1:Quantity>
<d9p1:SerialNumber>String</d9p1:SerialNumber>
</d9p1:SealTemplateProduct>
</Products>
<SealNumber>String</SealNumber>
</SealTemplateData.SealTemplateItemData>
</Items>
</SealTemplate>
<StoreConfirmationDocumentUrl>String</StoreConfirmationDocumentUrl>
<SystemUserId>0</SystemUserId>
<UpliftScheduleId>0</UpliftScheduleId>
<UpliftSchedulePrincipleId>0</UpliftSchedulePrincipleId>
<UpliftTemplate>
<Products>
<UpliftTemplateData.TemplateProductData>
<Barcode>String</Barcode>
<Name>String</Name>
<ProductCode>String</ProductCode>
<ReturnValue>0</ReturnValue>
<StatusQty xmlns:d9p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d9p1:KeyValueOfintint>
<d9p1:Key>0</d9p1:Key>
<d9p1:Value>0</d9p1:Value>
</d9p1:KeyValueOfintint>
</StatusQty>
</UpliftTemplateData.TemplateProductData>
</Products>
<Seals xmlns:d7p1="http://schemas.datacontract.org/2004/07/BusinessLogic.Entities">
<d7p1:UpliftRequestSealData>
<d7p1:Number>String</d7p1:Number>
<d7p1:Weight>0</d7p1:Weight>
</d7p1:UpliftRequestSealData>
</Seals>
<TotalValue>0</TotalValue>
</UpliftTemplate>
<VerificationCode>String</VerificationCode>
</AppointmentPrincipleData>
</PrincipleAppointments>
<ScheduleId>0</ScheduleId>
<UpliftStatus>Unconfirmed</UpliftStatus>
</AppointmentData>
</Appointments>
</GetUpliftScheduleResponse>