FragDenStaat API v1

https://fragdenstaat.de/api/v1/
Admin
FragDenStaat API v1 is the application programming interface for the FragDenStaat platform,...
Tokens:35,408
Snippets:115
Trust Score:9.8
Update:8 months ago
Show doc for...
Tokens:
Raw
### GET /api/v1/request/tags/autocomplete/

Source: https://fragdenstaat.de/api/v1/schema

Provides tag suggestions for autocompletion, with options for output format.

```APIDOC
## GET /api/v1/request/tags/autocomplete/

### Description
Provides tag suggestions for autocompletion. The output format can be specified as JSON or CSV.

### Method
GET

### Endpoint
/api/v1/request/tags/autocomplete/

### Parameters
#### Query Parameters
- **format** (string) - Optional - Specifies the output format. Allowed values: "csv", "json".

### Request Example
```json
{
  "example": "GET /api/v1/request/tags/autocomplete/?format=json"
}
```

### Response
#### Success Response (200)
- **FoiRequestList** (object) - A list of FOI requests (likely containing tag information).

#### Response Example
```json
{
  "example": "[FOI Request Object 1, FOI Request Object 2]"
}
```
```

--------------------------------

### GET /api/v1/request/search/

Source: https://fragdenstaat.de/api/v1/schema

Retrieves a list of requests, with options to filter and format the output.

```APIDOC
## GET /api/v1/request/search/

### Description
Retrieves a list of requests. The output format can be specified as JSON or CSV.

### Method
GET

### Endpoint
/api/v1/request/search/

### Parameters
#### Query Parameters
- **format** (string) - Optional - Specifies the output format. Allowed values: "csv", "json".

### Request Example
```json
{
  "example": "GET /api/v1/request/search/?format=json"
}
```

### Response
#### Success Response (200)
- **FoiRequestList** (object) - A list of FOI requests.

#### Response Example
```json
{
  "example": "[FOI Request Object 1, FOI Request Object 2]"
}
```
```

--------------------------------

### GET /api/v1/governmentplan/

Source: https://fragdenstaat.de/api/v1/schema

Retrieves a list of government plans. This endpoint supports filtering and formatting options for the returned data.

```APIDOC
## GET /api/v1/governmentplan/

### Description
Retrieves a list of government plans.

### Method
GET

### Endpoint
/api/v1/governmentplan/

### Parameters
#### Query Parameters
- **format** (string) - Optional - Specifies the desired response format. Allowed values: "csv", "json".

### Response
#### Success Response (200)
- **[Response fields depend on implementation, likely a list of government plans]**

#### Response Example
```json
{
  "example": "response body"
}
```
```

--------------------------------

### GET /api/v1/document/oembed/

Source: https://fragdenstaat.de/api/v1/schema

Retrieves oEmbed information for a document. Supports JSON and CSV formats.

```APIDOC
## GET /api/v1/document/oembed/

### Description
Retrieves oEmbed information for a document. This endpoint allows for embedding document previews or metadata in other platforms.

### Method
GET

### Endpoint
/api/v1/document/oembed/

### Parameters
#### Query Parameters
- **format** (string) - Optional - Specifies the desired output format. Allowed values: "csv", "json". Defaults to "json".

### Request Example
```json
{
  "example": "GET /api/v1/document/oembed/?format=json"
}
```

### Response
#### Success Response (200)
- **schema** (Document) - The schema for the document oEmbed data.

#### Response Example
```json
{
  "example": "[Document oEmbed data in JSON or CSV format]"
}
```
```

--------------------------------

### GET /api/v1/request/

Source: https://fragdenstaat.de/api/v1/schema

Retrieves a list of information requests with extensive filtering capabilities.

```APIDOC
## GET /api/v1/request/

### Description
Retrieves a list of information requests with various filtering options.

### Method
GET

### Endpoint
/api/v1/request/

### Parameters
#### Query Parameters
- **campaign** (integer) - Optional - Filter by campaign ID.
- **categories** (string) - Optional - Filter by categories.
- **checked** (boolean) - Optional - Filter by checked status.
- **classification** (string) - Optional - Filter by classification.
- **costs_max** (string) - Optional - Filter by maximum costs (decimal format).
- **costs_min** (string) - Optional - Filter by minimum costs (decimal format).
- **created_at_after** (string) - Optional - Filter requests created after a specific date (YYYY-MM-DD).
- **created_at_before** (string) - Optional - Filter requests created before a specific date (YYYY-MM-DD).
- **follower** (string) - Optional - Filter by follower.
- **format** (string) - Optional - Specifies the desired response format (e.g., "csv", "json").
- **has_same** (boolean) - Optional - Filter by whether it has the same.
- **is_foi** (boolean) - Optional - Filter by whether it is a Freedom of Information request.
- **jurisdiction** (string) - Optional - Filter by jurisdiction.

### Request Example
```
GET /api/v1/request/?format=json&is_foi=true&costs_max=50.00
```

### Response
#### Success Response (200)
- **RequestList** (object) - A list of information requests. The exact structure depends on the requested format.

#### Response Example
```json
{
  "example": "[RequestList structure]"
}
```
```

--------------------------------

### PUT /api/v1/upload/{guid}/

Source: https://fragdenstaat.de/api/v1/schema

