Backend resource · STATIC DECLARATIONS
Supply Request API reference · mansoq-core
Static source contract for Supply Request: 7 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/supply_request/. 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/supply_request/ |
list | declared/inherited method |
| POST | /api/v1/supply_request/ |
create | declared/inherited method |
| GET | /api/v1/supply_request/{external_id}/ |
retrieve | declared/inherited method |
| PUT | /api/v1/supply_request/{external_id}/ |
update | declared/inherited method |
| PATCH | /api/v1/supply_request/{external_id}/ |
partial_update | declared/inherited method |
| POST | /api/v1/supply_request/upsert/ |
upsert | @action declaration |
| GET | /api/v1/supply_request/request_orders/ |
request_orders | @action declaration |
list · GET
GET /api/v1/supply_request/ — 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):
| Location | Field | Declared/inferred read type | Requiredness evidence |
|---|---|---|---|
| query | include_children |
not declared at read site | not established |
| query | order |
not declared at read site | direct indexing; validation may be upstream |
| query | destination |
not declared at read site | direct indexing; validation may be upstream |
| query | origin |
not declared at read site | direct indexing; validation may be upstream |
response: SupplyRequestReadSpec. 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 |
| status | SupplyRequestStatusOptions | true | No extra constraint extracted |
| quantity | int | true | No extra constraint extracted |
| item | dict | true | No extra constraint extracted |
| order | dict | true | No extra constraint extracted |
Observed authorization checks: can_list_facility_supply_request. Helper/queryset evidence is included; this is not proof of complete security review.
Declared refusal/error evidence: ValidationError: No filters provided; PermissionDenied: Cannot read supply requests; PermissionDenied: Cannot list supply requests.
create · POST
POST /api/v1/supply_request/ — 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):
| Location | Field | Declared/inferred read type | Requiredness evidence |
|---|---|---|---|
| query | include_children |
not declared at read site | not established |
| query | order |
not declared at read site | direct indexing; validation may be upstream |
| query | destination |
not declared at read site | direct indexing; validation may be upstream |
| query | origin |
not declared at read site | direct indexing; validation may be upstream |
request: SupplyRequestWriteSpec. 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 |
| status | SupplyRequestStatusOptions | true | No extra constraint extracted |
| quantity | Decimal | true | ge: 1 |
| item | UUID4 | true | No extra constraint extracted |
| order | UUID4 | true | No extra constraint extracted |
response: SupplyRequestReadSpec. 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_facility_supply_request, can_write_facility_supply_request. Helper/queryset evidence is included; this is not proof of complete security review.
Declared refusal/error evidence: ValidationError: No filters provided; PermissionDenied: Cannot read supply requests; PermissionDenied: Cannot list supply requests; PermissionDenied: Cannot write supply requests; ValidationError: Request order is abandoned or entered in error; ValidationError: Request order is completed.
retrieve · GET
GET /api/v1/supply_request/{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 |
Directly observed request reads (these do not constitute a complete accepted-payload or requiredness guarantee):
| Location | Field | Declared/inferred read type | Requiredness evidence |
|---|---|---|---|
| query | include_children |
not declared at read site | not established |
| query | order |
not declared at read site | direct indexing; validation may be upstream |
| query | destination |
not declared at read site | direct indexing; validation may be upstream |
| query | origin |
not declared at read site | direct indexing; validation may be upstream |
response: SupplyRequestReadSpec. 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_facility_supply_request. Helper/queryset evidence is included; this is not proof of complete security review.
Declared refusal/error evidence: ValidationError: No filters provided; PermissionDenied: Cannot read supply requests; PermissionDenied: Cannot list supply requests.
update · PUT
PUT /api/v1/supply_request/{external_id}/ — action update. 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 |
Directly observed request reads (these do not constitute a complete accepted-payload or requiredness guarantee):
| Location | Field | Declared/inferred read type | Requiredness evidence |
|---|---|---|---|
| query | include_children |
not declared at read site | not established |
| query | order |
not declared at read site | direct indexing; validation may be upstream |
| query | destination |
not declared at read site | direct indexing; validation may be upstream |
| query | origin |
not declared at read site | direct indexing; validation may be upstream |
request: SupplyRequestUpdateSpec. 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 |
| status | SupplyRequestStatusOptions | true | No extra constraint extracted |
| quantity | Decimal | true | ge: 1 |
| order | UUID4 | true | No extra constraint extracted |
response: SupplyRequestReadSpec. 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_facility_supply_request, can_write_facility_supply_request. Helper/queryset evidence is included; this is not proof of complete security review.
Declared refusal/error evidence: ValidationError: No filters provided; PermissionDenied: Cannot read supply requests; PermissionDenied: Cannot list supply requests; PermissionDenied: Cannot write supply requests; ValidationError: Request order is abandoned or entered in error; ValidationError: Request order is completed.
partial_update · PATCH
PATCH /api/v1/supply_request/{external_id}/ — action partial_update. 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 |
Directly observed request reads (these do not constitute a complete accepted-payload or requiredness guarantee):
| Location | Field | Declared/inferred read type | Requiredness evidence |
|---|---|---|---|
| query | include_children |
not declared at read site | not established |
| query | order |
not declared at read site | direct indexing; validation may be upstream |
| query | destination |
not declared at read site | direct indexing; validation may be upstream |
| query | origin |
not declared at read site | direct indexing; validation may be upstream |
request: SupplyRequestUpdateSpec. 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: SupplyRequestReadSpec. 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_facility_supply_request. Helper/queryset evidence is included; this is not proof of complete security review.
Declared refusal/error evidence: ValidationError: No filters provided; PermissionDenied: Cannot read supply requests; PermissionDenied: Cannot list supply requests; ValidationError: Request order is abandoned or entered in error; ValidationError: Request order is completed.
upsert · POST
POST /api/v1/supply_request/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):
| Location | Field | Declared/inferred read type | Requiredness evidence |
|---|---|---|---|
| body | datapoints |
not declared at read site | not established |
| query | include_children |
not declared at read site | not established |
| query | order |
not declared at read site | direct indexing; validation may be upstream |
| query | destination |
not declared at read site | direct indexing; validation may be upstream |
| query | origin |
not declared at read site | direct indexing; validation may be upstream |
Observed authorization checks: can_list_facility_supply_request. 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: No filters provided; PermissionDenied: Cannot read supply requests; PermissionDenied: Cannot list supply requests; ValidationError: Request order is abandoned or entered in error; ValidationError: Request order is completed; PermissionDenied: Cannot write supply requests.
Conditional gates: conditional/computed expression; inspect pinned declaration comparison settings.MAX_DATAPOINTS_PER_UPSERT.
request_orders · GET
GET /api/v1/supply_request/request_orders/ — action request_orders. static contract extracted; runtime/permission/payload behavior review pending.
Directly observed request reads (these do not constitute a complete accepted-payload or requiredness guarantee):
| Location | Field | Declared/inferred read type | Requiredness evidence |
|---|---|---|---|
| query | delivery_order |
not declared at read site | direct indexing; validation may be upstream |
| query | include_children |
not declared at read site | not established |
| query | order |
not declared at read site | direct indexing; validation may be upstream |
| query | destination |
not declared at read site | direct indexing; validation may be upstream |
| query | origin |
not declared at read site | direct indexing; validation may be upstream |
Observed authorization checks: can_list_facility_supply_request. Helper/queryset evidence is included; this is not proof of complete security review.
Declared refusal/error evidence: ValidationError: delivery_order is required; ValidationError: No filters provided; PermissionDenied: Cannot read supply requests; PermissionDenied: Cannot list supply requests.
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.
- repositories/platform/mansoq-core/config/api_router.py:232
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/inventory/supply_request.py:44
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/base.py:168
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/inventory/supply_request.py:165
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/base.py:161
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/inventory/supply_request.py:110
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/inventory/supply_request.py:60
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/inventory/supply_request.py:134
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/base.py:330
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/base.py:158
- repositories/platform/mansoq-core/mansoq/emr/resources/inventory/supply_request/spec.py:66
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/base.py:136
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/inventory/supply_request.py:78
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/base.py:142
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/inventory/supply_request.py:122
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/base.py:130
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/base.py:346
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/inventory/supply_request.py:88
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/base.py:139
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/base.py:325
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/inventory/supply_request.py:69
- repositories/platform/mansoq-core/mansoq/emr/resources/inventory/supply_request/spec.py:39
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/base.py:83
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/inventory/supply_request.py:85
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/base.py:77
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/base.py:214
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/inventory/supply_request.py:82
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/base.py:228
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/base.py:201
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/base.py:335
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/inventory/supply_request.py:98
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/base.py:222
- repositories/platform/mansoq-core/mansoq/emr/resources/inventory/supply_request/spec.py:56
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/base.py:218
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/base.py:271
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/inventory/supply_request.py:147