Antel API

GetUpliftSchedule

The following routes are available for this service:
GET	/upliftscedule

**ApiServiceRequest** Parameters:
Name	Parameter	Data Type	Required	Description
ApiKey	form	string	Yes	The API Key required for authentication
Latitude	form	double	No	Latitude of the user making this request
Longitude	form	double	No	Longitude of the user making this request

**GetUpliftScheduleResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Appointments	form	List<AppointmentData>	No

**ApiServiceResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Description	form	string	Yes	Information about the response.
Heading	form	string	Yes	Heading or summary of the response.
WasSuccessful	form	boolean	Yes	Did the intended operation for this response complete successfully?
ResponseStatus	form	ResponseStatus	No

**AppointmentData** Parameters:
Name	Parameter	Data Type	Required
ScheduleId	form	int	No
AppointmentDate	form	string	No
OutletName	form	string	No
OutletChannel	form	string	No
UpliftStatus	form	UpliftScheduleStatus	No
IsComplete	form	bool	No
InProgress	form	bool	No
IsLate	form	bool	No
GoodToCollectStatus	form	bool	No
PrinciplesWithGoodsToCollect	form	string	No
PrincipleAppointments	form	List<AppointmentPrincipleData>	No

**UpliftScheduleStatus** Enum:
Name	Value
Unconfirmed	0
Confirmed	1
PortalCancelled	4
UserCancelled	5
NoOperatorAssigned	6

**AppointmentPrincipleData** Parameters:
Name	Parameter	Data Type	Required
Principle	form	PrincipalData	No
ScheduledDate	form	string	No
UpliftScheduleId	form	int	No
UpliftSchedulePrincipleId	form	int	No
PrincipleOutletId	form	int	No
VerificationCode	form	string	No
GoodsToCollect	form	bool	No
OutletRegion	form	string	No
OutletName	form	string	No
OutletChannel	form	string	No
OutletLatitude	form	double	No
OutletLongitude	form	double	No
MaxSubmissionDistance	form	double	No
ActionOutsideMaxDistance	form	ActionOutsideMaxDistanceType	No
CompletedDate	form	string	No
Cancelled	form	bool	No
Completed	form	bool	No
UpliftTemplate	form	UpliftTemplateData	No
PrePopulated	form	bool	No
AllowedProductStockStatuses	form	List<StockStatusData>	No
NoteToOperator	form	string	No
SealTemplate	form	SealTemplateData	No
PrePopulatedWithSeals	form	bool	No
PreAuthed	form	bool	No
OperatorName	form	string	No
SystemUserId	form	int	No
ProductExceptions	form	List<ProductExceptionData>	No
StoreConfirmationDocumentUrl	form	string	No

**PrincipalData** Parameters:
Name	Parameter	Data Type	Required
PrincipalId	form	int	No
Name	form	string	No
AuthLetterFileUrl	form	List<string>	No
LogoImageUrl	form	string	No
Products	form	List<ProductDataCategory>	No
UpliftPrefix	form	string	No
ContactName	form	string	No
ContactNumber	form	string	No
ContactEmail	form	string	No
AllowProductLookup	form	bool	No
HasLogo	form	bool	No
HasAuthLetter	form	bool	No
SealNetWeightMandatory	form	bool	No
AllowBillableSeals	form	bool	No
CaptureSerialNumber	form	bool	No
BatchCodesMandatory	form	bool	No
CaptureManufactureAndExpiryDate	form	bool	No
ProductExceptions	form	List<ProductExceptionData>	No
UsesOwnSealNumbers	form	bool	No

**ProductDataCategory** Parameters:
Name	Parameter	Data Type	Required	Description
UnitBarcode	form	string	No
Products	form	List<ProductData>	No

**ProductData** Parameters:
Name	Parameter	Data Type	Required
ProductId	form	int	No
PrincipalId	form	int	No
Name	form	string	No
Category	form	string	No
ProductCode	form	string	No
UnitBarcode	form	string	No
CartonQuantity	form	int	No
ShrinkQuantity	form	int	No
UnitQuantity	form	int	No
CartonMeasurement	form	string	No
ShrinkMeasurement	form	string	No
UnitMeasurement	form	string	No
CartonWeight	form	double	No
ShrinkWeight	form	double	No
UnitWeight	form	decimal	No
CartonPrice	form	decimal	No
ShrinkPrice	form	decimal	No
UnitPrice	form	decimal	No
MaxQuantity	form	int	No
MaxPrice	form	int	No

**ProductExceptionData** Parameters:
Name	Parameter	Data Type	Required
Region	form	string	No
Channel	form	string	No
ProductId	form	int	No
StockStatusIds	form	List<int>	No

**ActionOutsideMaxDistanceType** Enum:
Name	Value
Warn	0
Block	1

