Antel API

UserLogin

The following routes are available for this service:
POST	/user/login

**UserLogin** Parameters:
Name	Parameter	Data Type	Required	Description
EmailAddress	body	string	No
Password	body	string	No
UtcOffset	body	int	No
PushPlayerId	body	string	No	The user's push token - used for push messages.
RefreshToken	body	string	No	Refresh token used to auto login the user.

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

**UserLoginResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Data	form	LoginData	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	No

**LoginData** Parameters:
Name	Parameter	Data Type	Required
SystemUserId	form	int	No
RefreshToken	form	string	No
FriendlyName	form	string	No
VatValue	form	decimal	No
CanUplift	form	bool	No
StockCanDropOff	form	bool	No
StockCanCloseArrival	form	bool	No
BlockUpliftIfLineCountDoesNotMatch	form	bool	No
BlockUpliftIfQuantityDoesNotMatch	form	bool	No
CanRipTip	form	bool	No
CanDeleteUplifts	form	bool	No
StockOperators	form	List<StockOperatorData>	No
ClaimNumberRules	form	List<ClaimNumberRule>	No
UpliftSyncInterval	form	int	No
LateUpliftThreshold	form	int	No
PauseUpliftReasons	form	List<string>	No
NoGoodsToUpliftReasons	form	List<string>	No
BlurryImageErrorScore	form	decimal	No
BlurryImageWarningScore	form	decimal	No
BlurryImageDetectionEnabled	form	bool	No
ProfileImageUrl	form	string	No
ClaimValueWarningVariance	form	double	No
StockCanVehicleAssignment	form	bool	No
StockCanOperatorAssignment	form	bool	No
StockCanStockEnd	form	bool	No
StockCanCheckSealDetails	form	bool	No
StockManualEnabled	form	bool	No

**StockOperatorData** Parameters:
Name	Parameter	Data Type	Required	Description
Id	form	int	No
Name	form	string	No

**ClaimNumberRule** Parameters:
Name	Parameter	Data Type	Required
PrincipalId	form	int	No
ChannelName	form	string	No
RulePattern	form	string	No

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 /user/login HTTP/1.1 
Host: antel.api.dev.86degrees.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	emailAddress: String,
	password: String,
	utcOffset: 0,
	pushPlayerId: String,
	refreshToken: String,
	apiKey: String,
	latitude: 0,
	longitude: 0
}

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

{
	data: 
	{
		systemUserId: 0,
		refreshToken: String,
		friendlyName: String,
		vatValue: 0,
		canUplift: False,
		stockCanDropOff: False,
		stockCanCloseArrival: False,
		blockUpliftIfLineCountDoesNotMatch: False,
		blockUpliftIfQuantityDoesNotMatch: False,
		canRipTip: False,
		canDeleteUplifts: False,
		stockOperators: 
		[
			{
				
			}
		],
		claimNumberRules: 
		[
			{
				
			}
		],
		upliftSyncInterval: 0,
		lateUpliftThreshold: 0,
		pauseUpliftReasons: 
		[
			String
		],
		noGoodsToUpliftReasons: 
		[
			String
		],
		blurryImageErrorScore: 0,
		blurryImageWarningScore: 0,
		blurryImageDetectionEnabled: False,
		profileImageUrl: String,
		claimValueWarningVariance: 0,
		stockCanVehicleAssignment: False,
		stockCanOperatorAssignment: False,
		stockCanStockEnd: False,
		stockCanCheckSealDetails: False,
		stockManualEnabled: 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
		}
	}
}