| GET | /upliftscedule |
|---|
import Foundation
import ServiceStack
public class GetUpliftSchedule : ApiServiceRequest
{
required public init(){ super.init() }
required public init(from decoder: Decoder) throws {
try super.init(from: decoder)
}
public override func encode(to encoder: Encoder) throws {
try super.encode(to: encoder)
}
}
public class ApiServiceRequest : IServiceRequest, IHasApiKey, IHasDeviceInfo, Codable
{
/**
* The API Key required for authentication
*/
// @ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)
public var apiKey:String
/**
* Latitude of the user making this request
*/
// @ApiMember(DataType="double", Description="Latitude of the user making this request")
public var latitude:Double
/**
* Longitude of the user making this request
*/
// @ApiMember(DataType="double", Description="Longitude of the user making this request")
public var longitude:Double
required public init(){}
}
public class GetUpliftScheduleResponse : ApiServiceResponse
{
public var appointments:[AppointmentData] = []
required public init(){ super.init() }
private enum CodingKeys : String, CodingKey {
case appointments
}
required public init(from decoder: Decoder) throws {
try super.init(from: decoder)
let container = try decoder.container(keyedBy: CodingKeys.self)
appointments = try container.decodeIfPresent([AppointmentData].self, forKey: .appointments) ?? []
}
public override func encode(to encoder: Encoder) throws {
try super.encode(to: encoder)
var container = encoder.container(keyedBy: CodingKeys.self)
if appointments.count > 0 { try container.encode(appointments, forKey: .appointments) }
}
}
public class ApiServiceResponse : IServiceResponse, Codable
{
/**
* Information about the response.
*/
// @ApiMember(Description="Information about the response.", IsRequired=true)
public var Description:String
/**
* Heading or summary of the response.
*/
// @ApiMember(Description="Heading or summary of the response.", IsRequired=true)
public var heading:String
/**
* 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 var wasSuccessful:Bool
public var responseStatus:ResponseStatus
required public init(){}
}
public class AppointmentData : Codable
{
public var scheduleId:Int
public var appointmentDate:String
public var outletName:String
public var outletChannel:String
public var upliftStatus:UpliftScheduleStatus
public var isComplete:Bool
public var inProgress:Bool
public var isLate:Bool
public var goodToCollectStatus:Bool
public var principlesWithGoodsToCollect:String
public var principleAppointments:[AppointmentPrincipleData] = []
required public init(){}
}
public enum UpliftScheduleStatus : Int, Codable
{
case Unconfirmed = 0
case Confirmed = 1
case PortalCancelled = 4
case UserCancelled = 5
case NoOperatorAssigned = 6
}
public class AppointmentPrincipleData : Codable
{
public var principle:PrincipalData
public var scheduledDate:String
public var upliftScheduleId:Int
public var upliftSchedulePrincipleId:Int
public var principleOutletId:Int
public var verificationCode:String
public var goodsToCollect:Bool
public var outletRegion:String
public var outletName:String
public var outletChannel:String
public var outletLatitude:Double
public var outletLongitude:Double
public var maxSubmissionDistance:Double
public var actionOutsideMaxDistance:ActionOutsideMaxDistanceType
public var completedDate:String
public var cancelled:Bool
public var completed:Bool
public var upliftTemplate:UpliftTemplateData
public var prePopulated:Bool
public var allowedProductStockStatuses:[StockStatusData] = []
public var noteToOperator:String
public var sealTemplate:SealTemplateData
public var prePopulatedWithSeals:Bool
public var preAuthed:Bool
public var operatorName:String
public var systemUserId:Int
public var productExceptions:[ProductExceptionData] = []
public var storeConfirmationDocumentUrl:String
required public init(){}
}
public class PrincipalData : Codable
{
public var principalId:Int
public var name:String
public var authLetterFileUrl:[String] = []
public var logoImageUrl:String
public var products:[ProductDataCategory] = []
public var upliftPrefix:String
public var contactName:String
public var contactNumber:String
public var contactEmail:String
public var allowProductLookup:Bool
public var hasLogo:Bool
public var hasAuthLetter:Bool
public var sealNetWeightMandatory:Bool
public var allowBillableSeals:Bool
public var captureSerialNumber:Bool
public var batchCodesMandatory:Bool
public var captureManufactureAndExpiryDate:Bool
public var productExceptions:[ProductExceptionData] = []
public var usesOwnSealNumbers:Bool
required public init(){}
}
public class ProductDataCategory : Codable
{
public var unitBarcode:String
public var products:[ProductData] = []
required public init(){}
}
public class ProductData : Codable
{
public var productId:Int
public var principalId:Int
public var name:String
public var category:String
public var productCode:String
public var unitBarcode:String
public var cartonQuantity:Int
public var shrinkQuantity:Int
public var unitQuantity:Int
public var cartonMeasurement:String
public var shrinkMeasurement:String
public var unitMeasurement:String
public var cartonWeight:Double
public var shrinkWeight:Double
public var unitWeight:Double
public var cartonPrice:Double
public var shrinkPrice:Double
public var unitPrice:Double
public var maxQuantity:Int
public var maxPrice:Int
required public init(){}
}
public class ProductExceptionData : Codable
{
public var region:String
public var channel:String
public var productId:Int
public var stockStatusIds:[Int] = []
required public init(){}
}
public enum ActionOutsideMaxDistanceType : Int, Codable
{
case Warn = 0
case Block = 1
}
public class UpliftTemplateData : Codable
{
public var totalValue:Double
public var products:[TemplateProductData] = []
public var seals:[UpliftRequestSealData] = []
required public init(){}
}
public class TemplateProductData : Codable
{
public var name:String
public var productCode:String
public var barcode:String
public var statusQty:[Int:Int] = [:]
public var returnValue:Double
required public init(){}
}
public class UpliftRequestSealData : Codable
{
public var number:String
public var weight:Double
required public init(){}
}
public class StockStatusData : Codable
{
public var id:Int
public var name:String
public var photoRequired:Bool
public var color:String
required public init(){}
}
public class SealTemplateData : Codable
{
public var items:[SealTemplateItemData] = []
required public init(){}
}
public class SealTemplateItemData : Codable
{
public var sealNumber:String
public var productStockStatus:Int
public var products:[SealTemplateProduct] = []
required public init(){}
}
public class SealTemplateProduct : Codable
{
public var productId:Int
public var name:String
public var productStockStatusId:Int
public var quantity:Int
public var serialNumber:String
required public init(){}
}
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>