Antel Merchandiser App API

SaveUpliftRequest

The following routes are available for this service:
POST	/upliftrequest

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


open class SaveUpliftRequest : ApiServiceRequest()
{
    var UpliftRequest:UpliftRequestData? = 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 UpliftRequestData
{
    var UpliftRequestId:Int? = null
    var Id:UUID? = null
    var OutletId:Int? = null
    var Products:ArrayList<UpliftRequestProductData> = ArrayList<UpliftRequestProductData>()
    var OutletEmailAddress:String? = null
    var OutletContactName:String? = null
    var OutletChannel:String? = null
    var OutletRegion:String? = null
    var AdditionalNotes:String? = null
    var MerchandiserSignatureImage:Object? = null
    var StartTime:String? = null
    var StartLatitude:Double? = null
    var StartLongitude:Double? = null
    var EndTime:String? = null
    var EndLatitude:Double? = null
    var EndLongitude:Double? = null
    var LastUpdated:Date? = null
    var LastSynced:Date? = null
    var IncompleteUpliftRequestId:String? = null
    var AuthRequestId:UUID? = null
    var Authorised:Boolean? = null
    var PrincipalId:Int? = null
    var Seals:ArrayList<SealData> = ArrayList<SealData>()
    var Confirmed:Boolean? = null
    var Cancelled:Boolean? = null
    var Images:ArrayList<Object> = ArrayList<Object>()
    var SubmitImmediately:Boolean? = 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 SaveUpliftRequestResponse : ApiServiceResponse()
{
    var UpliftRequestProductIds:ArrayList<Int> = ArrayList<Int>()
    var AuthRequestId:UUID? = null
    var UpliftRequestId:Int? = null
    var DeleteFromDevice:Boolean? = null
    var ImageIds:ArrayList<String> = ArrayList<String>()
}

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 SaveUpliftRequest 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.

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

<SaveUpliftRequest 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>
  <UpliftRequest>
    <AdditionalNotes>String</AdditionalNotes>
    <AuthRequestId>00000000-0000-0000-0000-000000000000</AuthRequestId>
    <Authorised>false</Authorised>
    <Cancelled>false</Cancelled>
    <Confirmed>false</Confirmed>
    <EndLatitude>0</EndLatitude>
    <EndLongitude>0</EndLongitude>
    <EndTime>String</EndTime>
    <Id>00000000-0000-0000-0000-000000000000</Id>
    <Images xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:anyType />
    </Images>
    <IncompleteUpliftRequestId>String</IncompleteUpliftRequestId>
    <LastSynced>0001-01-01T00:00:00</LastSynced>
    <LastUpdated>0001-01-01T00:00:00</LastUpdated>
    <MerchandiserSignatureImage />
    <OutletChannel>String</OutletChannel>
    <OutletContactName>String</OutletContactName>
    <OutletEmailAddress>String</OutletEmailAddress>
    <OutletId>0</OutletId>
    <OutletRegion>String</OutletRegion>
    <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:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1: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>
    <Seals>
      <SealData>
        <Number xmlns="http://schemas.datacontract.org/2004/07/BusinessLogic.Entities">String</Number>
        <Weight xmlns="http://schemas.datacontract.org/2004/07/BusinessLogic.Entities">0</Weight>
      </SealData>
    </Seals>
    <StartLatitude>0</StartLatitude>
    <StartLongitude>0</StartLongitude>
    <StartTime>String</StartTime>
    <SubmitImmediately>false</SubmitImmediately>
    <UpliftRequestId>0</UpliftRequestId>
  </UpliftRequest>
</SaveUpliftRequest>

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

<SaveUpliftRequestResponse 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>
  <AuthRequestId>00000000-0000-0000-0000-000000000000</AuthRequestId>
  <DeleteFromDevice>false</DeleteFromDevice>
  <ImageIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </ImageIds>
  <UpliftRequestId>0</UpliftRequestId>
  <UpliftRequestProductIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </UpliftRequestProductIds>
</SaveUpliftRequestResponse>