Antel API

<back to all web services

UpliftAuthRequest

Requires Authentication
The following routes are available for this service:
POST/uplift/auth
UpliftAuthRequest Parameters:
NameParameterData TypeRequiredDescription
UpliftSchedulePrincipleIdbodyintNo
TotalValuebodydecimalNo
TotalUnitsbodydoubleNo
RegionbodystringNo
ChannelbodystringNo
SealsbodyList<UpliftSealData>No
UnbaggedItemsbodyUpliftSealDataNo
ApiServiceRequest Parameters:
NameParameterData TypeRequiredDescription
ApiKeyformstringYesThe API Key required for authentication
LatitudeformdoubleNoLatitude of the user making this request
LongitudeformdoubleNoLongitude of the user making this request
UpliftSealData Parameters:
NameParameterData TypeRequiredDescription
UnbaggedformboolNo
SealNumberformstringNo
AntelSealNumberformstringNo
ProductsformList<UpliftProductData>No
TotalPriceformdoubleNo
TotalQuantityformdoubleNo
NetWeightformdoubleNo
GrossWeightformdoubleNo
BillableSealformboolNo
InvalidAntelSealNumberformboolNo
UpliftProductData Parameters:
NameParameterData TypeRequiredDescription
UpliftProductIdformintNo
UpliftIdformintNo
ProductIdformintNo
UnitPriceformdecimalNo
NameformstringNo
CategoryformstringNo
UnitBarcodeformstringNo
UnitSizeformstringNo
UnitWeightformdecimalNo
CodeformstringNo
UpliftImagesformList<Object>No
QuantityformdoubleNo
ValueformdecimalNo
PriceOverMaxformboolNo
QuantityOverMaxformboolNo
QuantityOverRequirementformboolNo
SerialNumberformstringNo
BatchCodeformstringNo
StockStatusIdformintNo
LotNumberformstringNo
ExpiryDateformstringNo
ManufactureDateformstringNo
UpliftAuthRequestResponse Parameters:
NameParameterData TypeRequiredDescription
UpliftAuthRequestIdformGuidNo
ApiServiceResponse Parameters:
NameParameterData TypeRequiredDescription
DescriptionformstringYesInformation about the response.
HeadingformstringYesHeading or summary of the response.
WasSuccessfulformbooleanYesDid the intended operation for this response complete successfully?
ResponseStatusformResponseStatusNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /uplift/auth HTTP/1.1 
Host: antel.api.dev.86degrees.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<UpliftAuthRequest 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>
  <Channel>String</Channel>
  <Region>String</Region>
  <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>
  <TotalUnits>0</TotalUnits>
  <TotalValue>0</TotalValue>
  <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>
  <UpliftSchedulePrincipleId>0</UpliftSchedulePrincipleId>
</UpliftAuthRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<UpliftAuthRequestResponse 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>
  <UpliftAuthRequestId>00000000-0000-0000-0000-000000000000</UpliftAuthRequestId>
</UpliftAuthRequestResponse>