Antel API

UpliftAuthRequest

The following routes are available for this service:
POST	/uplift/auth

import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ApiServiceRequest(IServiceRequest, IHasApiKey, IHasDeviceInfo):
    # @ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)
    api_key: Optional[str] = None
    """
    The API Key required for authentication
    """


    # @ApiMember(DataType="double", Description="Latitude of the user making this request")
    latitude: float = 0.0
    """
    Latitude of the user making this request
    """


    # @ApiMember(DataType="double", Description="Longitude of the user making this request")
    longitude: float = 0.0
    """
    Longitude of the user making this request
    """


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ApiServiceResponse(IServiceResponse):
    # @ApiMember(Description="Information about the response.", IsRequired=true)
    description: Optional[str] = None
    """
    Information about the response.
    """


    # @ApiMember(Description="Heading or summary of the response.", IsRequired=true)
    heading: Optional[str] = None
    """
    Heading or summary of the response.
    """


    # @ApiMember(DataType="boolean", Description="Did the intended operation for this response complete successfully?", IsRequired=true)
    was_successful: bool = False
    """
    Did the intended operation for this response complete successfully?
    """


    response_status: Optional[ResponseStatus] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class UpliftAuthRequestResponse(ApiServiceResponse):
    uplift_auth_request_id: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class UpliftProductData:
    uplift_product_id: int = 0
    uplift_id: int = 0
    product_id: int = 0
    unit_price: Decimal = decimal.Decimal(0)
    name: Optional[str] = None
    category: Optional[str] = None
    unit_barcode: Optional[str] = None
    unit_size: Optional[str] = None
    unit_weight: Decimal = decimal.Decimal(0)
    code: Optional[str] = None
    uplift_images: Optional[List[Object]] = None
    quantity: float = 0.0
    value: Decimal = decimal.Decimal(0)
    price_over_max: bool = False
    quantity_over_max: bool = False
    quantity_over_requirement: bool = False
    serial_number: Optional[str] = None
    batch_code: Optional[str] = None
    stock_status_id: int = 0
    lot_number: Optional[str] = None
    expiry_date: Optional[str] = None
    manufacture_date: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class UpliftSealData:
    unbagged: bool = False
    seal_number: Optional[str] = None
    antel_seal_number: Optional[str] = None
    products: Optional[List[UpliftProductData]] = None
    total_price: float = 0.0
    total_quantity: float = 0.0
    net_weight: float = 0.0
    gross_weight: float = 0.0
    billable_seal: bool = False
    invalid_antel_seal_number: bool = False


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class UpliftAuthRequest(ApiServiceRequest):
    uplift_schedule_principle_id: int = 0
    total_value: Decimal = decimal.Decimal(0)
    total_units: float = 0.0
    region: Optional[str] = None
    channel: Optional[str] = None
    seals: Optional[List[UpliftSealData]] = None
    unbagged_items: Optional[UpliftSealData] = None

Python UpliftAuthRequest DTOs

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>