| POST | /uplift/finalise |
|---|
import Foundation
import ServiceStack
public class FinaliseUplift : ApiServiceRequest
{
public var upliftId:Int
public var incompleteUpliftId:String
required public init(){ super.init() }
private enum CodingKeys : String, CodingKey {
case upliftId
case incompleteUpliftId
}
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)
incompleteUpliftId = try container.decodeIfPresent(String.self, forKey: .incompleteUpliftId)
}
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 incompleteUpliftId != nil { try container.encode(incompleteUpliftId, forKey: .incompleteUpliftId) }
}
}
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 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(){}
}
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(){}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /uplift/finalise HTTP/1.1
Host: antel.api.dev.86degrees.com
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length
{"upliftId":0,"apiKey":"String","latitude":0,"longitude":0}
HTTP/1.1 200 OK
Content-Type: text/jsonl
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"}}}