GetUserDetail( username ) : UserDetail
Since: EngageIP v25.2
Retrieves the details of a user based on the provided username.
The data returned from this method call represents a UserDetail object which has the following properties:
ID (Integer) - The unique ID for the user
RoleID (Integer) - The ID representing this user's assigned role
Role (String) - The name of the role associated with the RoleID
CultureID (Integer) - The ID representing the assigned culture
Culture (String) - The name of the culture associated with the CultureID
CurrencyID (Integer) - The ID representing the assigned currency
Currency (String) - The name of the currency associated with the CurrencyID
LanguageID (Integer) - The ID representing the assigned language
Language (String) - The name of the language associated with the LanguageID
OwnerID (Integer) - The ID of the owner for which this user belongs
Owner (String) - The name of the owner associated with the OwnerID
Account (String) - The name of the account if an alternate name was supplied when creating the user, otherwise it will be the same as ID
Name (String) - The name of this user
Password (String) - The user's password
CreatedDate (DateTime) - The date/time stamp for when this user was created
UserStatusTypeID (Integer) - The ID of the user's status type
UserStatusType (String) - The name of the user status type associated with the UserStatusTypeID
CreditRatingID (Integer) - The ID representing the assigned credit rating
Assignable (Boolean) - Indicates if this user can be assigned tickets
BillGroupID (Integer) - The ID representing the assigned bill group
BillGroup (String) - The name of the bill group associated with the BillGroupID
CreditRating (String) - The name of the credit rating associated with the CreditRatingID
PasswordLastChangedDate (DateTime) - The time stamp from when the password was last changed
ActingOwnerID (Integer) - The owner who's product catalog the user can buy packages from. NOTE: In the case of an unbranded owner the acting owner and owner are distinct.
ExpireDate (DateTime) - The date and time for when this user expires
InvoiceConfigurationID (Integer) - The ID representing the assigned Invoice Configuration
InvoiceConfiguration (String) - The name of the invoice configuration associated with the InvoiceConfigurationID
InvoiceDeliveryType (String) - Name of the invoice delivery type, for example Email, Hard copy etc...
Current_StatusTypeID (Integer) - The current status of the user, the ID corresponds to the four base status types of Active, Canceled, Prospect and Suspended
CreatedBy (Integer) - User who created this account, for audit purposes
ForcePasswordChangeOnNextLogin (Boolean) - Whether or not to force a password change the next time the user attempts a login
ParentID (Integer) - Parent account ID if the user is a child account, otherwise null
Parameters:
username (String) - The username in which to retrieve details. An exception will be thrown if the username does not exist.
Returns:
A UserDetail object containing information about the requested user
Possible Exceptions:
INVALID USERNAME
SOAP 1.2
The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.
POST /adminportal/webservice.asmx HTTP/1.1
Host: demo.logisense.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Header>
<AuthHeader xmlns="Logisense_EngageIP">
<Username>string</Username>
<Password>string</Password>
</AuthHeader>
</soap12:Header>
<soap12:Body>
<GetUserDetail xmlns="Logisense_EngageIP">
<username>string</username>
</GetUserDetail>
</soap12:Body>
</soap12:Envelope>
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<GetUserDetailResponse xmlns="Logisense_EngageIP">
<GetUserDetailResult>
<ID>int</ID>
<RoleID>int</RoleID>
<CultureID>int</CultureID>
<CurrencyID>int</CurrencyID>
<LanguageID>int</LanguageID>
<OwnerID>int</OwnerID>
<Account>string</Account>
<Name>string</Name>
<Password>string</Password>
<CreatedDate>dateTime</CreatedDate>
<UserStatusTypeID>int</UserStatusTypeID>
<CreditRatingID>int</CreditRatingID>
<Role>string</Role>
<Culture>string</Culture>
<Currency>string</Currency>
<Language>string</Language>
<Owner>string</Owner>
<Assignable>boolean</Assignable>
<BillGroupID>int</BillGroupID>
<UserStatusType>string</UserStatusType>
<BillGroup>string</BillGroup>
<CreditRating>string</CreditRating>
<PasswordLastChangedDate>dateTime</PasswordLastChangedDate>
<ActingOwnerID>int</ActingOwnerID>
<ExpireDate>dateTime</ExpireDate>
<InvoiceConfigurationID>int</InvoiceConfigurationID>
<InvoiceDeliveryType>string</InvoiceDeliveryType>
<Current_StatusTypeID>int</Current_StatusTypeID>
<CreatedBy>int</CreatedBy>
<ForcePasswordChangeOnNextLogin>boolean</ForcePasswordChangeOnNextLogin>
<InvoiceConfiguration>string</InvoiceConfiguration>
<ParentID>int</ParentID>
</GetUserDetailResult>
</GetUserDetailResponse>
</soap12:Body>
</soap12:Envelope>
SOAP 1.1
The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.
POST /adminportal/webservice.asmx HTTP/1.1
Host: demo.logisense.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "Logisense_EngageIP/GetUserDetail"
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Header>
<AuthHeader xmlns="Logisense_EngageIP">
<Username>string</Username>
<Password>string</Password>
</AuthHeader>
</soap:Header>
<soap:Body>
<GetUserDetail xmlns="Logisense_EngageIP">
<username>string</username>
</GetUserDetail>
</soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<GetUserDetailResponse xmlns="Logisense_EngageIP">
<GetUserDetailResult>
<ID>int</ID>
<RoleID>int</RoleID>
<CultureID>int</CultureID>
<CurrencyID>int</CurrencyID>
<LanguageID>int</LanguageID>
<OwnerID>int</OwnerID>
<Account>string</Account>
<Name>string</Name>
<Password>string</Password>
<CreatedDate>dateTime</CreatedDate>
<UserStatusTypeID>int</UserStatusTypeID>
<CreditRatingID>int</CreditRatingID>
<Role>string</Role>
<Culture>string</Culture>
<Currency>string</Currency>
<Language>string</Language>
<Owner>string</Owner>
<Assignable>boolean</Assignable>
<BillGroupID>int</BillGroupID>
<UserStatusType>string</UserStatusType>
<BillGroup>string</BillGroup>
<CreditRating>string</CreditRating>
<PasswordLastChangedDate>dateTime</PasswordLastChangedDate>
<ActingOwnerID>int</ActingOwnerID>
<ExpireDate>dateTime</ExpireDate>
<InvoiceConfigurationID>int</InvoiceConfigurationID>
<InvoiceDeliveryType>string</InvoiceDeliveryType>
<Current_StatusTypeID>int</Current_StatusTypeID>
<CreatedBy>int</CreatedBy>
<ForcePasswordChangeOnNextLogin>boolean</ForcePasswordChangeOnNextLogin>
<InvoiceConfiguration>string</InvoiceConfiguration>
<ParentID>int</ParentID>
</GetUserDetailResult>
</GetUserDetailResponse>
</soap:Body>
</soap:Envelope>