Antel API

<back to all web services

UserLogin

The following routes are available for this service:
POST/user/login
UserLogin Parameters:
NameParameterData TypeRequiredDescription
EmailAddressbodystringNo
PasswordbodystringNo
UtcOffsetbodyintNo
PushPlayerIdbodystringNoThe user's push token - used for push messages.
RefreshTokenbodystringNoRefresh token used to auto login the user.
ApiServiceRequest Parameters:
NameParameterData TypeRequiredDescription
ApiKeyformstringYesThe API Key required for authentication
LatitudeformdoubleNoLatitude of the user making this request
LongitudeformdoubleNoLongitude of the user making this request
UserLoginResponse Parameters:
NameParameterData TypeRequiredDescription
DataformLoginDataNo
ApiServiceResponse Parameters:
NameParameterData TypeRequiredDescription
DescriptionformstringYesInformation about the response.
HeadingformstringYesHeading or summary of the response.
WasSuccessfulformbooleanYesDid the intended operation for this response complete successfully?
ResponseStatusformResponseStatusNo
LoginData Parameters:
NameParameterData TypeRequiredDescription
SystemUserIdformintNo
RefreshTokenformstringNo
FriendlyNameformstringNo
VatValueformdecimalNo
CanUpliftformboolNo
StockCanDropOffformboolNo
StockCanCloseArrivalformboolNo
BlockUpliftIfLineCountDoesNotMatchformboolNo
BlockUpliftIfQuantityDoesNotMatchformboolNo
CanRipTipformboolNo
CanDeleteUpliftsformboolNo
StockOperatorsformList<StockOperatorData>No
ClaimNumberRulesformList<ClaimNumberRule>No
UpliftSyncIntervalformintNo
LateUpliftThresholdformintNo
PauseUpliftReasonsformList<string>No
NoGoodsToUpliftReasonsformList<string>No
BlurryImageErrorScoreformdecimalNo
BlurryImageWarningScoreformdecimalNo
BlurryImageDetectionEnabledformboolNo
ProfileImageUrlformstringNo
ClaimValueWarningVarianceformdoubleNo
StockCanVehicleAssignmentformboolNo
StockCanOperatorAssignmentformboolNo
StockCanStockEndformboolNo
StockCanCheckSealDetailsformboolNo
StockManualEnabledformboolNo
StockOperatorData Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
NameformstringNo
ClaimNumberRule Parameters:
NameParameterData TypeRequiredDescription
PrincipalIdformintNo
ChannelNameformstringNo
RulePatternformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json
Content-Type: application/json
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: application/json
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"}}}