calendar_events.read
view permission
view-all query parameter to true to ignore all players permissions filters only if you have the calendar-events.ignore-permissions permission
| Name | Type | Description |
|---|---|---|
| serverId | number | The server id |
| Name | Type | Description | Default |
|---|---|---|---|
| from | date | The date from where you want to get events (minimum: 2020-1-1) | 2020-1-1 |
| to | date | The date to where you want to get events (maximum: 2049-12-31) | 2049-12-31 |
| ignore-permissions | boolean | If you want to ignore all players permissions filters | false |
| event-type | string | If you want to get only events of a specific type (enum: ) |
❌ |
| Status | Code | Description |
|---|---|---|
OK |
The request has been successfully completed | |
INVALID_DATE_FORMAT |
The date is invalid | |
INVALID_DATE_RANGE |
The date range must be between 2020-0-1 and 2049-11-31 and can't exceed 5184000 seconds length | |
INVALID_EVENT-TYPE |
The value doesn't follow the requirements | |
INVALID_FROM |
The value doesn't follow the requirements | |
INVALID_IGNORE-PERMISSIONS |
The value doesn't follow the requirements | |
INVALID_SERVER_ID |
The server id is invalid | |
INVALID_TO |
The value doesn't follow the requirements | |
UNAUTHORIZED |
The token is invalid or expired | |
ACCESS_DENIED |
The token or the author does not have the required permissions | |
CANT_IGNORE_PERMISSIONS |
You can't view ignore permissions you don't have the right permissions | |
DISCORD_CONNECTION_REQUIRED |
You need a Discord account link to your Steam Account to access to the route | |
SERVER_NOT_FOUND |
The server does not exist | |
INTERNAL_ERROR |
An internal error has occured |
"OK"
number
number
string
string
date
date
date | null
string | null
string
number
string
string | null
string | null
number
number
number
string
string
number | null
number
string
date | null
string
string
number
string
string
string | null
date
date
string
boolean
date | null
date | null
date | null
number | null
number | null
number | null
number | null
number | null
number
string
string
date
date
date | null
string | null
string
number
string
string | null
string | null
number
number
number
string
string
number | null
number
string
date | null
string
string
boolean | null
boolean | null
boolean
string | null
boolean | null
number | null
number
number
number
string
string
date
date | null
date | null
date | null
string
boolean
date | null
date | null
date | null
number | null
number | null
number | null
number | null
number | null
number
string
string
date
date
date | null
string | null
string
number
string
string | null
string | null
number
number
number
string
string
number | null
number
string
date | null
string
string
boolean | null
boolean | null
boolean
string | null
boolean | null
number | null
number | null
number | null
number | null
number | null
boolean | null
number
string
string
date
date
date | null
string | null
string
number
string
string | null
string | null
number
number
number
string
string
number | null
number
string
date | null
string
string
number
number
string
date | null
string
string
number
date | null
string | null
string | null
date
date | null
string
number | null
number | null
number | null
number | null
boolean | null
date
date
number
string
string
date
date
date | null
string | null
string
number
string
string | null
string | null
number
number
number
string
string
number | null
number
string
date | null
string
string
number
number
string
date | null
string
string
number
date | null
string | null
string | null
date
date | null
calendar_events.read
| Name | Type | Description |
|---|---|---|
| serverId | number | The server id |
| eventId | number | The event id to get |
| Name | Type | Description | Default |
|---|---|---|---|
| target-event-from-date | date | If the event is a schedule event, you can specify the date of the event to get | ❌ |
| Status | Code | Description |
|---|---|---|
OK |
The request has been successfully completed | |
INVALID_SERVER_ID |
The server id is invalid | |
INVALID_TARGET_EVENT_DATE |
The target event date is invalid | |
INVALID_TARGET-EVENT-FROM-DATE |
The value doesn't follow the requirements | |
UNAUTHORIZED |
The token is invalid or expired | |
ACCESS_DENIED |
The token or the author does not have the required permissions | |
DISCORD_CONNECTION_REQUIRED |
You need a Discord account link to your Steam Account to access to the route | |
SERVER_NOT_FOUND |
The server does not exist | |
TARGET_EVENT_NOT_FOUND |
The target event date was not found | |
INTERNAL_ERROR |
An internal error has occured |
"OK"
number
number
string
string
date
date
date | null
string | null
string
number
string
string | null
string | null
number
number
number
string
string
number | null
number
string
date | null
string
string
number
string
string
string | null
date
date
string
boolean
date | null
date | null
date | null
number | null
number | null
number | null
number | null
number | null
number
string
string
date
date
date | null
string | null
string
number
string
string | null
string | null
number
number
number
string
string
number | null
number
string
date | null
string
string
boolean | null
boolean | null
boolean
string | null
boolean | null
number | null
number
number
number
string
string
date
date | null
date | null
date | null
string
boolean
date | null
date | null
date | null
number | null
number | null
number | null
number | null
number | null
number
string
string
date
date
date | null
string | null
string
number
string
string | null
string | null
number
number
number
string
string
number | null
number
string
date | null
string
string
boolean | null
boolean | null
boolean
string | null
boolean | null
number | null
number | null
number | null
number | null
number | null
boolean | null
number
string
string
date
date
date | null
string | null
string
number
string
string | null
string | null
number
number
number
string
string
number | null
number
string
date | null
string
string
number
number
string
date | null
string
string
number
date | null
string | null
string | null
date
date | null
string
number | null
number | null
number | null
number | null
boolean | null
date
date
number
string
string
date
date
date | null
string | null
string
number
string
string | null
string | null
number
number
number
string
string
number | null
number
string
date | null
string
string
number
number
string
date | null
string
string
number
date | null
string | null
string | null
date
date | null
calendar_events.read
view permission on the event
null (excepted for you) if you don't have the view-participants-reason permission on the event
target-event-from-date query parameter if the event is a schedule event
| Name | Type | Description |
|---|---|---|
| serverId | number | The server id |
| eventId | number | The event id to get participants |
| Name | Type | Description | Default |
|---|---|---|---|
| target-event-from-date | date | If the event is a schedule event, you can specify the date of the event to get participants | ❌ |
| Status | Code | Description |
|---|---|---|
OK |
The request has been successfully completed | |
INVALID_SERVER_ID |
The server id is invalid | |
INVALID_TARGET-EVENT-FROM-DATE |
The value doesn't follow the requirements | |
UNAUTHORIZED |
The token is invalid or expired | |
ACCESS_DENIED |
The token or the author does not have the required permissions | |
DISCORD_CONNECTION_REQUIRED |
You need a Discord account link to your Steam Account to access to the route | |
SERVER_NOT_FOUND |
The server does not exist | |
INTERNAL_ERROR |
An internal error has occured |
"OK"
number
string
string
date
date
date | null
string | null
string
number
string
string | null
string | null
number
number
number
string
string
number | null
number
string
date | null
string
string
boolean | null
boolean | null
boolean
string | null
boolean | null
number | null
calendar_events.read
| Name | Type | Description |
|---|---|---|
| serverId | number | The server id |
| eventId | number | The event id to get permissions |
| Name | Type | Description | Default |
|---|---|---|---|
| target-event-from-date | date | If the event is a schedule event, you can specify the date of the event to get permissions | ❌ |
| Status | Code | Description |
|---|---|---|
OK |
The request has been successfully completed | |
INVALID_SERVER_ID |
The server id is invalid | |
INVALID_TARGET-EVENT-FROM-DATE |
The value doesn't follow the requirements | |
UNAUTHORIZED |
The token is invalid or expired | |
ACCESS_DENIED |
The token or the author does not have the required permissions | |
DISCORD_CONNECTION_REQUIRED |
You need a Discord account link to your Steam Account to access to the route | |
SERVER_NOT_FOUND |
The server does not exist | |
INTERNAL_ERROR |
An internal error has occured |
"OK"
string[]
calendar_events.read
| Name | Type | Description |
|---|---|---|
| serverId | number | The server id |
| Status | Code | Description |
|---|---|---|
OK |
The request has been successfully completed | |
INVALID_SERVER_ID |
The server id is invalid | |
UNAUTHORIZED |
The token is invalid or expired | |
ACCESS_DENIED |
The token or the author does not have the required permissions | |
DISCORD_CONNECTION_REQUIRED |
You need a Discord account link to your Steam Account to access to the route | |
SERVER_NOT_FOUND |
The server does not exist | |
INTERNAL_ERROR |
An internal error has occured |
"OK"
string[]
calendar_events.read
| Name | Type | Description |
|---|---|---|
| serverId | number | The server id |
| Status | Code | Description |
|---|---|---|
OK |
The request has been successfully completed | |
INVALID_SERVER_ID |
The server id is invalid | |
UNAUTHORIZED |
The token is invalid or expired | |
ACCESS_DENIED |
The token or the author does not have the required permissions | |
DISCORD_CONNECTION_REQUIRED |
You need a Discord account link to your Steam Account to access to the route | |
SERVER_NOT_FOUND |
The server does not exist | |
INTERNAL_ERROR |
An internal error has occured |
"OK"
string[]
calendar_events.create
create permission on the category of the event
manage permission on the category of the event
private
validatePresenceMinimumDelay and validatePresenceMaximumDelay can only be specified if the type is meeting
createChannelBeforeDelay, deleteChannelAfterDelay and createChannel can only be specified if the type is interview
createChannelBeforeDelay and deleteChannelAfterDelay needs to be specified if the createChannel is true
| Name | Type | Description |
|---|---|---|
| serverId | number | The server id |
| Key | Type | Description | Default | Required |
|---|---|---|---|---|
| authorUuid | string | The author uuid of the event | Current player uuid | ❌ |
| title | string | The title of the event (min length: 1, max length: 100) |
❌ | ✅ |
| description | string | The description of the event (min length: 1, max length: 1000) |
❌ | ✅ |
| fromDate | date | The start date of the event (must be in the future if you don't have the create-old-{{eventType}} permission on the selected category) |
❌ | ✅ |
| toDate | date | The end date of the event (must be after the start date) | ❌ | ✅ |
| type | string | The type of the event (enum: ) |
❌ | ✅ |
| validatePresenceMinimumDelay | number | The minimum delay before the event to validate the presence (max: 630720000) |
❌ | ❌ |
| validatePresenceMaximumDelay | number | The maximum delay before the event to validate the presence (max: 630720000) |
❌ | ❌ |
| category | string | The category of the event | ❌ | ✅ |
| dayOfTheMonth | number | If you want to create a schedule event, you can specify the day of the month (min: 1, max: 31) |
❌ | ❌ |
| dayOfTheWeek | number | If you want to create a schedule event, you can specify the day of the week (max: 6) |
❌ | ❌ |
| repeatDelay | number | If you want to create a schedule event, you can specify a repeat delay in seconds (min: 1, max: 630720000) |
❌ | ❌ |
| weekOfTheMonth | number | If you want to create a schedule event, you can specify the week of the month (starts at 0) (max: 5) |
❌ | ❌ |
| monthOfTheYear | number | If you want to create a schedule event, you can specify the month of the year (max: 11) |
❌ | ❌ |
| scheduleEndAt | date | If you want to create a schedule event, you can specify the end date of the schedule | ❌ | ❌ |
| createChannelBeforeDelay | number | If you want to create a channel before the event, you can specify the delay in seconds (min: 300, max: 3600) |
❌ | ❌ |
| deleteChannelAfterDelay | number | Specify the delay in seconds after the event start date to delete the channel when it is empty (min: 300, max: 3600) |
❌ | ❌ |
| createChannel | boolean | If you want to create a channel for the event, you can specify it | ❌ | ❌ |
| shareWith | array | The uuids of the players you want to share the event with (only for event wtih private category) (max length: 40) |
❌ | ❌ |
| participants | array | The participants of the interview (only for event type interview) (min length: 1, max length: 40) |
❌ | ❌ |
| Status | Code | Description |
|---|---|---|
OK |
The request has been successfully completed | |
BAD_BODY |
The request body is invalid | |
CANT_SET_CHANNEL_DELAY |
You can't set the channel delay if the type is not interview |
|
CANT_SET_PRESENCE_DELAY |
You can't set the presence delay if the type is not meeting |
|
FROM_DATE_MUST_BE_BEFORE_TO_DATE |
The from date must be before the to date | |
INVALID_AUTHOR_UUID |
The value authorUuid doesn't follow the requirements |
|
INVALID_CATEGORY |
The value category doesn't follow the requirements |
|
INVALID_CREATE_CHANNEL |
The value createChannel doesn't follow the requirements |
|
INVALID_CREATE_CHANNEL_BEFORE_DELAY |
The value createChannelBeforeDelay doesn't follow the requirements |
|
INVALID_DAY_OF_THE_MONTH |
The value dayOfTheMonth doesn't follow the requirements |
|
INVALID_DAY_OF_THE_WEEK |
The value dayOfTheWeek doesn't follow the requirements |
|
INVALID_DELETE_CHANNEL_AFTER_DELAY |
The value deleteChannelAfterDelay doesn't follow the requirements |
|
INVALID_DESCRIPTION |
The value description doesn't follow the requirements |
|
INVALID_FROM_DATE |
The value fromDate doesn't follow the requirements |
|
INVALID_MONTH_OF_THE_YEAR |
The value monthOfTheYear doesn't follow the requirements |
|
INVALID_PARTICIPANTS |
One of the participant uuid is invalid or the type is not equals to interview |
|
INVALID_PARTICIPANTS |
The value participants doesn't follow the requirements |
|
INVALID_REPEAT_DELAY |
The value repeatDelay doesn't follow the requirements |
|
INVALID_SCHEDULE_END_AT |
The value scheduleEndAt doesn't follow the requirements |
|
INVALID_SERVER_ID |
The server id is invalid | |
INVALID_SHARE_WITH |
The value shareWith doesn't follow the requirements |
|
INVALID_SHARED_PLAYER_UUID |
One of the shared player uuid is invalid, the same uuid of the author or the category is not equals to private |
|
INVALID_TITLE |
The value title doesn't follow the requirements |
|
INVALID_TO_DATE |
The value toDate doesn't follow the requirements |
|
INVALID_TYPE |
The value type doesn't follow the requirements |
|
INVALID_VALIDATE_PRESENCE_MAXIMUM_DELAY |
The value validatePresenceMaximumDelay doesn't follow the requirements |
|
INVALID_VALIDATE_PRESENCE_MINIMUM_DELAY |
The value validatePresenceMinimumDelay doesn't follow the requirements |
|
INVALID_WEEK_OF_THE_MONTH |
The value weekOfTheMonth doesn't follow the requirements |
|
MISSING_AUTHOR_UUID |
The authorUuid value is missing |
|
MISSING_BODY |
The request does not have a body | |
MISSING_CREATE_CHANNEL |
The createChannel value is missing |
|
MISSING_CREATE_CHANNEL_BEFORE_DELAY |
The createChannelBeforeDelay value is missing |
|
MISSING_CREATE_DELETE_CHANNEL_DELAY |
You must specify the createChannelBeforeDelay and deleteChannelAfterDelay if the createChannel is true |
|
MISSING_DAY_OF_THE_MONTH |
The dayOfTheMonth value is missing |
|
MISSING_DAY_OF_THE_WEEK |
The dayOfTheWeek value is missing |
|
MISSING_DELETE_CHANNEL_AFTER_DELAY |
The deleteChannelAfterDelay value is missing |
|
MISSING_MONTH_OF_THE_YEAR |
The monthOfTheYear value is missing |
|
MISSING_PARTICIPANTS |
The participants value is missing |
|
MISSING_REPEAT_DELAY |
The repeatDelay value is missing |
|
MISSING_SCHEDULE_END_AT |
The scheduleEndAt value is missing |
|
MISSING_SHARE_WITH |
The shareWith value is missing |
|
MISSING_VALIDATE_PRESENCE_MAXIMUM_DELAY |
The validatePresenceMaximumDelay value is missing |
|
MISSING_VALIDATE_PRESENCE_MINIMUM_DELAY |
The validatePresenceMinimumDelay value is missing |
|
MISSING_WEEK_OF_THE_MONTH |
The weekOfTheMonth value is missing |
|
NO_PRESENCE_DELAY |
You must set the presence delay if the type is meeting |
|
SCHEDULE_EVENT_END_AT_MUST_BE_AFTER_TO_DATE |
The schedule event end at must be after the to date | |
UNAUTHORIZED |
The token is invalid or expired | |
ACCESS_DENIED |
The token or the author does not have the required permissions | |
DISCORD_CONNECTION_REQUIRED |
You need a Discord account link to your Steam Account to access to the route | |
SERVER_NOT_FOUND |
The server does not exist | |
INTERNAL_ERROR |
An internal error has occured |
"OK"
number
number
string
string
date
date
date | null
string | null
string
number
string
string | null
string | null
number
number
number
string
string
number | null
number
string
date | null
string
string
number
string
string
string | null
date
date
string
boolean
date | null
date | null
date | null
number | null
number | null
number | null
number | null
number | null
number
string
string
date
date
date | null
string | null
string
number
string
string | null
string | null
number
number
number
string
string
number | null
number
string
date | null
string
string
boolean | null
boolean | null
boolean
string | null
boolean | null
number | null
number
number
number
string
string
date
date | null
date | null
date | null
string
boolean
date | null
date | null
date | null
number | null
number | null
number | null
number | null
number | null
number
string
string
date
date
date | null
string | null
string
number
string
string | null
string | null
number
number
number
string
string
number | null
number
string
date | null
string
string
boolean | null
boolean | null
boolean
string | null
boolean | null
number | null
number | null
number | null
number | null
number | null
boolean | null
number
string
string
date
date
date | null
string | null
string
number
string
string | null
string | null
number
number
number
string
string
number | null
number
string
date | null
string
string
number
number
string
date | null
string
string
number
date | null
string | null
string | null
date
date | null
string
number | null
number | null
number | null
number | null
boolean | null
date
date
number
string
string
date
date
date | null
string | null
string
number
string
string | null
string | null
number
number
number
string
string
number | null
number
string
date | null
string
string
number
number
string
date | null
string
string
number
date | null
string | null
string | null
date
date | null
calendar-participation.manage and calendar-participation.manage
manage-participants permission on the event
not check if the player is a valid participant, you need to do it yourself if you want to
presence or late to null if you want to remove the participation of a player
| Name | Type | Description |
|---|---|---|
| serverId | number | The server id |
| eventId | number | The event id where you want to update your participation |
| Key | Type | Structure | Description | Default | Required |
|---|---|---|---|---|---|
| targetEventDate | date | ❌ | If the event is a schedule event, you can specify the date of the event to update your participation | ❌ | ❌ |
| participants | array |
|
The participants to update | ❌ | ✅ |
| Status | Code | Description |
|---|---|---|
OK |
The request has been successfully completed | |
BAD_BODY |
The request body is invalid | |
INVALID_PARTICIPANTS |
The value participants doesn't follow the requirements |
|
INVALID_PLAYER_UUID |
One of the player uuid is invalid | |
INVALID_SERVER_ID |
The server id is invalid | |
INVALID_TARGET_EVENT_DATE |
The target event date is invalid | |
INVALID_TARGET_EVENT_DATE |
The value targetEventDate doesn't follow the requirements |
|
MISSING_BODY |
The request does not have a body | |
MISSING_DURATION |
The duration value is missing |
|
MISSING_LATE |
The late value is missing |
|
MISSING_PRESENCE |
The presence value is missing |
|
MISSING_TARGET_EVENT_DATE |
The targetEventDate value is missing |
|
UNAUTHORIZED |
The token is invalid or expired | |
ACCESS_DENIED |
The token or the author does not have the required permissions | |
DISCORD_CONNECTION_REQUIRED |
You need a Discord account link to your Steam Account to access to the route | |
SERVER_NOT_FOUND |
The server does not exist | |
TARGET_EVENT_DATE_NOT_FOUND |
The target event date was not found | |
TARGET_EVENT_NOT_FOUND |
The target event was not found | |
INTERNAL_ERROR |
An internal error has occured |
"OK"
calendar-participation.manage
reason if present is false
target-event-from-date query parameter if the event is a schedule event
present to null if you want to remove your participation
| Name | Type | Description |
|---|---|---|
| serverId | number | The server id |
| eventId | number | The event id where you want to update your participation |
| Name | Type | Description | Default |
|---|---|---|---|
| target-event-from-date | date | If the event is a schedule event, you can specify the date of the event to update your participation | ❌ |
| Key | Type | Description | Default | Required |
|---|---|---|---|---|
| present | boolean | If you are present or not | ❌ | ❌ |
| reason | string | The reason of your absence (min length: 1, max length: 150) |
❌ | ❌ |
| Status | Code | Description |
|---|---|---|
OK |
The request has been successfully completed | |
BAD_BODY |
The request body is invalid | |
CANT_SET_REASON |
You can't set a reason if you are present or you want to remove your participation | |
CANT_UPDATE_PASSED_EVENT |
You can't update your participation to a passed event | |
INVALID_PRESENT |
The value present doesn't follow the requirements |
|
INVALID_REASON |
The value reason doesn't follow the requirements |
|
INVALID_SERVER_ID |
The server id is invalid | |
INVALID_TARGET-EVENT-FROM-DATE |
The value doesn't follow the requirements | |
MISSING_BODY |
The request does not have a body | |
MISSING_PRESENT |
The present value is missing |
|
MISSING_REASON |
The reason value is missing |
|
UNAUTHORIZED |
The token is invalid or expired | |
ACCESS_DENIED |
The token or the author does not have the required permissions | |
CANT_VALIDATE_PRESENCE_TOO_EARLY |
You can't validate your presence too early | |
CANT_VALIDATE_PRESENCE_TOO_LATE |
You can't validate your presence too late | |
DISCORD_CONNECTION_REQUIRED |
You need a Discord account link to your Steam Account to access to the route | |
SERVER_NOT_FOUND |
The server does not exist | |
INTERNAL_ERROR |
An internal error has occured |
"OK"
calendar_events.update
update permission on the event
administrator global permission
fromDate or the toDate of a schedule event and not on the first occurrence, the current event will be updated (to stop the event before the seleced event) and a new event will be created (and sent on the newEvent field)
private
validatePresenceMinimumDelay and validatePresenceMaximumDelay can only be specified if the type is meeting
createChannelBeforeDelay, deleteChannelAfterDelay and createChannel can only be specified if the type is interview
createChannelBeforeDelay and deleteChannelAfterDelay needs to be specified if the createChannel is true
| Name | Type | Description |
|---|---|---|
| serverId | number | The server id |
| eventId | number | The event id to update |
| Name | Type | Description | Default |
|---|---|---|---|
| target-event-from-date | date | If the event is a schedule event, you can specify the date of the event to delete | ❌ |
| selected-event | string | If the event is a schedule event, you can specify if you want to delete the current event or the next ones (enum: ) |
this |
| Key | Type | Description | Default | Required |
|---|---|---|---|---|
| title | string | The title of the event (min length: 1, max length: 100) |
❌ | ✅ |
| description | string | The description of the event (min length: 1, max length: 1000) |
❌ | ✅ |
| fromDate | date | The start date of the event | ❌ | ✅ |
| toDate | date | ❌ | ✅ | |
| validatePresenceMinimumDelay | number | The minimum delay before the event to validate the presence (max: 630720000) |
❌ | ❌ |
| validatePresenceMaximumDelay | number | The maximum delay before the event to validate the presence (max: 630720000) |
❌ | ❌ |
| shareWith | array | The uuids of the players you want to share the event with (only for event wtih private category) (max length: 40) |
❌ | ❌ |
| participants | array | The participants of the interview (only for event type interview) (min length: 1, max length: 40) |
❌ | ❌ |
| dayOfTheMonth | number | If you want to create a schedule event, you can specify the day of the month (min: 1, max: 31) |
❌ | ❌ |
| dayOfTheWeek | number | If you want to create a schedule event, you can specify the day of the week (max: 6) |
❌ | ❌ |
| repeatDelay | number | If you want to create a schedule event, you can specify a repeat delay in seconds (min: 1, max: 630720000) |
❌ | ❌ |
| weekOfTheMonth | number | If you want to create a schedule event, you can specify the week of the month (starts at 0) (max: 5) |
❌ | ❌ |
| monthOfTheYear | number | If you want to create a schedule event, you can specify the month of the year (max: 11) |
❌ | ❌ |
| scheduleEndAt | date | ❌ | ❌ | |
| createChannelBeforeDelay | number | If you want to create a channel before the event, you can specify the delay in seconds (min: 300, max: 3600) |
❌ | ❌ |
| deleteChannelAfterDelay | number | Specify the delay in seconds after the event start date to delete the channel when it is empty (min: 300, max: 3600) |
❌ | ❌ |
| createChannel | boolean | If you want to create a channel for the event, you can specify it | ❌ | ❌ |
| Status | Code | Description |
|---|---|---|
OK |
The request has been successfully completed | |
BAD_BODY |
The request body is invalid | |
CANT_SET_CHANNEL_DELAY |
You can't set the channel delay if the type is not interview |
|
CANT_SET_PRESENCE_DELAY |
You can't set the presence delay if the type is not meeting |
|
CANT_UPDATE_PASSED_EVENT |
You can't update a passed event if you don't have the administrator global permission |
|
FROM_DATE_MUST_BE_BEFORE_TO_DATE |
The from date must be before the to date | |
FROM_DATE_MUST_BE_IN_THE_FUTURE |
The from date must be in the future | |
INVALID_CREATE_CHANNEL |
The value createChannel doesn't follow the requirements |
|
INVALID_CREATE_CHANNEL_BEFORE_DELAY |
The value createChannelBeforeDelay doesn't follow the requirements |
|
INVALID_DAY_OF_THE_MONTH |
The value dayOfTheMonth doesn't follow the requirements |
|
INVALID_DAY_OF_THE_WEEK |
The value dayOfTheWeek doesn't follow the requirements |
|
INVALID_DELETE_CHANNEL_AFTER_DELAY |
The value deleteChannelAfterDelay doesn't follow the requirements |
|
INVALID_DESCRIPTION |
The value description doesn't follow the requirements |
|
INVALID_FROM_DATE |
The value fromDate doesn't follow the requirements |
|
INVALID_MONTH_OF_THE_YEAR |
The value monthOfTheYear doesn't follow the requirements |
|
INVALID_PARTICIPANTS |
The value participants doesn't follow the requirements |
|
INVALID_REPEAT_DELAY |
The value repeatDelay doesn't follow the requirements |
|
INVALID_SCHEDULE_END_AT |
The value scheduleEndAt doesn't follow the requirements |
|
INVALID_SELECTED-EVENT |
The value doesn't follow the requirements | |
INVALID_SERVER_ID |
The server id is invalid | |
INVALID_SHARE_WITH |
The value shareWith doesn't follow the requirements |
|
INVALID_SHARED_PLAYER_UUID |
One of the shared player uuid is invalid, the same uuid of the author or the category is not equals to private |
|
INVALID_TARGET_EVENT_DATE |
The target event date is invalid | |
INVALID_TARGET-EVENT-FROM-DATE |
The value doesn't follow the requirements | |
INVALID_TITLE |
The value title doesn't follow the requirements |
|
INVALID_TO_DATE |
The value toDate doesn't follow the requirements |
|
INVALID_VALIDATE_PRESENCE_MAXIMUM_DELAY |
The value validatePresenceMaximumDelay doesn't follow the requirements |
|
INVALID_VALIDATE_PRESENCE_MINIMUM_DELAY |
The value validatePresenceMinimumDelay doesn't follow the requirements |
|
INVALID_WEEK_OF_THE_MONTH |
The value weekOfTheMonth doesn't follow the requirements |
|
MISSING_BODY |
The request does not have a body | |
MISSING_CREATE_CHANNEL |
The createChannel value is missing |
|
MISSING_CREATE_CHANNEL_BEFORE_DELAY |
The createChannelBeforeDelay value is missing |
|
MISSING_DAY_OF_THE_MONTH |
The dayOfTheMonth value is missing |
|
MISSING_DAY_OF_THE_WEEK |
The dayOfTheWeek value is missing |
|
MISSING_DELETE_CHANNEL_AFTER_DELAY |
The deleteChannelAfterDelay value is missing |
|
MISSING_MONTH_OF_THE_YEAR |
The monthOfTheYear value is missing |
|
MISSING_PARTICIPANTS |
The participants value is missing |
|
MISSING_REPEAT_DELAY |
The repeatDelay value is missing |
|
MISSING_SCHEDULE_END_AT |
The scheduleEndAt value is missing |
|
MISSING_SHARE_WITH |
The shareWith value is missing |
|
MISSING_VALIDATE_PRESENCE_MAXIMUM_DELAY |
The validatePresenceMaximumDelay value is missing |
|
MISSING_VALIDATE_PRESENCE_MINIMUM_DELAY |
The validatePresenceMinimumDelay value is missing |
|
MISSING_WEEK_OF_THE_MONTH |
The weekOfTheMonth value is missing |
|
NO_PRESENCE_DELAY |
You must set the presence delay if the type is meeting |
|
SCHEDULE_EVENT_END_AT_MUST_BE_AFTER_TO_DATE |
The schedule event end at must be after the to date | |
UNAUTHORIZED |
The token is invalid or expired | |
ACCESS_DENIED |
The token or the author does not have the required permissions | |
DISCORD_CONNECTION_REQUIRED |
You need a Discord account link to your Steam Account to access to the route | |
SERVER_NOT_FOUND |
The server does not exist | |
TARGET_EVENT_DATE_NOT_FOUND |
The target event date was not found | |
INTERNAL_ERROR |
An internal error has occured |
"OK"
number
number
string
string
date
date
date | null
string | null
string
number
string
string | null
string | null
number
number
number
string
string
number | null
number
string
date | null
string
string
number
string
string
string | null
date
date
string
boolean
date | null
date | null
date | null
number | null
number | null
number | null
number | null
number | null
number
string
string
date
date
date | null
string | null
string
number
string
string | null
string | null
number
number
number
string
string
number | null
number
string
date | null
string
string
boolean | null
boolean | null
boolean
string | null
boolean | null
number | null
number
number
number
string
string
date
date | null
date | null
date | null
string
boolean
date | null
date | null
date | null
number | null
number | null
number | null
number | null
number | null
number
string
string
date
date
date | null
string | null
string
number
string
string | null
string | null
number
number
number
string
string
number | null
number
string
date | null
string
string
boolean | null
boolean | null
boolean
string | null
boolean | null
number | null
number | null
number | null
number | null
number | null
boolean | null
number
string
string
date
date
date | null
string | null
string
number
string
string | null
string | null
number
number
number
string
string
number | null
number
string
date | null
string
string
number
number
string
date | null
string
string
number
date | null
string | null
string | null
date
date | null
string
number | null
number | null
number | null
number | null
boolean | null
date
date
number
string
string
date
date
date | null
string | null
string
number
string
string | null
string | null
number
number
number
string
string
number | null
number
string
date | null
string
string
number
number
string
date | null
string
string
number
date | null
string | null
string | null
date
date | null
calendar_events.delete
delete permission on the event
administrator global permission
| Name | Type | Description |
|---|---|---|
| serverId | number | The server id |
| eventId | number | The event id to delete |
| Name | Type | Description | Default |
|---|---|---|---|
| target-event-from-date | date | If the event is a schedule event, you can specify the date of the event to delete | ❌ |
| selected-event | string | If the event is a schedule event, you can specify if you want to delete the current event or the next ones (enum: ) |
this |
| Status | Code | Description |
|---|---|---|
OK |
The request has been successfully completed | |
INVALID_SELECTED-EVENT |
The value doesn't follow the requirements | |
INVALID_SERVER_ID |
The server id is invalid | |
INVALID_TARGET_EVENT_DATE |
The target event date is invalid | |
INVALID_TARGET-EVENT-FROM-DATE |
The value doesn't follow the requirements | |
UNAUTHORIZED |
The token is invalid or expired | |
ACCESS_DENIED |
The token or the author does not have the required permissions | |
DISCORD_CONNECTION_REQUIRED |
You need a Discord account link to your Steam Account to access to the route | |
SERVER_NOT_FOUND |
The server does not exist | |
TARGET_EVENT_NOT_FOUND |
The target event date was not found | |
INTERNAL_ERROR |
An internal error has occured |
"OK"