Getting User Portal Settings

You can get User Portal settings by sending the GET request to the following URL: /account/user_portal.

Request Headers

Parameter Description
X-Auth-Account-Url (required) Base URL of the account, e.g. http://myaccount.ispringonline.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 reponse will contain xml data with User Portal settings.

Possible Response Codes

Code Text Description
200 Ok The request has been processed successfully.

Sample Request

GET /account/user_portal HTTP/1.1
Host: api.ispringonline.com
X-Auth-Account-Url: http://myaccount.ispringonline.com
X-Auth-Email: email@email.com
X-Auth-Password: password

Sample Response

HTTP/1.1 200 OK
Server: nginx
Connection: close

<userPortalSettings>
  <userPortalEnabled>1</userPortalEnabled>
  <welcomeTitle>Welcome Title</welcomeTitle>
  <instructionMessage>Instruction message</instructionMessage>
  <showPublicContent>1</showPublicContent>
  <showHistoryReports>1</showHistoryReports>
  <showTags>0</showTags>
</userPortal>