> For the complete documentation index, see [llms.txt](https://developers.incidents.cloud.solarwinds.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developers.incidents.cloud.solarwinds.com/python-sdk/docs/sdks/schedulesoverrides.md).

# Schedules.Overrides

## Overview

### Available Operations

* [list](#list) - List Overrides
* [create](#create) - Create Schedule Override
* [update](#update) - Update Schedule Override

## list

List Overrides

### Example Usage

```python
from squadcast import SquadcastSDK


with SquadcastSDK(
    refresh_token_auth="<YOUR_REFRESH_TOKEN_AUTH_HERE>",
) as squadcast_sdk:

    res = squadcast_sdk.schedules.overrides.list(schedule_id="<id>", start_time="<value>", end_time="<value>")

    # Handle response
    print(res)

```

### Parameters

| Parameter        | Type                                                                                                                           | Required             | Description                                                         |
| ---------------- | ------------------------------------------------------------------------------------------------------------------------------ | -------------------- | ------------------------------------------------------------------- |
| `schedule_id`    | *str*                                                                                                                          | :heavy\_check\_mark: | N/A                                                                 |
| `start_time`     | *str*                                                                                                                          | :heavy\_check\_mark: | N/A                                                                 |
| `end_time`       | *str*                                                                                                                          | :heavy\_check\_mark: | N/A                                                                 |
| `participant_id` | *Optional\[str]*                                                                                                               | :heavy\_minus\_sign: | N/A                                                                 |
| `page_size`      | *Optional\[int]*                                                                                                               | :heavy\_minus\_sign: | N/A                                                                 |
| `cursor`         | *Optional\[str]*                                                                                                               | :heavy\_minus\_sign: | N/A                                                                 |
| `retries`        | [Optional\[utils.RetryConfig\]](https://developers.incidents.cloud.solarwinds.com/python-sdk/docs/models/utils/retryconfig.md) | :heavy\_minus\_sign: | Configuration to override the default retry behavior of the client. |

### Response

[**models.OverridesListOverridesResponse**](https://developers.incidents.cloud.solarwinds.com/python-sdk/docs/models/overrideslistoverridesresponse.md)

### Errors

| Error Type             | Status Code                       | Content Type     |
| ---------------------- | --------------------------------- | ---------------- |
| errors.CommonV4Error   | 400, 401, 402, 403, 404, 409, 422 | application/json |
| errors.CommonV4Error   | 500, 502, 503, 504                | application/json |
| errors.SDKDefaultError | 4XX, 5XX                          | \*/\*            |

## create

Create Schedule Override

### Example Usage

```python
from squadcast import SquadcastSDK


with SquadcastSDK(
    refresh_token_auth="<YOUR_REFRESH_TOKEN_AUTH_HERE>",
) as squadcast_sdk:

    res = squadcast_sdk.schedules.overrides.create(schedule_id="<id>", start_time="<value>", end_time="<value>", reason="<value>", overridden_participant={
        "group": [
            {
                "id": "<id>",
                "type": "<value>",
            },
        ],
    }, override_with={
        "group": [
            {
                "id": "<id>",
                "type": "<value>",
            },
        ],
    })

    # Handle response
    print(res)

```

### Parameters

| Parameter                | Type                                                                                                                                        | Required             | Description                                                         |
| ------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------- | -------------------- | ------------------------------------------------------------------- |
| `schedule_id`            | *str*                                                                                                                                       | :heavy\_check\_mark: | N/A                                                                 |
| `start_time`             | *str*                                                                                                                                       | :heavy\_check\_mark: | N/A                                                                 |
| `end_time`               | *str*                                                                                                                                       | :heavy\_check\_mark: | N/A                                                                 |
| `reason`                 | *str*                                                                                                                                       | :heavy\_check\_mark: | N/A                                                                 |
| `overridden_participant` | [models.V4OverrideParticipantGroup](https://developers.incidents.cloud.solarwinds.com/python-sdk/docs/models/v4overrideparticipantgroup.md) | :heavy\_check\_mark: | N/A                                                                 |
| `override_with`          | [models.V4OverrideParticipantGroup](https://developers.incidents.cloud.solarwinds.com/python-sdk/docs/models/v4overrideparticipantgroup.md) | :heavy\_check\_mark: | N/A                                                                 |
| `retries`                | [Optional\[utils.RetryConfig\]](https://developers.incidents.cloud.solarwinds.com/python-sdk/docs/models/utils/retryconfig.md)              | :heavy\_minus\_sign: | Configuration to override the default retry behavior of the client. |

### Response

[**models.OverridesCreateScheduleOverrideResponse**](https://developers.incidents.cloud.solarwinds.com/python-sdk/docs/models/overridescreatescheduleoverrideresponse.md)

### Errors

| Error Type             | Status Code                       | Content Type     |
| ---------------------- | --------------------------------- | ---------------- |
| errors.CommonV4Error   | 400, 401, 402, 403, 404, 409, 422 | application/json |
| errors.CommonV4Error   | 500, 502, 503, 504                | application/json |
| errors.SDKDefaultError | 4XX, 5XX                          | \*/\*            |

## update

Update Schedule Override

### Example Usage

```python
from squadcast import SquadcastSDK


with SquadcastSDK(
    refresh_token_auth="<YOUR_REFRESH_TOKEN_AUTH_HERE>",
) as squadcast_sdk:

    res = squadcast_sdk.schedules.overrides.update(schedule_id="<id>", override_id="<id>", start_time="<value>", end_time="<value>", reason="<value>", overridden_participant={
        "group": [
            {
                "id": "<id>",
                "type": "<value>",
            },
        ],
    }, override_with={
        "group": [],
    })

    # Handle response
    print(res)

```

### Parameters

| Parameter                | Type                                                                                                                                        | Required             | Description                                                         |
| ------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------- | -------------------- | ------------------------------------------------------------------- |
| `schedule_id`            | *str*                                                                                                                                       | :heavy\_check\_mark: | N/A                                                                 |
| `override_id`            | *str*                                                                                                                                       | :heavy\_check\_mark: | N/A                                                                 |
| `start_time`             | *str*                                                                                                                                       | :heavy\_check\_mark: | N/A                                                                 |
| `end_time`               | *str*                                                                                                                                       | :heavy\_check\_mark: | N/A                                                                 |
| `reason`                 | *str*                                                                                                                                       | :heavy\_check\_mark: | N/A                                                                 |
| `overridden_participant` | [models.V4OverrideParticipantGroup](https://developers.incidents.cloud.solarwinds.com/python-sdk/docs/models/v4overrideparticipantgroup.md) | :heavy\_check\_mark: | N/A                                                                 |
| `override_with`          | [models.V4OverrideParticipantGroup](https://developers.incidents.cloud.solarwinds.com/python-sdk/docs/models/v4overrideparticipantgroup.md) | :heavy\_check\_mark: | N/A                                                                 |
| `retries`                | [Optional\[utils.RetryConfig\]](https://developers.incidents.cloud.solarwinds.com/python-sdk/docs/models/utils/retryconfig.md)              | :heavy\_minus\_sign: | Configuration to override the default retry behavior of the client. |

### Response

[**models.OverridesUpdateScheduleOverrideResponse**](https://developers.incidents.cloud.solarwinds.com/python-sdk/docs/models/overridesupdatescheduleoverrideresponse.md)

### Errors

| Error Type             | Status Code                       | Content Type     |
| ---------------------- | --------------------------------- | ---------------- |
| errors.CommonV4Error   | 400, 401, 402, 403, 404, 409, 422 | application/json |
| errors.CommonV4Error   | 500, 502, 503, 504                | application/json |
| errors.SDKDefaultError | 4XX, 5XX                          | \*/\*            |
