Rotation

List Schedule Rotations

get

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

/v4/schedules/{scheduleID}/rotations

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

scheduleIDstringRequired

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}/rotations

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.Rotations.List(ctx, "<id>")
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

{
  "data": [
    {
      "id": 1,
      "name": "text",
      "scheduleID": 1,
      "color": "text",
      "startDate": "text",
      "period": "text",
      "customPeriodFrequency": 1,
      "customPeriodUnit": "text",
      "shiftTimeSlots": [
        {
          "startHour": 1,
          "startMin": 1,
          "duration": 1,
          "dayOfWeek": "text"
        }
      ],
      "changeParticipantsFrequency": 1,
      "changeParticipantsUnit": "text",
      "endDate": "text",
      "endsAfterIterations": 1,
      "rotationParticipants": [
        {
          "participants": [
            {
              "id": "text",
              "type": "text"
            }
          ]
        }
      ],
      "createdAt": "text",
      "updatedAt": "text"
    }
  ]
}

Create Rotation

post

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

/v4/schedules/{scheduleID}/rotations

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

scheduleIDstringRequired

Body

application/json

namestringRequired

colorstringOptional

startDatestringRequired

periodstringRequired

customPeriodFrequencyintegerOptional

customPeriodUnitstringOptional

changeParticipantsFrequencyintegerRequired

changeParticipantsUnitstringRequired

endDatestringOptional

endsAfterIterationsintegerOptional

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}/rotations

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.Rotations.Create(ctx, "<id>", components.V4CreateRotationRequest{
        Name: "<value>",
        StartDate: "<value>",
        Period: "<value>",
        ChangeParticipantsFrequency: 62013,
        ChangeParticipantsUnit: "<value>",
        ParticipantGroups: []components.V4ParticipantGroup{},
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

{
  "data": {
    "id": 1,
    "name": "text",
    "scheduleID": 1,
    "color": "text",
    "startDate": "text",
    "period": "text",
    "customPeriodFrequency": 1,
    "customPeriodUnit": "text",
    "shiftTimeSlots": [
      {
        "startHour": 1,
        "startMin": 1,
        "duration": 1,
        "dayOfWeek": "text"
      }
    ],
    "changeParticipantsFrequency": 1,
    "changeParticipantsUnit": "text",
    "endDate": "text",
    "endsAfterIterations": 1,
    "rotationParticipants": [
      {
        "participants": [
          {
            "id": "text",
            "type": "text"
          }
        ]
      }
    ],
    "createdAt": "text",
    "updatedAt": "text"
  }
}

Get Schedule Rotation by ID

get

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

/v4/schedules/{scheduleID}/rotations/{rotationID}

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

scheduleIDstringRequired

rotationIDstringRequired

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}/rotations/{rotationID}

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.Rotations.GetByID(ctx, "<id>", "<id>")
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

{
  "data": {
    "id": 1,
    "name": "text",
    "scheduleID": 1,
    "color": "text",
    "startDate": "text",
    "period": "text",
    "customPeriodFrequency": 1,
    "customPeriodUnit": "text",
    "shiftTimeSlots": [
      {
        "startHour": 1,
        "startMin": 1,
        "duration": 1,
        "dayOfWeek": "text"
      }
    ],
    "changeParticipantsFrequency": 1,
    "changeParticipantsUnit": "text",
    "endDate": "text",
    "endsAfterIterations": 1,
    "rotationParticipants": [
      {
        "participants": [
          {
            "id": "text",
            "type": "text"
          }
        ]
      }
    ],
    "createdAt": "text",
    "updatedAt": "text"
  }
}

Update Rotation

put

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

/v4/schedules/{scheduleID}/rotations/{rotationID}

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

scheduleIDstringRequired

rotationIDstringRequired

Body

application/json

namestringRequired

colorstringOptional

startDatestringRequired

periodstringRequired

customPeriodFrequencyintegerOptional

customPeriodUnitstringOptional

changeParticipantsFrequencyintegerRequired

changeParticipantsUnitstringRequired

endDatestringOptional

endsAfterIterationsintegerOptional

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}/rotations/{rotationID}

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.Rotations.Update(ctx, "<id>", "<id>", components.V4UpdateRotationRequest{
        Name: "<value>",
        StartDate: "<value>",
        Period: "<value>",
        ChangeParticipantsFrequency: 183098,
        ChangeParticipantsUnit: "<value>",
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

{
  "data": {
    "id": 1,
    "name": "text",
    "scheduleID": 1,
    "color": "text",
    "startDate": "text",
    "period": "text",
    "customPeriodFrequency": 1,
    "customPeriodUnit": "text",
    "shiftTimeSlots": [
      {
        "startHour": 1,
        "startMin": 1,
        "duration": 1,
        "dayOfWeek": "text"
      }
    ],
    "changeParticipantsFrequency": 1,
    "changeParticipantsUnit": "text",
    "endDate": "text",
    "endsAfterIterations": 1,
    "rotationParticipants": [
      {
        "participants": [
          {
            "id": "text",
            "type": "text"
          }
        ]
      }
    ],
    "createdAt": "text",
    "updatedAt": "text"
  }
}

Delete Rotation

delete

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

/v4/schedules/{scheduleID}/rotations/{rotationID}

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

scheduleIDstringRequired

rotationIDstringRequired

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}/rotations/{rotationID}

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.DeleteRotation(ctx, "<id>", "<id>")
    if err != nil {
        log.Fatal(err)
    }
    if res.Body != nil {
        // handle response
    }
}

{}

Get Rotation Participants

get

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

/v4/schedules/{scheduleID}/rotations/{rotationID}/participants

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

scheduleIDstringRequired

rotationIDstringRequired

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}/rotations/{rotationID}/participants

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.Rotations.GetParticipants(ctx, "<id>", "<id>")
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

{
  "data": {
    "rotationID": 1,
    "participants": [
      {
        "participants": [
          {
            "id": "text",
            "type": "text"
          }
        ]
      }
    ]
  }
}

Update Rotation Participants

put

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

/v4/schedules/{scheduleID}/rotations/{rotationID}/participants

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

scheduleIDstringRequired

rotationIDstringRequired

Body

application/json

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}/rotations/{rotationID}/participants

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.Rotations.UpdateParticipants(ctx, "<id>", "<id>", components.V4UpdateRotationParticipantsRequest{
        ParticipantGroups: []components.V4ParticipantGroup{},
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

{
  "data": {
    "rotationID": 1,
    "participantGroups": [
      {
        "participants": [
          {
            "id": "text",
            "type": "text"
          }
        ]
      }
    ]
  }
}