Review requests (submitting a prefilled review form to Springest)

Gewijzigd op Do, 26 Okt, 2023 om 12:03 PM

Note: This is a technical explanation of the review request. For non technical explanation click here.

What does it do?

The review request API gives you the opportunity to generate a link to the review form on Springest. By sending additional information as JSON the review form will be pre-filled. The user landing on the page then only has to submit the review to Springest. 

JSON API information 
URL to call review request api
Headers{}Header information
Information should be shared in JSON format
The body contains the information needed to request information

Body information (POST)

ParametersDescriptionTypeFormatRequired / Optional
emailUser's emailString Required
first_nameUser's first nameString Required
last_nameUser's last nameString Required
job_titleUser's job titleStringOptional
descriptionReview descriptionStringOptional
ratingReview ratingint{1, .. ,10}Optional
training_id OR
Springest ID of the training OR 
ID shared in XML-feed with Springest
training_completed_atTraining's completion date for the userdate'yyyy-mm-dd'Optional
review_trainerTrainer's emailstringOptional


When you POST your data to our API we run some validations on our end and will only process the request when they pass. When they don't, we let you know. As such, there are a couple of possible responses:

  1. 201 Created 
  2. When the review request has been created succesfully. It will return the training_id and the URL to the review form on Springest.

  3. 400 Bad Request
  4. This will trigger when validation fails. The response will be JSON or XML (based on the url you are POSTing to) that looks like this. Most errors contain either absence of one of the mandatory fields or the training_id/External_ID is not currently a published training in the Springest database.

Was dit artikel nuttig?

Dat is fantastisch!

Hartelijk dank voor uw beoordeling

Sorry dat we u niet konden helpen

Hartelijk dank voor uw beoordeling

Laat ons weten hoe we dit artikel kunnen verbeteren!

Selecteer tenminste een van de redenen
CAPTCHA-verificatie is vereist.

Feedback verzonden

We stellen uw moeite op prijs en zullen proberen het artikel te verbeteren