Updates an existing upload identified by its GUID. Allows for format specification.

```APIDOC
## PUT /api/v1/upload/{guid}/

### Description
Updates an existing upload identified by its GUID. Allows for format specification.

### Method
PUT

### Endpoint
/api/v1/upload/{guid}/

### Parameters
#### Path Parameters
- **guid** (string) - Required - The unique identifier (GUID) of the upload to update. Must follow the UUID format.

#### Query Parameters
- **format** (string) - Optional - Specifies the format of the upload. Allowed values: "csv", "json".

#### Request Body
- **(binary)** - Required - The updated data for the upload. Content type should be `application/offset+octet-stream`.

### Request Example
*(Binary data upload, no JSON example for request body)*

### Response
#### Success Response (200)
- **(object)** - The schema for the updated upload resource.

#### Response Example
```json
{
  "example": "response body"
}
```
```

--------------------------------

### GET /api/v1/publicbody/autocomplete/

Source: https://fragdenstaat.de/api/v1/schema

Provides autocomplete suggestions for public bodies. Supports CSV, JSON, and JSONP formats.

```APIDOC
## GET /api/v1/publicbody/autocomplete/

### Description
Provides autocomplete suggestions for public bodies. This endpoint is useful for dynamically searching and filtering public bodies as a user types.

### Method
GET

### Endpoint
/api/v1/publicbody/autocomplete/

### Parameters
#### Query Parameters
- **format** (string) - Optional - Specifies the desired response format. Allowed values: "csv", "json", "jsonp".

### Request Example
```json
{
  "example": "GET /api/v1/publicbody/autocomplete/?format=json"
}
```

### Response
#### Success Response (200)
- **PublicBodyList** (object) - A list of public bodies matching the autocomplete query. The exact structure depends on the requested format.
```

--------------------------------

### GET /api/v1/schema/

Source: https://fragdenstaat.de/api/v1/schema

Retrieves the OpenAPI3 schema for this API in JSON or YAML format.

```APIDOC
## GET /api/v1/schema/

### Description
Retrieves the OpenAPI3 schema for this API. The format can be selected via content negotiation.

### Method
GET

### Endpoint
/api/v1/schema/

### Parameters
#### Query Parameters
- **lang** (string) - Optional - Specifies the language for the schema. Allowed values: "de", "en".

### Request Example
```json
{
  "example": "GET /api/v1/schema/?lang=en"
}
```

### Response
#### Success Response (200)
- **OpenAPI3 Schema** (object) - The OpenAPI3 schema definition.

#### Response Example
```json
{
  "example": "{ \"openapi\": \"3.0.0\", ... }"
}
```
```

--------------------------------

### GET /api/v1/campaigninformationobject/

Source: https://fragdenstaat.de/api/v1/schema

Retrieves a list of campaign information objects. Supports filtering by format, limiting results, and pagination.

```APIDOC
## GET /api/v1/campaigninformationobject/

### Description
Retrieves a list of campaign information objects. Supports filtering by format, limiting results, and pagination.

### Method
GET

### Endpoint
/api/v1/campaigninformationobject/

### Parameters
#### Query Parameters
- **format** (string) - Optional - Enum: "csv", "json" - The desired format for the response.
- **limit** (integer) - Optional - Anzhal der pro Seite zurückzugebenden Ergebnisse.
- **offset** (integer) - Optional - Der initiale Index, von dem die Ergebnisse zurückgegeben werden sollen.

### Response
#### Success Response (200)
- **PaginatedInformationObjectList** - Schema reference for a paginated list of information objects.

#### Response Example
{
  "example": "response body"
}
```

--------------------------------

### GET /api/v1/documentcollection/

Source: https://fragdenstaat.de/api/v1/schema

Lists document collections. Supports pagination and format selection (JSON/CSV).

```APIDOC
## GET /api/v1/documentcollection/

### Description
Retrieves a list of document collections. This endpoint is useful for browsing or retrieving metadata about collections of documents.

### Method
GET

### Endpoint
/api/v1/documentcollection/

### Parameters
#### Query Parameters
- **format** (string) - Optional - Specifies the desired output format. Allowed values: "csv", "json". Defaults to "json".
- **limit** (integer) - Optional - The number of results to return per page.
- **offset** (integer) - Optional - The starting index for retrieving results.

### Request Example
```json
{
  "example": "GET /api/v1/documentcollection/?limit=10&offset=0&format=json"
}
```

### Response
#### Success Response (200)
- **schema** (PaginatedDocumentCollectionList) - A paginated list of document collections.

#### Response Example
```json
{
  "example": "[Paginated list of document collections in JSON or CSV format]"
}
```
```

--------------------------------

### PATCH /api/v1/upload/{guid}/

Source: https://fragdenstaat.de/api/v1/schema

Partially updates an existing upload identified by its GUID.

```APIDOC
## PATCH /api/v1/upload/{guid}/

### Description
Partially updates an existing upload identified by its GUID.

### Method
PATCH

### Endpoint
/api/v1/upload/{guid}/

### Parameters
*(Details for PATCH method are not fully provided in the input)*

### Request Example
*(Details not fully provided)*

### Response
*(Details not fully provided)*
```

--------------------------------

### GET /api/v1/georegion/reconciliation-suggest-service/

