API – Import external rating
Before making a request - log in as a user with the role of Administrator. How to log in via API is described here API – Authorization
- To import an external rating you need to send POST request to the following URI /api/rest.php/user-rating?action=set-external-user-rating
- The request body should contain JSON object with information about user, date and rating value.
- The request must contain the headings Content-Type: application/json;charset=UTF-8 and Authorization: Bearer xxxxxx.
Request example:
curl 'https://your-domain.davintoo.com/api/rest.php/user-rating?action=set-external-user-rating' -H 'Authorization: Bearer xxxxxx' -H 'Content-Type: application/json;charset=UTF-8' --data-binary '{"user_id":6085,"rating":94,"date":"2022-07-17"}'
Instead of a local address http://your-domain.davintoo.com you need to use the address of your instance.
In order for the external rating to be displayed on a graph in the user's learning history (in more detail Rating review by a user) the option must be enabled in the portal settings Allow adding external data to the user rating graph. This option is enabled by the technical support of the portal.
Format of the object with user information
* Mandatory fields are marked with an asterisk
To identify a user, either user_id or uid must be specified
| Field | Type | Description |
|---|---|---|
| _userid | Number | Internal user ID in the system |
| uid | String | External user ID in the system |
| rating* | Number | Value of external rating |
| date* | String | Date in YYYY-MM-DD format |
Answer
- In case of successful request (HTTP code response - 200), it will be true
- In case of error (HTTP response code - 400) it returns JSON object with error information:
{"user_id":{"required":"Field cannot be empty"}}