Manage Rosters

Updates, gets and deletes rosters for tenants.

Path Parameters

  • tenantIdstringrequired

    Describes the client ID or msp ID of the tenant

  • rosterIdstringrequired

    Roster unique Identifier

Responses

  • idstring

  • namestring

  • descriptionstring

  • createdTimestring

  • updatedTimestring

  • timeZoneobject

  • allClientsboolean

  • shiftDetailsarray

Loading Examples...

Path Parameters

  • tenantIdstringrequired

    Describes the client ID or msp ID of the tenant

  • rosterIdstringrequired

    Roster unique Identifier

Request Body

application/json

  • namestring

    Unique name for roster used for roster identification.

  • descriptionstring

  • timeZoneobject

    Time zone in which the roster should operate (see table). An example time zone is: `"timeZone": {"name": "Asia/Calcutta"},`

  • shiftDetailsarray

Loading Examples...

Responses

  • idstring

  • namestring

  • descriptionstring

  • createdTimestring

  • updatedTimestring

  • timeZoneobject

  • clientobject

  • shiftDetailsarray

Loading Examples...

Path Parameters

  • tenantIdstringrequired

    Describes the client ID or msp ID of the tenant

  • rosterIdstringrequired

    Roster unique Identifier

Responses

200OK