AVAILABLE WITH BUSINESS SUBSCRIPTION

Method: getUserProfileFields 

Permissions to Run the Request

Account Owner, Account Administrators, Department Administrators, or custom roles

Department Administrators and users with a custom role can get profile fields of the users belonging to the departments they manage and their sub-departments.


Parameters


ParameterTypeDescription
token (required)stringAccess token. You can obtain a token by making a request.

Return Value

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

ParameterTypeDescription
userFieldInfo[]arrayAn 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="https://schemas.xmlsoap.org/soap/envelope/"
                   xmlns:ns1="https://new.webservice.namespace">
  <SOAP-ENV:Body>
    <GetUserProfileFieldsRequest>
       <credentials>
         <token>p-1sJDjmULL5DdpXPJTcbm4jVIaWVHvNmrjAxATRbNE</token>
       </credentials>
    </GetUserProfileFieldsRequest>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>
XML

Sample Response

<SOAP-ENV:Envelope xmlns:SOAP-ENV="https://schemas.xmlsoap.org/soap/envelope/"
                   xmlns:ns1="https://ispringlearn.com/go/services/api/soap">
    <SOAP-ENV:Body>
        <ns1:GetUserProfileFieldsResult>
            <ns1:userFieldInfo>
                <ns1:userFieldInfoId>string</ns1:userFieldInfoId>
                <ns1:name>login</ns1:name>
                <ns1:label>Login</ns1:label>
                <ns1:type>login</ns1:type>
                <ns1:isUnique>true</ns1:isUnique>
                <ns1:isVisible>true</ns1:isVisible>
                <ns1:isRequired>true</ns1:isRequired>
                <ns1:orderPriority>0</ns1:orderPriority>
            </ns1:userFieldInfo>
            <ns1:userFieldInfo>
                <ns1:userFieldInfoId>string</ns1:userFieldInfoId>
                <ns1:name>password</ns1:name>
                <ns1:label>Password</ns1:label>
                <ns1:type>password</ns1:type>
                <ns1:isUnique>false</ns1:isUnique>
                <ns1:isVisible>true</ns1:isVisible>
                <ns1:isRequired>true</ns1:isRequired>
                <ns1:orderPriority>1</ns1:orderPriority>
            </ns1:userFieldInfo>
            <ns1:userFieldInfo>
                <ns1:userFieldInfoId>string</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>false</ns1:isRequired>
                <ns1:orderPriority>2</ns1:orderPriority>
            </ns1:userFieldInfo>
            <ns1:userFieldInfo>
                <ns1:userFieldInfoId>string</ns1:userFieldInfoId>
                <ns1:name>email</ns1:name>
                <ns1:label>Email</ns1:label>
                <ns1:type>email</ns1:type>
                <ns1:isUnique>true</ns1:isUnique>
                <ns1:isVisible>true</ns1:isVisible>
                <ns1:isRequired>true</ns1:isRequired>
                <ns1:orderPriority>3</ns1:orderPriority>
            </ns1:userFieldInfo>
            <ns1:userFieldInfo>
                <ns1:userFieldInfoId>string</ns1:userFieldInfoId>
                <ns1:name>country_id</ns1:name>
                <ns1:label>Country</ns1:label>
                <ns1:type>country</ns1:type>
                <ns1:isUnique>false</ns1:isUnique>
                <ns1:isVisible>true</ns1:isVisible>
                <ns1:isRequired>false</ns1:isRequired>
                <ns1:orderPriority>5</ns1:orderPriority>
                <ns1:values>
                    <ns1:field>
                        <ns1:name>1</ns1:name>
                        <ns1:value>Afghanistan</ns1:value>
                    </ns1:field>
                    <ns1:field>
                        <ns1:name>2</ns1:name>
                        <ns1:value>Albania</ns1:value>
                    </ns1:field>
                    <ns1:field>
                        <ns1:name>3</ns1:name>
                        <ns1:value>Algeria</ns1:value>
                    </ns1:field>
                    <ns1:field>
                        <ns1:name>238</ns1:name>
                        <ns1:value>Zimbabwe</ns1:value>
                    </ns1:field>
                </ns1:values>
            </ns1:userFieldInfo>
            <ns1:userFieldInfo>
                <ns1:userFieldInfoId>string</ns1:userFieldInfoId>
                <ns1:name>string</ns1:name>
                <ns1:label>string</ns1:label>
                <ns1:type>list</ns1:type>
                <ns1:isUnique>false</ns1:isUnique>
                <ns1:isVisible>true</ns1:isVisible>
                <ns1:isRequired>false</ns1:isRequired>
                <ns1:orderPriority>7</ns1:orderPriority>
                <ns1:values>
                    <ns1:field>
                        <ns1:name>string</ns1:name>
                        <ns1:value>string</ns1:value>
                    </ns1:field>
                    <ns1:field>
                        <ns1:name>string</ns1:name>
                        <ns1:value>string</ns1:value>
                    </ns1:field>
                </ns1:values>
            </ns1:userFieldInfo>
         </ns1:GetUserProfileFieldsResult>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>
XML