Skip to main content
POST
This page documents a frozen v1 API. It receives only critical correctness or security corrections. For new integrations, use the current API and follow the linked migration guide.

Autorisierungen

Authorization
string
header
erforderlich

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Pfadparameter

mandate_id
string<uuid>
erforderlich
request_id
string
erforderlich

Body

Serializer for creating/submitting an answer to a RequestToClient.

The required fields depend on the RequestToClient's allowed_answer_types:

  • yes-no: text must be "yes" or "no"
  • yes-no-dontknow: text must be "yes", "no", or "dontknow"
  • fileupload: files are required, text is optional comment
  • yes-no-freetext-on-no: text must be "yes" or "no", additional_comment required if "no"
  • yes-with-date-no-freetext-on-no: text must be date (if yes) or "no", additional_comment if "no"
  • freetext: text is required
text
string | null

The answer text. Required for most answer types. For yes-no types, use "yes", "no", or "dontknow".

Maximum string length: 5000
additional_comment
string | null

Additional comment. Required for "no" answers in yes-no-freetext-on-no type.

Maximum string length: 5000

Antwort

200 - application/json

Main serializer for RequestToClient in the Public API. Provides full detail view for GET requests.

id
string
erforderlich
read-only
href
string
erforderlich
read-only
mandate
object
erforderlich

Minimal mandate info for RequestToClient responses.

title
string
erforderlich
read-only
description
string | null
erforderlich
read-only
allowed_answer_types
erforderlich
  • None - ---------
  • yes-no - Ja/Nein
  • yes-no-dontknow - Ja/Nein/Weiß nicht
  • fileupload - Freitext + Dateiupload
  • yes-no-freetext-on-no - Ja/Nein + Freitext bei Nein
  • yes-with-date-no-freetext-on-no - Ja + Datum / Nein + Freitext
  • dynamic-form - Dynamisches Formular
Verfügbare Optionen:
yes-no,
yes-no-dontknow,
fileupload,
yes-no-freetext-on-no,
yes-with-date-no-freetext-on-no,
dynamic-form
file_attachments
object[]
erforderlich
read-only
answered
boolean
erforderlich
read-only
answer
object
erforderlich

Read-only serializer for displaying answers. Shows text, additional comment, and uploaded files.

created
string<date-time>
erforderlich
read-only
answered_at
string<date-time> | null
erforderlich
read-only