POST api/Mobile/GetUserInfo

Used to authenicate user and profile user profile

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
CompanyID	The company ID of the user requesting authenticaion	integer	Required
UserID	The users logon name	string	Required
Password	The user password	string	Required
ApplicationID	The application ID (MOBILE)	string	Required
LocationData	Geocoded location data from the device	string	None.

Request Formats

application/json, text/json

Sample:

{
  "CompanyID": 1,
  "UserID": "sample string 2",
  "Password": "sample string 3",
  "ApplicationID": "sample string 4",
  "LocationData": "sample string 5"
}

application/xml, text/xml

Sample:

<GetUserInfoParm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ParcelLogic.WebApi.Mobile.Models">
  <ApplicationID>sample string 4</ApplicationID>
  <CompanyID>1</CompanyID>
  <LocationData>sample string 5</LocationData>
  <Password>sample string 3</Password>
  <UserID>sample string 2</UserID>
</GetUserInfoParm>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

MobileUserProfile

Name	Description	Type	Additional information
UserGUID	Unique user guid used whenever making calls to the API to authenicate access	string	None.
FirstName	First name of user	string	None.
LastName	Last name of user	string	None.
TimezoneID	Timezone identifier of user	string	None.
WeightUOM	Weight unit of measure for user (LB,KG)	string	None.
SizeUOM	Size unit of measure for user (IN,CM)	string	None.
CourierType	Courier type if user is courier (A=agent, I=independing courier, E=employee driver)	string	None.
ApplicationID	Application identifier (PLSHIP, PLVEND)	string	None.
ChangePassword	If true, then require user to change password	boolean	None.
IsSuccessful	Used to determine if method call was successful (true) or failure (false)	boolean	Required
ErrorMessage	The error message if method call was not successful	string	None.

Response Formats

application/json, text/json

Sample:

{
  "UserGUID": "sample string 1",
  "FirstName": "sample string 2",
  "LastName": "sample string 3",
  "TimezoneID": "sample string 4",
  "WeightUOM": "sample string 5",
  "SizeUOM": "sample string 6",
  "CourierType": "sample string 7",
  "ApplicationID": "sample string 8",
  "ChangePassword": true,
  "IsSuccessful": true,
  "ErrorMessage": "sample string 11"
}

application/xml, text/xml

Sample:

<MobileUserProfile xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ParcelLogic.WebApi.Mobile.Models">
  <ErrorMessage>sample string 11</ErrorMessage>
  <IsSuccessful>true</IsSuccessful>
  <ApplicationID>sample string 8</ApplicationID>
  <ChangePassword>true</ChangePassword>
  <CourierType>sample string 7</CourierType>
  <FirstName>sample string 2</FirstName>
  <LastName>sample string 3</LastName>
  <SizeUOM>sample string 6</SizeUOM>
  <TimezoneID>sample string 4</TimezoneID>
  <UserGUID>sample string 1</UserGUID>
  <WeightUOM>sample string 5</WeightUOM>
</MobileUserProfile>