| GET | /principal/get |
|---|
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;
namespace WebService.ServiceModel
{
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()
{
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; }
}
}
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; }
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /principal/get HTTP/1.1 Host: antel.api.dev.86degrees.com Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
data:
{
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
},
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
}
}
}