Edit an album - OsiriX-Foundation/KheopsAuthorization GitHub Wiki

Used to edit an album (only for an admin).

URL : /albums/{album_id}

Method : PATCH

Auth Required : Authorization with a JWT Bearer token with the user as the sub claim.

Headers

• Accept : If present, require that this value be application/json
• Content-Type : Must be application/x-www-form-urlencoded

Parameters

• name={name} (Optional)
• description={description} (Optional)
• addUser={true/false} (Optional)
• downloadSeries={true/false} (Optional)
• sendSeries={true/false} (Optional)
• deleteSeries={true/false} (Optional)
• addSeries={true/false} (Optional)
• writeComments={true/false} (Optional)
• notificationNewSeries={true/false} (Optional)
• notificationNewComment={true/false} (Optional)

Success Response

• Status : 200 OK

{
    "album_id": "37bs6GW5cR",
    "name": "album name",
    "description": "some description",
    "created_time": "2018-09-21T11:50:23",
    "last_event_time": "2018-09-21T11:50:23",
    "number_of_users": 1,
    "number_of_comments": 0,
    "number_of_studies": 0,
    "add_user": false,
    "download_series": true,
    "send_series": true,
    "delete_series": false,
    "add_series": true,
    "write_comments": true,
    "is_favorite": false,
    "notification_new_series": true,
    "notification_new_comment": true,
    "is_admin": true
}

Error Response

If the calling user is not an admin.

• Status : 403 Forbidden

If the user is not found. If the album id does not exist. If the user is not a member of the album.

• Status : 404 Not Found