Features reference

Features endpoint authentication, parameters, request and response contracts.

Last updated:

On this pageGET /api/p/{pid}/featuresGET /api/p/{pid}/features/{fid}GET /api/p/{pid}/features/{fid}/routeGET /api/p/{pid}/features/{fid}/route-candidatesGET /api/p/{pid}/features/{fid}/talep

Paths, methods, parameters and available schemas are generated from the OpenAPI document in the repository.

Note: These endpoints form the browser application contract and do not provide the same versioning assurance as v1. Use the versioned API for external integrations.

GET /api/p/{pid}/features

List features

Complete set: open files and the change delta from the same brief REPEATABLE READ transaction.

Authentication: User session (cookie). Scope: Relevant organisation/project membership and operation permission; writes also check the current role, module and licence permissions.

Parameters

NameLocationTypeRequired
pidpathintegerYes
kapaliqueryintegerNo
tamqueryintegerNo

Responses

HTTP 200

application/json

This OpenAPI document does not define a body schema. See the relevant developer guide for details.

HTTP 422

application/json

FieldTypeRequiredDescription
detailValidationError[]No

For error meanings and client actions, see the error code glossary.

GET /api/p/{pid}/features/{fid}

Get feature

Authentication: User session (cookie). Scope: Relevant organisation/project membership and operation permission; writes also check the current role, module and licence permissions.

Parameters

NameLocationTypeRequired
pidpathintegerYes
fidpathstringYes
kapaliqueryintegerNo

Responses

HTTP 200

application/json

This OpenAPI document does not define a body schema. See the relevant developer guide for details.

HTTP 422

application/json

FieldTypeRequiredDescription
detailValidationError[]No

For error meanings and client actions, see the error code glossary.

GET /api/p/{pid}/features/{fid}/route

Get route

Route view (F1): cable and duct entries, continuity and length; duct and subduct sections; records passing through each segment.

Authentication: User session (cookie). Scope: Relevant organisation/project membership and operation permission; writes also check the current role, module and licence permissions.

Parameters

NameLocationTypeRequired
pidpathintegerYes
fidpathstringYes
kapaliqueryintegerNo

Responses

HTTP 200

application/json

This OpenAPI document does not define a body schema. See the relevant developer guide for details.

HTTP 422

application/json

FieldTypeRequiredDescription
detailValidationError[]No

For error meanings and client actions, see the error code glossary.

GET /api/p/{pid}/features/{fid}/route-candidates

Get route candidates

Segments along the geometry: candidates only; no relationships are written. An intersection does not establish a relationship.

Authentication: User session (cookie). Scope: Relevant organisation/project membership and operation permission; writes also check the current role, module and licence permissions.

Parameters

NameLocationTypeRequired
pidpathintegerYes
fidpathstringYes
kapaliqueryintegerNo

Responses

HTTP 200

application/json

This OpenAPI document does not define a body schema. See the relevant developer guide for details.

HTTP 422

application/json

FieldTypeRequiredDescription
detailValidationError[]No

For error meanings and client actions, see the error code glossary.

GET /api/p/{pid}/features/{fid}/talep

Get demand records

The planning section of a building record: plan, units, endpoints, address entrances and calculations; or an address entrance’s building link.

Authentication: User session (cookie). Scope: Relevant organisation/project membership and operation permission; writes also check the current role, module and licence permissions.

Parameters

NameLocationTypeRequired
pidpathintegerYes
fidpathstringYes
kapaliqueryintegerNo

Responses

HTTP 200

application/json

This OpenAPI document does not define a body schema. See the relevant developer guide for details.

HTTP 422

application/json

FieldTypeRequiredDescription
detailValidationError[]No

For error meanings and client actions, see the error code glossary.