GetUserDetails

 Previous  Home topic  Next  Print this topic Send Feedback

The GetUserDetails method allows you to retrieve the details about a user through the API.

 

int GetUserDetails(string tokenIn, int userId, out string tokenOut, out string title, out string firstName, 

out string lastName, out string emailAddress, out string addressLine1, out string addressLine2, out string town, 

out string zipCode, out string stateProvince, out string countryISO, out string telephone, out string fax, 

out string cellphone, out string skype, out string alternateEmailAddress, out string languageISO, 

out string directoryServiceUserName, out string customId, out bool isActive, out UserType userType, 

out UserRoles roles)

 

 

Send Params

Return Params
•addressLine1
•addressLine2
•alternateEmailAddress
•cellphone
•countryISO
•customId
•directoryServiceUserName
•emailAddress
•fax
•firstName
•isActive - Indicates if the user is active or not.
•languageISO
•lastName
•roles - Indicates the user's roles (None = 1,  Forms = 2,  Reports = 4, Connections = 8, Users = 16, Account = 32, API = 64, Portal = 128).
•skype
•stateProvince
•telephone
•title
•tokenIn - This is the security token that is obtained by the previous API call. See the API Security topic for more details.
•town
•userId - The ID of the user from whom we want to get the details.
•userType - Indicates the type of user (1 - Basic User, 2 Advanced User).
•zipCode

tokenOut - This is the new security token that should be used for the next Web service call after this one. See the API Security topic for more details.

 

 

Test

The test form is only available for requests from the local machine.

 

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 /api/API.asmx HTTP/1.1

Host: testing.perfectforms.com

Content-Type: text/xml; charset=utf-8

Content-Length: length

SOAPAction: "http://www.PerfectForms.com/API/GetUserDetails"

 

<?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>

    <GetUserDetails xmlns="http://www.PerfectForms.com/API">

      <tokenIn>string</tokenIn>

      <userId>int</userId>

    </GetUserDetails>

  </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>

    <GetUserDetailsResponse xmlns="http://www.PerfectForms.com/API">

      <GetUserDetailsResult>int</GetUserDetailsResult>

      <tokenOut>string</tokenOut>

      <title>string</title>

      <firstName>string</firstName>

      <lastName>string</lastName>

      <emailAddress>string</emailAddress>

      <addressLine1>string</addressLine1>

      <addressLine2>string</addressLine2>

      <town>string</town>

      <zipCode>string</zipCode>

      <stateProvince>string</stateProvince>

      <countryISO>string</countryISO>

      <telephone>string</telephone>

      <fax>string</fax>

      <cellphone>string</cellphone>

      <skype>string</skype>

      <alternateEmailAddress>string</alternateEmailAddress>

      <languageISO>string</languageISO>

      <directoryServiceUserName>string</directoryServiceUserName>

      <customId>string</customId>

      <isActive>boolean</isActive>

      <userType>Basic or Advanced or Limited</userType>

      <roles>None or Forms or Reports or Connections or Users or Account or API or Portal</roles>

    </GetUserDetailsResponse>

  </soap:Body>

</soap:Envelope>

 

 

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 /api/API.asmx HTTP/1.1

Host: testing.perfectforms.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:Body>

    <GetUserDetails xmlns="http://www.PerfectForms.com/API">

      <tokenIn>string</tokenIn>

      <userId>int</userId>

    </GetUserDetails>

  </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>

    <GetUserDetailsResponse xmlns="http://www.PerfectForms.com/API">

      <GetUserDetailsResult>int</GetUserDetailsResult>

      <tokenOut>string</tokenOut>

      <title>string</title>

      <firstName>string</firstName>

      <lastName>string</lastName>

      <emailAddress>string</emailAddress>

      <addressLine1>string</addressLine1>

      <addressLine2>string</addressLine2>

      <town>string</town>

      <zipCode>string</zipCode>

      <stateProvince>string</stateProvince>

      <countryISO>string</countryISO>

      <telephone>string</telephone>

      <fax>string</fax>

      <cellphone>string</cellphone>

      <skype>string</skype>

      <alternateEmailAddress>string</alternateEmailAddress>

      <languageISO>string</languageISO>

      <directoryServiceUserName>string</directoryServiceUserName>

      <customId>string</customId>

      <isActive>boolean</isActive>

      <userType>Basic or Advanced or Limited</userType>

      <roles>None or Forms or Reports or Connections or Users or Account or API or Portal</roles>

    </GetUserDetailsResponse>

  </soap12:Body>

</soap12:Envelope>

 

Updated: 06/12/2011  Page url: http://www.perfectforms.com/Documentation/manual/html/?fg_getuserdetails.htm
PerfectForms™ -- forms software, workflow software, and business process management