Overrides

List Overrides

get

https://api.eu.squadcast.comhttps://api.squadcast.com

/v4/schedules/{scheduleID}/overrides

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

scheduleIDstringRequired

Query parameters

startTimestringRequired

endTimestringRequired

participantIDstringOptional

pageSizeinteger · int32Optional

cursorstringOptional

Responses

200

The request has succeeded.

application/json

400

The server could not understand the request due to invalid syntax.

application/json

401

Access is unauthorized.

application/json

402

Client error

application/json

403

Access is forbidden.

application/json

404

The server cannot find the requested resource.

application/json

409

The request conflicts with the current state of the server.

application/json

422

Client error

application/json

500

Server error

application/json

502

Server error

application/json

503

Service unavailable.

application/json

504

Server error

application/json

get

/v4/schedules/{scheduleID}/overrides

Go (SDK)Python (SDK)Typescript (SDK)

package main

import(
	"context"
	"os"
	squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go"
	"github.com/SquadcastHub/squadcast-sdk-go/models/operations"
	"log"
)

func main() {
    ctx := context.Background()

    s := squadcastsdk.New(
        squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")),
    )

    res, err := s.Schedules.Overrides.List(ctx, operations.OverridesListOverridesRequest{
        ScheduleID: "<id>",
        StartTime: "<value>",
        EndTime: "<value>",
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

{
  "data": [
    {
      "id": 1,
      "orgID": "text",
      "teamID": "text",
      "scheduleID": 1,
      "startTime": "text",
      "endTime": "text",
      "reason": "text",
      "overriddenParticipant": {
        "group": [
          {
            "id": "text",
            "type": "text"
          }
        ]
      },
      "overrideWith": {
        "group": [
          {
            "id": "text",
            "type": "text"
          }
        ]
      },
      "createdAt": "text",
      "updatedAt": "text"
    }
  ],
  "pageInfo": {
    "pageSize": 1,
    "hasNext": true,
    "hasPrevious": true,
    "nextCursor": "text",
    "previousCursor": "text"
  }
}

Create Schedule Override

post

https://api.eu.squadcast.comhttps://api.squadcast.com

/v4/schedules/{scheduleID}/overrides

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

scheduleIDstringRequired

Body

application/json

startTimestringRequired

endTimestringRequired

reasonstringRequired

Responses

201

The request has succeeded and a new resource has been created as a result.

application/json

400

The server could not understand the request due to invalid syntax.

application/json

401

Access is unauthorized.

application/json

402

Client error

application/json

403

Access is forbidden.

application/json

404

The server cannot find the requested resource.

application/json

409

The request conflicts with the current state of the server.

application/json

422

Client error

application/json

500

Server error

application/json

502

Server error

application/json

503

Service unavailable.

application/json

504

Server error

application/json

post

/v4/schedules/{scheduleID}/overrides

Go (SDK)Python (SDK)Typescript (SDK)

package main

import(
	"context"
	"os"
	squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go"
	"github.com/SquadcastHub/squadcast-sdk-go/models/components"
	"log"
)

func main() {
    ctx := context.Background()

    s := squadcastsdk.New(
        squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")),
    )

    res, err := s.Schedules.CreateScheduleOverride(ctx, "<id>", components.V4CreateScheduleOverrideRequest{
        StartTime: "<value>",
        EndTime: "<value>",
        Reason: "<value>",
        OverriddenParticipant: components.V4OverrideParticipantGroup{
            Group: []components.V4Participant{
                components.V4Participant{
                    ID: "<id>",
                    Type: "<value>",
                },
            },
        },
        OverrideWith: components.V4OverrideParticipantGroup{
            Group: []components.V4Participant{
                components.V4Participant{
                    ID: "<id>",
                    Type: "<value>",
                },
            },
        },
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

{
  "data": {
    "id": 1,
    "orgID": "text",
    "teamID": "text",
    "scheduleID": 1,
    "startTime": "text",
    "endTime": "text",
    "reason": "text",
    "overriddenParticipant": {
      "group": [
        {
          "id": "text",
          "type": "text"
        }
      ]
    },
    "overrideWith": {
      "group": [
        {
          "id": "text",
          "type": "text"
        }
      ]
    },
    "createdAt": "text",
    "updatedAt": "text"
  }
}

Get Override by ID

get

https://api.eu.squadcast.comhttps://api.squadcast.com

/v4/schedules/{scheduleID}/overrides/{overrideID}

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

scheduleIDstringRequired

overrideIDstringRequired

Responses

200

The request has succeeded.

application/json

400

The server could not understand the request due to invalid syntax.

application/json

401

Access is unauthorized.

application/json

402

Client error

application/json

403

Access is forbidden.

application/json

404

The server cannot find the requested resource.

application/json

409

The request conflicts with the current state of the server.

application/json

422

Client error

application/json

500

Server error

application/json

502

Server error

application/json

503

Service unavailable.

application/json

504

Server error

application/json

get

/v4/schedules/{scheduleID}/overrides/{overrideID}

Go (SDK)Python (SDK)Typescript (SDK)

package main

import(
	"context"
	"os"
	squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go"
	"log"
)

func main() {
    ctx := context.Background()

    s := squadcastsdk.New(
        squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")),
    )

    res, err := s.Overrides.GetByID(ctx, "<id>", "<id>")
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

{
  "data": {
    "id": 1,
    "orgID": "text",
    "teamID": "text",
    "scheduleID": 1,
    "startTime": "text",
    "endTime": "text",
    "reason": "text",
    "overriddenParticipant": {
      "group": [
        {
          "id": "text",
          "type": "text"
        }
      ]
    },
    "overrideWith": {
      "group": [
        {
          "id": "text",
          "type": "text"
        }
      ]
    },
    "createdAt": "text",
    "updatedAt": "text"
  }
}

Update Schedule Override

put

https://api.eu.squadcast.comhttps://api.squadcast.com

/v4/schedules/{scheduleID}/overrides/{overrideID}

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

scheduleIDstringRequired

overrideIDstringRequired

Body

application/json

startTimestringRequired

endTimestringRequired

reasonstringRequired

Responses

200

The request has succeeded.

application/json

400

The server could not understand the request due to invalid syntax.

application/json

401

Access is unauthorized.

application/json

402

Client error

application/json

403

Access is forbidden.

application/json

404

The server cannot find the requested resource.

application/json

409

The request conflicts with the current state of the server.

application/json

422

Client error

application/json

500

Server error

application/json

502

Server error

application/json

503

Service unavailable.

application/json

504

Server error

application/json

put

/v4/schedules/{scheduleID}/overrides/{overrideID}

Go (SDK)Python (SDK)Typescript (SDK)

package main

import(
	"context"
	"os"
	squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go"
	"github.com/SquadcastHub/squadcast-sdk-go/models/components"
	"log"
)

func main() {
    ctx := context.Background()

    s := squadcastsdk.New(
        squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")),
    )

    res, err := s.Overrides.Update(ctx, "<id>", "<id>", components.V4UpdateScheduleOverrideRequest{
        StartTime: "<value>",
        EndTime: "<value>",
        Reason: "<value>",
        OverriddenParticipant: components.V4OverrideParticipantGroup{
            Group: []components.V4Participant{
                components.V4Participant{
                    ID: "<id>",
                    Type: "<value>",
                },
            },
        },
        OverrideWith: components.V4OverrideParticipantGroup{
            Group: []components.V4Participant{},
        },
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

{
  "data": {
    "id": 1,
    "orgID": "text",
    "teamID": "text",
    "scheduleID": 1,
    "startTime": "text",
    "endTime": "text",
    "reason": "text",
    "overriddenParticipant": {
      "group": [
        {
          "id": "text",
          "type": "text"
        }
      ]
    },
    "overrideWith": {
      "group": [
        {
          "id": "text",
          "type": "text"
        }
      ]
    },
    "createdAt": "text",
    "updatedAt": "text"
  }
}

Delete Schedule Override

delete

https://api.eu.squadcast.comhttps://api.squadcast.com

/v4/schedules/{scheduleID}/overrides/{overrideID}

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

scheduleIDstringRequired

overrideIDstringRequired

Responses

204

There is no content to send for this request, but the headers may be useful.

*/*

400

The server could not understand the request due to invalid syntax.

application/json

401

Access is unauthorized.

application/json

402

Client error

application/json

403

Access is forbidden.

application/json

404

The server cannot find the requested resource.

application/json

409

The request conflicts with the current state of the server.

application/json

422

Client error

application/json

500

Server error

application/json

502

Server error

application/json

503

Service unavailable.

application/json

504

Server error

application/json

delete

/v4/schedules/{scheduleID}/overrides/{overrideID}

Go (SDK)Python (SDK)Typescript (SDK)

package main

import(
	"context"
	"os"
	squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go"
	"log"
)

func main() {
    ctx := context.Background()

    s := squadcastsdk.New(
        squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")),
    )

    res, err := s.Schedules.Overrides.Delete(ctx, "<id>", "<id>")
    if err != nil {
        log.Fatal(err)
    }
    if res.Body != nil {
        // handle response
    }
}

{}