Antel Merchandiser App API

SaveIncompleteUpliftRequest

The following routes are available for this service:
POST	/sync/saveincompleteuplift

using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using WebService.ServiceModel;
using WebService.AppApi.Models.Base;
using WebService.AppApi.Models;
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 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; }
    }

}

namespace WebService.ServiceModel
{
    public partial class SaveIncompleteUpliftRequest
        : ApiServiceRequest
    {
        public SaveIncompleteUpliftRequest()
        {
            ImageIdsOnDevice = new List<string>{};
        }

        public virtual Guid IncompleteUpliftRequestId { get; set; }
        public virtual List<string> ImageIdsOnDevice { get; set; }
        public virtual UpliftRequestData UpliftRequestData { get; set; }
    }

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

        public virtual List<string> ImageIds { get; set; }
    }

}

C# SaveIncompleteUpliftRequest 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 /sync/saveincompleteuplift HTTP/1.1 
Host: returnit-api-dev.happen.zone 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<SaveIncompleteUpliftRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel">
  <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>
  <ImageIdsOnDevice xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </ImageIdsOnDevice>
  <IncompleteUpliftRequestId>00000000-0000-0000-0000-000000000000</IncompleteUpliftRequestId>
  <UpliftRequestData xmlns:d2p1="http://schemas.datacontract.org/2004/07/WebService.AppApi.Models">
    <d2p1:AdditionalNotes>String</d2p1:AdditionalNotes>
    <d2p1:AuthRequestId>00000000-0000-0000-0000-000000000000</d2p1:AuthRequestId>
    <d2p1:Authorised>false</d2p1:Authorised>
    <d2p1:Cancelled>false</d2p1:Cancelled>
    <d2p1:Confirmed>false</d2p1:Confirmed>
    <d2p1:EndLatitude>0</d2p1:EndLatitude>
    <d2p1:EndLongitude>0</d2p1:EndLongitude>
    <d2p1:EndTime>String</d2p1:EndTime>
    <d2p1:Id>00000000-0000-0000-0000-000000000000</d2p1:Id>
    <d2p1:Images xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:anyType />
    </d2p1:Images>
    <d2p1:IncompleteUpliftRequestId>String</d2p1:IncompleteUpliftRequestId>
    <d2p1:LastSynced>0001-01-01T00:00:00</d2p1:LastSynced>
    <d2p1:LastUpdated>0001-01-01T00:00:00</d2p1:LastUpdated>
    <d2p1:MerchandiserSignatureImage />
    <d2p1:OutletChannel>String</d2p1:OutletChannel>
    <d2p1:OutletContactName>String</d2p1:OutletContactName>
    <d2p1:OutletEmailAddress>String</d2p1:OutletEmailAddress>
    <d2p1:OutletId>0</d2p1:OutletId>
    <d2p1:OutletRegion>String</d2p1:OutletRegion>
    <d2p1:PrincipalId>0</d2p1:PrincipalId>
    <d2p1:Products>
      <d2p1:UpliftRequestProductData>
        <d2p1:BatchCode>String</d2p1:BatchCode>
        <d2p1:Category>String</d2p1:Category>
        <d2p1:Code>String</d2p1:Code>
        <d2p1:ExpiryDate>String</d2p1:ExpiryDate>
        <d2p1:Id>00000000-0000-0000-0000-000000000000</d2p1:Id>
        <d2p1:Images xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:anyType />
        </d2p1:Images>
        <d2p1:Name>String</d2p1:Name>
        <d2p1:PrincipalId>0</d2p1:PrincipalId>
        <d2p1:PrincipalLogoUrl>String</d2p1:PrincipalLogoUrl>
        <d2p1:PrincipalName>String</d2p1:PrincipalName>
        <d2p1:ProductId>0</d2p1:ProductId>
        <d2p1:ProductionDate>String</d2p1:ProductionDate>
        <d2p1:Quantity>0</d2p1:Quantity>
        <d2p1: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>
        </d2p1:Seal>
        <d2p1:SerialNumber>String</d2p1:SerialNumber>
        <d2p1:StockStatusColor>String</d2p1:StockStatusColor>
        <d2p1:StockStatusId>0</d2p1:StockStatusId>
        <d2p1:StockStatusName>String</d2p1:StockStatusName>
        <d2p1:UnitBarcode>String</d2p1:UnitBarcode>
        <d2p1:UnitOfMeasureId>0</d2p1:UnitOfMeasureId>
        <d2p1:UnitPrice>0</d2p1:UnitPrice>
        <d2p1:UnitSize>String</d2p1:UnitSize>
        <d2p1:UnitWeight>0</d2p1:UnitWeight>
        <d2p1:UpliftRequestProductId>0</d2p1:UpliftRequestProductId>
        <d2p1:Value>0</d2p1:Value>
      </d2p1:UpliftRequestProductData>
    </d2p1:Products>
    <d2p1:Seals>
      <d2p1: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>
      </d2p1:SealData>
    </d2p1:Seals>
    <d2p1:StartLatitude>0</d2p1:StartLatitude>
    <d2p1:StartLongitude>0</d2p1:StartLongitude>
    <d2p1:StartTime>String</d2p1:StartTime>
    <d2p1:SubmitImmediately>false</d2p1:SubmitImmediately>
    <d2p1:UpliftRequestId>0</d2p1:UpliftRequestId>
  </UpliftRequestData>
</SaveIncompleteUpliftRequest>

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

<SaveIncompleteUpliftRequestResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel">
  <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>
  <ImageIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </ImageIds>
</SaveIncompleteUpliftRequestResponse>