| POST | /uplift/conclude |
|---|
import Foundation
import ServiceStack
public class ConcludeUplift : ApiServiceRequest
{
public var upliftSchedulePrincipleId:Int
public var incompleteUpliftId:String
public var comments:String
required public init(){ super.init() }
private enum CodingKeys : String, CodingKey {
case upliftSchedulePrincipleId
case incompleteUpliftId
case comments
}
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)
incompleteUpliftId = try container.decodeIfPresent(String.self, forKey: .incompleteUpliftId)
comments = try container.decodeIfPresent(String.self, forKey: .comments)
}
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 incompleteUpliftId != nil { try container.encode(incompleteUpliftId, forKey: .incompleteUpliftId) }
if comments != nil { try container.encode(comments, forKey: .comments) }
}
}
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 .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /uplift/conclude HTTP/1.1
Host: antel.api.dev.86degrees.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<ConcludeUplift xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel">
<ApiKey xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel.Base">String</ApiKey>
<Latitude xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel.Base">0</Latitude>
<Longitude xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel.Base">0</Longitude>
<Comments>String</Comments>
<IncompleteUpliftId>00000000-0000-0000-0000-000000000000</IncompleteUpliftId>
<UpliftSchedulePrincipleId>0</UpliftSchedulePrincipleId>
</ConcludeUplift>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<SaveUpliftResponse 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>
<Claims>
<UpliftClaimData>
<ClaimDocumentImages xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:anyType />
</ClaimDocumentImages>
<ClaimNumber>String</ClaimNumber>
<ClaimUnits>0</ClaimUnits>
<ClaimValue>0</ClaimValue>
<LineCount>0</LineCount>
<ReturnOrderNumber>String</ReturnOrderNumber>
<UpliftClaimId>0</UpliftClaimId>
</UpliftClaimData>
</Claims>
<DeleteFromDevice>false</DeleteFromDevice>
<ImageIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</ImageIds>
<Seals>
<UpliftSealData>
<AntelSealNumber>String</AntelSealNumber>
<BillableSeal>false</BillableSeal>
<GrossWeight>0</GrossWeight>
<InvalidAntelSealNumber>false</InvalidAntelSealNumber>
<NetWeight>0</NetWeight>
<Products>
<UpliftProductData>
<BatchCode>String</BatchCode>
<Category>String</Category>
<Code>String</Code>
<ExpiryDate>String</ExpiryDate>
<LotNumber>String</LotNumber>
<ManufactureDate>String</ManufactureDate>
<Name>String</Name>
<PriceOverMax>false</PriceOverMax>
<ProductId>0</ProductId>
<Quantity>0</Quantity>
<QuantityOverMax>false</QuantityOverMax>
<QuantityOverRequirement>false</QuantityOverRequirement>
<SerialNumber>String</SerialNumber>
<StockStatusId>0</StockStatusId>
<UnitBarcode>String</UnitBarcode>
<UnitPrice>0</UnitPrice>
<UnitSize>String</UnitSize>
<UnitWeight>0</UnitWeight>
<UpliftId>0</UpliftId>
<UpliftImages xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d6p1:anyType />
</UpliftImages>
<UpliftProductId>0</UpliftProductId>
<Value>0</Value>
</UpliftProductData>
</Products>
<SealNumber>String</SealNumber>
<TotalPrice>0</TotalPrice>
<TotalQuantity>0</TotalQuantity>
<Unbagged>false</Unbagged>
</UpliftSealData>
</Seals>
<UnbaggedItems>
<AntelSealNumber>String</AntelSealNumber>
<BillableSeal>false</BillableSeal>
<GrossWeight>0</GrossWeight>
<InvalidAntelSealNumber>false</InvalidAntelSealNumber>
<NetWeight>0</NetWeight>
<Products>
<UpliftProductData>
<BatchCode>String</BatchCode>
<Category>String</Category>
<Code>String</Code>
<ExpiryDate>String</ExpiryDate>
<LotNumber>String</LotNumber>
<ManufactureDate>String</ManufactureDate>
<Name>String</Name>
<PriceOverMax>false</PriceOverMax>
<ProductId>0</ProductId>
<Quantity>0</Quantity>
<QuantityOverMax>false</QuantityOverMax>
<QuantityOverRequirement>false</QuantityOverRequirement>
<SerialNumber>String</SerialNumber>
<StockStatusId>0</StockStatusId>
<UnitBarcode>String</UnitBarcode>
<UnitPrice>0</UnitPrice>
<UnitSize>String</UnitSize>
<UnitWeight>0</UnitWeight>
<UpliftId>0</UpliftId>
<UpliftImages xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:anyType />
</UpliftImages>
<UpliftProductId>0</UpliftProductId>
<Value>0</Value>
</UpliftProductData>
</Products>
<SealNumber>String</SealNumber>
<TotalPrice>0</TotalPrice>
<TotalQuantity>0</TotalQuantity>
<Unbagged>false</Unbagged>
</UnbaggedItems>
<UpliftAuthRequestId>00000000-0000-0000-0000-000000000000</UpliftAuthRequestId>
<UpliftId>0</UpliftId>
</SaveUpliftResponse>