| POST | /uplift/finalise |
|---|
import java.math.*
import java.util.*
import net.servicestack.client.*
open class FinaliseUplift : ApiServiceRequest()
{
var upliftId:Int? = null
var incompleteUpliftId:UUID? = null
}
open class ApiServiceRequest : IServiceRequest, IHasApiKey, IHasDeviceInfo
{
/**
* The API Key required for authentication
*/
@ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)
var apiKey:String? = null
/**
* Latitude of the user making this request
*/
@ApiMember(DataType="double", Description="Latitude of the user making this request")
var latitude:Double? = null
/**
* Longitude of the user making this request
*/
@ApiMember(DataType="double", Description="Longitude of the user making this request")
var longitude:Double? = null
}
open class SaveUpliftResponse : ApiServiceResponse()
{
var upliftId:Int? = null
var upliftAuthRequestId:UUID? = null
var seals:ArrayList<UpliftSealData> = ArrayList<UpliftSealData>()
var unbaggedItems:UpliftSealData? = null
var claims:ArrayList<UpliftClaimData> = ArrayList<UpliftClaimData>()
var deleteFromDevice:Boolean? = null
var imageIds:ArrayList<String> = ArrayList<String>()
var invalidAntelSeal:Boolean? = null
}
open class ApiServiceResponse : IServiceResponse
{
/**
* Information about the response.
*/
@ApiMember(Description="Information about the response.", IsRequired=true)
var description:String? = null
/**
* Heading or summary of the response.
*/
@ApiMember(Description="Heading or summary of the response.", IsRequired=true)
var heading:String? = null
/**
* Did the intended operation for this response complete successfully?
*/
@ApiMember(DataType="boolean", Description="Did the intended operation for this response complete successfully?", IsRequired=true)
var wasSuccessful:Boolean? = null
var responseStatus:ResponseStatus? = null
}
open class UpliftSealData
{
var unbagged:Boolean? = null
var sealNumber:String? = null
var antelSealNumber:String? = null
var products:ArrayList<UpliftProductData> = ArrayList<UpliftProductData>()
var totalPrice:Double? = null
var totalQuantity:Double? = null
var netWeight:Double? = null
var grossWeight:Double? = null
var billableSeal:Boolean? = null
var invalidAntelSealNumber:Boolean? = null
}
open class UpliftProductData
{
var upliftProductId:Int? = null
var upliftId:Int? = null
var productId:Int? = null
var unitPrice:BigDecimal? = null
var name:String? = null
var category:String? = null
var unitBarcode:String? = null
var unitSize:String? = null
var unitWeight:BigDecimal? = null
var code:String? = null
var upliftImages:ArrayList<Object> = ArrayList<Object>()
var quantity:Double? = null
var value:BigDecimal? = null
var priceOverMax:Boolean? = null
var quantityOverMax:Boolean? = null
var quantityOverRequirement:Boolean? = null
var serialNumber:String? = null
var batchCode:String? = null
var stockStatusId:Int? = null
var lotNumber:String? = null
var expiryDate:String? = null
var manufactureDate:String? = null
}
open class UpliftClaimData
{
var upliftClaimId:Int? = null
var claimUnits:Int? = null
var claimNumber:String? = null
var claimValue:BigDecimal? = null
var claimDocumentImages:ArrayList<Object> = ArrayList<Object>()
var returnOrderNumber:String? = null
var lineCount:Int? = null
}
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/finalise HTTP/1.1
Host: antel.api.dev.86degrees.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
upliftId: 0,
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
}
}
}