Antel API

UpliftAuthRequest

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


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 UpliftAuthRequestResponse extends ApiServiceResponse
{
    public upliftAuthRequestId: string;

    public constructor(init?: Partial<UpliftAuthRequestResponse>) { super(init); (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 UpliftAuthRequest extends ApiServiceRequest
{
    public upliftSchedulePrincipleId: number;
    public totalValue: number;
    public totalUnits: number;
    public region: string;
    public channel: string;
    public seals: UpliftSealData[];
    public unbaggedItems: UpliftSealData;

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

TypeScript UpliftAuthRequest DTOs

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

HTTP + OTHER

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: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"upliftSchedulePrincipleId":0,"totalValue":0,"totalUnits":0,"region":"String","channel":"String","seals":[{"unbagged":false,"sealNumber":"String","antelSealNumber":"String","products":[{"upliftProductId":0,"upliftId":0,"productId":0,"unitPrice":0,"name":"String","category":"String","unitBarcode":"String","unitSize":"String","unitWeight":0,"code":"String","upliftImages":[{}],"quantity":0,"value":0,"priceOverMax":false,"quantityOverMax":false,"quantityOverRequirement":false,"serialNumber":"String","batchCode":"String","stockStatusId":0,"lotNumber":"String","expiryDate":"String","manufactureDate":"String"}],"totalPrice":0,"totalQuantity":0,"netWeight":0,"grossWeight":0,"billableSeal":false,"invalidAntelSealNumber":false}],"unbaggedItems":{"unbagged":false,"sealNumber":"String","antelSealNumber":"String","products":[{"upliftProductId":0,"upliftId":0,"productId":0,"unitPrice":0,"name":"String","category":"String","unitBarcode":"String","unitSize":"String","unitWeight":0,"code":"String","upliftImages":[{}],"quantity":0,"value":0,"priceOverMax":false,"quantityOverMax":false,"quantityOverRequirement":false,"serialNumber":"String","batchCode":"String","stockStatusId":0,"lotNumber":"String","expiryDate":"String","manufactureDate":"String"}],"totalPrice":0,"totalQuantity":0,"netWeight":0,"grossWeight":0,"billableSeal":false,"invalidAntelSealNumber":false},"apiKey":"String","latitude":0,"longitude":0}

HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"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"}}}