Use Try It Out to Update Learner Details

The following example describes how REST Services can be used to update learner data.

Note: Refer to Use the Try It Out Functionality for a video describing this process.

To update learner data:

1. Open the relevant learner record using the Learner Search and make a note of their Person Code.

   

2. Copy the Web service host URL institution setting (on the General (Cross System) screen).

   

   Note: The URL of your REST Services documentation is stored in the Web service host URL setting on the General (Cross-System) screen in Institution Settings.

3. Open a browser and paste the URL into the browser’s address bar, appending the URL with /docs (that is: http://<web service host URL>/docs).

   The ebs REST Documentation page is displayed.

   

   Services with a greyed-out padlock icon require authentication, so first, you must authorise the REST services session to use the Try It Out functionality.

The REST services states are described in the following table.

REST icon	REST service state
	Unauthorised - authorisation is required before 'Try it out' functionality is enabled.
	Authorised - 'Try it out' functionality is enabled.

4. Click the Authorize button.

   

   The Available authorizations window is displayed.

   

5. Enter your username and password. Click the Authorize button.

   

6. Click Close.

   

7. Click the Authentication REST Service.

   

   The Authentication REST service is displayed.

   

8. Click the Try it out button.

   

9. Click the Execute button.

   

   Copy the string from between the two token values found in the Responses body section (for example: <Token>123456789ABCDEFG</Token>).

   

10. Click the Authorize button.

    

    The Available authorizations window is displayed.

11. Paste the token into the Value field and click the Authorize button.

    

12. Click Close.

    

13. Browse to the People section and click the PUT/People/{personCode} REST Service to expand it.

    

14. Click the Try it out button.

    

15. Enter the personCode of the learner to be updated into The person code of the person to be updated field.

    

16. Substitute the relevant string value in the Edit value field for the alteration (for example: change the "Forename": "string", value to "Forename": "John",) and remove all unaltered fields, except for the opening and closing brackets (that is: {"Forename": "John",}).

    

17. Click the Execute button.

    

    The response is displayed on screen: 

    • 200 - update successful

    • 400 - there was a problem updating the learner’s record

    • 404 - the learner’s record could not be found

    

18. Use the Learner Search to verify that the update was successful.

    

Back to top