Antel Merchandiser App API

<back to all web services

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 .jsv suffix or ?format=jsv

HTTP + JSV

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: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	ImageIdsOnDevice: 
	[
		String
	],
	UpliftRequestData: 
	{
		UpliftRequestId: 0,
		OutletId: 0,
		Products: 
		[
			{
				UpliftRequestProductId: 0,
				ProductId: 0,
				PrincipalId: 0,
				UnitPrice: 0,
				Name: String,
				Category: String,
				UnitBarcode: String,
				UnitSize: String,
				UnitWeight: 0,
				Code: String,
				Images: 
				[
					{
						
					}
				],
				Quantity: 0,
				Value: 0,
				ProductionDate: String,
				ExpiryDate: String,
				BatchCode: String,
				Seal: 
				{
					Number: String,
					Weight: 0
				},
				SerialNumber: String,
				StockStatusId: 0,
				PrincipalLogoUrl: String,
				PrincipalName: String,
				StockStatusName: String,
				StockStatusColor: String,
				UnitOfMeasureId: 0
			}
		],
		OutletEmailAddress: String,
		OutletContactName: String,
		OutletChannel: String,
		OutletRegion: String,
		AdditionalNotes: String,
		MerchandiserSignatureImage: {},
		StartTime: String,
		StartLatitude: 0,
		StartLongitude: 0,
		EndTime: String,
		EndLatitude: 0,
		EndLongitude: 0,
		LastUpdated: 0001-01-01,
		LastSynced: 0001-01-01,
		IncompleteUpliftRequestId: String,
		Authorised: False,
		PrincipalId: 0,
		Seals: 
		[
			{
				Number: String,
				Weight: 0
			}
		],
		Confirmed: False,
		Cancelled: False,
		Images: 
		[
			{
				
			}
		],
		SubmitImmediately: False
	},
	ApiKey: String,
	Latitude: 0,
	Longitude: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ImageIds: 
	[
		String
	],
	Description: String,
	Heading: String,
	WasSuccessful: False,
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}