SG Developers Get test results
Purpose
This API endpoint provides the test results for an invitationId with an assessment partner.
The URL can be configured by softgarden but needs to be provided in the configuration process.
HTTP-Method
GET
Path
3rd party provider path /{invitationId}
Authentification
Bearer Token
Example curl call
|
1 2 |
curl --location --request GET '[3rd party api endpoint for single results]/some-invitation-id' \ --header 'Authorization: Bearer [token]' |
Expected response:
|
1 2 3 4 5 6 7 8 9 10 11 |
{ "status": "COMPLETED", "completionTime": "2021-03-26T10:00:00Z", "expirationTime": "2021-03-27T10:00:00Z", "result": { "resultUrl": "https://some-provider.de/some-result-link", "reportUrl": "https://some-provider.de/some-report-link", "shareUrl": "https://some-provider.de/some-public-sharing-link", "score": "300" } } |
Propertylist
| Property | Type | Description |
| status (*) | string | The status of the assessment Supported Values – COMPLETED – EXPIRED – PENDING |
| completionTime | string | date string in ISO-8601 format UTC based required if the status COMPLETED is returned |
| expirationTime | string | date string in ISO-8601 format UTC based required if the status EXPIRED is returned |
| result (*) | object | |
| – resultUrl (*) | string | An url where the assessment results can be viewed |
| – reportUrl | string | An url to an online available pdf report |
| – shareUrl | string | An url that can be shared without login (e.g. for sharing results with colleagues) |
| – score | string | A string containing e.g. a numerical score to be displayed in softgarden. |
| (*) field is required and need to be set |