Download Clinician Document attachment

GET 
/api/v2/public/clinicians/:clinicianId/documents/attachment/:attachmentId

General Information

This endpoint allows you to download a specific attachment file associated with a clinician's document.

Required Parameters

• clinicianId (path parameter): The unique identifier of the clinician
• attachmentId (path parameter): The unique identifier of the specific attachment to download

File Handling

• Files are streamed directly to the client for immediate download

Request

Path Parameters

clinicianId stringrequired
Clinician ID
Example: I7002epLHLhBCypdPCrn9XP4kTN2
attachmentId stringrequired

Id of the attachment

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": [
    "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...