Organization API reference · mansoq-core

Declared route and availability

This resource is declared in mansoq-core at /api/v1/organization/. verified core mount in config/urls.py A registered path and an indexed handler do not prove deployment availability, user permission or production readiness.

Operation map

list · GET

GET /api/v1/organization/ — action list. static contract extracted; runtime/permission/payload behavior review pending.

Directly observed request reads (these do not constitute a complete accepted-payload or requiredness guarantee):

response: OrganizationReadSpec. Declared fields below; inherited fields are retained in the schema inventory.

Observed authorization checks: get_accessible_organizations. Helper/queryset evidence is included; this is not proof of complete security review.

Class policy declarations: authentication_classes: JWTTokenPatientAuthentication, computed annotation (review required).

Conditional gates: permission in self.request.GET and not self.request.user.is_superuser or not conditional/computed expression; inspect pinned declaration.

create · POST

POST /api/v1/organization/ — action create. static contract extracted; runtime/permission/payload behavior review pending.

Directly observed request reads (these do not constitute a complete accepted-payload or requiredness guarantee):

request: OrganizationWriteSpec. Declared fields below; inherited fields are retained in the schema inventory.

response: OrganizationRetrieveSpec. Declared fields below; inherited fields are retained in the schema inventory.

Observed authorization checks: get_accessible_organizations, can_create_organization_obj. Helper/queryset evidence is included; this is not proof of complete security review.

Class policy declarations: authentication_classes: JWTTokenPatientAuthentication, computed annotation (review required).

Declared refusal/error evidence: PermissionDenied: Root Organizations can only be created by the superadmin; PermissionDenied: Organization Type cannot be created; ValidationError: Cannot create organizations under role organizations; PermissionDenied: User does not have the required permissions to create organizations; ValidationError: Organization already exists with same name; ValidationError (dynamic detail; inspect source).

Conditional gates: permission in self.request.GET and not self.request.user.is_superuser or not conditional/computed expression; inspect pinned declaration; parent.level_cache comparison settings.ORGANIZATION_MAX_DEPTH.

retrieve · GET

GET /api/v1/organization/{external_id}/ — action retrieve. static contract extracted; runtime/permission/payload behavior review pending.

Path and deployment-context parameters:

Directly observed request reads (these do not constitute a complete accepted-payload or requiredness guarantee):

response: OrganizationRetrieveSpec. Declared fields below; inherited fields are retained in the schema inventory.

The declared field table is shown at its first occurrence in this reference; this operation links the same schema.

Observed authorization checks: get_accessible_organizations. Helper/queryset evidence is included; this is not proof of complete security review.

Class policy declarations: authentication_classes: JWTTokenPatientAuthentication, computed annotation (review required).

Conditional gates: permission in self.request.GET and not self.request.user.is_superuser or not conditional/computed expression; inspect pinned declaration.

update · PUT

PUT /api/v1/organization/{external_id}/ — action update. static contract extracted; runtime/permission/payload behavior review pending.

Path and deployment-context parameters:

Directly observed request reads (these do not constitute a complete accepted-payload or requiredness guarantee):

request: OrganizationUpdateSpec. Declared fields below; inherited fields are retained in the schema inventory.

response: OrganizationRetrieveSpec. Declared fields below; inherited fields are retained in the schema inventory.

The declared field table is shown at its first occurrence in this reference; this operation links the same schema.

Observed authorization checks: get_accessible_organizations, can_manage_organization_obj. Helper/queryset evidence is included; this is not proof of complete security review.

Class policy declarations: authentication_classes: JWTTokenPatientAuthentication, computed annotation (review required).

Declared refusal/error evidence: PermissionDenied: Organization Type cannot be updated; PermissionDenied: User does not have the required permissions to update organizations; ValidationError: Organization already exists with same name; ValidationError (dynamic detail; inspect source).

Conditional gates: permission in self.request.GET and not self.request.user.is_superuser or not conditional/computed expression; inspect pinned declaration; parent.level_cache comparison settings.ORGANIZATION_MAX_DEPTH.

partial_update · PATCH

PATCH /api/v1/organization/{external_id}/ — action partial_update. static contract extracted; runtime/permission/payload behavior review pending.

Path and deployment-context parameters:

Directly observed request reads (these do not constitute a complete accepted-payload or requiredness guarantee):

request: OrganizationUpdateSpec. Declared fields below; inherited fields are retained in the schema inventory.

The declared field table is shown at its first occurrence in this reference; this operation links the same schema.

response: OrganizationRetrieveSpec. Declared fields below; inherited fields are retained in the schema inventory.

The declared field table is shown at its first occurrence in this reference; this operation links the same schema.

Observed authorization checks: get_accessible_organizations, can_manage_organization_obj. Helper/queryset evidence is included; this is not proof of complete security review.

Class policy declarations: authentication_classes: JWTTokenPatientAuthentication, computed annotation (review required).

Declared refusal/error evidence: ValidationError: Organization already exists with same name; ValidationError (dynamic detail; inspect source); PermissionDenied: Organization Type cannot be updated; PermissionDenied: User does not have the required permissions to update organizations.

