Antel Merchandiser App API

GetPrincipal

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

import java.math.*
import java.util.*
import net.servicestack.client.*


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()
{
    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 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 HasLogo:Boolean? = null
    var AllowProductLookup:Boolean? = null
    var CaptureSerialNumber:Boolean? = null
    var ShowProductionDate:Boolean? = null
    var ShowExpiryDate:Boolean? = null
    var ShowBatchCode:Boolean? = null
    var SealNumberPerProduct:Boolean? = null
    var AllowedProductStockStatuses:ArrayList<StockStatusData> = ArrayList<StockStatusData>()
    var Enabled:Boolean? = null
    var ShowSealNumber:Boolean? = null
    var ShowSealWeight:Boolean? = null
    var ConsolidationEnabled: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 PrincipalPrefix:String? = 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 UnitOfMeasureId:Int? = null
}

open class StockStatusData
{
    var Id:Int? = null
    var Name:String? = null
    var PhotoRequired:Boolean? = null
    var BatchCodeMandatory:Boolean? = null
    var Color:String? = null
}

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: 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>