org.path

Contains the paths to the different models served by onegov.org.

Classes

ShortLink

Functions

get_org(app) → onegov.org.models.Organisation

get_short_link(app, name) → ShortLink | None

view_short_link(self, request) → webob.Response

get_auth(app[, to, skip, signup_token]) → onegov.user.Auth

get_mtan_auth(app[, to]) → onegov.org.auth.MTANAuth

get_user(app, id) → onegov.user.User | None

get_users(app, request[, q, active, role, tag, ...]) → onegov.user.UserCollection

get_audit_entries(app[, page, operation]) → onegov.core.orm.audit.AuditEntryCollection

get_audit_entry(app, id) → onegov.core.orm.audit.AuditEntry | None

get_user_group(app, id) → onegov.user.UserGroup | None

get_user_groups(app) → onegov.user.UserGroupCollection[onegov.user.UserGroup]

get_topic(app, absorb) → onegov.org.models.Topic | None

get_news(request, absorb, filter_years, filter_tags[, ...]) → onegov.org.models.News | onegov.org.models.NewsCollection | None

get_files(request[, order_by]) → onegov.org.models.GeneralFileCollection

get_images(app) → onegov.org.models.ImageFileCollection

get_exports(request, app) → onegov.org.models.ExportCollection

get_export(request, app, id) → onegov.org.models.Export | None

get_forms(app) → onegov.form.FormCollection

get_form(app, name) → onegov.form.FormDefinition | None

get_surveys(app) → onegov.form.collection.SurveyCollection | None

get_survey(app, name) → onegov.form.models.definition.SurveyDefinition | None

get_pending_survey_submission(app, id) → onegov.form.models.submission.SurveySubmission | None

get_pending_form_submission(app, id) → onegov.form.PendingFormSubmission | None

get_complete_form_submission(app, id) → onegov.form.CompleteFormSubmission | None

get_form_registration_window(request, id) → onegov.form.FormRegistrationWindow | None

get_survey_submission_window(request, id) → onegov.form.models.survey_window.SurveySubmissionWindow | None

get_file_for_org(request, app, id) → onegov.file.File | None

Some files are kept private and out of any caches.

get_editor(app, action, trait[, page_id]) → onegov.org.models.Editor | None

get_people(app) → onegov.people.PersonCollection

get_person(app, id) → onegov.people.Person | None

get_chats(app[, page, state]) → onegov.chat.collections.ChatCollection

get_chat(app, id) → onegov.chat.models.Chat | None

get_ticket(app, handler_code, id) → onegov.ticket.Ticket | None

get_tickets(request[, handler, state, page, group, ...]) → onegov.ticket.TicketCollection | None

get_archived_tickets(request[, handler, page, group, ...]) → onegov.ticket.collection.ArchivedTicketCollection

get_ticket_note(app, id) → onegov.org.models.TicketNote | None

get_resources(app) → onegov.reservation.ResourceCollection

get_find_my_spot(app[, group, subgroup]) → onegov.org.models.resource.FindYourSpotCollection

get_resource(app, name[, date, view, highlights_min, ...]) → onegov.reservation.Resource | None

get_allocation(app, resource, id) → onegov.reservation.Allocation | None

get_reservation(app, resource, id) → onegov.reservation.Reservation | None

get_reservation_blocker(app, resource, id) → libres.db.models.ReservationBlocker | None

get_clipboard(request, token) → onegov.org.models.Clipboard | None

get_sitecollection(app) → onegov.org.models.SiteCollection

get_page_move(app, subject_id, direction, target_id) → onegov.org.models.PageMove | None

get_person_move(app, key, subject, direction, target) → onegov.org.models.PagePersonMove | None

get_form_move(app, key, subject, direction, target) → onegov.org.models.FormPersonMove | None

get_resource_move(app, key, subject, direction, target) → onegov.org.models.ResourcePersonMove | None

get_occurrences(app, request[, page, range, start, ...]) → onegov.event.OccurrenceCollection

get_occurrence(app, name) → onegov.event.Occurrence | None

get_event(app, name) → onegov.event.Event | None

get_search(request[, q, type, plain, page]) → onegov.org.models.Search

get_a_to_z(request) → onegov.org.models.AtoZPages

get_newsletters(app) → onegov.newsletter.NewsletterCollection

