EventSignUp
This method will get all BaseEventSignUp Objects
GET/api/event/base_event_signup
Query parameters
searchStringstring | text to search for in the list |
orderFieldNamestring | name of the order field |
orderFieldSortstring | sorting modeAllowed: DESCASC |
pageinteger | page of the list |
pageSizeinteger | number of entries for each page |
withMaxPageNumberstring | returns the number of pages available as a header if this is set |
Responses
200Returns a list of BaseEventSignUp objectsarray<BaseEventSignUp10>
Show fields (54)
bib_range_idintegerage_classstringAltersklasse nach DLV, z. B. M40 - berechnet aus Geburtstag, Geschlecht und Eventdatum.
idintegerPrimary key of the sign-up. Internal ID.
genderstringGender of the participant.
tokenstringPublic token of the sign-up. Used in links instead of the ID.
moments_tokenstringParticipant-bound moments token: allows this participant to use the event moments (digital guestbook) page; uploads via this token are linked to the participant.
waitingbooleanThe sign-up is on the waiting list.
confirmedbooleanThe sign-up is confirmed.
externalbooleanThe sign-up was made by an external party.
deletion_reasonstringReason the sign-up was cancelled.
billedbooleanThe sign-up was billed.
direct_billingbooleandirect_billing_check_datestring (date-time)direct_billing_tokenstringwait_list_confirmation_tokenstringwait_list_confirmation_sent_atstring (date-time)wait_list_confirmation_deadlinestring (date-time)wait_list_confirmed_atstring (date-time)wait_list_pending_confirmationbooleanwait_list_sort_orderintegerbirthdaystring (date-time)Birthday of the participant.
trialbooleanTrial date sign-up (Schnuppern): a date sign-up without a course place that uses up one unit of the person's trial pass (eventAccessBudget with sourceType trial)
trial_channelstringWho booked the trial date: app, trainer, office
trial_session_numberintegerNumber of this trial date within the pass (1 = first), for "Schnuppern 2/3"
trial_session_maxintegerTrial dates of the pass, for "Schnuppern 2/3"
nace_sectionstringNACE section code (letter A-U)
nace_codestringNACE code (numeric like 01.11, 62.01)
bib_numberintegerStartnummer (Zaehler). Bei PER_PREFIX nur zusammen mit dem Praefix eindeutig. Wird nur ueber BibNumberAssigner gesetzt, stornierte Anmeldungen behalten sie.
bib_labelstringAngezeigte Startnummer inkl. Praefix, z. B. W0123. Pro Event eindeutig.
bib_number_assigned_atstring (date-time)Time the bib number was assigned.
chip_codestringTransponder- oder QR-Kennung fuer die Zeitmessung. Pro Event eindeutig.
timing_tracking_consentbooleanEinwilligung in das GPS-Live-Tracking waehrend des Events.
createdstring (date-time)Point in time the entity was created.
updatedstring (date-time)Point in time the entity was last updated.
addressstringAddress as text.
address_streetstringStreet of the address.
address_house_numberstringHouse number of the address.
address_street_levelstringStreet and house number of the address.
address_costringCare-of line of the address.
address_citystringCity of the address.
address_zipstringPostal code of the address.
address_admin_level1stringFirst administrative level of the address, e.g. the federal state.
address_countrystringCountry code of the address.
address_full_countrystringFull name of the country of the address.
address_geo_latstringLatitude of the address.
address_geo_lngstringLongitude of the address.
address_external_provider_idstringfield to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
namestringName of the entity.
main_phonestringMain phone number.
main_faxstringMain fax number.
main_emailstringMain e-mail address.
websitestringWebsite address.
deletedbooleanThis property is used to mark an entity as deleted / archived
orderintegerPosition of the entity in the order.
curl --request GET \
--url https://your-instance.iw-erp.de/api/event/base_event_signup \
--header 'x-iw-jwt-token: <TOKEN>'const options = {method: 'GET', headers: {'x-iw-jwt-token': '<TOKEN>'}};
fetch('https://your-instance.iw-erp.de/api/event/base_event_signup', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://your-instance.iw-erp.de/api/event/base_event_signup"
headers = {"x-iw-jwt-token": "<TOKEN>"}
response = requests.get(url, headers=headers)
print(response.text)<?php
require_once('vendor/autoload.php');
$client = new \GuzzleHttp\Client();
$response = $client->request('GET', 'https://your-instance.iw-erp.de/api/event/base_event_signup', [
'headers' => [
'x-iw-jwt-token' => '<TOKEN>',
],
]);
echo $response->getBody();using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("https://your-instance.iw-erp.de/api/event/base_event_signup"),
Headers =
{
{ "x-iw-jwt-token", "<TOKEN>" },
},
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://your-instance.iw-erp.de/api/event/base_event_signup")
.get()
.addHeader("x-iw-jwt-token", "<TOKEN>")
.build();
Response response = client.newCall(request).execute();package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://your-instance.iw-erp.de/api/event/base_event_signup"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-iw-jwt-token", "<TOKEN>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}Dart with the iw_erp_api package
import 'package:iw_erp_api/clients/event_base_event_sign_up_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';
IwApiState().host = 'your-instance.iw-erp.de';
IwApiState().currentJwtApiToken = '<TOKEN>';
final result = await EventBaseEventSignUpController.getAll();
if (result.success) {
print(result.data);
}[
{
"id": 42,
"address_street": "Jakobistr. 39",
"address_city": "Hannover",
"address_zip": "30163",
"address_country": "DE",
"address_full_country": "DE",
"name": "Beispiel",
"main_phone": "+49 511 123456",
"main_email": "lena.hartmann@example.org",
"bib_range_id": 42
}
]Add a new BaseEventSignUp
POST/api/event/base_event_signup
Responses
200Add a new BaseEventSignUpBaseEventSignUp10
Show fields (54)
bib_range_idintegerage_classstringAltersklasse nach DLV, z. B. M40 - berechnet aus Geburtstag, Geschlecht und Eventdatum.
idintegerPrimary key of the sign-up. Internal ID.
genderstringGender of the participant.
tokenstringPublic token of the sign-up. Used in links instead of the ID.
moments_tokenstringParticipant-bound moments token: allows this participant to use the event moments (digital guestbook) page; uploads via this token are linked to the participant.
waitingbooleanThe sign-up is on the waiting list.
confirmedbooleanThe sign-up is confirmed.
externalbooleanThe sign-up was made by an external party.
deletion_reasonstringReason the sign-up was cancelled.
billedbooleanThe sign-up was billed.
direct_billingbooleandirect_billing_check_datestring (date-time)direct_billing_tokenstringwait_list_confirmation_tokenstringwait_list_confirmation_sent_atstring (date-time)wait_list_confirmation_deadlinestring (date-time)wait_list_confirmed_atstring (date-time)wait_list_pending_confirmationbooleanwait_list_sort_orderintegerbirthdaystring (date-time)Birthday of the participant.
trialbooleanTrial date sign-up (Schnuppern): a date sign-up without a course place that uses up one unit of the person's trial pass (eventAccessBudget with sourceType trial)
trial_channelstringWho booked the trial date: app, trainer, office
trial_session_numberintegerNumber of this trial date within the pass (1 = first), for "Schnuppern 2/3"
trial_session_maxintegerTrial dates of the pass, for "Schnuppern 2/3"
nace_sectionstringNACE section code (letter A-U)
nace_codestringNACE code (numeric like 01.11, 62.01)
bib_numberintegerStartnummer (Zaehler). Bei PER_PREFIX nur zusammen mit dem Praefix eindeutig. Wird nur ueber BibNumberAssigner gesetzt, stornierte Anmeldungen behalten sie.
bib_labelstringAngezeigte Startnummer inkl. Praefix, z. B. W0123. Pro Event eindeutig.
bib_number_assigned_atstring (date-time)Time the bib number was assigned.
chip_codestringTransponder- oder QR-Kennung fuer die Zeitmessung. Pro Event eindeutig.
timing_tracking_consentbooleanEinwilligung in das GPS-Live-Tracking waehrend des Events.
createdstring (date-time)Point in time the entity was created.
updatedstring (date-time)Point in time the entity was last updated.
addressstringAddress as text.
address_streetstringStreet of the address.
address_house_numberstringHouse number of the address.
address_street_levelstringStreet and house number of the address.
address_costringCare-of line of the address.
address_citystringCity of the address.
address_zipstringPostal code of the address.
address_admin_level1stringFirst administrative level of the address, e.g. the federal state.
address_countrystringCountry code of the address.
address_full_countrystringFull name of the country of the address.
address_geo_latstringLatitude of the address.
address_geo_lngstringLongitude of the address.
address_external_provider_idstringfield to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
namestringName of the entity.
main_phonestringMain phone number.
main_faxstringMain fax number.
main_emailstringMain e-mail address.
websitestringWebsite address.
deletedbooleanThis property is used to mark an entity as deleted / archived
orderintegerPosition of the entity in the order.
curl --request POST \
--url https://your-instance.iw-erp.de/api/event/base_event_signup \
--header 'x-iw-jwt-token: <TOKEN>'const options = {method: 'POST', headers: {'x-iw-jwt-token': '<TOKEN>'}};
fetch('https://your-instance.iw-erp.de/api/event/base_event_signup', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://your-instance.iw-erp.de/api/event/base_event_signup"
headers = {"x-iw-jwt-token": "<TOKEN>"}
response = requests.post(url, headers=headers)
print(response.text)<?php
require_once('vendor/autoload.php');
$client = new \GuzzleHttp\Client();
$response = $client->request('POST', 'https://your-instance.iw-erp.de/api/event/base_event_signup', [
'headers' => [
'x-iw-jwt-token' => '<TOKEN>',
],
]);
echo $response->getBody();using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("https://your-instance.iw-erp.de/api/event/base_event_signup"),
Headers =
{
{ "x-iw-jwt-token", "<TOKEN>" },
},
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://your-instance.iw-erp.de/api/event/base_event_signup")
.post(null)
.addHeader("x-iw-jwt-token", "<TOKEN>")
.build();
Response response = client.newCall(request).execute();package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://your-instance.iw-erp.de/api/event/base_event_signup"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("x-iw-jwt-token", "<TOKEN>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}Dart with the iw_erp_api package
import 'package:iw_erp_api/clients/event_base_event_sign_up_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';
import 'package:iw_erp_api/model/event_base_event_sign_up.dart';
IwApiState().host = 'your-instance.iw-erp.de';
IwApiState().currentJwtApiToken = '<TOKEN>';
final result = await EventBaseEventSignUpController.post(EventBaseEventSignUp.fromJson({}));
if (result.success) {
print(result.data);
}{
"id": 42,
"address_street": "Jakobistr. 39",
"address_city": "Hannover",
"address_zip": "30163",
"address_country": "DE",
"address_full_country": "DE",
"name": "Beispiel",
"main_phone": "+49 511 123456",
"main_email": "lena.hartmann@example.org",
"bib_range_id": 42
}This method will get a single BaseEventSignUp with the given id or token
GET/api/event/base_event_signup/{identifier}
Path parameters
identifierrequiredstring |
Responses
200Returns a single BaseEventSignUpBaseEventSignUp10
Show fields (54)
bib_range_idintegerage_classstringAltersklasse nach DLV, z. B. M40 - berechnet aus Geburtstag, Geschlecht und Eventdatum.
idintegerPrimary key of the sign-up. Internal ID.
genderstringGender of the participant.
tokenstringPublic token of the sign-up. Used in links instead of the ID.
moments_tokenstringParticipant-bound moments token: allows this participant to use the event moments (digital guestbook) page; uploads via this token are linked to the participant.
waitingbooleanThe sign-up is on the waiting list.
confirmedbooleanThe sign-up is confirmed.
externalbooleanThe sign-up was made by an external party.
deletion_reasonstringReason the sign-up was cancelled.
billedbooleanThe sign-up was billed.
direct_billingbooleandirect_billing_check_datestring (date-time)direct_billing_tokenstringwait_list_confirmation_tokenstringwait_list_confirmation_sent_atstring (date-time)wait_list_confirmation_deadlinestring (date-time)wait_list_confirmed_atstring (date-time)wait_list_pending_confirmationbooleanwait_list_sort_orderintegerbirthdaystring (date-time)Birthday of the participant.
trialbooleanTrial date sign-up (Schnuppern): a date sign-up without a course place that uses up one unit of the person's trial pass (eventAccessBudget with sourceType trial)
trial_channelstringWho booked the trial date: app, trainer, office
trial_session_numberintegerNumber of this trial date within the pass (1 = first), for "Schnuppern 2/3"
trial_session_maxintegerTrial dates of the pass, for "Schnuppern 2/3"
nace_sectionstringNACE section code (letter A-U)
nace_codestringNACE code (numeric like 01.11, 62.01)
bib_numberintegerStartnummer (Zaehler). Bei PER_PREFIX nur zusammen mit dem Praefix eindeutig. Wird nur ueber BibNumberAssigner gesetzt, stornierte Anmeldungen behalten sie.
bib_labelstringAngezeigte Startnummer inkl. Praefix, z. B. W0123. Pro Event eindeutig.
bib_number_assigned_atstring (date-time)Time the bib number was assigned.
chip_codestringTransponder- oder QR-Kennung fuer die Zeitmessung. Pro Event eindeutig.
timing_tracking_consentbooleanEinwilligung in das GPS-Live-Tracking waehrend des Events.
createdstring (date-time)Point in time the entity was created.
updatedstring (date-time)Point in time the entity was last updated.
addressstringAddress as text.
address_streetstringStreet of the address.
address_house_numberstringHouse number of the address.
address_street_levelstringStreet and house number of the address.
address_costringCare-of line of the address.
address_citystringCity of the address.
address_zipstringPostal code of the address.
address_admin_level1stringFirst administrative level of the address, e.g. the federal state.
address_countrystringCountry code of the address.
address_full_countrystringFull name of the country of the address.
address_geo_latstringLatitude of the address.
address_geo_lngstringLongitude of the address.
address_external_provider_idstringfield to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
namestringName of the entity.
main_phonestringMain phone number.
main_faxstringMain fax number.
main_emailstringMain e-mail address.
websitestringWebsite address.
deletedbooleanThis property is used to mark an entity as deleted / archived
orderintegerPosition of the entity in the order.
curl --request GET \
--url https://your-instance.iw-erp.de/api/event/base_event_signup/42 \
--header 'x-iw-jwt-token: <TOKEN>'const options = {method: 'GET', headers: {'x-iw-jwt-token': '<TOKEN>'}};
fetch('https://your-instance.iw-erp.de/api/event/base_event_signup/42', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://your-instance.iw-erp.de/api/event/base_event_signup/42"
headers = {"x-iw-jwt-token": "<TOKEN>"}
response = requests.get(url, headers=headers)
print(response.text)<?php
require_once('vendor/autoload.php');
$client = new \GuzzleHttp\Client();
$response = $client->request('GET', 'https://your-instance.iw-erp.de/api/event/base_event_signup/42', [
'headers' => [
'x-iw-jwt-token' => '<TOKEN>',
],
]);
echo $response->getBody();using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("https://your-instance.iw-erp.de/api/event/base_event_signup/42"),
Headers =
{
{ "x-iw-jwt-token", "<TOKEN>" },
},
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://your-instance.iw-erp.de/api/event/base_event_signup/42")
.get()
.addHeader("x-iw-jwt-token", "<TOKEN>")
.build();
Response response = client.newCall(request).execute();package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://your-instance.iw-erp.de/api/event/base_event_signup/42"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-iw-jwt-token", "<TOKEN>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}Dart with the iw_erp_api package
import 'package:iw_erp_api/clients/event_base_event_sign_up_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';
IwApiState().host = 'your-instance.iw-erp.de';
IwApiState().currentJwtApiToken = '<TOKEN>';
final result = await EventBaseEventSignUpController.get('42');
if (result.success) {
print(result.data);
}{
"id": 42,
"address_street": "Jakobistr. 39",
"address_city": "Hannover",
"address_zip": "30163",
"address_country": "DE",
"address_full_country": "DE",
"name": "Beispiel",
"main_phone": "+49 511 123456",
"main_email": "lena.hartmann@example.org",
"bib_range_id": 42
}Update a BaseEventSignUp
PUT/api/event/base_event_signup/{identifier}
Path parameters
identifierrequiredstring |
Responses
200Update a BaseEventSignUpBaseEventSignUp10
Show fields (54)
bib_range_idintegerage_classstringAltersklasse nach DLV, z. B. M40 - berechnet aus Geburtstag, Geschlecht und Eventdatum.
idintegerPrimary key of the sign-up. Internal ID.
genderstringGender of the participant.
tokenstringPublic token of the sign-up. Used in links instead of the ID.
moments_tokenstringParticipant-bound moments token: allows this participant to use the event moments (digital guestbook) page; uploads via this token are linked to the participant.
waitingbooleanThe sign-up is on the waiting list.
confirmedbooleanThe sign-up is confirmed.
externalbooleanThe sign-up was made by an external party.
deletion_reasonstringReason the sign-up was cancelled.
billedbooleanThe sign-up was billed.
direct_billingbooleandirect_billing_check_datestring (date-time)direct_billing_tokenstringwait_list_confirmation_tokenstringwait_list_confirmation_sent_atstring (date-time)wait_list_confirmation_deadlinestring (date-time)wait_list_confirmed_atstring (date-time)wait_list_pending_confirmationbooleanwait_list_sort_orderintegerbirthdaystring (date-time)Birthday of the participant.
trialbooleanTrial date sign-up (Schnuppern): a date sign-up without a course place that uses up one unit of the person's trial pass (eventAccessBudget with sourceType trial)
trial_channelstringWho booked the trial date: app, trainer, office
trial_session_numberintegerNumber of this trial date within the pass (1 = first), for "Schnuppern 2/3"
trial_session_maxintegerTrial dates of the pass, for "Schnuppern 2/3"
nace_sectionstringNACE section code (letter A-U)
nace_codestringNACE code (numeric like 01.11, 62.01)
bib_numberintegerStartnummer (Zaehler). Bei PER_PREFIX nur zusammen mit dem Praefix eindeutig. Wird nur ueber BibNumberAssigner gesetzt, stornierte Anmeldungen behalten sie.
bib_labelstringAngezeigte Startnummer inkl. Praefix, z. B. W0123. Pro Event eindeutig.
bib_number_assigned_atstring (date-time)Time the bib number was assigned.
chip_codestringTransponder- oder QR-Kennung fuer die Zeitmessung. Pro Event eindeutig.
timing_tracking_consentbooleanEinwilligung in das GPS-Live-Tracking waehrend des Events.
createdstring (date-time)Point in time the entity was created.
updatedstring (date-time)Point in time the entity was last updated.
addressstringAddress as text.
address_streetstringStreet of the address.
address_house_numberstringHouse number of the address.
address_street_levelstringStreet and house number of the address.
address_costringCare-of line of the address.
address_citystringCity of the address.
address_zipstringPostal code of the address.
address_admin_level1stringFirst administrative level of the address, e.g. the federal state.
address_countrystringCountry code of the address.
address_full_countrystringFull name of the country of the address.
address_geo_latstringLatitude of the address.
address_geo_lngstringLongitude of the address.
address_external_provider_idstringfield to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
namestringName of the entity.
main_phonestringMain phone number.
main_faxstringMain fax number.
main_emailstringMain e-mail address.
websitestringWebsite address.
deletedbooleanThis property is used to mark an entity as deleted / archived
orderintegerPosition of the entity in the order.
curl --request PUT \
--url https://your-instance.iw-erp.de/api/event/base_event_signup/42 \
--header 'x-iw-jwt-token: <TOKEN>'const options = {method: 'PUT', headers: {'x-iw-jwt-token': '<TOKEN>'}};
fetch('https://your-instance.iw-erp.de/api/event/base_event_signup/42', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://your-instance.iw-erp.de/api/event/base_event_signup/42"
headers = {"x-iw-jwt-token": "<TOKEN>"}
response = requests.put(url, headers=headers)
print(response.text)<?php
require_once('vendor/autoload.php');
$client = new \GuzzleHttp\Client();
$response = $client->request('PUT', 'https://your-instance.iw-erp.de/api/event/base_event_signup/42', [
'headers' => [
'x-iw-jwt-token' => '<TOKEN>',
],
]);
echo $response->getBody();using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Put,
RequestUri = new Uri("https://your-instance.iw-erp.de/api/event/base_event_signup/42"),
Headers =
{
{ "x-iw-jwt-token", "<TOKEN>" },
},
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://your-instance.iw-erp.de/api/event/base_event_signup/42")
.put(null)
.addHeader("x-iw-jwt-token", "<TOKEN>")
.build();
Response response = client.newCall(request).execute();package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://your-instance.iw-erp.de/api/event/base_event_signup/42"
req, _ := http.NewRequest("PUT", url, nil)
req.Header.Add("x-iw-jwt-token", "<TOKEN>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}Dart with the iw_erp_api package
import 'package:iw_erp_api/clients/event_base_event_sign_up_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';
import 'package:iw_erp_api/model/event_base_event_sign_up.dart';
IwApiState().host = 'your-instance.iw-erp.de';
IwApiState().currentJwtApiToken = '<TOKEN>';
final result = await EventBaseEventSignUpController.put(EventBaseEventSignUp.fromJson({}));
if (result.success) {
print(result.data);
}{
"id": 42,
"address_street": "Jakobistr. 39",
"address_city": "Hannover",
"address_zip": "30163",
"address_country": "DE",
"address_full_country": "DE",
"name": "Beispiel",
"main_phone": "+49 511 123456",
"main_email": "lena.hartmann@example.org",
"bib_range_id": 42
}Update a BaseEventSignUp
PATCH/api/event/base_event_signup/{identifier}
Path parameters
identifierrequiredstring |
Responses
200Update a BaseEventSignUpBaseEventSignUp10
Show fields (54)
bib_range_idintegerage_classstringAltersklasse nach DLV, z. B. M40 - berechnet aus Geburtstag, Geschlecht und Eventdatum.
idintegerPrimary key of the sign-up. Internal ID.
genderstringGender of the participant.
tokenstringPublic token of the sign-up. Used in links instead of the ID.
moments_tokenstringParticipant-bound moments token: allows this participant to use the event moments (digital guestbook) page; uploads via this token are linked to the participant.
waitingbooleanThe sign-up is on the waiting list.
confirmedbooleanThe sign-up is confirmed.
externalbooleanThe sign-up was made by an external party.
deletion_reasonstringReason the sign-up was cancelled.
billedbooleanThe sign-up was billed.
direct_billingbooleandirect_billing_check_datestring (date-time)direct_billing_tokenstringwait_list_confirmation_tokenstringwait_list_confirmation_sent_atstring (date-time)wait_list_confirmation_deadlinestring (date-time)wait_list_confirmed_atstring (date-time)wait_list_pending_confirmationbooleanwait_list_sort_orderintegerbirthdaystring (date-time)Birthday of the participant.
trialbooleanTrial date sign-up (Schnuppern): a date sign-up without a course place that uses up one unit of the person's trial pass (eventAccessBudget with sourceType trial)
trial_channelstringWho booked the trial date: app, trainer, office
trial_session_numberintegerNumber of this trial date within the pass (1 = first), for "Schnuppern 2/3"
trial_session_maxintegerTrial dates of the pass, for "Schnuppern 2/3"
nace_sectionstringNACE section code (letter A-U)
nace_codestringNACE code (numeric like 01.11, 62.01)
bib_numberintegerStartnummer (Zaehler). Bei PER_PREFIX nur zusammen mit dem Praefix eindeutig. Wird nur ueber BibNumberAssigner gesetzt, stornierte Anmeldungen behalten sie.
bib_labelstringAngezeigte Startnummer inkl. Praefix, z. B. W0123. Pro Event eindeutig.
bib_number_assigned_atstring (date-time)Time the bib number was assigned.
chip_codestringTransponder- oder QR-Kennung fuer die Zeitmessung. Pro Event eindeutig.
timing_tracking_consentbooleanEinwilligung in das GPS-Live-Tracking waehrend des Events.
createdstring (date-time)Point in time the entity was created.
updatedstring (date-time)Point in time the entity was last updated.
addressstringAddress as text.
address_streetstringStreet of the address.
address_house_numberstringHouse number of the address.
address_street_levelstringStreet and house number of the address.
address_costringCare-of line of the address.
address_citystringCity of the address.
address_zipstringPostal code of the address.
address_admin_level1stringFirst administrative level of the address, e.g. the federal state.
address_countrystringCountry code of the address.
address_full_countrystringFull name of the country of the address.
address_geo_latstringLatitude of the address.
address_geo_lngstringLongitude of the address.
address_external_provider_idstringfield to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
namestringName of the entity.
main_phonestringMain phone number.
main_faxstringMain fax number.
main_emailstringMain e-mail address.
websitestringWebsite address.
deletedbooleanThis property is used to mark an entity as deleted / archived
orderintegerPosition of the entity in the order.
curl --request PATCH \
--url https://your-instance.iw-erp.de/api/event/base_event_signup/42 \
--header 'x-iw-jwt-token: <TOKEN>'const options = {method: 'PATCH', headers: {'x-iw-jwt-token': '<TOKEN>'}};
fetch('https://your-instance.iw-erp.de/api/event/base_event_signup/42', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://your-instance.iw-erp.de/api/event/base_event_signup/42"
headers = {"x-iw-jwt-token": "<TOKEN>"}
response = requests.patch(url, headers=headers)
print(response.text)<?php
require_once('vendor/autoload.php');
$client = new \GuzzleHttp\Client();
$response = $client->request('PATCH', 'https://your-instance.iw-erp.de/api/event/base_event_signup/42', [
'headers' => [
'x-iw-jwt-token' => '<TOKEN>',
],
]);
echo $response->getBody();using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Patch,
RequestUri = new Uri("https://your-instance.iw-erp.de/api/event/base_event_signup/42"),
Headers =
{
{ "x-iw-jwt-token", "<TOKEN>" },
},
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://your-instance.iw-erp.de/api/event/base_event_signup/42")
.patch(null)
.addHeader("x-iw-jwt-token", "<TOKEN>")
.build();
Response response = client.newCall(request).execute();package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://your-instance.iw-erp.de/api/event/base_event_signup/42"
req, _ := http.NewRequest("PATCH", url, nil)
req.Header.Add("x-iw-jwt-token", "<TOKEN>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}Dart with package:http (no controller in the iw_erp_api package)
import 'package:http/http.dart' as http;
final response = await http.patch(
Uri.parse('https://your-instance.iw-erp.de/api/event/base_event_signup/42'),
headers: {'x-iw-jwt-token': '<TOKEN>'},
);
print(response.body);{
"id": 42,
"address_street": "Jakobistr. 39",
"address_city": "Hannover",
"address_zip": "30163",
"address_country": "DE",
"address_full_country": "DE",
"name": "Beispiel",
"main_phone": "+49 511 123456",
"main_email": "lena.hartmann@example.org",
"bib_range_id": 42
}This method will delete a single BaseEventSignUp with the given id or token
DELETE/api/event/base_event_signup/{identifier}
Path parameters
identifierrequiredstring |
Responses
200Deletes a single BaseEventSignUpBaseEventSignUp10
Show fields (54)
bib_range_idintegerage_classstringAltersklasse nach DLV, z. B. M40 - berechnet aus Geburtstag, Geschlecht und Eventdatum.
idintegerPrimary key of the sign-up. Internal ID.
genderstringGender of the participant.
tokenstringPublic token of the sign-up. Used in links instead of the ID.
moments_tokenstringParticipant-bound moments token: allows this participant to use the event moments (digital guestbook) page; uploads via this token are linked to the participant.
waitingbooleanThe sign-up is on the waiting list.
confirmedbooleanThe sign-up is confirmed.
externalbooleanThe sign-up was made by an external party.
deletion_reasonstringReason the sign-up was cancelled.
billedbooleanThe sign-up was billed.
direct_billingbooleandirect_billing_check_datestring (date-time)direct_billing_tokenstringwait_list_confirmation_tokenstringwait_list_confirmation_sent_atstring (date-time)wait_list_confirmation_deadlinestring (date-time)wait_list_confirmed_atstring (date-time)wait_list_pending_confirmationbooleanwait_list_sort_orderintegerbirthdaystring (date-time)Birthday of the participant.
trialbooleanTrial date sign-up (Schnuppern): a date sign-up without a course place that uses up one unit of the person's trial pass (eventAccessBudget with sourceType trial)
trial_channelstringWho booked the trial date: app, trainer, office
trial_session_numberintegerNumber of this trial date within the pass (1 = first), for "Schnuppern 2/3"
trial_session_maxintegerTrial dates of the pass, for "Schnuppern 2/3"
nace_sectionstringNACE section code (letter A-U)
nace_codestringNACE code (numeric like 01.11, 62.01)
bib_numberintegerStartnummer (Zaehler). Bei PER_PREFIX nur zusammen mit dem Praefix eindeutig. Wird nur ueber BibNumberAssigner gesetzt, stornierte Anmeldungen behalten sie.
bib_labelstringAngezeigte Startnummer inkl. Praefix, z. B. W0123. Pro Event eindeutig.
bib_number_assigned_atstring (date-time)Time the bib number was assigned.
chip_codestringTransponder- oder QR-Kennung fuer die Zeitmessung. Pro Event eindeutig.
timing_tracking_consentbooleanEinwilligung in das GPS-Live-Tracking waehrend des Events.
createdstring (date-time)Point in time the entity was created.
updatedstring (date-time)Point in time the entity was last updated.
addressstringAddress as text.
address_streetstringStreet of the address.
address_house_numberstringHouse number of the address.
address_street_levelstringStreet and house number of the address.
address_costringCare-of line of the address.
address_citystringCity of the address.
address_zipstringPostal code of the address.
address_admin_level1stringFirst administrative level of the address, e.g. the federal state.
address_countrystringCountry code of the address.
address_full_countrystringFull name of the country of the address.
address_geo_latstringLatitude of the address.
address_geo_lngstringLongitude of the address.
address_external_provider_idstringfield to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
namestringName of the entity.
main_phonestringMain phone number.
main_faxstringMain fax number.
main_emailstringMain e-mail address.
websitestringWebsite address.
deletedbooleanThis property is used to mark an entity as deleted / archived
orderintegerPosition of the entity in the order.
curl --request DELETE \
--url https://your-instance.iw-erp.de/api/event/base_event_signup/42 \
--header 'x-iw-jwt-token: <TOKEN>'const options = {method: 'DELETE', headers: {'x-iw-jwt-token': '<TOKEN>'}};
fetch('https://your-instance.iw-erp.de/api/event/base_event_signup/42', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://your-instance.iw-erp.de/api/event/base_event_signup/42"
headers = {"x-iw-jwt-token": "<TOKEN>"}
response = requests.delete(url, headers=headers)
print(response.text)<?php
require_once('vendor/autoload.php');
$client = new \GuzzleHttp\Client();
$response = $client->request('DELETE', 'https://your-instance.iw-erp.de/api/event/base_event_signup/42', [
'headers' => [
'x-iw-jwt-token' => '<TOKEN>',
],
]);
echo $response->getBody();using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Delete,
RequestUri = new Uri("https://your-instance.iw-erp.de/api/event/base_event_signup/42"),
Headers =
{
{ "x-iw-jwt-token", "<TOKEN>" },
},
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://your-instance.iw-erp.de/api/event/base_event_signup/42")
.delete(null)
.addHeader("x-iw-jwt-token", "<TOKEN>")
.build();
Response response = client.newCall(request).execute();package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://your-instance.iw-erp.de/api/event/base_event_signup/42"
req, _ := http.NewRequest("DELETE", url, nil)
req.Header.Add("x-iw-jwt-token", "<TOKEN>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}Dart with the iw_erp_api package
import 'package:iw_erp_api/clients/event_base_event_sign_up_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';
IwApiState().host = 'your-instance.iw-erp.de';
IwApiState().currentJwtApiToken = '<TOKEN>';
final result = await EventBaseEventSignUpController.delete('42');
if (result.success) {
print(result.data);
}{
"id": 42,
"address_street": "Jakobistr. 39",
"address_city": "Hannover",
"address_zip": "30163",
"address_country": "DE",
"address_full_country": "DE",
"name": "Beispiel",
"main_phone": "+49 511 123456",
"main_email": "lena.hartmann@example.org",
"bib_range_id": 42
}This method will get all BaseEventSignUp Objects for customer
GET/api/event/customer/base_event_signup
Query parameters
searchStringstring | text to search for in the list |
orderFieldNamestring | name of the order field |
orderFieldSortstring | sorting modeAllowed: DESCASC |
pageinteger | page of the list |
pageSizeinteger | number of entries for each page |
withMaxPageNumberstring | returns the number of pages available as a header if this is set |
Responses
200Returns a list of BaseEventSignUp objects for customerarray<BaseEventSignUp10>
Show fields (54)
bib_range_idintegerage_classstringAltersklasse nach DLV, z. B. M40 - berechnet aus Geburtstag, Geschlecht und Eventdatum.
idintegerPrimary key of the sign-up. Internal ID.
genderstringGender of the participant.
tokenstringPublic token of the sign-up. Used in links instead of the ID.
moments_tokenstringParticipant-bound moments token: allows this participant to use the event moments (digital guestbook) page; uploads via this token are linked to the participant.
waitingbooleanThe sign-up is on the waiting list.
confirmedbooleanThe sign-up is confirmed.
externalbooleanThe sign-up was made by an external party.
deletion_reasonstringReason the sign-up was cancelled.
billedbooleanThe sign-up was billed.
direct_billingbooleandirect_billing_check_datestring (date-time)direct_billing_tokenstringwait_list_confirmation_tokenstringwait_list_confirmation_sent_atstring (date-time)wait_list_confirmation_deadlinestring (date-time)wait_list_confirmed_atstring (date-time)wait_list_pending_confirmationbooleanwait_list_sort_orderintegerbirthdaystring (date-time)Birthday of the participant.
trialbooleanTrial date sign-up (Schnuppern): a date sign-up without a course place that uses up one unit of the person's trial pass (eventAccessBudget with sourceType trial)
trial_channelstringWho booked the trial date: app, trainer, office
trial_session_numberintegerNumber of this trial date within the pass (1 = first), for "Schnuppern 2/3"
trial_session_maxintegerTrial dates of the pass, for "Schnuppern 2/3"
nace_sectionstringNACE section code (letter A-U)
nace_codestringNACE code (numeric like 01.11, 62.01)
bib_numberintegerStartnummer (Zaehler). Bei PER_PREFIX nur zusammen mit dem Praefix eindeutig. Wird nur ueber BibNumberAssigner gesetzt, stornierte Anmeldungen behalten sie.
bib_labelstringAngezeigte Startnummer inkl. Praefix, z. B. W0123. Pro Event eindeutig.
bib_number_assigned_atstring (date-time)Time the bib number was assigned.
chip_codestringTransponder- oder QR-Kennung fuer die Zeitmessung. Pro Event eindeutig.
timing_tracking_consentbooleanEinwilligung in das GPS-Live-Tracking waehrend des Events.
createdstring (date-time)Point in time the entity was created.
updatedstring (date-time)Point in time the entity was last updated.
addressstringAddress as text.
address_streetstringStreet of the address.
address_house_numberstringHouse number of the address.
address_street_levelstringStreet and house number of the address.
address_costringCare-of line of the address.
address_citystringCity of the address.
address_zipstringPostal code of the address.
address_admin_level1stringFirst administrative level of the address, e.g. the federal state.
address_countrystringCountry code of the address.
address_full_countrystringFull name of the country of the address.
address_geo_latstringLatitude of the address.
address_geo_lngstringLongitude of the address.
address_external_provider_idstringfield to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
namestringName of the entity.
main_phonestringMain phone number.
main_faxstringMain fax number.
main_emailstringMain e-mail address.
websitestringWebsite address.
deletedbooleanThis property is used to mark an entity as deleted / archived
orderintegerPosition of the entity in the order.
curl --request GET \
--url https://your-instance.iw-erp.de/api/event/customer/base_event_signup \
--header 'x-iw-jwt-token: <TOKEN>'const options = {method: 'GET', headers: {'x-iw-jwt-token': '<TOKEN>'}};
fetch('https://your-instance.iw-erp.de/api/event/customer/base_event_signup', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://your-instance.iw-erp.de/api/event/customer/base_event_signup"
headers = {"x-iw-jwt-token": "<TOKEN>"}
response = requests.get(url, headers=headers)
print(response.text)<?php
require_once('vendor/autoload.php');
$client = new \GuzzleHttp\Client();
$response = $client->request('GET', 'https://your-instance.iw-erp.de/api/event/customer/base_event_signup', [
'headers' => [
'x-iw-jwt-token' => '<TOKEN>',
],
]);
echo $response->getBody();using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("https://your-instance.iw-erp.de/api/event/customer/base_event_signup"),
Headers =
{
{ "x-iw-jwt-token", "<TOKEN>" },
},
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://your-instance.iw-erp.de/api/event/customer/base_event_signup")
.get()
.addHeader("x-iw-jwt-token", "<TOKEN>")
.build();
Response response = client.newCall(request).execute();package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://your-instance.iw-erp.de/api/event/customer/base_event_signup"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-iw-jwt-token", "<TOKEN>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}Dart with the iw_erp_api package
import 'package:iw_erp_api/clients/event_base_event_sign_up_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';
IwApiState().host = 'your-instance.iw-erp.de';
IwApiState().currentJwtApiToken = '<TOKEN>';
final result = await EventBaseEventSignUpController.getAllCustomer();
if (result.success) {
print(result.data);
}[
{
"id": 42,
"address_street": "Jakobistr. 39",
"address_city": "Hannover",
"address_zip": "30163",
"address_country": "DE",
"address_full_country": "DE",
"name": "Beispiel",
"main_phone": "+49 511 123456",
"main_email": "lena.hartmann@example.org",
"bib_range_id": 42
}
]Add a new BaseEventSignUp as customer
POST/api/event/customer/base_event_signup
Responses
200Add a new BaseEventSignUp as customerBaseEventSignUp10
Show fields (54)
bib_range_idintegerage_classstringAltersklasse nach DLV, z. B. M40 - berechnet aus Geburtstag, Geschlecht und Eventdatum.
idintegerPrimary key of the sign-up. Internal ID.
genderstringGender of the participant.
tokenstringPublic token of the sign-up. Used in links instead of the ID.
moments_tokenstringParticipant-bound moments token: allows this participant to use the event moments (digital guestbook) page; uploads via this token are linked to the participant.
waitingbooleanThe sign-up is on the waiting list.
confirmedbooleanThe sign-up is confirmed.
externalbooleanThe sign-up was made by an external party.
deletion_reasonstringReason the sign-up was cancelled.
billedbooleanThe sign-up was billed.
direct_billingbooleandirect_billing_check_datestring (date-time)direct_billing_tokenstringwait_list_confirmation_tokenstringwait_list_confirmation_sent_atstring (date-time)wait_list_confirmation_deadlinestring (date-time)wait_list_confirmed_atstring (date-time)wait_list_pending_confirmationbooleanwait_list_sort_orderintegerbirthdaystring (date-time)Birthday of the participant.
trialbooleanTrial date sign-up (Schnuppern): a date sign-up without a course place that uses up one unit of the person's trial pass (eventAccessBudget with sourceType trial)
trial_channelstringWho booked the trial date: app, trainer, office
trial_session_numberintegerNumber of this trial date within the pass (1 = first), for "Schnuppern 2/3"
trial_session_maxintegerTrial dates of the pass, for "Schnuppern 2/3"
nace_sectionstringNACE section code (letter A-U)
nace_codestringNACE code (numeric like 01.11, 62.01)
bib_numberintegerStartnummer (Zaehler). Bei PER_PREFIX nur zusammen mit dem Praefix eindeutig. Wird nur ueber BibNumberAssigner gesetzt, stornierte Anmeldungen behalten sie.
bib_labelstringAngezeigte Startnummer inkl. Praefix, z. B. W0123. Pro Event eindeutig.
bib_number_assigned_atstring (date-time)Time the bib number was assigned.
chip_codestringTransponder- oder QR-Kennung fuer die Zeitmessung. Pro Event eindeutig.
timing_tracking_consentbooleanEinwilligung in das GPS-Live-Tracking waehrend des Events.
createdstring (date-time)Point in time the entity was created.
updatedstring (date-time)Point in time the entity was last updated.
addressstringAddress as text.
address_streetstringStreet of the address.
address_house_numberstringHouse number of the address.
address_street_levelstringStreet and house number of the address.
address_costringCare-of line of the address.
address_citystringCity of the address.
address_zipstringPostal code of the address.
address_admin_level1stringFirst administrative level of the address, e.g. the federal state.
address_countrystringCountry code of the address.
address_full_countrystringFull name of the country of the address.
address_geo_latstringLatitude of the address.
address_geo_lngstringLongitude of the address.
address_external_provider_idstringfield to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
namestringName of the entity.
main_phonestringMain phone number.
main_faxstringMain fax number.
main_emailstringMain e-mail address.
websitestringWebsite address.
deletedbooleanThis property is used to mark an entity as deleted / archived
orderintegerPosition of the entity in the order.
curl --request POST \
--url https://your-instance.iw-erp.de/api/event/customer/base_event_signup \
--header 'x-iw-jwt-token: <TOKEN>'const options = {method: 'POST', headers: {'x-iw-jwt-token': '<TOKEN>'}};
fetch('https://your-instance.iw-erp.de/api/event/customer/base_event_signup', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://your-instance.iw-erp.de/api/event/customer/base_event_signup"
headers = {"x-iw-jwt-token": "<TOKEN>"}
response = requests.post(url, headers=headers)
print(response.text)<?php
require_once('vendor/autoload.php');
$client = new \GuzzleHttp\Client();
$response = $client->request('POST', 'https://your-instance.iw-erp.de/api/event/customer/base_event_signup', [
'headers' => [
'x-iw-jwt-token' => '<TOKEN>',
],
]);
echo $response->getBody();using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("https://your-instance.iw-erp.de/api/event/customer/base_event_signup"),
Headers =
{
{ "x-iw-jwt-token", "<TOKEN>" },
},
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://your-instance.iw-erp.de/api/event/customer/base_event_signup")
.post(null)
.addHeader("x-iw-jwt-token", "<TOKEN>")
.build();
Response response = client.newCall(request).execute();package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://your-instance.iw-erp.de/api/event/customer/base_event_signup"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("x-iw-jwt-token", "<TOKEN>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}Dart with the iw_erp_api package
import 'package:iw_erp_api/clients/event_base_event_sign_up_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';
import 'package:iw_erp_api/model/event_base_event_sign_up.dart';
IwApiState().host = 'your-instance.iw-erp.de';
IwApiState().currentJwtApiToken = '<TOKEN>';
final result = await EventBaseEventSignUpController.postCustomer(EventBaseEventSignUp.fromJson({}));
if (result.success) {
print(result.data);
}{
"id": 42,
"address_street": "Jakobistr. 39",
"address_city": "Hannover",
"address_zip": "30163",
"address_country": "DE",
"address_full_country": "DE",
"name": "Beispiel",
"main_phone": "+49 511 123456",
"main_email": "lena.hartmann@example.org",
"bib_range_id": 42
}Sign up several persons of the selected company together (e.g. a family for a run)
POST/api/event/customer/base_event_signup_group
All persons are signed up or none: every entry runs the same checks as a single
customer sign-up (access, timing, required fields, price incl. member prices) and the
event must have a free place for each of them - a group never goes onto the wait list.
With direct billing the whole group gets one invoice and one payment.
Body: the shared sign-up fields plus sign_ups, one entry per person with person,
product (the selected price) and the per-person fields of the event (birthday,
allergies, media_questionnaire_answer, invoice_products, ...).
Only while the setting event_sign_up_group_enabled is on (iw error 403 otherwise).
Request body application/json
dataBaseEventSignUp3Show fields (39)
first_namestringFirst name of the participant.
last_namestringLast name of the participant.
genderstringGender of the participant.
deletion_reasonstringReason the sign-up was cancelled.
direct_billingbooleandirect_billing_check_datestring (date-time)direct_billing_tokenstringbirthdaystring (date-time)Birthday of the participant.
known_allergiesstringKnown allergies of the participant.
confirmed_no_allergiesbooleanGuardian confirmed that there are no known allergies.
allow_photosbooleanGuardian allows photos of the participant.
allow_child_alonebooleanParticipant may leave alone after the event.
authorized_pickupstringPersons who are allowed to pick up the participant.
needs_supportbooleanParticipant needs support, for example for inclusion.
support_descriptionstringDescription of the support the participant needs.
financial_supportbooleanParticipant receives financial support.
financial_support_numberstringNumber of the financial support, for example a voucher.
municipal_supportbooleanParticipant receives municipal support.
municipal_support_numberstringNumber of the municipal support.
grade_levelintegerSchool grade level of the participant.
school_classstringSchool class of the participant.
confirmed_disclaimerbooleanParticipant confirmed the disclaimer.
confirmed_privacybooleanParticipant confirmed the privacy policy.
confirmed_cancellation_policybooleanParticipant confirmed the cancellation policy.
free_note_onestringFree note 1 entered on the sign-up.
free_note_twostringFree note 2 entered on the sign-up.
free_note_threestringFree note 3 entered on the sign-up.
free_note_fourstringFree note 4 entered on the sign-up.
invoice_productsarray<BaseEventSignUpProductItem>Product items added to the invoice of the sign-up.
self_check_inbooleanParticipant checked in with the self-service check-in.
self_check_outbooleanParticipant checked out with the self-service check-out.
nace_sectionstringNACE section code (letter A-U)
nace_codestringNACE code (numeric like 01.11, 62.01)
main_phonestringMain phone number.
main_faxstringMain fax number.
main_emailstringMain e-mail address.
websitestringWebsite address.
base_eventBaseEvent21Event the entity belongs to.
base_bookingBaseBooking21Booking the entity belongs to.
Responses
200Sign up several persons of the selected company togetherBaseEventSignUpGroup
Show fields (3)
direct_billing_tokenstringToken of the invoice to pay online (direct billing): all sign-ups of a group share one invoice.
idintegerPrimary key of the sign-up group. Internal ID.
sign_upsarray<BaseEventSignUp18>Sign-ups that belong to the group.
Show fields (41)
idintegerPrimary key of the sign-up. Internal ID.
first_namestringFirst name of the participant.
last_namestringLast name of the participant.
genderstringGender of the participant.
waitingbooleanThe sign-up is on the waiting list.
confirmedbooleanThe sign-up is confirmed.
deletion_reasonstringReason the sign-up was cancelled.
direct_billingbooleandirect_billing_check_datestring (date-time)direct_billing_tokenstringwait_list_confirmation_sent_atstring (date-time)wait_list_confirmation_deadlinestring (date-time)wait_list_confirmed_atstring (date-time)wait_list_pending_confirmationbooleanwait_list_sort_orderintegerbirthdaystring (date-time)Birthday of the participant.
known_allergiesstringKnown allergies of the participant.
confirmed_no_allergiesbooleanGuardian confirmed that there are no known allergies.
allow_photosbooleanGuardian allows photos of the participant.
allow_child_alonebooleanParticipant may leave alone after the event.
authorized_pickupstringPersons who are allowed to pick up the participant.
needs_supportbooleanParticipant needs support, for example for inclusion.
support_descriptionstringDescription of the support the participant needs.
financial_supportbooleanParticipant receives financial support.
financial_support_numberstringNumber of the financial support, for example a voucher.
municipal_supportbooleanParticipant receives municipal support.
municipal_support_numberstringNumber of the municipal support.
grade_levelintegerSchool grade level of the participant.
school_classstringSchool class of the participant.
self_check_inbooleanParticipant checked in with the self-service check-in.
self_check_outbooleanParticipant checked out with the self-service check-out.
self_check_in_datestring (date-time)Time of the self-service check-in.
self_check_out_datestring (date-time)Time of the self-service check-out.
reminded_of_absencestring (date-time)Time the guardian was reminded of an absence.
trialbooleanTrial date sign-up (Schnuppern): a date sign-up without a course place that uses up one unit of the person's trial pass (eventAccessBudget with sourceType trial)
trial_channelstringWho booked the trial date: app, trainer, office
trial_session_numberintegerNumber of this trial date within the pass (1 = first), for "Schnuppern 2/3"
trial_session_maxintegerTrial dates of the pass, for "Schnuppern 2/3"
confirmed_datestring (date-time)Time the sign-up was confirmed.
bib_numberintegerStartnummer (Zaehler). Bei PER_PREFIX nur zusammen mit dem Praefix eindeutig. Wird nur ueber BibNumberAssigner gesetzt, stornierte Anmeldungen behalten sie.
bib_labelstringAngezeigte Startnummer inkl. Praefix, z. B. W0123. Pro Event eindeutig.
curl --request POST \
--url https://your-instance.iw-erp.de/api/event/customer/base_event_signup_group \
--header 'content-type: application/json' \
--header 'x-iw-jwt-token: <TOKEN>' \
--data '
{
"data": {
"first_name": "Lena",
"last_name": "Hartmann",
"support_description": "Text",
"main_phone": "+49 511 123456",
"main_email": "lena.hartmann@example.org",
"gender": "string"
}
}
'const options = {
method: 'POST',
headers: {'x-iw-jwt-token': '<TOKEN>', 'content-type': 'application/json'},
body: JSON.stringify({
data: {
first_name: 'Lena',
last_name: 'Hartmann',
support_description: 'Text',
main_phone: '+49 511 123456',
main_email: 'lena.hartmann@example.org',
gender: 'string'
}
})
};
fetch('https://your-instance.iw-erp.de/api/event/customer/base_event_signup_group', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://your-instance.iw-erp.de/api/event/customer/base_event_signup_group"
payload = { "data": {
"first_name": "Lena",
"last_name": "Hartmann",
"support_description": "Text",
"main_phone": "+49 511 123456",
"main_email": "lena.hartmann@example.org",
"gender": "string"
} }
headers = {
"x-iw-jwt-token": "<TOKEN>",
"content-type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)<?php
require_once('vendor/autoload.php');
$client = new \GuzzleHttp\Client();
$response = $client->request('POST', 'https://your-instance.iw-erp.de/api/event/customer/base_event_signup_group', [
'body' => '{"data":{"first_name":"Lena","last_name":"Hartmann","support_description":"Text","main_phone":"+49 511 123456","main_email":"lena.hartmann@example.org","gender":"string"}}',
'headers' => [
'content-type' => 'application/json',
'x-iw-jwt-token' => '<TOKEN>',
],
]);
echo $response->getBody();using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("https://your-instance.iw-erp.de/api/event/customer/base_event_signup_group"),
Headers =
{
{ "x-iw-jwt-token", "<TOKEN>" },
},
Content = new StringContent("{\"data\":{\"first_name\":\"Lena\",\"last_name\":\"Hartmann\",\"support_description\":\"Text\",\"main_phone\":\"+49 511 123456\",\"main_email\":\"lena.hartmann@example.org\",\"gender\":\"string\"}}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"data\":{\"first_name\":\"Lena\",\"last_name\":\"Hartmann\",\"support_description\":\"Text\",\"main_phone\":\"+49 511 123456\",\"main_email\":\"lena.hartmann@example.org\",\"gender\":\"string\"}}");
Request request = new Request.Builder()
.url("https://your-instance.iw-erp.de/api/event/customer/base_event_signup_group")
.post(body)
.addHeader("x-iw-jwt-token", "<TOKEN>")
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://your-instance.iw-erp.de/api/event/customer/base_event_signup_group"
payload := strings.NewReader("{\"data\":{\"first_name\":\"Lena\",\"last_name\":\"Hartmann\",\"support_description\":\"Text\",\"main_phone\":\"+49 511 123456\",\"main_email\":\"lena.hartmann@example.org\",\"gender\":\"string\"}}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-iw-jwt-token", "<TOKEN>")
req.Header.Add("content-type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}Dart with the iw_erp_api package
import 'package:iw_erp_api/clients/event_base_event_sign_up_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';
import 'package:iw_erp_api/model/event_base_event_sign_up.dart';
IwApiState().host = 'your-instance.iw-erp.de';
IwApiState().currentJwtApiToken = '<TOKEN>';
final result = await EventBaseEventSignUpController.postCustomerGroup(EventBaseEventSignUp.fromJson({
"first_name": "Lena",
"last_name": "Hartmann",
"support_description": "Text",
"main_phone": "+49 511 123456",
"main_email": "lena.hartmann@example.org",
"gender": "string"
}), List<EventBaseEventSignUp>.fromJson({
"first_name": "Lena",
"last_name": "Hartmann",
"support_description": "Text",
"main_phone": "+49 511 123456",
"main_email": "lena.hartmann@example.org",
"gender": "string"
}));
if (result.success) {
print(result.data);
}{
"id": 42,
"direct_billing_token": "string",
"sign_ups": [
{
"id": 42,
"first_name": "Lena",
"last_name": "Hartmann",
"support_description": "Text",
"gender": "string",
"waiting": true,
"confirmed": true,
"deletion_reason": "string",
"direct_billing": true,
"direct_billing_check_date": "2026-10-15T09:30:00+02:00"
}
]
}Sign up several persons together as a guest (e.g. a family for a public run)
POST/api/event/public/base_event_signup_group
Like the customer group sign-up, but without a login: every entry carries the
participant's own data (first_name, last_name, birthday, ... and the
per-person fields of the event); contact, address and payment data are shared
and sent once. Only prices without access conditions can be chosen. All or none
are signed up, never onto the wait list; with direct billing the group pays one invoice.
Only while the setting event_sign_up_group_enabled is on (iw error 403 otherwise).
Request body application/json
dataBaseEventSignUp4Show fields (56)
first_namestringFirst name of the participant.
last_namestringLast name of the participant.
genderstringGender of the participant.
deletion_reasonstringReason the sign-up was cancelled.
direct_billingbooleandirect_billing_check_datestring (date-time)direct_billing_tokenstringbirthdaystring (date-time)Birthday of the participant.
known_allergiesstringKnown allergies of the participant.
confirmed_no_allergiesbooleanGuardian confirmed that there are no known allergies.
allow_photosbooleanGuardian allows photos of the participant.
allow_child_alonebooleanParticipant may leave alone after the event.
authorized_pickupstringPersons who are allowed to pick up the participant.
needs_supportbooleanParticipant needs support, for example for inclusion.
support_descriptionstringDescription of the support the participant needs.
financial_supportbooleanParticipant receives financial support.
financial_support_numberstringNumber of the financial support, for example a voucher.
municipal_supportbooleanParticipant receives municipal support.
municipal_support_numberstringNumber of the municipal support.
grade_levelintegerSchool grade level of the participant.
school_classstringSchool class of the participant.
confirmed_disclaimerbooleanParticipant confirmed the disclaimer.
confirmed_privacybooleanParticipant confirmed the privacy policy.
confirmed_cancellation_policybooleanParticipant confirmed the cancellation policy.
free_note_onestringFree note 1 entered on the sign-up.
free_note_twostringFree note 2 entered on the sign-up.
free_note_threestringFree note 3 entered on the sign-up.
free_note_fourstringFree note 4 entered on the sign-up.
invoice_productsarray<BaseEventSignUpProductItem2>Product items added to the invoice of the sign-up.
self_check_inbooleanParticipant checked in with the self-service check-in.
self_check_outbooleanParticipant checked out with the self-service check-out.
nace_sectionstringNACE section code (letter A-U)
nace_codestringNACE code (numeric like 01.11, 62.01)
addressstringAddress as text.
address_streetstringStreet of the address.
address_house_numberstringHouse number of the address.
address_street_levelstringStreet and house number of the address.
address_costringCare-of line of the address.
address_citystringCity of the address.
address_zipstringPostal code of the address.
address_admin_level1stringFirst administrative level of the address, e.g. the federal state.
address_external_provider_idstringfield to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
namestringName of the entity.
main_phonestringMain phone number.
main_faxstringMain fax number.
main_emailstringMain e-mail address.
websitestringWebsite address.
base_eventBaseEvent22Event the entity belongs to.
payment_ownerstringAccount owner of the direct debit.
payment_institutionstringName of the bank of the direct debit.
payment_bicstringBIC of the bank account.
payment_ibanstringIBAN of the bank account.
payment_mandatestringReference of the SEPA mandate.
payment_mandate_sign_datestring (date-time)Date the SEPA mandate was signed.
payment_mandate_valid_until_datestring (date-time)Date until which the SEPA mandate is valid.
base_bookingBaseBooking22Booking the entity belongs to.
Responses
200Sign up several persons together as a guestBaseEventSignUpGroup
Show fields (3)
direct_billing_tokenstringToken of the invoice to pay online (direct billing): all sign-ups of a group share one invoice.
idintegerPrimary key of the sign-up group. Internal ID.
sign_upsarray<BaseEventSignUp18>Sign-ups that belong to the group.
Show fields (41)
idintegerPrimary key of the sign-up. Internal ID.
first_namestringFirst name of the participant.
last_namestringLast name of the participant.
genderstringGender of the participant.
waitingbooleanThe sign-up is on the waiting list.
confirmedbooleanThe sign-up is confirmed.
deletion_reasonstringReason the sign-up was cancelled.
direct_billingbooleandirect_billing_check_datestring (date-time)direct_billing_tokenstringwait_list_confirmation_sent_atstring (date-time)wait_list_confirmation_deadlinestring (date-time)wait_list_confirmed_atstring (date-time)wait_list_pending_confirmationbooleanwait_list_sort_orderintegerbirthdaystring (date-time)Birthday of the participant.
known_allergiesstringKnown allergies of the participant.
confirmed_no_allergiesbooleanGuardian confirmed that there are no known allergies.
allow_photosbooleanGuardian allows photos of the participant.
allow_child_alonebooleanParticipant may leave alone after the event.
authorized_pickupstringPersons who are allowed to pick up the participant.
needs_supportbooleanParticipant needs support, for example for inclusion.
support_descriptionstringDescription of the support the participant needs.
financial_supportbooleanParticipant receives financial support.
financial_support_numberstringNumber of the financial support, for example a voucher.
municipal_supportbooleanParticipant receives municipal support.
municipal_support_numberstringNumber of the municipal support.
grade_levelintegerSchool grade level of the participant.
school_classstringSchool class of the participant.
self_check_inbooleanParticipant checked in with the self-service check-in.
self_check_outbooleanParticipant checked out with the self-service check-out.
self_check_in_datestring (date-time)Time of the self-service check-in.
self_check_out_datestring (date-time)Time of the self-service check-out.
reminded_of_absencestring (date-time)Time the guardian was reminded of an absence.
trialbooleanTrial date sign-up (Schnuppern): a date sign-up without a course place that uses up one unit of the person's trial pass (eventAccessBudget with sourceType trial)
trial_channelstringWho booked the trial date: app, trainer, office
trial_session_numberintegerNumber of this trial date within the pass (1 = first), for "Schnuppern 2/3"
trial_session_maxintegerTrial dates of the pass, for "Schnuppern 2/3"
confirmed_datestring (date-time)Time the sign-up was confirmed.
bib_numberintegerStartnummer (Zaehler). Bei PER_PREFIX nur zusammen mit dem Praefix eindeutig. Wird nur ueber BibNumberAssigner gesetzt, stornierte Anmeldungen behalten sie.
bib_labelstringAngezeigte Startnummer inkl. Praefix, z. B. W0123. Pro Event eindeutig.
curl --request POST \
--url https://your-instance.iw-erp.de/api/event/public/base_event_signup_group \
--header 'content-type: application/json' \
--header 'x-iw-jwt-token: <TOKEN>' \
--data '
{
"data": {
"first_name": "Lena",
"last_name": "Hartmann",
"support_description": "Text",
"address_street": "Jakobistr. 39",
"address_city": "Hannover",
"address_zip": "30163"
}
}
'const options = {
method: 'POST',
headers: {'x-iw-jwt-token': '<TOKEN>', 'content-type': 'application/json'},
body: JSON.stringify({
data: {
first_name: 'Lena',
last_name: 'Hartmann',
support_description: 'Text',
address_street: 'Jakobistr. 39',
address_city: 'Hannover',
address_zip: '30163'
}
})
};
fetch('https://your-instance.iw-erp.de/api/event/public/base_event_signup_group', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://your-instance.iw-erp.de/api/event/public/base_event_signup_group"
payload = { "data": {
"first_name": "Lena",
"last_name": "Hartmann",
"support_description": "Text",
"address_street": "Jakobistr. 39",
"address_city": "Hannover",
"address_zip": "30163"
} }
headers = {
"x-iw-jwt-token": "<TOKEN>",
"content-type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)<?php
require_once('vendor/autoload.php');
$client = new \GuzzleHttp\Client();
$response = $client->request('POST', 'https://your-instance.iw-erp.de/api/event/public/base_event_signup_group', [
'body' => '{"data":{"first_name":"Lena","last_name":"Hartmann","support_description":"Text","address_street":"Jakobistr. 39","address_city":"Hannover","address_zip":"30163"}}',
'headers' => [
'content-type' => 'application/json',
'x-iw-jwt-token' => '<TOKEN>',
],
]);
echo $response->getBody();using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("https://your-instance.iw-erp.de/api/event/public/base_event_signup_group"),
Headers =
{
{ "x-iw-jwt-token", "<TOKEN>" },
},
Content = new StringContent("{\"data\":{\"first_name\":\"Lena\",\"last_name\":\"Hartmann\",\"support_description\":\"Text\",\"address_street\":\"Jakobistr. 39\",\"address_city\":\"Hannover\",\"address_zip\":\"30163\"}}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"data\":{\"first_name\":\"Lena\",\"last_name\":\"Hartmann\",\"support_description\":\"Text\",\"address_street\":\"Jakobistr. 39\",\"address_city\":\"Hannover\",\"address_zip\":\"30163\"}}");
Request request = new Request.Builder()
.url("https://your-instance.iw-erp.de/api/event/public/base_event_signup_group")
.post(body)
.addHeader("x-iw-jwt-token", "<TOKEN>")
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://your-instance.iw-erp.de/api/event/public/base_event_signup_group"
payload := strings.NewReader("{\"data\":{\"first_name\":\"Lena\",\"last_name\":\"Hartmann\",\"support_description\":\"Text\",\"address_street\":\"Jakobistr. 39\",\"address_city\":\"Hannover\",\"address_zip\":\"30163\"}}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-iw-jwt-token", "<TOKEN>")
req.Header.Add("content-type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}Dart with the iw_erp_api package
import 'package:iw_erp_api/clients/event_base_event_sign_up_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';
import 'package:iw_erp_api/model/event_base_event_sign_up.dart';
IwApiState().host = 'your-instance.iw-erp.de';
IwApiState().currentJwtApiToken = '<TOKEN>';
final result = await EventBaseEventSignUpController.postPublicGroup(EventBaseEventSignUp.fromJson({
"first_name": "Lena",
"last_name": "Hartmann",
"support_description": "Text",
"address_street": "Jakobistr. 39",
"address_city": "Hannover",
"address_zip": "30163"
}), List<EventBaseEventSignUp>.fromJson({
"first_name": "Lena",
"last_name": "Hartmann",
"support_description": "Text",
"address_street": "Jakobistr. 39",
"address_city": "Hannover",
"address_zip": "30163"
}));
if (result.success) {
print(result.data);
}{
"id": 42,
"direct_billing_token": "string",
"sign_ups": [
{
"id": 42,
"first_name": "Lena",
"last_name": "Hartmann",
"support_description": "Text",
"gender": "string",
"waiting": true,
"confirmed": true,
"deletion_reason": "string",
"direct_billing": true,
"direct_billing_check_date": "2026-10-15T09:30:00+02:00"
}
]
}This method will delete a single BaseEventSignUp for the person in a event
DELETE/api/event/customer/base_event_signup/event/{eventIdentifier}
Path parameters
eventIdentifierrequiredstring |
Responses
200Delete a single BaseEventSignUp for the person in a eventBaseEventSignUp10
Show fields (54)
bib_range_idintegerage_classstringAltersklasse nach DLV, z. B. M40 - berechnet aus Geburtstag, Geschlecht und Eventdatum.
idintegerPrimary key of the sign-up. Internal ID.
genderstringGender of the participant.
tokenstringPublic token of the sign-up. Used in links instead of the ID.
moments_tokenstringParticipant-bound moments token: allows this participant to use the event moments (digital guestbook) page; uploads via this token are linked to the participant.
waitingbooleanThe sign-up is on the waiting list.
confirmedbooleanThe sign-up is confirmed.
externalbooleanThe sign-up was made by an external party.
deletion_reasonstringReason the sign-up was cancelled.
billedbooleanThe sign-up was billed.
direct_billingbooleandirect_billing_check_datestring (date-time)direct_billing_tokenstringwait_list_confirmation_tokenstringwait_list_confirmation_sent_atstring (date-time)wait_list_confirmation_deadlinestring (date-time)wait_list_confirmed_atstring (date-time)wait_list_pending_confirmationbooleanwait_list_sort_orderintegerbirthdaystring (date-time)Birthday of the participant.
trialbooleanTrial date sign-up (Schnuppern): a date sign-up without a course place that uses up one unit of the person's trial pass (eventAccessBudget with sourceType trial)
trial_channelstringWho booked the trial date: app, trainer, office
trial_session_numberintegerNumber of this trial date within the pass (1 = first), for "Schnuppern 2/3"
trial_session_maxintegerTrial dates of the pass, for "Schnuppern 2/3"
nace_sectionstringNACE section code (letter A-U)
nace_codestringNACE code (numeric like 01.11, 62.01)
bib_numberintegerStartnummer (Zaehler). Bei PER_PREFIX nur zusammen mit dem Praefix eindeutig. Wird nur ueber BibNumberAssigner gesetzt, stornierte Anmeldungen behalten sie.
bib_labelstringAngezeigte Startnummer inkl. Praefix, z. B. W0123. Pro Event eindeutig.
bib_number_assigned_atstring (date-time)Time the bib number was assigned.
chip_codestringTransponder- oder QR-Kennung fuer die Zeitmessung. Pro Event eindeutig.
timing_tracking_consentbooleanEinwilligung in das GPS-Live-Tracking waehrend des Events.
createdstring (date-time)Point in time the entity was created.
updatedstring (date-time)Point in time the entity was last updated.
addressstringAddress as text.
address_streetstringStreet of the address.
address_house_numberstringHouse number of the address.
address_street_levelstringStreet and house number of the address.
address_costringCare-of line of the address.
address_citystringCity of the address.
address_zipstringPostal code of the address.
address_admin_level1stringFirst administrative level of the address, e.g. the federal state.
address_countrystringCountry code of the address.
address_full_countrystringFull name of the country of the address.
address_geo_latstringLatitude of the address.
address_geo_lngstringLongitude of the address.
address_external_provider_idstringfield to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
namestringName of the entity.
main_phonestringMain phone number.
main_faxstringMain fax number.
main_emailstringMain e-mail address.
websitestringWebsite address.
deletedbooleanThis property is used to mark an entity as deleted / archived
orderintegerPosition of the entity in the order.
curl --request DELETE \
--url https://your-instance.iw-erp.de/api/event/customer/base_event_signup/event/42 \
--header 'x-iw-jwt-token: <TOKEN>'const options = {method: 'DELETE', headers: {'x-iw-jwt-token': '<TOKEN>'}};
fetch('https://your-instance.iw-erp.de/api/event/customer/base_event_signup/event/42', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://your-instance.iw-erp.de/api/event/customer/base_event_signup/event/42"
headers = {"x-iw-jwt-token": "<TOKEN>"}
response = requests.delete(url, headers=headers)
print(response.text)<?php
require_once('vendor/autoload.php');
$client = new \GuzzleHttp\Client();
$response = $client->request('DELETE', 'https://your-instance.iw-erp.de/api/event/customer/base_event_signup/event/42', [
'headers' => [
'x-iw-jwt-token' => '<TOKEN>',
],
]);
echo $response->getBody();using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Delete,
RequestUri = new Uri("https://your-instance.iw-erp.de/api/event/customer/base_event_signup/event/42"),
Headers =
{
{ "x-iw-jwt-token", "<TOKEN>" },
},
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://your-instance.iw-erp.de/api/event/customer/base_event_signup/event/42")
.delete(null)
.addHeader("x-iw-jwt-token", "<TOKEN>")
.build();
Response response = client.newCall(request).execute();package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://your-instance.iw-erp.de/api/event/customer/base_event_signup/event/42"
req, _ := http.NewRequest("DELETE", url, nil)
req.Header.Add("x-iw-jwt-token", "<TOKEN>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}Dart with the iw_erp_api package
import 'package:iw_erp_api/clients/event_base_event_sign_up_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';
IwApiState().host = 'your-instance.iw-erp.de';
IwApiState().currentJwtApiToken = '<TOKEN>';
final result = await EventBaseEventSignUpController.deleteCustomerForEvent('42');
if (result.success) {
print(result.data);
}{
"id": 42,
"address_street": "Jakobistr. 39",
"address_city": "Hannover",
"address_zip": "30163",
"address_country": "DE",
"address_full_country": "DE",
"name": "Beispiel",
"main_phone": "+49 511 123456",
"main_email": "lena.hartmann@example.org",
"bib_range_id": 42
}This method will delete a single BaseEventSignUp for the person in a booking
DELETE/api/event/customer/base_event_signup/booking/{bookingIdentifier}
Path parameters
bookingIdentifierrequiredstring |
Responses
200Delete a single BaseEventSignUp for the person in a bookingBaseEventSignUp10
Show fields (54)
bib_range_idintegerage_classstringAltersklasse nach DLV, z. B. M40 - berechnet aus Geburtstag, Geschlecht und Eventdatum.
idintegerPrimary key of the sign-up. Internal ID.
genderstringGender of the participant.
tokenstringPublic token of the sign-up. Used in links instead of the ID.
moments_tokenstringParticipant-bound moments token: allows this participant to use the event moments (digital guestbook) page; uploads via this token are linked to the participant.
waitingbooleanThe sign-up is on the waiting list.
confirmedbooleanThe sign-up is confirmed.
externalbooleanThe sign-up was made by an external party.
deletion_reasonstringReason the sign-up was cancelled.
billedbooleanThe sign-up was billed.
direct_billingbooleandirect_billing_check_datestring (date-time)direct_billing_tokenstringwait_list_confirmation_tokenstringwait_list_confirmation_sent_atstring (date-time)wait_list_confirmation_deadlinestring (date-time)wait_list_confirmed_atstring (date-time)wait_list_pending_confirmationbooleanwait_list_sort_orderintegerbirthdaystring (date-time)Birthday of the participant.
trialbooleanTrial date sign-up (Schnuppern): a date sign-up without a course place that uses up one unit of the person's trial pass (eventAccessBudget with sourceType trial)
trial_channelstringWho booked the trial date: app, trainer, office
trial_session_numberintegerNumber of this trial date within the pass (1 = first), for "Schnuppern 2/3"
trial_session_maxintegerTrial dates of the pass, for "Schnuppern 2/3"
nace_sectionstringNACE section code (letter A-U)
nace_codestringNACE code (numeric like 01.11, 62.01)
bib_numberintegerStartnummer (Zaehler). Bei PER_PREFIX nur zusammen mit dem Praefix eindeutig. Wird nur ueber BibNumberAssigner gesetzt, stornierte Anmeldungen behalten sie.
bib_labelstringAngezeigte Startnummer inkl. Praefix, z. B. W0123. Pro Event eindeutig.
bib_number_assigned_atstring (date-time)Time the bib number was assigned.
chip_codestringTransponder- oder QR-Kennung fuer die Zeitmessung. Pro Event eindeutig.
timing_tracking_consentbooleanEinwilligung in das GPS-Live-Tracking waehrend des Events.
createdstring (date-time)Point in time the entity was created.
updatedstring (date-time)Point in time the entity was last updated.
addressstringAddress as text.
address_streetstringStreet of the address.
address_house_numberstringHouse number of the address.
address_street_levelstringStreet and house number of the address.
address_costringCare-of line of the address.
address_citystringCity of the address.
address_zipstringPostal code of the address.
address_admin_level1stringFirst administrative level of the address, e.g. the federal state.
address_countrystringCountry code of the address.
address_full_countrystringFull name of the country of the address.
address_geo_latstringLatitude of the address.
address_geo_lngstringLongitude of the address.
address_external_provider_idstringfield to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
namestringName of the entity.
main_phonestringMain phone number.
main_faxstringMain fax number.
main_emailstringMain e-mail address.
websitestringWebsite address.
deletedbooleanThis property is used to mark an entity as deleted / archived
orderintegerPosition of the entity in the order.
curl --request DELETE \
--url https://your-instance.iw-erp.de/api/event/customer/base_event_signup/booking/42 \
--header 'x-iw-jwt-token: <TOKEN>'const options = {method: 'DELETE', headers: {'x-iw-jwt-token': '<TOKEN>'}};
fetch('https://your-instance.iw-erp.de/api/event/customer/base_event_signup/booking/42', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://your-instance.iw-erp.de/api/event/customer/base_event_signup/booking/42"
headers = {"x-iw-jwt-token": "<TOKEN>"}
response = requests.delete(url, headers=headers)
print(response.text)<?php
require_once('vendor/autoload.php');
$client = new \GuzzleHttp\Client();
$response = $client->request('DELETE', 'https://your-instance.iw-erp.de/api/event/customer/base_event_signup/booking/42', [
'headers' => [
'x-iw-jwt-token' => '<TOKEN>',
],
]);
echo $response->getBody();using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Delete,
RequestUri = new Uri("https://your-instance.iw-erp.de/api/event/customer/base_event_signup/booking/42"),
Headers =
{
{ "x-iw-jwt-token", "<TOKEN>" },
},
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://your-instance.iw-erp.de/api/event/customer/base_event_signup/booking/42")
.delete(null)
.addHeader("x-iw-jwt-token", "<TOKEN>")
.build();
Response response = client.newCall(request).execute();package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://your-instance.iw-erp.de/api/event/customer/base_event_signup/booking/42"
req, _ := http.NewRequest("DELETE", url, nil)
req.Header.Add("x-iw-jwt-token", "<TOKEN>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}Dart with the iw_erp_api package
import 'package:iw_erp_api/clients/event_base_event_sign_up_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';
IwApiState().host = 'your-instance.iw-erp.de';
IwApiState().currentJwtApiToken = '<TOKEN>';
final result = await EventBaseEventSignUpController.deleteCustomerForBooking('42');
if (result.success) {
print(result.data);
}{
"id": 42,
"address_street": "Jakobistr. 39",
"address_city": "Hannover",
"address_zip": "30163",
"address_country": "DE",
"address_full_country": "DE",
"name": "Beispiel",
"main_phone": "+49 511 123456",
"main_email": "lena.hartmann@example.org",
"bib_range_id": 42
}Add a new BaseEventSignUp for event or booking as a guest
POST/api/event/public/base_event_signup
Request body application/json
dataBaseEventSignUp4Show fields (56)
first_namestringFirst name of the participant.
last_namestringLast name of the participant.
genderstringGender of the participant.
deletion_reasonstringReason the sign-up was cancelled.
direct_billingbooleandirect_billing_check_datestring (date-time)direct_billing_tokenstringbirthdaystring (date-time)Birthday of the participant.
known_allergiesstringKnown allergies of the participant.
confirmed_no_allergiesbooleanGuardian confirmed that there are no known allergies.
allow_photosbooleanGuardian allows photos of the participant.
allow_child_alonebooleanParticipant may leave alone after the event.
authorized_pickupstringPersons who are allowed to pick up the participant.
needs_supportbooleanParticipant needs support, for example for inclusion.
support_descriptionstringDescription of the support the participant needs.
financial_supportbooleanParticipant receives financial support.
financial_support_numberstringNumber of the financial support, for example a voucher.
municipal_supportbooleanParticipant receives municipal support.
municipal_support_numberstringNumber of the municipal support.
grade_levelintegerSchool grade level of the participant.
school_classstringSchool class of the participant.
confirmed_disclaimerbooleanParticipant confirmed the disclaimer.
confirmed_privacybooleanParticipant confirmed the privacy policy.
confirmed_cancellation_policybooleanParticipant confirmed the cancellation policy.
free_note_onestringFree note 1 entered on the sign-up.
free_note_twostringFree note 2 entered on the sign-up.
free_note_threestringFree note 3 entered on the sign-up.
free_note_fourstringFree note 4 entered on the sign-up.
invoice_productsarray<BaseEventSignUpProductItem2>Product items added to the invoice of the sign-up.
self_check_inbooleanParticipant checked in with the self-service check-in.
self_check_outbooleanParticipant checked out with the self-service check-out.
nace_sectionstringNACE section code (letter A-U)
nace_codestringNACE code (numeric like 01.11, 62.01)
addressstringAddress as text.
address_streetstringStreet of the address.
address_house_numberstringHouse number of the address.
address_street_levelstringStreet and house number of the address.
address_costringCare-of line of the address.
address_citystringCity of the address.
address_zipstringPostal code of the address.
address_admin_level1stringFirst administrative level of the address, e.g. the federal state.
address_external_provider_idstringfield to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
namestringName of the entity.
main_phonestringMain phone number.
main_faxstringMain fax number.
main_emailstringMain e-mail address.
websitestringWebsite address.
base_eventBaseEvent22Event the entity belongs to.
payment_ownerstringAccount owner of the direct debit.
payment_institutionstringName of the bank of the direct debit.
payment_bicstringBIC of the bank account.
payment_ibanstringIBAN of the bank account.
payment_mandatestringReference of the SEPA mandate.
payment_mandate_sign_datestring (date-time)Date the SEPA mandate was signed.
payment_mandate_valid_until_datestring (date-time)Date until which the SEPA mandate is valid.
base_bookingBaseBooking22Booking the entity belongs to.
Responses
200Add a new BaseEventSignUp for event or booking as a guestBaseEventSignUp
Show fields (42)
idintegerPrimary key of the sign-up. Internal ID.
first_namestringFirst name of the participant.
last_namestringLast name of the participant.
genderstringGender of the participant.
waitingbooleanThe sign-up is on the waiting list.
confirmedbooleanThe sign-up is confirmed.
deletion_reasonstringReason the sign-up was cancelled.
direct_billingbooleandirect_billing_check_datestring (date-time)direct_billing_tokenstringwait_list_confirmation_sent_atstring (date-time)wait_list_confirmation_deadlinestring (date-time)wait_list_confirmed_atstring (date-time)wait_list_pending_confirmationbooleanwait_list_sort_orderintegerbirthdaystring (date-time)Birthday of the participant.
known_allergiesstringKnown allergies of the participant.
confirmed_no_allergiesbooleanGuardian confirmed that there are no known allergies.
allow_photosbooleanGuardian allows photos of the participant.
allow_child_alonebooleanParticipant may leave alone after the event.
authorized_pickupstringPersons who are allowed to pick up the participant.
needs_supportbooleanParticipant needs support, for example for inclusion.
support_descriptionstringDescription of the support the participant needs.
financial_supportbooleanParticipant receives financial support.
financial_support_numberstringNumber of the financial support, for example a voucher.
municipal_supportbooleanParticipant receives municipal support.
municipal_support_numberstringNumber of the municipal support.
grade_levelintegerSchool grade level of the participant.
school_classstringSchool class of the participant.
self_check_inbooleanParticipant checked in with the self-service check-in.
self_check_outbooleanParticipant checked out with the self-service check-out.
self_check_in_datestring (date-time)Time of the self-service check-in.
self_check_out_datestring (date-time)Time of the self-service check-out.
reminded_of_absencestring (date-time)Time the guardian was reminded of an absence.
trialbooleanTrial date sign-up (Schnuppern): a date sign-up without a course place that uses up one unit of the person's trial pass (eventAccessBudget with sourceType trial)
trial_channelstringWho booked the trial date: app, trainer, office
trial_session_numberintegerNumber of this trial date within the pass (1 = first), for "Schnuppern 2/3"
trial_session_maxintegerTrial dates of the pass, for "Schnuppern 2/3"
confirmed_datestring (date-time)Time the sign-up was confirmed.
bib_numberintegerStartnummer (Zaehler). Bei PER_PREFIX nur zusammen mit dem Praefix eindeutig. Wird nur ueber BibNumberAssigner gesetzt, stornierte Anmeldungen behalten sie.
bib_labelstringAngezeigte Startnummer inkl. Praefix, z. B. W0123. Pro Event eindeutig.
namestringName of the entity.
curl --request POST \
--url https://your-instance.iw-erp.de/api/event/public/base_event_signup \
--header 'content-type: application/json' \
--header 'x-iw-jwt-token: <TOKEN>' \
--data '
{
"data": {
"first_name": "Lena",
"last_name": "Hartmann",
"support_description": "Text",
"address_street": "Jakobistr. 39",
"address_city": "Hannover",
"address_zip": "30163"
}
}
'const options = {
method: 'POST',
headers: {'x-iw-jwt-token': '<TOKEN>', 'content-type': 'application/json'},
body: JSON.stringify({
data: {
first_name: 'Lena',
last_name: 'Hartmann',
support_description: 'Text',
address_street: 'Jakobistr. 39',
address_city: 'Hannover',
address_zip: '30163'
}
})
};
fetch('https://your-instance.iw-erp.de/api/event/public/base_event_signup', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://your-instance.iw-erp.de/api/event/public/base_event_signup"
payload = { "data": {
"first_name": "Lena",
"last_name": "Hartmann",
"support_description": "Text",
"address_street": "Jakobistr. 39",
"address_city": "Hannover",
"address_zip": "30163"
} }
headers = {
"x-iw-jwt-token": "<TOKEN>",
"content-type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)<?php
require_once('vendor/autoload.php');
$client = new \GuzzleHttp\Client();
$response = $client->request('POST', 'https://your-instance.iw-erp.de/api/event/public/base_event_signup', [
'body' => '{"data":{"first_name":"Lena","last_name":"Hartmann","support_description":"Text","address_street":"Jakobistr. 39","address_city":"Hannover","address_zip":"30163"}}',
'headers' => [
'content-type' => 'application/json',
'x-iw-jwt-token' => '<TOKEN>',
],
]);
echo $response->getBody();using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("https://your-instance.iw-erp.de/api/event/public/base_event_signup"),
Headers =
{
{ "x-iw-jwt-token", "<TOKEN>" },
},
Content = new StringContent("{\"data\":{\"first_name\":\"Lena\",\"last_name\":\"Hartmann\",\"support_description\":\"Text\",\"address_street\":\"Jakobistr. 39\",\"address_city\":\"Hannover\",\"address_zip\":\"30163\"}}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"data\":{\"first_name\":\"Lena\",\"last_name\":\"Hartmann\",\"support_description\":\"Text\",\"address_street\":\"Jakobistr. 39\",\"address_city\":\"Hannover\",\"address_zip\":\"30163\"}}");
Request request = new Request.Builder()
.url("https://your-instance.iw-erp.de/api/event/public/base_event_signup")
.post(body)
.addHeader("x-iw-jwt-token", "<TOKEN>")
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://your-instance.iw-erp.de/api/event/public/base_event_signup"
payload := strings.NewReader("{\"data\":{\"first_name\":\"Lena\",\"last_name\":\"Hartmann\",\"support_description\":\"Text\",\"address_street\":\"Jakobistr. 39\",\"address_city\":\"Hannover\",\"address_zip\":\"30163\"}}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-iw-jwt-token", "<TOKEN>")
req.Header.Add("content-type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}Dart with the iw_erp_api package
import 'package:iw_erp_api/clients/event_base_event_sign_up_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';
import 'package:iw_erp_api/model/event_base_event_sign_up.dart';
IwApiState().host = 'your-instance.iw-erp.de';
IwApiState().currentJwtApiToken = '<TOKEN>';
final result = await EventBaseEventSignUpController.postPublic(EventBaseEventSignUp.fromJson({
"first_name": "Lena",
"last_name": "Hartmann",
"support_description": "Text",
"address_street": "Jakobistr. 39",
"address_city": "Hannover",
"address_zip": "30163"
}));
if (result.success) {
print(result.data);
}{
"id": 42,
"first_name": "Lena",
"last_name": "Hartmann",
"support_description": "Text",
"name": "Beispiel",
"gender": "string",
"waiting": true,
"confirmed": true,
"deletion_reason": "string",
"direct_billing": true
}Test adding a new BaseEventSignUp as customer / public
POST/api/event/public/test_base_event_signup
Request body application/json
dataBaseEventSignUp3Show fields (39)
first_namestringFirst name of the participant.
last_namestringLast name of the participant.
genderstringGender of the participant.
deletion_reasonstringReason the sign-up was cancelled.
direct_billingbooleandirect_billing_check_datestring (date-time)direct_billing_tokenstringbirthdaystring (date-time)Birthday of the participant.
known_allergiesstringKnown allergies of the participant.
confirmed_no_allergiesbooleanGuardian confirmed that there are no known allergies.
allow_photosbooleanGuardian allows photos of the participant.
allow_child_alonebooleanParticipant may leave alone after the event.
authorized_pickupstringPersons who are allowed to pick up the participant.
needs_supportbooleanParticipant needs support, for example for inclusion.
support_descriptionstringDescription of the support the participant needs.
financial_supportbooleanParticipant receives financial support.
financial_support_numberstringNumber of the financial support, for example a voucher.
municipal_supportbooleanParticipant receives municipal support.
municipal_support_numberstringNumber of the municipal support.
grade_levelintegerSchool grade level of the participant.
school_classstringSchool class of the participant.
confirmed_disclaimerbooleanParticipant confirmed the disclaimer.
confirmed_privacybooleanParticipant confirmed the privacy policy.
confirmed_cancellation_policybooleanParticipant confirmed the cancellation policy.
free_note_onestringFree note 1 entered on the sign-up.
free_note_twostringFree note 2 entered on the sign-up.
free_note_threestringFree note 3 entered on the sign-up.
free_note_fourstringFree note 4 entered on the sign-up.
invoice_productsarray<BaseEventSignUpProductItem>Product items added to the invoice of the sign-up.
self_check_inbooleanParticipant checked in with the self-service check-in.
self_check_outbooleanParticipant checked out with the self-service check-out.
nace_sectionstringNACE section code (letter A-U)
nace_codestringNACE code (numeric like 01.11, 62.01)
main_phonestringMain phone number.
main_faxstringMain fax number.
main_emailstringMain e-mail address.
websitestringWebsite address.
base_eventBaseEvent21Event the entity belongs to.
base_bookingBaseBooking21Booking the entity belongs to.
Responses
200Test adding a new BaseEventSignUp as customer / publicBaseEventSignUpTest
Show fields (19)
signup_allowedbooleansignup_waitlist_allowedbooleansignup_delete_allowedbooleansignup_after_upgrade_allowedbooleansignup_explicitly_disabledbooleansignup_require_add_bank_accountbooleansignup_requires_loginbooleansignup_invoice_address_requiredbooleansignup_free_capacitynumbersignup_max_capacitynumbersignup_fully_bookedbooleanOnly for an event with hidden people limit (globally or per event) and the opt-in setting `event_booking_show_fully_booked_if_people_limit_hidden`: no free place is left. The numbers themselves are never sent for such an event.
signup_min_participants_reachedbooleansignup_group_availablebooleanOnly with the query param `groupSize`: the event (or booking) has a free place for every person of a group of that size. Groups are never put onto the wait list. Always false while group sign-ups are switched off (`event_sign_up_group_enabled`).
signup_require_add_access_tagbooleanview_participants_allowedbooleanview_participant_grid_allowedbooleancan_track_timebooleansignup_via_budgetbooleanbudget_remainingnumber
curl --request POST \
--url https://your-instance.iw-erp.de/api/event/public/test_base_event_signup \
--header 'content-type: application/json' \
--header 'x-iw-jwt-token: <TOKEN>' \
--data '
{
"data": {
"first_name": "Lena",
"last_name": "Hartmann",
"support_description": "Text",
"main_phone": "+49 511 123456",
"main_email": "lena.hartmann@example.org",
"gender": "string"
}
}
'const options = {
method: 'POST',
headers: {'x-iw-jwt-token': '<TOKEN>', 'content-type': 'application/json'},
body: JSON.stringify({
data: {
first_name: 'Lena',
last_name: 'Hartmann',
support_description: 'Text',
main_phone: '+49 511 123456',
main_email: 'lena.hartmann@example.org',
gender: 'string'
}
})
};
fetch('https://your-instance.iw-erp.de/api/event/public/test_base_event_signup', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://your-instance.iw-erp.de/api/event/public/test_base_event_signup"
payload = { "data": {
"first_name": "Lena",
"last_name": "Hartmann",
"support_description": "Text",
"main_phone": "+49 511 123456",
"main_email": "lena.hartmann@example.org",
"gender": "string"
} }
headers = {
"x-iw-jwt-token": "<TOKEN>",
"content-type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)<?php
require_once('vendor/autoload.php');
$client = new \GuzzleHttp\Client();
$response = $client->request('POST', 'https://your-instance.iw-erp.de/api/event/public/test_base_event_signup', [
'body' => '{"data":{"first_name":"Lena","last_name":"Hartmann","support_description":"Text","main_phone":"+49 511 123456","main_email":"lena.hartmann@example.org","gender":"string"}}',
'headers' => [
'content-type' => 'application/json',
'x-iw-jwt-token' => '<TOKEN>',
],
]);
echo $response->getBody();using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("https://your-instance.iw-erp.de/api/event/public/test_base_event_signup"),
Headers =
{
{ "x-iw-jwt-token", "<TOKEN>" },
},
Content = new StringContent("{\"data\":{\"first_name\":\"Lena\",\"last_name\":\"Hartmann\",\"support_description\":\"Text\",\"main_phone\":\"+49 511 123456\",\"main_email\":\"lena.hartmann@example.org\",\"gender\":\"string\"}}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"data\":{\"first_name\":\"Lena\",\"last_name\":\"Hartmann\",\"support_description\":\"Text\",\"main_phone\":\"+49 511 123456\",\"main_email\":\"lena.hartmann@example.org\",\"gender\":\"string\"}}");
Request request = new Request.Builder()
.url("https://your-instance.iw-erp.de/api/event/public/test_base_event_signup")
.post(body)
.addHeader("x-iw-jwt-token", "<TOKEN>")
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://your-instance.iw-erp.de/api/event/public/test_base_event_signup"
payload := strings.NewReader("{\"data\":{\"first_name\":\"Lena\",\"last_name\":\"Hartmann\",\"support_description\":\"Text\",\"main_phone\":\"+49 511 123456\",\"main_email\":\"lena.hartmann@example.org\",\"gender\":\"string\"}}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-iw-jwt-token", "<TOKEN>")
req.Header.Add("content-type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}Dart with the iw_erp_api package
import 'package:iw_erp_api/clients/event_base_event_sign_up_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';
import 'package:iw_erp_api/model/event_base_event_sign_up.dart';
IwApiState().host = 'your-instance.iw-erp.de';
IwApiState().currentJwtApiToken = '<TOKEN>';
final result = await EventBaseEventSignUpController.postTest(EventBaseEventSignUp.fromJson({
"first_name": "Lena",
"last_name": "Hartmann",
"support_description": "Text",
"main_phone": "+49 511 123456",
"main_email": "lena.hartmann@example.org",
"gender": "string"
}));
if (result.success) {
print(result.data);
}{
"signup_allowed": true,
"signup_waitlist_allowed": true,
"signup_delete_allowed": true,
"signup_after_upgrade_allowed": true,
"signup_explicitly_disabled": true,
"signup_require_add_bank_account": true,
"signup_requires_login": true,
"signup_invoice_address_required": true,
"signup_free_capacity": 1.5,
"signup_max_capacity": 1.5
}Test adding a new BaseEventSignUp for the person from the admin ui
POST/api/event/admin/test_base_event_signup
Request body application/json
dataBaseEventSignUp3Show fields (39)
first_namestringFirst name of the participant.
last_namestringLast name of the participant.
genderstringGender of the participant.
deletion_reasonstringReason the sign-up was cancelled.
direct_billingbooleandirect_billing_check_datestring (date-time)direct_billing_tokenstringbirthdaystring (date-time)Birthday of the participant.
known_allergiesstringKnown allergies of the participant.
confirmed_no_allergiesbooleanGuardian confirmed that there are no known allergies.
allow_photosbooleanGuardian allows photos of the participant.
allow_child_alonebooleanParticipant may leave alone after the event.
authorized_pickupstringPersons who are allowed to pick up the participant.
needs_supportbooleanParticipant needs support, for example for inclusion.
support_descriptionstringDescription of the support the participant needs.
financial_supportbooleanParticipant receives financial support.
financial_support_numberstringNumber of the financial support, for example a voucher.
municipal_supportbooleanParticipant receives municipal support.
municipal_support_numberstringNumber of the municipal support.
grade_levelintegerSchool grade level of the participant.
school_classstringSchool class of the participant.
confirmed_disclaimerbooleanParticipant confirmed the disclaimer.
confirmed_privacybooleanParticipant confirmed the privacy policy.
confirmed_cancellation_policybooleanParticipant confirmed the cancellation policy.
free_note_onestringFree note 1 entered on the sign-up.
free_note_twostringFree note 2 entered on the sign-up.
free_note_threestringFree note 3 entered on the sign-up.
free_note_fourstringFree note 4 entered on the sign-up.
invoice_productsarray<BaseEventSignUpProductItem>Product items added to the invoice of the sign-up.
self_check_inbooleanParticipant checked in with the self-service check-in.
self_check_outbooleanParticipant checked out with the self-service check-out.
nace_sectionstringNACE section code (letter A-U)
nace_codestringNACE code (numeric like 01.11, 62.01)
main_phonestringMain phone number.
main_faxstringMain fax number.
main_emailstringMain e-mail address.
websitestringWebsite address.
base_eventBaseEvent21Event the entity belongs to.
base_bookingBaseBooking21Booking the entity belongs to.
Responses
200Test adding a new BaseEventSignUp for the person from the admin uiSuccess
Show fields (3)
successbooleanmessagestringerror_codesarray<integer>
curl --request POST \
--url https://your-instance.iw-erp.de/api/event/admin/test_base_event_signup \
--header 'content-type: application/json' \
--header 'x-iw-jwt-token: <TOKEN>' \
--data '
{
"data": {
"first_name": "Lena",
"last_name": "Hartmann",
"support_description": "Text",
"main_phone": "+49 511 123456",
"main_email": "lena.hartmann@example.org",
"gender": "string"
}
}
'const options = {
method: 'POST',
headers: {'x-iw-jwt-token': '<TOKEN>', 'content-type': 'application/json'},
body: JSON.stringify({
data: {
first_name: 'Lena',
last_name: 'Hartmann',
support_description: 'Text',
main_phone: '+49 511 123456',
main_email: 'lena.hartmann@example.org',
gender: 'string'
}
})
};
fetch('https://your-instance.iw-erp.de/api/event/admin/test_base_event_signup', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://your-instance.iw-erp.de/api/event/admin/test_base_event_signup"
payload = { "data": {
"first_name": "Lena",
"last_name": "Hartmann",
"support_description": "Text",
"main_phone": "+49 511 123456",
"main_email": "lena.hartmann@example.org",
"gender": "string"
} }
headers = {
"x-iw-jwt-token": "<TOKEN>",
"content-type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)<?php
require_once('vendor/autoload.php');
$client = new \GuzzleHttp\Client();
$response = $client->request('POST', 'https://your-instance.iw-erp.de/api/event/admin/test_base_event_signup', [
'body' => '{"data":{"first_name":"Lena","last_name":"Hartmann","support_description":"Text","main_phone":"+49 511 123456","main_email":"lena.hartmann@example.org","gender":"string"}}',
'headers' => [
'content-type' => 'application/json',
'x-iw-jwt-token' => '<TOKEN>',
],
]);
echo $response->getBody();using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("https://your-instance.iw-erp.de/api/event/admin/test_base_event_signup"),
Headers =
{
{ "x-iw-jwt-token", "<TOKEN>" },
},
Content = new StringContent("{\"data\":{\"first_name\":\"Lena\",\"last_name\":\"Hartmann\",\"support_description\":\"Text\",\"main_phone\":\"+49 511 123456\",\"main_email\":\"lena.hartmann@example.org\",\"gender\":\"string\"}}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"data\":{\"first_name\":\"Lena\",\"last_name\":\"Hartmann\",\"support_description\":\"Text\",\"main_phone\":\"+49 511 123456\",\"main_email\":\"lena.hartmann@example.org\",\"gender\":\"string\"}}");
Request request = new Request.Builder()
.url("https://your-instance.iw-erp.de/api/event/admin/test_base_event_signup")
.post(body)
.addHeader("x-iw-jwt-token", "<TOKEN>")
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://your-instance.iw-erp.de/api/event/admin/test_base_event_signup"
payload := strings.NewReader("{\"data\":{\"first_name\":\"Lena\",\"last_name\":\"Hartmann\",\"support_description\":\"Text\",\"main_phone\":\"+49 511 123456\",\"main_email\":\"lena.hartmann@example.org\",\"gender\":\"string\"}}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-iw-jwt-token", "<TOKEN>")
req.Header.Add("content-type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}Dart with the iw_erp_api package
import 'package:iw_erp_api/clients/event_base_event_sign_up_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';
import 'package:iw_erp_api/model/event_base_event_sign_up.dart';
IwApiState().host = 'your-instance.iw-erp.de';
IwApiState().currentJwtApiToken = '<TOKEN>';
final result = await EventBaseEventSignUpController.postAdminTest(EventBaseEventSignUp.fromJson({
"first_name": "Lena",
"last_name": "Hartmann",
"support_description": "Text",
"main_phone": "+49 511 123456",
"main_email": "lena.hartmann@example.org",
"gender": "string"
}));
if (result.success) {
print(result.data);
}{
"success": true,
"message": "string",
"error_codes": [
1
]
}Rebook a BaseEventSignUp from one event to another.
POST/api/event/base_event_signup/{identifier}/rebook
This will archive the original signup and create a new one in the target event with the same participant data.
Path parameters
identifierrequiredstring |
Responses
200Rebook a BaseEventSignUp from one event to anotherBaseEventSignUp10
Show fields (54)
bib_range_idintegerage_classstringAltersklasse nach DLV, z. B. M40 - berechnet aus Geburtstag, Geschlecht und Eventdatum.
idintegerPrimary key of the sign-up. Internal ID.
genderstringGender of the participant.
tokenstringPublic token of the sign-up. Used in links instead of the ID.
moments_tokenstringParticipant-bound moments token: allows this participant to use the event moments (digital guestbook) page; uploads via this token are linked to the participant.
waitingbooleanThe sign-up is on the waiting list.
confirmedbooleanThe sign-up is confirmed.
externalbooleanThe sign-up was made by an external party.
deletion_reasonstringReason the sign-up was cancelled.
billedbooleanThe sign-up was billed.
direct_billingbooleandirect_billing_check_datestring (date-time)direct_billing_tokenstringwait_list_confirmation_tokenstringwait_list_confirmation_sent_atstring (date-time)wait_list_confirmation_deadlinestring (date-time)wait_list_confirmed_atstring (date-time)wait_list_pending_confirmationbooleanwait_list_sort_orderintegerbirthdaystring (date-time)Birthday of the participant.
trialbooleanTrial date sign-up (Schnuppern): a date sign-up without a course place that uses up one unit of the person's trial pass (eventAccessBudget with sourceType trial)
trial_channelstringWho booked the trial date: app, trainer, office
trial_session_numberintegerNumber of this trial date within the pass (1 = first), for "Schnuppern 2/3"
trial_session_maxintegerTrial dates of the pass, for "Schnuppern 2/3"
nace_sectionstringNACE section code (letter A-U)
nace_codestringNACE code (numeric like 01.11, 62.01)
bib_numberintegerStartnummer (Zaehler). Bei PER_PREFIX nur zusammen mit dem Praefix eindeutig. Wird nur ueber BibNumberAssigner gesetzt, stornierte Anmeldungen behalten sie.
bib_labelstringAngezeigte Startnummer inkl. Praefix, z. B. W0123. Pro Event eindeutig.
bib_number_assigned_atstring (date-time)Time the bib number was assigned.
chip_codestringTransponder- oder QR-Kennung fuer die Zeitmessung. Pro Event eindeutig.
timing_tracking_consentbooleanEinwilligung in das GPS-Live-Tracking waehrend des Events.
createdstring (date-time)Point in time the entity was created.
updatedstring (date-time)Point in time the entity was last updated.
addressstringAddress as text.
address_streetstringStreet of the address.
address_house_numberstringHouse number of the address.
address_street_levelstringStreet and house number of the address.
address_costringCare-of line of the address.
address_citystringCity of the address.
address_zipstringPostal code of the address.
address_admin_level1stringFirst administrative level of the address, e.g. the federal state.
address_countrystringCountry code of the address.
address_full_countrystringFull name of the country of the address.
address_geo_latstringLatitude of the address.
address_geo_lngstringLongitude of the address.
address_external_provider_idstringfield to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
namestringName of the entity.
main_phonestringMain phone number.
main_faxstringMain fax number.
main_emailstringMain e-mail address.
websitestringWebsite address.
deletedbooleanThis property is used to mark an entity as deleted / archived
orderintegerPosition of the entity in the order.
curl --request POST \
--url https://your-instance.iw-erp.de/api/event/base_event_signup/42/rebook \
--header 'x-iw-jwt-token: <TOKEN>'const options = {method: 'POST', headers: {'x-iw-jwt-token': '<TOKEN>'}};
fetch('https://your-instance.iw-erp.de/api/event/base_event_signup/42/rebook', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://your-instance.iw-erp.de/api/event/base_event_signup/42/rebook"
headers = {"x-iw-jwt-token": "<TOKEN>"}
response = requests.post(url, headers=headers)
print(response.text)<?php
require_once('vendor/autoload.php');
$client = new \GuzzleHttp\Client();
$response = $client->request('POST', 'https://your-instance.iw-erp.de/api/event/base_event_signup/42/rebook', [
'headers' => [
'x-iw-jwt-token' => '<TOKEN>',
],
]);
echo $response->getBody();using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("https://your-instance.iw-erp.de/api/event/base_event_signup/42/rebook"),
Headers =
{
{ "x-iw-jwt-token", "<TOKEN>" },
},
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://your-instance.iw-erp.de/api/event/base_event_signup/42/rebook")
.post(null)
.addHeader("x-iw-jwt-token", "<TOKEN>")
.build();
Response response = client.newCall(request).execute();package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://your-instance.iw-erp.de/api/event/base_event_signup/42/rebook"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("x-iw-jwt-token", "<TOKEN>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}Dart with the iw_erp_api package
import 'package:iw_erp_api/clients/event_base_event_sign_up_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';
IwApiState().host = 'your-instance.iw-erp.de';
IwApiState().currentJwtApiToken = '<TOKEN>';
final result = await EventBaseEventSignUpController.rebook('42', 42);
if (result.success) {
print(result.data);
}{
"id": 42,
"address_street": "Jakobistr. 39",
"address_city": "Hannover",
"address_zip": "30163",
"address_country": "DE",
"address_full_country": "DE",
"name": "Beispiel",
"main_phone": "+49 511 123456",
"main_email": "lena.hartmann@example.org",
"bib_range_id": 42
}Copy a BaseEventSignUp to another event/booking. The original signup is kept intact.
POST/api/event/base_event_signup/{identifier}/copy
Path parameters
identifierrequiredstring |
Responses
200Copy a BaseEventSignUp to another event/bookingBaseEventSignUp10
Show fields (54)
bib_range_idintegerage_classstringAltersklasse nach DLV, z. B. M40 - berechnet aus Geburtstag, Geschlecht und Eventdatum.
idintegerPrimary key of the sign-up. Internal ID.
genderstringGender of the participant.
tokenstringPublic token of the sign-up. Used in links instead of the ID.
moments_tokenstringParticipant-bound moments token: allows this participant to use the event moments (digital guestbook) page; uploads via this token are linked to the participant.
waitingbooleanThe sign-up is on the waiting list.
confirmedbooleanThe sign-up is confirmed.
externalbooleanThe sign-up was made by an external party.
deletion_reasonstringReason the sign-up was cancelled.
billedbooleanThe sign-up was billed.
direct_billingbooleandirect_billing_check_datestring (date-time)direct_billing_tokenstringwait_list_confirmation_tokenstringwait_list_confirmation_sent_atstring (date-time)wait_list_confirmation_deadlinestring (date-time)wait_list_confirmed_atstring (date-time)wait_list_pending_confirmationbooleanwait_list_sort_orderintegerbirthdaystring (date-time)Birthday of the participant.
trialbooleanTrial date sign-up (Schnuppern): a date sign-up without a course place that uses up one unit of the person's trial pass (eventAccessBudget with sourceType trial)
trial_channelstringWho booked the trial date: app, trainer, office
trial_session_numberintegerNumber of this trial date within the pass (1 = first), for "Schnuppern 2/3"
trial_session_maxintegerTrial dates of the pass, for "Schnuppern 2/3"
nace_sectionstringNACE section code (letter A-U)
nace_codestringNACE code (numeric like 01.11, 62.01)
bib_numberintegerStartnummer (Zaehler). Bei PER_PREFIX nur zusammen mit dem Praefix eindeutig. Wird nur ueber BibNumberAssigner gesetzt, stornierte Anmeldungen behalten sie.
bib_labelstringAngezeigte Startnummer inkl. Praefix, z. B. W0123. Pro Event eindeutig.
bib_number_assigned_atstring (date-time)Time the bib number was assigned.
chip_codestringTransponder- oder QR-Kennung fuer die Zeitmessung. Pro Event eindeutig.
timing_tracking_consentbooleanEinwilligung in das GPS-Live-Tracking waehrend des Events.
createdstring (date-time)Point in time the entity was created.
updatedstring (date-time)Point in time the entity was last updated.
addressstringAddress as text.
address_streetstringStreet of the address.
address_house_numberstringHouse number of the address.
address_street_levelstringStreet and house number of the address.
address_costringCare-of line of the address.
address_citystringCity of the address.
address_zipstringPostal code of the address.
address_admin_level1stringFirst administrative level of the address, e.g. the federal state.
address_countrystringCountry code of the address.
address_full_countrystringFull name of the country of the address.
address_geo_latstringLatitude of the address.
address_geo_lngstringLongitude of the address.
address_external_provider_idstringfield to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
namestringName of the entity.
main_phonestringMain phone number.
main_faxstringMain fax number.
main_emailstringMain e-mail address.
websitestringWebsite address.
deletedbooleanThis property is used to mark an entity as deleted / archived
orderintegerPosition of the entity in the order.
curl --request POST \
--url https://your-instance.iw-erp.de/api/event/base_event_signup/42/copy \
--header 'x-iw-jwt-token: <TOKEN>'const options = {method: 'POST', headers: {'x-iw-jwt-token': '<TOKEN>'}};
fetch('https://your-instance.iw-erp.de/api/event/base_event_signup/42/copy', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://your-instance.iw-erp.de/api/event/base_event_signup/42/copy"
headers = {"x-iw-jwt-token": "<TOKEN>"}
response = requests.post(url, headers=headers)
print(response.text)<?php
require_once('vendor/autoload.php');
$client = new \GuzzleHttp\Client();
$response = $client->request('POST', 'https://your-instance.iw-erp.de/api/event/base_event_signup/42/copy', [
'headers' => [
'x-iw-jwt-token' => '<TOKEN>',
],
]);
echo $response->getBody();using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("https://your-instance.iw-erp.de/api/event/base_event_signup/42/copy"),
Headers =
{
{ "x-iw-jwt-token", "<TOKEN>" },
},
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://your-instance.iw-erp.de/api/event/base_event_signup/42/copy")
.post(null)
.addHeader("x-iw-jwt-token", "<TOKEN>")
.build();
Response response = client.newCall(request).execute();package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://your-instance.iw-erp.de/api/event/base_event_signup/42/copy"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("x-iw-jwt-token", "<TOKEN>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}Dart with package:http (no controller in the iw_erp_api package)
import 'package:http/http.dart' as http;
final response = await http.post(
Uri.parse('https://your-instance.iw-erp.de/api/event/base_event_signup/42/copy'),
headers: {'x-iw-jwt-token': '<TOKEN>'},
);
print(response.body);{
"id": 42,
"address_street": "Jakobistr. 39",
"address_city": "Hannover",
"address_zip": "30163",
"address_country": "DE",
"address_full_country": "DE",
"name": "Beispiel",
"main_phone": "+49 511 123456",
"main_email": "lena.hartmann@example.org",
"bib_range_id": 42
}Copy all current main-event sign-ups of a BaseEvent into one or more of its bookings.
POST/api/event/base_event/{identifier}/copy_main_signups_to_bookings
Mirrors the behavior of BaseEventCopySignUpToBookingCommand, but runs on demand for user-selected bookings and does not touch the copied_to_booking_until markers used by the automatic generation.
Path parameters
identifierrequiredstring |
Responses
200Copy all main-event sign-ups into the given bookingsEventSignUpCopyToBookingsResult
Show fields (5)
copiedintegerskipped_existingintegerskipped_fullintegerskipped_otherintegerbookings_processedinteger
curl --request POST \
--url https://your-instance.iw-erp.de/api/event/base_event/42/copy_main_signups_to_bookings \
--header 'x-iw-jwt-token: <TOKEN>'const options = {method: 'POST', headers: {'x-iw-jwt-token': '<TOKEN>'}};
fetch('https://your-instance.iw-erp.de/api/event/base_event/42/copy_main_signups_to_bookings', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://your-instance.iw-erp.de/api/event/base_event/42/copy_main_signups_to_bookings"
headers = {"x-iw-jwt-token": "<TOKEN>"}
response = requests.post(url, headers=headers)
print(response.text)<?php
require_once('vendor/autoload.php');
$client = new \GuzzleHttp\Client();
$response = $client->request('POST', 'https://your-instance.iw-erp.de/api/event/base_event/42/copy_main_signups_to_bookings', [
'headers' => [
'x-iw-jwt-token' => '<TOKEN>',
],
]);
echo $response->getBody();using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("https://your-instance.iw-erp.de/api/event/base_event/42/copy_main_signups_to_bookings"),
Headers =
{
{ "x-iw-jwt-token", "<TOKEN>" },
},
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://your-instance.iw-erp.de/api/event/base_event/42/copy_main_signups_to_bookings")
.post(null)
.addHeader("x-iw-jwt-token", "<TOKEN>")
.build();
Response response = client.newCall(request).execute();package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://your-instance.iw-erp.de/api/event/base_event/42/copy_main_signups_to_bookings"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("x-iw-jwt-token", "<TOKEN>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}Dart with the iw_erp_api package
import 'package:iw_erp_api/clients/event_base_event_sign_up_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';
IwApiState().host = 'your-instance.iw-erp.de';
IwApiState().currentJwtApiToken = '<TOKEN>';
final result = await EventBaseEventSignUpController.copyMainSignUpsToBookings('42', [42]);
if (result.success) {
print(result.data);
}{
"copied": 1,
"skipped_existing": 1,
"skipped_full": 1,
"skipped_other": 1,
"bookings_processed": 1
}Confirm a waitlist promotion via token (public, no auth required)
POST/api/event/public/base_event_signup/wait_list_confirm/{token}
Path parameters
tokenrequiredstring |
Responses
default
curl --request POST \
--url https://your-instance.iw-erp.de/api/event/public/base_event_signup/wait_list_confirm/42 \
--header 'x-iw-jwt-token: <TOKEN>'const options = {method: 'POST', headers: {'x-iw-jwt-token': '<TOKEN>'}};
fetch('https://your-instance.iw-erp.de/api/event/public/base_event_signup/wait_list_confirm/42', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://your-instance.iw-erp.de/api/event/public/base_event_signup/wait_list_confirm/42"
headers = {"x-iw-jwt-token": "<TOKEN>"}
response = requests.post(url, headers=headers)
print(response.text)<?php
require_once('vendor/autoload.php');
$client = new \GuzzleHttp\Client();
$response = $client->request('POST', 'https://your-instance.iw-erp.de/api/event/public/base_event_signup/wait_list_confirm/42', [
'headers' => [
'x-iw-jwt-token' => '<TOKEN>',
],
]);
echo $response->getBody();using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("https://your-instance.iw-erp.de/api/event/public/base_event_signup/wait_list_confirm/42"),
Headers =
{
{ "x-iw-jwt-token", "<TOKEN>" },
},
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://your-instance.iw-erp.de/api/event/public/base_event_signup/wait_list_confirm/42")
.post(null)
.addHeader("x-iw-jwt-token", "<TOKEN>")
.build();
Response response = client.newCall(request).execute();package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://your-instance.iw-erp.de/api/event/public/base_event_signup/wait_list_confirm/42"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("x-iw-jwt-token", "<TOKEN>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}Dart with the iw_erp_api package
import 'package:iw_erp_api/clients/event_base_event_sign_up_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';
IwApiState().host = 'your-instance.iw-erp.de';
IwApiState().currentJwtApiToken = '<TOKEN>';
final result = await EventBaseEventSignUpController.waitListPublicConfirm('42');
if (result.success) {
print(result.data);
}Trigger the online payment for a sign up that has no invoice yet
POST/api/event/base_event_signup/{identifier}/request_payment
Writes the missing (proforma) invoice, mails the payment link to the registered person and starts the payment deadline. The same work the scheduled inwendo:billing:direct-billing-request-payment does, for one sign up and without waiting for the next run.
Path parameters
identifierrequiredstring |
Responses
200Returns the created invoice, the payment link and the deadline
curl --request POST \
--url https://your-instance.iw-erp.de/api/event/base_event_signup/42/request_payment \
--header 'x-iw-jwt-token: <TOKEN>'const options = {method: 'POST', headers: {'x-iw-jwt-token': '<TOKEN>'}};
fetch('https://your-instance.iw-erp.de/api/event/base_event_signup/42/request_payment', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://your-instance.iw-erp.de/api/event/base_event_signup/42/request_payment"
headers = {"x-iw-jwt-token": "<TOKEN>"}
response = requests.post(url, headers=headers)
print(response.text)<?php
require_once('vendor/autoload.php');
$client = new \GuzzleHttp\Client();
$response = $client->request('POST', 'https://your-instance.iw-erp.de/api/event/base_event_signup/42/request_payment', [
'headers' => [
'x-iw-jwt-token' => '<TOKEN>',
],
]);
echo $response->getBody();using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("https://your-instance.iw-erp.de/api/event/base_event_signup/42/request_payment"),
Headers =
{
{ "x-iw-jwt-token", "<TOKEN>" },
},
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://your-instance.iw-erp.de/api/event/base_event_signup/42/request_payment")
.post(null)
.addHeader("x-iw-jwt-token", "<TOKEN>")
.build();
Response response = client.newCall(request).execute();package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://your-instance.iw-erp.de/api/event/base_event_signup/42/request_payment"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("x-iw-jwt-token", "<TOKEN>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}Dart with package:http (no controller in the iw_erp_api package)
import 'package:http/http.dart' as http;
final response = await http.post(
Uri.parse('https://your-instance.iw-erp.de/api/event/base_event_signup/42/request_payment'),
headers: {'x-iw-jwt-token': '<TOKEN>'},
);
print(response.body);Admin: Confirm a waitlist promotion on behalf of a person
POST/api/event/base_event_signup/{identifier}/wait_list_confirm
Path parameters
identifierrequiredstring |
Responses
default
curl --request POST \
--url https://your-instance.iw-erp.de/api/event/base_event_signup/42/wait_list_confirm \
--header 'x-iw-jwt-token: <TOKEN>'const options = {method: 'POST', headers: {'x-iw-jwt-token': '<TOKEN>'}};
fetch('https://your-instance.iw-erp.de/api/event/base_event_signup/42/wait_list_confirm', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://your-instance.iw-erp.de/api/event/base_event_signup/42/wait_list_confirm"
headers = {"x-iw-jwt-token": "<TOKEN>"}
response = requests.post(url, headers=headers)
print(response.text)<?php
require_once('vendor/autoload.php');
$client = new \GuzzleHttp\Client();
$response = $client->request('POST', 'https://your-instance.iw-erp.de/api/event/base_event_signup/42/wait_list_confirm', [
'headers' => [
'x-iw-jwt-token' => '<TOKEN>',
],
]);
echo $response->getBody();using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("https://your-instance.iw-erp.de/api/event/base_event_signup/42/wait_list_confirm"),
Headers =
{
{ "x-iw-jwt-token", "<TOKEN>" },
},
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://your-instance.iw-erp.de/api/event/base_event_signup/42/wait_list_confirm")
.post(null)
.addHeader("x-iw-jwt-token", "<TOKEN>")
.build();
Response response = client.newCall(request).execute();package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://your-instance.iw-erp.de/api/event/base_event_signup/42/wait_list_confirm"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("x-iw-jwt-token", "<TOKEN>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}Dart with the iw_erp_api package
import 'package:iw_erp_api/clients/event_base_event_sign_up_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';
IwApiState().host = 'your-instance.iw-erp.de';
IwApiState().currentJwtApiToken = '<TOKEN>';
final result = await EventBaseEventSignUpController.waitListAdminConfirm('42');
if (result.success) {
print(result.data);
}Customer: confirm the own (or a household member's) wait list promotion
POST/api/event/customer/base_event_signup/{identifier}/wait_list_confirm
The logged-in counterpart of the public token link: the sign-up must belong to the selected company and one of its persons, a confirmation must be pending and the deadline must not have passed.
Path parameters
identifierrequiredstring |
Responses
200Customer: confirm a wait list promotionBaseEventSignUp10
Show fields (54)
bib_range_idintegerage_classstringAltersklasse nach DLV, z. B. M40 - berechnet aus Geburtstag, Geschlecht und Eventdatum.
idintegerPrimary key of the sign-up. Internal ID.
genderstringGender of the participant.
tokenstringPublic token of the sign-up. Used in links instead of the ID.
moments_tokenstringParticipant-bound moments token: allows this participant to use the event moments (digital guestbook) page; uploads via this token are linked to the participant.
waitingbooleanThe sign-up is on the waiting list.
confirmedbooleanThe sign-up is confirmed.
externalbooleanThe sign-up was made by an external party.
deletion_reasonstringReason the sign-up was cancelled.
billedbooleanThe sign-up was billed.
direct_billingbooleandirect_billing_check_datestring (date-time)direct_billing_tokenstringwait_list_confirmation_tokenstringwait_list_confirmation_sent_atstring (date-time)wait_list_confirmation_deadlinestring (date-time)wait_list_confirmed_atstring (date-time)wait_list_pending_confirmationbooleanwait_list_sort_orderintegerbirthdaystring (date-time)Birthday of the participant.
trialbooleanTrial date sign-up (Schnuppern): a date sign-up without a course place that uses up one unit of the person's trial pass (eventAccessBudget with sourceType trial)
trial_channelstringWho booked the trial date: app, trainer, office
trial_session_numberintegerNumber of this trial date within the pass (1 = first), for "Schnuppern 2/3"
trial_session_maxintegerTrial dates of the pass, for "Schnuppern 2/3"
nace_sectionstringNACE section code (letter A-U)
nace_codestringNACE code (numeric like 01.11, 62.01)
bib_numberintegerStartnummer (Zaehler). Bei PER_PREFIX nur zusammen mit dem Praefix eindeutig. Wird nur ueber BibNumberAssigner gesetzt, stornierte Anmeldungen behalten sie.
bib_labelstringAngezeigte Startnummer inkl. Praefix, z. B. W0123. Pro Event eindeutig.
bib_number_assigned_atstring (date-time)Time the bib number was assigned.
chip_codestringTransponder- oder QR-Kennung fuer die Zeitmessung. Pro Event eindeutig.
timing_tracking_consentbooleanEinwilligung in das GPS-Live-Tracking waehrend des Events.
createdstring (date-time)Point in time the entity was created.
updatedstring (date-time)Point in time the entity was last updated.
addressstringAddress as text.
address_streetstringStreet of the address.
address_house_numberstringHouse number of the address.
address_street_levelstringStreet and house number of the address.
address_costringCare-of line of the address.
address_citystringCity of the address.
address_zipstringPostal code of the address.
address_admin_level1stringFirst administrative level of the address, e.g. the federal state.
address_countrystringCountry code of the address.
address_full_countrystringFull name of the country of the address.
address_geo_latstringLatitude of the address.
address_geo_lngstringLongitude of the address.
address_external_provider_idstringfield to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
namestringName of the entity.
main_phonestringMain phone number.
main_faxstringMain fax number.
main_emailstringMain e-mail address.
websitestringWebsite address.
deletedbooleanThis property is used to mark an entity as deleted / archived
orderintegerPosition of the entity in the order.
curl --request POST \
--url https://your-instance.iw-erp.de/api/event/customer/base_event_signup/42/wait_list_confirm \
--header 'x-iw-jwt-token: <TOKEN>'const options = {method: 'POST', headers: {'x-iw-jwt-token': '<TOKEN>'}};
fetch('https://your-instance.iw-erp.de/api/event/customer/base_event_signup/42/wait_list_confirm', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://your-instance.iw-erp.de/api/event/customer/base_event_signup/42/wait_list_confirm"
headers = {"x-iw-jwt-token": "<TOKEN>"}
response = requests.post(url, headers=headers)
print(response.text)<?php
require_once('vendor/autoload.php');
$client = new \GuzzleHttp\Client();
$response = $client->request('POST', 'https://your-instance.iw-erp.de/api/event/customer/base_event_signup/42/wait_list_confirm', [
'headers' => [
'x-iw-jwt-token' => '<TOKEN>',
],
]);
echo $response->getBody();using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("https://your-instance.iw-erp.de/api/event/customer/base_event_signup/42/wait_list_confirm"),
Headers =
{
{ "x-iw-jwt-token", "<TOKEN>" },
},
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://your-instance.iw-erp.de/api/event/customer/base_event_signup/42/wait_list_confirm")
.post(null)
.addHeader("x-iw-jwt-token", "<TOKEN>")
.build();
Response response = client.newCall(request).execute();package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://your-instance.iw-erp.de/api/event/customer/base_event_signup/42/wait_list_confirm"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("x-iw-jwt-token", "<TOKEN>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}Dart with the iw_erp_api package
import 'package:iw_erp_api/clients/event_base_event_sign_up_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';
IwApiState().host = 'your-instance.iw-erp.de';
IwApiState().currentJwtApiToken = '<TOKEN>';
final result = await EventBaseEventSignUpController.customerWaitListConfirm('42');
if (result.success) {
print(result.data);
}{
"id": 42,
"address_street": "Jakobistr. 39",
"address_city": "Hannover",
"address_zip": "30163",
"address_country": "DE",
"address_full_country": "DE",
"name": "Beispiel",
"main_phone": "+49 511 123456",
"main_email": "lena.hartmann@example.org",
"bib_range_id": 42
}This method will get all BaseEventSignUp Objects for trainer
GET/api/event/trainer_event/base_event_signup/{eventIdentifier}
Path parameters
eventIdentifierrequiredstring |
Query parameters
searchStringstring | text to search for in the list |
orderFieldNamestring | name of the order field |
orderFieldSortstring | sorting modeAllowed: DESCASC |
pageinteger | page of the list |
pageSizeinteger | number of entries for each page |
withMaxPageNumberstring | returns the number of pages available as a header if this is set |
Responses
200Returns a list of BaseEventSignUp objects for trainerarray<BaseEventSignUp10>
Show fields (54)
bib_range_idintegerage_classstringAltersklasse nach DLV, z. B. M40 - berechnet aus Geburtstag, Geschlecht und Eventdatum.
idintegerPrimary key of the sign-up. Internal ID.
genderstringGender of the participant.
tokenstringPublic token of the sign-up. Used in links instead of the ID.
moments_tokenstringParticipant-bound moments token: allows this participant to use the event moments (digital guestbook) page; uploads via this token are linked to the participant.
waitingbooleanThe sign-up is on the waiting list.
confirmedbooleanThe sign-up is confirmed.
externalbooleanThe sign-up was made by an external party.
deletion_reasonstringReason the sign-up was cancelled.
billedbooleanThe sign-up was billed.
direct_billingbooleandirect_billing_check_datestring (date-time)direct_billing_tokenstringwait_list_confirmation_tokenstringwait_list_confirmation_sent_atstring (date-time)wait_list_confirmation_deadlinestring (date-time)wait_list_confirmed_atstring (date-time)wait_list_pending_confirmationbooleanwait_list_sort_orderintegerbirthdaystring (date-time)Birthday of the participant.
trialbooleanTrial date sign-up (Schnuppern): a date sign-up without a course place that uses up one unit of the person's trial pass (eventAccessBudget with sourceType trial)
trial_channelstringWho booked the trial date: app, trainer, office
trial_session_numberintegerNumber of this trial date within the pass (1 = first), for "Schnuppern 2/3"
trial_session_maxintegerTrial dates of the pass, for "Schnuppern 2/3"
nace_sectionstringNACE section code (letter A-U)
nace_codestringNACE code (numeric like 01.11, 62.01)
bib_numberintegerStartnummer (Zaehler). Bei PER_PREFIX nur zusammen mit dem Praefix eindeutig. Wird nur ueber BibNumberAssigner gesetzt, stornierte Anmeldungen behalten sie.
bib_labelstringAngezeigte Startnummer inkl. Praefix, z. B. W0123. Pro Event eindeutig.
bib_number_assigned_atstring (date-time)Time the bib number was assigned.
chip_codestringTransponder- oder QR-Kennung fuer die Zeitmessung. Pro Event eindeutig.
timing_tracking_consentbooleanEinwilligung in das GPS-Live-Tracking waehrend des Events.
createdstring (date-time)Point in time the entity was created.
updatedstring (date-time)Point in time the entity was last updated.
addressstringAddress as text.
address_streetstringStreet of the address.
address_house_numberstringHouse number of the address.
address_street_levelstringStreet and house number of the address.
address_costringCare-of line of the address.
address_citystringCity of the address.
address_zipstringPostal code of the address.
address_admin_level1stringFirst administrative level of the address, e.g. the federal state.
address_countrystringCountry code of the address.
address_full_countrystringFull name of the country of the address.
address_geo_latstringLatitude of the address.
address_geo_lngstringLongitude of the address.
address_external_provider_idstringfield to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
namestringName of the entity.
main_phonestringMain phone number.
main_faxstringMain fax number.
main_emailstringMain e-mail address.
websitestringWebsite address.
deletedbooleanThis property is used to mark an entity as deleted / archived
orderintegerPosition of the entity in the order.
curl --request GET \
--url https://your-instance.iw-erp.de/api/event/trainer_event/base_event_signup/42 \
--header 'x-iw-jwt-token: <TOKEN>'const options = {method: 'GET', headers: {'x-iw-jwt-token': '<TOKEN>'}};
fetch('https://your-instance.iw-erp.de/api/event/trainer_event/base_event_signup/42', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://your-instance.iw-erp.de/api/event/trainer_event/base_event_signup/42"
headers = {"x-iw-jwt-token": "<TOKEN>"}
response = requests.get(url, headers=headers)
print(response.text)<?php
require_once('vendor/autoload.php');
$client = new \GuzzleHttp\Client();
$response = $client->request('GET', 'https://your-instance.iw-erp.de/api/event/trainer_event/base_event_signup/42', [
'headers' => [
'x-iw-jwt-token' => '<TOKEN>',
],
]);
echo $response->getBody();using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("https://your-instance.iw-erp.de/api/event/trainer_event/base_event_signup/42"),
Headers =
{
{ "x-iw-jwt-token", "<TOKEN>" },
},
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://your-instance.iw-erp.de/api/event/trainer_event/base_event_signup/42")
.get()
.addHeader("x-iw-jwt-token", "<TOKEN>")
.build();
Response response = client.newCall(request).execute();package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://your-instance.iw-erp.de/api/event/trainer_event/base_event_signup/42"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-iw-jwt-token", "<TOKEN>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}Dart with the iw_erp_api package
import 'package:iw_erp_api/clients/event_base_event_sign_up_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';
IwApiState().host = 'your-instance.iw-erp.de';
IwApiState().currentJwtApiToken = '<TOKEN>';
final result = await EventBaseEventSignUpController.getAllTrainerEvent('42');
if (result.success) {
print(result.data);
}[
{
"id": 42,
"address_street": "Jakobistr. 39",
"address_city": "Hannover",
"address_zip": "30163",
"address_country": "DE",
"address_full_country": "DE",
"name": "Beispiel",
"main_phone": "+49 511 123456",
"main_email": "lena.hartmann@example.org",
"bib_range_id": 42
}
]This method will get all BaseEventSignUp Objects for trainer with the eventIdentifier and multiple bookings
GET/api/event/trainer_event/bookings_with_base_event_signup/{eventIdentifier}
Path parameters
eventIdentifierrequiredstring |
Query parameters
searchStringstring | text to search for in the list |
orderFieldNamestring | name of the order field |
orderFieldSortstring | sorting modeAllowed: DESCASC |
pageinteger | page of the list |
pageSizeinteger | number of entries for each page |
withMaxPageNumberstring | returns the number of pages available as a header if this is set |
Responses
default
curl --request GET \
--url https://your-instance.iw-erp.de/api/event/trainer_event/bookings_with_base_event_signup/42 \
--header 'x-iw-jwt-token: <TOKEN>'const options = {method: 'GET', headers: {'x-iw-jwt-token': '<TOKEN>'}};
fetch('https://your-instance.iw-erp.de/api/event/trainer_event/bookings_with_base_event_signup/42', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://your-instance.iw-erp.de/api/event/trainer_event/bookings_with_base_event_signup/42"
headers = {"x-iw-jwt-token": "<TOKEN>"}
response = requests.get(url, headers=headers)
print(response.text)<?php
require_once('vendor/autoload.php');
$client = new \GuzzleHttp\Client();
$response = $client->request('GET', 'https://your-instance.iw-erp.de/api/event/trainer_event/bookings_with_base_event_signup/42', [
'headers' => [
'x-iw-jwt-token' => '<TOKEN>',
],
]);
echo $response->getBody();using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("https://your-instance.iw-erp.de/api/event/trainer_event/bookings_with_base_event_signup/42"),
Headers =
{
{ "x-iw-jwt-token", "<TOKEN>" },
},
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://your-instance.iw-erp.de/api/event/trainer_event/bookings_with_base_event_signup/42")
.get()
.addHeader("x-iw-jwt-token", "<TOKEN>")
.build();
Response response = client.newCall(request).execute();package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://your-instance.iw-erp.de/api/event/trainer_event/bookings_with_base_event_signup/42"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-iw-jwt-token", "<TOKEN>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}Dart with the iw_erp_api package
import 'package:iw_erp_api/clients/event_base_event_sign_up_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';
IwApiState().host = 'your-instance.iw-erp.de';
IwApiState().currentJwtApiToken = '<TOKEN>';
final result = await EventBaseEventSignUpController.getAllTrainerEventWithBookings('42');
if (result.success) {
print(result.data);
}This method will get all BaseEventSignUp Objects for trainer
GET/api/event/trainer_booking/base_event_signup/{bookingIdentifier}
Path parameters
bookingIdentifierrequiredstring |
Query parameters
searchStringstring | text to search for in the list |
orderFieldNamestring | name of the order field |
orderFieldSortstring | sorting modeAllowed: DESCASC |
pageinteger | page of the list |
pageSizeinteger | number of entries for each page |
withMaxPageNumberstring | returns the number of pages available as a header if this is set |
Responses
200Returns a list of BaseEventSignUp objects for trainer by bookingarray<BaseEventSignUp10>
Show fields (54)
bib_range_idintegerage_classstringAltersklasse nach DLV, z. B. M40 - berechnet aus Geburtstag, Geschlecht und Eventdatum.
idintegerPrimary key of the sign-up. Internal ID.
genderstringGender of the participant.
tokenstringPublic token of the sign-up. Used in links instead of the ID.
moments_tokenstringParticipant-bound moments token: allows this participant to use the event moments (digital guestbook) page; uploads via this token are linked to the participant.
waitingbooleanThe sign-up is on the waiting list.
confirmedbooleanThe sign-up is confirmed.
externalbooleanThe sign-up was made by an external party.
deletion_reasonstringReason the sign-up was cancelled.
billedbooleanThe sign-up was billed.
direct_billingbooleandirect_billing_check_datestring (date-time)direct_billing_tokenstringwait_list_confirmation_tokenstringwait_list_confirmation_sent_atstring (date-time)wait_list_confirmation_deadlinestring (date-time)wait_list_confirmed_atstring (date-time)wait_list_pending_confirmationbooleanwait_list_sort_orderintegerbirthdaystring (date-time)Birthday of the participant.
trialbooleanTrial date sign-up (Schnuppern): a date sign-up without a course place that uses up one unit of the person's trial pass (eventAccessBudget with sourceType trial)
trial_channelstringWho booked the trial date: app, trainer, office
trial_session_numberintegerNumber of this trial date within the pass (1 = first), for "Schnuppern 2/3"
trial_session_maxintegerTrial dates of the pass, for "Schnuppern 2/3"
nace_sectionstringNACE section code (letter A-U)
nace_codestringNACE code (numeric like 01.11, 62.01)
bib_numberintegerStartnummer (Zaehler). Bei PER_PREFIX nur zusammen mit dem Praefix eindeutig. Wird nur ueber BibNumberAssigner gesetzt, stornierte Anmeldungen behalten sie.
bib_labelstringAngezeigte Startnummer inkl. Praefix, z. B. W0123. Pro Event eindeutig.
bib_number_assigned_atstring (date-time)Time the bib number was assigned.
chip_codestringTransponder- oder QR-Kennung fuer die Zeitmessung. Pro Event eindeutig.
timing_tracking_consentbooleanEinwilligung in das GPS-Live-Tracking waehrend des Events.
createdstring (date-time)Point in time the entity was created.
updatedstring (date-time)Point in time the entity was last updated.
addressstringAddress as text.
address_streetstringStreet of the address.
address_house_numberstringHouse number of the address.
address_street_levelstringStreet and house number of the address.
address_costringCare-of line of the address.
address_citystringCity of the address.
address_zipstringPostal code of the address.
address_admin_level1stringFirst administrative level of the address, e.g. the federal state.
address_countrystringCountry code of the address.
address_full_countrystringFull name of the country of the address.
address_geo_latstringLatitude of the address.
address_geo_lngstringLongitude of the address.
address_external_provider_idstringfield to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
namestringName of the entity.
main_phonestringMain phone number.
main_faxstringMain fax number.
main_emailstringMain e-mail address.
websitestringWebsite address.
deletedbooleanThis property is used to mark an entity as deleted / archived
orderintegerPosition of the entity in the order.
curl --request GET \
--url https://your-instance.iw-erp.de/api/event/trainer_booking/base_event_signup/42 \
--header 'x-iw-jwt-token: <TOKEN>'const options = {method: 'GET', headers: {'x-iw-jwt-token': '<TOKEN>'}};
fetch('https://your-instance.iw-erp.de/api/event/trainer_booking/base_event_signup/42', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://your-instance.iw-erp.de/api/event/trainer_booking/base_event_signup/42"
headers = {"x-iw-jwt-token": "<TOKEN>"}
response = requests.get(url, headers=headers)
print(response.text)<?php
require_once('vendor/autoload.php');
$client = new \GuzzleHttp\Client();
$response = $client->request('GET', 'https://your-instance.iw-erp.de/api/event/trainer_booking/base_event_signup/42', [
'headers' => [
'x-iw-jwt-token' => '<TOKEN>',
],
]);
echo $response->getBody();using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("https://your-instance.iw-erp.de/api/event/trainer_booking/base_event_signup/42"),
Headers =
{
{ "x-iw-jwt-token", "<TOKEN>" },
},
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://your-instance.iw-erp.de/api/event/trainer_booking/base_event_signup/42")
.get()
.addHeader("x-iw-jwt-token", "<TOKEN>")
.build();
Response response = client.newCall(request).execute();package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://your-instance.iw-erp.de/api/event/trainer_booking/base_event_signup/42"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-iw-jwt-token", "<TOKEN>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}Dart with the iw_erp_api package
import 'package:iw_erp_api/clients/event_base_event_sign_up_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';
IwApiState().host = 'your-instance.iw-erp.de';
IwApiState().currentJwtApiToken = '<TOKEN>';
final result = await EventBaseEventSignUpController.getAllTrainerBooking('42');
if (result.success) {
print(result.data);
}[
{
"id": 42,
"address_street": "Jakobistr. 39",
"address_city": "Hannover",
"address_zip": "30163",
"address_country": "DE",
"address_full_country": "DE",
"name": "Beispiel",
"main_phone": "+49 511 123456",
"main_email": "lena.hartmann@example.org",
"bib_range_id": 42
}
]Get participant list for a booking with next booking info per participant (same day).
GET/api/event/trainer_booking/base_event_signup_with_next/{bookingIdentifier}
Requires trainerCanViewParticipants AND trainerCanViewNextBooking to be enabled on the event data type.
Path parameters
bookingIdentifierrequiredstring |
Responses
default
curl --request GET \
--url https://your-instance.iw-erp.de/api/event/trainer_booking/base_event_signup_with_next/42 \
--header 'x-iw-jwt-token: <TOKEN>'const options = {method: 'GET', headers: {'x-iw-jwt-token': '<TOKEN>'}};
fetch('https://your-instance.iw-erp.de/api/event/trainer_booking/base_event_signup_with_next/42', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://your-instance.iw-erp.de/api/event/trainer_booking/base_event_signup_with_next/42"
headers = {"x-iw-jwt-token": "<TOKEN>"}
response = requests.get(url, headers=headers)
print(response.text)<?php
require_once('vendor/autoload.php');
$client = new \GuzzleHttp\Client();
$response = $client->request('GET', 'https://your-instance.iw-erp.de/api/event/trainer_booking/base_event_signup_with_next/42', [
'headers' => [
'x-iw-jwt-token' => '<TOKEN>',
],
]);
echo $response->getBody();using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("https://your-instance.iw-erp.de/api/event/trainer_booking/base_event_signup_with_next/42"),
Headers =
{
{ "x-iw-jwt-token", "<TOKEN>" },
},
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://your-instance.iw-erp.de/api/event/trainer_booking/base_event_signup_with_next/42")
.get()
.addHeader("x-iw-jwt-token", "<TOKEN>")
.build();
Response response = client.newCall(request).execute();package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://your-instance.iw-erp.de/api/event/trainer_booking/base_event_signup_with_next/42"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-iw-jwt-token", "<TOKEN>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}Dart with the iw_erp_api package
import 'package:iw_erp_api/clients/event_base_event_sign_up_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';
IwApiState().host = 'your-instance.iw-erp.de';
IwApiState().currentJwtApiToken = '<TOKEN>';
final result = await EventBaseEventSignUpController.getAllTrainerBookingWithNext('42');
if (result.success) {
print(result.data);
}This method will toggle confirmed on BaseEventSignUp Objects for trainer
GET/api/event/trainer_actions/base_event_signup/toggle/{signUpIdentifier}
Path parameters
signUpIdentifierrequiredstring |
Responses
default
curl --request GET \
--url https://your-instance.iw-erp.de/api/event/trainer_actions/base_event_signup/toggle/42 \
--header 'x-iw-jwt-token: <TOKEN>'const options = {method: 'GET', headers: {'x-iw-jwt-token': '<TOKEN>'}};
fetch('https://your-instance.iw-erp.de/api/event/trainer_actions/base_event_signup/toggle/42', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://your-instance.iw-erp.de/api/event/trainer_actions/base_event_signup/toggle/42"
headers = {"x-iw-jwt-token": "<TOKEN>"}
response = requests.get(url, headers=headers)
print(response.text)<?php
require_once('vendor/autoload.php');
$client = new \GuzzleHttp\Client();
$response = $client->request('GET', 'https://your-instance.iw-erp.de/api/event/trainer_actions/base_event_signup/toggle/42', [
'headers' => [
'x-iw-jwt-token' => '<TOKEN>',
],
]);
echo $response->getBody();using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("https://your-instance.iw-erp.de/api/event/trainer_actions/base_event_signup/toggle/42"),
Headers =
{
{ "x-iw-jwt-token", "<TOKEN>" },
},
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://your-instance.iw-erp.de/api/event/trainer_actions/base_event_signup/toggle/42")
.get()
.addHeader("x-iw-jwt-token", "<TOKEN>")
.build();
Response response = client.newCall(request).execute();package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://your-instance.iw-erp.de/api/event/trainer_actions/base_event_signup/toggle/42"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-iw-jwt-token", "<TOKEN>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}Dart with the iw_erp_api package
import 'package:iw_erp_api/clients/event_base_event_sign_up_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';
IwApiState().host = 'your-instance.iw-erp.de';
IwApiState().currentJwtApiToken = '<TOKEN>';
final result = await EventBaseEventSignUpController.getTrainerToggle('42');
if (result.success) {
print(result.data);
}This method will toggle the vaccinated status on BaseEventSignUp Objects for trainer
GET/api/event/trainer_actions/base_event_signup/vaccinated/{signUpIdentifier}
Path parameters
signUpIdentifierrequiredstring |
Responses
default
curl --request GET \
--url https://your-instance.iw-erp.de/api/event/trainer_actions/base_event_signup/vaccinated/42 \
--header 'x-iw-jwt-token: <TOKEN>'const options = {method: 'GET', headers: {'x-iw-jwt-token': '<TOKEN>'}};
fetch('https://your-instance.iw-erp.de/api/event/trainer_actions/base_event_signup/vaccinated/42', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://your-instance.iw-erp.de/api/event/trainer_actions/base_event_signup/vaccinated/42"
headers = {"x-iw-jwt-token": "<TOKEN>"}
response = requests.get(url, headers=headers)
print(response.text)<?php
require_once('vendor/autoload.php');
$client = new \GuzzleHttp\Client();
$response = $client->request('GET', 'https://your-instance.iw-erp.de/api/event/trainer_actions/base_event_signup/vaccinated/42', [
'headers' => [
'x-iw-jwt-token' => '<TOKEN>',
],
]);
echo $response->getBody();using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("https://your-instance.iw-erp.de/api/event/trainer_actions/base_event_signup/vaccinated/42"),
Headers =
{
{ "x-iw-jwt-token", "<TOKEN>" },
},
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://your-instance.iw-erp.de/api/event/trainer_actions/base_event_signup/vaccinated/42")
.get()
.addHeader("x-iw-jwt-token", "<TOKEN>")
.build();
Response response = client.newCall(request).execute();package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://your-instance.iw-erp.de/api/event/trainer_actions/base_event_signup/vaccinated/42"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-iw-jwt-token", "<TOKEN>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}Dart with the iw_erp_api package
import 'package:iw_erp_api/clients/event_base_event_sign_up_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';
IwApiState().host = 'your-instance.iw-erp.de';
IwApiState().currentJwtApiToken = '<TOKEN>';
final result = await EventBaseEventSignUpController.getTrainerToggleVaccinated('42');
if (result.success) {
print(result.data);
}This method will toggle the vaccinated status on BaseEventSignUp Objects for trainer
GET/api/event/trainer_actions/base_event_signup/recovered/{signUpIdentifier}
Path parameters
signUpIdentifierrequiredstring |
Responses
default
curl --request GET \
--url https://your-instance.iw-erp.de/api/event/trainer_actions/base_event_signup/recovered/42 \
--header 'x-iw-jwt-token: <TOKEN>'const options = {method: 'GET', headers: {'x-iw-jwt-token': '<TOKEN>'}};
fetch('https://your-instance.iw-erp.de/api/event/trainer_actions/base_event_signup/recovered/42', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://your-instance.iw-erp.de/api/event/trainer_actions/base_event_signup/recovered/42"
headers = {"x-iw-jwt-token": "<TOKEN>"}
response = requests.get(url, headers=headers)
print(response.text)<?php
require_once('vendor/autoload.php');
$client = new \GuzzleHttp\Client();
$response = $client->request('GET', 'https://your-instance.iw-erp.de/api/event/trainer_actions/base_event_signup/recovered/42', [
'headers' => [
'x-iw-jwt-token' => '<TOKEN>',
],
]);
echo $response->getBody();using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("https://your-instance.iw-erp.de/api/event/trainer_actions/base_event_signup/recovered/42"),
Headers =
{
{ "x-iw-jwt-token", "<TOKEN>" },
},
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://your-instance.iw-erp.de/api/event/trainer_actions/base_event_signup/recovered/42")
.get()
.addHeader("x-iw-jwt-token", "<TOKEN>")
.build();
Response response = client.newCall(request).execute();package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://your-instance.iw-erp.de/api/event/trainer_actions/base_event_signup/recovered/42"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-iw-jwt-token", "<TOKEN>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}Dart with the iw_erp_api package
import 'package:iw_erp_api/clients/event_base_event_sign_up_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';
IwApiState().host = 'your-instance.iw-erp.de';
IwApiState().currentJwtApiToken = '<TOKEN>';
final result = await EventBaseEventSignUpController.getTrainerToggleRecovered('42');
if (result.success) {
print(result.data);
}This method will update a single field on BaseEventSignUp Objects by trainer
POST/api/event/trainer_actions/base_event_signup/update/{signUpIdentifier}
Path parameters
signUpIdentifierrequiredstring |
Responses
default
curl --request POST \
--url https://your-instance.iw-erp.de/api/event/trainer_actions/base_event_signup/update/42 \
--header 'x-iw-jwt-token: <TOKEN>'const options = {method: 'POST', headers: {'x-iw-jwt-token': '<TOKEN>'}};
fetch('https://your-instance.iw-erp.de/api/event/trainer_actions/base_event_signup/update/42', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://your-instance.iw-erp.de/api/event/trainer_actions/base_event_signup/update/42"
headers = {"x-iw-jwt-token": "<TOKEN>"}
response = requests.post(url, headers=headers)
print(response.text)<?php
require_once('vendor/autoload.php');
$client = new \GuzzleHttp\Client();
$response = $client->request('POST', 'https://your-instance.iw-erp.de/api/event/trainer_actions/base_event_signup/update/42', [
'headers' => [
'x-iw-jwt-token' => '<TOKEN>',
],
]);
echo $response->getBody();using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("https://your-instance.iw-erp.de/api/event/trainer_actions/base_event_signup/update/42"),
Headers =
{
{ "x-iw-jwt-token", "<TOKEN>" },
},
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://your-instance.iw-erp.de/api/event/trainer_actions/base_event_signup/update/42")
.post(null)
.addHeader("x-iw-jwt-token", "<TOKEN>")
.build();
Response response = client.newCall(request).execute();package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://your-instance.iw-erp.de/api/event/trainer_actions/base_event_signup/update/42"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("x-iw-jwt-token", "<TOKEN>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}Dart with the iw_erp_api package
import 'package:iw_erp_api/clients/event_base_event_sign_up_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';
import 'package:iw_erp_api/model/event_base_event_sign_up.dart';
import 'package:iw_erp_api/model/simple_change.dart';
IwApiState().host = 'your-instance.iw-erp.de';
IwApiState().currentJwtApiToken = '<TOKEN>';
final result = await EventBaseEventSignUpController.postTrainerAction(EventBaseEventSignUp.fromJson({}), SimpleChange.fromJson({}));
if (result.success) {
print(result.data);
}Delete a participant from an entire event (main sign-up + cascades to all future bookings)
POST/api/event/trainer_actions/base_event_signup/delete_for_event/{eventIdentifier}
Path parameters
eventIdentifierrequiredstring |
Responses
default
curl --request POST \
--url https://your-instance.iw-erp.de/api/event/trainer_actions/base_event_signup/delete_for_event/42 \
--header 'x-iw-jwt-token: <TOKEN>'const options = {method: 'POST', headers: {'x-iw-jwt-token': '<TOKEN>'}};
fetch('https://your-instance.iw-erp.de/api/event/trainer_actions/base_event_signup/delete_for_event/42', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://your-instance.iw-erp.de/api/event/trainer_actions/base_event_signup/delete_for_event/42"
headers = {"x-iw-jwt-token": "<TOKEN>"}
response = requests.post(url, headers=headers)
print(response.text)<?php
require_once('vendor/autoload.php');
$client = new \GuzzleHttp\Client();
$response = $client->request('POST', 'https://your-instance.iw-erp.de/api/event/trainer_actions/base_event_signup/delete_for_event/42', [
'headers' => [
'x-iw-jwt-token' => '<TOKEN>',
],
]);
echo $response->getBody();using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("https://your-instance.iw-erp.de/api/event/trainer_actions/base_event_signup/delete_for_event/42"),
Headers =
{
{ "x-iw-jwt-token", "<TOKEN>" },
},
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://your-instance.iw-erp.de/api/event/trainer_actions/base_event_signup/delete_for_event/42")
.post(null)
.addHeader("x-iw-jwt-token", "<TOKEN>")
.build();
Response response = client.newCall(request).execute();package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://your-instance.iw-erp.de/api/event/trainer_actions/base_event_signup/delete_for_event/42"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("x-iw-jwt-token", "<TOKEN>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}Dart with package:http (no controller in the iw_erp_api package)
import 'package:http/http.dart' as http;
final response = await http.post(
Uri.parse('https://your-instance.iw-erp.de/api/event/trainer_actions/base_event_signup/delete_for_event/42'),
headers: {'x-iw-jwt-token': '<TOKEN>'},
);
print(response.body);This method will add a new BaseEventSignUp for the event by the trainer
GET/api/event/trainer_event/base_event_signup_scan/{eventIdentifier}/{personIdentifier}
Path parameters
eventIdentifierrequiredstring | |
personIdentifierrequiredstring |
Responses
default
curl --request GET \
--url https://your-instance.iw-erp.de/api/event/trainer_event/base_event_signup_scan/42/42 \
--header 'x-iw-jwt-token: <TOKEN>'const options = {method: 'GET', headers: {'x-iw-jwt-token': '<TOKEN>'}};
fetch('https://your-instance.iw-erp.de/api/event/trainer_event/base_event_signup_scan/42/42', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://your-instance.iw-erp.de/api/event/trainer_event/base_event_signup_scan/42/42"
headers = {"x-iw-jwt-token": "<TOKEN>"}
response = requests.get(url, headers=headers)
print(response.text)<?php
require_once('vendor/autoload.php');
$client = new \GuzzleHttp\Client();
$response = $client->request('GET', 'https://your-instance.iw-erp.de/api/event/trainer_event/base_event_signup_scan/42/42', [
'headers' => [
'x-iw-jwt-token' => '<TOKEN>',
],
]);
echo $response->getBody();using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("https://your-instance.iw-erp.de/api/event/trainer_event/base_event_signup_scan/42/42"),
Headers =
{
{ "x-iw-jwt-token", "<TOKEN>" },
},
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://your-instance.iw-erp.de/api/event/trainer_event/base_event_signup_scan/42/42")
.get()
.addHeader("x-iw-jwt-token", "<TOKEN>")
.build();
Response response = client.newCall(request).execute();package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://your-instance.iw-erp.de/api/event/trainer_event/base_event_signup_scan/42/42"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-iw-jwt-token", "<TOKEN>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}Dart with the iw_erp_api package
import 'package:iw_erp_api/clients/event_base_event_sign_up_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';
IwApiState().host = 'your-instance.iw-erp.de';
IwApiState().currentJwtApiToken = '<TOKEN>';
final result = await EventBaseEventSignUpController.eventTrainerScan('42', '42');
if (result.success) {
print(result.data);
}This method will add a new BaseEventSignUp for the booking by the trainer
GET/api/event/trainer_booking/base_event_signup_scan/{bookingIdentifier}/{personIdentifier}
Path parameters
bookingIdentifierrequiredstring | |
personIdentifierrequiredstring |
Responses
default
curl --request GET \
--url https://your-instance.iw-erp.de/api/event/trainer_booking/base_event_signup_scan/42/42 \
--header 'x-iw-jwt-token: <TOKEN>'const options = {method: 'GET', headers: {'x-iw-jwt-token': '<TOKEN>'}};
fetch('https://your-instance.iw-erp.de/api/event/trainer_booking/base_event_signup_scan/42/42', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://your-instance.iw-erp.de/api/event/trainer_booking/base_event_signup_scan/42/42"
headers = {"x-iw-jwt-token": "<TOKEN>"}
response = requests.get(url, headers=headers)
print(response.text)<?php
require_once('vendor/autoload.php');
$client = new \GuzzleHttp\Client();
$response = $client->request('GET', 'https://your-instance.iw-erp.de/api/event/trainer_booking/base_event_signup_scan/42/42', [
'headers' => [
'x-iw-jwt-token' => '<TOKEN>',
],
]);
echo $response->getBody();using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("https://your-instance.iw-erp.de/api/event/trainer_booking/base_event_signup_scan/42/42"),
Headers =
{
{ "x-iw-jwt-token", "<TOKEN>" },
},
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://your-instance.iw-erp.de/api/event/trainer_booking/base_event_signup_scan/42/42")
.get()
.addHeader("x-iw-jwt-token", "<TOKEN>")
.build();
Response response = client.newCall(request).execute();package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://your-instance.iw-erp.de/api/event/trainer_booking/base_event_signup_scan/42/42"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-iw-jwt-token", "<TOKEN>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}Dart with the iw_erp_api package
import 'package:iw_erp_api/clients/event_base_event_sign_up_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';
IwApiState().host = 'your-instance.iw-erp.de';
IwApiState().currentJwtApiToken = '<TOKEN>';
final result = await EventBaseEventSignUpController.bookingTrainerScan('42', '42');
if (result.success) {
print(result.data);
}Test adding a new BaseEventSignUp as trainer
POST/api/event/trainer/test_base_event_signup
Request body application/json
dataBaseEventSignUp3Show fields (39)
first_namestringFirst name of the participant.
last_namestringLast name of the participant.
genderstringGender of the participant.
deletion_reasonstringReason the sign-up was cancelled.
direct_billingbooleandirect_billing_check_datestring (date-time)direct_billing_tokenstringbirthdaystring (date-time)Birthday of the participant.
known_allergiesstringKnown allergies of the participant.
confirmed_no_allergiesbooleanGuardian confirmed that there are no known allergies.
allow_photosbooleanGuardian allows photos of the participant.
allow_child_alonebooleanParticipant may leave alone after the event.
authorized_pickupstringPersons who are allowed to pick up the participant.
needs_supportbooleanParticipant needs support, for example for inclusion.
support_descriptionstringDescription of the support the participant needs.
financial_supportbooleanParticipant receives financial support.
financial_support_numberstringNumber of the financial support, for example a voucher.
municipal_supportbooleanParticipant receives municipal support.
municipal_support_numberstringNumber of the municipal support.
grade_levelintegerSchool grade level of the participant.
school_classstringSchool class of the participant.
confirmed_disclaimerbooleanParticipant confirmed the disclaimer.
confirmed_privacybooleanParticipant confirmed the privacy policy.
confirmed_cancellation_policybooleanParticipant confirmed the cancellation policy.
free_note_onestringFree note 1 entered on the sign-up.
free_note_twostringFree note 2 entered on the sign-up.
free_note_threestringFree note 3 entered on the sign-up.
free_note_fourstringFree note 4 entered on the sign-up.
invoice_productsarray<BaseEventSignUpProductItem>Product items added to the invoice of the sign-up.
self_check_inbooleanParticipant checked in with the self-service check-in.
self_check_outbooleanParticipant checked out with the self-service check-out.
nace_sectionstringNACE section code (letter A-U)
nace_codestringNACE code (numeric like 01.11, 62.01)
main_phonestringMain phone number.
main_faxstringMain fax number.
main_emailstringMain e-mail address.
websitestringWebsite address.
base_eventBaseEvent21Event the entity belongs to.
base_bookingBaseBooking21Booking the entity belongs to.
Responses
200Test adding a new BaseEventSignUp as trainerBaseEventSignUpTrainerTest
Show fields (4)
signup_allowedbooleansignup_waitlist_allowedbooleantrainer_can_track_timebooleantrainer_can_edit_scoreboardbooleanThe trainer may enter score and match activities (event type allows it and the event has a scoreboard).
curl --request POST \
--url https://your-instance.iw-erp.de/api/event/trainer/test_base_event_signup \
--header 'content-type: application/json' \
--header 'x-iw-jwt-token: <TOKEN>' \
--data '
{
"data": {
"first_name": "Lena",
"last_name": "Hartmann",
"support_description": "Text",
"main_phone": "+49 511 123456",
"main_email": "lena.hartmann@example.org",
"gender": "string"
}
}
'const options = {
method: 'POST',
headers: {'x-iw-jwt-token': '<TOKEN>', 'content-type': 'application/json'},
body: JSON.stringify({
data: {
first_name: 'Lena',
last_name: 'Hartmann',
support_description: 'Text',
main_phone: '+49 511 123456',
main_email: 'lena.hartmann@example.org',
gender: 'string'
}
})
};
fetch('https://your-instance.iw-erp.de/api/event/trainer/test_base_event_signup', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://your-instance.iw-erp.de/api/event/trainer/test_base_event_signup"
payload = { "data": {
"first_name": "Lena",
"last_name": "Hartmann",
"support_description": "Text",
"main_phone": "+49 511 123456",
"main_email": "lena.hartmann@example.org",
"gender": "string"
} }
headers = {
"x-iw-jwt-token": "<TOKEN>",
"content-type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)<?php
require_once('vendor/autoload.php');
$client = new \GuzzleHttp\Client();
$response = $client->request('POST', 'https://your-instance.iw-erp.de/api/event/trainer/test_base_event_signup', [
'body' => '{"data":{"first_name":"Lena","last_name":"Hartmann","support_description":"Text","main_phone":"+49 511 123456","main_email":"lena.hartmann@example.org","gender":"string"}}',
'headers' => [
'content-type' => 'application/json',
'x-iw-jwt-token' => '<TOKEN>',
],
]);
echo $response->getBody();using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("https://your-instance.iw-erp.de/api/event/trainer/test_base_event_signup"),
Headers =
{
{ "x-iw-jwt-token", "<TOKEN>" },
},
Content = new StringContent("{\"data\":{\"first_name\":\"Lena\",\"last_name\":\"Hartmann\",\"support_description\":\"Text\",\"main_phone\":\"+49 511 123456\",\"main_email\":\"lena.hartmann@example.org\",\"gender\":\"string\"}}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"data\":{\"first_name\":\"Lena\",\"last_name\":\"Hartmann\",\"support_description\":\"Text\",\"main_phone\":\"+49 511 123456\",\"main_email\":\"lena.hartmann@example.org\",\"gender\":\"string\"}}");
Request request = new Request.Builder()
.url("https://your-instance.iw-erp.de/api/event/trainer/test_base_event_signup")
.post(body)
.addHeader("x-iw-jwt-token", "<TOKEN>")
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://your-instance.iw-erp.de/api/event/trainer/test_base_event_signup"
payload := strings.NewReader("{\"data\":{\"first_name\":\"Lena\",\"last_name\":\"Hartmann\",\"support_description\":\"Text\",\"main_phone\":\"+49 511 123456\",\"main_email\":\"lena.hartmann@example.org\",\"gender\":\"string\"}}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-iw-jwt-token", "<TOKEN>")
req.Header.Add("content-type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}Dart with the iw_erp_api package
import 'package:iw_erp_api/clients/event_base_event_sign_up_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';
import 'package:iw_erp_api/model/event_base_event_sign_up.dart';
IwApiState().host = 'your-instance.iw-erp.de';
IwApiState().currentJwtApiToken = '<TOKEN>';
final result = await EventBaseEventSignUpController.postTrainerTest(EventBaseEventSignUp.fromJson({
"first_name": "Lena",
"last_name": "Hartmann",
"support_description": "Text",
"main_phone": "+49 511 123456",
"main_email": "lena.hartmann@example.org",
"gender": "string"
}));
if (result.success) {
print(result.data);
}{
"signup_allowed": true,
"signup_waitlist_allowed": true,
"trainer_can_track_time": true,
"trainer_can_edit_scoreboard": true
}Add a new BaseEventSignUp for event or booking as a trainer. Only possible if event billing not required.
POST/api/event/trainer/base_event_signup
Request body application/json
dataBaseEventSignUp4Show fields (56)
first_namestringFirst name of the participant.
last_namestringLast name of the participant.
genderstringGender of the participant.
deletion_reasonstringReason the sign-up was cancelled.
direct_billingbooleandirect_billing_check_datestring (date-time)direct_billing_tokenstringbirthdaystring (date-time)Birthday of the participant.
known_allergiesstringKnown allergies of the participant.
confirmed_no_allergiesbooleanGuardian confirmed that there are no known allergies.
allow_photosbooleanGuardian allows photos of the participant.
allow_child_alonebooleanParticipant may leave alone after the event.
authorized_pickupstringPersons who are allowed to pick up the participant.
needs_supportbooleanParticipant needs support, for example for inclusion.
support_descriptionstringDescription of the support the participant needs.
financial_supportbooleanParticipant receives financial support.
financial_support_numberstringNumber of the financial support, for example a voucher.
municipal_supportbooleanParticipant receives municipal support.
municipal_support_numberstringNumber of the municipal support.
grade_levelintegerSchool grade level of the participant.
school_classstringSchool class of the participant.
confirmed_disclaimerbooleanParticipant confirmed the disclaimer.
confirmed_privacybooleanParticipant confirmed the privacy policy.
confirmed_cancellation_policybooleanParticipant confirmed the cancellation policy.
free_note_onestringFree note 1 entered on the sign-up.
free_note_twostringFree note 2 entered on the sign-up.
free_note_threestringFree note 3 entered on the sign-up.
free_note_fourstringFree note 4 entered on the sign-up.
invoice_productsarray<BaseEventSignUpProductItem2>Product items added to the invoice of the sign-up.
self_check_inbooleanParticipant checked in with the self-service check-in.
self_check_outbooleanParticipant checked out with the self-service check-out.
nace_sectionstringNACE section code (letter A-U)
nace_codestringNACE code (numeric like 01.11, 62.01)
addressstringAddress as text.
address_streetstringStreet of the address.
address_house_numberstringHouse number of the address.
address_street_levelstringStreet and house number of the address.
address_costringCare-of line of the address.
address_citystringCity of the address.
address_zipstringPostal code of the address.
address_admin_level1stringFirst administrative level of the address, e.g. the federal state.
address_external_provider_idstringfield to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
namestringName of the entity.
main_phonestringMain phone number.
main_faxstringMain fax number.
main_emailstringMain e-mail address.
websitestringWebsite address.
base_eventBaseEvent22Event the entity belongs to.
payment_ownerstringAccount owner of the direct debit.
payment_institutionstringName of the bank of the direct debit.
payment_bicstringBIC of the bank account.
payment_ibanstringIBAN of the bank account.
payment_mandatestringReference of the SEPA mandate.
payment_mandate_sign_datestring (date-time)Date the SEPA mandate was signed.
payment_mandate_valid_until_datestring (date-time)Date until which the SEPA mandate is valid.
base_bookingBaseBooking22Booking the entity belongs to.
Responses
200Add a new BaseEventSignUp for event or booking as a trainer. Only possible if event billing not required.BaseEventSignUp
Show fields (42)
idintegerPrimary key of the sign-up. Internal ID.
first_namestringFirst name of the participant.
last_namestringLast name of the participant.
genderstringGender of the participant.
waitingbooleanThe sign-up is on the waiting list.
confirmedbooleanThe sign-up is confirmed.
deletion_reasonstringReason the sign-up was cancelled.
direct_billingbooleandirect_billing_check_datestring (date-time)direct_billing_tokenstringwait_list_confirmation_sent_atstring (date-time)wait_list_confirmation_deadlinestring (date-time)wait_list_confirmed_atstring (date-time)wait_list_pending_confirmationbooleanwait_list_sort_orderintegerbirthdaystring (date-time)Birthday of the participant.
known_allergiesstringKnown allergies of the participant.
confirmed_no_allergiesbooleanGuardian confirmed that there are no known allergies.
allow_photosbooleanGuardian allows photos of the participant.
allow_child_alonebooleanParticipant may leave alone after the event.
authorized_pickupstringPersons who are allowed to pick up the participant.
needs_supportbooleanParticipant needs support, for example for inclusion.
support_descriptionstringDescription of the support the participant needs.
financial_supportbooleanParticipant receives financial support.
financial_support_numberstringNumber of the financial support, for example a voucher.
municipal_supportbooleanParticipant receives municipal support.
municipal_support_numberstringNumber of the municipal support.
grade_levelintegerSchool grade level of the participant.
school_classstringSchool class of the participant.
self_check_inbooleanParticipant checked in with the self-service check-in.
self_check_outbooleanParticipant checked out with the self-service check-out.
self_check_in_datestring (date-time)Time of the self-service check-in.
self_check_out_datestring (date-time)Time of the self-service check-out.
reminded_of_absencestring (date-time)Time the guardian was reminded of an absence.
trialbooleanTrial date sign-up (Schnuppern): a date sign-up without a course place that uses up one unit of the person's trial pass (eventAccessBudget with sourceType trial)
trial_channelstringWho booked the trial date: app, trainer, office
trial_session_numberintegerNumber of this trial date within the pass (1 = first), for "Schnuppern 2/3"
trial_session_maxintegerTrial dates of the pass, for "Schnuppern 2/3"
confirmed_datestring (date-time)Time the sign-up was confirmed.
bib_numberintegerStartnummer (Zaehler). Bei PER_PREFIX nur zusammen mit dem Praefix eindeutig. Wird nur ueber BibNumberAssigner gesetzt, stornierte Anmeldungen behalten sie.
bib_labelstringAngezeigte Startnummer inkl. Praefix, z. B. W0123. Pro Event eindeutig.
namestringName of the entity.
curl --request POST \
--url https://your-instance.iw-erp.de/api/event/trainer/base_event_signup \
--header 'content-type: application/json' \
--header 'x-iw-jwt-token: <TOKEN>' \
--data '
{
"data": {
"first_name": "Lena",
"last_name": "Hartmann",
"support_description": "Text",
"address_street": "Jakobistr. 39",
"address_city": "Hannover",
"address_zip": "30163"
}
}
'const options = {
method: 'POST',
headers: {'x-iw-jwt-token': '<TOKEN>', 'content-type': 'application/json'},
body: JSON.stringify({
data: {
first_name: 'Lena',
last_name: 'Hartmann',
support_description: 'Text',
address_street: 'Jakobistr. 39',
address_city: 'Hannover',
address_zip: '30163'
}
})
};
fetch('https://your-instance.iw-erp.de/api/event/trainer/base_event_signup', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://your-instance.iw-erp.de/api/event/trainer/base_event_signup"
payload = { "data": {
"first_name": "Lena",
"last_name": "Hartmann",
"support_description": "Text",
"address_street": "Jakobistr. 39",
"address_city": "Hannover",
"address_zip": "30163"
} }
headers = {
"x-iw-jwt-token": "<TOKEN>",
"content-type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)<?php
require_once('vendor/autoload.php');
$client = new \GuzzleHttp\Client();
$response = $client->request('POST', 'https://your-instance.iw-erp.de/api/event/trainer/base_event_signup', [
'body' => '{"data":{"first_name":"Lena","last_name":"Hartmann","support_description":"Text","address_street":"Jakobistr. 39","address_city":"Hannover","address_zip":"30163"}}',
'headers' => [
'content-type' => 'application/json',
'x-iw-jwt-token' => '<TOKEN>',
],
]);
echo $response->getBody();using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("https://your-instance.iw-erp.de/api/event/trainer/base_event_signup"),
Headers =
{
{ "x-iw-jwt-token", "<TOKEN>" },
},
Content = new StringContent("{\"data\":{\"first_name\":\"Lena\",\"last_name\":\"Hartmann\",\"support_description\":\"Text\",\"address_street\":\"Jakobistr. 39\",\"address_city\":\"Hannover\",\"address_zip\":\"30163\"}}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"data\":{\"first_name\":\"Lena\",\"last_name\":\"Hartmann\",\"support_description\":\"Text\",\"address_street\":\"Jakobistr. 39\",\"address_city\":\"Hannover\",\"address_zip\":\"30163\"}}");
Request request = new Request.Builder()
.url("https://your-instance.iw-erp.de/api/event/trainer/base_event_signup")
.post(body)
.addHeader("x-iw-jwt-token", "<TOKEN>")
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://your-instance.iw-erp.de/api/event/trainer/base_event_signup"
payload := strings.NewReader("{\"data\":{\"first_name\":\"Lena\",\"last_name\":\"Hartmann\",\"support_description\":\"Text\",\"address_street\":\"Jakobistr. 39\",\"address_city\":\"Hannover\",\"address_zip\":\"30163\"}}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-iw-jwt-token", "<TOKEN>")
req.Header.Add("content-type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}Dart with the iw_erp_api package
import 'package:iw_erp_api/clients/event_base_event_sign_up_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';
import 'package:iw_erp_api/model/event_base_event_sign_up.dart';
IwApiState().host = 'your-instance.iw-erp.de';
IwApiState().currentJwtApiToken = '<TOKEN>';
final result = await EventBaseEventSignUpController.postTrainer(EventBaseEventSignUp.fromJson({
"first_name": "Lena",
"last_name": "Hartmann",
"support_description": "Text",
"address_street": "Jakobistr. 39",
"address_city": "Hannover",
"address_zip": "30163"
}));
if (result.success) {
print(result.data);
}{
"id": 42,
"first_name": "Lena",
"last_name": "Hartmann",
"support_description": "Text",
"name": "Beispiel",
"gender": "string",
"waiting": true,
"confirmed": true,
"deletion_reason": "string",
"direct_billing": true
}Add a new MassUserNotification for the event signups in referenceIds
POST/api/event/trainer/mass_notification
Request body application/json
dataMassUserNotificationShow fields (16)
send_pushbooleanWhether push notifications should be sent.
send_mailbooleanWhether e-mails should be sent.
send_letterbooleanWhether letters should be sent.
send_smsbooleanWhether SMS messages should be sent.
send_whatsappbooleanWhether WhatsApp messages should be sent.
reference_class_namestringClass name of the records the notification refers to.
reference_idsarray<string>IDs of the records the notification refers to.
textstringThe headline of the notification
long_textstringThe text of the notification
html_textstringThe html text of the notification, overrides the long text
attachmentsarray<Attachment12>Attachments of the mass notification.
templateFlexibleLatexTemplate3Template used for the mass notification.
save_as_attachmentbooleanWhether the notification is saved as an attachment.
check_for_duplicatesbooleanWhether duplicate recipients are checked.
create_questionnaire_draftbooleanIf true, a MediaQuestionnaireAnswer draft is created (or reused) for each referenced BaseEventSignUp recipient, and its fill link is exposed as a template placeholder.
questionnaire_draft_questionnaireMediaQuestionnaire3The result-list questionnaire the per-recipient drafts are created for.
Responses
200Add a new MassUserNotification for the event signups in referenceIdsMassUserNotification2
Show fields (20)
idintegerPrimary key of the mass notification. Internal ID.
processedbooleanWhether the mass notification has been processed.
send_pushbooleanWhether push notifications should be sent.
send_mailbooleanWhether e-mails should be sent.
send_letterbooleanWhether letters should be sent.
send_smsbooleanWhether SMS messages should be sent.
send_whatsappbooleanWhether WhatsApp messages should be sent.
reference_class_namestringClass name of the records the notification refers to.
reference_idsarray<string>IDs of the records the notification refers to.
textstringThe headline of the notification
long_textstringThe text of the notification
html_textstringThe html text of the notification, overrides the long text
attachmentsarray<Attachment22>Attachments of the mass notification.
Show fields (26)
idintegerPrimary key of the attachment. Internal ID.
filenamestringOriginal file name.
filesizestringSize of the file in bytes.
mimetypestringMIME type of the file.
createdbyusernamestringName of the user who uploaded the file, as text.
createdstring (date-time)Point in time the attachment was created.
googleidstringID of the file in Google Drive.
googledownloadlinkstringDownload link of the file in Google Drive.
scopestringScope that controls who can see the attachment.
ocr_document_typestringDocument type recognized by OCR.
ocr_from_namestringSender name recognized by OCR.
ocr_from_companystringSender company recognized by OCR.
ocr_from_addressstringSender address recognized by OCR.
ocr_from_emailstringSender e-mail address recognized by OCR.
ocr_from_phonestringSender phone number recognized by OCR.
ocr_to_namestringRecipient name recognized by OCR.
ocr_to_companystringRecipient company recognized by OCR.
ocr_to_addressstringRecipient address recognized by OCR.
ocr_to_emailstringRecipient e-mail address recognized by OCR.
ocr_to_phonestringRecipient phone number recognized by OCR.
ocr_summarystringSummary of the document created by OCR.
ocr_statusstringOCR processing status: null=not processed, pending, processing, done, error
ocr_errorstringReason of the last failed or incomplete OCR run, null when it went through
ocr_processed_atstring (date-time)Point in time OCR processing finished.
virus_checkedboolean1 once the virus scan has passed for this file. The scan runs in the background (AttachmentVirusScanCommand), so a freshly uploaded file starts at 0 and stays there until it was really checked. An infected file never reaches 1 - it is deleted instead. UIs use this to decide whether a file may be handed to a user, so it must stay false until proven otherwise.
virus_checked_atstring (date-time)When the virus scan passed. Null while the file is still waiting.
templateFlexibleLatexTemplateTemplate used for the mass notification.
Show fields (35)
predefinedbooleanTrue for templates shipped by the servercontrolpanel (PredefinedFlexibleTemplateMap). Their IDs are referenced by code, so the UI offers to duplicate ("Vorlage anpassen") instead of editing them.
data_typestringData type (reference class key) the template is rendered and checked with. For predefined templates (tag IW_PFLT) this is the data type of the code that uses them.
data_type_labelstringHuman readable name of the assigned data type, null for tags that are not a known data type.
template_modestringSerialized mode so clients do not have to know that null means standard.
last_check_statusstringSummary of the last template check for list views, the full result is admin detail only.
idstringPrimary key of the template. Internal ID. Used as a string identifier.
namestringName of the template.
tagstringTag used to group templates.
mass_messagebooleanWhether the template is used for mass messages.
default_store_as_pdfbooleanWhether the generated document is stored as PDF by default.
security_scopestringScope that controls who can use the template.
security_user_access_typeintegerAccess type required to use the template.
param1stringValue of parameter 1 used in the template.
param2stringValue of parameter 2 used in the template.
param3stringValue of parameter 3 used in the template.
param4stringValue of parameter 4 used in the template.
param5stringValue of parameter 5 used in the template.
param6stringValue of parameter 6 used in the template.
param7stringValue of parameter 7 used in the template.
param8stringValue of parameter 8 used in the template.
param9stringValue of parameter 9 used in the template.
param10stringValue of parameter 10 used in the template.
default_value_param1stringDefault value of parameter 1.
default_value_param2stringDefault value of parameter 2.
default_value_param3stringDefault value of parameter 3.
default_value_param4stringDefault value of parameter 4.
default_value_param5stringDefault value of parameter 5.
default_value_param6stringDefault value of parameter 6.
default_value_param7stringDefault value of parameter 7.
default_value_param8stringDefault value of parameter 8.
default_value_param9stringDefault value of parameter 9.
default_value_param10stringDefault value of parameter 10.
deletedbooleanThis property is used to mark an entity as deleted / archived
createdstring (date-time)Point in time the entity was created.
updatedstring (date-time)Point in time the entity was last updated.
save_as_attachmentbooleanWhether the notification is saved as an attachment.
check_for_duplicatesbooleanWhether duplicate recipients are checked.
create_questionnaire_draftbooleanIf true, a MediaQuestionnaireAnswer draft is created (or reused) for each referenced BaseEventSignUp recipient, and its fill link is exposed as a template placeholder.
questionnaire_draft_questionnaireMediaQuestionnaireThe result-list questionnaire the per-recipient drafts are created for.
Show fields (34)
idintegerPrimary key of the questionnaire. Internal ID.
questionnaire_typestringType of the questionnaire, for example registration or survey.
tokenstringPublic token of the questionnaire. Used instead of the ID.
public_copyrightstringCopyright text shown with the questionnaire.
public_language_codestringLanguage of the questionnaire, for example de.
complexity_levelintegerComplexity level of the questionnaire.
public_authorstringAuthor shown to the public.
show_free_textbooleanShow a free text field.
show_attachmentbooleanShow an upload field for attachments.
require_attachmentbooleanAn attachment must be uploaded.
with_paginationbooleanShow the questionnaire page by page.
one_entry_per_personbooleanIf true, only one entry per person is allowed - only for logged-in users and table results
require_addressbooleanThe address must be entered.
require_contactbooleanContact details must be entered.
require_agebooleanThe age must be entered.
require_grade_levelbooleanThe school grade level must be entered.
start_timestring (date-time)Start of the availability of the questionnaire.
end_timestring (date-time)End of the availability of the questionnaire.
age_groupstringAge group the questionnaire is intended for.
min_ageintegerMinimum age in years.
max_ageintegerMaximum age in years.
min_grade_levelintegerMinimum school grade level.
max_grade_levelintegerMaximum school grade level.
age_toleranceintegerYears by which the age may be outside the range and still be accepted.
group_allowedbooleanWhether the questionnaire is limited to a group.
allow_self_registerbooleanWhether people can register themselves to answer the questionnaire.
allow_self_download_result_templatebooleanWhether answerers can download their own result.
clarification_enabledbooleanSecond loop after the AI comparison: answers the AI does not rate as fulfilled become clarification points (MediaQuestionnaireClarification) that are discussed with the customer and decided before the result template is created. Without it the result template follows the AI comparison directly.
createdstring (date-time)Point in time the entity was created.
updatedstring (date-time)Point in time the entity was last updated.
deletedbooleanThis property is used to mark an entity as deleted / archived
image_urlstringURL of the image of the entity.
namestringName of the entity.
slug_identifierstringSlug used in URLs of the entity.
createdstring (date-time)Point in time the entity was created.
updatedstring (date-time)Point in time the entity was last updated.
curl --request POST \
--url https://your-instance.iw-erp.de/api/event/trainer/mass_notification \
--header 'content-type: application/json' \
--header 'x-iw-jwt-token: <TOKEN>' \
--data '
{
"data": {
"send_mail": true,
"reference_class_name": "Beispiel",
"text": "Text",
"long_text": "Text",
"html_text": "Text",
"send_push": true
}
}
'const options = {
method: 'POST',
headers: {'x-iw-jwt-token': '<TOKEN>', 'content-type': 'application/json'},
body: JSON.stringify({
data: {
send_mail: true,
reference_class_name: 'Beispiel',
text: 'Text',
long_text: 'Text',
html_text: 'Text',
send_push: true
}
})
};
fetch('https://your-instance.iw-erp.de/api/event/trainer/mass_notification', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://your-instance.iw-erp.de/api/event/trainer/mass_notification"
payload = { "data": {
"send_mail": True,
"reference_class_name": "Beispiel",
"text": "Text",
"long_text": "Text",
"html_text": "Text",
"send_push": True
} }
headers = {
"x-iw-jwt-token": "<TOKEN>",
"content-type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)<?php
require_once('vendor/autoload.php');
$client = new \GuzzleHttp\Client();
$response = $client->request('POST', 'https://your-instance.iw-erp.de/api/event/trainer/mass_notification', [
'body' => '{"data":{"send_mail":true,"reference_class_name":"Beispiel","text":"Text","long_text":"Text","html_text":"Text","send_push":true}}',
'headers' => [
'content-type' => 'application/json',
'x-iw-jwt-token' => '<TOKEN>',
],
]);
echo $response->getBody();using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("https://your-instance.iw-erp.de/api/event/trainer/mass_notification"),
Headers =
{
{ "x-iw-jwt-token", "<TOKEN>" },
},
Content = new StringContent("{\"data\":{\"send_mail\":true,\"reference_class_name\":\"Beispiel\",\"text\":\"Text\",\"long_text\":\"Text\",\"html_text\":\"Text\",\"send_push\":true}}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"data\":{\"send_mail\":true,\"reference_class_name\":\"Beispiel\",\"text\":\"Text\",\"long_text\":\"Text\",\"html_text\":\"Text\",\"send_push\":true}}");
Request request = new Request.Builder()
.url("https://your-instance.iw-erp.de/api/event/trainer/mass_notification")
.post(body)
.addHeader("x-iw-jwt-token", "<TOKEN>")
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://your-instance.iw-erp.de/api/event/trainer/mass_notification"
payload := strings.NewReader("{\"data\":{\"send_mail\":true,\"reference_class_name\":\"Beispiel\",\"text\":\"Text\",\"long_text\":\"Text\",\"html_text\":\"Text\",\"send_push\":true}}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-iw-jwt-token", "<TOKEN>")
req.Header.Add("content-type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}Dart with the iw_erp_api package
import 'package:iw_erp_api/clients/event_base_event_sign_up_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';
import 'package:iw_erp_api/model/mass_notification.dart';
IwApiState().host = 'your-instance.iw-erp.de';
IwApiState().currentJwtApiToken = '<TOKEN>';
final result = await EventBaseEventSignUpController.postTrainerNotification(MassNotification.fromJson({
"send_mail": true,
"reference_class_name": "Beispiel",
"text": "Text",
"long_text": "Text",
"html_text": "Text",
"send_push": true
}));
if (result.success) {
print(result.data);
}{
"id": 42,
"send_mail": true,
"reference_class_name": "Beispiel",
"text": "Text",
"long_text": "Text",
"html_text": "Text",
"processed": true,
"send_push": true,
"send_letter": true,
"send_sms": true
}