| Type: | Package |
| Title: | Interface for 'Semestry TermTime' Services |
| Version: | 0.0.1 |
| Description: | Provides an R interface for interacting with the 'Semestry TermTime' services. It allows users to retrieve scheduling data from the API. see https://github.com/vusaverse/vvtermtime/blob/main/openapi_7.7.0.pdf for details. |
| URL: | https://github.com/vusaverse/vvtermtime, https://vusaverse.github.io/vvtermtime/ |
| License: | MIT + file LICENSE |
| Encoding: | UTF-8 |
| RoxygenNote: | 7.2.3 |
| Imports: | httr, jsonlite, magrittr |
| Suggests: | knitr, rmarkdown |
| VignetteBuilder: | knitr |
| NeedsCompilation: | no |
| Packaged: | 2023-08-07 11:48:47 UTC; rstudio |
| Author: | Tomer Iwan [aut, cre, cph] |
| Maintainer: | Tomer Iwan <t.iwan@vu.nl> |
| Repository: | CRAN |
| Date/Publication: | 2023-08-07 17:40:03 UTC |
Pipe operator
Description
See magrittr::%>% for details.
Usage
lhs %>% rhs
Arguments
lhs |
A value or the magrittr placeholder. |
rhs |
A function call using the magrittr semantics. |
Value
The result of calling rhs(lhs).
Authenticate with Semestry Termtime API
Description
This function authenticates with the Semestry Termtime API by verifying the API key and base URL. It returns an authenticated Semestry object that can be used for subsequent API calls.
Usage
authenticate(api_key, base_url)
Arguments
api_key |
The API key for Semestry. |
base_url |
The base URL of the Semestry API. |
Value
An authenticated Semestry object.
Retrieve activity report attr from the Semestry API
Description
This function sends a GET request to the report room endpoint of the Semestry API and retrieves the room booking data.
Usage
get_activities_report_attr(semestry, timeout = 30)
Arguments
semestry |
An authenticated Semestry object. |
timeout |
The timeout duration for the GET request (default: 30 seconds). |
Value
The retrieved activity report data from the API.
Retrieve activity report schedule from the Semestry API
Description
This function sends a GET request to the report room endpoint of the Semestry API and retrieves the room booking data.
Usage
get_activities_report_sche(semestry, timeout = 30)
Arguments
semestry |
An authenticated Semestry object. |
timeout |
The timeout duration for the GET request (default: 30 seconds). |
Value
The retrieved activity report data from the API.
Retrieve building data from the Semestry API
Description
This function sends a GET request to the buildings endpoint of the Semestry API and retrieves the building data.
Usage
get_buildings(semestry, timeout = 30)
Arguments
semestry |
An authenticated Semestry object. |
timeout |
The timeout duration for the GET request (default: 30 seconds). |
Value
The retrieved building data from the API.
Retrieve campus data from the Semestry API
Description
This function sends a GET request to the campuses endpoint of the Semestry API and retrieves the campus data.
Usage
get_campuses(semestry, timeout = 30)
Arguments
semestry |
An authenticated Semestry object. |
timeout |
The timeout duration for the GET request (default: 30 seconds). |
Value
The retrieved campus data from the API.
Retrieve course data from the Semestry API
Description
This function sends a GET request to the courses endpoint of the Semestry API and retrieves the course data.
Usage
get_courses(semestry, timeout = 30)
Arguments
semestry |
An authenticated Semestry object. |
timeout |
The timeout duration for the GET request (default: 30 seconds). |
Value
The retrieved course data from the API.
Examples
## Not run:
semestry <- authenticate_semestry()
get_courses(semestry)
## End(Not run)
Retrieve data from the Semestry API database endpoint
Description
This function sends a GET request to the database endpoint of the Semestry API and retrieves the data.
Usage
get_database(semestry, timeout = 30)
Arguments
semestry |
An authenticated Semestry object. |
timeout |
The timeout duration for the GET request (default: 30 seconds). |
Value
The retrieved data from the API database.
Retrieve department data from the Semestry API
Description
This function sends a GET request to the departments endpoint of the Semestry API and retrieves the department data.
Usage
get_departments(semestry, timeout = 30)
Arguments
semestry |
An authenticated Semestry object. |
timeout |
The timeout duration for the GET request (default: 30 seconds). |
Value
The retrieved department data from the API.
Retrieve module data from the Semestry API
Description
This function sends a GET request to the modules endpoint of the Semestry API and retrieves the module data.
Usage
get_modules(semestry, timeout = 30)
Arguments
semestry |
An authenticated Semestry object. |
timeout |
The timeout duration for the GET request (default: 30 seconds). |
Value
The retrieved module data from the API.
Retrieve offers from the Semestry API
Description
This function sends a GET request to the offers endpoint of the Semestry API and retrieves the offers.
Usage
get_offers(semestry, timeout = 30)
Arguments
semestry |
An authenticated Semestry object. |
timeout |
The timeout duration for the GET request (default: 30 seconds). |
Value
The retrieved offers from the API.
Examples
## Not run:
semestry <- authenticate_semestry()
get_offers(semestry)
## End(Not run)
Retrieve booking report from the Semestry API
Description
This function sends a GET request to the report booking endpoint of the Semestry API and retrieves the booking booking data.
Usage
get_report_booking(semestry, timeout = 30)
Arguments
semestry |
An authenticated Semestry object. |
timeout |
The timeout duration for the GET request (default: 30 seconds). |
Value
The retrieved report booking data from the API.
Retrieve room report from the Semestry API
Description
This function sends a GET request to the report room endpoint of the Semestry API and retrieves the room booking data.
Usage
get_report_room(semestry, timeout = 30)
Arguments
semestry |
An authenticated Semestry object. |
timeout |
The timeout duration for the GET request (default: 30 seconds). |
Value
The retrieved report room data from the API.
Retrieve room booking data from the Semestry API
Description
This function sends a GET request to the roombookings endpoint of the Semestry API and retrieves the room booking data.
Usage
get_roombookings(semestry, timeout = 30)
Arguments
semestry |
An authenticated Semestry object. |
timeout |
The timeout duration for the GET request (default: 30 seconds). |
Value
The retrieved room booking data from the API.
Retrieve room data from the Semestry API
Description
This function sends a GET request to the rooms endpoint of the Semestry API and retrieves the room data.
Usage
get_rooms(semestry, timeout = 30)
Arguments
semestry |
An authenticated Semestry object. |
timeout |
The timeout duration for the GET request (default: 30 seconds). |
Value
The retrieved room data from the API.
Examples
## Not run:
semestry <- authenticate_semestry()
get_rooms(semestry)
## End(Not run)
Retrieve schedule rooms data from the Semestry API
Description
This function sends a GET request to the schedule/rooms endpoint of the Semestry API and retrieves the schedule rooms data.
Usage
get_schedule_rooms(semestry, timeout = 30)
Arguments
semestry |
An authenticated Semestry object. |
timeout |
The timeout duration for the GET request (default: 30 seconds). |
Value
The retrieved schedule rooms data from the API.
Retrieve staff data from the Semestry API
Description
This function sends a GET request to the staff endpoint of the Semestry API and retrieves the staff data.
Usage
get_staff(semestry, timeout = 30)
Arguments
semestry |
An authenticated Semestry object. |
timeout |
The timeout duration for the GET request (default: 30 seconds). |
Value
The retrieved staff data from the API.
Examples
## Not run:
semestry <- authenticate_semestry()
get_staff(semestry)
## End(Not run)
Retrieve staff pools from the Semestry API
Description
This function sends a GET request to the staffpools endpoint of the Semestry API and retrieves the staff pools.
Usage
get_staff_pools(semestry, timeout = 30)
Arguments
semestry |
An authenticated Semestry object. |
timeout |
The timeout duration for the GET request (default: 30 seconds). |
Value
The retrieved staff pools from the API.
Retrieve student group mapppings from the Semestry API
Description
This function sends a GET request to the studentgroupmaps endpoint of the Semestry API and retrieves the student group mappings data.
Usage
get_student_group_maps(semestry, timeout = 30)
Arguments
semestry |
An authenticated Semestry object. |
timeout |
The timeout duration for the GET request (default: 30 seconds). |
Value
The retrieved student group maps from the API.
Retrieve student data from the Semestry API
Description
This function sends a GET request to the students endpoint of the Semestry API and retrieves the student data.
Usage
get_students(semestry, timeout = 30)
Arguments
semestry |
An authenticated Semestry object. |
timeout |
The timeout duration for the GET request (default: 30 seconds). |
Value
The retrieved student data from the API.
Examples
## Not run:
semestry <- authenticate_semestry()
get_students(semestry)
## End(Not run)
Retrieve timeframes data from the Semestry API
Description
This function sends a GET request to the timeframes endpoint of the Semestry API and retrieves the timeframes data.
Usage
get_timeframes(semestry, timeout = 30)
Arguments
semestry |
An authenticated Semestry object. |
timeout |
The timeout duration for the GET request (default: 30 seconds). |
Value
The retrieved timeframes data from the API.
Retrieve webhook data from the Semestry API
Description
This function sends a GET request to the webhooks endpoint of the Semestry API and retrieves the webhook data.
Usage
get_webhooks(semestry, timeout = 30)
Arguments
semestry |
An authenticated Semestry object. |
timeout |
The timeout duration for the GET request (default: 30 seconds). |
Value
The retrieved webhook data from the API.