Antel Merchandiser App API

IncompleteUpliftRequestList

The following routes are available for this service:
GET	/sync/incompleteupliftrequests

**ApiServiceRequest** Parameters:
Name	Parameter	Data Type	Required	Description
ApiKey	form	string	Yes	The API Key required for authentication
Latitude	form	double	No	Latitude of the user making this request
Longitude	form	double	No	Longitude of the user making this request

**IncompleteUpliftRequestListResponse** Parameters:
Name	Parameter	Data Type	Required
IncompleteUpliftRequests	form	List<IncompleteUpliftRequestData>	Yes
AllowLogin	form	bool	No
AssignedOutlets	form	List<OutletData>	Yes
Archived	form	bool	No

**ApiServiceResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Description	form	string	Yes	Information about the response.
Heading	form	string	Yes	Heading or summary of the response.
WasSuccessful	form	boolean	Yes	Did the intended operation for this response complete successfully?
ResponseStatus	form	ResponseStatus	Yes

**IncompleteUpliftRequestData** Parameters:
Name	Parameter	Data Type	Required
SystemUserId	form	int	No
IncompleteUpliftRequestId	form	Guid	No
UpliftRequestOnDeviceId	form	Guid	No
OutletId	form	int	No
LastSynced	form	DateTime	No
IsSubmitted	form	bool	No
DeleteFromDevice	form	bool	No
CreatedByMerchandiserName	form	string	Yes

**OutletData** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
Name	form	string	Yes
LastRequestedDate	form	string	Yes
HasGeneralUpliftRequest	form	bool	No
UpliftRequestCount	form	int	No
AssignedPrincipalIds	form	List<int>	Yes
AssignedRegions	form	List<OutletRegionData>	Yes
Channel	form	string	Yes
NextScheduledDate	form	string	Yes

**OutletRegionData** Parameters:
Name	Parameter	Data Type	Required	Description
PrincipalId	form	int	No
Region	form	string	Yes

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