| POST | /uplift/conclude |
|---|
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 ConcludeUplift
Inherits ApiServiceRequest
Public Overridable Property UpliftSchedulePrincipleId As Integer
Public Overridable Property IncompleteUpliftId As Guid
Public Overridable Property Comments As String
End Class
Public Partial Class SaveUpliftResponse
Inherits ApiServiceResponse
Public Sub New()
Seals = New List(Of UpliftSealData)
Claims = New List(Of UpliftClaimData)
ImageIds = New List(Of String)
End Sub
Public Overridable Property UpliftId As Integer
Public Overridable Property UpliftAuthRequestId As Guid
Public Overridable Property Seals As List(Of UpliftSealData)
Public Overridable Property UnbaggedItems As UpliftSealData
Public Overridable Property Claims As List(Of UpliftClaimData)
Public Overridable Property DeleteFromDevice As Boolean
Public Overridable Property ImageIds As List(Of String)
Public Overridable Property InvalidAntelSeal As Boolean
End Class
Public Partial Class UpliftClaimData
Public Sub New()
ClaimDocumentImages = New List(Of Object)
End Sub
Public Overridable Property UpliftClaimId As Integer
Public Overridable Property ClaimUnits As Integer
Public Overridable Property ClaimNumber As String
Public Overridable Property ClaimValue As Decimal
Public Overridable Property ClaimDocumentImages As List(Of Object)
Public Overridable Property ReturnOrderNumber As String
Public Overridable Property LineCount As Integer
End Class
Public Partial Class UpliftProductData
Public Sub New()
UpliftImages = New List(Of Object)
End Sub
Public Overridable Property UpliftProductId As Integer
Public Overridable Property UpliftId As Integer
Public Overridable Property ProductId As Integer
Public Overridable Property UnitPrice As Decimal
Public Overridable Property Name As String
Public Overridable Property Category As String
Public Overridable Property UnitBarcode As String
Public Overridable Property UnitSize As String
Public Overridable Property UnitWeight As Decimal
Public Overridable Property Code As String
Public Overridable Property UpliftImages As List(Of Object)
Public Overridable Property Quantity As Double
Public Overridable Property Value As Decimal
Public Overridable Property PriceOverMax As Boolean
Public Overridable Property QuantityOverMax As Boolean
Public Overridable Property QuantityOverRequirement As Boolean
Public Overridable Property SerialNumber As String
Public Overridable Property BatchCode As String
Public Overridable Property StockStatusId As Integer
Public Overridable Property LotNumber As String
Public Overridable Property ExpiryDate As String
Public Overridable Property ManufactureDate As String
End Class
Public Partial Class UpliftSealData
Public Sub New()
Products = New List(Of UpliftProductData)
End Sub
Public Overridable Property Unbagged As Boolean
Public Overridable Property SealNumber As String
Public Overridable Property AntelSealNumber As String
Public Overridable Property Products As List(Of UpliftProductData)
Public Overridable Property TotalPrice As Double
Public Overridable Property TotalQuantity As Double
Public Overridable Property NetWeight As Double
Public Overridable Property GrossWeight As Double
Public Overridable Property BillableSeal As Boolean
Public Overridable Property InvalidAntelSealNumber 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 .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /uplift/conclude HTTP/1.1
Host: antel.api.dev.86degrees.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<ConcludeUplift xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel">
<ApiKey xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel.Base">String</ApiKey>
<Latitude xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel.Base">0</Latitude>
<Longitude xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel.Base">0</Longitude>
<Comments>String</Comments>
<IncompleteUpliftId>00000000-0000-0000-0000-000000000000</IncompleteUpliftId>
<UpliftSchedulePrincipleId>0</UpliftSchedulePrincipleId>
</ConcludeUplift>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<SaveUpliftResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel">
<Description xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel.Base">String</Description>
<Heading xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel.Base">String</Heading>
<ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types" xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel.Base">
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:Message>String</d2p1:Message>
<d2p1:StackTrace>String</d2p1:StackTrace>
<d2p1:Errors>
<d2p1:ResponseError>
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:FieldName>String</d2p1:FieldName>
<d2p1:Message>String</d2p1:Message>
<d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringstring>
<d5p1:Key>String</d5p1:Key>
<d5p1:Value>String</d5p1:Value>
</d5p1:KeyValueOfstringstring>
</d2p1:Meta>
</d2p1:ResponseError>
</d2p1:Errors>
<d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:KeyValueOfstringstring>
<d3p1:Key>String</d3p1:Key>
<d3p1:Value>String</d3p1:Value>
</d3p1:KeyValueOfstringstring>
</d2p1:Meta>
</ResponseStatus>
<WasSuccessful xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel.Base">false</WasSuccessful>
<Claims>
<UpliftClaimData>
<ClaimDocumentImages xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:anyType />
</ClaimDocumentImages>
<ClaimNumber>String</ClaimNumber>
<ClaimUnits>0</ClaimUnits>
<ClaimValue>0</ClaimValue>
<LineCount>0</LineCount>
<ReturnOrderNumber>String</ReturnOrderNumber>
<UpliftClaimId>0</UpliftClaimId>
</UpliftClaimData>
</Claims>
<DeleteFromDevice>false</DeleteFromDevice>
<ImageIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</ImageIds>
<Seals>
<UpliftSealData>
<AntelSealNumber>String</AntelSealNumber>
<BillableSeal>false</BillableSeal>
<GrossWeight>0</GrossWeight>
<InvalidAntelSealNumber>false</InvalidAntelSealNumber>
<NetWeight>0</NetWeight>
<Products>
<UpliftProductData>
<BatchCode>String</BatchCode>
<Category>String</Category>
<Code>String</Code>
<ExpiryDate>String</ExpiryDate>
<LotNumber>String</LotNumber>
<ManufactureDate>String</ManufactureDate>
<Name>String</Name>
<PriceOverMax>false</PriceOverMax>
<ProductId>0</ProductId>
<Quantity>0</Quantity>
<QuantityOverMax>false</QuantityOverMax>
<QuantityOverRequirement>false</QuantityOverRequirement>
<SerialNumber>String</SerialNumber>
<StockStatusId>0</StockStatusId>
<UnitBarcode>String</UnitBarcode>
<UnitPrice>0</UnitPrice>
<UnitSize>String</UnitSize>
<UnitWeight>0</UnitWeight>
<UpliftId>0</UpliftId>
<UpliftImages xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d6p1:anyType />
</UpliftImages>
<UpliftProductId>0</UpliftProductId>
<Value>0</Value>
</UpliftProductData>
</Products>
<SealNumber>String</SealNumber>
<TotalPrice>0</TotalPrice>
<TotalQuantity>0</TotalQuantity>
<Unbagged>false</Unbagged>
</UpliftSealData>
</Seals>
<UnbaggedItems>
<AntelSealNumber>String</AntelSealNumber>
<BillableSeal>false</BillableSeal>
<GrossWeight>0</GrossWeight>
<InvalidAntelSealNumber>false</InvalidAntelSealNumber>
<NetWeight>0</NetWeight>
<Products>
<UpliftProductData>
<BatchCode>String</BatchCode>
<Category>String</Category>
<Code>String</Code>
<ExpiryDate>String</ExpiryDate>
<LotNumber>String</LotNumber>
<ManufactureDate>String</ManufactureDate>
<Name>String</Name>
<PriceOverMax>false</PriceOverMax>
<ProductId>0</ProductId>
<Quantity>0</Quantity>
<QuantityOverMax>false</QuantityOverMax>
<QuantityOverRequirement>false</QuantityOverRequirement>
<SerialNumber>String</SerialNumber>
<StockStatusId>0</StockStatusId>
<UnitBarcode>String</UnitBarcode>
<UnitPrice>0</UnitPrice>
<UnitSize>String</UnitSize>
<UnitWeight>0</UnitWeight>
<UpliftId>0</UpliftId>
<UpliftImages xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:anyType />
</UpliftImages>
<UpliftProductId>0</UpliftProductId>
<Value>0</Value>
</UpliftProductData>
</Products>
<SealNumber>String</SealNumber>
<TotalPrice>0</TotalPrice>
<TotalQuantity>0</TotalQuantity>
<Unbagged>false</Unbagged>
</UnbaggedItems>
<UpliftAuthRequestId>00000000-0000-0000-0000-000000000000</UpliftAuthRequestId>
<UpliftId>0</UpliftId>
</SaveUpliftResponse>