Study

Get Studies of Project

GET https://your.host.vinlab/projects/:project_id/studies

/studies?_offset=0&_limit=25&project_id=d4702175-0403-48e5-bbba-e98716722d4d

Path Parameters

Name	Type	Description
_offset	int32
_limit	int32
_sort	string
status	string

200

{
    "error_code": 0,
    "error_message": "OK",
    "server_time": 1637652047,
    "count": 1,
    "data": [
        {
            "id": "949f28e2-bbe4-4478-8cbf-79be2e52187d",
            "modified": 1637149122,
            "created": 1637149122,
            "creator_username":"test",
            "code": "TP1-3",
            "status": "ASSIGNED",
            "project_id": "122d7cfb-40fd-48d9-9de7-ba9309ef2e0c",
            "study_index": "aaaa",
            "study_info": {
                "data_types": [
                    "DICOM"
                ],
                "series": [
                    {
                        "series_index": "aaaa",
                        "instances": 1
                    }
                ],
                "instances": 1
            }
        }
    ]
}

Upload new Study

POST https://your.host.vinlab/projects/:project_id/studies

Request Body

Name	Type	Description
file*	file	Multipart form data

200

{
  "error_code": 0,
  "error_message": "OK",
  "server_time": 1637652047,
  "data": {
    "id": "949f28e2-bbe4-4478-8cbf-79be2e52187d"
  }
}

Get Study detail

GET https://your.host.vinlab/projects/:project_id/studies/:study_id/info

200

{
    "error_code": 0,
    "error_message": "OK",
    "server_time": 1637652369,
    "data": {
        "id": "886922b1-9a89-4f48-b874-8b017e8d3dbe",
        "modified": 1637220897,
        "created": 1637207625,
        "creator_username":"test",
        "code": "TP1-6",
        "status": "REVIEWING",
        "project_id": "122d7cfb-40fd-48d9-9de7-ba9309ef2e0c",
        "study_index": "8276396141594019647"
    }
}

Mark a Study in Reviewing status

PUT https://your.host.vinlab/projects/:project_id/studies/:study_id/mark-seen

200

{
    "error_code": 0,
    "error_message": "OK",
    "server_time": 1637652369,
    "data": {
        "id": "886922b1-9a89-4f48-b874-8b017e8d3dbe",
        "modified": 1637220897,
        "created": 1637207625,
        "creator_username":"test",
        "code": "TP1-6",
        "status": "REVIEWING",
        "project_id": "122d7cfb-40fd-48d9-9de7-ba9309ef2e0c",
        "study_index": "8276396141594019647"
    }
}

Delete Studies of Project by IDs

POST https://your.host.vinlab/projects/:project_id/studies/delete-many

200

{
    "error_code": 0,
    "error_message": "OK",
    "server_time": 1637652047,
    "data": "949f28e2-bbe4-4478-8cbf-79be2e52187d"
}

// Input sample
{
    ids: [
        "1",
        "2"
    ]
}