API Dashboard

Taffy 3.1.0

Resources:

weather

locations DELETE PATCH PUT POST GET /weather/locations

Request Body:

Loading...

Response:

get
get the locations for the provided station
optional string station
label or id of the radiostation

details DELETE PATCH PUT POST GET /weather/details

Request Body:

Loading...

Response:

get
get the weather
required string zipcodes
list of zip codes

votings

voting DELETE PATCH PUT POST GET /votings/voting

Request Body:

Loading...

Response:

get
get a specific voting by ID
required numeric voting_id
ID of the voting
post
get a specific voting by ID
required numeric answer_id
ID of the answer

traffic

radar DELETE PATCH PUT POST GET /traffic/radar

Request Body:

Loading...

Response:

get
get the detailed radar entries for the radiostation
optional string station (default: "")
label or id of the radiostation

overview DELETE PATCH PUT POST GET /traffic/overview

Request Body:

Loading...

Response:

get
get the counted disruptions and radars for the radiostation
required string station
label or id of the radiostation

overregional DELETE PATCH PUT POST GET /traffic/overregional

Request Body:

Loading...

Response:

get
get the detailed overregional entries for the radiostation
optional string station (default: "")
label or id of the radiostation

local DELETE PATCH PUT POST GET /traffic/local

Request Body:

Loading...

Response:

get
get the detailed local entries for the radiostation
optional string station (default: "")
label or id of the radiostation

dispatch DELETE PATCH PUT POST GET /traffic/dispatch

Request Body:

Loading...

Response:

post
handle form submits (we process form submits and send them to the rnrw-API)
optional string station
label or id of the radiostation
optional string captcha (default: "")
captcha value provided by google recaptcha
optional string type (default: userfeedback)
type of the message
required string message
detailed message to describe the incident
required string username
user / name
optional string usermail (default: "")
user / e-mail
optional string userphone (default: "")
user / phone
optional string coordX (default: "")
location / geocoords x of the incident
optional string coordY (default: "")
location / geocoords y of the incident
required string street
location / street of the incident
optional string zipcode (default: "")
location / zipcode of the incident
required string city
location / city of the incident

detail DELETE PATCH PUT POST GET /traffic/detail

Request Body:

Loading...

Response:

get
get the detailed disruptions and radars for the radiostation
required string station
label or id of the radiostation
optional string type (default: all)
type of data to get (all|local|radars|overregional)

studio

status DELETE PATCH PUT POST GET /studio/status

Request Body:

Loading...

Response:

get
returns the last status available for the studio (last entry by timeslot)
required string station
label or id of the radiostation
optional string timeslot
optional timeslot to get the status at a given time
post
set the studio status to arguments.status for current timeslot
required string station
label or id of the radiostation
required string status
0 := NRW on, 1 := Studio 1 on, 2 := Studio 2 on, 3 := B├╝rgerfunk
optional string timeslot
optional timeslot to set the status at

contact DELETE PATCH PUT POST GET /studio/contact

Request Body:

Loading...

Response:

post
send a mail to the studio
required string station
label or id of the radiostation
optional string captcha (default: "")
captcha value provided by google recaptcha
required string firstname
user firstname in form
required string lastname
user lastname in form
required string mail
user mail in form
required string message
message in form

sendeplan

sendeplan DELETE PATCH PUT POST GET /sendeplan/sendeplan

Request Body:

Loading...

Response:

get
get the program information for the provided station for the current day or for a specific date
optional string station (default: "")
label or id of the radiostation
optional string date (default: "")

moderators DELETE PATCH PUT POST GET /sendeplan/moderators

Request Body:

Loading...

Response:

get
get the moderators for the provided station
required string station
label or id of the radiostation

current DELETE PATCH PUT POST GET /sendeplan/current

Request Body:

Loading...

Response:

get
get the current program information for the provided station
required string station
label or id of the radiostation

search

search DELETE PATCH PUT POST GET /search/search

