create_absence

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

Verhalten und Grenzen

Trägt eine Abwesenheit ein, für dich selbst oder als Owner bzw. Admin für ein anderes Mitglied, z. B. „Ich bin nächste Woche im Urlaub“. Ganztägig mit first_day und last_day (letzter Tag inklusive), sonst start und end mit Offset. Während der Abwesenheit hat das Mitglied keine freien Zeiten, Round Robin überspringt es, und Collective-Terminarten bieten keine Zeit an. Bestehende Buchungen bleiben beim Mitglied; das Ergebnis listet sie, damit du reassign_booking anbieten kannst. Den Zeitraum 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": {
    "user_id": {
      "description": "Member who is absent. Default: you.",
      "type": "string",
      "minLength": 1,
      "maxLength": 64
    },
    "all_day": {
      "type": "boolean"
    },
    "first_day": {
      "description": "All-day: first day.",
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}$"
    },
    "last_day": {
      "description": "All-day: last day, inclusive.",
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}$"
    },
    "start": {
      "description": "Not all-day: start with offset.",
      "type": "string",
      "maxLength": 40
    },
    "end": {
      "description": "Not all-day: end with offset.",
      "type": "string",
      "maxLength": 40
    },
    "time_zone": {
      "description": "IANA time zone for all-day dates. Default: the member's availability time zone.",
      "type": "string",
      "maxLength": 64
    },
    "reason": {
      "type": "string",
      "enum": [
        "vacation",
        "sick",
        "training",
        "other"
      ]
    },
    "substitute_user_id": {
      "description": "Member who covers. From list_absences members.",
      "type": "string",
      "minLength": 1,
      "maxLength": 64
    },
    "link_substitute_on_profile": {
      "description": "Show a link to the substitute's booking page on the member's profile page. Default false.",
      "type": "boolean"
    }
  },
  "required": [
    "all_day",
    "reason"
  ],
  "additionalProperties": false
}

Ausgabe

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "absence": {
      "type": "object",
      "properties": {
        "absence_id": {
          "type": "string"
        },
        "user_id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "start": {
          "type": "string"
        },
        "end": {
          "type": "string"
        },
        "all_day": {
          "type": "boolean"
        },
        "first_day": {
          "type": [
            "string",
            "null"
          ]
        },
        "last_day": {
          "type": [
            "string",
            "null"
          ]
        },
        "time_zone": {
          "type": "string"
        },
        "reason": {
          "anyOf": [
            {
              "type": "string",
              "enum": [
                "vacation",
                "sick",
                "training",
                "other"
              ]
            },
            {
              "type": "null"
            }
          ]
        },
        "substitute": {
          "anyOf": [
            {
              "type": "object",
              "properties": {
                "user_id": {
                  "type": "string"
                },
                "name": {
                  "type": "string"
                }
              },
              "required": [
                "user_id",
                "name"
              ],
              "additionalProperties": false
            },
            {
              "type": "null"
            }
          ]
        }
      },
      "required": [
        "absence_id",
        "user_id",
        "name",
        "start",
        "end",
        "all_day",
        "first_day",
        "last_day",
        "time_zone",
        "reason",
        "substitute"
      ],
      "additionalProperties": false
    },
    "affected_bookings": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "booking_id": {
            "type": "string"
          },
          "start": {
            "type": "string"
          },
          "appointment_type": {
            "type": [
              "string",
              "null"
            ]
          },
          "can_reassign": {
            "type": "boolean"
          }
        },
        "required": [
          "booking_id",
          "start",
          "appointment_type",
          "can_reassign"
        ],
        "additionalProperties": false
      }
    },
    "console_url": {
      "type": "string"
    }
  },
  "required": [
    "absence",
    "affected_bookings",
    "console_url"
  ],
  "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