**UpliftTemplateData** Parameters:
Name	Parameter	Data Type	Required
TotalValue	form	decimal	No
Products	form	List<TemplateProductData>	No
Seals	form	List<UpliftRequestSealData>	No

**TemplateProductData** Parameters:
Name	Parameter	Data Type	Required
Name	form	string	No
ProductCode	form	string	No
Barcode	form	string	No
StatusQty	form	Dictionary<int, int>	No
ReturnValue	form	decimal	No

**UpliftRequestSealData** Parameters:
Name	Parameter	Data Type	Required	Description
Number	form	string	No
Weight	form	double	No

**StockStatusData** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
Name	form	string	No
PhotoRequired	form	bool	No
Color	form	string	No

**SealTemplateData** Parameters:
Name	Parameter	Data Type	Required	Description
Items	form	List<SealTemplateItemData>	No

**SealTemplateItemData** Parameters:
Name	Parameter	Data Type	Required
SealNumber	form	string	No
ProductStockStatus	form	int	No
Products	form	List<SealTemplateProduct>	No

**SealTemplateProduct** Parameters:
Name	Parameter	Data Type	Required
ProductId	form	int	No
Name	form	string	No
ProductStockStatusId	form	int	No
Quantity	form	int	No
SerialNumber	form	string	No

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.

GET /upliftscedule HTTP/1.1 
Host: antel.api.dev.86degrees.com 
Accept: text/jsv

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

{
	appointments: 
	[
		{
			scheduleId: 0,
			appointmentDate: String,
			outletName: String,
			outletChannel: String,
			upliftStatus: 0,
			isComplete: False,
			inProgress: False,
			isLate: False,
			goodToCollectStatus: False,
			principlesWithGoodsToCollect: "",
			principleAppointments: 
			[
				{
					principle: 
					{
						principalId: 0,
						name: String,
						authLetterFileUrl: 
						[
							String
						],
						logoImageUrl: String,
						products: 
						[
							{
								unitBarcode: String,
								products: 
								[
									{
										productId: 0,
										principalId: 0,
										name: String,
										category: String,
										productCode: String,
										unitBarcode: String,
										cartonQuantity: 0,
										shrinkQuantity: 0,
										unitQuantity: 0,
										cartonMeasurement: String,
										shrinkMeasurement: String,
										unitMeasurement: String,
										cartonWeight: 0,
										shrinkWeight: 0,
										unitWeight: 0,
										cartonPrice: 0,
										shrinkPrice: 0,
										unitPrice: 0,
										maxQuantity: 0,
										maxPrice: 0
									}
								]
							}
						],
						upliftPrefix: String,
						contactName: String,
						contactNumber: String,
						contactEmail: String,
						allowProductLookup: False,
						hasLogo: False,
						hasAuthLetter: False,
						sealNetWeightMandatory: False,
						allowBillableSeals: False,
						captureSerialNumber: False,
						batchCodesMandatory: False,
						captureManufactureAndExpiryDate: False,
						productExceptions: 
						[
							{
								region: String,
								channel: String,
								productId: 0,
								stockStatusIds: 
								[
									0
								]
							}
						],
						usesOwnSealNumbers: False
					},
					scheduledDate: String,
					upliftScheduleId: 0,
					upliftSchedulePrincipleId: 0,
					principleOutletId: 0,
					verificationCode: String,
					goodsToCollect: False,
					outletRegion: String,
					outletName: String,
					outletChannel: String,
					outletLatitude: 0,
					outletLongitude: 0,
					maxSubmissionDistance: 0,
					actionOutsideMaxDistance: 0,
					completedDate: String,
					cancelled: False,
					completed: False,
					upliftTemplate: 
					{
						totalValue: 0,
						products: 
						[
							{
								name: String,
								productCode: String,
								barcode: String,
								statusQty: 
								{
									0: 0
								},
								returnValue: 0
							}
						],
						seals: 
						[
							{
								number: String,
								weight: 0
							}
						]
					},
					prePopulated: False,
					allowedProductStockStatuses: 
					[
						{
							id: 0,
							name: String,
							photoRequired: False,
							color: String
						}
					],
					noteToOperator: String,
					sealTemplate: 
					{
						items: 
						[
							{
								sealNumber: String,
								productStockStatus: 0,
								products: 
								[
									{
										productId: 0,
										name: String,
										productStockStatusId: 0,
										quantity: 0,
										serialNumber: String
									}
								]
							}
						]
					},
					prePopulatedWithSeals: False,
					preAuthed: False,
					operatorName: String,
					systemUserId: 0,
					productExceptions: 
					[
						{
							region: String,
							channel: String,
							productId: 0,
							stockStatusIds: 
							[
								0
							]
						}
					],
					storeConfirmationDocumentUrl: String
				}
			]
		}
	],
	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
		}
	}
}