Backend resource · STATIC DECLARATIONS

Schedule API reference · mansoq-core

Static source contract for Schedule: 8 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/facility/{facility_external_id}/schedule/. 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/facility/{facility_external_id}/schedule/`	list	declared/inherited method
POST	`/api/v1/facility/{facility_external_id}/schedule/`	create	declared/inherited method
GET	`/api/v1/facility/{facility_external_id}/schedule/{external_id}/`	retrieve	declared/inherited method
PUT	`/api/v1/facility/{facility_external_id}/schedule/{external_id}/`	update	declared/inherited method
PATCH	`/api/v1/facility/{facility_external_id}/schedule/{external_id}/`	partial_update	declared/inherited method
DELETE	`/api/v1/facility/{facility_external_id}/schedule/{external_id}/`	destroy	declared/inherited method
POST	`/api/v1/facility/{facility_external_id}/schedule/upsert/`	upsert	@action declaration
POST	`/api/v1/facility/{facility_external_id}/schedule/{external_id}/set_charge_item_definition/`	set_charge_item_definition	@action declaration

list · GET

GET /api/v1/facility/{facility_external_id}/schedule/ — action list. static contract extracted; runtime/permission/payload behavior review pending.

Path and deployment-context parameters:

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

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

Location	Field	Declared/inferred read type	Requiredness evidence
query	`resource_type`	not declared at read site	direct indexing; validation may be upstream
query	`resource_id`	not declared at read site	direct indexing; validation may be upstream

response: ScheduleReadSpec. 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
is_public	bool	true	No extra constraint extracted
name	str	true	No extra constraint extracted
valid_from	datetime.datetime	true	No extra constraint extracted
valid_to	datetime.datetime	true	No extra constraint extracted
availabilities	list	false	No extra constraint extracted
resource_type	SchedulableResourceTypeOptions	true	No extra constraint extracted
charge_item_definition	dict \| None	false	No extra constraint extracted
revisit_allowed_days	int \| None	false	No extra constraint extracted
revisit_charge_item_definition	dict \| None	false	No extra constraint extracted
created_by	dict	false	No extra constraint extracted
updated_by	dict	false	No extra constraint extracted

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

Declared refusal/error evidence: ValidationError: resource_type and resource_id are required; PermissionDenied: You do not have permission to update schedule.

create · POST

POST /api/v1/facility/{facility_external_id}/schedule/ — action create. static contract extracted; runtime/permission/payload behavior review pending.

Path and deployment-context parameters:

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

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

Location	Field	Declared/inferred read type	Requiredness evidence
query	`resource_type`	not declared at read site	direct indexing; validation may be upstream
query	`resource_id`	not declared at read site	direct indexing; validation may be upstream

request: ScheduleCreateSpec. 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
is_public	bool	true	No extra constraint extracted
facility	UUID4	true	No extra constraint extracted
name	str	true	No extra constraint extracted
valid_from	datetime.datetime	true	No extra constraint extracted
valid_to	datetime.datetime	true	No extra constraint extracted
availabilities	list[AvailabilityForScheduleSpec]	true	No extra constraint extracted
resource_type	SchedulableResourceTypeOptions	true	No extra constraint extracted
resource_id	UUID4	true	No extra constraint extracted

response: ScheduleReadSpec. 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: can_write_schedule, can_list_schedule. Helper/queryset evidence is included; this is not proof of complete security review.

Declared refusal/error evidence: ValidationError: resource_type and resource_id are required; PermissionDenied: You do not have permission to create schedule; PermissionDenied: You do not have permission to update schedule.

retrieve · GET

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

Path and deployment-context parameters:

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

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

Location	Field	Declared/inferred read type	Requiredness evidence
query	`resource_type`	not declared at read site	direct indexing; validation may be upstream
query	`resource_id`	not declared at read site	direct indexing; validation may be upstream

response: ScheduleReadSpec. 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: can_list_schedule. Helper/queryset evidence is included; this is not proof of complete security review.

Declared refusal/error evidence: ValidationError: resource_type and resource_id are required; PermissionDenied: You do not have permission to update schedule.

update · PUT

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

Path and deployment-context parameters:

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

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

Location	Field	Declared/inferred read type	Requiredness evidence
query	`resource_type`	not declared at read site	direct indexing; validation may be upstream
query	`resource_id`	not declared at read site	direct indexing; validation may be upstream

request: ScheduleUpdateSpec. 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
is_public	bool	true	No extra constraint extracted
name	str	true	No extra constraint extracted
valid_from	datetime.datetime	true	No extra constraint extracted
valid_to	datetime.datetime	true	No extra constraint extracted

response: ScheduleReadSpec. 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: can_write_schedule, can_list_schedule. Helper/queryset evidence is included; this is not proof of complete security review.

Declared refusal/error evidence: ValidationError: resource_type and resource_id are required; PermissionDenied: You do not have permission to update schedule.

partial_update · PATCH

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

Path and deployment-context parameters:

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

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

Location	Field	Declared/inferred read type	Requiredness evidence
query	`resource_type`	not declared at read site	direct indexing; validation may be upstream
query	`resource_id`	not declared at read site	direct indexing; validation may be upstream

request: ScheduleUpdateSpec. 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: ScheduleReadSpec. 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: can_list_schedule, can_write_schedule. Helper/queryset evidence is included; this is not proof of complete security review.

Declared refusal/error evidence: ValidationError: resource_type and resource_id are required; PermissionDenied: You do not have permission to update schedule.

destroy · DELETE

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

Path and deployment-context parameters:

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

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

Location	Field	Declared/inferred read type	Requiredness evidence
query	`resource_type`	not declared at read site	direct indexing; validation may be upstream
query	`resource_id`	not declared at read site	direct indexing; validation may be upstream

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

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

Declared refusal/error evidence: ValidationError: resource_type and resource_id are required; ValidationError: Cannot delete schedule as there are future bookings associated with it; PermissionDenied: You do not have permission to update schedule.

upsert · POST

POST /api/v1/facility/{facility_external_id}/schedule/upsert/ — action upsert. static contract extracted; runtime/permission/payload behavior review pending.

Path and deployment-context parameters:

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

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

Location	Field	Declared/inferred read type	Requiredness evidence
body	`datapoints`	not declared at read site	not established
query	`resource_type`	not declared at read site	direct indexing; validation may be upstream
query	`resource_id`	not declared at read site	direct indexing; validation may be upstream

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

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: resource_type and resource_id are required; PermissionDenied: You do not have permission to update schedule; PermissionDenied: You do not have permission to create schedule.

Conditional gates: conditional/computed expression; inspect pinned declaration comparison settings.MAX_DATAPOINTS_PER_UPSERT.

set_charge_item_definition · POST

POST /api/v1/facility/{facility_external_id}/schedule/{external_id}/set_charge_item_definition/ — action set_charge_item_definition. static contract extracted; runtime/permission/payload behavior review pending.

Path and deployment-context parameters:

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

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

Location	Field	Declared/inferred read type	Requiredness evidence
query	`resource_type`	not declared at read site	direct indexing; validation may be upstream
query	`resource_id`	not declared at read site	direct indexing; validation may be upstream

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

Declared refusal/error evidence: PermissionDenied: You do not have permission to set charge item definition; ValidationError: resource_type and resource_id are required; PermissionDenied: You do not have permission to update schedule.

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.