MANIAC-MAN

Versioning

Versioning is done by adding a Version-Header, default is 1.0

More information: https://openapi-generator.tech

Contact Info: team@openapitools.org

Version: 1.2

BasePath:/api/v1

http://apache.org/licenses/LICENSE-2.0.html

Access

APIKey KeyParamName:auth KeyInQuery:false KeyInHeader:true

Methods

[ Jump to Models ]

Default

delete /cost/{id}
get /cost/{id}
post /cost/{id}
delete /cost/{id}/{type}
delete /events/activate/{id}
put /events/activate/{id}
get /events
delete /events/{id}
put /events/{id}
post /events
delete /files/{id}/{filename}
post /files/{id}
delete /images/{id}
post /images/{id}
get /registrations
delete /registrations/{id}

Default

delete /cost/{id}

This method deletes all cost objects associated with an event (costIdDelete)

This method deletes all cost objects associated with an event

Path parameters

id (required)

Path Parameter — Eventid for the cost-object default: null

Request headers

auth (required)

Header Parameter — an authorization header containing a predefined secret token default: null

Responses

209

Deleted'

404

Event not found

get /cost/{id}

just to create test data (costIdGet)

Do not call – just foir internal testiung

Path parameters

id (required)

Path Parameter — Eventid for the cost-object default: null

Request headers

auth (required)

Header Parameter — an authorization header containing a predefined secret token default: null

Return type

Cost

Example data

Content-Type: application/json

