Webex · Schema

HolidayListDTO

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name	Type	Description
organizationId	string	ID of the contact center organization. This field is required for all bulk save operations.
id	string	ID of this contact center resource. It should not be specified when creating a new resource. However, it is mandatory when updating a resource.
version	integer	The version of this resource. For a newly created resource, it will be 0 unless specified otherwise.
name	string	Enter a name for the holiday list.
description	string	(Optional) Enter a description of the holiday list.
holidays	array	Holiday list.
holidaysCount	integer
createdTime	integer	This is the created time of the entity.
lastUpdatedTime	integer	This is the updated time of the entity.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/HolidayListDTO",
  "title": "HolidayListDTO",
  "type": "object",
  "properties": {
    "organizationId": {
      "type": "string",
      "format": "uuid",
      "description": "ID of the contact center organization. This field is required for all bulk save operations.",
      "example": "f53c8b54-46ca-43f6-ba05-08426a46e23d",
      "maxLength": 36,
      "minLength": 32,
      "pattern": "^[0-9a-fA-F]{8}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{12}$"
    },
    "id": {
      "type": "string",
      "description": "ID of this contact center resource. It should not be specified when creating a new resource. However, it is mandatory when updating a resource.",
      "example": "93912f11-6017-404b-bf14-5331890b1797"
    },
    "version": {
      "type": "integer",
      "format": "int32",
      "description": "The version of this resource. For a newly created resource, it will be 0 unless specified otherwise.",
      "example": 1
    },
    "name": {
      "type": "string",
      "description": "Enter a name for the holiday list.",
      "example": "Holiday List 2022",
      "maxLength": 80,
      "minLength": 0,
      "pattern": "^[a-zA-Z0-9_-]+(\\s?[a-zA-Z0-9_-]+)*$"
    },
    "description": {
      "type": "string",
      "description": "(Optional) Enter a description of the holiday list.",
      "example": "This is a holiday list for year 2022.",
      "maxLength": 255,
      "minLength": 0
    },
    "holidays": {
      "type": "array",
      "description": "Holiday list.",
      "example": {
        "name": "My Holiday List",
        "description": "My Holiday List Desc",
        "holidays": [
          {
            "name": "Holi",
            "startDate": "2022-04-16",
            "endDate": "2022-04-16",
            "frequency": "Yearly",
            "recurrence": {
              "interval": 1,
              "specificDayOfMonth": 16,
              "specificMonth": "APR",
              "endDate": "2030-12-24"
            }
          },
          {
            "name": "Good Friday",
            "startDate": "2022-05-24",
            "endDate": "2022-05-24",
            "frequency": "Yearly",
            "recurrence": {
              "interval": 1,
              "specificDayOfMonth": 24,
              "specificMonth": "MAY",
              "endDate": "2030-12-24"
            }
          }
        ],
        "id": "93912f11-6017-404b-bf14-5331890b1797",
        "organizationId": "f53c8b54-46ca-43f6-ba05-08426a46e23d",
        "createdTime": 1628231177000,
        "lastUpdatedTime": 1628231177000
      },
      "items": {
        "$ref": "#/components/schemas/HolidaysDTO"
      },
      "minItems": 1
    },
    "holidaysCount": {
      "type": "integer",
      "format": "int64"
    },
    "createdTime": {
      "type": "integer",
      "format": "int64",
      "description": "This is the created time of the entity.",
      "example": 123456789
    },
    "lastUpdatedTime": {
      "type": "integer",
      "format": "int64",
      "description": "This is the updated time of the entity.",
      "example": 123456789
    }
  },
  "required": [
    "holidays",
    "name"
  ]
}