Antel API

ConcludeUplift

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


export class ApiServiceRequest implements IServiceRequest, IHasApiKey, IHasDeviceInfo
{
    /** @description The API Key required for authentication */
    // @ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)
    public apiKey: string;

    /** @description Latitude of the user making this request */
    // @ApiMember(DataType="double", Description="Latitude of the user making this request")
    public latitude: number;

    /** @description Longitude of the user making this request */
    // @ApiMember(DataType="double", Description="Longitude of the user making this request")
    public longitude: number;

    public constructor(init?: Partial<ApiServiceRequest>) { (Object as any).assign(this, init); }
}

export class ApiServiceResponse implements IServiceResponse
{
    /** @description Information about the response. */
    // @ApiMember(Description="Information about the response.", IsRequired=true)
    public description: string;

    /** @description Heading or summary of the response. */
    // @ApiMember(Description="Heading or summary of the response.", IsRequired=true)
    public heading: string;

    /** @description Did the intended operation for this response complete successfully? */
    // @ApiMember(DataType="boolean", Description="Did the intended operation for this response complete successfully?", IsRequired=true)
    public wasSuccessful: boolean;

    public responseStatus: ResponseStatus;

    public constructor(init?: Partial<ApiServiceResponse>) { (Object as any).assign(this, init); }
}

export class UpliftProductData
{
    public upliftProductId: number;
    public upliftId: number;
    public productId: number;
    public unitPrice: number;
    public name: string;
    public category: string;
    public unitBarcode: string;
    public unitSize: string;
    public unitWeight: number;
    public code: string;
    public upliftImages: Object[];
    public quantity: number;
    public value: number;
    public priceOverMax: boolean;
    public quantityOverMax: boolean;
    public quantityOverRequirement: boolean;
    public serialNumber: string;
    public batchCode: string;
    public stockStatusId: number;
    public lotNumber: string;
    public expiryDate: string;
    public manufactureDate: string;

    public constructor(init?: Partial<UpliftProductData>) { (Object as any).assign(this, init); }
}

export class UpliftSealData
{
    public unbagged: boolean;
    public sealNumber: string;
    public antelSealNumber: string;
    public products: UpliftProductData[];
    public totalPrice: number;
    public totalQuantity: number;
    public netWeight: number;
    public grossWeight: number;
    public billableSeal: boolean;
    public invalidAntelSealNumber: boolean;

    public constructor(init?: Partial<UpliftSealData>) { (Object as any).assign(this, init); }
}

export class UpliftClaimData
{
    public upliftClaimId: number;
    public claimUnits: number;
    public claimNumber: string;
    public claimValue: number;
    public claimDocumentImages: Object[];
    public returnOrderNumber: string;
    public lineCount: number;

    public constructor(init?: Partial<UpliftClaimData>) { (Object as any).assign(this, init); }
}

export class SaveUpliftResponse extends ApiServiceResponse
{
    public upliftId: number;
    public upliftAuthRequestId: string;
    public seals: UpliftSealData[];
    public unbaggedItems: UpliftSealData;
    public claims: UpliftClaimData[];
    public deleteFromDevice: boolean;
    public imageIds: string[];
    public invalidAntelSeal: boolean;

    public constructor(init?: Partial<SaveUpliftResponse>) { super(init); (Object as any).assign(this, init); }
}

export class ConcludeUplift extends ApiServiceRequest
{
    public upliftSchedulePrincipleId: number;
    public incompleteUpliftId: string;
    public comments: string;

    public constructor(init?: Partial<ConcludeUplift>) { super(init); (Object as any).assign(this, init); }
}

TypeScript ConcludeUplift 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/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>