Source: https://fragdenstaat.de/api/v1/schema

Implements the OpenRefine Suggest Entry Point for georegions. This endpoint is designed to provide suggestions based on a given prefix and supports multiple response formats.

```APIDOC
## GET /api/v1/georegion/reconciliation-suggest-service/

### Description
Implements OpenRefine Suggest Entry Point (https://github.com/OpenRefine/OpenRefine/wiki/Suggest-API#suggest-entry-point). Only implements prefix.

### Method
GET

### Endpoint
/api/v1/georegion/reconciliation-suggest-service/

### Parameters
#### Query Parameters
- **format** (string) - Optional - Specifies the desired response format. Allowed values: "csv", "json", "jsonp".

### Response
#### Success Response (200)
- **GeoRegion** (object) - Contains georegion data.

#### Response Example
```json
{
  "example": "response body"
}
```
```

--------------------------------

### GET /api/v1/georegion/autocomplete/

Source: https://fragdenstaat.de/api/v1/schema

Retrieves autocomplete suggestions for geographic regions. Supports CSV, JSON, and JSONP formats.

```APIDOC
## GET /api/v1/georegion/autocomplete/

### Description
Retrieves autocomplete suggestions for geographic regions. This endpoint is useful for providing real-time suggestions as a user types in a search field.

### Method
GET

### Endpoint
/api/v1/georegion/autocomplete/

### Parameters
#### Query Parameters
- **format** (string) - Optional - Specifies the desired output format. Allowed values: `csv`, `json`, `jsonp`.

### Request Example
```
GET /api/v1/georegion/autocomplete/?format=json
```

### Response
#### Success Response (200)
- **GeoRegion** (object) - Contains a list of geographic region suggestions. The exact structure depends on the requested format.

#### Response Example (JSON)
```json
{
  "example": "[{"id": "Q123", "name": "Berlin"}, {"id": "Q456", "name": "Munich"}]"
}
```
```

--------------------------------

### Public Body Reconciliation Suggest Service

Source: https://fragdenstaat.de/api/v1/schema

Implements the OpenRefine Suggest Entry Point for public bodies. This endpoint can be used to suggest entries based on a prefix. It supports GET and POST requests and allows specifying the response format.

```APIDOC
## GET /api/v1/publicbody/reconciliation-suggest-service/

### Description
Implements OpenRefine Suggest Entry Point. Only implements prefix-based suggestions.

### Method
GET

### Endpoint
/api/v1/publicbody/reconciliation-suggest-service/

### Query Parameters
- **format** (string) - Optional - Specifies the response format. Allowed values: `csv`, `json`, `jsonp`.

### Response
#### Success Response (200)
- **PublicBodyList** (object) - A list of public bodies matching the query.

#### Response Example
```json
{
  "example": "[PublicBodyList object structure]"
}
```

## POST /api/v1/publicbody/reconciliation-suggest-service/

### Description
Implements OpenRefine Suggest Entry Point for public bodies using POST. This endpoint can be used to suggest entries based on a prefix. It supports POST requests and allows specifying the response format.

### Method
POST

### Endpoint
/api/v1/publicbody/reconciliation-suggest-service/

### Query Parameters
- **format** (string) - Optional - Specifies the response format. Allowed values: `csv`, `json`, `jsonp`.

### Request Body
- **PublicBodyList** (object) - Required - The data for the suggestion request.

### Request Example
```json
{
  "example": "[PublicBodyList object structure]"
}
```

### Response
#### Success Response (200)
- **PublicBodyList** (object) - A list of public bodies matching the query.

#### Response Example
```json
{
  "example": "[PublicBodyList object structure]"
}
```
```

--------------------------------

### GET /api/v1/georegion/reconciliation-propose-properties/

Source: https://fragdenstaat.de/api/v1/schema

Retrieves proposed properties for geographic regions, implementing the OpenRefine Data Extension API. Supports various response formats.

```APIDOC
## GET /api/v1/georegion/reconciliation-propose-properties/

### Description
Implements OpenRefine Data Extension API to retrieve proposed properties for geographic regions. This endpoint allows for data reconciliation and extension.

### Method
GET

### Endpoint
/api/v1/georegion/reconciliation-propose-properties/

### Parameters
#### Query Parameters
- **format** (string) - Optional - Specifies the desired response format. Allowed values: `csv`, `json`, `jsonp`.

### Request Example
(No request body for GET requests)

### Response
#### Success Response (200)
- **GeoRegion** (object) - A schema object representing geographic region data. The exact structure depends on the requested format.

#### Response Example
(Example response will vary based on format and data)
```json
{
  "example": "GeoRegion data in JSON format"
}
```
```

--------------------------------

### List Government Plans

Source: https://fragdenstaat.de/api/v1/schema

Retrieves a paginated list of government plans.

```APIDOC
## GET /websites/fragdenstaat_de_api_v1/government_plans

### Description
Retrieves a paginated list of government plans. This endpoint provides access to information about various government initiatives and policies.

### Method
GET

### Endpoint
/websites/fragdenstaat_de_api_v1/government_plans

### Parameters
#### Query Parameters
- **offset** (integer) - Optional - The number of results to skip.
- **limit** (integer) - Optional - The maximum number of results to return.

### Response
#### Success Response (200)
- **count** (integer) - The total number of government plans available.
- **next** (string) - URI for the next page of results, or null if there are no more pages.
- **previous** (string) - URI for the previous page of results, or null if this is the first page.
- **results** (array) - An array of government plan objects.

#### Response Example
```json
{
  "count": 123,
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100",
  "results": [
    {
      "$ref": "#/components/schemas/GovernmentPlan"
    }
  ]
}
```
```

