Versions Compared

Old Version 15

changes.mady.by.user Anton Tolkachiov

Saved on

compared with

New Version 16

changes.mady.by.user An Nguyen

Saved on

Key

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

...

Parameter

Location

Type

Description

X-AccountCode

Header

Header

If the app knows the account code, it should pass it in this header for every request. Otherwise leave blank

X-ApiToken

Header

Header

Once the user logs in, the app gets the token and should pass it for every request.

user_id

URL

String

Wherever there’s user’s :id field in API methods, it will also accept dash (-) as a mapping to the current user.

API Errors

VSee Clinic API use standard HTTP response status codes

Code

Meaning

Response example

1

200

Success

Code Block
{
  data: {
    // actual payload
  }
}
2

400

Bad Request

Code Block
{
  code: 404,
  message: "Sorry, this page is not available."
}
3

401

Unauthorized

4

403

Forbidden

5

404

Not Found

6

429

Too Many Requests

7

500

Internal Server Error

8

502

Bad Gateway

9

503

Service Unavailable

10

504

Gateway Timeout

API Objects

User Object

(To be completed soon)

...