get_newsletter(app, name) → onegov.newsletter.Newsletter | None

get_newsletter_recipients(app) → onegov.newsletter.RecipientCollection

get_subscription(app, recipient_id, token) → onegov.newsletter.Subscription | None

get_entry_subscription(app, recipient_id, token) → onegov.directory.models.directory.EntrySubscription | None

get_legacy_file(app, filename) → onegov.org.models.LegacyFile | None

get_image(app, filename) → onegov.org.models.LegacyImage | None

get_image_sets(app) → onegov.org.models.ImageSetCollection

get_image_set(app, id) → onegov.org.models.ImageSet | None

get_resource_recipient_collection(app) → onegov.org.models.ResourceRecipientCollection

get_resource_recipient(app, id) → onegov.org.models.ResourceRecipient | None

get_payment_provider_collection(app) → onegov.pay.PaymentProviderCollection | None

get_payment_provider(app, id) → onegov.pay.PaymentProvider[onegov.pay.Payment] | None

get_payment(app, id) → onegov.pay.Payment | None

get_expand_ticket_group(request) → collections.abc.Callable[[list[str]], list[str]]

get_payments(request[, source, page, start, end, ...]) → onegov.pay.PaymentCollection

get_invoices(request[, page, g, ticket_start, ...]) → onegov.ticket.TicketInvoiceCollection

get_messages(app[, channel_id, type, newer_than, ...]) → onegov.chat.MessageCollection[Any]

get_text_modules(app) → onegov.chat.TextModuleCollection

get_text_module(app, id) → onegov.chat.TextModule | None

get_directories(app) → onegov.directory.DirectoryCollection[onegov.org.models.ExtendedDirectory]

get_directory(app, name) → onegov.directory.Directory | None

get_directory_entries(request, app, directory_name, ...) → onegov.org.models.directory.ExtendedDirectoryEntryCollection | None

get_directory_entry(app, directory_name, name) → onegov.directory.DirectoryEntry | None

get_directory_submission_action(app, directory_id, ...) → onegov.org.models.DirectorySubmissionAction | None

get_publication_collection(request[, year]) → onegov.org.models.PublicationCollection

get_dashboard(request) → onegov.org.models.Dashboard | None

get_citizen_dashboard(request) → onegov.org.models.CitizenDashboard | None

get_external_link_collection(request[, type]) → onegov.org.models.external_link.ExternalLinkCollection

get_external_link(request, id) → onegov.org.models.external_link.ExternalLink | None

get_document_form_collection(request[, type]) → onegov.org.models.document_form.FormDocumentCollection

get_document_form_page(app, name) → onegov.org.models.document_form.FormDocument | None

get_qr_code(app, payload[, border, box_size, ...]) → onegov.qrcode.QrCode

get_api_key_for_delete(request, key) → onegov.api.models.ApiKey | None

get_sent_notification_collection(request) → onegov.org.models.PushNotificationCollection

get_parliamentarians(app[, active, party]) → onegov.org.models.RISParliamentarianCollection

get_parliamentarian(app, id) → onegov.org.models.RISParliamentarian | None

get_parliamentarian_roles(app) → onegov.org.models.RISParliamentarianRoleCollection

get_parliamentarian_role(app, id) → onegov.org.models.RISParliamentarianRole | None

get_parliamentary_groups(app[, active]) → onegov.org.models.RISParliamentaryGroupCollection

get_parliamentary_group(app, id) → onegov.org.models.RISParliamentaryGroup | None

get_commissions(app[, active]) → onegov.org.models.RISCommissionCollection

get_commission(app, id[, active_members]) → onegov.org.models.RISCommission | None

get_meetings(app[, past]) → onegov.org.models.MeetingCollection

get_meeting(app, id) → onegov.org.models.Meeting | None

get_political_businesses(request[, page, q, status, ...]) → onegov.org.models.PoliticalBusinessCollection

get_political_business(request, id) → onegov.org.models.PoliticalBusiness | None

get_meeting_item(app, id) → onegov.org.models.MeetingItem | None

get_commission_membership(app, id) → onegov.org.models.RISCommissionMembership | None

Module Contents