--------------------------------

### Website Detail

Source: https://fragdenstaat.de/api/v1/schema

Retrieves detailed information about a specific website within the FragDenStaat platform. This includes metadata such as creation date, update date, document counts, and URLs for related resources.

```APIDOC
## GET /websites/{id}

### Description
Retrieves detailed information about a specific website.

### Method
GET

### Endpoint
/websites/{id}

### Parameters
#### Path Parameters
- **id** (integer) - Required - The unique identifier of the website.

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **resource_uri** (string) - The URI of the resource.
- **id** (integer) - The unique identifier of the website.
- **site_url** (string) - The URL of the website.
- **title** (string) - The title of the website.
- **description** (string) - A description of the website.
- **public** (boolean) - Indicates if the website is public.
- **listed** (boolean) - Indicates if the website is listed.
- **created_at** (string) - The date and time the website was created.
- **updated_at** (string) - The date and time the website was last updated.
- **document_count** (string) - The total number of documents associated with the website.
- **document_directory_count** (string) - The number of document directories.
- **uid** (string) - The unique identifier (UUID) of the website.
- **cover_image** (string) - URL of the cover image for the website.
- **current_directory** (string) - The current directory path.
- **directories** (string) - Information about directories.
- **directory_stack** (string) - The directory stack.
- **documents** (string) - Information about documents.
- **documents_uri** (string) - URI for accessing documents.
- **pages_uri** (string) - URI for accessing pages.
- **settings** (object) - Website settings.
- **zip_download_url** (string) - URL for downloading a zip archive of the website.

#### Response Example
```json
{
    "resource_uri": "/api/v1/websites/123/",
    "id": 123,
    "site_url": "https://example.com",
    "title": "Example Website",
    "description": "This is an example website.",
    "public": true,
    "listed": true,
    "created_at": "2023-10-27T10:00:00Z",
    "updated_at": "2023-10-27T10:30:00Z",
    "document_count": "100",
    "document_directory_count": "10",
    "uid": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
    "cover_image": "https://example.com/cover.jpg",
    "current_directory": "/",
    "directories": "[]",
    "directory_stack": "[]",
    "documents": "[]",
    "documents_uri": "/api/v1/websites/123/documents/",
    "pages_uri": "/api/v1/websites/123/pages/",
    "settings": {},
    "zip_download_url": "https://example.com/download.zip"
}
```
```

--------------------------------

### Following API

Source: https://fragdenstaat.de/api/v1/schema/swagger-ui

Endpoints for managing user followings.

```APIDOC
## Following API

### Description
Manages user followings, allowing users to follow and unfollow other users or entities.

### Endpoints

#### List current followings
- **Method**: GET
- **Endpoint**: `/api/v1/following/`

#### Start following an entity
- **Method**: POST
- **Endpoint**: `/api/v1/following/`

#### Unfollow an entity by ID
- **Method**: DELETE
- **Endpoint**: `/api/v1/following/{id}/`
```

--------------------------------

### POST /api/v1/campaigninformationobject/

Source: https://fragdenstaat.de/api/v1/schema

Creates a new campaign information object. Accepts data in JSON, form-urlencoded, or multipart/form-data format.

```APIDOC
## POST /api/v1/campaigninformationobject/

### Description
Creates a new campaign information object. Accepts data in JSON, form-urlencoded, or multipart/form-data format.

### Method
POST

### Endpoint
/api/v1/campaigninformationobject/

### Parameters
#### Query Parameters
- **format** (string) - Optional - Enum: "csv", "json" - The desired format for the response.

#### Request Body
- **InformationObject** - Schema reference for the information object to be created.

### Request Example
```json
{
  "example": "request body"
}
```

### Response
#### Success Response (201)
- **InformationObject** - Schema reference for the created information object.

#### Response Example
{
  "example": "response body"
}
```

--------------------------------

### POST /api/v1/upload/

Source: https://fragdenstaat.de/api/v1/schema

Initiates an upload process for new data. Supports CSV and JSON formats.

```APIDOC
## POST /api/v1/upload/

### Description
Initiates an upload process for new data. Supports CSV and JSON formats.

### Method
POST

### Endpoint
/api/v1/upload/

### Parameters
#### Query Parameters
- **format** (string) - Optional - Specifies the format of the upload. Allowed values: "csv", "json".

#### Request Body
- **(binary)** - Required - The data to be uploaded. Content type should be `application/offset+octet-stream`.

### Request Example
*(Binary data upload, no JSON example for request body)*

### Response
#### Success Response (201)
- **(object)** - The schema for the created upload resource.

#### Response Example
```json
{
  "example": "response body"
}
```
```

--------------------------------

### List Information Objects

Source: https://fragdenstaat.de/api/v1/schema

Retrieves a paginated list of information objects.

