{
  "opencollection": "1.0.0",
  "info": {
    "name": "Webex Admin Address Book Location Call Settings:  Schedules API",
    "version": "1.0.0"
  },
  "items": [
    {
      "info": {
        "name": "Location Call Settings:  Schedules",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Read the List of Schedules",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/telephony/config/locations/:locationId/schedules",
            "params": [
              {
                "name": "locationId",
                "value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzMxMTYx",
                "type": "path",
                "description": "Return the list of schedules for this location."
              },
              {
                "name": "orgId",
                "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
                "type": "query",
                "description": "List schedules for this organization."
              },
              {
                "name": "max",
                "value": "5",
                "type": "query",
                "description": "Limit the number of objects returned to this maximum count."
              },
              {
                "name": "start",
                "value": "0",
                "type": "query",
                "description": "Start at the zero-based offset in the list of matching objects."
              },
              {
                "name": "name",
                "value": "AUTOATTENDANT-BUSINESS-HOURS",
                "type": "query",
                "description": "Only return schedules with the matching name."
              },
              {
                "name": "type",
                "value": "businessHours",
                "type": "query",
                "description": "Type of the schedule."
              }
            ]
          },
          "docs": "List all schedules for the given location of the organization.\n\nA time schedule establishes a set of times during the day or holidays in the year in which a feature, for example auto attendants, can perform a specific action.\n\nRetrieving this list requires a full or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`."
        },
        {
          "info": {
            "name": "Create a Schedule",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/telephony/config/locations/:locationId/schedules",
            "params": [
              {
                "name": "locationId",
                "value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzEyMzQ1",
                "type": "path",
                "description": "Create the schedule for this location."
              },
              {
                "name": "orgId",
                "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
                "type": "query",
                "description": "Create the schedule for this organization."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create new Schedule for the given location.\n\nA time schedule establishes a set of times during the day or holidays in the year in which a feature, for example auto attendants, can perform a specific action.\n\nCreating a schedule requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`."
        },
        {
          "info": {
            "name": "Get Details for a Schedule",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/telephony/config/locations/:locationId/schedules/:type/:scheduleId",
            "params": [
              {
                "name": "locationId",
                "value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzEyMzQ1",
                "type": "path",
                "description": "Retrieve schedule details in this location."
              },
              {
                "name": "type",
                "value": "businessHours",
                "type": "path",
                "description": "Type of the schedule."
              },
              {
                "name": "scheduleId",
                "value": "Y2lzY29zcGFyazovL3VzL1NDSEVEVUxFL1FWVlVUMEZVVkVWT1JFRk9WQzFJVDB4SlJFRlo",
                "type": "path",
                "description": "Retrieve the schedule with the matching ID."
              },
              {
                "name": "orgId",
                "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
                "type": "query",
                "description": "Retrieve schedule details from this organization."
              }
            ]
          },
          "docs": "Retrieve Schedule details.\n\nA time schedule establishes a set of times during the day or holidays in the year in which a feature, for example auto attendants, can perform a specific action.\n\nRetrieving schedule details requires a full or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`."
        },
        {
          "info": {
            "name": "Update a Schedule",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "{{baseUrl}}/telephony/config/locations/:locationId/schedules/:type/:scheduleId",
            "params": [
              {
                "name": "locationId",
                "value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzEyMzQ1",
                "type": "path",
                "description": "Location in which this schedule exists."
              },
              {
                "name": "type",
                "value": "businessHours",
                "type": "path",
                "description": "Type of schedule."
              },
              {
                "name": "scheduleId",
                "value": "Y2lzY29zcGFyazovL3VzL1NDSEVEVUxFL1FWVlVUMEZVVkVWT1JFRk9WQzFJVDB4SlJFRlo",
                "type": "path",
                "description": "Update schedule with the matching ID."
              },
              {
                "name": "orgId",
                "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
                "type": "query",
                "description": "Update schedule from this organization."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update the designated schedule.\n\nA time schedule establishes a set of times during the day or holidays in the year in which a feature, for example auto attendants, can perform a specific action.\n\nUpdating a schedule requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`.\n\n**NOTE**: The Schedule ID will change upon modification of the Schedule name."
        },
        {
          "info": {
            "name": "Delete a Schedule",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{{baseUrl}}/telephony/config/locations/:locationId/schedules/:type/:scheduleId",
            "params": [
              {
                "name": "locationId",
                "value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzEyMzQ1",
                "type": "path",
                "description": "Location from which to delete a schedule."
              },
              {
                "name": "type",
                "value": "businessHours",
                "type": "path",
                "description": "Type of the schedule."
              },
              {
                "name": "scheduleId",
                "value": "Y2lzY29zcGFyazovL3VzL1NDSEVEVUxFL1FWVlVUMEZVVkVWT1JFRk9WQzFJVDB4SlJFRlo",
                "type": "path",
                "description": "Delete the schedule with the matching ID."
              },
              {
                "name": "orgId",
                "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
                "type": "query",
                "description": "Delete the schedule from this organization."
              }
            ]
          },
          "docs": "Delete the designated Schedule.\n\nA time schedule establishes a set of times during the day or holidays in the year in which a feature, for example auto attendants, can perform a specific action.\n\nDeleting a schedule requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`."
        },
        {
          "info": {
            "name": "Get Details for a Schedule Event",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/telephony/config/locations/:locationId/schedules/:type/:scheduleId/events/:eventId",
            "params": [
              {
                "name": "locationId",
                "value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzEyMzQ1",
                "type": "path",
                "description": "Retrieve schedule event details in this location."
              },
              {
                "name": "type",
                "value": "businessHours",
                "type": "path",
                "description": "Type of schedule."
              },
              {
                "name": "scheduleId",
                "value": "Y2lzY29zcGFyazovL3VzL1NDSEVEVUxFL1FWVlVUMEZVVkVWT1JFRk9WQzFJVDB4SlJFRlo",
                "type": "path",
                "description": "Retrieve the schedule event with the matching schedule ID."
              },
              {
                "name": "eventId",
                "value": "Y2lzY29zcGFyazovL3VzL1NDSEVEVUxFX0VWRU5UL1RtVjNJRmxsWVhJbmN3",
                "type": "path",
                "description": "Retrieve the schedule event with the matching schedule event ID."
              },
              {
                "name": "orgId",
                "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
                "type": "query",
                "description": "Retrieve schedule event details from this organization."
              }
            ]
          },
          "docs": "Retrieve Schedule Event details.\n\nA time schedule establishes a set of times during the day or holidays in the year in which a feature, for example auto attendants, can perform a specific action.\n\nRetrieving a schedule event's details requires a full or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`."
        },
        {
          "info": {
            "name": "Update a Schedule Event",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "{{baseUrl}}/telephony/config/locations/:locationId/schedules/:type/:scheduleId/events/:eventId",
            "params": [
              {
                "name": "locationId",
                "value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzEyMzQ1",
                "type": "path",
                "description": "Location in which this schedule event exists."
              },
              {
                "name": "type",
                "value": "businessHours",
                "type": "path",
                "description": "Type of schedule.\n\n+ `businessHours` - Business hours schedule type.\n\n+ `holidays` - Holidays schedule type."
              },
              {
                "name": "scheduleId",
                "value": "Y2lzY29zcGFyazovL3VzL1NDSEVEVUxFL1FWVlVUMEZVVkVWT1JFRk9WQzFJVDB4SlJFRlo",
                "type": "path",
                "description": "Update schedule event with the matching schedule ID."
              },
              {
                "name": "eventId",
                "value": "Y2lzY29zcGFyazovL3VzL1NDSEVEVUxFX0VWRU5UL1RtVjNJRmxsWVhJbmN5QkVZWGs",
                "type": "path",
                "description": "Update the schedule event with the matching schedule event ID."
              },
              {
                "name": "orgId",
                "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
                "type": "query",
                "description": "Update schedule from this organization."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update the designated Schedule Event.\n\nA time schedule establishes a set of times during the day or holidays in the year in which a feature, for example auto attendants, can perform a specific action.\n\nUpdating a schedule event requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`.\n\n**NOTE**: The schedule event ID will change upon modification of the schedule event name."
        },
        {
          "info": {
            "name": "Delete a Schedule Event",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{{baseUrl}}/telephony/config/locations/:locationId/schedules/:type/:scheduleId/events/:eventId",
            "params": [
              {
                "name": "locationId",
                "value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzEyMzQ1",
                "type": "path",
                "description": "Location from which to delete a schedule."
              },
              {
                "name": "type",
                "value": "businessHours",
                "type": "path",
                "description": "Type of schedule."
              },
              {
                "name": "scheduleId",
                "value": "Y2lzY29zcGFyazovL3VzL1NDSEVEVUxFL1FWVlVUMEZVVkVWT1JFRk9WQzFJVDB4SlJFRlo",
                "type": "path",
                "description": "Delete the schedule with the matching ID."
              },
              {
                "name": "eventId",
                "value": "Y2lzY29zcGFyazovL3VzL1NDSEVEVUxFX0VWRU5UL1RtVjNJRmxsWVhJbmN5QkVZWGs",
                "type": "path",
                "description": "Delete the schedule event with the matching schedule event ID."
              },
              {
                "name": "orgId",
                "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
                "type": "query",
                "description": "Delete the schedule from this organization."
              }
            ]
          },
          "docs": "Delete the designated Schedule Event.\n\nA time schedule establishes a set of times during the day or holidays in the year in which a feature, for example auto attendants, can perform a specific action.\n\nDeleting a schedule event requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`."
        },
        {
          "info": {
            "name": "Create a Schedule Event",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/telephony/config/locations/:locationId/schedules/:type/:scheduleId/events",
            "params": [
              {
                "name": "locationId",
                "value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzEyMzQ1",
                "type": "path",
                "description": "Create the schedule for this location."
              },
              {
                "name": "type",
                "value": "businessHours",
                "type": "path",
                "description": "Type of schedule."
              },
              {
                "name": "scheduleId",
                "value": "Y2lzY29zcGFyazovL3VzL1NDSEVEVUxFL1FWVlVUMEZVVkVWT1JFRk9WQzFJVDB4SlJFRlo",
                "type": "path",
                "description": "Create event for a given schedule ID."
              },
              {
                "name": "orgId",
                "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
                "type": "query",
                "description": "Create the schedule for this organization."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create new Event for the given location Schedule.\n\nA time schedule establishes a set of times during the day or holidays in the year in which a feature, for example auto attendants, can perform a specific action.\n\nCreating a schedule event requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`."
        }
      ]
    }
  ],
  "bundled": true
}