Favoriting Clinicians

POST 
/api/v2/public/facilities/favoriting-clinician

Auto scheduler will prioritize favorited clinicians.

Request

application/json

Body

required

facilityId stringrequired

Facility ID

clinicianId stringrequired

Clinician ID

isFavorited booleanrequired

Favorite/Unfavorite a clinician

Responses

201

Empty Response

400

Bad request

application/json

Schema

Schema

message string[]

Error description

error string

The type of error

statusCode integer

Status code of the error

Example (from schema)

{
  "message": [
    "Property must be a string"
  ],
  "error": "Bad Request",
  "statusCode": 400
}

Request Validation

Request Validation Error

{
  "message": [
    "facilityId must be a string",
    "clinicianId must be a string",
    "isFavorited must be a boolean value"
  ],
  "error": "Bad Request",
  "statusCode": 400
}

401

Unauthorized

application/json

Schema

Schema

message string

Error description

statusCode integer

Status code of the error

Example (from schema)

{
  "message": "Unauthorized",
  "statusCode": 401
}

403

Forbidden

application/json

Schema

Schema

message string

Error description

error string

The type of error

statusCode integer

Status code of the error

Example (from schema)

{
  "message": "Forbidden Resource",
  "error": "Forbidden",
  "statusCode": 403
}

Clinician Blocked

Clinician is blocked

{
  "message": "Clinician is blocked",
  "error": "Forbidden",
  "statusCode": 403
}

404

Not Found

application/json

Schema

Schema

message string

Error description

error string

The type of error

statusCode integer

Status code of the error

Example (from schema)

{
  "message": "Not Found",
  "error": "Not Found",
  "statusCode": 404
}

Clinician Not Found

Clinician is no longer available for favoriting

{
  "message": "Clinician is no longer available for favoriting",
  "error": "Not Found",
  "statusCode": 404
}

Loading...