| POST | /uplift |
|---|
import Foundation
import ServiceStack
public class SaveUplift : ApiServiceRequest
{
public var uplift:UpliftData
required public init(){ super.init() }
private enum CodingKeys : String, CodingKey {
case uplift
}
required public init(from decoder: Decoder) throws {
try super.init(from: decoder)
let container = try decoder.container(keyedBy: CodingKeys.self)
uplift = try container.decodeIfPresent(UpliftData.self, forKey: .uplift)
}
public override func encode(to encoder: Encoder) throws {
try super.encode(to: encoder)
var container = encoder.container(keyedBy: CodingKeys.self)
if uplift != nil { try container.encode(uplift, forKey: .uplift) }
}
}
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 UpliftData : Codable
{
public var upliftId:Int
public var principleOutletId:Int
public var upliftScheduleId:Int
public var upliftSchedulePrincipleId:Int
public var authRequestId:String
public var delayedAuth:Bool
public var appointmentPrincipleData:AppointmentPrincipleData
public var authCode:String
public var startTime:String
public var endTime:String
public var sequentialNumber:String
public var startLatitude:Double
public var startLongitude:Double
public var endLatitude:Double
public var endLongitude:Double
public var totalValue:Double
public var totalUnits:Double
public var comments:String
public var adhocEmailAddress:String
public var vatValue:Double
public var statusImages:[Int:[Object]] = [:]
public var damagedOkImages:[Object] = []
public var damagedBadImages:[Object] = []
public var expiredImages:[Object] = []
public var recallImages:[Object] = []
public var goodStockImages:[Object] = []
public var derangedImages:[Object] = []
public var overstockedImages:[Object] = []
public var factoryFaultImages:[Object] = []
public var outletContactName:String
public var outletContactNumber:String
public var outletLatitude:Double
public var outletLongitude:Double
public var maxSubmissionDistance:Double
public var actionOutsideMaxDistance:ActionOutsideMaxDistanceType
//outletSignatureImage:Object ignored. Type could not be extended in Swift
//operatorSignatureImage:Object ignored. Type could not be extended in Swift
//operatorRegNumberImage:Object ignored. Type could not be extended in Swift
public var seals:[UpliftSealData] = []
public var invalidAntelSeal:Bool
public var unbaggedItems:UpliftSealData
public var authorised:Bool
public var claims:[UpliftClaimData] = []
public var lastUpdated:Date
public var lastSynced:Date
public var checkedOutDeviceId:String
public var checkedOutOperatorName:String
public var incompleteUpliftId:String
public var pauseReason:String
public var storeConfirmationDocumentUrl:String
required public init(){}
}
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(){}
}
public class UpliftSealData : Codable
{
public var unbagged:Bool
public var sealNumber:String
public var antelSealNumber:String
public var products:[UpliftProductData] = []
public var totalPrice:Double
public var totalQuantity:Double
public var netWeight:Double
public var grossWeight:Double
public var billableSeal:Bool
public var invalidAntelSealNumber:Bool
required public init(){}
}
public class UpliftProductData : Codable
{
public var upliftProductId:Int
public var upliftId:Int
public var productId:Int
public var unitPrice:Double
public var name:String
public var category:String
public var unitBarcode:String
public var unitSize:String
public var unitWeight:Double
public var code:String
public var upliftImages:[Object] = []
public var quantity:Double
public var value:Double
public var priceOverMax:Bool
public var quantityOverMax:Bool
public var quantityOverRequirement:Bool
public var serialNumber:String
public var batchCode:String
public var stockStatusId:Int
public var lotNumber:String
public var expiryDate:String
public var manufactureDate:String
required public init(){}
}
public class UpliftClaimData : Codable
{
public var upliftClaimId:Int
public var claimUnits:Int
public var claimNumber:String
public var claimValue:Double
public var claimDocumentImages:[Object] = []
public var returnOrderNumber:String
public var lineCount:Int
required public init(){}
}
public class SaveUpliftResponse : ApiServiceResponse
{
public var upliftId:Int
public var upliftAuthRequestId:String
public var seals:[UpliftSealData] = []
public var unbaggedItems:UpliftSealData
public var claims:[UpliftClaimData] = []
public var deleteFromDevice:Bool
public var imageIds:[String] = []
public var invalidAntelSeal:Bool
required public init(){ super.init() }
private enum CodingKeys : String, CodingKey {
case upliftId
case upliftAuthRequestId
case seals
case unbaggedItems
case claims
case deleteFromDevice
case imageIds
case invalidAntelSeal
}
required public init(from decoder: Decoder) throws {
try super.init(from: decoder)
let container = try decoder.container(keyedBy: CodingKeys.self)
upliftId = try container.decodeIfPresent(Int.self, forKey: .upliftId)
upliftAuthRequestId = try container.decodeIfPresent(String.self, forKey: .upliftAuthRequestId)
seals = try container.decodeIfPresent([UpliftSealData].self, forKey: .seals) ?? []
unbaggedItems = try container.decodeIfPresent(UpliftSealData.self, forKey: .unbaggedItems)
claims = try container.decodeIfPresent([UpliftClaimData].self, forKey: .claims) ?? []
deleteFromDevice = try container.decodeIfPresent(Bool.self, forKey: .deleteFromDevice)
imageIds = try container.decodeIfPresent([String].self, forKey: .imageIds) ?? []
invalidAntelSeal = try container.decodeIfPresent(Bool.self, forKey: .invalidAntelSeal)
}
public override func encode(to encoder: Encoder) throws {
try super.encode(to: encoder)
var container = encoder.container(keyedBy: CodingKeys.self)
if upliftId != nil { try container.encode(upliftId, forKey: .upliftId) }
if upliftAuthRequestId != nil { try container.encode(upliftAuthRequestId, forKey: .upliftAuthRequestId) }
if seals.count > 0 { try container.encode(seals, forKey: .seals) }
if unbaggedItems != nil { try container.encode(unbaggedItems, forKey: .unbaggedItems) }
if claims.count > 0 { try container.encode(claims, forKey: .claims) }
if deleteFromDevice != nil { try container.encode(deleteFromDevice, forKey: .deleteFromDevice) }
if imageIds.count > 0 { try container.encode(imageIds, forKey: .imageIds) }
if invalidAntelSeal != nil { try container.encode(invalidAntelSeal, forKey: .invalidAntelSeal) }
}
}
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(){}
}
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.
POST /uplift HTTP/1.1
Host: antel.api.dev.86degrees.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
uplift:
{
upliftId: 0,
principleOutletId: 0,
upliftScheduleId: 0,
upliftSchedulePrincipleId: 0,
delayedAuth: False,
appointmentPrincipleData:
{
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
},
authCode: String,
startTime: String,
endTime: String,
sequentialNumber: String,
startLatitude: 0,
startLongitude: 0,
endLatitude: 0,
endLongitude: 0,
totalValue: 0,
totalUnits: 0,
comments: String,
adhocEmailAddress: String,
vatValue: 0,
statusImages:
{
0:
[
{
}
]
},
damagedOkImages:
[
{
}
],
damagedBadImages:
[
{
}
],
expiredImages:
[
{
}
],
recallImages:
[
{
}
],
goodStockImages:
[
{
}
],
derangedImages:
[
{
}
],
overstockedImages:
[
{
}
],
factoryFaultImages:
[
{
}
],
outletContactName: String,
outletContactNumber: String,
outletLatitude: 0,
outletLongitude: 0,
maxSubmissionDistance: 0,
actionOutsideMaxDistance: 0,
outletSignatureImage: {},
operatorSignatureImage: {},
operatorRegNumberImage: {},
seals:
[
{
unbagged: False,
sealNumber: String,
antelSealNumber: String,
products:
[
{
upliftProductId: 0,
upliftId: 0,
productId: 0,
unitPrice: 0,
name: String,
category: String,
unitBarcode: String,
unitSize: String,
unitWeight: 0,
code: String,
upliftImages:
[
{
}
],
quantity: 0,
value: 0,
priceOverMax: False,
quantityOverMax: False,
quantityOverRequirement: False,
serialNumber: String,
batchCode: String,
stockStatusId: 0,
lotNumber: String,
expiryDate: String,
manufactureDate: String
}
],
totalPrice: 0,
totalQuantity: 0,
netWeight: 0,
grossWeight: 0,
billableSeal: False,
invalidAntelSealNumber: False
}
],
invalidAntelSeal: False,
unbaggedItems:
{
unbagged: False,
sealNumber: String,
antelSealNumber: String,
products:
[
{
upliftProductId: 0,
upliftId: 0,
productId: 0,
unitPrice: 0,
name: String,
category: String,
unitBarcode: String,
unitSize: String,
unitWeight: 0,
code: String,
upliftImages:
[
{
}
],
quantity: 0,
value: 0,
priceOverMax: False,
quantityOverMax: False,
quantityOverRequirement: False,
serialNumber: String,
batchCode: String,
stockStatusId: 0,
lotNumber: String,
expiryDate: String,
manufactureDate: String
}
],
totalPrice: 0,
totalQuantity: 0,
netWeight: 0,
grossWeight: 0,
billableSeal: False,
invalidAntelSealNumber: False
},
authorised: False,
claims:
[
{
upliftClaimId: 0,
claimUnits: 0,
claimNumber: String,
claimValue: 0,
claimDocumentImages:
[
{
}
],
returnOrderNumber: String,
lineCount: 0
}
],
lastUpdated: 0001-01-01,
lastSynced: 0001-01-01,
checkedOutOperatorName: String,
pauseReason: String,
storeConfirmationDocumentUrl: String
},
apiKey: String,
latitude: 0,
longitude: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
upliftId: 0,
seals:
[
{
unbagged: False,
sealNumber: String,
antelSealNumber: String,
products:
[
{
upliftProductId: 0,
upliftId: 0,
productId: 0,
unitPrice: 0,
name: String,
category: String,
unitBarcode: String,
unitSize: String,
unitWeight: 0,
code: String,
upliftImages:
[
{
}
],
quantity: 0,
value: 0,
priceOverMax: False,
quantityOverMax: False,
quantityOverRequirement: False,
serialNumber: String,
batchCode: String,
stockStatusId: 0,
lotNumber: String,
expiryDate: String,
manufactureDate: String
}
],
totalPrice: 0,
totalQuantity: 0,
netWeight: 0,
grossWeight: 0,
billableSeal: False,
invalidAntelSealNumber: False
}
],
unbaggedItems:
{
unbagged: False,
sealNumber: String,
antelSealNumber: String,
products:
[
{
upliftProductId: 0,
upliftId: 0,
productId: 0,
unitPrice: 0,
name: String,
category: String,
unitBarcode: String,
unitSize: String,
unitWeight: 0,
code: String,
upliftImages:
[
{
}
],
quantity: 0,
value: 0,
priceOverMax: False,
quantityOverMax: False,
quantityOverRequirement: False,
serialNumber: String,
batchCode: String,
stockStatusId: 0,
lotNumber: String,
expiryDate: String,
manufactureDate: String
}
],
totalPrice: 0,
totalQuantity: 0,
netWeight: 0,
grossWeight: 0,
billableSeal: False,
invalidAntelSealNumber: False
},
claims:
[
{
upliftClaimId: 0,
claimUnits: 0,
claimNumber: String,
claimValue: 0,
claimDocumentImages:
[
{
}
],
returnOrderNumber: String,
lineCount: 0
}
],
deleteFromDevice: False,
imageIds:
[
String
],
invalidAntelSeal: False,
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
}
}
}