book_appointment

Diese Referenz wird aus dem veröffentlichten Werkzeugvertrag erzeugt. Feldnamen und normative Beschreibungen im Schema sind Englisch.

Verhalten und Grenzen

Bucht einen Termin einer Terminart für eine andere Person. Ridian trägt den Termin im Kalender der Gastgeber ein und schickt der buchenden Person eine Bestätigung mit Link zum Verschieben oder Absagen. Eine Startzeit aus find_booking_slots verwenden. Eine feste request_id mitschicken; dieselbe request_id liefert dieselbe Buchung statt einer zweiten. Name, E-Mail und Zeit vorher mit dem Nutzer bestätigen.

Berechtigungen

Freigegebene Scopes, Konten, Kalender und Sichtbarkeitsregeln begrenzen den Zugriff. Ein Workspace-Admin erhält dadurch keinen pauschalen Zugriff auf fremde Konten.

bookings:write

Freigaben und Grenzen

Eingabe

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "appointment_type_id": {
      "type": "string",
      "minLength": 1,
      "maxLength": 64,
      "description": "appointment_type_id from list_appointment_types."
    },
    "start": {
      "type": "string",
      "maxLength": 40
    },
    "booker_name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 200
    },
    "booker_email": {
      "type": "string",
      "maxLength": 320,
      "format": "email",
      "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
    },
    "booker_time_zone": {
      "type": "string",
      "maxLength": 64,
      "description": "IANA time zone of the booker for the confirmation email, e.g. \"Europe/Berlin\"."
    },
    "language": {
      "description": "Language of the confirmation email. Default de.",
      "type": "string",
      "enum": [
        "de",
        "en"
      ]
    },
    "request_id": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]{8,128}$",
      "description": "Stable id for this booking: 8–128 letters, digits, _ or -."
    }
  },
  "required": [
    "appointment_type_id",
    "start",
    "booker_name",
    "booker_email",
    "booker_time_zone",
    "request_id"
  ],
  "additionalProperties": false
}

Ausgabe

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "booking_id": {
      "type": "string"
    },
    "created": {
      "type": "boolean"
    }
  },
  "required": [
    "booking_id",
    "created"
  ],
  "additionalProperties": false
}

Fehler und Wiederholungen

Prüfe das Werkzeugergebnis auf Fehler. Wiederhole Schreiboperationen nicht blind nach einem Timeout. Prüfe zuerst den aktuellen Ressourcen- oder Sendestatus.

Fehlerbehandlung