| POST | /stock/seal/details |
|---|
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
Imports CommonService.Api.Models.Base
Namespace Global
Namespace CommonService.Api.Models.Base
Public Partial Class FileDataItem
Public Overridable Property FileName As String
Public Overridable Property FileUrl As String
Public Overridable Property ThumbnailUrl As String
Public Overridable Property FileId As Guid
Public Overridable Property ThumbnailId As Guid
Public Overridable Property LinkId As Integer
Public Overridable Property CreatedDate As Date
End Class
End Namespace
Namespace WebService.ServiceModel
Public Partial Class SealDetailsRequest
Inherits ApiServiceRequest
Public Overridable Property SealId As Integer
End Class
Public Partial Class SealDetailsResponse
Inherits ApiServiceResponse
Public Sub New()
ClaimNumbers = New List(Of String)
SealImages = New List(Of FileDataItem)
OrderHistory = New List(Of SealOrderHistoryItem)
MovementHistory = New List(Of SealMovementHistoryItem)
End Sub
Public Overridable Property PrincipalName As String
Public Overridable Property UpliftNumber As String
Public Overridable Property OperatorName As String
Public Overridable Property OutletName As String
Public Overridable Property UpliftDate As String
Public Overridable Property SealNumber As String
Public Overridable Property CurrentWeight As String
Public Overridable Property TargetWeight As String
Public Overridable Property HasWeightIssue As Boolean
Public Overridable Property BucketName As String
Public Overridable Property ClaimNumbers As List(Of String)
Public Overridable Property JoinedClaimNumbers As String
Public Overridable Property SealImages As List(Of FileDataItem)
Public Overridable Property OrderHistory As List(Of SealOrderHistoryItem)
Public Overridable Property MovementHistory As List(Of SealMovementHistoryItem)
End Class
Public Partial Class SealMovementHistoryItem
Public Overridable Property Id As Long
Public Overridable Property EventDateTime As String
Public Overridable Property ActionUserName As String
Public Overridable Property ScannedDepotName As String
Public Overridable Property AssignedBucketName As String
Public Overridable Property AssignedOrderNumber As String
Public Overridable Property AssignedOperatorName As String
Public Overridable Property OrderDriverName As String
Public Overridable Property OrderDriverCompanyName As String
Public Overridable Property OrderDriverLicensePlate As String
Public Overridable Property TargetWeight As Double
Public Overridable Property CurrentWeight As Double
Public Overridable Property HadWeightIssue As Boolean
Public Overridable Property HadUnknownUplift As Boolean
Public Overridable Property WasPaused As Boolean
Public Overridable Property PausedWasAwaitingAuth As Boolean
End Class
Public Partial Class SealOrderHistoryItem
Public Overridable Property CreatedDate As String
Public Overridable Property OrderId As Integer
Public Overridable Property OrderNumber As String
Public Overridable Property OrderRequestingOperator As String
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
VB.NET SealDetailsRequest DTOs
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/details HTTP/1.1
Host: antel.api.dev.86degrees.com
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"sealId":0,"apiKey":"String","latitude":0,"longitude":0}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"principalName":"String","upliftNumber":"String","operatorName":"String","outletName":"String","upliftDate":"String","sealNumber":"String","currentWeight":"String","targetWeight":"String","hasWeightIssue":false,"bucketName":"String","claimNumbers":["String"],"joinedClaimNumbers":"String","sealImages":[{"fileName":"String","fileUrl":"String","thumbnailUrl":"String","linkId":0,"createdDate":"0001-01-01T00:00:00.0000000"}],"orderHistory":[{"createdDate":"String","orderId":0,"orderNumber":"String","orderRequestingOperator":"String"}],"movementHistory":[{"id":0,"eventDateTime":"String","actionUserName":"String","scannedDepotName":"String","assignedBucketName":"String","assignedOrderNumber":"String","assignedOperatorName":"String","orderDriverName":"String","orderDriverCompanyName":"String","orderDriverLicensePlate":"String","targetWeight":0,"currentWeight":0,"hadWeightIssue":false,"hadUnknownUplift":false,"wasPaused":false,"pausedWasAwaitingAuth":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"}}}