JobOccurrence

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/blackbaud/main/json-schema/blackbaud-job-occurrence-schema.json",
  "title": "JobOccurrence",
  "description": "GetJobOccurrence",
  "x-generated": "2026-10-14",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/blackbaud-altru-volunteer-api-openapi.yml#/components/schemas/JobOccurrence",
  "required": [
    "description",
    "day_of_week"
  ],
  "type": "object",
  "properties": {
    "description": {
      "maxLength": 30,
      "minLength": 0,
      "type": "string",
      "description": "The occurrence name."
    },
    "department": {
      "type": "string",
      "description": "The department. This code table can be queried at https://api.sky.blackbaud.com/alt-adnmg/codetables/departmentcode/entries"
    },
    "location": {
      "type": "string",
      "description": "The location. This code table can be queried at https://api.sky.blackbaud.com/alt-adnmg/codetables/volunteerlocationcode/entries"
    },
    "type": {
      "type": "string",
      "description": "The type. Available values are <i>one time</i>, <i>recurring</i>, <i>recurring over date range</i>, <i>ongoing</i>"
    },
    "start_date": {
      "type": "string",
      "description": "The start date. Uses the format YYYY-MM-DDThh:mm:ss. An example date: <i>1955-11-05T22:04:00</i>.",
      "format": "date-time"
    },
    "end_date": {
      "type": "string",
      "description": "The end date. Uses the format YYYY-MM-DDThh:mm:ss. An example date: <i>1955-11-05T22:04:00</i>.",
      "format": "date-time"
    },
    "start_month_day": {
      "$ref": "#/$defs/MonthDay"
    },
    "end_month_day": {
      "$ref": "#/$defs/MonthDay"
    },
    "one_start_time": {
      "$ref": "#/$defs/HourMinute"
    },
    "one_end_time": {
      "$ref": "#/$defs/HourMinute"
    },
    "rec_start_time": {
      "$ref": "#/$defs/HourMinute"
    },
    "rec_end_time": {
      "$ref": "#/$defs/HourMinute"
    },
    "day_of_week": {
      "type": "string",
      "description": "The day of week. Available values are <i>every day</i>, <i>sunday</i>, <i>monday</i>, <i>tuesday</i>, <i>wednesday</i>, <i>thursday</i>, <i>friday</i>, <i>saturday</i>, <i>weekends</i>, <i>weekdays</i>"
    },
    "event_id": {
      "type": "string",
      "description": "The event."
    },
    "volunteers_needed": {
      "type": "integer",
      "description": "The volunteers needed.",
      "format": "int32"
    },
    "comments": {
      "type": "string",
      "description": "The comment."
    },
    "site_id": {
      "type": "string",
      "description": "The site."
    },
    "site_required": {
      "type": "boolean",
      "description": "Indicates whether site required. Read-only in the SOAP API."
    },
    "base_currency_id": {
      "type": "string",
      "description": "The base currency. Read-only in the SOAP API."
    },
    "estimated_value": {
      "type": "number",
      "description": "The estimated value.",
      "format": "double"
    },
    "recurrence_start_date": {
      "type": "string",
      "description": "The start date. Uses the format YYYY-MM-DDThh:mm:ss. An example date: <i>1955-11-05T22:04:00</i>.",
      "format": "date-time"
    },
    "recurrence_end_date": {
      "type": "string",
      "description": "The end date. Uses the format YYYY-MM-DDThh:mm:ss. An example date: <i>1955-11-05T22:04:00</i>.",
      "format": "date-time"
    }
  },
  "additionalProperties": false,
  "x-display-name": "Job Occurrence Edit Form 1.1",
  "x-display-id": "Job Occurrence Edit Form 1.1",
  "$defs": {
    "HourMinute": {
      "type": "object",
      "properties": {
        "hour": {
          "type": "integer",
          "description": "The hour.",
          "format": "int32"
        },
        "minute": {
          "type": "integer",
          "description": "The minute.",
          "format": "int32"
        }
      },
      "description": "HourMinute",
      "x-display-name": "Hour Minute",
      "x-display-id": "Hour Minute"
    },
    "MonthDay": {
      "type": "object",
      "properties": {
        "month": {
          "type": "integer",
          "description": "The month.",
          "format": "int32"
        },
        "day": {
          "type": "integer",
          "description": "The day.",
          "format": "int32"
        }
      },
      "description": "MonthDay",
      "x-display-name": "Month Day",
      "x-display-id": "Month Day"
    }
  }
}