Antel Merchandiser App API

GetPrincipal

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

namespace WebService.AppApi.Models

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type ApiServiceResponse() = 
        ///<summary>
        ///Information about the response.
        ///</summary>
        [<ApiMember(Description="Information about the response.", IsRequired=true)>]
        member val Description:String = null with get,set

        ///<summary>
        ///Heading or summary of the response.
        ///</summary>
        [<ApiMember(Description="Heading or summary of the response.", IsRequired=true)>]
        member val Heading:String = null with get,set

        ///<summary>
        ///Did the intended operation for this response complete successfully?
        ///</summary>
        [<ApiMember(DataType="boolean", Description="Did the intended operation for this response complete successfully?", IsRequired=true)>]
        member val WasSuccessful:Boolean = new Boolean() with get,set

        member val ResponseStatus:ResponseStatus = null with get,set

    [<AllowNullLiteral>]
    type ProductData() = 
        member val ProductId:Int32 = new Int32() with get,set
        member val PrincipalId:Int32 = new Int32() with get,set
        member val PrincipalPrefix:String = null with get,set
        member val Name:String = null with get,set
        member val Category:String = null with get,set
        member val ProductCode:String = null with get,set
        member val UnitBarcode:String = null with get,set
        member val CartonQuantity:Int32 = new Int32() with get,set
        member val ShrinkQuantity:Int32 = new Int32() with get,set
        member val UnitQuantity:Int32 = new Int32() with get,set
        member val CartonMeasurement:String = null with get,set
        member val ShrinkMeasurement:String = null with get,set
        member val UnitMeasurement:String = null with get,set
        member val CartonWeight:Double = new Double() with get,set
        member val ShrinkWeight:Double = new Double() with get,set
        member val UnitWeight:Decimal = new Decimal() with get,set
        member val CartonPrice:Decimal = new Decimal() with get,set
        member val ShrinkPrice:Decimal = new Decimal() with get,set
        member val UnitPrice:Decimal = new Decimal() with get,set
        member val UnitOfMeasureId:Int32 = new Int32() with get,set

    [<AllowNullLiteral>]
    type ProductDataCategory() = 
        member val UnitBarcode:String = null with get,set
        member val Products:ResizeArray<ProductData> = new ResizeArray<ProductData>() with get,set

    [<AllowNullLiteral>]
    type StockStatusData() = 
        member val Id:Int32 = new Int32() with get,set
        member val Name:String = null with get,set
        member val PhotoRequired:Boolean = new Boolean() with get,set
        member val BatchCodeMandatory:Boolean = new Boolean() with get,set
        member val Color:String = null with get,set

    [<AllowNullLiteral>]
    type PrincipalData() = 
        member val PrincipalId:Int32 = new Int32() with get,set
        member val Name:String = null with get,set
        member val LogoImageUrl:String = null with get,set
        member val Products:ResizeArray<ProductDataCategory> = new ResizeArray<ProductDataCategory>() with get,set
        member val UpliftPrefix:String = null with get,set
        member val ContactName:String = null with get,set
        member val ContactNumber:String = null with get,set
        member val ContactEmail:String = null with get,set
        member val HasLogo:Boolean = new Boolean() with get,set
        member val AllowProductLookup:Boolean = new Boolean() with get,set
        member val CaptureSerialNumber:Boolean = new Boolean() with get,set
        member val ShowProductionDate:Boolean = new Boolean() with get,set
        member val ShowExpiryDate:Boolean = new Boolean() with get,set
        member val ShowBatchCode:Boolean = new Boolean() with get,set
        member val SealNumberPerProduct:Boolean = new Boolean() with get,set
        member val AllowedProductStockStatuses:ResizeArray<StockStatusData> = new ResizeArray<StockStatusData>() with get,set
        member val Enabled:Boolean = new Boolean() with get,set
        member val ShowSealNumber:Boolean = new Boolean() with get,set
        member val ShowSealWeight:Boolean = new Boolean() with get,set
        member val ConsolidationEnabled:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type GetPrincipalResponse() = 
        inherit ApiServiceResponse()
        member val Data:PrincipalData = null with get,set

    [<AllowNullLiteral>]
    type ApiServiceRequest() = 
        ///<summary>
        ///The API Key required for authentication
        ///</summary>
        [<ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)>]
        member val ApiKey:String = null with get,set

        ///<summary>
        ///Latitude of the user making this request
        ///</summary>
        [<ApiMember(DataType="double", Description="Latitude of the user making this request")>]
        member val Latitude:Double = new Double() with get,set

        ///<summary>
        ///Longitude of the user making this request
        ///</summary>
        [<ApiMember(DataType="double", Description="Longitude of the user making this request")>]
        member val Longitude:Double = new Double() with get,set

    [<AllowNullLiteral>]
    type GetPrincipal() = 
        inherit ApiServiceRequest()
        member val PrincipalId:Int32 = new Int32() with get,set

F# 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>