Page Comparison

Table of Contents

minLevel	1
maxLevel	7

GET /rooms [public access]
Status
colour Yellow
title v3

Parameters

Parameter	Type	Description

list_type

String

Return all rooms from a clinic


`page`	`Integer`	Page number for pagination
`limit`	`Integer`	Limit for pagination

Info
Rooms API supports DataTable API

...

Code Block

curl -k -X GET -H "X-AccountCode: vclinic" "https://api.vsee.me/api_v3/rooms"

{
    "data": [{
        "slug": "room1",
        "name": "Room 1",
        "domain": "demo.vsee.me",
        "code": "room1_code",
        "created": 1427922788,
        "modified": 1427922788
    }, ...]
}

POST /rooms
Status
colour Yellow
title v3

Parameters

Parameter	Type	Description
`X-ApiToken`	`Header`	Clinic Admin token (app token)
`domain`	`String`	Clinic’s domain
`code`	`String`	(optional) Room code (should be unique)
`slug`	`String`	(optional) Set this room as default, other rooms will lose default status.
`name`	`String`	Room's name

Response

Code Block

curl --location --request POST 'https://api.vsee.me/api_v3/rooms' \
--header 'X-AccountCode: vclinic' \
--header 'X-ApiToken: 83ec6843c3af534c551ab609d869dd82' \
--form 'domain=vclinic.vsee.me' \
--form 'slug=provider00102' \
--form 'name=provider00102 room'

{
    "data": {
        "visits": {
            "walkin": {
                "enabled": true
            },
            "appointment": {
                "enabled": false
            }
        },
        "auth": {
            "guest": {
                "type": 600,
                "log_in": {
                    "enabled": true
                }
            }
        },
        "subtitle": "If this is an emergency, please call 911.",
        "slug": "provider00102",
        "name": "provider00102 room",
        "domain": "vclinic.vsee.me",
        "active": true,
        "users": "85741",
        "account_code": "clinic",
        "provider_ids": [
            "85741"
        ],
        "public_access_room": true,
        "modified": 1605728974,
        "created": 1605728974,
        "payment": {
            "consultations": [
                {
                    "id": "5fb57ace-4808-4346-ad3c-3348925862c1",
                    "description": "15-min Consultation",
                    "duration": 15,
                    "amount": 0,
                    "group": false,
                    "charge": false,
                    "slots": 1
                }
            ],
            "currency": "USD",
            "__note__": "paymentCurrency will be deprecated by 1 Jun 2017"
        },
        "operation_settings": {
            "is_closed": false,
            "close_msg": "Service currently not available. Please check back later",
            "default_timezone": "America/Los_Angeles"
        },
        "id": "171",
        "code": "b4vjj"
    }
}

...

Code Block
{ "code": 400, "message": "In domain 'vclinic.vsee.me' slug 'uat2' already exists." }

GET /rooms/:code [public access]
Status
colour Yellow
title v3
Status
colour Green
title v4

This API is available in both api v3 and v4

Parameters

(none)

Response

Code Block

Expand

title	Response v3

Code Block


curl -k -X GET -H "X-AccountCode: vclinic" "https://api.vsee.me/api_v3/rooms/room1"

