Antel Merchandiser App API

<back to all web services

UpliftRequestAuthRequest

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


open class UpliftRequestAuthRequest : ApiServiceRequest()
{
    var UpliftRequestOnDeviceId:UUID? = null
    var OutletId:Int? = null
    var PrincipalId:Int? = null
    var TotalValue:BigDecimal? = null
    var TotalUnits:Double? = null
    var Region:String? = null
    var Channel:String? = null
    var Products:ArrayList<UpliftRequestProductData> = ArrayList<UpliftRequestProductData>()
}

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 UpliftRequestProductData
{
    var Id:UUID? = null
    var UpliftRequestProductId:Int? = null
    var ProductId:Int? = null
    var PrincipalId:Int? = null
    var UnitPrice:BigDecimal? = null
    var Name:String? = null
    var Category:String? = null
    var UnitBarcode:String? = null
    var UnitSize:String? = null
    var UnitWeight:BigDecimal? = null
    var Code:String? = null
    var Images:ArrayList<Object> = ArrayList<Object>()
    var Quantity:Double? = null
    var Value:BigDecimal? = null
    var ProductionDate:String? = null
    var ExpiryDate:String? = null
    var BatchCode:String? = null
    var Seal:SealData? = null
    var SerialNumber:String? = null
    var StockStatusId:Int? = null
    var PrincipalLogoUrl:String? = null
    var PrincipalName:String? = null
    var StockStatusName:String? = null
    var StockStatusColor:String? = null
    var UnitOfMeasureId:Int? = null
}

open class SealData : Seal()
{
}

open class Seal
{
    var Number:String? = null
    var Weight:Double? = null
}

open class UpliftRequestAuthRequestResponse : ApiServiceResponse()
{
    var UpliftRequestAuthRequestId:UUID? = 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
}

Kotlin UpliftRequestAuthRequest DTOs

POST /upliftrequest/auth HTTP/1.1 
Host: returnit-api-dev.happen.zone 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<UpliftRequestAuthRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebService.AppApi.Models">
  <ApiKey xmlns="http://schemas.datacontract.org/2004/07/WebService.AppApi.Models.Base">String</ApiKey>
  <Latitude xmlns="http://schemas.datacontract.org/2004/07/WebService.AppApi.Models.Base">0</Latitude>
  <Longitude xmlns="http://schemas.datacontract.org/2004/07/WebService.AppApi.Models.Base">0</Longitude>
  <Channel>String</Channel>
  <OutletId>0</OutletId>
  <PrincipalId>0</PrincipalId>
  <Products>
    <UpliftRequestProductData>
      <BatchCode>String</BatchCode>
      <Category>String</Category>
      <Code>String</Code>
      <ExpiryDate>String</ExpiryDate>
      <Id>00000000-0000-0000-0000-000000000000</Id>
      <Images xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:anyType />
      </Images>
      <Name>String</Name>
      <PrincipalId>0</PrincipalId>
      <PrincipalLogoUrl>String</PrincipalLogoUrl>
      <PrincipalName>String</PrincipalName>
      <ProductId>0</ProductId>
      <ProductionDate>String</ProductionDate>
      <Quantity>0</Quantity>
      <Seal>
        <Number xmlns="http://schemas.datacontract.org/2004/07/BusinessLogic.Entities">String</Number>
        <Weight xmlns="http://schemas.datacontract.org/2004/07/BusinessLogic.Entities">0</Weight>
      </Seal>
      <SerialNumber>String</SerialNumber>
      <StockStatusColor>String</StockStatusColor>
      <StockStatusId>0</StockStatusId>
      <StockStatusName>String</StockStatusName>
      <UnitBarcode>String</UnitBarcode>
      <UnitOfMeasureId>0</UnitOfMeasureId>
      <UnitPrice>0</UnitPrice>
      <UnitSize>String</UnitSize>
      <UnitWeight>0</UnitWeight>
      <UpliftRequestProductId>0</UpliftRequestProductId>
      <Value>0</Value>
    </UpliftRequestProductData>
  </Products>
  <Region>String</Region>
  <TotalUnits>0</TotalUnits>
  <TotalValue>0</TotalValue>
  <UpliftRequestOnDeviceId>00000000-0000-0000-0000-000000000000</UpliftRequestOnDeviceId>
</UpliftRequestAuthRequest>

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

<UpliftRequestAuthRequestResponse 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>
  <UpliftRequestAuthRequestId>00000000-0000-0000-0000-000000000000</UpliftRequestAuthRequestId>
</UpliftRequestAuthRequestResponse>