POST api/Security/UserInfo

Use this method to authenticate a user and get profile information

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
CompanyID	The company number user is associated with	integer	None.
LogonName	The logon name of the user	string	None.
Password	The password of the user	string	None.
UserGUID	Unique system generated user identifier (replaces above parameters if known)	string	None.

Request Formats

application/json, text/json

Sample:

{
  "CompanyID": 1,
  "LogonName": "sample string 2",
  "Password": "sample string 3",
  "UserGUID": "sample string 4"
}

application/xml, text/xml

Sample:

<UserInfoParm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ParcelLogic.WebApi.ShipperPortal.Models">
  <CompanyID>1</CompanyID>
  <LogonName>sample string 2</LogonName>
  <Password>sample string 3</Password>
  <UserGUID>sample string 4</UserGUID>
</UserInfoParm>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

UserInfoResp

Name	Description	Type	Additional information
IsSuccessful	User authentication was successful (true)	boolean	None.
ErrorMessage	Error message is authentication failed	string	None.
PasswordHasExpired	Authentication successful, but password has expired (true)	boolean	None.
TermsAgreeNeeded	Authentication successful, but user has not agreed to terms and conditions (true)	boolean	None.
UserGUID	Unique system assigned user identifier	string	None.
LogonName	User logon name	string	None.
FirstName	Users first name	string	None.
LastName	Users last name	string	None.
EmailAddress	Users email address	string	None.
PhoneNumber	Users phone number	string	None.
TimezoneID	Users timezone identifier (WorldTimeServer.com)	string	None.
CountryID	Users country identifier	string	None.
CurrencyID	Users currency ID (ie. USD)	string	None.
WeightUOM	Weight unit of measure (LB,KG)	string	None.
SizeUOM	Size unit of measure (IN,CM)	string	None.
DistanceUOM	Distance unit of measure (MI,KM)	string	None.
TemperatureUOM	Temperate unit of measure (F,C)	string	None.
CompanyID	The company ID the user belongs to	integer	None.
AccountNumber		string	None.
AccountNumberShipper		string	None.
BillToType		string	None.
UserCompanyName		string	None.
LogoName		string	None.
Pieces		integer	None.
Weight		decimal number	None.
Length		integer	None.
Width		integer	None.
Height		integer	None.
PickupCompanyName		string	None.
PickupAddress1		string	None.
PickupAddress2		string	None.
PickupAddress3		string	None.
PickupCityName		string	None.
PickupStateProvID		string	None.
PickupPostalCode		string	None.
PickupCountryID		string	None.
PickupTimezoneID		string	None.
PickupPersonToSee		string	None.
PickupPhoneNumber		string	None.
PickupAfterHoursNumber		string	None.
PickupFaxNumber		string	None.
PickupEmailAddress		string	None.
PickupInstructions		string	None.
PickupReadyTime		date	None.
PickupReadyNow		boolean	None.
PickupAirportID		string	None.
PickupDistance		integer	None.
DeliveryCompanyName		string	None.
DeliveryAddress1		string	None.
DeliveryAddress2		string	None.
DeliveryAddress3		string	None.
DeliveryCityName		string	None.
DeliveryStateProvID		string	None.
DeliveryPostalCode		string	None.
DeliveryCountryID		string	None.
DeliveryTimezoneID		string	None.
DeliveryAttention		string	None.
DeliveryPhoneNumber		string	None.
DeliveryAfterHoursNumber		string	None.
DeliveryFaxNumber		string	None.
DeliveryEmailAddress		string	None.
DeliveryInstructions		string	None.
DeliveryRequestTime		date	None.
DeliveryRequestAsap		boolean	None.
DeliveryAirportID		string	None.
DeliveryDistance		integer	None.
DeclaredValue		decimal number	None.
Contents		string	None.
Reference		string	None.
Reference2		string	None.
Reference3		string	None.
Reference4		string	None.
Reference5		string	None.
ReferenceTypeID		integer	None.
ReferenceTypeID2		integer	None.
ReferenceTypeID3		integer	None.
ReferenceTypeID4		integer	None.
ReferenceTypeID5		integer	None.
ReferenceLabel		string	None.
ReferenceLabel2		string	None.
ReferenceLabel3		string	None.
ReferenceLabel4		string	None.
ReferenceLabel5		string	None.
ContentsLabel		string	None.
ShowRates		boolean	None.
OfficeID		integer	None.
UserGroupGUID		string	None.
ServiceGUID		string	None.
ShowMap		boolean	None.
OrderFormType		string	None.
ReferenceGroupGUID		string	None.
ReferenceGroupGUID2		string	None.
ReferenceGroupGUID3		string	None.
ReferenceGroupGUID4		string	None.
ReferenceGroupGUID5		string	None.
OperationsAlertEmail		string	None.
SendNewOrderEmail		boolean	None.
MaxSearchDays		integer	None.
NotifyShipperOrderAck		boolean	None.
NotifyShipperOrderRouted		boolean	None.
NotifyShipperDispatched		boolean	None.
NotifyShipperPickedUp		boolean	None.
NotifyShipperDepToAp		boolean	None.
NotifyShipperObcCheckin		boolean	None.
NotifyShipperDropped		boolean	None.
NotifyShipperConfirmed		boolean	None.
NotifyShipperDeparted		boolean	None.
NotifyShipperArrived		boolean	None.
NotifyShipperRecovered		boolean	None.
NotifyShipperOutForDelivery		boolean	None.
NotifyShipperDelivered		boolean	None.
NotifyShipperOrigQdt		boolean	None.
NotifyShipperChangeQdt		boolean	None.
NotifyConseeOrderAck		boolean	None.
NotifyConseeOrderRouted		boolean	None.
NotifyConseeDispatched		boolean	None.
NotifyConseePickedUp		boolean	None.
NotifyConseeDepToAp		boolean	None.
NotifyConseeObcCheckin		boolean	None.
NotifyConseeDropped		boolean	None.
NotifyConseeConfirmed		boolean	None.
NotifyConseeDeparted		boolean	None.
NotifyConseeArrived		boolean	None.
NotifyConseeRecovered		boolean	None.
NotifyConseeOutForDelivery		boolean	None.
NotifyConseeDelivered		boolean	None.
NotifyConseeOrigQdt		boolean	None.
NotifyConseeChangeQdt		boolean	None.
ServiceAvailType		string	None.
ContentsReferenceGroupGUID		string	None.
HoldForPickup		boolean	None.
DeliverWhen		string	None.
HideRouting		boolean	None.
Reference6		string	None.
Reference7		string	None.
Reference8		string	None.
Reference9		string	None.
ReferenceTypeID6		integer	None.
ReferenceTypeID7		integer	None.
ReferenceTypeID8		integer	None.
ReferenceTypeID9		integer	None.
ReferenceLabel6		string	None.
ReferenceLabel7		string	None.
ReferenceLabel8		string	None.
ReferenceLabel9		string	None.
ReferenceGroupGUID6		string	None.
ReferenceGroupGUID7		string	None.
ReferenceGroupGUID8		string	None.
ReferenceGroupGUID9		string	None.
ShpUseOrderNumAsTrackNum		boolean	None.
ShpShowOrderNumBeforeSave		boolean	None.
IsDangerousGoods		boolean	None.
DgUNNumber		string	None.
DgCommodityClass		string	None.
DgDryIceWeight		decimal number	None.
DgTransportationIndex		string	None.
DgTransportationLimit		string	None.
DgIsRadioactive		boolean	None.
DgPackingGroup		string	None.
DgQuantityAndPackType		string	None.
DgPackingInst		string	None.
DgAuthorization		string	None.
DgHandlingInfo		string	None.
DgEmergencyPhone		string	None.
DgSignatory		string	None.
DgProperName		string	None.
DgDate		date	None.

Response Formats

application/json, text/json

Sample:

Sample not available.