| POST | /stock/depotDropoff |
|---|
namespace WebService.ServiceModel
open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
[<AllowNullLiteral>]
type ApiServiceResponse() =
///<summary>
///Information about the response.
///</summary>
[<ApiMember(Description="Information about the response.", IsRequired=true)>]
member val Description:String = null with get,set
///<summary>
///Heading or summary of the response.
///</summary>
[<ApiMember(Description="Heading or summary of the response.", IsRequired=true)>]
member val Heading:String = null with get,set
///<summary>
///Did the intended operation for this response complete successfully?
///</summary>
[<ApiMember(DataType="boolean", Description="Did the intended operation for this response complete successfully?", IsRequired=true)>]
member val WasSuccessful:Boolean = new Boolean() with get,set
member val ResponseStatus:ResponseStatus = null with get,set
[<AllowNullLiteral>]
type AntelSealData() =
member val SealNumber:String = null with get,set
member val PrincipalName:String = null with get,set
member val SealId:Int64 = new Int64() with get,set
member val OperatorName:String = null with get,set
member val OutletName:String = null with get,set
member val UpliftDate:String = null with get,set
member val SealExists:Boolean = new Boolean() with get,set
member val IsPaused:Boolean = new Boolean() with get,set
member val PausedAwaitingAuth:Boolean = new Boolean() with get,set
[<AllowNullLiteral>]
type DepotDropOffResponse() =
inherit ApiServiceResponse()
member val SealData:AntelSealData = null with get,set
member val WeightRequired:Boolean = new Boolean() with get,set
member val AtDepot:Boolean = new Boolean() with get,set
member val SkipConfirm:Boolean = new Boolean() with get,set
[<AllowNullLiteral>]
type ApiServiceRequest() =
///<summary>
///The API Key required for authentication
///</summary>
[<ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)>]
member val ApiKey:String = null with get,set
///<summary>
///Latitude of the user making this request
///</summary>
[<ApiMember(DataType="double", Description="Latitude of the user making this request")>]
member val Latitude:Double = new Double() with get,set
///<summary>
///Longitude of the user making this request
///</summary>
[<ApiMember(DataType="double", Description="Longitude of the user making this request")>]
member val Longitude:Double = new Double() with get,set
[<AllowNullLiteral>]
type DepotDropOff() =
inherit ApiServiceRequest()
member val SealNumber:String = null with get,set
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
}
}
}