| POST | /uplift/auth |
|---|
import Foundation
import ServiceStack
public class UpliftAuthRequest : ApiServiceRequest
{
public var upliftSchedulePrincipleId:Int
public var totalValue:Double
public var totalUnits:Double
public var region:String
public var channel:String
public var seals:[UpliftSealData] = []
public var unbaggedItems:UpliftSealData
required public init(){ super.init() }
private enum CodingKeys : String, CodingKey {
case upliftSchedulePrincipleId
case totalValue
case totalUnits
case region
case channel
case seals
case unbaggedItems
}
required public init(from decoder: Decoder) throws {
try super.init(from: decoder)
let container = try decoder.container(keyedBy: CodingKeys.self)
upliftSchedulePrincipleId = try container.decodeIfPresent(Int.self, forKey: .upliftSchedulePrincipleId)
totalValue = try container.decodeIfPresent(Double.self, forKey: .totalValue)
totalUnits = try container.decodeIfPresent(Double.self, forKey: .totalUnits)
region = try container.decodeIfPresent(String.self, forKey: .region)
channel = try container.decodeIfPresent(String.self, forKey: .channel)
seals = try container.decodeIfPresent([UpliftSealData].self, forKey: .seals) ?? []
unbaggedItems = try container.decodeIfPresent(UpliftSealData.self, forKey: .unbaggedItems)
}
public override func encode(to encoder: Encoder) throws {
try super.encode(to: encoder)
var container = encoder.container(keyedBy: CodingKeys.self)
if upliftSchedulePrincipleId != nil { try container.encode(upliftSchedulePrincipleId, forKey: .upliftSchedulePrincipleId) }
if totalValue != nil { try container.encode(totalValue, forKey: .totalValue) }
if totalUnits != nil { try container.encode(totalUnits, forKey: .totalUnits) }
if region != nil { try container.encode(region, forKey: .region) }
if channel != nil { try container.encode(channel, forKey: .channel) }
if seals.count > 0 { try container.encode(seals, forKey: .seals) }
if unbaggedItems != nil { try container.encode(unbaggedItems, forKey: .unbaggedItems) }
}
}
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 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 UpliftAuthRequestResponse : ApiServiceResponse
{
public var upliftAuthRequestId:String
required public init(){ super.init() }
private enum CodingKeys : String, CodingKey {
case upliftAuthRequestId
}
required public init(from decoder: Decoder) throws {
try super.init(from: decoder)
let container = try decoder.container(keyedBy: CodingKeys.self)
upliftAuthRequestId = try container.decodeIfPresent(String.self, forKey: .upliftAuthRequestId)
}
public override func encode(to encoder: Encoder) throws {
try super.encode(to: encoder)
var container = encoder.container(keyedBy: CodingKeys.self)
if upliftAuthRequestId != nil { try container.encode(upliftAuthRequestId, forKey: .upliftAuthRequestId) }
}
}
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/auth HTTP/1.1
Host: antel.api.dev.86degrees.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
upliftSchedulePrincipleId: 0,
totalValue: 0,
totalUnits: 0,
region: String,
channel: String,
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
},
apiKey: String,
latitude: 0,
longitude: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
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
}
}
}