Get Multi | Candid | API Reference

1 from candid import CandidApiClient 2 3 client = CandidApiClient( 4 client_id="YOUR_CLIENT_ID", 5 client_secret="YOUR_CLIENT_SECRET", 6 ) 7 client.pre_encounter.images.v_1.get_multi()

1 [ 2 { 3 "deactivated": true, 4 "display_name": "display_name", 5 "file_name": "file_name", 6 "file_type": "file_type", 7 "id": "id", 8 "organization_id": "organization_id", 9 "signed_url": "signed_url", 10 "status": "PENDING", 11 "updated_at": "2024-01-15T09:30:00Z", 12 "updating_user_id": "updating_user_id", 13 "version": 1, 14 "coverage": { 15 "id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", 16 "side": "FRONT" 17 }, 18 "patient": { 19 "id": "id", 20 "notes": "notes" 21 } 22 }, 23 { 24 "deactivated": true, 25 "display_name": "display_name", 26 "file_name": "file_name", 27 "file_type": "file_type", 28 "id": "id", 29 "organization_id": "organization_id", 30 "signed_url": "signed_url", 31 "status": "PENDING", 32 "updated_at": "2024-01-15T09:30:00Z", 33 "updating_user_id": "updating_user_id", 34 "version": 1, 35 "coverage": { 36 "id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", 37 "side": "FRONT" 38 }, 39 "patient": { 40 "id": "id", 41 "notes": "notes" 42 } 43 } 44 ]

Searches for images that match the query parameters.

Query parameters

patient_idstringOptional

coverage_idstringOptional

Response

This endpoint returns a list of objects.

deactivatedboolean

True if the object is deactivated. Deactivated objects are not returned in search results but are returned in all other endpoints including scan.

display_namestring

file_namestring

file_typestring

idstring

The unique identifier for an Image

organization_idstring

The organization that owns this object.

signed_urlstring

A signed URL to the image. This url can be used to upload an image to GCP storage or to read the image contents.

statusenum

Allowed values:

updated_atdatetime

updating_user_idstring

The user ID of the user who last updated the object.

versioninteger

The version of the object. Any update to any property of an object object will create a new version.

coverageobject or null

An association to a Coverage.

patientobject or null

An association to a Patient.

Headers

Query parameters

Response