Antel Merchandiser App API

<back to all web services

GetPrincipal

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;

namespace WebService.AppApi.Models
{
    public partial class GetPrincipal
        : ApiServiceRequest
    {
        public virtual int PrincipalId { get; set; }
    }

    public partial class GetPrincipalResponse
        : ApiServiceResponse
    {
        public virtual PrincipalData Data { get; set; }
    }

    public partial class PrincipalData
    {
        public PrincipalData()
        {
            Products = new List<ProductDataCategory>{};
            AllowedProductStockStatuses = new List<StockStatusData>{};
        }

        public virtual int PrincipalId { get; set; }
        public virtual string Name { 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 HasLogo { get; set; }
        public virtual bool AllowProductLookup { get; set; }
        public virtual bool CaptureSerialNumber { get; set; }
        public virtual bool ShowProductionDate { get; set; }
        public virtual bool ShowExpiryDate { get; set; }
        public virtual bool ShowBatchCode { get; set; }
        public virtual bool SealNumberPerProduct { get; set; }
        public virtual List<StockStatusData> AllowedProductStockStatuses { get; set; }
        public virtual bool Enabled { get; set; }
        public virtual bool ShowSealNumber { get; set; }
        public virtual bool ShowSealWeight { get; set; }
        public virtual bool ConsolidationEnabled { get; set; }
    }

    public partial class ProductData
    {
        public virtual int ProductId { get; set; }
        public virtual int PrincipalId { get; set; }
        public virtual string PrincipalPrefix { 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 UnitOfMeasureId { 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 StockStatusData
    {
        public virtual int Id { get; set; }
        public virtual string Name { get; set; }
        public virtual bool PhotoRequired { get; set; }
        public virtual bool BatchCodeMandatory { get; set; }
        public virtual string Color { 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# GetPrincipal DTOs

GET /principal/get HTTP/1.1 
Host: returnit-api-dev.happen.zone 
Accept: text/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Data: 
	{
		PrincipalId: 0,
		Name: String,
		LogoImageUrl: String,
		Products: 
		[
			{
				UnitBarcode: String,
				Products: 
				[
					{
						ProductId: 0,
						PrincipalId: 0,
						PrincipalPrefix: String,
						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,
						UnitOfMeasureId: 0
					}
				]
			}
		],
		UpliftPrefix: String,
		ContactName: String,
		ContactNumber: String,
		ContactEmail: String,
		HasLogo: False,
		AllowProductLookup: False,
		CaptureSerialNumber: False,
		ShowProductionDate: False,
		ShowExpiryDate: False,
		ShowBatchCode: False,
		SealNumberPerProduct: False,
		AllowedProductStockStatuses: 
		[
			{
				Id: 0,
				Name: String,
				PhotoRequired: False,
				BatchCodeMandatory: False,
				Color: String
			}
		],
		Enabled: False,
		ShowSealNumber: False,
		ShowSealWeight: False,
		ConsolidationEnabled: 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
		}
	}
}