```APIDOC
## GET /websites/fragdenstaat_de_api_v1/information_objects

### Description
Retrieves a paginated list of information objects. This endpoint allows access to various pieces of information managed by the platform.

### Method
GET

### Endpoint
/websites/fragdenstaat_de_api_v1/information_objects

### Parameters
#### Query Parameters
- **offset** (integer) - Optional - The number of results to skip.
- **limit** (integer) - Optional - The maximum number of results to return.

### Response
#### Success Response (200)
- **count** (integer) - The total number of information objects available.
- **next** (string) - URI for the next page of results, or null if there are no more pages.
- **previous** (string) - URI for the previous page of results, or null if this is the first page.
- **results** (array) - An array of information object objects.

#### Response Example
```json
{
  "count": 123,
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100",
  "results": [
    {
      "$ref": "#/components/schemas/InformationObject"
    }
  ]
}
```
```

--------------------------------

### Venue List and Create API

Source: https://fragdenstaat.de/api/v1/schema

Provides endpoints to list existing venues and create new ones. Supports CSV or JSON format for the response.

```APIDOC
## GET /api/v1/venue/

### Description
Retrieves a list of venues. The response format can be specified as CSV or JSON.

### Method
GET

### Endpoint
/api/v1/venue/

### Query Parameters
- **format** (string) - Optional - Specifies the response format. Allowed values: "csv", "json".

### Response
#### Success Response (200)
- No response body.

## POST /api/v1/venue/

### Description
Creates a new venue. The response format can be specified as CSV or JSON, although the response body is empty upon successful creation.

### Method
POST

### Endpoint
/api/v1/venue/

### Query Parameters
- **format** (string) - Optional - Specifies the response format. Allowed values: "csv", "json".

### Response
#### Success Response (201)
- No response body.
```

--------------------------------

### GET /api/v1/documentcollection/{id}/

Source: https://fragdenstaat.de/api/v1/schema

Retrieves a specific document collection by its ID. Supports format selection (JSON/CSV).

```APIDOC
## GET /api/v1/documentcollection/{id}/

### Description
Retrieves a specific document collection identified by its unique ID. This endpoint provides detailed information about a single collection.

### Method
GET

### Endpoint
/api/v1/documentcollection/{id}/

### Parameters
#### Path Parameters
- **id** (integer) - Required - The unique identifier of the document collection.

#### Query Parameters
- **format** (string) - Optional - Specifies the desired output format. Allowed values: "csv", "json". Defaults to "json".

### Request Example
```json
{
  "example": "GET /api/v1/documentcollection/123/?format=json"
}
```

### Response
#### Success Response (200)
- **schema** (DocumentCollection) - The schema for a single document collection.

#### Response Example
```json
{
  "example": "[Document collection details in JSON or CSV format]"
}
```
```

--------------------------------

### GET /api/v1/attachment/{id}/

Source: https://fragdenstaat.de/api/v1/schema

Retrieves a specific attachment by its ID. The response format can be specified as JSON or CSV.

```APIDOC
## GET /api/v1/attachment/{id}/

### Description
Retrieves a specific attachment by its ID. The response format can be specified as JSON or CSV.

### Method
GET

### Endpoint
/api/v1/attachment/{id}/

### Parameters
#### Path Parameters
- **id** (integer) - Required - Ein eindeutiger Ganzzahl-Wert, der Anhang identifiziert.

#### Query Parameters
- **format** (string) - Optional - Enum: ["csv", "json"]

### Request Example
```json
{
  "example": "request body"
}
```

### Response
#### Success Response (200)
- **FoiAttachment** (object) - Description: Schema reference: #/components/schemas/FoiAttachment

#### Response Example
```json
{
  "example": "response body"
}
```
```

--------------------------------

### GET /api/v1/request/{id}/

Source: https://fragdenstaat.de/api/v1/schema

Retrieves a specific information request by its ID. The output format can be specified as CSV or JSON.

```APIDOC
## GET /api/v1/request/{id}/

### Description
Retrieves a specific information request identified by its unique ID. The response format can be specified as either CSV or JSON.

### Method
GET

### Endpoint
/api/v1/request/{id}/

### Parameters
#### Path Parameters
- **id** (integer) - Required - A unique integer value identifying the information request.

#### Query Parameters
- **format** (string) - Optional - Specifies the output format. Allowed values: `csv`, `json`.

### Request Example
```json
{
  "example": "request body"
}
```

### Response
#### Success Response (200)
- **(object)** - The detailed information request object, conforming to `#/components/schemas/FoiRequestDetail`. The format can be JSON or CSV.

#### Response Example
```json
{
  "example": "response body"
}
```
```

--------------------------------

### User Preference Schema

Source: https://fragdenstaat.de/api/v1/schema

Defines the structure for user preferences.

```APIDOC
## PatchedUserPreference Schema

### Description
Represents a user preference that can be updated.

### Schema Details

#### Properties
- **value** (string) - The new value for the user preference.
```

--------------------------------

### POST /api/v1/problemreport/{id}/escalate/

Source: https://fragdenstaat.de/api/v1/schema

Escalates a specific problem report. Requires authentication.

```APIDOC
## POST /api/v1/problemreport/{id}/escalate/

### Description
Escalates a specific problem report identified by its ID. This endpoint requires authentication.

