trust_api.routers.schemas
=========================

.. py:module:: trust_api.routers.schemas


Classes
-------

.. autoapisummary::

   trust_api.routers.schemas.CohortQueryInput
   trust_api.routers.schemas.CentralHubUser
   trust_api.routers.schemas.CentralHubProject
   trust_api.routers.schemas.DeleteImagingInput
   trust_api.routers.schemas.GetImagingStatusInput
   trust_api.routers.schemas.ReimportStudiesInput
   trust_api.routers.schemas.UpdateProfileRequest


Module Contents
---------------

.. py:class:: CohortQueryInput

   Bases: :py:obj:`pydantic.BaseModel`


   Represents the input for a cohort query.


   .. py:attribute:: encrypted_project_id
      :type:  str


   .. py:attribute:: query_id
      :type:  str


   .. py:attribute:: query_name
      :type:  str


   .. py:attribute:: query
      :type:  str


   .. py:attribute:: trust_id
      :type:  str


.. py:class:: CentralHubUser

   Bases: :py:obj:`pydantic.BaseModel`


   Represents a user on the central hub.


   .. py:attribute:: id
      :type:  uuid.UUID


   .. py:attribute:: email
      :type:  pydantic.EmailStr


   .. py:attribute:: is_disabled
      :type:  bool
      :value: False



.. py:class:: CentralHubProject

   Bases: :py:obj:`pydantic.BaseModel`


   Represents a project on the central hub from which an imaging project is created on XNAT.


   .. py:attribute:: project_id
      :type:  uuid.UUID


   .. py:attribute:: trust_id
      :type:  uuid.UUID


   .. py:attribute:: project_name
      :type:  str


   .. py:attribute:: query
      :type:  str | None
      :value: None



   .. py:attribute:: users
      :type:  list[CentralHubUser]
      :value: []



   .. py:attribute:: dicom_to_nifti
      :type:  bool
      :value: True



.. py:class:: DeleteImagingInput

   Bases: :py:obj:`pydantic.BaseModel`


   Input for deleting an imaging project.


   .. py:attribute:: imaging_project_id
      :type:  str


.. py:class:: GetImagingStatusInput

   Bases: :py:obj:`pydantic.BaseModel`


   Input for retrieving imaging project status.


   .. py:attribute:: imaging_project_id
      :type:  str


   .. py:attribute:: encoded_query
      :type:  str


.. py:class:: ReimportStudiesInput

   Bases: :py:obj:`pydantic.BaseModel`


   Input for reimporting imaging studies.


   .. py:attribute:: imaging_project_id
      :type:  str


   .. py:attribute:: encoded_query
      :type:  str


.. py:class:: UpdateProfileRequest

   Bases: :py:obj:`pydantic.BaseModel`


   Request body for updating a user's profile.


   .. py:attribute:: email
      :type:  pydantic.EmailStr


   .. py:attribute:: enabled
      :type:  bool