Get Clinician Document attachments

GET 
/api/v2/public/clinicians/:clinicianId/documents/:category/:documentId

Error: ENOENT: no such file or directory, open '/app/dist/apps/public-api/v2/clinicians/docs/get-document-attachments.md'

Request

Path Parameters

clinicianId stringrequired
Clinician ID
Example: I7002epLHLhBCypdPCrn9XP4kTN2
category stringrequired
Possible values: [background-check, credential, license, ssn, cdph-530]
Category of the document
Example: license
documentId stringrequired

Id of the document

Responses

201

application/json

Schema

Schema

data object

clinicianId stringrequired

Id of the clinician

firstName stringrequired

First name of the clinician

lastName stringrequired

Last name of the clinician

contactEmail stringrequired

Email of the clinician

contactPhone stringrequired

Contact phone of the clinician

licenseType Arrayrequired

List of valid license types of the clinician

Example (from schema)

{
  "data": {
    "clinicianId": "gpMEmsoXfWVmhXJIvXipPjo0dc43",
    "firstName": "John",
    "lastName": "Doe",
    "contactEmail": "john@doe.com",
    "contactPhone": "+12345678910",
    "licenseType": [
      "RN",
      "CNA"
    ]
  }
}

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": [
    "shiftId must be a string"
  ],
  "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
}

Loading...