{
  "cost_accomodation_single" : 5,
  "format" : 7,
  "type" : 0,
  "cost_participation" : 6,
  "cost_accomodation_double" : 1,
  "cost_subsistence" : 5,
  "version" : 2
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

OK Cost

post /cost/{id}

This method creates or updates event cost (costIdPost)

This method is used to to ceate a new cost entry for an event. If this cost type for this event already exists the response status code will be 202, otherwise 200

Path parameters

id (required)

Path Parameter — Eventid for the Cost-object default: null

Consumes

This API call consumes the following media types via the request header:

application/json

Request body

Cost Cost (required)

Body Parameter —

Request headers

auth (required)

Header Parameter — an authorization header containing a predefined secret token default: null

Responses

200

202

updated

404

Event not found

delete /cost/{id}/{type}

This method deletes an event cost object (costIdTypeDelete)

This method deletes an event cost obejct

Path parameters

id (required)

Path Parameter — Eventid for the cost-object default: null

type (required)

Path Parameter — Cost-object type as defined by the data model default: null

Request headers

auth (required)

Header Parameter — an authorization header containing a predefined secret token default: null

Responses

209

Deleted'

404

Event / Object with this type not found

delete /events/activate/{id}

This method deactivates an event (eventsActivateIdDelete)

This method deactivates an event.

Path parameters

id (required)

Path Parameter — Unique identifier of the event returned on event creation. default: null

Request headers

auth (required)

Header Parameter — an authorization header containing a predefined secret token default: null

Responses

200

Deactivated

400

Bad Request

401

Unauthorized

403

Forbidden

404

Object Not Found

put /events/activate/{id}

This method activates an event (eventsActivateIdPut)

This method activates an event.

Path parameters

id (required)

Path Parameter — Unique identifier of the event returned on event creation. default: null

Request headers

auth (required)

Header Parameter — an authorization header containing a predefined secret token default: null

Responses

200

Activated

400

Bad Request

401

Unauthorized

403

Forbidden

404

Object Not Found

get /events

just to create test data (eventsGet)

Do not call – just foir internal testiung

Return type

Event

Example data

Content-Type: application/json

{
  "date" : "date",
  "leader" : "leader",
  "children_free_always" : true,
  "event_format" : 1,
  "display_formblatt651a" : true,
  "description" : "description",
  "datetime_short" : "datetime_short",
  "title" : "title",
  "last_date" : "last_date",
  "registration_link_external" : "registration_link_external",
  "image_source" : "image_source",
  "contact_person_mail" : "contact_person_mail",
  "children_free_from" : 5,
  "max_attendants" : 5,
  "event_type" : 6,
  "display_registration_form" : true,
  "id" : 0,
  "contact_person_name" : "contact_person_name",
  "display_teilnahmebedingung" : true,
  "family_possible" : true,
  "image_description" : "image_description",
  "subtitle_short" : "subtitle_short",
  "children_max_age" : 2,
  "lecturer" : "lecturer",
  "price_text" : "price_text",
  "title_short" : "title_short",
  "caretaker_ausweisvermerk_b" : false,
  "children_free_until" : 7,
  "invoice_possible" : true,
  "start_time" : "start_time",
  "description_short" : "description_short",
  "organizer" : "organizer",
  "contact_display" : "contact_display",
  "subtitle" : "subtitle",
  "additional_pricing_information" : "additional_pricing_information",
  "location" : "location",
  "first_date" : "first_date"
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

OK Event

delete /events/{id}

This method deletes an event (eventsIdDelete)

This method deletes an event

Path parameters

id (required)

Path Parameter — Unique identifier of the event returned on event creation default: null

Request headers

auth (required)

Header Parameter — an authorization header containing a predefined secret token default: null

Responses

204

No Content (Deletion successfull)

404

Object Not Found

put /events/{id}

This method updates selected fileds of an event (eventsIdPut)

This method updates selected fileds of an event. More precisely, those given in the body. The body must be a subset of an event description.

Path parameters

id (required)

Path Parameter — Unique identifier of the event returned on event creation. default: null

Consumes

This API call consumes the following media types via the request header:

application/json

Request body

Event Event (required)

Body Parameter —

Request headers

auth (required)

Header Parameter — an authorization header containing a predefined secret token default: null

Responses

200

OK (Updated)

400

Bad Request

401

Unauthorized

403

Forbidden

404

Object Not Found

409

Conflict - das ist der Statuscode der gesendet wird wenn eine Veranstaltung gerade überschrieben wurde

post /events

This method creates a new event (eventsPost)

This method is used to create new events, not to update old events. It cinsumes an event description as specified below. It returns the event managers internal id of this event.

Consumes

This API call consumes the following media types via the request header:

application/json

Request body

Event Event (required)

Body Parameter —

Request headers

auth (required)

Header Parameter — an authorization header containing a predefined secret token default: null

Responses

200

201

Created

400

Bad Request

401

Unauthorized - no rights to send this request

403

Forbidden - database error implied

404

Object Not Found

409

Conflict

delete /files/{id}/{filename}

This method deletes an event attachment (filesIdFilenameDelete)

This method is used to delete an event attachment.

Path parameters

id (required)

Path Parameter — Eventid for the file target default: null

filename (required)

Path Parameter — filename of the file to delete default: null

Request headers

auth (required)

Header Parameter — an authorization header containing a predefined secret token default: null

Responses

200

post /files/{id}

This method creates or updates an event attachment (filesIdPost)

This method is used to create a new event attachment and update it. To update a file upload a file with the same filename to the same event.

Path parameters

id (required)

Path Parameter — Eventid for the file target default: null

Consumes

This API call consumes the following media types via the request header:

multipart/form-data

Request headers

auth (required)

Header Parameter — an authorization header containing a predefined secret token default: null

Form parameters

linkName (required)

Form Parameter — Text that should be displayed when showing the image default: null

fileName (required)

Form Parameter — Filename with oder identifier (separated with an _) default: null

attachment (required)

Form Parameter — The attachment to add default: null format: binary

Responses

200

delete /images/{id}

This method deletes the image of event (imagesIdDelete)

This method is used to delete an event image

Path parameters

id (required)

Path Parameter — Eventid for the file target default: null

Request headers

auth (required)

Header Parameter — an authorization header containing a predefined secret token default: null

Responses

209

Deleted

post /images/{id}

This method creates or updates an event image (imagesIdPost)

This method is used to create a new event image or update it. Please make sure the image is smaller than 2.5MB priot to uploading it.

Path parameters

id (required)

Path Parameter — Eventid for the file target default: null

Consumes

This API call consumes the following media types via the request header:

multipart/form-data

Request headers

auth (required)

Header Parameter — an authorization header containing a predefined secret token default: null

Form parameters

image (required)

Form Parameter — default: null format: binary

Responses

200

get /registrations

This method returns the oldest not yet delivered registartion (registrationsGet)

This method returns a collection of connected Source Systems

Request headers

auth (required)

Header Parameter — an authorization header containing a predefined secret token default: null

Return type

Registration

Example data

Content-Type: application/json

{
  "accompanying_child" : true,
  "invoice_postal" : "invoice_postal",
  "comment_subsistence" : "comment_subsistence",
  "gender" : "gender",
  "mail" : "mail",
  "city" : "city",
  "cost_type" : 7,
  "date_of_birth" : "date_of_birth",
  "cost_version" : 9,
  "registration_id" : 6,
  "title" : "title",
  "disclaimer_shown" : true,
  "comment_general" : "comment_general",
  "format_selected" : 4,
  "advertisement_accepted" : true,
  "cost_calculated" : 3,
  "bank" : "bank",
  "street" : "street",
  "invoice_street" : "invoice_street",
  "event" : 0,
  "first_name" : "first_name",
  "primary_registration" : 1,
  "timestamp" : 5,
  "caretaker" : true,
  "subsistence" : true,
  "participant_info" : 5,
  "last_name" : "last_name",
  "child_of" : 2,
  "invoice_city" : "invoice_city",
  "comment_accomodation" : "comment_accomodation",
  "invoice_recipient" : "invoice_recipient",
  "invoice_selected" : true,
  "phone" : "phone",
  "account_holder" : "account_holder",
  "iban" : "iban",
  "accomodation" : 2,
  "comment_reduced" : "comment_reduced",
  "postal" : "postal",
  "bic" : "bic"
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

OK Registration

400

Bad Request

401

Unauthorized

403

Forbidden

404

No more registartions on this server

delete /registrations/{id}

This method deletes a registration (registrationsIdDelete)

This method deletes a registration. It should be called after a registration has been processed and stored by MANIAC

Path parameters

id (required)

Path Parameter — Unique identifier of the registration received on getting the registration default: null

Request headers

auth (required)

Header Parameter — an authorization header containing a predefined secret token default: null

Responses

204

No Content (Deletion successfull)

404

Object Not Found

Models

[ Jump to Methods ]

Cost -
Event -
Registration -

`Cost` - Up

type

Integer Integerencoded Bit Vector. –– 1= Einzelperson (voll), 2= Einzelperson (ermäßigt), 3= Eltern (einzeln), 4= Kind (einzeln), 5= Familienpauschale

cost_participation

Integer Teilnahmebeitrag in Cent. (0 bedeutet kostenfrei)

cost_accomodation_double (optional)

Integer Kosten für Unterbringung in 2-Bett Zimmer in Cent - 0 bedeutet kostenlos, nicht vorhanden bedeutet nicht anwendbar)

cost_accomodation_single (optional)

Integer Kosten für die Unterbringung in einem Eizelzimmer in Cent - 0 bedeutet kostenlos, nicht vorhanden bedeutet nicht anwendbar)

cost_subsistence (optional)

Integer Verpflegungskosten in Cent - 0 bedeutet kostenlos, nicht vorhanden bedeutet nicht anwendbar)

