SG Developers Notification about update
Purpose
This API endpoint provides the functionality that an assessment partner can inform softgarden about an update, e.g. in the case of test completion. Softgarden will then call the assessment partner’s API to receive the newest test results for an invitationId.
The required public basic authentication will be communicated in the configuration process.
HTTP-Method
POST
Path
will be transmitted in the invite request as property callback
Authentification
Basic Authorization (with public oAuth client as described here)
Request-Body
|
1 2 3 |
{ "invitationId": "some-invitation-id" } |
Propertylist
| Property | Type | Description |
| invitationId | string | 3rd party invitation id |
Example curl call
|
1 2 3 4 5 6 |
curl --location --request POST 'https://app.softgarden.io/api/rest/v3/frontend/assessmentProvider/invitationRequiresUpdate' \ --header 'Authorization: Basic [base64BasicAuthString]' \ --header 'Content-Type: application/json' \ --data-raw '{ "invitationId": "some-invitation-id" }' |
Response codes:
| Code | Meaning |
| 204 | Request was handled successfully |
| 400 | The invitation id was not provided in the body |
| 401 | Wrong credentials for invitation id |
| 500 | Server error occured |