Antel Merchandiser App API

<back to all web services

IncompleteUpliftRequestList

The following routes are available for this service:
GET/sync/incompleteupliftrequests
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 IncompleteUpliftRequestData() = 
        member val SystemUserId:Int32 = new Int32() with get,set
        member val IncompleteUpliftRequestId:Guid = new Guid() with get,set
        member val UpliftRequestOnDeviceId:Guid = new Guid() with get,set
        member val OutletId:Int32 = new Int32() with get,set
        member val LastSynced:DateTime = new DateTime() with get,set
        member val IsSubmitted:Boolean = new Boolean() with get,set
        member val DeleteFromDevice:Boolean = new Boolean() with get,set
        member val CreatedByMerchandiserName:String = null with get,set

    [<AllowNullLiteral>]
    type OutletRegionData() = 
        member val PrincipalId:Int32 = new Int32() with get,set
        member val Region:String = null with get,set

    [<AllowNullLiteral>]
    type OutletData() = 
        member val Id:Int32 = new Int32() with get,set
        member val Name:String = null with get,set
        member val LastRequestedDate:String = null with get,set
        member val HasGeneralUpliftRequest:Boolean = new Boolean() with get,set
        member val UpliftRequestCount:Int32 = new Int32() with get,set
        member val AssignedPrincipalIds:ResizeArray<Int32> = new ResizeArray<Int32>() with get,set
        member val AssignedRegions:ResizeArray<OutletRegionData> = new ResizeArray<OutletRegionData>() with get,set
        member val Channel:String = null with get,set
        member val NextScheduledDate:String = null with get,set

    [<AllowNullLiteral>]
    type IncompleteUpliftRequestListResponse() = 
        inherit ApiServiceResponse()
        member val IncompleteUpliftRequests:ResizeArray<IncompleteUpliftRequestData> = new ResizeArray<IncompleteUpliftRequestData>() with get,set
        member val AllowLogin:Boolean = new Boolean() with get,set
        member val AssignedOutlets:ResizeArray<OutletData> = new ResizeArray<OutletData>() with get,set
        member val Archived:Boolean = new Boolean() 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 IncompleteUpliftRequestList() = 
        inherit ApiServiceRequest()

F# 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
		}
	}
}