Antel Merchandiser App 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	Yes

**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	Yes

**PrincipalData** Parameters:
Name	Parameter	Data Type	Required
PrincipalId	form	int	No
Name	form	string	Yes
LogoImageUrl	form	string	Yes
Products	form	List<ProductDataCategory>	Yes
UpliftPrefix	form	string	Yes
ContactName	form	string	Yes
ContactNumber	form	string	Yes
ContactEmail	form	string	Yes
HasLogo	form	bool	No
AllowProductLookup	form	bool	No
CaptureSerialNumber	form	bool	No
ShowProductionDate	form	bool	No
ShowExpiryDate	form	bool	No
ShowBatchCode	form	bool	No
SealNumberPerProduct	form	bool	No
AllowedProductStockStatuses	form	List<StockStatusData>	Yes
Enabled	form	bool	No
ShowSealNumber	form	bool	No
ShowSealWeight	form	bool	No
ConsolidationEnabled	form	bool	No

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

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

**StockStatusData** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
Name	form	string	Yes
PhotoRequired	form	bool	No
BatchCodeMandatory	form	bool	No
Color	form	string	Yes

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

HTTP + XML

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: returnit-api-dev.happen.zone 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetPrincipalResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebService.AppApi.Models">
  <Description xmlns="http://schemas.datacontract.org/2004/07/WebService.AppApi.Models.Base">String</Description>
  <Heading xmlns="http://schemas.datacontract.org/2004/07/WebService.AppApi.Models.Base">String</Heading>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types" xmlns="http://schemas.datacontract.org/2004/07/WebService.AppApi.Models.Base">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <WasSuccessful xmlns="http://schemas.datacontract.org/2004/07/WebService.AppApi.Models.Base">false</WasSuccessful>
  <Data>
    <AllowProductLookup>false</AllowProductLookup>
    <AllowedProductStockStatuses>
      <StockStatusData>
        <BatchCodeMandatory>false</BatchCodeMandatory>
        <Color>String</Color>
        <Id>0</Id>
        <Name>String</Name>
        <PhotoRequired>false</PhotoRequired>
      </StockStatusData>
    </AllowedProductStockStatuses>
    <CaptureSerialNumber>false</CaptureSerialNumber>
    <ConsolidationEnabled>false</ConsolidationEnabled>
    <ContactEmail>String</ContactEmail>
    <ContactName>String</ContactName>
    <ContactNumber>String</ContactNumber>
    <Enabled>false</Enabled>
    <HasLogo>false</HasLogo>
    <LogoImageUrl>String</LogoImageUrl>
    <Name>String</Name>
    <PrincipalId>0</PrincipalId>
    <Products>
      <ProductDataCategory>
        <Products>
          <ProductData>
            <CartonMeasurement>String</CartonMeasurement>
            <CartonPrice>0</CartonPrice>
            <CartonQuantity>0</CartonQuantity>
            <CartonWeight>0</CartonWeight>
            <Category>String</Category>
            <Name>String</Name>
            <PrincipalId>0</PrincipalId>
            <PrincipalPrefix>String</PrincipalPrefix>
            <ProductCode>String</ProductCode>
            <ProductId>0</ProductId>
            <ShrinkMeasurement>String</ShrinkMeasurement>
            <ShrinkPrice>0</ShrinkPrice>
            <ShrinkQuantity>0</ShrinkQuantity>
            <ShrinkWeight>0</ShrinkWeight>
            <UnitBarcode>String</UnitBarcode>
            <UnitMeasurement>String</UnitMeasurement>
            <UnitOfMeasureId>0</UnitOfMeasureId>
            <UnitPrice>0</UnitPrice>
            <UnitQuantity>0</UnitQuantity>
            <UnitWeight>0</UnitWeight>
          </ProductData>
        </Products>
        <UnitBarcode>String</UnitBarcode>
      </ProductDataCategory>
    </Products>
    <SealNumberPerProduct>false</SealNumberPerProduct>
    <ShowBatchCode>false</ShowBatchCode>
    <ShowExpiryDate>false</ShowExpiryDate>
    <ShowProductionDate>false</ShowProductionDate>
    <ShowSealNumber>false</ShowSealNumber>
    <ShowSealWeight>false</ShowSealWeight>
    <UpliftPrefix>String</UpliftPrefix>
  </Data>
</GetPrincipalResponse>