| POST | /stock/seal/end |
|---|
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 AntelSealData
Public Overridable Property SealNumber As String
Public Overridable Property PrincipalName As String
Public Overridable Property SealId As Long
Public Overridable Property OperatorName As String
Public Overridable Property OutletName As String
Public Overridable Property UpliftDate As String
Public Overridable Property SealExists As Boolean
Public Overridable Property IsPaused As Boolean
Public Overridable Property PausedAwaitingAuth As Boolean
End Class
Public Partial Class EndSeal
Inherits ApiServiceRequest
Public Overridable Property SealNumber As String
Public Overridable Property BucketId As Integer
End Class
Public Partial Class EndSealResponse
Inherits ApiServiceResponse
Public Overridable Property SealData As AntelSealData
Public Overridable Property InBucket As Boolean
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 .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /stock/seal/end HTTP/1.1
Host: antel.api.dev.86degrees.com
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"sealNumber":"String","bucketId":0,"apiKey":"String","latitude":0,"longitude":0}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"sealData":{"sealNumber":"String","principalName":"String","sealId":0,"operatorName":"String","outletName":"String","upliftDate":"String","sealExists":false,"isPaused":false,"pausedAwaitingAuth":false},"inBucket":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"}}}