| Both sides previous revision Previous revision Next revision | Previous revision |
| en:2.0:individueller_aufruf_der_module [2020/12/31 08:41] – fasse | en:2.0:individueller_aufruf_der_module [2025/11/23 15:47] (current) – greno |
|---|
| ====== Which modules can I call? ====== | ====== Individual call of the modules ====== |
| | ===== Which modules can I call? ===== |
| Admidio usually runs as a standalone program, which you can access via a link from your existing homepage. But maybe you want to link single modules or pages of Admidio directly. An overview of the possible modules can be found in our menu. In addition, there are other pages which you can integrate directly and, if necessary, adapt to your ideas via further parameters. | Admidio usually runs as a standalone program, which you can access via a link from your existing homepage. But maybe you want to link single modules or pages of Admidio directly. An overview of the possible modules can be found in our menu. In addition, there are other pages which you can integrate directly and, if necessary, adapt to your ideas via further parameters. |
| |
| |
| ===== What links and parameters are available? ===== | ===== What links and parameters are available? ===== |
| All parameters given here are optional. Each module can be called without the respective parameters. you should only pass them if the desired change is needed. | All parameters given here are optional. Each module can be called without the respective parameters. You should only pass them if the desired change is needed. |
| |
| The parameters are appended directly to the URL. you simply put a **?** after the URL and then you can write the parameter name. After a **=** then follows the value. If you want to append more than one parameter, the parameters are separated by a **&**. | The parameters are appended directly to the URL. You simply put a **?** after the URL and then you can write the parameter name. After a **=** then follows the value. If you want to append more than one parameter, the parameters are separated by a **&**. |
| |
| ''Example: http://www.example.org/.../mail.php?rol_id=1&subject=My-private-email'' | ''Example: http://www.example.org/.../messages_write.php?role_uuid=550e8400-e29b-11d4-a716-446655440000&subject=My-private-email'' |
| |
| **Note:** | **Note:** |
| There must be no spaces or special characters in the complete URL. This also applies to the parameters. If you still want to pass a value with a space, you can simply write **%20** instead of the space. | There must be no spaces or special characters in the complete URL. This also applies to the parameters. If you still want to pass a value with a space, you can simply write **%20** instead of the space. |
| |
| === Loginseite === | === Login page === |
| Aufruf der Loginseite mit Link zur Registrierung und Weiterleitung zu der in den Einstellungen festgelegten Seite.\\ \\ | Calling the login page with link to registration and redirection to the page specified in the settings.\\ \\ |
| ''Link: http://www.example.org/admidio-ordner/adm_program/system/login.php'' | ''Link: http://www.example.org/admidio-folder/adm_program/system/login.php'' |
| \\ \\ | ^ Parameter ^ Value ^ Description ^ |
| | | organization_short_name | Shortname of organization | The short name of a stored organization that should be preselected on the login page. (from version 4.3) | |
| === Logout === | === Logout === |
| Ausloggen des Benutzers mit Weiterleitung zu der in den Einstellungen festgelegten Seite.\\ \\ | Logout of the user with redirection to the page specified in the settings.\\ \\ |
| ''Link: http://www.example.org/admidio-ordner/adm_program/system/logout.php'' | ''Link: http://www.example.org/admidio-folder/adm_program/system/logout.php'' |
| \\ \\ | \\ \\ |
| === Registrierung === | === Registration === |
| Neue Benutzer können sich über dieses Formular registrieren.\\ \\ | New users can register using this form.\\ \\ |
| ''Link: http://www.example.org/admidio-ordner/adm_program/system/registration.php'' | ''Link: http://www.example.org/admidio-folder/adm_program/modules/profile/profile_new.php'' |
| \\ \\ | \\ \\ |
| === Ankündigungen === | === Announcements === |
| Liste mit allen erfassten Ankündigungen. Berechtige Benutzer haben hier die Möglichkeit Ankündigungen zu erfassen, editieren oder zu löschen.\\ \\ | List with all recorded announcements. Authorized users have the possibility to enter, edit or delete announcements here.\\ \\ |
| ''Link: http://www.example.org/admidio-ordner/adm_program/modules/announcements/annnouncements.php'' | ''Link: http://www.example.org/admidio-folder/adm_program/modules/announcements/annnouncements.php'' |
| ^ Parameter ^ Wert ^ Beschreibung ^ | ^ Parameter ^ Value ^ Description ^ |
| | headline | Bezeichnung | Frei wählbare Bezeichnung für das Modul anstelle von Ankündigungen | | | date_from | Format: System setting | View all announcements as of this date. | |
| | date_from | Format: Systemeinstellung | Alle Ankündigungen ab diesem Datum anzeigen lassen. | | | date_to | Format: System setting | View all announcements up to this date. | |
| | date_to | Format: Systemeinstellung | Alle Ankündigungen bis zu diesem Datum anzeigen lassen. | | | cat_uuid | UUID of a category | Displays all announcements of this category. | |
| | cat_id | Id einer Kategorie | Zeigt alle Ankündigungen dieser Kategorie an. | | | ann_uuid | UUID of an announcement | Displays only this one announcement. | |
| | id | Id einer Ankündigung | Zeigt nur diese eine Ankündigung an. | | |
| | === Documents & Files === |
| | Listing of various documents or files in a freely selectable folder structure. Folders can also be shared only with specific user groups.\\ \\ |
| | ''Link: http://www.example.org/admidio-folder/adm_program/modules/documents-files/documents_files.php'' |
| | ^ Parameter ^ Value ^ Description ^ |
| | | folder_uuid | Folder UUID | Specifying the UUID of the file folder to be displayed. | |
| | |
| | === E-mail === |
| | Sending e-mails to all members of specific roles. Without parameters, the logged-in user can select roles or other users via a selection box.\\ \\ |
| | ''Link: http://www.example.org/admidio-folder/adm_program/modules/messages/messages_write.php'' |
| | ^ Parameter ^ Value ^ Description ^ |
| | | role_uuid | UUID of the role | UUID of the role to whose members an e-mail is sent. | |
| | | user_uuid | UUID of the user | UUID of the user to whom an e-mail is sent. | |
| | | subject | Subject | Subject of the e-mail can be preset with this. | |
| | | carbon_copy | 1\\ 0 (default) | Flag whether a copy should be sent to the sender. | |
| | | msg_type | EMAIL (Default)\\ PM | Specify whether to create an e-mail or a private message. | |
| |
| === Dokumente & Dateien === | === Photos === |
| Auflisten von verschiedenen Dokumenten oder Dateien in einer frei wählbaren Ordnerstruktur. Ordner können auch nur für bestimmte Nutzergruppen freigegeben werden.\\ \\ | Display of a photo gallery. Authorized users can create, maintain and delete new albums.\\ \\ |
| ''Link: http://www.example.org/admidio-ordner/adm_program/modules/documents-files/documents_files.php'' | ''Link: http://www.example.org/admidio-folder/adm_program/modules/photos/photos.php'' |
| ^ Parameter ^ Wert ^ Beschreibung ^ | ^ Parameter ^ Value ^ Description ^ |
| | folder_id | ID des Ordners | Angabe der ID des Dateiordners, der angezeigt werden soll | | | pho_uuid | UUID of an album | Displays the photos of this album. | |
| |
| === E-Mail === | === E-cards === |
| Verschicken von E-Mails an alle Mitglieder bestimmter Rollen. Ohne Parameter, kann der angemeldete Benutzer Rollen oder andere Benutzer über eine Auswahlbox auswählen.\\ \\ | By selecting an image in the photo module, you can send it to one or more recipients within the organization, or to external recipients with any text.\\ \\ |
| ''Link: http://www.example.org/admidio-ordner/adm_program/modules/messages/messages_write.php'' | ''Link: http://www.example.org/admidio-folder/adm_program/modules/ecards/ecard_form.php'' |
| ^ Parameter ^ Wert ^ Beschreibung ^ | ^ Parameter ^ Value ^ Description ^ |
| | rol_id | Id der Rolle | Id der Rolle, an deren Mitglieder eine E-Mail geschickt wird. | | | photo_uuid | UUID of an album | UUID of the photo album whose image you want to send. | |
| | usr_id | Id des Benutzer | Id des Benutzers, an den eine E-Mail geschickt wird. | | | photo_nr | Number of a photo | Number of the photo of the selected album for which a greeting card is to be created. | |
| | subject | Betreff | Betreff der E-Mail kann hiermit vorbelegt werden. | | | user_uuid | UUID of a member | UUID of the member to whom the ecard should be sent. | |
| | carbon_copy | 1\\ 0(default) | Flag, ob eine Kopie an den Absender verschickt werden soll. | | |
| |
| === Fotos === | === Guestbook === |
| Anzeige einer Fotogalerie. Berechtigte Benutzer können neue Alben anlegen, pflegen und löschen.\\ \\ | The guestbook was removed from version 5 onwards. |
| ''Link: http://www.example.org/admidio-ordner/adm_program/modules/photos/photos.php'' | |
| ^ Parameter ^ Wert ^ Beschreibung ^ | |
| | headline | Bezeichnung | Frei wählbare Bezeichnung für das Modul anstelle von Ankündigungen | | |
| | pho_id | Id eines Albums | Zeigt die Fotos dieses Albums an. | | |
| |
| === Grußkarten === | A guestbook with commenting function for members of certain roles.\\ \\ |
| Durch Auswahl eines Bildes im Foto-Modul kann man dieses an einen oder mehrere Empfänger innerhalb der Organisation oder auch außenstehende mit einem beliebigen Text versehen senden.\\ \\ | ''Link: http://www.example.org/admidio-folder/adm_program/modules/guestbook/guestbook.php'' |
| ''Link: http://www.example.org/admidio-ordner/adm_program/modules/ecards/ecard_form.php'' | ^ Parameter ^ Value ^ Description ^ |
| ^ Parameter ^ Wert ^ Beschreibung ^ | | gbo_uuid | UUID of an entry | Displays only this guestbook entry. | |
| | pho_id | Id eines Albums | Id des Fotoalbums, dessen Bild Sie senden möchten. | | |
| | photo_nr | Nummer eines Fotos | Nummer des Fotos des gewählten Albums für das eine Grußkarte erstellt werden soll. | | |
| |
| === Gästebuch === | === Groups & Roles === |
| Ein Gästebuch mit Kommentierfunktion für Mitglieder bestimmter Rollen.\\ \\ | Overview of all roles with call of different member lists for each group or role.\\ \\ |
| ''Link: http://www.example.org/admidio-ordner/adm_program/modules/guestbook/guestbook.php'' | ''Link: http://www.example.org/admidio-folder/adm_program/modules/groups-roles/groups-roles.php'' |
| ^ Parameter ^ Wert ^ Beschreibung ^ | ^ Parameter ^ Value ^ Description ^ |
| | headline | Bezeichnung | Frei wählbare Bezeichnung für das Modul anstelle von Gästebuch | | | cat_uuid | UUID of a category | UUID of a category whose roles should be displayed. | |
| | id | Id eines Eintrags | Zeigt nur diesen Gästebucheintrag an. | | | role_type | 0 \\ 1 (Default) \\ 2 | Inactive roles only \\ All active roles \\ Appointment participant roles only | |
| | | show | card (default)\\ permissions | Show all groups and roles in map view. \\ Show permissions of all groups and roles in list view. | |
| |
| === Gruppen & Rollen === | === Own lists === |
| Übersicht über alle Rollen mit Aufruf verschiedener Mitgliederlisten zu jeder Rolle.\\ \\ | Here you can create an individual member list for a role. Columns, sorting and conditions are freely selectable.\\ \\ |
| ''Link: http://www.example.org/admidio-ordner/adm_program/modules/groups-roles/groups-roles.php'' | ''Link: http://www.example.org/admidio-folder/adm_program/modules/groups-roles/mylist.php'' |
| ^ Parameter ^ Wert ^ Beschreibung ^ | ^ Parameter ^ Value ^ Description ^ |
| | cat_id | Id einer Kategorie | Id einer Kategorie deren Rollen angezeigt werden sollen | | | list_uuid | UUID of a list | UUID of a list to be displayed. | |
| | role_type | 0 \\ 1 (Default) \\ 2 | nur inaktive Rollen\\ Alle aktive Rollen \\ Nur Terminteilnehmerrollen | | | active_role | 1 (default)\\ 0 | All active roles of the organization.\\ Only the inactive roles of the organization. | |
| | show | card (default)\\ permissions | Alle Gruppen und Rollen in der Kartenansicht anzeigen \\ Berechtigungen aller Gruppen und Rollen in der Listenansicht anzeigen. | | | show_members | 0 (default) \\ 1 \\ 2 | All active members\\ All former members\\ All active and former members | |
| |
| === Eigene Listen === | === Profile === |
| Hier kann eine individuelle Mitgliederliste zu einer Rolle erstellt werden. Spalten, Sortierung und Bedingungen sind frei wählbar.\\ \\ | The profile of a user. The profile of the currently logged in user is automatically displayed.\\ \\ |
| ''Link: http://www.example.org/admidio-ordner/adm_program/modules/groups-roles/mylist.php'' | ''Link: http://www.example.org/admidio-folder/adm_program/modules/profile/profile.php'' |
| ^ Parameter ^ Wert ^ Beschreibung ^ | ^ Parameter ^ Value ^ Description ^ |
| | active_role | 1 (default)\\ 0 | Alle aktiven Rollen der Organisation\\ Nur die inaktiven Rollen der Organisation | | | user_uuid | UUID of a user | If this parameter is set, then the profile of this user is displayed. Without the parameter, the own profile is always displayed. | |
| | show_members | 0 (default) \\ 1 \\ 2 | Alle aktive Mitglieder\\ Alle ehemalige Mitglieder\\ Alle aktiven und ehemaligen Mitglieder | | |
| |
| === Profil === | === Events === |
| Das Profil eines Benutzers. Es wird automatisch das Profil des aktuell eingeloggten Benutzers angezeigt.\\ \\ | List with all recorded events. Authorized users have the possibility to enter, edit or delete events here.\\ \\ |
| ''Link: http://www.example.org/admidio-ordner/adm_program/modules/profile/profile.php'' | ''Link: http://www.example.org/admidio-folder/adm_program/modules/dates/dates.php'' |
| ^ Parameter ^ Wert ^ Beschreibung ^ | ^ Parameter ^ Value ^ Description ^ |
| | user_id | Id eines Benutzers | Wird dieser Parameter gesetzt, dann wird das Profil dieses Benutzers angezeigt. Ohne den Parameter wird immer das eigene Profil angezeigt. | | | date_from | Format: System setting | Show all events from this date. | |
| | | date_to | Format: System setting | Display all events up to this date. | |
| | | cat_uuid | Calendar UUID | Display all events for the passed calendar. | |
| | | dat_uuid | UUID of an event | Displays only this one event. | |
| | | mode | actual(default)\\ old\\ all | All upcoming events displayed.\\ Only show the already past events.\\ All upcoming and already past events are displayed. | |
| | | show | all(default)\\ maybe_participate\\ only_participate | Show all events.\\ Show only events where the current user is logged in or can log in.\\ Show only events where the current user is logged in. | |
| | | view | detail\\ compact\\ room\\ participants | Detailed standard html view.\\ Events are displayed in a compact one-line list.\\ Events with room assignment are displayed.\\ Participants of events are displayed in a list with. | |
| | | view_mode | html \\ print \\ | Detailed standard html view.\\ Events are presented in a compact list without unnecessary graphical elements. | |
| |
| === Termine === | === Web links === |
| Liste mit allen erfassten Terminen. Berechtige Benutzer haben hier die Möglichkeit Termine zu erfassen, editieren oder zu löschen.\\ \\ | List of all registered links. Authorized users can add new links here and edit or delete old ones.\\ \\ |
| ''Link: http://www.example.org/admidio-ordner/adm_program/modules/dates/dates.php'' | ''Link: http://www.example.org/admidio-folder/adm_program/modules/links/links.php'' |
| ^ Parameter ^ Wert ^ Beschreibung ^ | ^ Parameter ^ Value ^ Description ^ |
| | headline | Bezeichnung | Frei wählbare Bezeichnung für das Modul anstelle von Termine | | | cat_uuid | UUID of a category | Displays all web links of this category. | |
| | date_from | Format: Systemeinstellung | Alle Termine ab diesem Datum anzeigen lassen. | | | link_uuid | UUID of a web link | Displays only this one web link. | |
| | date_to | Format: Systemeinstellung | Alle Termine bis zu diesem Datum anzeigen lassen. | | |
| | cat_id | Id des Kalenders | Alle Termine für den übergebenen Kalender anzeigen lassen | | |
| | id | Id eines Termins | Zeigt nur diesen einen Termin an. | | |
| | mode | actual(default)\\ old\\ all | Alle kommenden Termine angezeigt.\\ Nur die bereits vergangenen Termine angezeigen. | | |
| | show | all(default)\\ maybe_participate\\ only_participate | Alle Termine anzeigen.\\ Nur Termine anzeigen bei denen der aktuelle Benutzer angemeldet ist oder sich anmelden kann.\\ Nur Termine anzeigen bei denen der aktuelle Benutzer angemeldet ist. | | |
| | view | detail\\ compact\\ room\\ participants | Ausführliche Standard-Html-Ansicht. \\ Termine werden in einer kompakten einzeiligen Liste dargestellt. \\ Termine mit Raumzuordnung werden angezeigt. \\ Teilnehmer von Terminen werden in einer Liste mit angezeigt. | | |
| | view_mode | html \\ print \\ | Ausführliche Standard-Html-Ansicht.\\ Termine werden in einer kompakten Liste ohne unnötige grafische Elemente dargestellt. | | |
| |
| === Weblinks === | ===== How can I embed a page in an iFrame? ===== |
| Liste aller eingetragenen Links. Berechtigte Benutzer können hier neue Links hinzufügen und Alte bearbeiten oder löschen.\\ \\ | If you want to embed a module or any Admidio page in an iFrame, you can do this using one of the links documented here. In many cases, you do not want to display the menu or the page header, but only the actual content of the page, as shown in the following screenshot:\\ |
| ''Link: http://www.example.org/admidio-ordner/adm_program/modules/links/links.php'' | {{:en:2.0:documentation:iframe.png?600|Admidio page with reduced content}} |
| ^ Parameter ^ Wert ^ Beschreibung ^ | |
| | headline | Bezeichnung | Frei wählbare Bezeichnung für das Modul anstelle von Weblinks | | |
| | cat_id | Id einer Kategorie | Zeigt alle Weblinks dieser Kategorie an. | | |
| | id | Id eines Weblinks | Zeigt nur diesen einen Weblink an. | | |
| |
| | To achieve this, from version 4.3.6 you can append the query parameter ''iframe'' with the value ''1'' to every page call.\\ |
| | ''Example: http://www.example.org/admidio-ordner/adm_program/modules/announcements/annnouncements.php?iframe=1''\\ |
| | Admidio remembers the setting. If a user now clicks on a link on this page, the page that is then called up is also displayed with the reduced content. If you want to insert another link where you want to display the full Admidio page, set the query parameter ''iframe'' to the value ''0''. |
