MANSOQ Knowledge
← Technical API reference

Frontend module · STATIC DECLARATIONS

Public Appointment Api client API reference · mansoq-hmis-web

4 client route/call declarations with path parameters, named payload/response types and source references. Exact server acceptance and permissions require the matched backend contract.

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.

Client contract scope

These 4 declarations come from repositories/teleicu/mansoq-hmis-web/src/types/scheduling/PublicAppointmentApi.ts. Client types and noAuth flags describe the caller; they do not authorize a server action. Dynamic paths and missing backend matches are retained as review work, not repaired into invented endpoints.

Operation map

Client method HTTP method Path pattern Resolution
default.getSlotsForDay POST /api/v1/otp/slots/get_slots_for_day/ literal
default.getAppointments GET /api/v1/otp/slots/get_appointments/ literal
default.createAppointment POST /api/v1/otp/slots/{id}/create_appointment/ literal
default.cancelAppointment POST /api/v1/otp/slots/cancel_appointment/ literal

default.getSlotsForDay

POST /api/v1/otp/slots/get_slots_for_day/. typed route object; literal. multiple static method/path matches across source registrations; installed target and boundary require review.

request type: object. client-side declaration; not proof of accepted server payload.

default.getSlotsForDay.request declared fields:

Field Type Required Description
facility string true —
resource_type SchedulableResourceType true —
resource_id string true —
day string true —

response type: object. client-side declaration; not proof of accepted server payload.

TokenSlot declared fields:

Field Type Required Description
id string true —
availability object true —
start_datetime string true —
end_datetime string true —
allocated number true —

default.getSlotsForDay.response declared fields:

Field Type Required Description
results TokenSlot[] true —

Operational limitation: request validation, permission checks, error statuses and irreversible side effects belong to the server implementation. An unmatched or computed client route requires contract review before use.

default.getAppointments

GET /api/v1/otp/slots/get_appointments/. typed route object; literal. multiple static method/path matches across source registrations; installed target and boundary require review.

response type: object. client-side declaration; not proof of accepted server payload.

Composed/inherited schema references: AppointmentBase, PublicPatientRead. Exact generic composition is retained in the structured reference and requires server-side confirmation.

default.getAppointments.response declared fields:

Field Type Required Description
results PublicAppointment[] true —

Operational limitation: request validation, permission checks, error statuses and irreversible side effects belong to the server implementation. An unmatched or computed client route requires contract review before use.

default.createAppointment

POST /api/v1/otp/slots/{id}/create_appointment/. typed route object; literal. multiple static method/path matches across source registrations; installed target and boundary require review.

Path parameters: id. Transport strings are declared here; semantic identifier types require the server contract.

request type: AppointmentCreatePublicRequest. client-side declaration; not proof of accepted server payload.

AppointmentCreatePublicRequest declared fields:

Field Type Required Description
patient string true —
note string true —

response type: PublicAppointment. client-side declaration; not proof of accepted server payload.

Operational limitation: request validation, permission checks, error statuses and irreversible side effects belong to the server implementation. An unmatched or computed client route requires contract review before use.

default.cancelAppointment

POST /api/v1/otp/slots/cancel_appointment/. typed route object; literal. multiple static method/path matches across source registrations; installed target and boundary require review.

request type: object. client-side declaration; not proof of accepted server payload.

default.cancelAppointment.request declared fields:

Field Type Required Description
appointment string true —
patient string true —

response type: PublicAppointment. client-side declaration; not proof of accepted server payload.

Operational limitation: request validation, permission checks, error statuses and irreversible side effects belong to the server implementation. An unmatched or computed client route requires contract review before use.

Pinned source evidence

Links require access to the private source repository.