Antel API

<back to all web services

GetUpliftSchedule

using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using WebService.ServiceModel;
using WebService.ServiceModel.Base;
using BusinessLogic.Entities;

namespace BusinessLogic.Entities
{
    public enum ActionOutsideMaxDistanceType
    {
        Warn = 0,
        Block = 1,
    }

    public partial class SealTemplateProduct
    {
        public virtual int ProductId { get; set; }
        public virtual string Name { get; set; }
        public virtual int ProductStockStatusId { get; set; }
        public virtual int Quantity { get; set; }
        public virtual string SerialNumber { get; set; }
    }

    public partial class UpliftRequestSealData
    {
        public virtual string Number { get; set; }
        public virtual double Weight { get; set; }
    }

    public enum UpliftScheduleStatus
    {
        Unconfirmed = 0,
        Confirmed = 1,
        PortalCancelled = 4,
        UserCancelled = 5,
        NoOperatorAssigned = 6,
    }

}

namespace WebService.ServiceModel
{
    public partial class AppointmentData
    {
        public AppointmentData()
        {
            PrincipleAppointments = new List<AppointmentPrincipleData>{};
        }

        public virtual int ScheduleId { get; set; }
        public virtual string AppointmentDate { get; set; }
        public virtual string OutletName { get; set; }
        public virtual string OutletChannel { get; set; }
        public virtual UpliftScheduleStatus UpliftStatus { get; set; }
        public virtual bool IsComplete { get; set; }
        public virtual bool InProgress { get; set; }
        public virtual bool IsLate { get; set; }
        public virtual bool GoodToCollectStatus { get; set; }
        public virtual string PrinciplesWithGoodsToCollect { get; set; }
        public virtual List<AppointmentPrincipleData> PrincipleAppointments { get; set; }
    }

    public partial class AppointmentPrincipleData
    {
        public AppointmentPrincipleData()
        {
            AllowedProductStockStatuses = new List<StockStatusData>{};
            ProductExceptions = new List<ProductExceptionData>{};
        }

        public virtual PrincipalData Principle { get; set; }
        public virtual string ScheduledDate { get; set; }
        public virtual int UpliftScheduleId { get; set; }
        public virtual int UpliftSchedulePrincipleId { get; set; }
        public virtual int PrincipleOutletId { get; set; }
        public virtual string VerificationCode { get; set; }
        public virtual bool GoodsToCollect { get; set; }
        public virtual string OutletRegion { get; set; }
        public virtual string OutletName { get; set; }
        public virtual string OutletChannel { get; set; }
        public virtual double OutletLatitude { get; set; }
        public virtual double OutletLongitude { get; set; }
        public virtual double MaxSubmissionDistance { get; set; }
        public virtual ActionOutsideMaxDistanceType ActionOutsideMaxDistance { get; set; }
        public virtual string CompletedDate { get; set; }
        public virtual bool Cancelled { get; set; }
        public virtual bool Completed { get; set; }
        public virtual UpliftTemplateData UpliftTemplate { get; set; }
        public virtual bool PrePopulated { get; set; }
        public virtual List<StockStatusData> AllowedProductStockStatuses { get; set; }
        public virtual string NoteToOperator { get; set; }
        public virtual SealTemplateData SealTemplate { get; set; }
        public virtual bool PrePopulatedWithSeals { get; set; }
        public virtual bool PreAuthed { get; set; }
        public virtual string OperatorName { get; set; }
        public virtual int SystemUserId { get; set; }
        public virtual List<ProductExceptionData> ProductExceptions { get; set; }
        public virtual string StoreConfirmationDocumentUrl { get; set; }
    }

    public partial class GetUpliftSchedule
        : ApiServiceRequest
    {
    }

    public partial class GetUpliftScheduleResponse
        : ApiServiceResponse
    {
        public GetUpliftScheduleResponse()
        {
            Appointments = new List<AppointmentData>{};
        }

        public virtual List<AppointmentData> Appointments { get; set; }
    }

    public partial class PrincipalData
    {
        public PrincipalData()
        {
            AuthLetterFileUrl = new List<string>{};
            Products = new List<ProductDataCategory>{};
            ProductExceptions = new List<ProductExceptionData>{};
        }

        public virtual int PrincipalId { get; set; }
        public virtual string Name { get; set; }
        public virtual List<string> AuthLetterFileUrl { get; set; }
        public virtual string LogoImageUrl { get; set; }
        public virtual List<ProductDataCategory> Products { get; set; }
        public virtual string UpliftPrefix { get; set; }
        public virtual string ContactName { get; set; }
        public virtual string ContactNumber { get; set; }
        public virtual string ContactEmail { get; set; }
        public virtual bool AllowProductLookup { get; set; }
        public virtual bool HasLogo { get; set; }
        public virtual bool HasAuthLetter { get; set; }
        public virtual bool SealNetWeightMandatory { get; set; }
        public virtual bool AllowBillableSeals { get; set; }
        public virtual bool CaptureSerialNumber { get; set; }
        public virtual bool BatchCodesMandatory { get; set; }
        public virtual bool CaptureManufactureAndExpiryDate { get; set; }
        public virtual List<ProductExceptionData> ProductExceptions { get; set; }
        public virtual bool UsesOwnSealNumbers { get; set; }
    }

