Antel Merchandiser App API

SaveUpliftRequest

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

using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using WebService.AppApi.Models;
using WebService.AppApi.Models.Base;
using BusinessLogic.Entities;

namespace BusinessLogic.Entities
{
    public partial class Seal
    {
        public virtual string Number { get; set; }
        public virtual double Weight { get; set; }
    }

}

namespace WebService.AppApi.Models
{
    public partial class SaveUpliftRequest
        : ApiServiceRequest
    {
        public virtual UpliftRequestData UpliftRequest { get; set; }
    }

    public partial class SaveUpliftRequestResponse
        : ApiServiceResponse
    {
        public SaveUpliftRequestResponse()
        {
            UpliftRequestProductIds = new List<int>{};
            ImageIds = new List<string>{};
        }

        public virtual List<int> UpliftRequestProductIds { get; set; }
        public virtual Guid AuthRequestId { get; set; }
        public virtual int UpliftRequestId { get; set; }
        public virtual bool DeleteFromDevice { get; set; }
        public virtual List<string> ImageIds { get; set; }
    }

    public partial class SealData
        : Seal
    {
    }

    public partial class UpliftRequestData
    {
        public UpliftRequestData()
        {
            Products = new List<UpliftRequestProductData>{};
            Seals = new List<SealData>{};
            Images = new List<Object>{};
        }

        public virtual int UpliftRequestId { get; set; }
        public virtual Guid Id { get; set; }
        public virtual int OutletId { get; set; }
        public virtual List<UpliftRequestProductData> Products { get; set; }
        public virtual string OutletEmailAddress { get; set; }
        public virtual string OutletContactName { get; set; }
        public virtual string OutletChannel { get; set; }
        public virtual string OutletRegion { get; set; }
        public virtual string AdditionalNotes { get; set; }
        public virtual Object MerchandiserSignatureImage { get; set; }
        public virtual string StartTime { get; set; }
        public virtual double StartLatitude { get; set; }
        public virtual double StartLongitude { get; set; }
        public virtual string EndTime { get; set; }
        public virtual double EndLatitude { get; set; }
        public virtual double EndLongitude { get; set; }
        public virtual DateTime LastUpdated { get; set; }
        public virtual DateTime LastSynced { get; set; }
        public virtual string IncompleteUpliftRequestId { get; set; }
        public virtual Guid AuthRequestId { get; set; }
        public virtual bool Authorised { get; set; }
        public virtual int PrincipalId { get; set; }
        public virtual List<SealData> Seals { get; set; }
        public virtual bool Confirmed { get; set; }
        public virtual bool Cancelled { get; set; }
        public virtual List<Object> Images { get; set; }
        public virtual bool SubmitImmediately { get; set; }
    }

    public partial class UpliftRequestProductData
    {
        public UpliftRequestProductData()
        {
            Images = new List<Object>{};
        }

        public virtual Guid Id { get; set; }
        public virtual int UpliftRequestProductId { get; set; }
        public virtual int ProductId { get; set; }
        public virtual int PrincipalId { get; set; }
        public virtual decimal UnitPrice { get; set; }
        public virtual string Name { get; set; }
        public virtual string Category { get; set; }
        public virtual string UnitBarcode { get; set; }
        public virtual string UnitSize { get; set; }
        public virtual decimal UnitWeight { get; set; }
        public virtual string Code { get; set; }
        public virtual List<Object> Images { get; set; }
        public virtual double Quantity { get; set; }
        public virtual decimal Value { get; set; }
        public virtual string ProductionDate { get; set; }
        public virtual string ExpiryDate { get; set; }
        public virtual string BatchCode { get; set; }
        public virtual SealData Seal { get; set; }
        public virtual string SerialNumber { get; set; }
        public virtual int StockStatusId { get; set; }
        public virtual string PrincipalLogoUrl { get; set; }
        public virtual string PrincipalName { get; set; }
        public virtual string StockStatusName { get; set; }
        public virtual string StockStatusColor { get; set; }
        public virtual int UnitOfMeasureId { get; set; }
    }

}

namespace WebService.AppApi.Models.Base
{
    public partial class ApiServiceRequest
        : IServiceRequest, IHasApiKey, IHasDeviceInfo
    {
        ///<summary>
        ///The API Key required for authentication
        ///</summary>
        [ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)]
        public virtual string ApiKey { get; set; }

        ///<summary>
        ///Latitude of the user making this request
        ///</summary>
        [ApiMember(DataType="double", Description="Latitude of the user making this request")]
        public virtual double Latitude { get; set; }

        ///<summary>
        ///Longitude of the user making this request
        ///</summary>
        [ApiMember(DataType="double", Description="Longitude of the user making this request")]
        public virtual double Longitude { get; set; }
    }

    public partial class ApiServiceResponse
        : IServiceResponse
    {
        ///<summary>
        ///Information about the response.
        ///</summary>
        [ApiMember(Description="Information about the response.", IsRequired=true)]
        public virtual string Description { get; set; }

        ///<summary>
        ///Heading or summary of the response.
        ///</summary>
        [ApiMember(Description="Heading or summary of the response.", IsRequired=true)]
        public virtual string Heading { 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)]
        public virtual bool WasSuccessful { get; set; }

        public virtual ResponseStatus ResponseStatus { get; set; }
    }

}

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