Hcx Gateway API reference · mansoq-hcx

Declared route and availability

This resource is declared in mansoq-hcx at /api/{installed_plugin_prefix}//. plugin/local mount; actual prefix and enablement require deployment verification A registered path and an indexed handler do not prove deployment availability, user permission or production readiness.

Operation map

check_eligibility · POST

POST /api/{installed_plugin_prefix}/check_eligibility/ — action check_eligibility. 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):

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: IsAuthenticated.

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

make_claim · POST

POST /api/{installed_plugin_prefix}/make_claim/ — action make_claim. 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):

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: IsAuthenticated.

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

send_communication · POST

POST /api/{installed_plugin_prefix}/send_communication/ — action send_communication. 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):

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: IsAuthenticated.

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

payors · GET

GET /api/{installed_plugin_prefix}/payors/ — action payors. 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):

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: IsAuthenticated.

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

pmjy_packages · GET

GET /api/{installed_plugin_prefix}/pmjy_packages/ — action pmjy_packages. 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):

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: IsAuthenticated.

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.