Antel API

<back to all web services

GetUpliftSchedule

Requires Authentication
The following routes are available for this service:
GET/upliftscedule
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

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"appointments":[{"scheduleId":0,"appointmentDate":"String","outletName":"String","outletChannel":"String","upliftStatus":0,"isComplete":false,"inProgress":false,"isLate":false,"goodToCollectStatus":false,"principlesWithGoodsToCollect":"","principleAppointments":[{"principle":{"principalId":0,"name":"String","authLetterFileUrl":["String"],"logoImageUrl":"String","products":[{"unitBarcode":"String","products":[{"productId":0,"principalId":0,"name":"String","category":"String","productCode":"String","unitBarcode":"String","cartonQuantity":0,"shrinkQuantity":0,"unitQuantity":0,"cartonMeasurement":"String","shrinkMeasurement":"String","unitMeasurement":"String","cartonWeight":0,"shrinkWeight":0,"unitWeight":0,"cartonPrice":0,"shrinkPrice":0,"unitPrice":0,"maxQuantity":0,"maxPrice":0}]}],"upliftPrefix":"String","contactName":"String","contactNumber":"String","contactEmail":"String","allowProductLookup":false,"hasLogo":false,"hasAuthLetter":false,"sealNetWeightMandatory":false,"allowBillableSeals":false,"captureSerialNumber":false,"batchCodesMandatory":false,"captureManufactureAndExpiryDate":false,"productExceptions":[{"region":"String","channel":"String","productId":0,"stockStatusIds":[0]}],"usesOwnSealNumbers":false},"scheduledDate":"String","upliftScheduleId":0,"upliftSchedulePrincipleId":0,"principleOutletId":0,"verificationCode":"String","goodsToCollect":false,"outletRegion":"String","outletName":"String","outletChannel":"String","outletLatitude":0,"outletLongitude":0,"maxSubmissionDistance":0,"actionOutsideMaxDistance":0,"completedDate":"String","cancelled":false,"completed":false,"upliftTemplate":{"totalValue":0,"products":[{"name":"String","productCode":"String","barcode":"String","statusQty":{"0":0},"returnValue":0}],"seals":[{"number":"String","weight":0}]},"prePopulated":false,"allowedProductStockStatuses":[{"id":0,"name":"String","photoRequired":false,"color":"String"}],"noteToOperator":"String","sealTemplate":{"items":[{"sealNumber":"String","productStockStatus":0,"products":[{"productId":0,"name":"String","productStockStatusId":0,"quantity":0,"serialNumber":"String"}]}]},"prePopulatedWithSeals":false,"preAuthed":false,"operatorName":"String","systemUserId":0,"productExceptions":[{"region":"String","channel":"String","productId":0,"stockStatusIds":[0]}],"storeConfirmationDocumentUrl":"String"}]}],"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"}}}