Conditional gates: permission in self.request.GET and not self.request.user.is_superuser or not conditional/computed expression; inspect pinned declaration; parent.level_cache comparison settings.ORGANIZATION_MAX_DEPTH.

destroy · DELETE

DELETE /api/v1/organization/{external_id}/ — action destroy. static contract extracted; runtime/permission/payload behavior review pending.

Path and deployment-context parameters:

Directly observed request reads (these do not constitute a complete accepted-payload or requiredness guarantee):

Observed authorization checks: get_accessible_organizations, can_manage_organization_obj. Helper/queryset evidence is included; this is not proof of complete security review.

Class policy declarations: authentication_classes: JWTTokenPatientAuthentication, computed annotation (review required).

Explicit response statuses in observed code: status.HTTP_204_NO_CONTENT. Other branches/framework exception handling may differ.

Declared refusal/error evidence: PermissionDenied: Cannot delete organization with children; PermissionDenied: Organization Type cannot be deleted; PermissionDenied: User does not have the required permissions to delete organizations.

Conditional gates: permission in self.request.GET and not self.request.user.is_superuser or not conditional/computed expression; inspect pinned declaration.

upsert · POST

POST /api/v1/organization/upsert/ — action upsert. static contract extracted; runtime/permission/payload behavior review pending.

Directly observed request reads (these do not constitute a complete accepted-payload or requiredness guarantee):

Observed authorization checks: get_accessible_organizations, can_manage_organization_obj, can_create_organization_obj. Helper/queryset evidence is included; this is not proof of complete security review.

Class policy declarations: authentication_classes: JWTTokenPatientAuthentication, computed annotation (review required).

Explicit response statuses in observed code: 400. Other branches/framework exception handling may differ.

Declared refusal/error evidence: RestFrameworkValidationError: Invalid request data; RestFrameworkValidationError: No datapoints provided; RestFrameworkValidationError: Too many datapoints provided; ValidationError: Organization already exists with same name; ValidationError (dynamic detail; inspect source); PermissionDenied: Organization Type cannot be updated; PermissionDenied: User does not have the required permissions to update organizations; PermissionDenied: Root Organizations can only be created by the superadmin; PermissionDenied: Organization Type cannot be created; ValidationError: Cannot create organizations under role organizations; PermissionDenied: User does not have the required permissions to create organizations.

Conditional gates: conditional/computed expression; inspect pinned declaration comparison settings.MAX_DATAPOINTS_PER_UPSERT; permission in self.request.GET and not self.request.user.is_superuser or not conditional/computed expression; inspect pinned declaration; parent.level_cache comparison settings.ORGANIZATION_MAX_DEPTH.

mine · GET

Get organizations that are directly attached to the given user

GET /api/v1/organization/mine/ — action mine. static contract extracted; runtime/permission/payload behavior review pending.

Directly observed request reads (these do not constitute a complete accepted-payload or requiredness guarantee):

Observed authorization checks: get_accessible_organizations. Helper/queryset evidence is included; this is not proof of complete security review.

Class policy declarations: authentication_classes: JWTTokenPatientAuthentication, computed annotation (review required).

Conditional gates: permission in self.request.GET and not self.request.user.is_superuser or not conditional/computed expression; inspect pinned declaration.

accessible_role_organizations · GET

GET /api/v1/organization/accessible_role_organizations/ — action accessible_role_organizations. static contract extracted; runtime/permission/payload behavior review pending.

Directly observed request reads (these do not constitute a complete accepted-payload or requiredness guarantee):

Observed authorization checks: get_accessible_organizations. Helper/queryset evidence is included; this is not proof of complete security review.

Class policy declarations: authentication_classes: JWTTokenPatientAuthentication, computed annotation (review required).

Conditional gates: permission in self.request.GET and not self.request.user.is_superuser or not conditional/computed expression; inspect pinned declaration.

managing_organization · POST

POST /api/v1/organization/{external_id}/managing_organization/ — action managing_organization. static contract extracted; runtime/permission/payload behavior review pending.

Path and deployment-context parameters:

Directly observed request reads (these do not constitute a complete accepted-payload or requiredness guarantee):

decorator request: OrganizationManagingOrganizationRequest. Declared fields below; inherited fields are retained in the schema inventory.

Observed authorization checks: can_manage_organization_obj, get_accessible_organizations. Helper/queryset evidence is included; this is not proof of complete security review.

Class policy declarations: authentication_classes: JWTTokenPatientAuthentication, computed annotation (review required).

Declared refusal/error evidence: ValidationError: Managing organization is only supported for role organizations; PermissionDenied: User does not have the required permissions to requested organization; PermissionDenied: User does not have the required permissions to manage the organization; ValidationError: Managing organization is not part of the organization.

Conditional gates: permission in self.request.GET and not self.request.user.is_superuser or not conditional/computed expression; inspect pinned declaration.

Integration review checklist

Confirm the installed route and full schema; review authentication, organization/facility scoping, all accepted fields, value-state and date/time semantics, idempotency, pagination, response/exception branches and the allowed correction/reversal workflow. Test positive and negative cases with synthetic data. This source reference does not establish external certification or replace an illustrated user procedure.