Antel Merchandiser App API

<back to all web services

IncompleteUpliftRequestList

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


open class IncompleteUpliftRequestList : ApiServiceRequest()
{
}

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 IncompleteUpliftRequestListResponse : ApiServiceResponse()
{
    var IncompleteUpliftRequests:ArrayList<IncompleteUpliftRequestData> = ArrayList<IncompleteUpliftRequestData>()
    var AllowLogin:Boolean? = null
    var AssignedOutlets:ArrayList<OutletData> = ArrayList<OutletData>()
    var Archived:Boolean? = 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 IncompleteUpliftRequestData
{
    var SystemUserId:Int? = null
    var IncompleteUpliftRequestId:UUID? = null
    var UpliftRequestOnDeviceId:UUID? = null
    var OutletId:Int? = null
    var LastSynced:Date? = null
    var IsSubmitted:Boolean? = null
    var DeleteFromDevice:Boolean? = null
    var CreatedByMerchandiserName:String? = null
}

open class OutletData
{
    var Id:Int? = null
    var Name:String? = null
    var LastRequestedDate:String? = null
    var HasGeneralUpliftRequest:Boolean? = null
    var UpliftRequestCount:Int? = null
    var AssignedPrincipalIds:ArrayList<Int> = ArrayList<Int>()
    var AssignedRegions:ArrayList<OutletRegionData> = ArrayList<OutletRegionData>()
    var Channel:String? = null
    var NextScheduledDate:String? = null
}

open class OutletRegionData
{
    var PrincipalId:Int? = null
    var Region:String? = null
}

Kotlin IncompleteUpliftRequestList 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/incompleteupliftrequests HTTP/1.1 
Host: returnit-api-dev.happen.zone 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	IncompleteUpliftRequests: 
	[
		{
			
		}
	],
	AllowLogin: False,
	AssignedOutlets: 
	[
		{
			
		}
	],
	Archived: 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
		}
	}
}