org.path.get_org(app: onegov.org.app.OrgApp) → onegov.org.models.Organisation[source]
__slots__ = ('name', 'to')[source]
name[source]
to[source]
org.path.get_auth(app: onegov.org.app.OrgApp, to: str = '/', skip: bool = False, signup_token: str | None = None) → onegov.user.Auth[source]
org.path.get_mtan_auth(app: onegov.org.app.OrgApp, to: str = '/') → onegov.org.auth.MTANAuth[source]
org.path.get_user(app: onegov.org.app.OrgApp, id: uuid.UUID) → onegov.user.User | None[source]
org.path.get_users(app: onegov.org.app.OrgApp, request: onegov.org.request.OrgRequest, q: str | None = None, active: list[bool] | None = None, role: list[str] | None = None, tag: list[str] | None = None, provider: list[str] | None = None, source: list[str] | None = None) → onegov.user.UserCollection[source]
org.path.get_audit_entries(app: onegov.org.app.OrgApp, page: int = 0, operation: str | None = None) → onegov.core.orm.audit.AuditEntryCollection[source]
org.path.get_audit_entry(app: onegov.org.app.OrgApp, id: uuid.UUID) → onegov.core.orm.audit.AuditEntry | None[source]
org.path.get_user_group(app: onegov.org.app.OrgApp, id: uuid.UUID) → onegov.user.UserGroup | None[source]
org.path.get_user_groups(app: onegov.org.app.OrgApp) → onegov.user.UserGroupCollection[onegov.user.UserGroup][source]
org.path.get_topic(app: onegov.org.app.OrgApp, absorb: str) → onegov.org.models.Topic | None[source]
org.path.get_news(request: onegov.org.request.OrgRequest, absorb: str, filter_years: list[int], filter_tags: list[str], page: int = 0) → onegov.org.models.News | onegov.org.models.NewsCollection | None[source]
org.path.get_files(request: onegov.org.request.OrgRequest, order_by: str = 'name') → onegov.org.models.GeneralFileCollection[source]
org.path.get_images(app: onegov.org.app.OrgApp) → onegov.org.models.ImageFileCollection[source]
org.path.get_exports(request: onegov.org.request.OrgRequest, app: onegov.org.app.OrgApp) → onegov.org.models.ExportCollection[source]
org.path.get_export(request: onegov.org.request.OrgRequest, app: onegov.org.app.OrgApp, id: str) → onegov.org.models.Export | None[source]
org.path.get_forms(app: onegov.org.app.OrgApp) → onegov.form.FormCollection[source]
org.path.get_form(app: onegov.org.app.OrgApp, name: str) → onegov.form.FormDefinition | None[source]
org.path.get_surveys(app: onegov.org.app.OrgApp) → onegov.form.collection.SurveyCollection | None[source]
org.path.get_survey(app: onegov.org.app.OrgApp, name: str) → onegov.form.models.definition.SurveyDefinition | None[source]
org.path.get_pending_survey_submission(app: onegov.org.app.OrgApp, id: uuid.UUID) → onegov.form.models.submission.SurveySubmission | None[source]
org.path.get_pending_form_submission(app: onegov.org.app.OrgApp, id: uuid.UUID) → onegov.form.PendingFormSubmission | None[source]
org.path.get_complete_form_submission(app: onegov.org.app.OrgApp, id: uuid.UUID) → onegov.form.CompleteFormSubmission | None[source]
org.path.get_form_registration_window(request: onegov.org.request.OrgRequest, id: uuid.UUID) → onegov.form.FormRegistrationWindow | None[source]
org.path.get_survey_submission_window(request: onegov.org.request.OrgRequest, id: uuid.UUID) → onegov.form.models.survey_window.SurveySubmissionWindow | None[source]
org.path.get_file_for_org(request: onegov.org.request.OrgRequest, app: onegov.org.app.OrgApp, id: str) → onegov.file.File | None[source]

Some files are kept private and out of any caches.

This approach is not all that morepath-y, as we could override the views instead to change the required permissions, but this approach has the advantage that we don’t need to overwrite multiple views and we do not have to care for additional views added in the future.

