Antel Merchandiser App API

<back to all web services

UpliftRequestAuthRequest

Requires Authentication
The following routes are available for this service:
POST/upliftrequest/auth
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using WebService.AppApi.Models;
using WebService.AppApi.Models.Base;
using BusinessLogic.Entities;

namespace BusinessLogic.Entities
{
    public partial class Seal
    {
        public virtual string Number { get; set; }
        public virtual double Weight { get; set; }
    }

}

namespace WebService.AppApi.Models
{
    public partial class SealData
        : Seal
    {
    }

    public partial class UpliftRequestAuthRequest
        : ApiServiceRequest
    {
        public UpliftRequestAuthRequest()
        {
            Products = new List<UpliftRequestProductData>{};
        }

        public virtual Guid UpliftRequestOnDeviceId { get; set; }
        public virtual int OutletId { get; set; }
        public virtual int PrincipalId { get; set; }
        public virtual decimal TotalValue { get; set; }
        public virtual double TotalUnits { get; set; }
        public virtual string Region { get; set; }
        public virtual string Channel { get; set; }
        public virtual List<UpliftRequestProductData> Products { get; set; }
    }

    public partial class UpliftRequestAuthRequestResponse
        : ApiServiceResponse
    {
        public virtual Guid UpliftRequestAuthRequestId { get; set; }
    }

    public partial class UpliftRequestProductData
    {
        public UpliftRequestProductData()
        {
            Images = new List<Object>{};
        }

        public virtual Guid Id { get; set; }
        public virtual int UpliftRequestProductId { get; set; }
        public virtual int ProductId { get; set; }
        public virtual int PrincipalId { get; set; }
        public virtual decimal UnitPrice { get; set; }
        public virtual string Name { get; set; }
        public virtual string Category { get; set; }
        public virtual string UnitBarcode { get; set; }
        public virtual string UnitSize { get; set; }
        public virtual decimal UnitWeight { get; set; }
        public virtual string Code { get; set; }
        public virtual List<Object> Images { get; set; }
        public virtual double Quantity { get; set; }
        public virtual decimal Value { get; set; }
        public virtual string ProductionDate { get; set; }
        public virtual string ExpiryDate { get; set; }
        public virtual string BatchCode { get; set; }
        public virtual SealData Seal { get; set; }
        public virtual string SerialNumber { get; set; }
        public virtual int StockStatusId { get; set; }
        public virtual string PrincipalLogoUrl { get; set; }
        public virtual string PrincipalName { get; set; }
        public virtual string StockStatusName { get; set; }
        public virtual string StockStatusColor { get; set; }
        public virtual int UnitOfMeasureId { 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; }
    }

}

C# UpliftRequestAuthRequest 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.

POST /upliftrequest/auth HTTP/1.1 
Host: returnit-api-dev.happen.zone 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	OutletId: 0,
	PrincipalId: 0,
	TotalValue: 0,
	TotalUnits: 0,
	Region: String,
	Channel: String,
	Products: 
	[
		{
			UpliftRequestProductId: 0,
			ProductId: 0,
			PrincipalId: 0,
			UnitPrice: 0,
			Name: String,
			Category: String,
			UnitBarcode: String,
			UnitSize: String,
			UnitWeight: 0,
			Code: String,
			Images: 
			[
				{
					
				}
			],
			Quantity: 0,
			Value: 0,
			ProductionDate: String,
			ExpiryDate: String,
			BatchCode: String,
			Seal: 
			{
				Number: String,
				Weight: 0
			},
			SerialNumber: String,
			StockStatusId: 0,
			PrincipalLogoUrl: String,
			PrincipalName: String,
			StockStatusName: String,
			StockStatusColor: String,
			UnitOfMeasureId: 0
		}
	],
	ApiKey: String,
	Latitude: 0,
	Longitude: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
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
		}
	}
}