MANSOQ Knowledge
← Technical API reference

Backend resource · STATIC DECLARATIONS

OTPSlot API reference · mansoq-core

Static source contract for OTPSlot: 5 declared or inherited operation mappings, schema/field evidence and authorization/refusal references. Deployment and behavioral review remain explicit.

Static API contract — behavior review pending. Source baseline f6e9f05f76d4.

Enable JavaScript to inspect structured operation, parameter, schema and permission evidence. Download this reference and its evidence.

Declared route and availability

This resource is declared in mansoq-core at /api/v1/otp/slots/. 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

Method Path Action Evidence
GET /api/v1/otp/slots/{external_id}/ retrieve declared/inherited method
POST /api/v1/otp/slots/get_slots_for_day/ get_slots_for_day @action declaration
POST /api/v1/otp/slots/{external_id}/create_appointment/ create_appointment @action declaration
POST /api/v1/otp/slots/cancel_appointment/ cancel_appointment @action declaration
GET /api/v1/otp/slots/get_appointments/ get_appointments @action declaration

retrieve · GET

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

Path and deployment-context parameters:

Location Parameter Type Required
path external_id router lookup string; semantic ID validation requires handler/schema review true

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

Field Type Required Constraints
meta dict false No extra constraint extracted
id UUID4 | None false No extra constraint extracted
availability UUID4 true No extra constraint extracted
start_datetime datetime.datetime true No extra constraint extracted
end_datetime datetime.datetime true No extra constraint extracted
allocated int true No extra constraint extracted

Authorization: no literal permission name was resolved in the bounded handler/helper traversal. Authentication, inherited policies, object/facility scoping and middleware still require review; this does not mean public access.

Class policy declarations: permission_classes: OTPAuthenticatedPermission; authentication_classes: JWTTokenPatientAuthentication.

get_slots_for_day · POST

POST /api/v1/otp/slots/get_slots_for_day/ — action get_slots_for_day. static contract extracted; runtime/permission/payload behavior review pending.

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

Field Type Required Constraints
facility UUID4 true No extra constraint extracted

Authorization: no literal permission name was resolved in the bounded handler/helper traversal. Authentication, inherited policies, object/facility scoping and middleware still require review; this does not mean public access.

Class policy declarations: permission_classes: OTPAuthenticatedPermission; authentication_classes: JWTTokenPatientAuthentication.

create_appointment · POST

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

Path and deployment-context parameters:

Location Parameter Type Required
path external_id router lookup string; semantic ID validation requires handler/schema review true

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

Field Type Required Constraints
patient UUID4 true No extra constraint extracted
note str true No extra constraint extracted
tags list[UUID4] false No extra constraint extracted

Authorization: no literal permission name was resolved in the bounded handler/helper traversal. Authentication, inherited policies, object/facility scoping and middleware still require review; this does not mean public access.

Class policy declarations: permission_classes: OTPAuthenticatedPermission; authentication_classes: JWTTokenPatientAuthentication.

Declared refusal/error evidence: ValidationError: Patient not allowed.

cancel_appointment · POST

POST /api/v1/otp/slots/cancel_appointment/ — action cancel_appointment. static contract extracted; runtime/permission/payload behavior review pending.

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

Field Type Required Constraints
patient UUID4 true No extra constraint extracted
appointment UUID4 true No extra constraint extracted

Authorization: no literal permission name was resolved in the bounded handler/helper traversal. Authentication, inherited policies, object/facility scoping and middleware still require review; this does not mean public access.

Class policy declarations: permission_classes: OTPAuthenticatedPermission; authentication_classes: JWTTokenPatientAuthentication.

get_appointments · GET

GET /api/v1/otp/slots/get_appointments/ — action get_appointments. static contract extracted; runtime/permission/payload behavior review pending.

Authorization: no literal permission name was resolved in the bounded handler/helper traversal. Authentication, inherited policies, object/facility scoping and middleware still require review; this does not mean public access.

Class policy declarations: permission_classes: OTPAuthenticatedPermission; authentication_classes: JWTTokenPatientAuthentication.

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.

Pinned source evidence

Links require access to the private source repository.