JOjoincandidhealth
v1

Get Multi

Changed on

Searches for images that match the query parameters.

get/images/v1

Request

  • Base URL
    https://pre-api.joincandidhealth.com
  • URL
    https://pre-api.joincandidhealth.com/images/v1
  • Auth
    HTTP bearer

Query parameters

patient_idstring
coverage_idstring
file_typestring
patient_notesstring
sort_field'updatedAt' | 'fileName' | 'displayName' | 'fileType' | 'status'

The field to order by. Defaults to updatedAt.

sort_direction'asc' | 'desc'

The direction to order by. Defaults to desc.

Response

Response with status 200

organization_idstring required

The unique identifier for an Organization in the database

deactivatedboolean required

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

versioninteger required

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

updated_atstring date-time required
updating_user_idstring required

The unique identifier for a User in the database

file_namestring required
display_namestring required
file_typestring required
status'PENDING' | 'UPLOADED' | 'FAILED' required
idstring required

The unique identifier for an Image

signed_urlstring required

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

Changes

  • 24b2d80d577aRevision changes
    • breaking

      the query request parameter sort_direction was restricted to a list of enum values

    • breaking

      the query request parameter sort_field was restricted to a list of enum values

    • breaking

      the response's property type changed from no type to object for status

    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security OAuthScheme was added to the API

    • info

      added the new enum value asc to the query request parameter sort_direction

    • info

      added the new enum value desc to the query request parameter sort_direction

    • info

      added the new enum value displayName to the query request parameter sort_field

    • info

      added the new enum value fileName to the query request parameter sort_field

    • info

      added the new enum value fileType to the query request parameter sort_field

    • info

      added the new enum value status to the query request parameter sort_field

    • info

      added the new enum value updatedAt to the query request parameter sort_field

    • info

      for the query request parameter sort_direction, the type was generalized from no type to string

    • info

      for the query request parameter sort_field, the type was generalized from no type to string

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

  • 3a81ee81d4edRevision changes
    • info

      api operation id getMulti removed and replaced with v1_getMulti