| POST | /stock/depotDropoff |
|---|
import java.math.*
import java.util.*
import net.servicestack.client.*
open class DepotDropOff : ApiServiceRequest()
{
var sealNumber: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 DepotDropOffResponse : ApiServiceResponse()
{
var sealData:AntelSealData? = null
var weightRequired:Boolean? = null
var atDepot:Boolean? = null
var skipConfirm: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 AntelSealData
{
var sealNumber:String? = null
var principalName:String? = null
var sealId:Long? = null
var operatorName:String? = null
var outletName:String? = null
var upliftDate:String? = null
var sealExists:Boolean? = null
var isPaused:Boolean? = null
var pausedAwaitingAuth:Boolean? = 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/depotDropoff HTTP/1.1
Host: antel.api.dev.86degrees.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
sealNumber: String,
apiKey: String,
latitude: 0,
longitude: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
sealData:
{
sealNumber: String,
principalName: String,
sealId: 0,
operatorName: String,
outletName: String,
upliftDate: String,
sealExists: False,
isPaused: False,
pausedAwaitingAuth: False
},
weightRequired: False,
atDepot: False,
skipConfirm: 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
}
}
}