version

Integer Versionsnummer

format (optional)

Integer

`Event` - Up

Integer MaßnamhmeID

event_type

Integer 0->Einzeltermin; 1->Reihentermin; 2-> Einzeltermine

event_format (optional)

Integer 0->Vor Ort; 1 -> Online; 2-> Hybrid

max_attendants (optional)

Integer Maximale Teilnehmeranzahl

first_date (optional)

String Datum (DD.MM.YYYY). Mandatory for initial event creation. When empty no change is assumed.

last_date (optional)

String Datum (DD.MM.YYYY). Mandatory for initial event creation. When empty it's assumed to be unchanged. After this date, this event won't be displayed anymore

date (optional)

String Datum

title

String Titel

subtitle

String Untertitel

description

String Beschreibung

start_time (optional)

String Uhrzeit zu der die Veranstaltung startet

datetime_short (optional)

String Kurzbeschreibung Datum/Uhrzeit

title_short (optional)

String Kurzbeschreibung Titel

subtitle_short (optional)

String Kurzbeschreibung Untertitel

description_short (optional)

String Kurzbeschreibung Beschreibung

image_description (optional)

String Unformatierter Text, der das Bild beschreibt

image_source (optional)

String Bildquelle für das Veranstaltungsbild

location (optional)

String Ort

organizer (optional)

String Veranstalter

leader (optional)

String Leitung

price_text (optional)

String price as string

additional_pricing_information (optional)

String Zusatzinfo (Feld neben Kosten) - deprectaed since 1.2

contact_person_name

String Name der Kontaktperson

contact_person_mail (optional)

String Mailadresse der Kontaktperson

lecturer

String Refent

contact_display

String Richt Text string with onformation on the contact person

display_registration_form

Boolean Boolean value describing whether or not to show the Anmeldeformular

display_formblatt651a

Boolean Boolean value describing whether or not to show the Formblatt

display_teilnahmebedingung

