TableEntryCollection

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/blackbaud/main/json-schema/blackbaud-table-entry-collection-schema.json",
  "title": "TableEntryCollection",
  "description": "Defines a collection of table entries.",
  "x-generated": "2026-10-14",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/blackbaud-code-table-api-openapi.yml#/components/schemas/TableEntryCollection",
  "type": "object",
  "properties": {
    "count": {
      "type": "integer",
      "format": "int32"
    },
    "value": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "$ref": "#/$defs/TableEntry"
      }
    }
  },
  "additionalProperties": false,
  "$defs": {
    "PhoneFormat": {
      "enum": [
        "None",
        "Mask1",
        "Mask2",
        "Mask3",
        "Mask4",
        "Mask5",
        "Mask6",
        "Mask7",
        "Mask8",
        "Mask9",
        "Mask10",
        "Mask11"
      ],
      "type": "string",
      "description": "<p>Members:</p><ul><li><i>None</i></li><li><i>Mask1</i></li><li><i>Mask2</i></li><li><i>Mask3</i></li><li><i>Mask4</i></li><li><i>Mask5</i></li><li><i>Mask6</i></li><li><i>Mask7</i></li><li><i>Mask8</i></li><li><i>Mask9</i></li><li><i>Mask10</i></li><li><i>Mask11</i></li></ul>"
    },
    "PhoneNumberType": {
      "enum": [
        "TelephoneNumber",
        "FaxNumber",
        "EmailAddress",
        "WebAddressUrl",
        "Other"
      ],
      "type": "string",
      "description": "<p>Members:</p><ul><li><i>TelephoneNumber</i></li><li><i>FaxNumber</i></li><li><i>EmailAddress</i></li><li><i>WebAddressUrl</i></li><li><i>Other</i></li></ul>"
    },
    "RatingsDataType": {
      "enum": [
        "Text",
        "Number",
        "Date",
        "Currency",
        "Boolean",
        "Table"
      ],
      "type": "string",
      "description": "<p>Members:</p><ul><li><i>Text</i></li><li><i>Number</i></li><li><i>Date</i></li><li><i>Currency</i></li><li><i>Boolean</i></li><li><i>Table</i></li></ul>"
    },
    "TableEntry": {
      "type": "object",
      "properties": {
        "table_entries_id": {
          "type": [
            "string",
            "null"
          ],
          "description": "The ID of the table entry."
        },
        "is_active": {
          "type": "boolean",
          "description": "The active status of the entry."
        },
        "long_description": {
          "type": [
            "string",
            "null"
          ],
          "description": "The long description of the entry."
        },
        "short_description": {
          "type": [
            "string",
            "null"
          ],
          "description": "The short description of the entry. Only supported by entries of certain tables, such as constituent codes."
        },
        "numeric_value": {
          "type": [
            "number",
            "null"
          ],
          "description": "The numeric value of the entry. Also known as minimum amount for Gift/Donor table entries.",
          "format": "double"
        },
        "sequence": {
          "type": [
            "integer",
            "null"
          ],
          "description": "The sequence of the table entry.",
          "format": "int32"
        },
        "is_system_entry": {
          "type": "boolean",
          "description": "The value indicating whether the entry is a system entry."
        },
        "code_tables_id": {
          "type": [
            "string",
            "null"
          ],
          "description": "The ID associated with the record's code table."
        },
        "date_added": {
          "type": [
            "string",
            "null"
          ],
          "description": "The date on which the record was added.",
          "format": "date-time"
        },
        "date_changed": {
          "type": [
            "string",
            "null"
          ],
          "description": "The date on which the record was last changed.",
          "format": "date-time"
        },
        "added_by_id": {
          "type": [
            "string",
            "null"
          ],
          "description": "The ID of the user who added the record."
        },
        "last_changed_by_id": {
          "type": [
            "string",
            "null"
          ],
          "description": "The ID of the user who last changed the record."
        },
        "code_tables_name": {
          "type": [
            "string",
            "null"
          ],
          "description": "The name of the code table the table entry belongs to."
        },
        "phone_format": {
          "$ref": "#/$defs/PhoneFormat"
        },
        "phone_type": {
          "$ref": "#/$defs/PhoneNumberType"
        },
        "ratings_data_type": {
          "$ref": "#/$defs/RatingsDataType"
        },
        "table_number": {
          "type": [
            "string",
            "null"
          ],
          "description": "For ratings type table entries that are of table data type, the table used as the possible rating values."
        }
      },
      "additionalProperties": false,
      "description": "A Table entry record."
    }
  }
}