| POST | /stock/depotDropoff |
|---|
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using WebService.ServiceModel;
using WebService.ServiceModel.Base;
namespace WebService.ServiceModel
{
public partial class AntelSealData
{
public virtual string SealNumber { get; set; }
public virtual string PrincipalName { get; set; }
public virtual long SealId { get; set; }
public virtual string OperatorName { get; set; }
public virtual string OutletName { get; set; }
public virtual string UpliftDate { get; set; }
public virtual bool SealExists { get; set; }
public virtual bool IsPaused { get; set; }
public virtual bool PausedAwaitingAuth { get; set; }
}
public partial class DepotDropOff
: ApiServiceRequest
{
public virtual string SealNumber { get; set; }
}
public partial class DepotDropOffResponse
: ApiServiceResponse
{
public virtual AntelSealData SealData { get; set; }
public virtual bool WeightRequired { get; set; }
public virtual bool AtDepot { get; set; }
public virtual bool SkipConfirm { get; set; }
}
}
namespace WebService.ServiceModel.Base
{
public partial class ApiServiceRequest
: IServiceRequest, IHasApiKey, IHasDeviceInfo
{
///<summary>
///The API Key required for authentication
///</summary>
[ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)]
public virtual string ApiKey { get; set; }
///<summary>
///Latitude of the user making this request
///</summary>
[ApiMember(DataType="double", Description="Latitude of the user making this request")]
public virtual double Latitude { get; set; }
///<summary>
///Longitude of the user making this request
///</summary>
[ApiMember(DataType="double", Description="Longitude of the user making this request")]
public virtual double Longitude { get; set; }
}
public partial class ApiServiceResponse
: IServiceResponse
{
///<summary>
///Information about the response.
///</summary>
[ApiMember(Description="Information about the response.", IsRequired=true)]
public virtual string Description { get; set; }
///<summary>
///Heading or summary of the response.
///</summary>
[ApiMember(Description="Heading or summary of the response.", IsRequired=true)]
public virtual string Heading { 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)]
public virtual bool WasSuccessful { get; set; }
public virtual ResponseStatus ResponseStatus { 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
}
}
}