{
  "data": {
    "description": "",
    "specialties": [
      {
        "code": "general_care",
        "name": "Default",
        "duration": 15
      },
      {
        "code": "primary_care",
        "name": "Primary Care",
        "duration": 15
      },
      {
        "code": "psychiatry",
        "name": "Psychiatry",
        "duration": 30
      },
      {
        "code": "dermatology",
        "name": "Dermatology",
        "duration": 15
      }
    ],
    "modified": 1466796316,
    "created": 1446802721,
    "payment": {
      "paymentCurrency": "USD",
      "consultations": [
        {
          "description": "15-min Consultation",
          "amount": 0,
          "duration": 15
        },
        {
          "description": "30 min",
          "amount": 20,
          "duration": 30
        },
        {
          "description": "45 min",
          "amount": 40,
          "duration": 45
        }
      ]
    },
    "slug": "room1",
    "name": "Room 1",
    "domain": "demo.vsee.me",
    "code": "room1",
    "account_code": "DEMO-ACCOUNT",

}

GET /rooms/:code/providers [public access]

Response

Code Block

curl -k -X GET \ -H "X-AccountCode: vclinic" \ "https://api.vsee.me/api_v3/rooms/example-room-code/providers" { "data": [

  "operation_settings": {
        "close_message": {

{

id

html": "

401

,

"username": "provider-401",

 },
        "

code

close_msg": "",
        "

subtype

closed_days":

"482",

"first_name":

"Jarod",

last_name

saturday"

:

"Sun

401",

],

"vseeid":

"evisitdev+user401",

photo

default_timezone":

null,

"America/Los_Angeles",
        "

title

is_closed":

""

false,
        "

suffix

is_closed_now":

""

false,
        "

status

is_open_all_time": false,
        "

short

is_scheduled_

bio

closed": false,

}

] }

GET /rooms/:code/providers/:id [public access]

Response

Code Block

curl -k -X GET \ -H "X-AccountCode: vclinic" \ "https://api.vsee.me/api_v3/rooms/ceproom1/providers/826" { "data": {

 "open_hours": [
            {
                "

id

name": "

826

sunday_start_time",

"code":

"55de45a2ce384a24ad633301ac1f0144",

"first_name":

"John",

last_name

value": "

Will",

09:00 AM"

"username": "provider1"

},

"vseeid": "conciergedev+user826",

"email": "anton+provider1@vsee.com",

"active":

true,

"title":

"Dr.",

suffix

name": "

M.D.

sunday_end_time",

"tos": false,

phone

value": "

334

05:00

2222211

PM"

,

"subtype":

"482",

"status":

false

},

"educational_training":

"edu

and

training...",

"professional_interests":

"interests...",

"personal_interests":

"some

personal

hobby"

}

GET /rooms/:code/queue [public access]

Waiting time = average_visit_time * before_me

Response

Code Block

curl -X GET -H "X-AccountCode: vclinic" "https://api.vsee.me/api_v3/rooms/ceproom1/queue" { "data": {

"name": "monday_start_time",
                "

length

value":

10,

"09:00 AM"

"capacity":

100,

},
            {

"average_visit_time": 3600,

       "name": "monday_end_time",
                "

before_me

value":

3

"05:00 PM"

}

           },
            {
                "name": "tuesday_start_time",
                "value": "09:00 AM"
            },
            {
                "name": "tuesday_end_time",
                "value": "05:00 PM"
            },
            {
                "name": "wednesday_start_time",
                "value": "09:00 AM"
            },
            {
                "name": "wednesday_end_time",
                "value": "05:00 PM"
            },
            {
                "name": "thursday_start_time",
                "value": "09:00 AM"
            },
            {
                "name": "thursday_end_time",
                "value": "05:00 PM"
            },
            {
                "name": "friday_start_time",
                "value": "09:00 AM"
            },
            {
                "name": "friday_end_time",
                "value": "05:00 PM"
            },
            {
                "name": "saturday_start_time",
                "value": "09:00 AM"
            },
            {
                "name": "saturday_end_time",
                "value": "05:00 PM"
            }
        ],
        "operating_hours": "09:00 AM - 05:00 PM",
        "operating_schedule": [
            {
                "day_of_week": "Sunday",
                "is_closed": false,
                "schedule": "09:00 AM - 05:00 PM"
            },
            {
                "day_of_week": "Monday",
                "is_closed": false,
                "schedule": "09:00 AM - 05:00 PM"
            },
            {
                "day_of_week": "Tuesday",
                "is_closed": false,
                "schedule": "09:00 AM - 05:00 PM"
            },
            {
                "day_of_week": "Wednesday",
                "is_closed": false,
                "schedule": "09:00 AM - 05:00 PM"
            },
            {
                "day_of_week": "Thursday",
                "is_closed": false,
                "schedule": "09:00 AM - 05:00 PM"
            },
            {
                "day_of_week": "Friday",
                "is_closed": false,
                "schedule": "09:00 AM - 05:00 PM"
            },
            {
                "day_of_week": "Saturday",
                "is_closed": true,
                "schedule": "Closed for walk-in visits"
            }
        ],
        "operating_status": "Open now",
        "status": "open",
        "timezone": "America/Los_Angeles"
    }
}

Expand

title	Response v4

Code Block

https://api-ms.vsee.me/api/rooms/:code

200 OK

