Page tree
Skip to end of metadata
Go to start of metadata

You can get the list of the user profile fields by sending an HTTP GET request to the following URL: /user/profile/fields.

Request Headers

ParameterDescription
X-Auth-Account-Url (required)Base URL of the account, e.g. http://myaccount.ispringlearn.com
X-Auth-Email (required)Administrator/Publisher e-mail address.
X-Auth-Password (required)Administrator/Publisher password.

 

After the request has been completed, the system returns the response with Code 200. The body of the response will contain xml data with the list of the user profile fields.

Possible Response Codes

CodeTextDescription
200OkThe request has been processed successfully.

 

Sample Request

GET /user/profile/fields HTTP/1.1
Host: api.ispringonline.com
X
-Auth-Account-Url: http://myaccount.ispringonline.com
X
-Auth-Email: email@email.net
X
-Auth-Password: password

Sample Response

HTTP/1.1 200 OK
Server: nginx/1.0.4
Date: Tue, 21 Feb 2012 12:52:28 GMT
Content-Type: text/html; charset=utf-8
Connection: close

<?xml version="1.0" encoding="UTF-8"?>
<userProfileFields>
 
<userFieldInfo>
   
<userFieldInfoId>3</userFieldInfoId>
    <name>first_name</
name>
   
<label>First Name</label>
    <type>string</
type>
   
<isUnique>false</isUnique>
    <isVisible>true</
isVisible>
   
<isRequired>true</isRequired>
    <orderPriority>-15</
orderPriority>
 
</userFieldInfo>
    <userFieldInfo>
    <userFieldInfoId>4</
userFieldInfoId>
   
<name>last_name</name>
    <label>Last name</
label>
   
<type>string</type>
    <isUnique>false</
isUnique>
   
<isVisible>true</isVisible>
    <isRequired>true</
isRequired>
   
<orderPriority>-13</orderPriority>
  </
userFieldInfo>
   
<userFieldInfo>
   
<userFieldInfoId>10</userFieldInfoId>
    <name>city</
name>
   
<label>City</label>
    <type>string</
type>
   
<isUnique>false</isUnique>
    <isVisible>true</
isVisible>
   
<isRequired>false</isRequired>
    <orderPriority>-3</
orderPriority>
 
</userFieldInfo>
</
userProfileFields>
  •