| GET | /upliftscedule |
|---|
namespace WebService.ServiceModel
open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
[<AllowNullLiteral>]
type ApiServiceResponse() =
///<summary>
///Information about the response.
///</summary>
[<ApiMember(Description="Information about the response.", IsRequired=true)>]
member val Description:String = null with get,set
///<summary>
///Heading or summary of the response.
///</summary>
[<ApiMember(Description="Heading or summary of the response.", IsRequired=true)>]
member val Heading:String = null with get,set
///<summary>
///Did the intended operation for this response complete successfully?
///</summary>
[<ApiMember(DataType="boolean", Description="Did the intended operation for this response complete successfully?", IsRequired=true)>]
member val WasSuccessful:Boolean = new Boolean() with get,set
member val ResponseStatus:ResponseStatus = null with get,set
type UpliftScheduleStatus =
| Unconfirmed = 0
| Confirmed = 1
| PortalCancelled = 4
| UserCancelled = 5
| NoOperatorAssigned = 6
[<AllowNullLiteral>]
type ProductData() =
member val ProductId:Int32 = new Int32() with get,set
member val PrincipalId:Int32 = new Int32() with get,set
member val Name:String = null with get,set
member val Category:String = null with get,set
member val ProductCode:String = null with get,set
member val UnitBarcode:String = null with get,set
member val CartonQuantity:Int32 = new Int32() with get,set
member val ShrinkQuantity:Int32 = new Int32() with get,set
member val UnitQuantity:Int32 = new Int32() with get,set
member val CartonMeasurement:String = null with get,set
member val ShrinkMeasurement:String = null with get,set
member val UnitMeasurement:String = null with get,set
member val CartonWeight:Double = new Double() with get,set
member val ShrinkWeight:Double = new Double() with get,set
member val UnitWeight:Decimal = new Decimal() with get,set
member val CartonPrice:Decimal = new Decimal() with get,set
member val ShrinkPrice:Decimal = new Decimal() with get,set
member val UnitPrice:Decimal = new Decimal() with get,set
member val MaxQuantity:Int32 = new Int32() with get,set
member val MaxPrice:Int32 = new Int32() with get,set
[<AllowNullLiteral>]
type ProductDataCategory() =
member val UnitBarcode:String = null with get,set
member val Products:ResizeArray<ProductData> = new ResizeArray<ProductData>() with get,set
[<AllowNullLiteral>]
type ProductExceptionData() =
member val Region:String = null with get,set
member val Channel:String = null with get,set
member val ProductId:Int32 = new Int32() with get,set
member val StockStatusIds:ResizeArray<Int32> = new ResizeArray<Int32>() with get,set
[<AllowNullLiteral>]
type PrincipalData() =
member val PrincipalId:Int32 = new Int32() with get,set
member val Name:String = null with get,set
member val AuthLetterFileUrl:ResizeArray<String> = new ResizeArray<String>() with get,set
member val LogoImageUrl:String = null with get,set
member val Products:ResizeArray<ProductDataCategory> = new ResizeArray<ProductDataCategory>() with get,set
member val UpliftPrefix:String = null with get,set
member val ContactName:String = null with get,set
member val ContactNumber:String = null with get,set
member val ContactEmail:String = null with get,set
member val AllowProductLookup:Boolean = new Boolean() with get,set
member val HasLogo:Boolean = new Boolean() with get,set
member val HasAuthLetter:Boolean = new Boolean() with get,set
member val SealNetWeightMandatory:Boolean = new Boolean() with get,set
member val AllowBillableSeals:Boolean = new Boolean() with get,set
member val CaptureSerialNumber:Boolean = new Boolean() with get,set
member val BatchCodesMandatory:Boolean = new Boolean() with get,set
member val CaptureManufactureAndExpiryDate:Boolean = new Boolean() with get,set
member val ProductExceptions:ResizeArray<ProductExceptionData> = new ResizeArray<ProductExceptionData>() with get,set
member val UsesOwnSealNumbers:Boolean = new Boolean() with get,set
type ActionOutsideMaxDistanceType =
| Warn = 0
| Block = 1
[<AllowNullLiteral>]
type TemplateProductData() =
member val Name:String = null with get,set
member val ProductCode:String = null with get,set
member val Barcode:String = null with get,set
member val StatusQty:Dictionary<Int32, Int32> = new Dictionary<Int32, Int32>() with get,set
member val ReturnValue:Decimal = new Decimal() with get,set
[<AllowNullLiteral>]
type UpliftRequestSealData() =
member val Number:String = null with get,set
member val Weight:Double = new Double() with get,set
[<AllowNullLiteral>]
type UpliftTemplateData() =
member val TotalValue:Decimal = new Decimal() with get,set
member val Products:ResizeArray<TemplateProductData> = new ResizeArray<TemplateProductData>() with get,set
member val Seals:ResizeArray<UpliftRequestSealData> = new ResizeArray<UpliftRequestSealData>() with get,set
[<AllowNullLiteral>]
type StockStatusData() =
member val Id:Int32 = new Int32() with get,set
member val Name:String = null with get,set
member val PhotoRequired:Boolean = new Boolean() with get,set
member val Color:String = null with get,set
[<AllowNullLiteral>]
type SealTemplateProduct() =
member val ProductId:Int32 = new Int32() with get,set
member val Name:String = null with get,set
member val ProductStockStatusId:Int32 = new Int32() with get,set
member val Quantity:Int32 = new Int32() with get,set
member val SerialNumber:String = null with get,set
[<AllowNullLiteral>]
type SealTemplateItemData() =
member val SealNumber:String = null with get,set
member val ProductStockStatus:Int32 = new Int32() with get,set
member val Products:ResizeArray<SealTemplateProduct> = new ResizeArray<SealTemplateProduct>() with get,set
[<AllowNullLiteral>]
type SealTemplateData() =
member val Items:ResizeArray<SealTemplateItemData> = new ResizeArray<SealTemplateItemData>() with get,set
[<AllowNullLiteral>]
type AppointmentPrincipleData() =
member val Principle:PrincipalData = null with get,set
member val ScheduledDate:String = null with get,set
member val UpliftScheduleId:Int32 = new Int32() with get,set
member val UpliftSchedulePrincipleId:Int32 = new Int32() with get,set
member val PrincipleOutletId:Int32 = new Int32() with get,set
member val VerificationCode:String = null with get,set
member val GoodsToCollect:Boolean = new Boolean() with get,set
member val OutletRegion:String = null with get,set
member val OutletName:String = null with get,set
member val OutletChannel:String = null with get,set
member val OutletLatitude:Double = new Double() with get,set
member val OutletLongitude:Double = new Double() with get,set
member val MaxSubmissionDistance:Double = new Double() with get,set
member val ActionOutsideMaxDistance:ActionOutsideMaxDistanceType = new ActionOutsideMaxDistanceType() with get,set
member val CompletedDate:String = null with get,set
member val Cancelled:Boolean = new Boolean() with get,set
member val Completed:Boolean = new Boolean() with get,set
member val UpliftTemplate:UpliftTemplateData = null with get,set
member val PrePopulated:Boolean = new Boolean() with get,set
member val AllowedProductStockStatuses:ResizeArray<StockStatusData> = new ResizeArray<StockStatusData>() with get,set
member val NoteToOperator:String = null with get,set
member val SealTemplate:SealTemplateData = null with get,set
member val PrePopulatedWithSeals:Boolean = new Boolean() with get,set
member val PreAuthed:Boolean = new Boolean() with get,set
member val OperatorName:String = null with get,set
member val SystemUserId:Int32 = new Int32() with get,set
member val ProductExceptions:ResizeArray<ProductExceptionData> = new ResizeArray<ProductExceptionData>() with get,set
member val StoreConfirmationDocumentUrl:String = null with get,set
[<AllowNullLiteral>]
type AppointmentData() =
member val ScheduleId:Int32 = new Int32() with get,set
member val AppointmentDate:String = null with get,set
member val OutletName:String = null with get,set
member val OutletChannel:String = null with get,set
member val UpliftStatus:UpliftScheduleStatus = new UpliftScheduleStatus() with get,set
member val IsComplete:Boolean = new Boolean() with get,set
member val InProgress:Boolean = new Boolean() with get,set
member val IsLate:Boolean = new Boolean() with get,set
member val GoodToCollectStatus:Boolean = new Boolean() with get,set
member val PrinciplesWithGoodsToCollect:String = null with get,set
member val PrincipleAppointments:ResizeArray<AppointmentPrincipleData> = new ResizeArray<AppointmentPrincipleData>() with get,set
[<AllowNullLiteral>]
type GetUpliftScheduleResponse() =
inherit ApiServiceResponse()
member val Appointments:ResizeArray<AppointmentData> = new ResizeArray<AppointmentData>() with get,set
[<AllowNullLiteral>]
type ApiServiceRequest() =
///<summary>
///The API Key required for authentication
///</summary>
[<ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)>]
member val ApiKey:String = null with get,set
///<summary>
///Latitude of the user making this request
///</summary>
[<ApiMember(DataType="double", Description="Latitude of the user making this request")>]
member val Latitude:Double = new Double() with get,set
///<summary>
///Longitude of the user making this request
///</summary>
[<ApiMember(DataType="double", Description="Longitude of the user making this request")>]
member val Longitude:Double = new Double() with get,set
[<AllowNullLiteral>]
type GetUpliftSchedule() =
inherit ApiServiceRequest()
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
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/csv
HTTP/1.1 200 OK
Content-Type: text/csv
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"}}}