Reviews
Reviews can be read for one training or an entire institute.
Available Methods
| Method | Description |
GET /institutes/:id/reviews.xml |
Get reviews for an institute |
GET /trainings/:id/reviews.xml |
Get reviews for a training |
For educational providers:
If you want to show your reviews or an average of the reviews on your website, you can just copy paste our Review Widget code. If you want to create a custom widget this is possible too. You can use the Review Endpoint (and perhaps the Springest_id for institutes with imports from our trainings endpoint) to get all the data.
Conditions for creating a custom review widget:
- sign our data agreement file
- provide a link back to Springest where the custom widget is shown.
Note: As of 2020 it is not possible to POST reviews directly to our reviews endpoint. You can use the Review Request flow for this. Below information is purely for reference.
For requesting an API key, sending the data agreement file or questions please contact datasupport@springest.com
DISABLED: Create a review for an institute
Request: POST /institutes/:id/reviews.xml?api_key=YOURAPIKEY
DISABLED: Here is an example of how to do a single post request to add a review to Springest:
curl -k --data "review[training_id]=951&review[description]=SOME TEXT&review[course_completed_at]='2014-01-12'&review[rating]=8&review[author_name]=Detmar&review[created_at]='2014-02-01'&review[author_email]=detmartest@springest.com" "https://api.springest.nl/reviews.xml?api_key=***
Parameters
| Parameter | Type | Values | Description |
|---|---|---|---|
review[training_name] |
String | The name of the training the review is about | optional |
review[training_id] |
Integer | The ID of the training in Springest | Required if no training_name |
review[description] |
String | The written content of the training | Required (minimum 30 words) |
review[anonymous_review] |
Boolean | True if the reviewer wishes to remain anonymous, false otherwise | Optional |
review[ip_address] |
Ipv4 | IP address of the reviewer at the time the review was created | Optional |
review[created_at] |
String | The date the review was created on in iso8601 format | Required |
review[course_completed_at] |
String | The date the course was completed (month and year are used) | Required |
review[rating] |
Integer | A rating between 1 and 10 for the training | Required |
review[author_email] |
String | The reviewers email address | Required |
review[author_name] |
String | The reviewer's name (will be hidden if anonymous) | Required |
review[source] |
String | The company that is sending us the review | Optional |
DISABLED: Create a review for a training
Request: POST /trainings/:id/reviews.xml?api_key=YOURAPIKEY
Parameters
| Parameter | Type | Values | Description |
|---|---|---|---|
review[description] |
String | The written content of the training | Required (minimum 30 words) |
review[anonymous_review] |
Boolean | True if the reviewer wishes to remain anonymous, false otherwise | Optional |
review[ip_address] |
Boolean | IP address of the reviewer at the time the review was created | Optional |
review[created_at] |
String | The date the review was created on in iso8601 format | Required |
review[course_completed_at] |
String | The date the course was completed (month and year are used) | Required |
review[rating] |
Integer | A rating between 1 and 10 for the training | Required |
review[author_email] |
String | The reviewers email address | Required |
review[author_name] |
String | The reviewer's name (will be hidden if anonymous) | Required |
review[source] |
String | The company that is sending us the review | Optional |