Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Parameter

Type

Description

target_id

String

The id of the target which is related to the files

target_type

String

The file of the target which is related to the files. For now the possible values are 'user' and 'visit'

category_type

String

The category type of this file. For now the possible reasons are 'user_document', 'intake_attachment', 'user_consent', 'user_avatar'.

include_shared

Boolean true|false

Include this param will get all the files that tagged user_document and notes files that shared to the user.

Response

curl -X GET \ >
Code Block
languagejson
curl --location --request GET 'https://api-vclinic.vsee.iome/cc/ligeng/api_v3/files?target_id=3509362317820300&target_type=user' \
>   -H--header 'X-ApiTokenAccountCode: 4df5b2b7dec8a8c40e142e43c1825502vclinic' \
>   -H--header 'cacheX-controlApiToken: no-cachevclinic_api_key'
\{
>   -H 'content-type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW' \
>   -F target_id=350936 \
>   -F target_type=user


{ "data": [
        {
            "datacreated": [1657668358,
            "creator": {
            "id    "full_name": "5e1598e7-4118-47ca-84da-0923c71b6977",Patient's Name",
                "nametype": "55bb223fd7304.jpg"200,
                "sizeusername": 184259 "62ce09a2940adc6474"
            },
            "ext": "jpgpdf",
            "fullpath": "https:\/\/api-vclinic.vsee.io\/cc\/ligeng\me/files\/view\/5e1598e762ce0306-4118bd68-47ca8fj3-84da7771-0923c71b69776dfc0ks8219474?auth_code=ede418b2b0b1fa5451c726a7e6959b2efabcad97bb7e2d413f9jd93unf92u4e35584d10&time=15785300831669924552",
            "id": "62ce0306-bd68-8fj3-7771-6dfc0ks8219474",
            "creatoris_deletable": true,
            "meta": {
                "username"account": {
                    "code": "ligeng+trial14+member01@vseelab.com"vclinic"
                },
                "typecategory": 200"user_document",
                "full_name"target": {
                    "id": "Ligeng Long Long Long Long Long Long Long Long Long Long Long Long Long Long Long Name2317820300",
                    "type": "user"
                },
                "is_deletablevisible": false, // true if attachment type is user_document true
            },
            "name": "2017-01-21 04:00:00 - filename.pdf",
            "createdsize": 1578473704274988
        }
    ]
}

GET /files/:id

Retrieve file info

...