/
v3.0.11Get access

getClientSelfExclusionSchedules

This command retrieves the active recurring restriction schedules for a player. It is primarily used to populate the "Availability Period" section of the Self-Exclusion UI, allowing the player to see their existing blocked time

Request parameters:

NameDescriptionTypeValuesDefault
scheduleType
The frequency of the schedulestring"week"-
This method is usually used with these methods:

Call example:

getClientSelfExclusionSchedules({
  scheduleType: 'week'
})

Response examples:

{
  code: 0,
  rid: 'command542072510468137',
  data: {
    result: 0,
    result_text: null,
    details: {
      Schedules: [{
        Id: 1629,
        ClientId: 88736727,
        ExclusionType: 8,
        ScheduleType: 1,
        WeekDayFrom: 2,
        TimeFrom: '18:00:00',
        WeekDayTo: 2,
        TimeTo: '18:11:00'
      }, {
        Id: 1630,
        ClientId: 88736727,
        ExclusionType: 8,
        ScheduleType: 1,
        WeekDayFrom: 6,
        TimeFrom: '19:59:00',
        WeekDayTo: 6,
        TimeTo: '19:59:00'
      }]
    }
  }
}

Response parameters:

NameDescriptionTypeValues
Schedules
Each object in this array represents a specific recurring time block where the player is restricted from bettingarray-
└─
object
└─ Id
The unique internal database ID for this specific schedule recordnumber-
└─ ClientId
The unique identifier of the player to whom this schedule belongsnumber-
└─ ExclusionType
Identifier representing the specific category of self-restriction being appliednumber8
└─ ScheduleType
The frequency of the restrictionnumber1
└─ WeekDayFrom
The start day of the restriction 1 - Monday 2 - Tuesday 3 - Wednesday 4 - Thursday 5 - Friday 6 - Saturday 7 - Sundaynumber1, 2, 3, 4, 5, 6, 7
└─ WeekDayTo
The end day of the restriction 1 - Monday 2 - Tuesday 3 - Wednesday 4 - Thursday 5 - Friday 6 - Saturday 7 - Sundaynumber1, 2, 3, 4, 5, 6, 7
└─ TimeFrom
The start time of the restriction in HH:MM:SS format. Returned in UTC+0string-
└─ TimeTo
The end time of the restriction in HH:MM:SS format. Returned in UTC+0string-