Get an Album - OsiriX-Foundation/KheopsAuthorization GitHub Wiki

Used to get a specific album

URL : /albums/{album_id}

Method : GET

Auth Required : Authorization with a JWT Bearer token with the user as the sub claim. The user must be an admin or an user of the {album_id}.

Headers

• Accept : If present, require that this value be application/json

URL Parameters

• includeUsers={true/false} by default : false

Success Response

• Status : 200 OK

If includeUsers={true}

{
    "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,
    "users": [
        {
            "email": "[email protected]",
            "last_name": "user1 last name",
            "first_name": "user1 first name",
            "sub": "c2fd0b66-dac4-4b98-9341-d4f3b303bd4e",
            "is_admin": true
        },
        {
            "email": "[email protected]",
            "last_name": "user2 last name",
            "first_name": "user2 first name",
            "sub": "baa88921-db53-4a59-80d3-7853da25e7f0",
            "is_admin": false
        }
    ],
    "modalities" : ["CT","MR"],
    "number_of_comments": 0,
    "number_of_studies": 0,
    "number_of_series": 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
}

If includeUsers={false}

{
    "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,
    "modalities" : ["CT","MR"],
    "number_of_comments": 0,
    "number_of_studies": 0,
    "number_of_series": 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
}

If authorization is an album capability token

{
    "album_id": "37bs6GW5cR",
    "name": "album name",
    "description": "some description",
    "modalities" : ["CT","MR"],
    "number_of_studies": 3,
    "number_of_series": 7,
    "number_of_instances": 67
}

Error Response

If Queries Parameters are incorrect.

• Status : 400 Bad Request

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

If includeUsers={true} and the user can't see the users list

• Status : 403 Forbidden