NewVolunteerSchedule

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/blackbaud/main/json-schema/blackbaud-new-volunteer-schedule-schema.json",
  "title": "NewVolunteerSchedule",
  "description": "CreateVolunteerSchedule",
  "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/NewVolunteerSchedule",
  "required": [
    "job_occurrence_id",
    "start_date",
    "end_date"
  ],
  "type": "object",
  "properties": {
    "job_occurrence_id": {
      "type": "string",
      "description": "The job occurrence ID."
    },
    "single_day_edit": {
      "type": "boolean",
      "description": "Indicates whether single day edit."
    },
    "job_name": {
      "maxLength": 50,
      "minLength": 0,
      "type": "string",
      "description": "The job. Read-only in the SOAP API."
    },
    "occurrence_name": {
      "maxLength": 30,
      "minLength": 0,
      "type": "string",
      "description": "The occurrence. Read-only in the SOAP API."
    },
    "start_date": {
      "type": "string",
      "description": "The dates. 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"
    },
    "starttime": {
      "$ref": "#/$defs/HourMinute"
    },
    "endtime": {
      "$ref": "#/$defs/HourMinute"
    },
    "volunteers": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/NewVolunteerScheduleVolunteers"
      },
      "description": "Volunteers."
    },
    "needed": {
      "type": "integer",
      "description": "The needed. Read-only in the SOAP API.",
      "format": "int32"
    }
  },
  "additionalProperties": false,
  "x-display-name": "Assign Volunteers Add Data Form",
  "x-display-id": "Assign Volunteers Add Data Form",
  "$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"
    },
    "NewVolunteerScheduleVolunteers": {
      "type": "object",
      "properties": {
        "volunteer_id": {
          "type": "string",
          "description": "volunteerid"
        },
        "volunteer_assignment_id": {
          "type": "string",
          "description": "volunteerassignmentid"
        },
        "assign": {
          "type": "boolean",
          "description": "assign"
        },
        "volunteer_name": {
          "type": "string",
          "description": "volunteer name"
        },
        "match": {
          "type": "string",
          "description": "percent match"
        }
      },
      "description": "NewVolunteerScheduleVolunteers",
      "x-display-name": "volunteers",
      "x-display-id": "volunteers"
    }
  }
}