Antel Merchandiser App API

<back to all web services

SaveUpliftRequest

Requires Authentication
The following routes are available for this service:
POST/upliftrequest
namespace BusinessLogic.Entities

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 SaveUpliftRequestResponse() = 
        inherit ApiServiceResponse()
        member val UpliftRequestProductIds:ResizeArray<Int32> = new ResizeArray<Int32>() with get,set
        member val AuthRequestId:Guid = new Guid() with get,set
        member val UpliftRequestId:Int32 = new Int32() with get,set
        member val DeleteFromDevice:Boolean = new Boolean() with get,set
        member val ImageIds:ResizeArray<String> = new ResizeArray<String>() 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 Seal() = 
        member val Number:String = null with get,set
        member val Weight:Double = new Double() with get,set

    [<AllowNullLiteral>]
    type SealData() = 
        inherit Seal()

    [<AllowNullLiteral>]
    type UpliftRequestProductData() = 
        member val Id:Guid = new Guid() with get,set
        member val UpliftRequestProductId:Int32 = new Int32() with get,set
        member val ProductId:Int32 = new Int32() with get,set
        member val PrincipalId:Int32 = new Int32() with get,set
        member val UnitPrice:Decimal = new Decimal() with get,set
        member val Name:String = null with get,set
        member val Category:String = null with get,set
        member val UnitBarcode:String = null with get,set
        member val UnitSize:String = null with get,set
        member val UnitWeight:Decimal = new Decimal() with get,set
        member val Code:String = null with get,set
        member val Images:ResizeArray<Object> = new ResizeArray<Object>() with get,set
        member val Quantity:Double = new Double() with get,set
        member val Value:Decimal = new Decimal() with get,set
        member val ProductionDate:String = null with get,set
        member val ExpiryDate:String = null with get,set
        member val BatchCode:String = null with get,set
        member val Seal:SealData = null with get,set
        member val SerialNumber:String = null with get,set
        member val StockStatusId:Int32 = new Int32() with get,set
        member val PrincipalLogoUrl:String = null with get,set
        member val PrincipalName:String = null with get,set
        member val StockStatusName:String = null with get,set
        member val StockStatusColor:String = null with get,set
        member val UnitOfMeasureId:Int32 = new Int32() with get,set

    [<AllowNullLiteral>]
    type UpliftRequestData() = 
        member val UpliftRequestId:Int32 = new Int32() with get,set
        member val Id:Guid = new Guid() with get,set
        member val OutletId:Int32 = new Int32() with get,set
        member val Products:ResizeArray<UpliftRequestProductData> = new ResizeArray<UpliftRequestProductData>() with get,set
        member val OutletEmailAddress:String = null with get,set
        member val OutletContactName:String = null with get,set
        member val OutletChannel:String = null with get,set
        member val OutletRegion:String = null with get,set
        member val AdditionalNotes:String = null with get,set
        member val MerchandiserSignatureImage:Object = null with get,set
        member val StartTime:String = null with get,set
        member val StartLatitude:Double = new Double() with get,set
        member val StartLongitude:Double = new Double() with get,set
        member val EndTime:String = null with get,set
        member val EndLatitude:Double = new Double() with get,set
        member val EndLongitude:Double = new Double() with get,set
        member val LastUpdated:DateTime = new DateTime() with get,set
        member val LastSynced:DateTime = new DateTime() with get,set
        member val IncompleteUpliftRequestId:String = null with get,set
        member val AuthRequestId:Guid = new Guid() with get,set
        member val Authorised:Boolean = new Boolean() with get,set
        member val PrincipalId:Int32 = new Int32() with get,set
        member val Seals:ResizeArray<SealData> = new ResizeArray<SealData>() with get,set
        member val Confirmed:Boolean = new Boolean() with get,set
        member val Cancelled:Boolean = new Boolean() with get,set
        member val Images:ResizeArray<Object> = new ResizeArray<Object>() with get,set
        member val SubmitImmediately:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type SaveUpliftRequest() = 
        inherit ApiServiceRequest()
        member val UpliftRequest:UpliftRequestData = null with get,set

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