Antel API

GetUpliftSchedule

The following routes are available for this service:
GET	/upliftscedule


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 enum UpliftScheduleStatus
{
    Unconfirmed = 0,
    Confirmed = 1,
    PortalCancelled = 4,
    UserCancelled = 5,
    NoOperatorAssigned = 6,
}

export class ProductData
{
    public productId: number;
    public principalId: number;
    public name: string;
    public category: string;
    public productCode: string;
    public unitBarcode: string;
    public cartonQuantity: number;
    public shrinkQuantity: number;
    public unitQuantity: number;
    public cartonMeasurement: string;
    public shrinkMeasurement: string;
    public unitMeasurement: string;
    public cartonWeight: number;
    public shrinkWeight: number;
    public unitWeight: number;
    public cartonPrice: number;
    public shrinkPrice: number;
    public unitPrice: number;
    public maxQuantity: number;
    public maxPrice: number;

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

export class ProductDataCategory
{
    public unitBarcode: string;
    public products: ProductData[];

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

export class ProductExceptionData
{
    public region: string;
    public channel: string;
    public productId: number;
    public stockStatusIds: number[];

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

export class PrincipalData
{
    public principalId: number;
    public name: string;
    public authLetterFileUrl: string[];
    public logoImageUrl: string;
    public products: ProductDataCategory[];
    public upliftPrefix: string;
    public contactName: string;
    public contactNumber: string;
    public contactEmail: string;
    public allowProductLookup: boolean;
    public hasLogo: boolean;
    public hasAuthLetter: boolean;
    public sealNetWeightMandatory: boolean;
    public allowBillableSeals: boolean;
    public captureSerialNumber: boolean;
    public batchCodesMandatory: boolean;
    public captureManufactureAndExpiryDate: boolean;
    public productExceptions: ProductExceptionData[];
    public usesOwnSealNumbers: boolean;

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

export enum ActionOutsideMaxDistanceType
{
    Warn = 0,
    Block = 1,
}

export class TemplateProductData
{
    public name: string;
    public productCode: string;
    public barcode: string;
    public statusQty: { [index: number]: number; };
    public returnValue: number;

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

export class UpliftRequestSealData
{
    public number: string;
    public weight: number;

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

export class UpliftTemplateData
{
    public totalValue: number;
    public products: TemplateProductData[];
    public seals: UpliftRequestSealData[];

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

export class StockStatusData
{
    public id: number;
    public name: string;
    public photoRequired: boolean;
    public color: string;

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

export class SealTemplateProduct
{
    public productId: number;
    public name: string;
    public productStockStatusId: number;
    public quantity: number;
    public serialNumber: string;

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

export class SealTemplateItemData
{
    public sealNumber: string;
    public productStockStatus: number;
    public products: SealTemplateProduct[];

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

export class SealTemplateData
{
    public items: SealTemplateItemData[];

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

export class AppointmentPrincipleData
{
    public principle: PrincipalData;
    public scheduledDate: string;
    public upliftScheduleId: number;
    public upliftSchedulePrincipleId: number;
    public principleOutletId: number;
    public verificationCode: string;
    public goodsToCollect: boolean;
    public outletRegion: string;
    public outletName: string;
    public outletChannel: string;
    public outletLatitude: number;
    public outletLongitude: number;
    public maxSubmissionDistance: number;
    public actionOutsideMaxDistance: ActionOutsideMaxDistanceType;
    public completedDate: string;
    public cancelled: boolean;
    public completed: boolean;
    public upliftTemplate: UpliftTemplateData;
    public prePopulated: boolean;
    public allowedProductStockStatuses: StockStatusData[];
    public noteToOperator: string;
    public sealTemplate: SealTemplateData;
    public prePopulatedWithSeals: boolean;
    public preAuthed: boolean;
    public operatorName: string;
    public systemUserId: number;
    public productExceptions: ProductExceptionData[];
    public storeConfirmationDocumentUrl: string;

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

export class AppointmentData
{
    public scheduleId: number;
    public appointmentDate: string;
    public outletName: string;
    public outletChannel: string;
    public upliftStatus: UpliftScheduleStatus;
    public isComplete: boolean;
    public inProgress: boolean;
    public isLate: boolean;
    public goodToCollectStatus: boolean;
    public principlesWithGoodsToCollect: string;
    public principleAppointments: AppointmentPrincipleData[];

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

export class GetUpliftScheduleResponse extends ApiServiceResponse
{
    public appointments: AppointmentData[];

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

export class GetUpliftSchedule extends ApiServiceRequest
{

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

TypeScript GetUpliftSchedule 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.

GET /upliftscedule HTTP/1.1 
Host: antel.api.dev.86degrees.com 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetUpliftScheduleResponse 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>
  <Appointments>
    <AppointmentData>
      <AppointmentDate>String</AppointmentDate>
      <GoodToCollectStatus>false</GoodToCollectStatus>
      <InProgress>false</InProgress>
      <IsComplete>false</IsComplete>
      <IsLate>false</IsLate>
      <OutletChannel>String</OutletChannel>
      <OutletName>String</OutletName>
      <PrincipleAppointments>
        <AppointmentPrincipleData>
          <ActionOutsideMaxDistance>Warn</ActionOutsideMaxDistance>
          <AllowedProductStockStatuses>
            <StockStatusData>
              <Color>String</Color>
              <Id>0</Id>
              <Name>String</Name>
              <PhotoRequired>false</PhotoRequired>
            </StockStatusData>
          </AllowedProductStockStatuses>
          <Cancelled>false</Cancelled>
          <Completed>false</Completed>
          <CompletedDate>String</CompletedDate>
          <GoodsToCollect>false</GoodsToCollect>
          <MaxSubmissionDistance>0</MaxSubmissionDistance>
          <NoteToOperator>String</NoteToOperator>
          <OperatorName>String</OperatorName>
          <OutletChannel>String</OutletChannel>
          <OutletLatitude>0</OutletLatitude>
          <OutletLongitude>0</OutletLongitude>
          <OutletName>String</OutletName>
          <OutletRegion>String</OutletRegion>
          <PreAuthed>false</PreAuthed>
          <PrePopulated>false</PrePopulated>
          <PrePopulatedWithSeals>false</PrePopulatedWithSeals>
          <Principle>
            <AllowBillableSeals>false</AllowBillableSeals>
            <AllowProductLookup>false</AllowProductLookup>
            <AuthLetterFileUrl xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:string>String</d7p1:string>
            </AuthLetterFileUrl>
            <BatchCodesMandatory>false</BatchCodesMandatory>
            <CaptureManufactureAndExpiryDate>false</CaptureManufactureAndExpiryDate>
            <CaptureSerialNumber>false</CaptureSerialNumber>
            <ContactEmail>String</ContactEmail>
            <ContactName>String</ContactName>
            <ContactNumber>String</ContactNumber>
            <HasAuthLetter>false</HasAuthLetter>
            <HasLogo>false</HasLogo>
            <LogoImageUrl>String</LogoImageUrl>
            <Name>String</Name>
            <PrincipalId>0</PrincipalId>
            <ProductExceptions>
              <ProductExceptionData>
                <Channel>String</Channel>
                <ProductId>0</ProductId>
                <Region>String</Region>
                <StockStatusIds xmlns:d9p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                  <d9p1:int>0</d9p1:int>
                </StockStatusIds>
              </ProductExceptionData>
            </ProductExceptions>
            <Products>
              <ProductDataCategory>
                <Products>
                  <ProductData>
                    <CartonMeasurement>String</CartonMeasurement>
                    <CartonPrice>0</CartonPrice>
                    <CartonQuantity>0</CartonQuantity>
                    <CartonWeight>0</CartonWeight>
                    <Category>String</Category>
                    <MaxPrice>0</MaxPrice>
                    <MaxQuantity>0</MaxQuantity>
                    <Name>String</Name>
                    <PrincipalId>0</PrincipalId>
                    <ProductCode>String</ProductCode>
                    <ProductId>0</ProductId>
                    <ShrinkMeasurement>String</ShrinkMeasurement>
                    <ShrinkPrice>0</ShrinkPrice>
                    <ShrinkQuantity>0</ShrinkQuantity>
                    <ShrinkWeight>0</ShrinkWeight>
                    <UnitBarcode>String</UnitBarcode>
                    <UnitMeasurement>String</UnitMeasurement>
                    <UnitPrice>0</UnitPrice>
                    <UnitQuantity>0</UnitQuantity>
                    <UnitWeight>0</UnitWeight>
                  </ProductData>
                </Products>
                <UnitBarcode>String</UnitBarcode>
              </ProductDataCategory>
            </Products>
            <SealNetWeightMandatory>false</SealNetWeightMandatory>
            <UpliftPrefix>String</UpliftPrefix>
            <UsesOwnSealNumbers>false</UsesOwnSealNumbers>
          </Principle>
          <PrincipleOutletId>0</PrincipleOutletId>
          <ProductExceptions>
            <ProductExceptionData>
              <Channel>String</Channel>
              <ProductId>0</ProductId>
              <Region>String</Region>
              <StockStatusIds xmlns:d8p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                <d8p1:int>0</d8p1:int>
              </StockStatusIds>
            </ProductExceptionData>
          </ProductExceptions>
          <ScheduledDate>String</ScheduledDate>
          <SealTemplate>
            <Items>
              <SealTemplateData.SealTemplateItemData>
                <ProductStockStatus>0</ProductStockStatus>
                <Products xmlns:d9p1="http://schemas.datacontract.org/2004/07/BusinessLogic.Entities">
                  <d9p1:SealTemplateProduct>
                    <d9p1:Name>String</d9p1:Name>
                    <d9p1:ProductId>0</d9p1:ProductId>
                    <d9p1:ProductStockStatusId>0</d9p1:ProductStockStatusId>
                    <d9p1:Quantity>0</d9p1:Quantity>
                    <d9p1:SerialNumber>String</d9p1:SerialNumber>
                  </d9p1:SealTemplateProduct>
                </Products>
                <SealNumber>String</SealNumber>
              </SealTemplateData.SealTemplateItemData>
            </Items>
          </SealTemplate>
          <StoreConfirmationDocumentUrl>String</StoreConfirmationDocumentUrl>
          <SystemUserId>0</SystemUserId>
          <UpliftScheduleId>0</UpliftScheduleId>
          <UpliftSchedulePrincipleId>0</UpliftSchedulePrincipleId>
          <UpliftTemplate>
            <Products>
              <UpliftTemplateData.TemplateProductData>
                <Barcode>String</Barcode>
                <Name>String</Name>
                <ProductCode>String</ProductCode>
                <ReturnValue>0</ReturnValue>
                <StatusQty xmlns:d9p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                  <d9p1:KeyValueOfintint>
                    <d9p1:Key>0</d9p1:Key>
                    <d9p1:Value>0</d9p1:Value>
                  </d9p1:KeyValueOfintint>
                </StatusQty>
              </UpliftTemplateData.TemplateProductData>
            </Products>
            <Seals xmlns:d7p1="http://schemas.datacontract.org/2004/07/BusinessLogic.Entities">
              <d7p1:UpliftRequestSealData>
                <d7p1:Number>String</d7p1:Number>
                <d7p1:Weight>0</d7p1:Weight>
              </d7p1:UpliftRequestSealData>
            </Seals>
            <TotalValue>0</TotalValue>
          </UpliftTemplate>
          <VerificationCode>String</VerificationCode>
        </AppointmentPrincipleData>
      </PrincipleAppointments>
      <ScheduleId>0</ScheduleId>
      <UpliftStatus>Unconfirmed</UpliftStatus>
    </AppointmentData>
  </Appointments>
</GetUpliftScheduleResponse>