Antel Merchandiser App API

SaveUpliftRequest

The following routes are available for this service:
POST	/upliftrequest

**SaveUpliftRequest** Parameters:
Name	Parameter	Data Type	Required	Description
UpliftRequest	body	UpliftRequestData	Yes

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

**UpliftRequestData** Parameters:
Name	Parameter	Data Type	Required
UpliftRequestId	form	int	No
Id	form	Guid	No
OutletId	form	int	No
Products	form	List<UpliftRequestProductData>	Yes
OutletEmailAddress	form	string	Yes
OutletContactName	form	string	Yes
OutletChannel	form	string	Yes
OutletRegion	form	string	Yes
AdditionalNotes	form	string	Yes
MerchandiserSignatureImage	form	Object	Yes
StartTime	form	string	Yes
StartLatitude	form	double	No
StartLongitude	form	double	No
EndTime	form	string	Yes
EndLatitude	form	double	No
EndLongitude	form	double	No
LastUpdated	form	DateTime	No
LastSynced	form	DateTime	No
IncompleteUpliftRequestId	form	string	Yes
AuthRequestId	form	Guid	No
Authorised	form	bool	No
PrincipalId	form	int	No
Seals	form	List<SealData>	Yes
Confirmed	form	bool	No
Cancelled	form	bool	No
Images	form	List<Object>	Yes
SubmitImmediately	form	bool	No

**UpliftRequestProductData** Parameters:
Name	Parameter	Data Type	Required
Id	form	Guid	No
UpliftRequestProductId	form	int	No
ProductId	form	int	No
PrincipalId	form	int	No
UnitPrice	form	decimal	No
Name	form	string	Yes
Category	form	string	Yes
UnitBarcode	form	string	Yes
UnitSize	form	string	Yes
UnitWeight	form	decimal	No
Code	form	string	Yes
Images	form	List<Object>	Yes
Quantity	form	double	No
Value	form	decimal	No
ProductionDate	form	string	Yes
ExpiryDate	form	string	Yes
BatchCode	form	string	Yes
Seal	form	SealData	Yes
SerialNumber	form	string	Yes
StockStatusId	form	int	No
PrincipalLogoUrl	form	string	Yes
PrincipalName	form	string	Yes
StockStatusName	form	string	Yes
StockStatusColor	form	string	Yes
UnitOfMeasureId	form	int	No

**Seal** Parameters:
Name	Parameter	Data Type	Required	Description
Number	form	string	No
Weight	form	double	No

**SaveUpliftRequestResponse** Parameters:
Name	Parameter	Data Type	Required
UpliftRequestProductIds	form	List<int>	Yes
AuthRequestId	form	Guid	No
UpliftRequestId	form	int	No
DeleteFromDevice	form	bool	No
ImageIds	form	List<string>	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

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.

POST /upliftrequest HTTP/1.1 
Host: returnit-api-dev.happen.zone 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	UpliftRequest: 
	{
		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
	},
	ApiKey: String,
	Latitude: 0,
	Longitude: 0
}

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

{
	UpliftRequestProductIds: 
	[
		0
	],
	UpliftRequestId: 0,
	DeleteFromDevice: False,
	ImageIds: 
	[
		String
	],
	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
		}
	}
}