POST resource/add-readers
Sets the readers of the resuorce
Request Information
Headers
HTTP_AUTHORIZATION: Required. OAuth 1.0 parameters with the OAuth signature of the url you are going to request. The consumer keys and access token can be obtained from the community administration.
Sample:HTTP_AUTHORIZATION: OAuth oauth_token="CObXqjfOisVh9%2F2GjC7NNd8BCzY%3D", oauth_consumer_key="clGACsiGaMp%2FD%2BUwkSvRBxA1k50%3D", oauth_nonce="VqKza6d5x1HpPQWFe08spbdOnkTQpfaLfD9Oeuyg", oauth_signature_method="HMAC-SHA1", oauth_timestamp="1462882011", oauth_signature="RH5aKKKJaEvK5cIsZZzXtFh7cCk%3D"
Body Parameters
Name | Description | Type | Additional information |
---|---|---|---|
resource_id |
Resource identificator |
globally unique identifier |
Required |
community_short_name |
Community short name |
string |
Required |
visibility |
Visibility of the resurce enumeration |
integer |
Required |
readers_list |
Users short names of the resource editors or readers |
Collection of ReaderEditor |
Required |
publish_home |
True if the resource must be published in the home of the community (by default false) |
boolean |
Optional |
Request Formats
application/json, text/json
Sample:
{ "resource_id": "dda4a08a-6a33-40fe-be0e-edadfd27e514", "community_short_name": "developers", "visibility": 1, "readers_list": [ { "user_id": "00000000-0000-0000-0000-000000000000", "user_short_name": "john-vander-var" }, { "user_id": "00000000-0000-0000-0000-000000000000", "group_short_name": "administrators" }, { "user_id": "00000000-0000-0000-0000-000000000000", "group_short_name": "developers", "organization_short_name": "gnossteam" } ], "publish_home": false }
Response Information
Response HTTP status code
On success, the response contains 200 code.
On fail, throws a WebException with code:
- 401 Unauthorized if the OAuth signature is invalid
- 400 Bad Request if the params are invalid
- 500 Internal server error if something goes wrong...