family_api package

Subpackages

• family_api.tests package
  • Submodules
  • family_api.tests.test_family_api module
    • test_family_api_permissions()
    • test_family_details_view()
    • test_family_details_view_nonexistent()
    • test_full_family_details_view()
    • test_full_study_families_view()
    • test_list_families_view()
    • test_list_families_view_nonexistent()
    • test_list_families_view_tag_filter()
    • test_list_families_view_tag_filter_multiple()
    • test_list_members_view()
    • test_list_members_view_nonexistent()
    • test_list_tags_view()
    • test_member_details_view()
    • test_member_details_view_nonexistent()
  • Module contents

Submodules

family_api.urls module

family_api.views module

class family_api.views.AllMemberDetailsView

Bases: QueryBaseView, DatasetAccessRightsView

Details of all members of a family.

get(request: Request, dataset_id: str, family_id: str) → Response

Response to get request for details of all members of a family.

class family_api.views.FamilyDetailsView

Bases: QueryBaseView, DatasetAccessRightsView

Get a family details view.

get(request: Request, dataset_id: str, family_id: str) → Response

Response to a get request for the details of a specific family.

class family_api.views.ListAllDetailsView

Bases: QueryBaseView, DatasetAccessRightsView

List of all family details.

get(request: Request, dataset_id: str) → Response

Response to get request for all families details in a dataset.

class family_api.views.ListFamiliesView

Bases: QueryBaseView, DatasetAccessRightsView

List dataset families.

get(request: Request, dataset_id: str | None) → Response

Response to get request for a dataset families.

class family_api.views.ListMembersView

Bases: QueryBaseView, DatasetAccessRightsView

List family members view.

get(request: Request, dataset_id: str, family_id: str) → Response

Response to get family members.

class family_api.views.MemberDetailsView

Bases: QueryBaseView, DatasetAccessRightsView

Details view of a person.

get(request: Request, dataset_id: str, family_id: str, member_id: str) → Response

Response to get request for a person details.

class family_api.views.TagsView

Bases: QueryBaseView, DatasetAccessRightsView

get(request: Request) → Response

Module contents