Integration Endpoint API reference · mansoq-core

Declared route and availability

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

Connection endpoints, one per environment, with their certificates.

Operation map

list · GET

GET /api/v1/facility/{facility_external_id}/rcm/integration/endpoints/ — action list. 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: can_read_rcm_configuration_in_facility. Helper/queryset evidence is included; this is not proof of complete security review.

Declared refusal/error evidence: PermissionDenied: Cannot read RCM configuration.

retrieve · GET

GET /api/v1/facility/{facility_external_id}/rcm/integration/endpoints/{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):

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

Declared refusal/error evidence: PermissionDenied: Cannot read RCM configuration.

certificate · GET

Expiry as a countdown, because expiry blocks submission.

GET /api/v1/facility/{facility_external_id}/rcm/integration/endpoints/{external_id}/certificate/ — action certificate. 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: can_read_rcm_configuration_in_facility. Helper/queryset evidence is included; this is not proof of complete security review.

Declared refusal/error evidence: PermissionDenied: Cannot read RCM configuration.

rotate_certificate · POST

Rotate the certificate. On a frozen row that means a new version.

POST /api/v1/facility/{facility_external_id}/rcm/integration/endpoints/{external_id}/rotate_certificate/ — action rotate_certificate. 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: can_edit_rcm_configuration_in_facility, can_read_rcm_configuration_in_facility. Helper/queryset evidence is included; this is not proof of complete security review.

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

Declared refusal/error evidence: PermissionDenied: Cannot edit RCM configuration; ValidationError: Request body must be an object; ValidationError (dynamic detail; inspect source); PermissionDenied: Cannot read RCM configuration.

Conditional gates: certificate_subject in data; certificate_not_after in data.

test_connection · POST

Pre-flight only. Nothing is transmitted, in any environment.

The four refusals assert_live_submission_allowed raises are reported individually rather than as one failure, because each has a different owner: activation is a decision, certification is a process, the pinned package is a procurement fact and an open gate is a research task.

POST /api/v1/facility/{facility_external_id}/rcm/integration/endpoints/{external_id}/test_connection/ — action test_connection. 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: can_read_rcm_configuration_in_facility. Helper/queryset evidence is included; this is not proof of complete security review.

Declared refusal/error evidence: PermissionDenied: Cannot read RCM configuration.

replay · POST

Plan an identity-preserving resend. Nothing is transmitted.

The attempt ceiling is read from configuration and is refused when it is not established: a resend loop with an invented ceiling is how a stuck transaction becomes an unbounded one instead of a support ticket.

POST /api/v1/facility/{facility_external_id}/rcm/integration/endpoints/{external_id}/replay/ — action replay. 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: can_edit_rcm_configuration_in_facility, can_read_rcm_configuration_in_facility. Helper/queryset evidence is included; this is not proof of complete security review.

Declared refusal/error evidence: PermissionDenied: Cannot edit RCM configuration; ValidationError: Request body must be an object; ValidationError (dynamic detail; inspect source); PermissionDenied: Cannot read RCM configuration.

errors · GET

Recorded transport and business errors, by pointer, never by payload.

"Inspect errors" is one of SET-11's four core actions, so the selection is an error selection. The previous predicate — exclude(operation_outcome={}, http_status=None) — excluded only the rows that were both outcome-free and status-free, which is every exchange that ever reached the payer: a successful 200 carries an http status and was listed as an error. An operator reading that screen is triaging successes.

An error is an HTTP failure class or a recorded OperationOutcome. Nothing here reads status/transport_status/business_status: those are open TEXT columns with no published vocabulary, and picking values out of them would hard-code a classification the instruments do not state.

GET /api/v1/facility/{facility_external_id}/rcm/integration/endpoints/{external_id}/errors/ — action errors. 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: can_read_rcm_configuration_in_facility. Helper/queryset evidence is included; this is not proof of complete security review.

Declared refusal/error evidence: PermissionDenied: Cannot read RCM configuration.

export · GET

The integration configuration, exportable and provably secret-free.

The same guard that protects the screen protects this, because ch. 31 names the UI and the export together and the export is the one that leaves the building.

GET /api/v1/facility/{facility_external_id}/rcm/integration/endpoints/export/ — action export. 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: can_read_rcm_configuration_in_facility. Helper/queryset evidence is included; this is not proof of complete security review.

Declared refusal/error evidence: PermissionDenied: Cannot read RCM configuration.

activation_states · GET

The seven states and what each permits, for the screen to render.

GET /api/v1/facility/{facility_external_id}/rcm/integration/endpoints/activation_states/ — action activation_states. 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: can_read_rcm_configuration_in_facility. Helper/queryset evidence is included; this is not proof of complete security review.

Declared refusal/error evidence: PermissionDenied: Cannot read RCM configuration.

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.