Getting User Profile Fields

You can obtain the list of the user profile fields with the getUserProfileFields method.

Parameters

Parameter Type Description
credentials (required) credentials Read the description of the Credentials object.

Return Value

After the request has been completed, the system returns an object with the following properties.

Parameter Type Description
UserFieldInfo[] array An array of objects with the following properties: userFieldInfoId, name, label, type, isUnique, isVisible, isRequired, orderPriority.

Sample Call

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="http://new.webservice.namespace">
  <SOAP-ENV:Body>
    <ns1:GetUserProfileFieldsRequest>
       <ns1:credentials>
         <ns1:accountUrl>http://myaccount.isonline.com</ns1:accountUrl>
         <ns1:email>email@email.com</ns1:email>
         <ns1:password>password</ns1:password>
       </ns1:credentials>
    </ns1:GetUserProfileFieldsRequest>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Sample Response

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="http://new.webservice.namespace">
  <SOAP-ENV:Body>
    <ns1:GetUserProfileFieldsResult>
      <ns1:userFieldInfo>
        <ns1:userFieldInfoId>3</ns1:userFieldInfoId>
        <ns1:name>first_name</ns1:name>
        <ns1:label>First Name</ns1:label>
        <ns1:type>string</ns1:type>
        <ns1:isUnique>false</ns1:isUnique>
        <ns1:isVisible>true</ns1:isVisible>
        <ns1:isRequired>true</ns1:isRequired>
        <ns1:orderPriority>-15</ns1:orderPriority>
      </ns1:userFieldInfo>
   
      <ns1:userFieldInfo>
        <ns1:userFieldInfoId>4</ns1:userFieldInfoId>
        <ns1:name>last_name</ns1:name>
        <ns1:label>Last name</ns1:label>
        <ns1:type>string</ns1:type>
        <ns1:isUnique>false</ns1:isUnique>
        <ns1:isVisible>true</ns1:isVisible>
        <ns1:isRequired>true</ns1:isRequired>
        <ns1:orderPriority>-13</ns1:orderPriority>
      </ns1:userFieldInfo>
    </ns1:GetUserProfileFieldsResult>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>