### Method
POST

### Endpoint
/api/v1/problemreport/{id}/escalate/

### Parameters
#### Path Parameters
- **id** (integer) - Required - Ein eindeutiger Ganzzahl-Wert, der Problembericht identifiziert.

#### Query Parameters
- **format** (string) - Optional - Specifies the desired response format. Allowed values: "csv", "json".

#### Request Body
- **ProblemReport** (object) - Required - The schema for the problem report data.

### Request Example
```json
{
  "example": "ProblemReport object"
}
```

### Response
#### Success Response (200)
- **ProblemReport** (object) - The updated problem report object.

#### Response Example
```json
{
  "example": "ProblemReport object"
}
```
```

--------------------------------

### GET /api/v1/campaigninformationobject/{id}/

Source: https://fragdenstaat.de/api/v1/schema

Retrieves a specific campaign information object by its ID. Supports JSON and CSV formats.

```APIDOC
## GET /api/v1/campaigninformationobject/{id}/

### Description
Retrieves a specific campaign information object by its ID. The response format can be specified as JSON or CSV.

### Method
GET

### Endpoint
/api/v1/campaigninformationobject/{id}/

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the campaign information object.

#### Query Parameters
- **format** (string) - Optional - The desired response format. Accepted values: "csv", "json". Defaults to JSON if not specified.

### Request Example
```bash
GET /api/v1/campaigninformationobject/123/?format=json
```

### Response
#### Success Response (200)
- **schema** (object) - The schema for the InformationObject, returned in the requested format (JSON or CSV).

#### Response Example
```json
{
  "example": "JSON response body representing the InformationObject"
}
```
```csv
"example","csv","response","body"
```
```

--------------------------------

### GET /api/v1/publicbody/

Source: https://fragdenstaat.de/api/v1/schema

Retrieves a list of public bodies. Supports various response formats including JSON, CSV, and JavaScript.

```APIDOC
## GET /api/v1/publicbody/

### Description
Retrieves a list of public bodies.

### Method
GET

### Endpoint
/api/v1/publicbody/

### Parameters
#### Query Parameters
- **format** (string) - Optional - Specifies the desired response format (e.g., "csv", "json", "javascript").

### Request Example
```
GET /api/v1/publicbody/?format=json
```

### Response
#### Success Response (200)
- **PublicBodyList** (object) - A list of public bodies. The exact structure depends on the requested format.

#### Response Example
```json
{
  "example": "[PublicBodyList structure]"
}
```
```

--------------------------------

### GET /api/v1/publicbody/reconciliation/

Source: https://fragdenstaat.de/api/v1/schema

OpenRefine Reconciliation API endpoint for querying public bodies. Supports CSV, JSON, and JSONP formats.

```APIDOC
## GET /api/v1/publicbody/reconciliation/

### Description
This is an OpenRefine Reconciliation API endpoint, designed to work with tools like OpenRefine for data cleaning and reconciliation. It allows querying public bodies based on various criteria. Refer to https://github.com/OpenRefine/OpenRefine/wiki/Reconciliation-Service-API for more details on the Reconciliation Service API.

### Method
GET

### Endpoint
/api/v1/publicbody/reconciliation/

### Parameters
#### Query Parameters
- **format** (string) - Optional - Specifies the desired response format. Allowed values: "csv", "json", "jsonp".

### Request Example
```json
{
  "example": "GET /api/v1/publicbody/reconciliation/?format=json"
}
```

### Response
#### Success Response (200)
- **PublicBodyList** (object) - A list of public bodies matching the reconciliation query. The exact structure depends on the requested format.
```

--------------------------------

### POST /api/v1/georegion/reconciliation-suggest-service/

Source: https://fragdenstaat.de/api/v1/schema

Implements the OpenRefine Suggest Entry Point for georegions using a POST request. This endpoint allows sending data in the request body and supports multiple response formats.

```APIDOC
## POST /api/v1/georegion/reconciliation-suggest-service/

