Add users - Sharing
PUT /assessment/{externalId}/sharing
Header
| Name | Data Type | Description |
|---|---|---|
| Content-type: | application/json | for all requests |
| Authorization: | EAPI {token} | for all requests |
Body Parameters
Parameters indicated with a * are mandatory
| Name | Data Type |
Description |
|---|---|---|
| *[].UserName | String) | UserName |
| *[].Role | String | User’s role (Name of role from Assessment Roles) |
Sample Request URL
https://api.cirrusplatform.com/api/v1/integrations/assessment/ColExt1/sharing
Sample Request
[{
"userName": "user1",
"role": "author"
},
{
"userName": "user2",
"role": "author"
}]
Sample Response
{
"Content": {
"SuccessfullyShared": ["user1"],
"Errors": [{
"UserName": "user2",
"Error": "Assessment has already been shared with this user!"
},
{
"UserName": "user3",
"Error": "Assessment has already been shared with this user!"
}]
},
"Success": true,
"Errors": null
}
Response codes
| Code | Description |
|---|---|
| 200 | Successful operation |
| 403 | Not allowed to use external API |
| 400 | Possible error codes: Assessment hasn't been found by external id externalId List of sharing users are not specified |
| 500 | Internal server error |