package
0.0.6
Repository: https://github.com/aydev-fr/isen-api.git
Documentation: pkg.go.dev

# Functions

AbsencesGet gin Handler for /absences endpoint @Summary List user's absences @Description Get user's absences @Produce json @Success 200 {array} isen.Absence @Failure 400 {object} HTTPError @Failure 500 {object} HTTPError @Failure 504 {object} HTTPError @Security ApiKeyAuth @Router /absences [get].
AgendaGet gin Handler for /agenda endpoint @Summary Get user's agenda @Description Returns a list of all user's courses between start and end timestamps.
CreateKey creates a package specific key for a given string.
EventAgendaGet gin Handler for /agenda/event/{eventId} endpoint @Summary Get informations from a specific event @Description Get informations of an agenda event from its ID @Produce json @Param eventId path string true "Agenda Event ID" @Success 200 {object} isen.ScheduleEventDetails @Failure 400 {object} HTTPError @Failure 500 {object} HTTPError @Failure 504 {object} HTTPError @Security ApiKeyAuth @Router /agenda/event/{eventId} [get].
No description provided by the author
No description provided by the author
NotationsClassGet gin Handler for /notations/class endpoint @Summary List user's class notations @Description Get a list of all user's class notes with min, average and max note @Produce json @Success 200 {array} isen.Notation @Failure 400 {object} HTTPError @Failure 500 {object} HTTPError @Failure 504 {object} HTTPError @Security ApiKeyAuth @Router /notations/class [get].
NotationsGet gin Handler for /notations endpoint @Summary List user's notations @Description Get user's notations @Produce json @Success 200 {array} isen.Notation @Failure 400 {object} HTTPError @Failure 500 {object} HTTPError @Failure 504 {object} HTTPError @Security ApiKeyAuth @Router /notations [get].
PersonalInformationsGet gin Handler for /personal-informations endpoint @Summary List user's personal informations @Description Get user's personal informations @Produce json @Success 200 {object} isen.PersonalInformations @Failure 400 {object} HTTPError @Failure 500 {object} HTTPError @Failure 504 {object} HTTPError @Security ApiKeyAuth @Router /personal-informations [get].
TokenPost gin Handler for /token endpoint @Summary Get ISEN Token @Description Get ISEN Token needed for every authenticated request @Accept json @Produce plain @Param account body aurion.Login true "Account credentials" @Success 200 {string} string @Failure 400 {object} HTTPError @Failure 401 {object} HTTPError @Failure 500 {object} HTTPError @Failure 504 {object} HTTPError @Router /token [post].

# Structs

No description provided by the author
Route is the information for every URI.

# Type aliases

Routes is the list of the generated Route.