| Both sides previous revision Previous revision Next revision | Previous revision |
| en:2.0:individueller_aufruf_der_module [2020/12/31 10:53] – fasse | en:2.0:individueller_aufruf_der_module [2024/12/08 19:17] (current) – [What links and parameters are available?] greno |
|---|
| |
| ===== 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:** |
| Calling the login page with link to registration and redirection to the page specified in the settings.\\ \\ | Calling the login page with link to registration and redirection to the page specified in the settings.\\ \\ |
| ''Link: http://www.example.org/admidio-folder/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 === |
| Logout of the user with redirection to the page specified in the settings.\\ \\ | Logout of the user with redirection to the page specified in the settings.\\ \\ |
| === Registration === | === Registration === |
| New users can register using this form.\\ \\ | New users can register using this form.\\ \\ |
| ''Link: http://www.example.org/admidio-folder/adm_program/system/registration.php'' | ''Link: http://www.example.org/admidio-folder/adm_program/modules/profile/profile_new.php'' |
| \\ \\ | \\ \\ |
| === Announcements === | === Announcements === |
| ''Link: http://www.example.org/admidio-folder/adm_program/modules/announcements/annnouncements.php'' | ''Link: http://www.example.org/admidio-folder/adm_program/modules/announcements/annnouncements.php'' |
| ^ Parameter ^ Value ^ Description ^ | ^ Parameter ^ Value ^ Description ^ |
| | headline | Designation | Freely selectable name for the module instead of announcements. | | |
| | date_from | Format: System setting | View all announcements as of this date. | | | date_from | Format: System setting | View all announcements as of this date. | |
| | date_to | Format: System setting | View all announcements up to this date. | | | date_to | Format: System setting | View all announcements up to this date. | |
| | cat_id | Id of a category | Displays all announcements of this category. | | | cat_uuid | UUID of a category | Displays all announcements of this category. | |
| | id | Id of an announcement | Displays only this one announcement. | | | ann_uuid | UUID of an announcement | Displays only this one announcement. | |
| |
| === Documents & Files === | === Documents & Files === |
| ''Link: http://www.example.org/admidio-folder/adm_program/modules/documents-files/documents_files.php'' | ''Link: http://www.example.org/admidio-folder/adm_program/modules/documents-files/documents_files.php'' |
| ^ Parameter ^ Value ^ Description ^ | ^ Parameter ^ Value ^ Description ^ |
| | folder_id | Folder ID | Specifying the ID of the file folder to be displayed. | | | folder_uuid | Folder UUID | Specifying the UUID of the file folder to be displayed. | |
| |
| === E-mail === | === E-mail === |
| ''Link: http://www.example.org/admidio-folder/adm_program/modules/messages/messages_write.php'' | ''Link: http://www.example.org/admidio-folder/adm_program/modules/messages/messages_write.php'' |
| ^ Parameter ^ Value ^ Description ^ | ^ Parameter ^ Value ^ Description ^ |
| | rol_id | Id of the role | Id of the role to whose members an e-mail is sent. | | | role_uuid | UUID of the role | UUID of the role to whose members an e-mail is sent. | |
| | usr_id | Id of the user | Id of the user to whom 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. | | | 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. | | | 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. | |
| |
| === Photos === | === Photos === |
| ''Link: http://www.example.org/admidio-folder/adm_program/modules/photos/photos.php'' | ''Link: http://www.example.org/admidio-folder/adm_program/modules/photos/photos.php'' |
| ^ Parameter ^ Value ^ Description ^ | ^ Parameter ^ Value ^ Description ^ |
| | headline | Designation | Freely selectable name for the module instead of photos. | | | pho_uuid | UUID of an album | Displays the photos of this album. | |
| | pho_id | Id of an album | Displays the photos of this album. | | |
| |
| === E-cards === | === E-cards === |
| ''Link: http://www.example.org/admidio-folder/adm_program/modules/ecards/ecard_form.php'' | ''Link: http://www.example.org/admidio-folder/adm_program/modules/ecards/ecard_form.php'' |
| ^ Parameter ^ Value ^ Description ^ | ^ Parameter ^ Value ^ Description ^ |
| | pho_id | Id eines Albums | Id des Fotoalbums, dessen Bild Sie senden möchten. | | | photo_uuid | UUID of an album | UUID of the photo album whose image you want to send. | |
| | photo_nr | Nummer eines Fotos | Nummer des Fotos des gewählten Albums für das eine Grußkarte erstellt werden soll. | | | photo_nr | Number of a photo | Number of the photo of the selected album for which a greeting card is to be created. | |
| | | user_uuid | UUID of a member | UUID of the member to whom the ecard should be sent. | |
| |
| === Guestbook === | === Guestbook === |
| ''Link: http://www.example.org/admidio-folder/adm_program/modules/guestbook/guestbook.php'' | ''Link: http://www.example.org/admidio-folder/adm_program/modules/guestbook/guestbook.php'' |
| ^ Parameter ^ Value ^ Description ^ | ^ Parameter ^ Value ^ Description ^ |
| | headline | Designation | Frei wählbare Bezeichnung für das Modul anstelle von Gästebuch | | | gbo_uuid | UUID of an entry | Displays only this guestbook entry. | |
| | id | Id eines Eintrags | Zeigt nur diesen Gästebucheintrag an. | | |
| |
| === Groups & Roles === | === Groups & Roles === |
| ''Link: http://www.example.org/admidio-folder/adm_program/modules/groups-roles/groups-roles.php'' | ''Link: http://www.example.org/admidio-folder/adm_program/modules/groups-roles/groups-roles.php'' |
| ^ Parameter ^ Value ^ Description ^ | ^ Parameter ^ Value ^ Description ^ |
| | cat_id | Id einer Kategorie | Id einer Kategorie deren Rollen angezeigt werden sollen | | | cat_uuid | UUID of a category | UUID of a category whose roles should be displayed. | |
| | role_type | 0 \\ 1 (Default) \\ 2 | nur inaktive Rollen\\ Alle aktive Rollen \\ Nur Terminteilnehmerrollen | | | role_type | 0 \\ 1 (Default) \\ 2 | Inactive roles only \\ All active roles \\ Appointment participant roles only | |
| | show | card (default)\\ permissions | Alle Gruppen und Rollen in der Kartenansicht anzeigen \\ Berechtigungen aller Gruppen und Rollen in der Listenansicht anzeigen. | | | show | card (default)\\ permissions | Show all groups and roles in map view. \\ Show permissions of all groups and roles in list view. | |
| |
| === Own lists === | === Own lists === |
| ''Link: http://www.example.org/admidio-folder/adm_program/modules/groups-roles/mylist.php'' | ''Link: http://www.example.org/admidio-folder/adm_program/modules/groups-roles/mylist.php'' |
| ^ Parameter ^ Value ^ Description ^ | ^ Parameter ^ Value ^ Description ^ |
| | active_role | 1 (default)\\ 0 | Alle aktiven Rollen der Organisation\\ Nur die inaktiven Rollen der Organisation | | | list_uuid | UUID of a list | UUID of a list to be displayed. | |
| | show_members | 0 (default) \\ 1 \\ 2 | Alle aktive Mitglieder\\ Alle ehemalige Mitglieder\\ Alle aktiven und ehemaligen Mitglieder | | | active_role | 1 (default)\\ 0 | All active roles of the organization.\\ Only the inactive roles of the organization. | |
| | | show_members | 0 (default) \\ 1 \\ 2 | All active members\\ All former members\\ All active and former members | |
| |
| === Profile === | === Profile === |
| ''Link: http://www.example.org/admidio-folder/adm_program/modules/profile/profile.php'' | ''Link: http://www.example.org/admidio-folder/adm_program/modules/profile/profile.php'' |
| ^ Parameter ^ Value ^ Description ^ | ^ 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. | | | 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. | |
| |
| === Events === | === Events === |
| ''Link: http://www.example.org/admidio-folder/adm_program/modules/dates/dates.php'' | ''Link: http://www.example.org/admidio-folder/adm_program/modules/dates/dates.php'' |
| ^ Parameter ^ Value ^ Description ^ | ^ Parameter ^ Value ^ Description ^ |
| | headline | Designation | Frei wählbare Bezeichnung für das Modul anstelle von Termine | | | date_from | Format: System setting | Show all events from this date. | |
| | date_from | Format: System setting | Alle Termine ab diesem Datum anzeigen lassen. | | | date_to | Format: System setting | Display all events up to this date. | |
| | date_to | Format: System setting | Alle Termine bis zu diesem Datum anzeigen lassen. | | | cat_uuid | Calendar UUID | Display all events for the passed calendar. | |
| | cat_id | Id des Kalenders | Alle Termine für den übergebenen Kalender anzeigen lassen | | | dat_uuid | UUID of an event | Displays only this one event. | |
| | id | Id eines Termins | Zeigt nur diesen einen Termin an. | | | mode | actual(default)\\ old\\ all | All upcoming events displayed.\\ Only show the already past events.\\ All upcoming and already past events are displayed. | |
| | mode | actual(default)\\ old\\ all | Alle kommenden Termine angezeigt.\\ Nur die bereits vergangenen Termine angezeigen. | | | 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. | |
| | 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 | 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 | 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 \\ | Detailed standard html view.\\ Events are presented in a compact list without unnecessary graphical elements. | |
| | view_mode | html \\ print \\ | Ausführliche Standard-Html-Ansicht.\\ Termine werden in einer kompakten Liste ohne unnötige grafische Elemente dargestellt. | | |
| |
| === Web links === | === Web links === |
| ''Link: http://www.example.org/admidio-folder/adm_program/modules/links/links.php'' | ''Link: http://www.example.org/admidio-folder/adm_program/modules/links/links.php'' |
| ^ Parameter ^ Value ^ Description ^ | ^ Parameter ^ Value ^ Description ^ |
| | headline | Designation | Frei wählbare Bezeichnung für das Modul anstelle von Weblinks | | | cat_uuid | UUID of a category | Displays all web links of this category. | |
| | cat_id | Id einer Kategorie | Zeigt alle Weblinks dieser Kategorie an. | | | link_uuid | UUID of a web link | Displays only this one web link. | |
| | id | Id eines Weblinks | Zeigt nur diesen einen Weblink an. | | |
| | ===== How can I embed a page in an iFrame? ===== |
| | 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:\\ |
| | {{:en:2.0:documentation:iframe.png?600|Admidio page with reduced content}} |
| |
| | 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''. |