Request Body:

Loading...

Response:

get
optional string searchTerm (default: "")
optional string type (default: "")
optional numeric station (default: 0)
optional numeric from (default: 0)
optional numeric size (default: 10)

playlist

title DELETE PATCH PUT POST GET /playlist/title

Request Body:

Loading...

Response:

get
search a specific title return search result array
required string station (default: 0)
label or id of the radiostation
optional string req_station (default: "")
label or id of the radiostation requesting the data (to set affiliate ids and placeholder images)
optional numeric title_id (default: 0)
id of the title
optional string searchterm (default: "")
searchterm
optional string datefrom (default: "")
date to filter titles on
optional string dateto (default: "")
date to filter titles on
optional numeric pagenum (default: 1)
number of the page to get from the index
optional numeric pagesize (default: 100)
number of records shown per page
post
insert a title to the playlist
required string station
label or id of the radiostation
required string artist
artist of the title
required string title
title
required numeric duration
duration of the title
required string timeslot
starttime of the title

next DELETE PATCH PUT POST GET /playlist/next

Request Body:

Loading...

Response:

get
get the next title
required string station
label or id of the radiostation
optional string req_station (default: "")
label or id of the radiostation requesting the data (to set affiliate ids and placeholder images)

latest DELETE PATCH PUT POST GET /playlist/latest

Request Body:

Loading...

Response:

get
get the current title
required string station
label or id of the radiostation
optional string req_station (default: "")
label or id of the radiostation requesting the data (to set affiliate ids and placeholder images)
optional numeric count (default: 10)
number of entries returned

export DELETE PATCH PUT POST GET /playlist/export

Request Body:

Loading...

Response:

get
export the playlist to a specific format (json, xml, rss)
required string station
label or id of the radiostation
optional numeric count (default: 10)
number of titles returned

current DELETE PATCH PUT POST GET /playlist/current

Request Body:

Loading...

Response:

get
get the current title
required string station
label or id of the radiostation
optional string req_station (default: "")
label or id of the radiostation requesting the data (to set affiliate ids and placeholder images)

channels DELETE PATCH PUT POST GET /playlist/channels

Request Body:

Loading...

Response:

get
get all webchannels of a station
required string station
label or id of the radiostation

newsroom

news DELETE PATCH PUT POST GET /newsroom/news

Request Body:

Loading...

Response:

get
get a station's news
required numeric news_id

category DELETE PATCH PUT POST GET /newsroom/category

Request Body:

Loading...

Response:

get
get all news of a category for a station
required numeric category_id
optional numeric from (default: 0)
optional numeric size (default: 10)

categories DELETE PATCH PUT POST GET /newsroom/categories

Request Body:

Loading...

Response:

get
get the categories tree of a station

datamanager

upload DELETE PATCH PUT POST GET /datamanager/upload

Request Body:

Loading...

Response:

post
required string file
the file content

storages DELETE PATCH PUT POST GET /datamanager/storages

Request Body:

Loading...

Response:

get
get a list of databases (and later also other storage options)

sites DELETE PATCH PUT POST GET /datamanager/sites

Request Body:

Loading...

Response:

get
get the sites the current user has access to

settings DELETE PATCH PUT POST GET /datamanager/settings

Request Body:

Loading...

Response:

get
get the formbuilder settings

session DELETE PATCH PUT POST GET /datamanager/session

Request Body:

Loading...

Response:

get
get the current session

formtemplates DELETE PATCH PUT POST GET /datamanager/formtemplates

Request Body:

Loading...

Response:

get
get a list of form templates
optional string mode (default: full)
select mode [full|countonly]
optional numeric lang_ID (default: 1)
gui language ID
optional string searchstring (default: "")
search
optional numeric category_ID (default: 0)
filter by form template category_ID
optional numeric editor_ID (default: 0)
filter by editor_ID
optional numeric site_ID (default: 0)
filter by site_ID
optional string formstatus (default: 1)
filter by form status, list: 1: active, 8: disabled, 9: deleted
optional boolean getcategories (default: false)
get the form template categories
optional boolean getdescriptions (default: false)
get the form template description texts
optional boolean getimages (default: false)
get the form template images
optional string orderby (default: sortorder ASC)
order type [sortorder, formtemplate_ID, mostused, templatename]

