Relesys API Docs

v1.3

https://api.relesysapp.net/api/v1.3

Welcome

Introduction Getting access

Concepts

Scopes HTTP Status Codes Request Throttling Pagination Filtering Sorting Patch Requests Permissions Notifications Markdown Syntax Module Settings

Endpoints

Events

List
GET /calendarmodules/{moduleId}/calendars/{calendarId}/events 
https://api.relesysapp.net/api/v1.3/calendarmodules/{moduleId}/calendars/{calendarId}/events
Get a list of events.

type - This field displays the type of the events. Currently, the available types are:
  • Event
  • ToDo
Default sort is by start in ascending order.
Scopes: relesys.api, relesys.api:read, relesys.api.calendars, relesys.api.calendars:read
URL Path
moduleId string / guid required
calendarId string / guid required
Query String
attendanceConfirmationEnabled boolean Filterable optional
attendancePointsAmount integer Filterable optional
categoryId string / guid Filterable optional
creationDateTime datetimeoffset Filterable Sortable optional
end datetimeoffset Filterable Sortable optional
endTimeZone string Filterable optional
id string / guid Filterable optional
individualInvitationsEnabled boolean Filterable optional
isCancelled boolean Filterable optional
lastModifiedDateTime datetimeoffset Filterable Sortable optional
location string Filterable Sortable optional
registrationDeadlineDaysBeforeStart integer Filterable optional
registrationEndDate datetimeoffset Filterable Sortable optional
registrationStartDate datetimeoffset Filterable Sortable optional
signupEnabled boolean Filterable optional
signupLimit integer Filterable optional
start datetimeoffset Filterable Sortable optional
startTimeZone string Filterable optional
type string Filterable Sortable optional
sort string Comma separated sort order based on sortable properties optional
offset integer Offset value for use in pagination Default: 0 optional
limit integer Total objects to fetch (max 1000) Default: 200 optional
Responses
application/json
200
Schema
object
  count integer      
  ⯈ data array[object]      
   attendanceConfirmationEnabled boolean      
   attendancePointsAmount integer      
   ⯈ attendanceServiceForms array[object]      
    type string      
    url string      
   categoryId string / guid      
   categoryUrl string      
   creationDateTime datetimeoffset      
   end datetimeoffset      
   endTimeZone string      
   id string / guid      
   individualInvitationsEnabled boolean      
   isCancelled boolean      
   lastModifiedDateTime datetimeoffset      
   ⯈ locales array[object]      
    culture string      
    summary string      
    title string      
   location string      
   registrationDeadlineDaysBeforeStart integer      
   registrationEndDate datetimeoffset      
   registrationStartDate datetimeoffset      
   signupEnabled boolean      
   signupLimit integer      
   start datetimeoffset      
   startTimeZone string      
   type string      
   url string      
  nextUrl string      
  previousUrl string