{
  "data": {
    "visits": {
      "walkin": {
        "enabled": true
      },
      "appointment": {
        "enabled": false,
        "users": {
          "provider": []
        },
        "create_slot": {
          "enabled": false
        }
      },
      "follow_clinic": true
    },
    "payment": {
      "paymentCurrency": "USD",
      "consultations": [
        {
          "id": "5e31e5d1-8910-4a5b-849a-22c8925860a2",
          "description": "15-min Consultation",
          "duration": 15,
          "amount": 0,
          "group": false,
          "charge": false,
          "slots": 1,
          "visible_to_patient": true
        }
      ],
      "currency": "USD",
      "__note__": "paymentCurrency will be deprecated by 1 Jun 2017"
    },
    "visible": false,
    "deep_link_disabled": false,
    "one_time_use": false,
    "active": true,
    "public_access_room": true,
    "operation_settings": {
      "timezone": "America/Los_Angeles",
      "status": "open",
      "open_hours": [
        {
          "name": "sunday_start_time",
          "value": "08:00 AM"
        },
        ...
      ],
      "closed_days": [],
      "close_message": {
        "html": "Operating hours are 7am-6pm PST Monday through Friday, 7am-5pm PST Saturdays, and 8am-1pm PST Sundays.  You have reached the approval network after hours. Should you require assistance please call us at 619-326-3646 during normal business hours."
      },
      "close_msg": "Operating hours are 7am-6pm PST Monday through Friday, 7am-5pm PST Saturdays, and 8am-1pm PST Sundays.  You have reached the approval network after hours. Should you require assistance please call us at 619-326-3646 during normal business hours.",
      "is_open_all_time": false,
      "is_closed_now": false,
      "is_closed": true,
      "is_scheduled_closed": true,
      "operating_status": "Closed for walk-in visits",
      "operating_hours": "Opens tomorrow at 06:00 AM - 06:00 PM",
      "operating_schedule": [
        {
          "day_of_week": "Sunday",
          "is_closed": false,
          "schedule": "08:00 AM - 01:00 PM"
        },
        ...
      ],
      "default_timezone": "America/Los_Angeles"
    },
    "code": "xxx",
    "room_id": 222,
    "slug": "room_slug",
    "name": "Testing",
    "domain": "clinic.vsee.me",
    "account_code": "vclinic",
    "modified": 1714364864,
    "created": 1580328401,
    "provider_ids": [
      "200045",
      ...
      "195781"
    ],
    "listed_clinic_directory": false,
    "id": "24315",
    "description": ""
  }
}

GET /rooms/:code/providers [public access]
Status
colour Yellow
title v3

Response

Code Block

curl -k -X GET \
  -H "X-AccountCode: vclinic" \
  "https://api.vsee.me/api_v3/rooms/example-room-code/providers"

{
  "data": [
    {
      "id": "401",
      "username": "provider-401",
      "code": "",
      "subtype": "482",
      "first_name": "Jarod",
      "last_name": "Sun 401",
      "vseeid": "evisitdev+user401",
      "photo": null,
      "title": "",
      "suffix": "",
      "status": false,
      "short_bio": false
    }
  ]
}

GET /rooms/:code/providers/:id [public access]
Status
colour Yellow
title v3

Response

Code Block


curl -k -X GET \
  -H "X-AccountCode: vclinic" \
  "https://api.vsee.me/api_v3/rooms/ceproom1/providers/826"

{
  "data": {
    "id": "826",
    "code": "55de45a2ce384a24ad633301ac1f0144",
    "first_name": "John",
    "last_name": "Will",
    "username": "provider1",
    "vseeid": "conciergedev+user826",
    "email": "anton+provider1@vsee.com",
    "active": true,
    "title": "Dr.",
    "suffix": "M.D.",
    "tos": false,
    "phone": "334 2222211",
    "subtype": "482",
    "status": false,
    "educational_training": "edu and training...",
    "professional_interests": "interests...",
    "personal_interests": "some personal hobby",
    "short_bio": "...",
  }
}

GET /rooms/:code/queue [public access]
Status
colour Yellow
title v3

Waiting time = average_visit_time * before_me

Response

Code Block
curl -X GET -H "X-AccountCode: vclinic" "https://api.vsee.me/api_v3/rooms/ceproom1/queue" { "data": { "length": 10, "capacity": 100, "average_visit_time": 3600, "before_me": 3 } }