formtemplate DELETE PATCH PUT POST GET /datamanager/formtemplate

Request Body:

Loading...

Response:

delete
delete a form template
required numeric formtemplate_ID
formtemplate ID
get
get a form template
optional numeric formtemplate_ID (default: 0)
select form by formtemplate_ID
optional numeric lang_ID (default: 1)
gui language ID or 0 - get all text versions for editing
optional string uniquename (default: "")
or by uniquename
post
post a new form template
required numeric site_ID
site_ID or 0
optional numeric formtype_ID (default: 1)
form type: 1: standard / all questions on one page, 2: conversational / single question per page, 14: CONTENS uniform/compatible
required numeric category_ID
form's category_ID
optional numeric stylegroup_ID (default: 0)
form's stylegroup_ID
required struct templatename (default: [runtime expression])
form template name (struct with lang_IDs as keys)
required struct templatedescription (default: [runtime expression])
form template description (struct with lang_IDs as keys)
required numeric sortorder
form template's sort order within this category
required string controllerfilename
technical name [A-Za-Z0-9_-]
optional numeric formstatus (default: 1)
form template status: 1: active, 8: disabled, 9: deleted
required string formdata
JSON with form data, { formpages: [...] }
optional numeric editable (default: 1)
is this form editable? 0: not editable, 1: editable by site editor, 2: editable by admin only
optional string uniquename (default: [runtime expression])
generated UUID
optional numeric submitlimit (default: 0)
maximum number of form submits, for sweepstakes/raffles; 0: unlimited
required struct limitreachedtext (default: [runtime expression])
text to display when the limit is reached (struct with lang_IDs as keys)
optional numeric formprotect (default: 0)
use form protection? 0: no form protection, 1: use Google invisible reCAPTCHA, ...
required struct confirmationpagetitle (default: [runtime expression])
title to display on the confirmation page (struct with lang_IDs as keys)
required struct confirmationpagecontent (default: [runtime expression])
content to display on the confirmation page (struct with lang_IDs as keys)
optional numeric editor_ID (default: 0)
editor who created & is responsible for this form template
put
change a form template
required numeric formtemplate_ID
formtemplate ID
required numeric site_ID
site_ID or 0
optional numeric formtype_ID (default: 1)
form type: 1: standard / all questions on one page, 2: conversational / single question per page, 14: CONTENS uniform/compatible
required numeric category_ID
form's category_ID
optional numeric stylegroup_ID (default: 0)
form's stylegroup_ID
required struct templatename (default: [runtime expression])
form template name (struct with lang_IDs as keys)
required struct templatedescription (default: [runtime expression])
form template description (struct with lang_IDs as keys)
required numeric sortorder
form template's sort order within this category
required string controllerfilename
technical name [A-Za-Z0-9_-]
optional numeric formstatus (default: 1)
form template status: 1: active, 8: disabled, 9: deleted
required string formdata
JSON with form data, { formpages: [...] }
optional numeric editable (default: 1)
is this form editable? 0: not editable, 1: editable by site editor, 2: editable by admin only
optional numeric submitlimit (default: 0)
maximum number of form submits, for sweepstakes/raffles; 0: unlimited
required struct limitreachedtext (default: [runtime expression])
text to display when the limit is reached (struct with lang_IDs as keys)
optional numeric formprotect (default: 0)
use form protection? 0: no form protection, 1: use Google invisible reCAPTCHA, ...
required struct confirmationpagetitle (default: [runtime expression])
title to display on the confirmation page (struct with lang_IDs as keys)
required struct confirmationpagecontent (default: [runtime expression])
content to display on the confirmation page (struct with lang_IDs as keys)
optional numeric editor_ID (default: 0)
editor who created & is responsible for this form template

