Antel Merchandiser App API

CheckPrincipals

The following routes are available for this service:
POST	/principal/check

**CheckPrincipals** Parameters:
Name	Parameter	Data Type	Required	Description
Principals	body	List<PrincipalAppSync>	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

**PrincipalAppSync** Parameters:
Name	Parameter	Data Type	Required	Description
PrincipalId	form	int	No
LastUpdated	form	string	Yes

**CheckPrincipalsResponse** Parameters:
Name	Parameter	Data Type	Required
PrincipalsToUpdate	form	List<int>	Yes
PrincipalAppSyncData	form	List<PrincipalAppSync>	Yes
AuthRules	form	List<PrincipalAuthRuleData>	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

**PrincipalAuthRuleData** Parameters:
Name	Parameter	Data Type	Required
PrincipalId	form	int	No
ValueAuthRules	form	List<AuthRuleData>	Yes
UnitAuthRules	form	List<AuthRuleData>	Yes

**AuthRuleData** Parameters:
Name	Parameter	Data Type	Required
FromValue	form	double	No
ToValue	form	double	No
Allow	form	bool	No
AuthRequired	form	bool	No
Region	form	string	Yes
Channel	form	string	Yes
UnitOfMeasure	form	UnitOfMeasureData	Yes

**UnitOfMeasureData** Parameters:
Name	Parameter	Data Type	Required	Description
Id	form	int	No
Name	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.

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

{
	Principals: 
	[
		{
			PrincipalId: 0,
			LastUpdated: String
		}
	],
	ApiKey: String,
	Latitude: 0,
	Longitude: 0
}

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

{
	PrincipalsToUpdate: 
	[
		0
	],
	PrincipalAppSyncData: 
	[
		{
			PrincipalId: 0,
			LastUpdated: String
		}
	],
	AuthRules: 
	[
		{
			PrincipalId: 0,
			ValueAuthRules: 
			[
				{
					
				}
			],
			UnitAuthRules: 
			[
				{
					
				}
			]
		}
	],
	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
		}
	}
}