Boolean Boolean value describing whether or not to show the terms of participation

registration_link_external

String Link to an external registration page. In case it is not empty display_regitration_form display_formblatt651a display_teilnahmebedingung are assumed tobe false

children_free_from (optional)

Integer Frei ab dem X-ten Kind, -1 wenn Kinder immer Kostenpflichtig sind

children_max_age (optional)

Integer Teilnehmer wird bis X Jahre als Kind angesehen

caretaker_ausweisvermerk_b (optional)

Boolean Kostenfreie Begelitperson für Teilnehmer mit Ausweisvermek B

family_possible (optional)

Boolean Kinder / Familien möglich

children_free_until (optional)

Integer Kinder immer Kostenfrei wenn Si ehöchstens X Jahre alt sind

children_free_always (optional)

Boolean Kinder sind immer kostenfrei

invoice_possible (optional)

Boolean Bezahlung auch mit Rechning möglich

`Registration` - Up

event

Integer event_id des Events, für das die Registrierung gilt

registration_id

Integer internal id of a registration (can be used to delete it from server)

primary_registration (optional)

Integer For group registrations

participant_info (optional)

Integer 1= Teilnehmer, 2= Leitung, 4= Referent, 8= Interessent, 16= Gestrichen, 32= Warteliste

gender

String "male"|"female"|"None"

title

String Titel eines Teilnehmers

first_name

String Vorname des Teilnehmers

last_name

String Nachname des Teilnehmers

date_of_birth (optional)

String Birthdate for registrant (YYYY-MM-DD)

city

String Name der Stadt aus der der Teilnehmende kommt

postal

String PLZ der Stadt aus der der Teilnehmende kommt

street

String Straßenname und Hausnummer

mail (optional)

String Participant's mail address

phone (optional)

String string containing participant's phone number (string for +, (), -, ...)

account_holder (optional)

String Name of the account owner (empty if identical to name)

iban (optional)

String IBAN des Teilnehmenden

bic (optional)

String BIC des Teilnehmenden

bank (optional)

String Kreditinstitut des Teilnehmenden

invoice_selected (optional)

Boolean Invoice Payment Selected for this registration -> account_holder, iban, bic, bank are empty and invoice_recipient, invoice_street, invoice_city, invoice_postal are set

invoice_recipient (optional)

String Invoice recipeint (also set if invoice_recipient == first_name + last_name)

invoice_street (optional)

String

invoice_postal (optional)

String

invoice_city (optional)

String

timestamp

Integer Zeitpunkt der Registrierung

accomodation

Integer Übernachtung. 0 = keine, 1 = Einzeluimmer, 2 = Doppelzimmer

comment_accomodation (optional)

String Zimmer mit, ...

subsistence (optional)

Boolean Zeigt an, ob diese Person Verpflegung gebucht hat

comment_subsistence (optional)

String Alergisch gegen Erdnüsse, ...

cost_type (optional)

Integer Art der Kosten

cost_version (optional)

Integer Versionsnummer

cost_calculated (optional)

Integer public facing

caretaker (optional)

Boolean This is the registration of a caretaker with "Ausweisvermerk B"

advertisement_accepted (optional)

Boolean This participant agreed to receive the biyearly newsletter (only applicable for primary registrations)

comment_general (optional)

String Participants general comment - '0.5.2'

comment_reduced (optional)

String Reason for the reduction entitlement - '0.5.2'

child_of (optional)

Integer This participant is the child of the person registered with this registration_id. - '0.5.2'

format_selected (optional)

Integer 0->Vor Ort; 1 -> Online;

disclaimer_shown (optional)

Boolean

accompanying_child (optional)

Boolean

MANIAC-MAN

Versioning

Access

Methods

Table of Contents

Default

Default

Path parameters

Request headers

Responses

209

404

Path parameters

Request headers

Return type

Example data

Produces

Responses

200

Path parameters

Consumes

Request body

Request headers

Responses

200

202

404

Path parameters

Request headers

Responses

209

404

Path parameters

Request headers

Responses

200

400

401

403

404

Path parameters

Request headers

Responses

200

400

401

403

404

Return type

Example data

Produces

Responses

200

Path parameters

Request headers

Responses

204

404

Path parameters

Consumes

Request body

Request headers

Responses

200

400

401

403

404

409

Consumes

Request body

Request headers

Responses

200

201

400

401

403

404

409

`Cost` - Up

`Event` - Up

`Registration` - Up