formsubmission DELETE PATCH PUT POST GET /datamanager/formsubmission

Request Body:

Loading...

Response:

post
submit a form (that was build via dm form builder) - load & execute processes for storing data, sending emails etc.
required string uniquename
form's uniquename
optional numeric lang_ID (default: 1)
gui language ID
required struct formfields
struct with submitted form fields
optional struct client (default: [runtime expression])
client meta data collected by client.js

forms DELETE PATCH PUT POST GET /datamanager/forms

Request Body:

Loading...

Response:

get
get a list of forms
optional string mode (default: full)
select mode [full|countonly]
optional numeric lang_ID (default: 1)
gui language ID
optional string searchstring (default: "")
search
optional numeric category_ID (default: 0)
filter by form category_ID
optional numeric editor_ID (default: 0)
filter by editor_ID
optional numeric site_ID (default: 0)
filter by site_ID
optional numeric formtype_ID (default: 0)
filter by formtype_ID: 1: standard / all questions on one page, 2: conversational / single question per page, 14: CONTENS uniform/compatible
optional numeric based_on_formtemplate_ID (default: 0)
filter by formtemplate_ID the form is based on
optional numeric based_on_form_ID (default: 0)
filter by form_ID the form is based on
optional string formstatus (default: 0,1,8)
filter by form status, list: 0: in development, 1: active, 8: disabled, 9: deleted
optional boolean getcategories (default: false)
get the form categories
optional string orderby (default: form_ID DESC)
order type [form_ID, formname, controllerfilename, enddate] & DESC

formprocessingstorages DELETE PATCH PUT POST GET /datamanager/formprocessingstorages

Request Body:

Loading...

Response:

get
get a list of form processing storage processes
optional string mode (default: full)
select mode [full|countonly]
optional string searchstring (default: "")
search
required numeric form_ID
filter by form_ID
optional numeric storagetype (default: 0)
filter by storage type: 1: relational database storage, 2: nosql database storage
optional numeric site_ID (default: 0)
filter by related form's site_ID
optional string orderby (default: database)
order type [storageprocess_ID, database, suffix]

formprocessingstorage DELETE PATCH PUT POST GET /datamanager/formprocessingstorage

Request Body:

Loading...

Response:

delete
delete a form storage process
required numeric storageprocess_ID
process ID
get
get a form storage process
required numeric storageprocess_ID
select process by storageprocess_ID
post
post a new form storage process
required numeric form_ID
related form_ID
optional numeric storagetype (default: 1)
storage type: 1: relational database storage, 2: nosql database storage
required string database
database name (lucee admin, create / alter table rights required)
required string suffix
table name suffix in relational databases, collection name suffix in nosql databases
put
change a form storage process
required numeric storageprocess_ID
process ID
optional numeric storagetype (default: 1)
storage type: 1: relational database storage, 2: nosql database storage
required string database
database name (lucee admin, create / alter table rights required)
required string suffix
table name suffix in relational databases, collection name suffix in nosql databases

formprocessingemails DELETE PATCH PUT POST GET /datamanager/formprocessingemails

Request Body:

Loading...

Response:

get
get a list of form processing / email send processes
optional string mode (default: full)
select mode [full|countonly]
optional numeric lang_ID (default: 1)
gui language ID
optional string searchstring (default: "")
search
required numeric form_ID
filter by form_ID
optional numeric emailtype (default: 0)
filter by email type: 1: autoresponder/confirmation email to sender (leave recipientemail empty), 2: email to page owner
optional numeric site_ID (default: 0)
filter by related form's site_ID
optional string orderby (default: recipientemail)
order type [emailprocess_ID, recipientemail]

formprocessingemail DELETE PATCH PUT POST GET /datamanager/formprocessingemail

Request Body:

Loading...

