Antel Merchandiser App API

<back to all web services

IncompleteUpliftRequestFromServer

The following routes are available for this service:
GET/sync/incompleteupliftrequest
import java.math.*
import java.util.*
import net.servicestack.client.*


open class IncompleteUpliftRequestFromServer : ApiServiceRequest()
{
    var IncompleteUpliftRequestId:UUID? = null
}

open class ApiServiceRequest : IServiceRequest, IHasApiKey, IHasDeviceInfo
{
    /**
    * The API Key required for authentication
    */
    @ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)
    var ApiKey:String? = null

    /**
    * Latitude of the user making this request
    */
    @ApiMember(DataType="double", Description="Latitude of the user making this request")
    var Latitude:Double? = null

    /**
    * Longitude of the user making this request
    */
    @ApiMember(DataType="double", Description="Longitude of the user making this request")
    var Longitude:Double? = null
}

open class IncompleteUpliftRequestFromServerResponse : ApiServiceResponse()
{
    var UpliftRequestData:UpliftRequestData? = null
}

open class ApiServiceResponse : IServiceResponse
{
    /**
    * Information about the response.
    */
    @ApiMember(Description="Information about the response.", IsRequired=true)
    var Description:String? = null

    /**
    * Heading or summary of the response.
    */
    @ApiMember(Description="Heading or summary of the response.", IsRequired=true)
    var Heading:String? = null

    /**
    * Did the intended operation for this response complete successfully?
    */
    @ApiMember(DataType="boolean", Description="Did the intended operation for this response complete successfully?", IsRequired=true)
    var WasSuccessful:Boolean? = null

    var ResponseStatus:ResponseStatus? = null
}

open class UpliftRequestData
{
    var UpliftRequestId:Int? = null
    var Id:UUID? = null
    var OutletId:Int? = null
    var Products:ArrayList<UpliftRequestProductData> = ArrayList<UpliftRequestProductData>()
    var OutletEmailAddress:String? = null
    var OutletContactName:String? = null
    var OutletChannel:String? = null
    var OutletRegion:String? = null
    var AdditionalNotes:String? = null
    var MerchandiserSignatureImage:Object? = null
    var StartTime:String? = null
    var StartLatitude:Double? = null
    var StartLongitude:Double? = null
    var EndTime:String? = null
    var EndLatitude:Double? = null
    var EndLongitude:Double? = null
    var LastUpdated:Date? = null
    var LastSynced:Date? = null
    var IncompleteUpliftRequestId:String? = null
    var AuthRequestId:UUID? = null
    var Authorised:Boolean? = null
    var PrincipalId:Int? = null
    var Seals:ArrayList<SealData> = ArrayList<SealData>()
    var Confirmed:Boolean? = null
    var Cancelled:Boolean? = null
    var Images:ArrayList<Object> = ArrayList<Object>()
    var SubmitImmediately:Boolean? = null
}

open class UpliftRequestProductData
{
    var Id:UUID? = null
    var UpliftRequestProductId:Int? = null
    var ProductId:Int? = null
    var PrincipalId:Int? = null
    var UnitPrice:BigDecimal? = null
    var Name:String? = null
    var Category:String? = null
    var UnitBarcode:String? = null
    var UnitSize:String? = null
    var UnitWeight:BigDecimal? = null
    var Code:String? = null
    var Images:ArrayList<Object> = ArrayList<Object>()
    var Quantity:Double? = null
    var Value:BigDecimal? = null
    var ProductionDate:String? = null
    var ExpiryDate:String? = null
    var BatchCode:String? = null
    var Seal:SealData? = null
    var SerialNumber:String? = null
    var StockStatusId:Int? = null
    var PrincipalLogoUrl:String? = null
    var PrincipalName:String? = null
    var StockStatusName:String? = null
    var StockStatusColor:String? = null
    var UnitOfMeasureId:Int? = null
}

open class SealData : Seal()
{
}

open class Seal
{
    var Number:String? = null
    var Weight:Double? = null
}

Kotlin 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
		}
	}
}