Namespaces

Projects

ovok.projects lists the projects the signed-in user administers and manages the current

  • Stable unknown
  • Release candidate since 0.1.0-rc.3
  • Development since 0.1.0-dev.21+c43ebba

ovok.projects lists the projects the signed-in user administers and manages the current project's members, features and settings.

List projects and members

Both lists return a Page; auto_paging_iter() walks every page.

from ovok_sdk import Ovok

ovok = Ovok("https://api.sandbox.ovok.com", "your-tenant")
for project in ovok.projects.list().auto_paging_iter():
    print(project["name"])

members = ovok.projects.members.list({"count": 50})

Manage members

ovok.projects.members.invite({"email": "nurse@example.com", "role": "practitioner"})
ovok.projects.members.update("membership-id", {"admin": True})
ovok.projects.members.remove("membership-id")

Change features and settings

settings.update() turns an on/off setting on or off; settings.update_text() sets or clears a text setting. features.update() replaces the whole feature list.

settings = ovok.projects.settings.retrieve()
ovok.projects.settings.update("patient-registration", True)
ovok.projects.settings.update_text("support-email", "support@example.com")

features = ovok.projects.features.retrieve()

API reference

See ovok_sdk.resources.platform for every method, parameter and error.

Last updated on

On this page