GET api/Mobile/GetUserInfo/{UserID}/{Password}/{ApplicationID}/{LocationData}
Used to authenicate user and get user profile information
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
UserID |
Unique user name |
string |
Required |
Password |
Users password |
string |
Required |
ApplicationID |
Application ID (PLVEND, PLSHIP, PLTMS) |
string |
Required |
LocationData |
Geocoded current location of the device (lat,long) |
string |
None. |
Body Parameters
None.
Response Information
Resource Description
MobileUserProfileName | Description | Type | Additional information |
---|---|---|---|
ErrorMessage |
The error message is a problem occurred with authentication |
string |
None. |
UserGUID |
Unique user identifier |
string |
None. |
FirstName |
First name of user |
string |
None. |
LastName |
Last name of user |
string |
None. |
TimezoneID |
The timezone identifier of the user |
string |
None. |
WeightUOM |
The weight unit of measure of the user (LB,KG) |
string |
None. |
SizeUOM |
The size unit of measure of the user (IN,CM) |
string |
None. |
CourierType |
The courier type of the user (A=agent,E=employee,C=contractor) |
string |
None. |
RequireChangePassword |
Is password change required |
string |
None. |
Response Formats
application/json, text/json
Sample:
{ "ErrorMessage": "sample string 1", "UserGUID": "sample string 2", "FirstName": "sample string 3", "LastName": "sample string 4", "TimezoneID": "sample string 5", "WeightUOM": "sample string 6", "SizeUOM": "sample string 7", "CourierType": "sample string 8", "RequireChangePassword": "sample string 9" }
application/xml, text/xml
Sample:
<MobileUserProfile xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mnx.WebApi.Transportation.Models.Mobile"> <CourierType>sample string 8</CourierType> <ErrorMessage>sample string 1</ErrorMessage> <FirstName>sample string 3</FirstName> <LastName>sample string 4</LastName> <RequireChangePassword>sample string 9</RequireChangePassword> <SizeUOM>sample string 7</SizeUOM> <TimezoneID>sample string 5</TimezoneID> <UserGUID>sample string 2</UserGUID> <WeightUOM>sample string 6</WeightUOM> </MobileUserProfile>