API¶
Authorization¶
To have access to the api, an authorization is required. You can configure users via typoscript. This configuration is set global (plugin.tx_slubevents.settings.api.users) in the plugin and not for a specific plugin.
Constants |
Type |
Comment |
|---|---|---|
settings.api.users.0.username |
String |
Username to authorize access |
settings.api.users.0.password |
String |
Password to authorize access |
Feel free to add further users. If you have one user with empty username or empty password, the authorization will fail.
In default these values are empty for security. So, if you get no data, check this configuration.
Event list¶
The API delivers a json formatted list with events. You can manipulate the list with additional parameter.
You have to call this API with a special page type. Just attach "?type=1452982642" to your project url and typoscript calls the extension "slubevents" and the plugin "apieventlist".
Additional parameter¶
Parameter |
Type |
Comment |
|---|---|---|
tx_slubevents_apieventlist[category] |
String|Integer |
Comma separated list of category ids |
tx_slubevents_apieventlist[discipline] |
String|Integer |
Comma separated list of discipline ids |
tx_slubevents_apieventlist[contact] |
String|Integer |
Comma separated list of contact ids |
tx_slubevents_apieventlist[showPastEvents] |
Integer (0|1) |
Default is to show events beginning with today |
tx_slubevents_apieventlist[showEventsFromNow] |
Integer (0|1) |
Additional setting for "showPastEvents" |
tx_slubevents_apieventlist[limitByNextWeeks] |
Integer |
Set a limit for the next weeks |
tx_slubevents_apieventlist[startTimestamp] |
Integer (Timestamp) |
Influence the start date, works together with stopTimestamp |
tx_slubevents_apieventlist[stopTimestamp] |
Integer (Timestamp) |
Influence the stop date, works together with startTimestamp |
tx_slubevents_apieventlist[sorting] |
String (asc|desc) |
Default value is ascending |
tx_slubevents_apieventlist[limit] |
Integer |
Limit quantity of result data |
If you use these parameter and have trouble add "tx_slubevents_apieventlist" in [FE][cacheHash][cachedParametersWhiteList] and [FE][cacheHash][excludedParameters].
Typoscript constants¶
Constant |
Type |
Comment |
|---|---|---|
settings.unsubscribePid |
Integer |
Set the page to unsubscribe an event. If not set, link to unsubscribe not generated |
Event list user¶
The API delivers a json formatted list with events subscribed by a specific user. You can manipulate the list with additional parameter.
As extra parameter you have to specify the user. This api is in general separated from event list to be more flexible. It has her own result structure. Compared with event list, a user event does not show the subscribers (it is the given user) but has an unsubscribe link.
You have to call this API with a special page type. Just attach "?type=1452982643" to your project url and typoscript calls the extension "slubevents" and the plugin "apieventlist".
Additional parameter¶
You can manipulate the list with the same additional parameter like "event list". Just use different prefix "tx_slubevents_apieventlist**user**" instead of "tx_slubevents_apieventlist".
Necessary parameter¶
Parameter |
Type |
Comment |
|---|---|---|
tx_slubevents_apieventlistuser[user] |
Integer |
Event -> subscribers -> customerid |
If you use these parameter and have trouble add "tx_slubevents_apieventlistuser" in [FE][cacheHash][cachedParametersWhiteList] and [FE][cacheHash][excludedParameters].