Welcome to OpenSpecimenAPIConnector’s documentation!

OSAPIConnector Documentation

• Installation
  • Jupyter Demos
  • Integration Testing

Getting Started

• Getting Started
  • Installing the Package
  • Importing the Package
  • Configuring the URL and Login
  • Creating an Institute
  • Creating a Site
  • Creating a Collection Protocol
  • Creating a Registration
  • Creating a Specimen together with a Visit

OSAPIConnector Modules

• OpenSpecimenAPIconnector package
  • Subpackages
    • OpenSpecimenAPIconnector.mg_core package
      • Submodules
      • OpenSpecimenAPIconnector.mg_core.mappings module
      • Module contents
    • OpenSpecimenAPIconnector.mg_util package
      • Submodules
      • OpenSpecimenAPIconnector.mg_util.OpenSpecimenBBMRImapping module
      • Module contents
    • OpenSpecimenAPIconnector.os_core package
      • Submodules
      • OpenSpecimenAPIconnector.os_core.collection_protocol module
      • OpenSpecimenAPIconnector.os_core.collection_protocol_event module
      • OpenSpecimenAPIconnector.os_core.collection_protocol_registration module
      • OpenSpecimenAPIconnector.os_core.container module
      • OpenSpecimenAPIconnector.os_core.csv_bulk module
      • OpenSpecimenAPIconnector.os_core.csv_export module
      • OpenSpecimenAPIconnector.os_core.institute module
      • OpenSpecimenAPIconnector.os_core.jsons module
      • OpenSpecimenAPIconnector.os_core.mandatory module
      • OpenSpecimenAPIconnector.os_core.participant module
      • OpenSpecimenAPIconnector.os_core.query module
      • OpenSpecimenAPIconnector.os_core.req_util module
      • OpenSpecimenAPIconnector.os_core.site module
      • OpenSpecimenAPIconnector.os_core.specimen module
      • OpenSpecimenAPIconnector.os_core.url module
      • OpenSpecimenAPIconnector.os_core.users module
      • OpenSpecimenAPIconnector.os_core.visit module
      • Module contents
    • OpenSpecimenAPIconnector.os_util package
      • Submodules
      • OpenSpecimenAPIconnector.os_util.aggregated_fields module
      • OpenSpecimenAPIconnector.os_util.bulk_operations module
      • OpenSpecimenAPIconnector.os_util.collection_protocol_util module
      • OpenSpecimenAPIconnector.os_util.container_util module
      • OpenSpecimenAPIconnector.os_util.cpevent_util module
      • OpenSpecimenAPIconnector.os_util.cpr_util module
      • OpenSpecimenAPIconnector.os_util.csv_exp_util module
      • OpenSpecimenAPIconnector.os_util.institute_util module
      • OpenSpecimenAPIconnector.os_util.query_util module
      • OpenSpecimenAPIconnector.os_util.site_util module
      • OpenSpecimenAPIconnector.os_util.specimen_util module
      • OpenSpecimenAPIconnector.os_util.users_util module
      • OpenSpecimenAPIconnector.os_util.visit_util module
      • Module contents
  • Submodules
  • OpenSpecimenAPIconnector.config module
  • Module contents

Indices and tables

• Index

• Module Index

• Search Page

Links

• Documentation of OpenSpecimen

• GitHub of the Project

• GitHub for Docker-Version of OpenSpecimen