Response:

delete
delete a form email process
required numeric emailprocess_ID
process ID
get
get a form email process
required numeric emailprocess_ID
select process by emailprocess_ID
optional numeric lang_ID (default: 1)
gui language ID or 0 - get all text versions for editing
post
post a new form email process
required numeric form_ID
related form_ID
optional numeric emailtype (default: 2)
email type: 1: autoresponder/confirmation email to sender (leave recipientemail empty), 2: email to page owner
required string sendername
sender name
optional string replytoemail (default: "")
email address to reply to
required string recipientemail
recipient's email address
required struct subjecttext (default: [runtime expression])
email subject text (with placeholders, i.e. rowkeynames from form rows) (struct with lang_IDs as keys)
required struct titletext (default: [runtime expression])
email title text (with placeholders) (struct with lang_IDs as keys)
required struct contenttext (default: [runtime expression])
email content (with placeholders) (struct with lang_IDs as keys)
optional numeric attachdata (default: 1)
attach the submitted form data? 1: yes, 0: no
put
change a form email process
required numeric emailprocess_ID
process ID
required numeric form_ID
related form_ID
optional numeric emailtype (default: 2)
email type: 1: autoresponder/confirmation email to sender (leave recipientemail empty), 2: email to page owner
required string sendername
sender name
optional string replytoemail (default: "")
email address to reply to
required string recipientemail
recipient's email address
required struct subjecttext (default: [runtime expression])
email subject text (with placeholders, i.e. rowkeynames from form rows) (struct with lang_IDs as keys)
required struct titletext (default: [runtime expression])
email title text (with placeholders) (struct with lang_IDs as keys)
required struct contenttext (default: [runtime expression])
email content (with placeholders) (struct with lang_IDs as keys)
optional numeric attachdata (default: 1)
attach the submitted form data? 1: yes, 0: no

form DELETE PATCH PUT POST GET /datamanager/form

Request Body:

Loading...

Response:

delete
delete a form
required numeric form_ID
form ID
get
get a form
optional numeric form_ID (default: 0)
select form by form_ID
optional numeric lang_ID (default: 1)
gui language ID or 0 - get all text versions for editing
optional string uniquename (default: "")
or by uniquename
optional boolean export (default: false)
export as json (for download, local storage and sharing)
post
post a new form
optional numeric app_ID (default: 0)
app_ID (for CONTENS compatibility) or 0
required numeric site_ID
site_ID or 0
optional numeric formtype_ID (default: 1)
form type: 1: standard / all questions on one page, 2: conversational / single question per page, 14: CONTENS uniform/compatible
required numeric category_ID
form's category_ID
optional numeric formadmin_ID (default: 0)
formadmin_ID (for CONTENS compatibility) or 0
optional numeric stylegroup_ID (default: 0)
form's stylegroup_ID
optional numeric table_ID (default: 0)
table_ID (for CONTENS compatibility) or 0
required struct formname (default: [runtime expression])
form name (struct with lang_IDs as keys)
required string controllerfilename
technical name [A-Za-Z0-9_-]
optional numeric formstatus (default: 1)
form status: 0: in development, 1: active, 8: disabled, 9: deleted
required string formfilepath
form file path (for CONTENS compatibility) or empty
optional numeric languagemode (default: 1)
0: gui languages, 1: site languages, 2: gui and site languages, 3: custom, 4: single language, 5: editor languages
required string formdata
JSON with form data, { formpages: [...] }
optional numeric editable (default: 1)
is this form editable? 0: not editable, 1: editable by site editor, 2: editable by admin only
optional string uniquename (default: [runtime expression])
generated UUID
optional numeric submitlimit (default: 0)
maximum number of form submits, for sweepstakes/raffles; 0: unlimited
required struct limitreachedtext (default: [runtime expression])
text to display when the limit is reached (struct with lang_IDs as keys)
optional any enddate (default: "")
deactivate form after this date & time - date or struct, e.g. {year: 2018, month: 12, day: 14}
required struct enddatetext (default: [runtime expression])
text to display when the end date is reached (struct with lang_IDs as keys)
optional numeric formprotect (default: 0)
use form protection? 0: no form protection, 1: use Google invisible reCAPTCHA, ...
required struct confirmationpagetitle (default: [runtime expression])
title to display on the confirmation page (struct with lang_IDs as keys)
required struct confirmationpagecontent (default: [runtime expression])
content to display on the confirmation page (struct with lang_IDs as keys)
optional numeric based_on_formtemplate_ID (default: 0)
this form was created based on this form template
optional numeric based_on_form_ID (default: 0)
this form was created as a copy of this form template
optional numeric editor_ID (default: 0)
editor who created & is responsible for this form template
optional array emails (default: [runtime expression])
emails related to the form (array of struct as in form:get)
optional array storages (default: [runtime expression])
storages related to the form (array of struct as in form:get)
put
change a form template
required numeric form_ID
formtemplate ID
optional numeric app_ID (default: 0)
app_ID (for CONTENS compatibility) or 0
required numeric site_ID
site_ID or 0
optional numeric formtype_ID (default: 1)
form type: 1: standard / all questions on one page, 2: conversational / single question per page, 14: CONTENS uniform/compatible
required numeric category_ID
form's category_ID
optional numeric formadmin_ID (default: 0)
formadmin_ID (for CONTENS compatibility) or 0
optional numeric stylegroup_ID (default: 0)
form's stylegroup_ID
optional numeric table_ID (default: 0)
table_ID (for CONTENS compatibility) or 0
required struct formname (default: [runtime expression])
form name (struct with lang_IDs as keys)
required string controllerfilename
technical name [A-Za-Z0-9_-]
optional numeric formstatus (default: 1)
form status: 0: in development, 1: active, 8: disabled, 9: deleted
required string formfilepath
form file path (for CONTENS compatibility) or empty
optional numeric languagemode (default: 1)
0: gui languages, 1: site languages, 2: gui and site languages, 3: custom, 4: single language, 5: editor languages
required string formdata
JSON with form data, { formpages: [...] }
optional numeric editable (default: 1)
is this form editable? 0: not editable, 1: editable by site editor, 2: editable by admin only
optional numeric submitlimit (default: 0)
maximum number of form submits, for sweepstakes/raffles; 0: unlimited
required struct limitreachedtext (default: [runtime expression])
text to display when the limit is reached (struct with lang_IDs as keys)
optional any enddate (default: "")
deactivate form after this date & time - date or struct, e.g. {year: 2018, month: 12, day: 14}
required struct enddatetext (default: [runtime expression])
text to display when the end date is reached (struct with lang_IDs as keys)
optional numeric formprotect (default: 0)
use form protection? 0: no form protection, 1: use Google invisible reCAPTCHA, ...
required struct confirmationpagetitle (default: [runtime expression])
title to display on the confirmation page (struct with lang_IDs as keys)
required struct confirmationpagecontent (default: [runtime expression])
content to display on the confirmation page (struct with lang_IDs as keys)
optional numeric editor_ID (default: 0)
editor who created & is responsible for this form template
optional array emails (default: [runtime expression])
emails related to the form (array of struct as in form:get)
optional array storages (default: [runtime expression])
storages related to the form (array of struct as in form:get)

editors DELETE PATCH PUT POST GET /datamanager/editors

Request Body:

Loading...

Response:

get
get the editors (of sites the current user has access to)

categories DELETE PATCH PUT POST GET /datamanager/categories

Request Body:

Loading...

Response:

get
get form template categories
optional string mode (default: full)
select mode [full|countonly]
optional numeric lang_ID (default: 1)
gui language ID
optional string searchstring (default: "")
search
optional numeric site_ID (default: 0)
filter tree by site_ID

Resources are listed in matching order. From top to bottom, the first URI to match the request is used.