| POST | /stock/closeArrival/order |
|---|
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports WebService.ServiceModel
Imports WebService.ServiceModel.Base
Namespace Global
Namespace WebService.ServiceModel
Public Partial Class CloseOrderArrival
Inherits ApiServiceRequest
Public Overridable Property OrderNumber As String
End Class
Public Partial Class CloseOrderArrivalResponse
Inherits ApiServiceResponse
Public Overridable Property OrderNumber As String
Public Overridable Property RequestingOperatorName As String
Public Overridable Property OperatorName As String
Public Overridable Property DestinationDepot As String
Public Overridable Property DriverName As String
Public Overridable Property CompanyName As String
Public Overridable Property LicensePlate As String
Public Overridable Property OrderId As Integer
Public Overridable Property EstimatedSeals As Integer
Public Overridable Property OperationSummary As StockOperationSummary
End Class
Public Partial Class StockOperationSealItem
Public Overridable Property UpliftNumber As String
Public Overridable Property SealNumber As String
Public Overridable Property PrincipalName As String
Public Overridable Property CurrentWeight As Double
Public Overridable Property WeightDifference As Double
Public Overridable Property OperatorName As String
Public Overridable Property OutletName As String
Public Overridable Property UpliftDate As String
Public Overridable Property PausedAwaitingAuth As Boolean
Public Overridable Property UpliftPdfLink As String
End Class
Public Partial Class StockOperationSummary
Public Sub New()
ScannedSeals = New List(Of StockOperationSealItem)
MissingSeals = New List(Of StockOperationSealItem)
UnknownUpliftSeals = New List(Of StockOperationSealItem)
PausedSeals = New List(Of StockOperationSealItem)
WeightDifferenceSeals = New List(Of StockOperationSealItem)
End Sub
Public Overridable Property ScannedSeals As List(Of StockOperationSealItem)
Public Overridable Property MissingSeals As List(Of StockOperationSealItem)
Public Overridable Property UnknownUpliftSeals As List(Of StockOperationSealItem)
Public Overridable Property PausedSeals As List(Of StockOperationSealItem)
Public Overridable Property WeightDifferenceSeals As List(Of StockOperationSealItem)
Public Overridable Property HasScannedSeals As Boolean
Public Overridable Property HasMissingSeals As Boolean
Public Overridable Property HasWeightDifferenceSeals As Boolean
Public Overridable Property HasUnknownUpliftSeals As Boolean
Public Overridable Property HasPausedSeals As Boolean
Public Overridable Property HasException As Boolean
Public Overridable Property TotalSealsCount As Integer
Public Overridable Property TotalSealsWeight As Double
End Class
End Namespace
Namespace WebService.ServiceModel.Base
Public Partial Class ApiServiceRequest
Implements IServiceRequest
Implements IHasApiKey
Implements IHasDeviceInfo
'''<Summary>
'''The API Key required for authentication
'''</Summary>
<ApiMember(DataType:="string", Description:="The API Key required for authentication", IsRequired:=true)>
Public Overridable Property ApiKey As String
'''<Summary>
'''Latitude of the user making this request
'''</Summary>
<ApiMember(DataType:="double", Description:="Latitude of the user making this request")>
Public Overridable Property Latitude As Double
'''<Summary>
'''Longitude of the user making this request
'''</Summary>
<ApiMember(DataType:="double", Description:="Longitude of the user making this request")>
Public Overridable Property Longitude As Double
End Class
Public Partial Class ApiServiceResponse
Implements IServiceResponse
'''<Summary>
'''Information about the response.
'''</Summary>
<ApiMember(Description:="Information about the response.", IsRequired:=true)>
Public Overridable Property Description As String
'''<Summary>
'''Heading or summary of the response.
'''</Summary>
<ApiMember(Description:="Heading or summary of the response.", IsRequired:=true)>
Public Overridable Property Heading As String
'''<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 Overridable Property WasSuccessful As Boolean
Public Overridable Property ResponseStatus As ResponseStatus
End Class
End Namespace
End Namespace
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
}
}
}