Antel API

GetPrincipal

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

import java.math.*
import java.util.*
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*


open class GetPrincipal : ApiServiceRequest()
{
    var principalId:Int? = null
}

open class ApiServiceRequest : IServiceRequest, IHasApiKey, IHasDeviceInfo
{
    /**
    * The API Key required for authentication
    */
    @ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)
    var apiKey:String? = null

    /**
    * Latitude of the user making this request
    */
    @ApiMember(DataType="double", Description="Latitude of the user making this request")
    var latitude:Double? = null

    /**
    * Longitude of the user making this request
    */
    @ApiMember(DataType="double", Description="Longitude of the user making this request")
    var longitude:Double? = null
}

open class GetPrincipalResponse : ApiServiceResponse()
{
    @SerializedName("data") var Data:PrincipalData? = null
}

open class ApiServiceResponse : IServiceResponse
{
    /**
    * Information about the response.
    */
    @ApiMember(Description="Information about the response.", IsRequired=true)
    var description:String? = null

    /**
    * Heading or summary of the response.
    */
    @ApiMember(Description="Heading or summary of the response.", IsRequired=true)
    var heading:String? = null

    /**
    * Did the intended operation for this response complete successfully?
    */
    @ApiMember(DataType="boolean", Description="Did the intended operation for this response complete successfully?", IsRequired=true)
    var wasSuccessful:Boolean? = null

    var responseStatus:ResponseStatus? = null
}

open class PrincipalData
{
    var principalId:Int? = null
    var name:String? = null
    var authLetterFileUrl:ArrayList<String> = ArrayList<String>()
    var logoImageUrl:String? = null
    var products:ArrayList<ProductDataCategory> = ArrayList<ProductDataCategory>()
    var upliftPrefix:String? = null
    var contactName:String? = null
    var contactNumber:String? = null
    var contactEmail:String? = null
    var allowProductLookup:Boolean? = null
    var hasLogo:Boolean? = null
    var hasAuthLetter:Boolean? = null
    var sealNetWeightMandatory:Boolean? = null
    var allowBillableSeals:Boolean? = null
    var captureSerialNumber:Boolean? = null
    var batchCodesMandatory:Boolean? = null
    var captureManufactureAndExpiryDate:Boolean? = null
    var productExceptions:ArrayList<ProductExceptionData> = ArrayList<ProductExceptionData>()
    var usesOwnSealNumbers:Boolean? = null
}

open class ProductDataCategory
{
    var unitBarcode:String? = null
    var products:ArrayList<ProductData> = ArrayList<ProductData>()
}

open class ProductData
{
    var productId:Int? = null
    var principalId:Int? = null
    var name:String? = null
    var category:String? = null
    var productCode:String? = null
    var unitBarcode:String? = null
    var cartonQuantity:Int? = null
    var shrinkQuantity:Int? = null
    var unitQuantity:Int? = null
    var cartonMeasurement:String? = null
    var shrinkMeasurement:String? = null
    var unitMeasurement:String? = null
    var cartonWeight:Double? = null
    var shrinkWeight:Double? = null
    var unitWeight:BigDecimal? = null
    var cartonPrice:BigDecimal? = null
    var shrinkPrice:BigDecimal? = null
    var unitPrice:BigDecimal? = null
    var maxQuantity:Int? = null
    var maxPrice:Int? = null
}

open class ProductExceptionData
{
    var region:String? = null
    var channel:String? = null
    var productId:Int? = null
    var stockStatusIds:ArrayList<Int> = ArrayList<Int>()
}

Kotlin GetPrincipal DTOs

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: antel.api.dev.86degrees.com 
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.ServiceModel">
  <Description xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel.Base">String</Description>
  <Heading xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel.Base">String</Heading>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types" xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel.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.ServiceModel.Base">false</WasSuccessful>
  <Data>
    <AllowBillableSeals>false</AllowBillableSeals>
    <AllowProductLookup>false</AllowProductLookup>
    <AuthLetterFileUrl xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </AuthLetterFileUrl>
    <BatchCodesMandatory>false</BatchCodesMandatory>
    <CaptureManufactureAndExpiryDate>false</CaptureManufactureAndExpiryDate>
    <CaptureSerialNumber>false</CaptureSerialNumber>
    <ContactEmail>String</ContactEmail>
    <ContactName>String</ContactName>
    <ContactNumber>String</ContactNumber>
    <HasAuthLetter>false</HasAuthLetter>
    <HasLogo>false</HasLogo>
    <LogoImageUrl>String</LogoImageUrl>
    <Name>String</Name>
    <PrincipalId>0</PrincipalId>
    <ProductExceptions>
      <ProductExceptionData>
        <Channel>String</Channel>
        <ProductId>0</ProductId>
        <Region>String</Region>
        <StockStatusIds xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:int>0</d5p1:int>
        </StockStatusIds>
      </ProductExceptionData>
    </ProductExceptions>
    <Products>
      <ProductDataCategory>
        <Products>
          <ProductData>
            <CartonMeasurement>String</CartonMeasurement>
            <CartonPrice>0</CartonPrice>
            <CartonQuantity>0</CartonQuantity>
            <CartonWeight>0</CartonWeight>
            <Category>String</Category>
            <MaxPrice>0</MaxPrice>
            <MaxQuantity>0</MaxQuantity>
            <Name>String</Name>
            <PrincipalId>0</PrincipalId>
            <ProductCode>String</ProductCode>
            <ProductId>0</ProductId>
            <ShrinkMeasurement>String</ShrinkMeasurement>
            <ShrinkPrice>0</ShrinkPrice>
            <ShrinkQuantity>0</ShrinkQuantity>
            <ShrinkWeight>0</ShrinkWeight>
            <UnitBarcode>String</UnitBarcode>
            <UnitMeasurement>String</UnitMeasurement>
            <UnitPrice>0</UnitPrice>
            <UnitQuantity>0</UnitQuantity>
            <UnitWeight>0</UnitWeight>
          </ProductData>
        </Products>
        <UnitBarcode>String</UnitBarcode>
      </ProductDataCategory>
    </Products>
    <SealNetWeightMandatory>false</SealNetWeightMandatory>
    <UpliftPrefix>String</UpliftPrefix>
    <UsesOwnSealNumbers>false</UsesOwnSealNumbers>
  </Data>
</GetPrincipalResponse>