Antel Merchandiser App API

<back to all web services

IncompleteUpliftRequestFromServer

The following routes are available for this service:
GET/sync/incompleteupliftrequest
namespace WebService.ServiceModel

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 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 IncompleteUpliftRequestFromServerResponse() = 
        inherit ApiServiceResponse()
        member val UpliftRequestData:UpliftRequestData = null 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 IncompleteUpliftRequestFromServer() = 
        inherit ApiServiceRequest()
        member val IncompleteUpliftRequestId:Guid = new Guid() with get,set

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

GET /sync/incompleteupliftrequest HTTP/1.1 
Host: returnit-api-dev.happen.zone 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	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
	},
	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
		}
	}
}