Antel Merchandiser App API

<back to all web services

IncompleteUpliftRequestList

The following routes are available for this service:
GET/sync/incompleteupliftrequests
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using WebService.ServiceModel;
using WebService.AppApi.Models.Base;
using WebService.AppApi.Models;

namespace WebService.AppApi.Models
{
    public partial class OutletData
    {
        public OutletData()
        {
            AssignedPrincipalIds = new List<int>{};
            AssignedRegions = new List<OutletRegionData>{};
        }

        public virtual int Id { get; set; }
        public virtual string Name { get; set; }
        public virtual string LastRequestedDate { get; set; }
        public virtual bool HasGeneralUpliftRequest { get; set; }
        public virtual int UpliftRequestCount { get; set; }
        public virtual List<int> AssignedPrincipalIds { get; set; }
        public virtual List<OutletRegionData> AssignedRegions { get; set; }
        public virtual string Channel { get; set; }
        public virtual string NextScheduledDate { get; set; }
    }

    public partial class OutletRegionData
    {
        public virtual int PrincipalId { get; set; }
        public virtual string Region { get; set; }
    }

}

namespace WebService.AppApi.Models.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; }
    }

}

namespace WebService.ServiceModel
{
    public partial class IncompleteUpliftRequestData
    {
        public virtual int SystemUserId { get; set; }
        public virtual Guid IncompleteUpliftRequestId { get; set; }
        public virtual Guid UpliftRequestOnDeviceId { get; set; }
        public virtual int OutletId { get; set; }
        public virtual DateTime LastSynced { get; set; }
        public virtual bool IsSubmitted { get; set; }
        public virtual bool DeleteFromDevice { get; set; }
        public virtual string CreatedByMerchandiserName { get; set; }
    }

    public partial class IncompleteUpliftRequestList
        : ApiServiceRequest
    {
    }

    public partial class IncompleteUpliftRequestListResponse
        : ApiServiceResponse
    {
        public IncompleteUpliftRequestListResponse()
        {
            IncompleteUpliftRequests = new List<IncompleteUpliftRequestData>{};
            AssignedOutlets = new List<OutletData>{};
        }

        public virtual List<IncompleteUpliftRequestData> IncompleteUpliftRequests { get; set; }
        public virtual bool AllowLogin { get; set; }
        public virtual List<OutletData> AssignedOutlets { get; set; }
        public virtual bool Archived { get; set; }
    }

}

C# IncompleteUpliftRequestList DTOs

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

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /sync/incompleteupliftrequests HTTP/1.1 
Host: returnit-api-dev.happen.zone 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	IncompleteUpliftRequests: 
	[
		{
			
		}
	],
	AllowLogin: False,
	AssignedOutlets: 
	[
		{
			
		}
	],
	Archived: False,
	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
		}
	}
}