| 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 .jsv suffix or ?format=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
}
}
}