Antel API

GetPrincipal

The following routes are available for this service:
GET	/principal/get

**GetPrincipal** Parameters:
Name	Parameter	Data Type	Required	Description
PrincipalId	query	int	No

**ApiServiceRequest** Parameters:
Name	Parameter	Data Type	Required	Description
ApiKey	form	string	Yes	The API Key required for authentication
Latitude	form	double	No	Latitude of the user making this request
Longitude	form	double	No	Longitude of the user making this request

**GetPrincipalResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Data	form	PrincipalData	No

**ApiServiceResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Description	form	string	Yes	Information about the response.
Heading	form	string	Yes	Heading or summary of the response.
WasSuccessful	form	boolean	Yes	Did the intended operation for this response complete successfully?
ResponseStatus	form	ResponseStatus	No

**PrincipalData** Parameters:
Name	Parameter	Data Type	Required
PrincipalId	form	int	No
Name	form	string	No
AuthLetterFileUrl	form	List<string>	No
LogoImageUrl	form	string	No
Products	form	List<ProductDataCategory>	No
UpliftPrefix	form	string	No
ContactName	form	string	No
ContactNumber	form	string	No
ContactEmail	form	string	No
AllowProductLookup	form	bool	No
HasLogo	form	bool	No
HasAuthLetter	form	bool	No
SealNetWeightMandatory	form	bool	No
AllowBillableSeals	form	bool	No
CaptureSerialNumber	form	bool	No
BatchCodesMandatory	form	bool	No
CaptureManufactureAndExpiryDate	form	bool	No
ProductExceptions	form	List<ProductExceptionData>	No
UsesOwnSealNumbers	form	bool	No

**ProductDataCategory** Parameters:
Name	Parameter	Data Type	Required	Description
UnitBarcode	form	string	No
Products	form	List<ProductData>	No

**ProductData** Parameters:
Name	Parameter	Data Type	Required
ProductId	form	int	No
PrincipalId	form	int	No
Name	form	string	No
Category	form	string	No
ProductCode	form	string	No
UnitBarcode	form	string	No
CartonQuantity	form	int	No
ShrinkQuantity	form	int	No
UnitQuantity	form	int	No
CartonMeasurement	form	string	No
ShrinkMeasurement	form	string	No
UnitMeasurement	form	string	No
CartonWeight	form	double	No
ShrinkWeight	form	double	No
UnitWeight	form	decimal	No
CartonPrice	form	decimal	No
ShrinkPrice	form	decimal	No
UnitPrice	form	decimal	No
MaxQuantity	form	int	No
MaxPrice	form	int	No

**ProductExceptionData** Parameters:
Name	Parameter	Data Type	Required
Region	form	string	No
Channel	form	string	No
ProductId	form	int	No
StockStatusIds	form	List<int>	No

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 /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
		}
	}
}