Antel API

<back to all web services

GetPrincipal

Requires Authentication
The following routes are available for this service:
GET/principal/get
GetPrincipal Parameters:
NameParameterData TypeRequiredDescription
PrincipalIdqueryintNo
ApiServiceRequest Parameters:
NameParameterData TypeRequiredDescription
ApiKeyformstringYesThe API Key required for authentication
LatitudeformdoubleNoLatitude of the user making this request
LongitudeformdoubleNoLongitude of the user making this request
GetPrincipalResponse Parameters:
NameParameterData TypeRequiredDescription
DataformPrincipalDataNo
ApiServiceResponse Parameters:
NameParameterData TypeRequiredDescription
DescriptionformstringYesInformation about the response.
HeadingformstringYesHeading or summary of the response.
WasSuccessfulformbooleanYesDid the intended operation for this response complete successfully?
ResponseStatusformResponseStatusNo
PrincipalData Parameters:
NameParameterData TypeRequiredDescription
PrincipalIdformintNo
NameformstringNo
AuthLetterFileUrlformList<string>No
LogoImageUrlformstringNo
ProductsformList<ProductDataCategory>No
UpliftPrefixformstringNo
ContactNameformstringNo
ContactNumberformstringNo
ContactEmailformstringNo
AllowProductLookupformboolNo
HasLogoformboolNo
HasAuthLetterformboolNo
SealNetWeightMandatoryformboolNo
AllowBillableSealsformboolNo
CaptureSerialNumberformboolNo
BatchCodesMandatoryformboolNo
CaptureManufactureAndExpiryDateformboolNo
ProductExceptionsformList<ProductExceptionData>No
UsesOwnSealNumbersformboolNo
ProductDataCategory Parameters:
NameParameterData TypeRequiredDescription
UnitBarcodeformstringNo
ProductsformList<ProductData>No
ProductData Parameters:
NameParameterData TypeRequiredDescription
ProductIdformintNo
PrincipalIdformintNo
NameformstringNo
CategoryformstringNo
ProductCodeformstringNo
UnitBarcodeformstringNo
CartonQuantityformintNo
ShrinkQuantityformintNo
UnitQuantityformintNo
CartonMeasurementformstringNo
ShrinkMeasurementformstringNo
UnitMeasurementformstringNo
CartonWeightformdoubleNo
ShrinkWeightformdoubleNo
UnitWeightformdecimalNo
CartonPriceformdecimalNo
ShrinkPriceformdecimalNo
UnitPriceformdecimalNo
MaxQuantityformintNo
MaxPriceformintNo
ProductExceptionData Parameters:
NameParameterData TypeRequiredDescription
RegionformstringNo
ChannelformstringNo
ProductIdformintNo
StockStatusIdsformList<int>No

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

HTTP + OTHER

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

HTTP/1.1 200 OK
Content-Type: text/jsonl
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"}}}