Get Clinician Document attachments

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

General Information

This endpoint retrieves all file attachments associated with a specific clinician document.

Required Parameters

• clinicianId (path parameter): The unique identifier of the clinician
• category (path parameter): The document category (LICENSE, CREDENTIAL, BACKGROUND_CHECK, SSN, CDPH_530)
• documentId (path parameter): The unique identifier of the specific document

Access Control

• The implementation logic requires that a clinician has submitted a shift request to a facility that the facility user is connected to. This requirement is in place to prevent the unauthorized sharing of documentation for users who have not interacted with one of your shifts

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[]
Array [
attachmentId stringrequired
Id of the attachment
attachmentUrl stringrequired
Url of the attachment
]

Example (from schema)

{
  "data": [
    {
      "attachmentId": "123",
      "attachmentUrl": "https://example.com/attachment1.pdf"
    }
  ]
}

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...