length - total current queue length
capacity- maximum possible queue length
average_visit_time - time in seconds per patient
before_me - patient in the queue before me

POST /users/:id/rooms
Status
colour Yellow
title v3

Associate a room to a user

Parameters

Parameter	Type	Description
`code`	`String`	Room code
`default`	`Boolean`	(optional) Set this room as default, other rooms will lose default status.

Response

Code Block

curl --location --request POST 'https://api.vsee.me/api_v3/users/85741/rooms' \
--header 'X-AccountCode: vclinic' \
--header 'X-ApiToken: 83ec6843c3af534c551ab609d869dd82' \
--form 'code=b4vjj''

{
    "data": [
        {
            "_id": "171",
            "slug": "provider00102",
            "name": "provider00102 room",
            "domain": "clinic.vseepreview.com",
            "code": "b4vjj",
            "active": true,
            "users": "85741",
            "account_code": "clinic",
            "provider_ids": [
                "85741"
            ],
            "public_access_room": true,
            "modified": {
                "sec": 1605728974,
                "usec": 177000
            },
            "created": {
                "sec": 1605728974,
                "usec": 177000
            },
            "payment": {
                "consultations": [
                    {
                        "id": "5fb57ace-4808-4346-ad3c-3348925862c1",
                        "description": "15-min Consultation",
                        "duration": 15,
                        "amountamount": 0,
                        "group": 0false,
                        "groupcharge": false,
                        "chargeslots": false, 1
                    }
       "slots": 1        ]
            },
            "default": false
  ]      }
      },
            "default": false
        }
    ]]
}

DELETE /users/:id/rooms/:room_code
Status
colour Yellow
title v3

Remove a room association with a user

Parameters

Parameter	Type	Description
`code`	`String`	Room code

Response

Code Block


curl --location --request DELETE 'https://api.vsee.me/api_v3/users/85741/rooms/b4vjj' \
--header 'X-AccountCode: vclinic' \
--header 'X-ApiToken: 83ec6843c3af534c551ab609d869dd82' \
--form 'code=b4vjj''

{
    
}

Versions Compared

Old Version 6

New Version Current

Key

GET /rooms [public access]
Status
colour Yellow
title v3

POST /rooms
Status
colour Yellow
title v3

GET /rooms/:code [public access]
Status
colour Yellow
title v3
Status
colour Green
title v4

GET /rooms/:code/providers [public access]

GET /rooms/:code/providers/:id [public access]

GET /rooms/:code/queue [public access]

GET /rooms/:code/providers [public access]
Status
colour Yellow
title v3

GET /rooms/:code/providers/:id [public access]
Status
colour Yellow
title v3

GET /rooms/:code/queue [public access]
Status
colour Yellow
title v3

POST /users/:id/rooms
Status
colour Yellow
title v3

DELETE /users/:id/rooms/:room_code
Status
colour Yellow
title v3

Page Comparison

Versions Compared

Old Version 6

New Version Current

Key

GET /rooms [public access] StatuscolourYellowtitlev3

POST /rooms StatuscolourYellowtitlev3

GET /rooms/:code [public access] StatuscolourYellowtitlev3 StatuscolourGreentitlev4

GET /rooms/:code/providers [public access]

GET /rooms/:code/providers/:id [public access]

GET /rooms/:code/queue [public access]

GET /rooms/:code/providers [public access] StatuscolourYellowtitlev3

GET /rooms/:code/providers/:id [public access] StatuscolourYellowtitlev3

GET /rooms/:code/queue [public access] StatuscolourYellowtitlev3

POST /users/:id/rooms StatuscolourYellowtitlev3

DELETE /users/:id/rooms/:room_code StatuscolourYellowtitlev3

GET /rooms [public access]
Status
colour Yellow
title v3

POST /rooms
Status
colour Yellow
title v3

GET /rooms/:code [public access]
Status
colour Yellow
title v3
Status
colour Green
title v4

GET /rooms/:code/providers [public access]
Status
colour Yellow
title v3

GET /rooms/:code/providers/:id [public access]
Status
colour Yellow
title v3

GET /rooms/:code/queue [public access]
Status
colour Yellow
title v3

POST /users/:id/rooms
Status
colour Yellow
title v3

DELETE /users/:id/rooms/:room_code
Status
colour Yellow
title v3