| POST | /stock/closeArrival/order |
|---|
import java.math.*
import java.util.*
import net.servicestack.client.*
open class CloseOrderArrival : ApiServiceRequest()
{
var orderNumber:String? = 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 CloseOrderArrivalResponse : ApiServiceResponse()
{
var orderNumber:String? = null
var requestingOperatorName:String? = null
var operatorName:String? = null
var destinationDepot:String? = null
var driverName:String? = null
var companyName:String? = null
var licensePlate:String? = null
var orderId:Int? = null
var estimatedSeals:Int? = null
var operationSummary:StockOperationSummary? = 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 StockOperationSummary
{
var scannedSeals:ArrayList<StockOperationSealItem> = ArrayList<StockOperationSealItem>()
var missingSeals:ArrayList<StockOperationSealItem> = ArrayList<StockOperationSealItem>()
var unknownUpliftSeals:ArrayList<StockOperationSealItem> = ArrayList<StockOperationSealItem>()
var pausedSeals:ArrayList<StockOperationSealItem> = ArrayList<StockOperationSealItem>()
var weightDifferenceSeals:ArrayList<StockOperationSealItem> = ArrayList<StockOperationSealItem>()
var hasScannedSeals:Boolean? = null
var hasMissingSeals:Boolean? = null
var hasWeightDifferenceSeals:Boolean? = null
var hasUnknownUpliftSeals:Boolean? = null
var hasPausedSeals:Boolean? = null
var hasException:Boolean? = null
var totalSealsCount:Int? = null
var totalSealsWeight:Double? = null
}
open class StockOperationSealItem
{
var upliftNumber:String? = null
var sealNumber:String? = null
var principalName:String? = null
var currentWeight:Double? = null
var weightDifference:Double? = null
var operatorName:String? = null
var outletName:String? = null
var upliftDate:String? = null
var pausedAwaitingAuth:Boolean? = null
var upliftPdfLink:String? = 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 /stock/closeArrival/order HTTP/1.1
Host: antel.api.dev.86degrees.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
orderNumber: String,
apiKey: String,
latitude: 0,
longitude: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
orderNumber: String,
requestingOperatorName: String,
operatorName: String,
destinationDepot: String,
driverName: String,
companyName: String,
licensePlate: String,
orderId: 0,
estimatedSeals: 0,
operationSummary:
{
scannedSeals:
[
{
upliftNumber: String,
sealNumber: String,
principalName: String,
currentWeight: 0,
weightDifference: 0,
operatorName: String,
outletName: String,
upliftDate: String,
pausedAwaitingAuth: False,
upliftPdfLink: String
}
],
missingSeals:
[
{
upliftNumber: String,
sealNumber: String,
principalName: String,
currentWeight: 0,
weightDifference: 0,
operatorName: String,
outletName: String,
upliftDate: String,
pausedAwaitingAuth: False,
upliftPdfLink: String
}
],
unknownUpliftSeals:
[
{
upliftNumber: String,
sealNumber: String,
principalName: String,
currentWeight: 0,
weightDifference: 0,
operatorName: String,
outletName: String,
upliftDate: String,
pausedAwaitingAuth: False,
upliftPdfLink: String
}
],
pausedSeals:
[
{
upliftNumber: String,
sealNumber: String,
principalName: String,
currentWeight: 0,
weightDifference: 0,
operatorName: String,
outletName: String,
upliftDate: String,
pausedAwaitingAuth: False,
upliftPdfLink: String
}
],
weightDifferenceSeals:
[
{
upliftNumber: String,
sealNumber: String,
principalName: String,
currentWeight: 0,
weightDifference: 0,
operatorName: String,
outletName: String,
upliftDate: String,
pausedAwaitingAuth: False,
upliftPdfLink: String
}
],
hasScannedSeals: True,
hasMissingSeals: True,
hasWeightDifferenceSeals: True,
hasUnknownUpliftSeals: True,
hasPausedSeals: True,
hasException: True,
totalSealsCount: 4,
totalSealsWeight: 0
},
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
}
}
}