fsi.path
========

.. py:module:: fsi.path


Functions
---------

.. autoapisummary::

   fsi.path.get_course_details
   fsi.path.get_course_event_details
   fsi.path.get_past_events_view
   fsi.path.get_events_view
   fsi.path.get_courses
   fsi.path.get_attendees
   fsi.path.get_attendee_details
   fsi.path.get_notification_templates
   fsi.path.get_template_details
   fsi.path.get_reservations
   fsi.path.get_reservation_details
   fsi.path.get_audit


Module Contents
---------------

.. py:function:: get_course_details(request: onegov.fsi.request.FsiRequest, id: uuid.UUID) -> onegov.fsi.models.course.Course | None

.. py:function:: get_course_event_details(request: onegov.fsi.request.FsiRequest, id: uuid.UUID) -> onegov.fsi.models.course_event.CourseEvent | None

.. py:function:: get_past_events_view(request: onegov.fsi.request.FsiRequest, page: int = 0, show_hidden: bool = False, course_id: uuid.UUID | None = None) -> onegov.fsi.collections.course_event.PastCourseEventCollection

.. py:function:: get_events_view(request: onegov.fsi.request.FsiRequest, page: int = 0, from_date: datetime.datetime | None = None, upcoming_only: bool = False, past_only: bool = False, limit: int | None = None, show_hidden: bool = True, course_id: uuid.UUID | None = None, sort_desc: bool = False) -> onegov.fsi.collections.course_event.CourseEventCollection

.. py:function:: get_courses(request: onegov.fsi.request.FsiRequest, show_hidden_from_public: bool) -> onegov.fsi.collections.course.CourseCollection

.. py:function:: get_attendees(request: onegov.fsi.request.FsiRequest, page: int = 0, exclude_external: bool = False, external_only: bool = False, editors_only: bool = False, admins_only: bool = False) -> onegov.fsi.collections.attendee.CourseAttendeeCollection

   This collection has permission private, so no members can see it


.. py:function:: get_attendee_details(request: onegov.fsi.request.FsiRequest, id: uuid.UUID) -> onegov.fsi.models.course_attendee.CourseAttendee | None

.. py:function:: get_notification_templates(request: onegov.fsi.request.FsiRequest, course_event_id: uuid.UUID | None = None) -> onegov.fsi.collections.notification_template.CourseNotificationTemplateCollection

.. py:function:: get_template_details(request: onegov.fsi.request.FsiRequest, id: uuid.UUID) -> onegov.fsi.models.course_notification_template.CourseNotificationTemplate | None

.. py:function:: get_reservations(request: onegov.fsi.request.FsiRequest, course_event_id: uuid.UUID | None = None, attendee_id: uuid.UUID | None = None, external_only: bool = False, page: int = 0) -> onegov.fsi.collections.subscription.SubscriptionsCollection

.. py:function:: get_reservation_details(request: onegov.fsi.request.FsiRequest, id: uuid.UUID) -> onegov.fsi.models.course_subscription.CourseSubscription | None

.. py:function:: get_audit(request: onegov.fsi.request.FsiRequest, course_id: uuid.UUID | None, organisations: list[str], page: int = 0, letter: str | None = None) -> onegov.fsi.collections.audit.AuditCollection | None