Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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

Permission to run the request: Account Owner, Administrator. 

 

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.
X-User-Portal-Enabled (optional, default: 1)0 or 1
X-Welcome-Title (optional)Welcome Title to that will be displayed on in User Portal.
X-Instruction-Message (optional)Instruction Message to that will be displayed on in User Portal.
X-Show-PublicHistory-ContentReports (optional, default: 1)0 or 1
X-ShowCourses-HistorySort-Reports Column (optional, default: 1)0 or 1
X-Show-Tags (optional, default: 0)0 or 1
)

Specify how to source courses in User Portal: by status, title or duration.

Values:

  • status
  • title
  • duration

After the request has been completed, the system returns the response with Code 200.

Possible Response Codes

CodeTextDescription
403Permission deniedYou have no permission to change the setting of User Portal. Only Account Owner and Administrator have permission to send the request.
400Bad RequestThe system failed to process the request, because it did not contain all necessary parameters.
200OkUser Portal settings have been changed.

 

Sample Request

Code Block
languagexml
POST /account/user_portal HTTP/1.1


Host: api.ispringonline.com


X-Auth-Account-Url: http://myaccount.
ispringonline
ispringlearn.com


X-Auth-Email: email@email.com


X-Auth-Password: password


X-User-Portal-Enabled:
 
 1


X-Welcome-Title:
 
 Welcome title


X-Instruction-Message:
 
 Instruction
 
 Message


X-Show-
Public-Content: 1
X
-Show-
History-Reports:
 
 0


X-
Show
Courses-
Tags: 0
Sort-Column: status

 

Sample Response

Code Block
languagexml
HTTP/1.1
 
 200 OK

Server:

nginx
Connection: close