API · v1 · stabil
CODEMETA OSDeveloper Center
Konsole öffnen
Entity · survey_invitations

Survey Invitation Schema

Schema-ID
survey_invitation
Collection
survey_invitations
Permissions
  • Lesensurvey_invitation_view
  • Anlegensurvey_invitation_create
  • Ändernsurvey_invitation_edit
  • Löschensurvey_invitation_delete
Beziehungen

Felder

Survey Invitation Schema

survey_invitations4 Permissions

Schema for satisfaction survey invitations sent to contacts

surveyIduuiderforderlich→ survey

FK to survey

modestringoptional

Delivery mode — single-ticket invitation or weekly digest spanning multiple tickets

Werte
per_ticketweekly_digest
Default: "per_ticket"
ticketIduuidoptional→ ticket

FK to ticket (required for mode = per_ticket)

nullable
ticketNumberstringoptional
max 50 Zeichennullable
digestTicketsobject[]optional

Tickets included in a weekly digest invitation (mode = weekly_digest)

Default: []nullable
ticketIduuiderforderlich→ ticket
ticketNumberstringerforderlich
max 50 Zeichen
titlestringoptional
max 500 Zeichennullable
closedAtdatetimeoptional
nullable
ratedAtdatetimeoptional
nullable
responseIduuidoptional
nullable
weekOfdatetimeoptional

ISO-week start (Monday 00:00 UTC) covered by a digest invitation

nullable
partyIduuidoptional
nullable
contactPartyIduuidoptional
nullable
contactIduuidoptional
nullable
contactEmailemailerforderlich
contactNamestringoptional
nullable
statusstringerforderlich
Werte
PENDINGSENTDELIVEREDOPENEDCOMPLETEDEXPIREDCANCELLED
sentAtdatetimeoptional
nullable
openedAtdatetimeoptional
nullable
respondedAtdatetimeoptional
nullable
responseIduuidoptional
nullable
remindersSentnumberoptional
≥ 0Default: 0
lastReminderAtdatetimeoptional
nullable
expiresAtdatetimeerforderlich
surveyUrlstringoptional
max 500 Zeichennullable

Standard-Endpoints

Diese Resource folgt dem generischen CRUD-Vertrag der Plattform. Lesen Sie die Konventionen für Pagination, Idempotenz, Optimistic Locking und Audit. Die wichtigsten Endpoints:

  • GET /api/v1/survey_invitations — Liste, paginiert + filterbar
  • GET /api/v1/survey_invitations/<id> — Einzelne Entity
  • POST /api/v1/survey_invitations — Anlegen
  • PATCH /api/v1/survey_invitations/<id> — Teil-Update
  • DELETE /api/v1/survey_invitations/<id> — Soft-Delete
  • GET /api/v1/survey_invitations/<id>/timeline — Audit + Aktivitäten

Suche