org.path.get_editor(app: onegov.org.app.OrgApp, action: str, trait: str, page_id: int = 0) → onegov.org.models.Editor | None[source]
org.path.get_people(app: onegov.org.app.OrgApp) → onegov.people.PersonCollection[source]
org.path.get_person(app: onegov.org.app.OrgApp, id: uuid.UUID) → onegov.people.Person | None[source]
org.path.get_chats(app: onegov.org.app.OrgApp, page: int = 0, state: str = 'active') → onegov.chat.collections.ChatCollection[source]
org.path.get_chat(app: onegov.org.app.OrgApp, id: uuid.UUID) → onegov.chat.models.Chat | None[source]
org.path.get_ticket(app: onegov.org.app.OrgApp, handler_code: str, id: uuid.UUID) → onegov.ticket.Ticket | None[source]
org.path.get_tickets(request: onegov.org.request.OrgRequest, handler: str = 'ALL', state: onegov.ticket.collection.ExtendedTicketState | None = 'open', page: int = 0, group: str | None = None, owner: str | None = None, submitter: str | None = None, q: str | None = None, extra_parameters: dict[str, str] | None = None) → onegov.ticket.TicketCollection | None[source]
org.path.get_archived_tickets(request: onegov.org.request.OrgRequest, handler: str = 'ALL', page: int = 0, group: str | None = None, owner: str | None = None, submitter: str | None = None, q: str | None = None, extra_parameters: dict[str, str] | None = None) → onegov.ticket.collection.ArchivedTicketCollection[source]
org.path.get_ticket_note(app: onegov.org.app.OrgApp, id: str) → onegov.org.models.TicketNote | None[source]
org.path.get_resources(app: onegov.org.app.OrgApp) → onegov.reservation.ResourceCollection[source]
org.path.get_find_my_spot(app: onegov.org.app.OrgApp, group: str | None = None, subgroup: str | None = None) → onegov.org.models.resource.FindYourSpotCollection[source]
org.path.get_resource(app: onegov.org.app.OrgApp, name: str, date: get_resource.date | None = None, view: str | None = None, highlights_min: int | None = None, highlights_max: int | None = None) → onegov.reservation.Resource | None[source]
org.path.get_allocation(app: onegov.org.app.OrgApp, resource: uuid.UUID, id: int) → onegov.reservation.Allocation | None[source]
org.path.get_reservation(app: onegov.org.app.OrgApp, resource: uuid.UUID, id: int) → onegov.reservation.Reservation | None[source]
org.path.get_reservation_blocker(app: onegov.org.app.OrgApp, resource: uuid.UUID, id: int) → libres.db.models.ReservationBlocker | None[source]
org.path.get_clipboard(request: onegov.org.request.OrgRequest, token: str) → onegov.org.models.Clipboard | None[source]
org.path.get_sitecollection(app: onegov.org.app.OrgApp) → onegov.org.models.SiteCollection[source]
org.path.get_page_move(app: onegov.org.app.OrgApp, subject_id: int, direction: onegov.core.orm.abstract.MoveDirection, target_id: int) → onegov.org.models.PageMove | None[source]
org.path.get_person_move(app: onegov.org.app.OrgApp, key: int, subject: str, direction: onegov.core.orm.abstract.MoveDirection, target: str) → onegov.org.models.PagePersonMove | None[source]
org.path.get_form_move(app: onegov.org.app.OrgApp, key: str, subject: str, direction: onegov.core.orm.abstract.MoveDirection, target: str) → onegov.org.models.FormPersonMove | None[source]
org.path.get_resource_move(app: onegov.org.app.OrgApp, key: uuid.UUID, subject: str, direction: onegov.core.orm.abstract.MoveDirection, target: str) → onegov.org.models.ResourcePersonMove | None[source]
org.path.get_occurrences(app: onegov.org.app.OrgApp, request: onegov.org.request.OrgRequest, page: int = 0, range: onegov.event.collections.occurrences.DateRange | None = None, start: datetime.date | None = None, end: datetime.date | None = None, tags: list[str] | None = None, filter_keywords: dict[str, list[str]] | None = None, locations: list[str] | None = None, search: str | None = None, search_query: dict[str, Any] | None = None) → onegov.event.OccurrenceCollection[source]
org.path.get_occurrence(app: onegov.org.app.OrgApp, name: str) → onegov.event.Occurrence | None[source]
org.path.get_event(app: onegov.org.app.OrgApp, name: str) → onegov.event.Event | None[source]
org.path.get_a_to_z(request: onegov.org.request.OrgRequest) → onegov.org.models.AtoZPages[source]
org.path.get_newsletters(app: onegov.org.app.OrgApp) → onegov.newsletter.NewsletterCollection[source]
org.path.get_newsletter(app: onegov.org.app.OrgApp, name: str) → onegov.newsletter.Newsletter | None[source]
org.path.get_newsletter_recipients(app: onegov.org.app.OrgApp) → onegov.newsletter.RecipientCollection[source]
org.path.get_subscription(app: onegov.org.app.OrgApp, recipient_id: uuid.UUID, token: str) → onegov.newsletter.Subscription | None[source]
org.path.get_entry_subscription(app: onegov.org.app.OrgApp, recipient_id: uuid.UUID, token: str) → onegov.directory.models.directory.EntrySubscription | None[source]
org.path.get_legacy_file(app: onegov.org.app.OrgApp, filename: str) → onegov.org.models.LegacyFile | None[source]
org.path.get_image(app: onegov.org.app.OrgApp, filename: str) → onegov.org.models.LegacyImage | None[source]
org.path.get_image_sets(app: onegov.org.app.OrgApp) → onegov.org.models.ImageSetCollection[source]
org.path.get_image_set(app: onegov.org.app.OrgApp, id: str) → onegov.org.models.ImageSet | None[source]
org.path.get_resource_recipient_collection(app: onegov.org.app.OrgApp) → onegov.org.models.ResourceRecipientCollection[source]
org.path.get_resource_recipient(app: onegov.org.app.OrgApp, id: uuid.UUID) → onegov.org.models.ResourceRecipient | None[source]
org.path.get_payment_provider_collection(app: onegov.org.app.OrgApp) → onegov.pay.PaymentProviderCollection | None[source]
org.path.get_payment_provider(app: onegov.org.app.OrgApp, id: uuid.UUID) → onegov.pay.PaymentProvider[onegov.pay.Payment] | None[source]
org.path.get_payment(app: onegov.org.app.OrgApp, id: uuid.UUID) → onegov.pay.Payment | None[source]
org.path.get_expand_ticket_group(request: onegov.org.request.OrgRequest) → collections.abc.Callable[[list[str]], list[str]][source]
org.path.get_payments(request: onegov.org.request.OrgRequest, source: str = '*', page: int = 0, start: datetime.datetime | None = None, end: datetime.datetime | None = None, status: str | None = None, payment_type: str | None = None, g: list[str] | None = None, ticket_start: datetime.date | None = None, ticket_end: datetime.date | None = None, reservation_start: datetime.date | None = None, reservation_end: datetime.date | None = None, reservation_reference_date: Literal['final', 'any'] | None = None, extra_parameters: dict[str, Any] | None = None) → onegov.pay.PaymentCollection[source]
org.path.get_invoices(request: onegov.org.request.OrgRequest, page: int = 0, g: list[str] | None = None, ticket_start: datetime.date | None = None, ticket_end: datetime.date | None = None, reservation_start: datetime.date | None = None, reservation_end: datetime.date | None = None, reservation_reference_date: Literal['final', 'any'] | None = None, has_payment: bool | None = None, invoiced: bool | None = None, extra_parameters: dict[str, Any] | None = None) → onegov.ticket.TicketInvoiceCollection[source]
org.path.get_messages(app: onegov.org.app.OrgApp, channel_id: str = '*', type: str = '*', newer_than: str | None = None, older_than: str | None = None, limit: int = 25, load: str = 'older-first') → onegov.chat.MessageCollection[Any][source]
org.path.get_text_modules(app: onegov.org.app.OrgApp) → onegov.chat.TextModuleCollection[source]
org.path.get_text_module(app: onegov.org.app.OrgApp, id: uuid.UUID) → onegov.chat.TextModule | None[source]
org.path.get_directories(app: onegov.org.app.OrgApp) → onegov.directory.DirectoryCollection[onegov.org.models.ExtendedDirectory][source]
org.path.get_directory(app: onegov.org.app.OrgApp, name: str) → onegov.directory.Directory | None[source]
org.path.get_directory_entries(request: onegov.org.request.OrgRequest, app: onegov.org.app.OrgApp, directory_name: str, keywords: dict[str, list[str]], page: int = 0, search: str | None = None, search_query: dict[str, Any] | None = None, published_only: bool = False, past_only: bool = False, upcoming_only: bool = False) → onegov.org.models.directory.ExtendedDirectoryEntryCollection | None[source]
org.path.get_directory_entry(app: onegov.org.app.OrgApp, directory_name: str, name: str) → onegov.directory.DirectoryEntry | None[source]
org.path.get_directory_submission_action(app: onegov.org.app.OrgApp, directory_id: uuid.UUID, submission_id: uuid.UUID, action: str) → onegov.org.models.DirectorySubmissionAction | None[source]
org.path.get_publication_collection(request: onegov.org.request.OrgRequest, year: int | None = None) → onegov.org.models.PublicationCollection[source]
org.path.get_dashboard(request: onegov.org.request.OrgRequest) → onegov.org.models.Dashboard | None[source]
org.path.get_citizen_dashboard(request: onegov.org.request.OrgRequest) → onegov.org.models.CitizenDashboard | None[source]
org.path.get_document_form_collection(request: onegov.org.request.OrgRequest, type: str | None = None) → onegov.org.models.document_form.FormDocumentCollection[source]
org.path.get_document_form_page(app: onegov.org.app.OrgApp, name: str) → onegov.org.models.document_form.FormDocument | None[source]
org.path.get_qr_code(app: onegov.org.app.OrgApp, payload: str, border: int | None = None, box_size: int | None = None, fill_color: str | None = None, back_color: str | None = None, img_format: str | None = None, encoding: Literal['base64'] | None = None) → onegov.qrcode.QrCode[source]
org.path.get_api_key_for_delete(request: onegov.org.request.OrgRequest, key: uuid.UUID) → onegov.api.models.ApiKey | None[source]
org.path.get_sent_notification_collection(request: onegov.org.request.OrgRequest) → onegov.org.models.PushNotificationCollection[source]
org.path.get_parliamentarians(app: onegov.org.app.OrgApp, active: list[bool] | None = None, party: list[str] | None = None) → onegov.org.models.RISParliamentarianCollection[source]
org.path.get_parliamentarian(app: onegov.org.app.OrgApp, id: uuid.UUID) → onegov.org.models.RISParliamentarian | None[source]
org.path.get_parliamentarian_roles(app: onegov.org.app.OrgApp) → onegov.org.models.RISParliamentarianRoleCollection[source]
org.path.get_parliamentarian_role(app: onegov.org.app.OrgApp, id: uuid.UUID) → onegov.org.models.RISParliamentarianRole | None[source]
org.path.get_parliamentary_groups(app: onegov.org.app.OrgApp, active: bool = True) → onegov.org.models.RISParliamentaryGroupCollection[source]
org.path.get_parliamentary_group(app: onegov.org.app.OrgApp, id: uuid.UUID) → onegov.org.models.RISParliamentaryGroup | None[source]
org.path.get_commissions(app: onegov.org.app.OrgApp, active: bool = True) → onegov.org.models.RISCommissionCollection[source]
org.path.get_commission(app: onegov.org.app.OrgApp, id: uuid.UUID, active_members: bool | None = None) → onegov.org.models.RISCommission | None[source]
org.path.get_meetings(app: onegov.org.app.OrgApp, past: bool = True) → onegov.org.models.MeetingCollection[source]
org.path.get_meeting(app: onegov.org.app.OrgApp, id: uuid.UUID) → onegov.org.models.Meeting | None[source]
org.path.get_political_businesses(request: onegov.org.request.OrgRequest, page: int = 0, q: str | None = None, status: list[onegov.org.models.political_business.PoliticalBusinessStatus] | None = None, types: list[onegov.org.models.political_business.PoliticalBusinessType] | None = None, years: list[int] | None = None) → onegov.org.models.PoliticalBusinessCollection[source]
org.path.get_political_business(request: onegov.org.request.OrgRequest, id: uuid.UUID) → onegov.org.models.PoliticalBusiness | None[source]
org.path.get_meeting_item(app: onegov.org.app.OrgApp, id: uuid.UUID) → onegov.org.models.MeetingItem | None[source]
org.path.get_commission_membership(app: onegov.org.app.OrgApp, id: uuid.UUID) → onegov.org.models.RISCommissionMembership | None[source]