    public partial class ProductData
    {
        public virtual int ProductId { get; set; }
        public virtual int PrincipalId { get; set; }
        public virtual string Name { get; set; }
        public virtual string Category { get; set; }
        public virtual string ProductCode { get; set; }
        public virtual string UnitBarcode { get; set; }
        public virtual int CartonQuantity { get; set; }
        public virtual int ShrinkQuantity { get; set; }
        public virtual int UnitQuantity { get; set; }
        public virtual string CartonMeasurement { get; set; }
        public virtual string ShrinkMeasurement { get; set; }
        public virtual string UnitMeasurement { get; set; }
        public virtual double CartonWeight { get; set; }
        public virtual double ShrinkWeight { get; set; }
        public virtual decimal UnitWeight { get; set; }
        public virtual decimal CartonPrice { get; set; }
        public virtual decimal ShrinkPrice { get; set; }
        public virtual decimal UnitPrice { get; set; }
        public virtual int MaxQuantity { get; set; }
        public virtual int MaxPrice { get; set; }
    }

    public partial class ProductDataCategory
    {
        public ProductDataCategory()
        {
            Products = new List<ProductData>{};
        }

        public virtual string UnitBarcode { get; set; }
        public virtual List<ProductData> Products { get; set; }
    }

    public partial class ProductExceptionData
    {
        public ProductExceptionData()
        {
            StockStatusIds = new List<int>{};
        }

        public virtual string Region { get; set; }
        public virtual string Channel { get; set; }
        public virtual int ProductId { get; set; }
        public virtual List<int> StockStatusIds { get; set; }
    }

    public partial class SealTemplateData
    {
        public SealTemplateData()
        {
            Items = new List<SealTemplateItemData>{};
        }

        public virtual List<SealTemplateItemData> Items { get; set; }
        public partial class SealTemplateItemData
        {
            public SealTemplateItemData()
            {
                Products = new List<SealTemplateProduct>{};
            }

            public virtual string SealNumber { get; set; }
            public virtual int ProductStockStatus { get; set; }
            public virtual List<SealTemplateProduct> Products { get; set; }
        }

    }

    public partial class StockStatusData
    {
        public virtual int Id { get; set; }
        public virtual string Name { get; set; }
        public virtual bool PhotoRequired { get; set; }
        public virtual string Color { get; set; }
    }

    public partial class UpliftTemplateData
    {
        public UpliftTemplateData()
        {
            Products = new List<TemplateProductData>{};
            Seals = new List<UpliftRequestSealData>{};
        }

        public virtual decimal TotalValue { get; set; }
        public virtual List<TemplateProductData> Products { get; set; }
        public virtual List<UpliftRequestSealData> Seals { get; set; }
        public partial class TemplateProductData
        {
            public TemplateProductData()
            {
                StatusQty = new Dictionary<int, int>{};
            }

            public virtual string Name { get; set; }
            public virtual string ProductCode { get; set; }
            public virtual string Barcode { get; set; }
            public virtual Dictionary<int, int> StatusQty { get; set; }
            public virtual decimal ReturnValue { get; set; }
        }

    }

}

namespace WebService.ServiceModel.Base
{
    public partial class ApiServiceRequest
        : IServiceRequest, IHasApiKey, IHasDeviceInfo
    {
        ///<summary>
        ///The API Key required for authentication
        ///</summary>
        [ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)]
        public virtual string ApiKey { get; set; }

        ///<summary>
        ///Latitude of the user making this request
        ///</summary>
        [ApiMember(DataType="double", Description="Latitude of the user making this request")]
        public virtual double Latitude { get; set; }

        ///<summary>
        ///Longitude of the user making this request
        ///</summary>
        [ApiMember(DataType="double", Description="Longitude of the user making this request")]
        public virtual double Longitude { get; set; }
    }

    public partial class ApiServiceResponse
        : IServiceResponse
    {
        ///<summary>
        ///Information about the response.
        ///</summary>
        [ApiMember(Description="Information about the response.", IsRequired=true)]
        public virtual string Description { get; set; }

        ///<summary>
        ///Heading or summary of the response.
        ///</summary>
        [ApiMember(Description="Heading or summary of the response.", IsRequired=true)]
        public virtual string Heading { get; set; }

        ///<summary>
        ///Did the intended operation for this response complete successfully?
        ///</summary>
        [ApiMember(DataType="boolean", Description="Did the intended operation for this response complete successfully?", IsRequired=true)]
        public virtual bool WasSuccessful { get; set; }

        public virtual ResponseStatus ResponseStatus { get; set; }
    }

}

C# GetUpliftSchedule DTOs

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>