Antel Merchandiser App API

UpliftHistory

The following routes are available for this service:
GET	/uplift/history

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

**UpliftHistoryResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Items	form	List<UpliftHistoryItem>	Yes

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

**UpliftHistoryItem** Parameters:
Name	Parameter	Data Type	Required
PrincipleLogo	form	string	Yes
PrincipleName	form	string	Yes
OutletName	form	string	Yes
AppointmentDate	form	string	Yes
AppointmentDateFormatted	form	string	Yes
SubmittedDate	form	string	Yes
SubmittedDateFormatted	form	string	Yes
UpliftNumber	form	string	Yes
AntelScheduledDate	form	string	Yes
AntelCompletedDate	form	string	Yes
AntelSubmissionDocumentUrl	form	string	Yes
AntelUpliftNumber	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 /uplift/history HTTP/1.1 
Host: returnit-api-dev.happen.zone 
Accept: text/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Items: 
	[
		{
			
		}
	],
	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
		}
	}
}