Get Attachments by Charge Capture External ID

Beta

GET

/api/encounter-attachments/v1/by-charge-capture-external-id/:charge_capture_external_id

GET

/api/encounter-attachments/v1/by-charge-capture-external-id/:charge_capture_external_id

1 from candid import CandidApiClient
2 
3 client = CandidApiClient()
4 
5 client.encounter_attachments.v_1.get_by_charge_capture_external_id(
6     charge_capture_external_id="charge_capture_external_id",
7 )

200Retrieved

1 [
2   {
3     "attachment_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
4     "attachment_type": "DOCUMENTATION",
5     "authed_url": "authed_url",
6     "content_type": "content_type",
7     "description": "description",
8     "file_name": "file_name"
9   },
10   {
11     "attachment_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
12     "attachment_type": "DOCUMENTATION",
13     "authed_url": "authed_url",
14     "content_type": "content_type",
15     "description": "description",
16     "file_name": "file_name"
17   }
18 ]

Returns all attachments associated with the given charge capture external ID.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Path parameters

charge_capture_external_idstringRequired

Response

This endpoint returns a list of objects.

attachment_idUUID

attachment_typeenum

Allowed values:

authed_urlstring

content_typestring

descriptionstring

file_namestring