### Description
Implements OpenRefine Suggest Entry Point (https://github.com/OpenRefine/OpenRefine/wiki/Suggest-API#suggest-entry-point). Only implements prefix.

### Method
POST

### Endpoint
/api/v1/georegion/reconciliation-suggest-service/

### Parameters
#### Query Parameters
- **format** (string) - Optional - Specifies the desired response format. Allowed values: "csv", "json", "jsonp".

#### Request Body
- **GeoRegion** (object) - Required - Contains georegion data to be processed.

### Request Example
```json
{
  "example": "request body"
}
```

### Response
#### Success Response (200)
- **GeoRegion** (object) - Contains georegion data.

#### Response Example
```json
{
  "example": "response body"
}
```
```

--------------------------------

### GET /api/v1/georegion/reconciliation/

Source: https://fragdenstaat.de/api/v1/schema

Provides a reconciliation service for geographic regions, compatible with OpenRefine. Supports CSV, JSON, and JSONP formats.

```APIDOC
## GET /api/v1/georegion/reconciliation/

### Description
This endpoint implements the OpenRefine Reconciliation API for geographic regions. It allows for matching and disambiguating geographic entities.

### Method
GET

### Endpoint
/api/v1/georegion/reconciliation/

### Parameters
#### Query Parameters
- **format** (string) - Optional - Specifies the desired output format. Allowed values: `csv`, `json`, `jsonp`.

### Request Example
```
GET /api/v1/georegion/reconciliation/?format=json
```

### Response
#### Success Response (200)
- **GeoRegion** (object) - Contains reconciliation results for geographic regions. The exact structure depends on the requested format.

#### Response Example (JSON)
```json
{
  "example": "{\"result": [{"id": "Q123", "name": "Berlin", "score": 0.95}] }"
}
```
```

--------------------------------

### Security Schemes

Source: https://fragdenstaat.de/api/v1/schema

This section details the security schemes available for authenticating with the FragDenStaat API, including cookie-based session authentication and OAuth2.

```APIDOC
## Security Schemes

### Description
Details the authentication methods supported by the API.

### Security Schemes

#### cookieAuth
- **Type**: `apiKey`
- **In**: `cookie`
- **Name**: `sessionid`

#### oauth2
- **Type**: `oauth2`
- **Flows**: (Details of OAuth2 flows would be listed here if provided)
```

--------------------------------

### Public Body Search

Source: https://fragdenstaat.de/api/v1/schema

Allows searching for public bodies. This endpoint supports GET requests and allows specifying the response format.

```APIDOC
## GET /api/v1/publicbody/search/

### Description
Allows searching for public bodies.

### Method
GET

### Endpoint
/api/v1/publicbody/search/

### Query Parameters
- **format** (string) - Optional - Specifies the response format. Allowed values: `csv`, `json`, `jsonp`.

### Response
#### Success Response (200)
- **[Response Schema]** - The schema for the search results will depend on the format requested.

#### Response Example
```json
{
  "example": "[Search results object structure]"
}
```
```

--------------------------------

### User Preference API

Source: https://fragdenstaat.de/api/v1/schema/swagger-ui

Endpoints for managing user preferences.

```APIDOC
## User Preference API

### Description
Manages user preferences, allowing for retrieval, setting, updating, and patching preferences by key.

### Endpoints

#### Retrieve a user preference by key
- **Method**: GET
- **Endpoint**: `/api/v1/userpreference/{key}/`

#### Set or update a user preference by key
- **Method**: POST, PUT, PATCH
- **Endpoint**: `/api/v1/userpreference/{key}/`
```

--------------------------------

### POST /api/v1/problemreport/{id}/resolve/

Source: https://fragdenstaat.de/api/v1/schema

Resolves a specific problem report. Requires authentication.

```APIDOC
## POST /api/v1/problemreport/{id}/resolve/

### Description
Resolves a specific problem report identified by its ID. This endpoint requires authentication.

### Method
POST

### Endpoint
/api/v1/problemreport/{id}/resolve/

### Parameters
#### Path Parameters
- **id** (integer) - Required - Ein eindeutiger Ganzzahl-Wert, der Problembericht identifiziert.

#### Query Parameters
- **format** (string) - Optional - Specifies the desired response format. Allowed values: "csv", "json".

#### Request Body
- **ProblemReport** (object) - Required - The schema for the problem report data.

### Request Example
```json
{
  "example": "ProblemReport object"
}
```

### Response
#### Success Response (200)
- **ProblemReport** (object) - The updated problem report object.

#### Response Example
```json
{
  "example": "ProblemReport object"
}
```
```

--------------------------------

### POST /api/v1/campaigninformationobject/report/

Source: https://fragdenstaat.de/api/v1/schema

Creates a report for campaign information objects. The request body can be in JSON, form-urlencoded, or multipart/form-data format, and the response can be in JSON or CSV.

```APIDOC
## POST /api/v1/campaigninformationobject/report/

### Description
Creates a report for campaign information objects. This endpoint accepts various content types for the request body and supports JSON or CSV for the response.

### Method
POST

### Endpoint
/api/v1/campaigninformationobject/report/

### Parameters
#### Query Parameters
- **format** (string) - Optional - The desired response format for the report. Accepted values: "csv", "json". Defaults to JSON if not specified.

#### Request Body
- **schema** (object) - Required - The schema for the InformationObject, which defines the data for the report. Accepted formats: application/json, application/x-www-form-urlencoded, multipart/form-data.

### Request Example
```json
{
  "example": "JSON request body defining the InformationObject for the report"
}
```

### Response
#### Success Response (200)
- **schema** (object) - The generated report data, returned in the requested format (JSON or CSV).

#### Response Example
```json
{
  "example": "JSON response body representing the generated report"
}
```
```csv
"example","csv","response","body"
```
```

--------------------------------

### GeoRegion Reconciliation Flyout API

Source: https://fragdenstaat.de/api/v1/schema

This endpoint implements the OpenRefine Flyout Entry Point for GeoRegions. It supports both GET and POST requests and allows specifying the response format.

```APIDOC
## GET /api/v1/georegion/reconciliation-flyout/

### Description
Implements OpenRefine Flyout Entry Point for GeoRegions. Allows retrieving reconciliation data.

### Method
GET

### Endpoint
/api/v1/georegion/reconciliation-flyout/

### Parameters
#### Query Parameters
- **format** (string) - Optional - Specifies the response format. Allowed values: "csv", "json", "jsonp".

### Response
#### Success Response (200)
- **schema** (GeoRegion) - The schema for the GeoRegion data.

#### Response Example
```json
{
  "example": "GeoRegion schema details"
}
```

## POST /api/v1/georegion/reconciliation-flyout/

### Description
Implements OpenRefine Flyout Entry Point for GeoRegions. Allows creating or updating reconciliation data via POST request.

### Method
POST

### Endpoint
/api/v1/georegion/reconciliation-flyout/

### Parameters
#### Query Parameters
- **format** (string) - Optional - Specifies the response format. Allowed values: "csv", "json", "jsonp".

#### Request Body
- **schema** (GeoRegion) - Required - The schema for the GeoRegion data to be processed.

### Request Example
```json
{
  "example": "GeoRegion schema details"
}
```

### Response
#### Success Response (200)
- **schema** (GeoRegion) - The schema for the GeoRegion data.

#### Response Example
```json
{
  "example": "GeoRegion schema details"
}
```
```

--------------------------------

### POST /api/v1/request/

Source: https://fragdenstaat.de/api/v1/schema

Creates a new information request. Supports JSON, form-urlencoded, and multipart/form-data for request bodies. The output format can be specified as CSV or JSON.

```APIDOC
## POST /api/v1/request/

### Description
Creates a new information request. The request body can be provided in JSON, form-urlencoded, or multipart/form-data format. The response format can be specified as either CSV or JSON.

### Method
POST

### Endpoint
/api/v1/request/

### Parameters
#### Query Parameters
- **format** (string) - Optional - Specifies the output format. Allowed values: `csv`, `json`.

#### Request Body
- **(object)** - Required - The schema for creating a request, defined in `#/components/schemas/MakeRequest`.

### Request Example
```json
{
  "example": "request body"
}
```

### Response
#### Success Response (201)
- **(object)** - The created request object, conforming to `#/components/schemas/MakeRequest`. The format can be JSON or CSV.

#### Response Example
```json
{
  "example": "response body"
}
```
```

--------------------------------

### Public Body Reconciliation Properties API

Source: https://fragdenstaat.de/api/v1/schema

This API implements the OpenRefine Data Extension API for proposing properties related to public bodies. It supports both GET and POST requests.

```APIDOC
## GET /api/v1/publicbody/reconciliation-propose-properties/

### Description
Implements OpenRefine Data Extension API for proposing properties related to public bodies.

### Method
GET

### Endpoint
/api/v1/publicbody/reconciliation-propose-properties/

### Parameters
#### Query Parameters
- **format** (string) - Optional - Specifies the desired response format. Allowed values: `csv`, `json`, `jsonp`.

### Response
#### Success Response (200)
- **schema** (object) - Reference to the `PublicBodyList` schema.

#### Response Example
```json
{
  "example": "PublicBodyList schema response"
}
```

## POST /api/v1/publicbody/reconciliation-propose-properties/

### Description
Implements OpenRefine Data Extension API for proposing properties related to public bodies. This endpoint accepts a request body.

### Method
POST

### Endpoint
/api/v1/publicbody/reconciliation-propose-properties/

### Parameters
#### Query Parameters
- **format** (string) - Optional - Specifies the desired response format. Allowed values: `csv`, `json`, `jsonp`.

#### Request Body
- **schema** (object) - Required - Reference to the `PublicBodyList` schema.

### Request Example
```json
{
  "example": "PublicBodyList schema request"
}
```

### Response
#### Success Response (200)
- **schema** (object) - Reference to the `PublicBodyList` schema.

#### Response Example
```json
{
  "example": "PublicBodyList schema response"
}
```
```

--------------------------------

### Public Body Reconciliation Flyout API

Source: https://fragdenstaat.de/api/v1/schema

This endpoint implements the OpenRefine Flyout Entry Point for public body reconciliation. It supports GET and POST requests and allows specifying the response format.

```APIDOC
## GET /api/v1/publicbody/reconciliation-flyout/

### Description
Implements OpenRefine Flyout Entry Point for public body reconciliation. Allows retrieving public body data in various formats.

### Method
GET

### Endpoint
/api/v1/publicbody/reconciliation-flyout/

### Parameters
#### Query Parameters
- **format** (string) - Optional - Specifies the desired response format. Allowed values: "csv", "json", "jsonp".

### Response
#### Success Response (200)
- **PublicBodyList** (object) - A list of public bodies.

#### Response Example
```json
{
  "example": "[PublicBodyList object structure]"
}
```

## POST /api/v1/publicbody/reconciliation-flyout/

### Description
Implements OpenRefine Flyout Entry Point for public body reconciliation. Allows submitting data for reconciliation via POST request.

### Method
POST

### Endpoint
/api/v1/publicbody/reconciliation-flyout/

### Parameters
#### Query Parameters
- **format** (string) - Optional - Specifies the desired response format. Allowed values: "csv", "json", "jsonp".

#### Request Body
- **PublicBodyList** (object) - Required - The data to be reconciled, expected in JSON, form-urlencoded, or multipart/form-data format.

### Request Example
```json
{
  "example": "[PublicBodyList object structure]"
}
```

### Response
#### Success Response (200)
- **PublicBodyList** (object) - A list of public bodies.

#### Response Example
```json
{
  "example": "[PublicBodyList object structure]"
}
```
```
Tokens:
Raw