PoliscopePoliscope
APIReferenzFocusregions

/focusregions/{id}

GET
/focusregions/{id}

Get a single focusregion by ID. The authenticated user must be a team member.

Authorization

AuthorizationBearer <token>

API key as Bearer token

In: header

Path Parameters

id*string
Length1 <= length

Query Parameters

detail?string

Controls response detail level. summary: lightweight overview, fastest, ideal for result lists and quick searches. standard: richer data for displaying detailed cards or results. full: includes deeply nested fields, best for analysis or full context rendering.

Default"standard"
Value in"summary" | "standard" | "full"

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://api.poliscope.de/v2/focusregions/string"
{
  "data": {
    "id": "string",
    "name": "string",
    "type": "string",
    "query": "string",
    "team": [
      {
        "userId": "string",
        "firstName": "string",
        "lastName": "string",
        "email": "string",
        "paused": true,
        "lastVisit": "string",
        "newResultsCount": 0
      }
    ],
    "searchMode": "string",
    "entityIds": [
      "string"
    ],
    "levels": [
      "string"
    ],
    "regionalPlanAmendmentEdits": [
      "string"
    ],
    "regionalPlanAmendmentEntities": [
      {
        "id": "string",
        "name": "string",
        "level": "10",
        "location": {
          "lat": 0,
          "lon": 0
        },
        "parents": [
          {
            "id": "string",
            "name": "string",
            "level": "10"
          }
        ]
      }
    ]
  },
  "meta": {}
}
{
  "error": "BAD_REQUEST",
  "message": "string"
}
{
  "error": "BAD_REQUEST",
  "message": "string"
}
{
  "error": "BAD_REQUEST",
  "message": "string"
}

/focusregions/coverage GET

Return the RIS coverage summary per focusregion for the authenticated user. Entities without an own administration are not counted.

/focusregions/{id}/coverage GET

RIS coverage report for a focusregion's selected entities, including the entities that need no RIS. The authenticated user must be a team member.