Skip to content
Developer

BibNumber

Events5 EndpointsEvent / BibNumber

Stats of the bib numbers of an event: mode, assigned, pending and usage per range.

GET/api/event/base_event/{identifier}/bib_number/stats

Path parameters

identifierrequiredstring

Responses

200Bib number stats

Request
curl --request GET \
  --url https://your-instance.iw-erp.de/api/event/base_event/42/bib_number/stats \
  --header 'x-iw-jwt-token: <TOKEN>'

Assigns numbers to every sign up of the event without one. With dry_run only the preview is returned.

POST/api/event/base_event/{identifier}/bib_number/assign

Path parameters

identifierrequiredstring

Request body application/json

  • sort_modestring

    Allowed: CREATED LAST_NAME BIRTHDAY AGE_CLASS COMPANY

  • dry_runboolean
  • only_confirmedboolean

Responses

200Assigned and skipped sign ups

Request
curl --request POST \
  --url https://your-instance.iw-erp.de/api/event/base_event/42/bib_number/assign \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "sort_mode": "CREATED",
  "dry_run": true,
  "only_confirmed": true
}
'

Exchanges the numbers of two sign ups of the event.

POST/api/event/base_event/{identifier}/bib_number/swap

Path parameters

identifierrequiredstring

Request body application/json

  • sign_up_ainteger
  • sign_up_binteger

Responses

200success

Request
curl --request POST \
  --url https://your-instance.iw-erp.de/api/event/base_event/42/bib_number/swap \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "sign_up_a": 1,
  "sign_up_b": 1
}
'

Sets or removes the bib number and/or the chip code of a sign up. Only the keys sent are changed.

PUT/api/event/base_event_signup/{identifier}/bib_number

Path parameters

identifierrequiredstring

Request body application/json

  • bib_labelstring
  • chip_codestring

Responses

200The updated sign upBaseEventSignUp10

Show fields (54)
  • bib_range_idinteger
  • age_classstring

    Altersklasse nach DLV, z. B. M40 - berechnet aus Geburtstag, Geschlecht und Eventdatum.

  • idinteger

    Primary key of the sign-up. Internal ID.

  • genderstring

    Gender of the participant.

  • tokenstring

    Public token of the sign-up. Used in links instead of the ID.

  • moments_tokenstring

    Participant-bound moments token: allows this participant to use the event moments (digital guestbook) page; uploads via this token are linked to the participant.

  • waitingboolean

    The sign-up is on the waiting list.

  • confirmedboolean

    The sign-up is confirmed.

  • externalboolean

    The sign-up was made by an external party.

  • deletion_reasonstring

    Reason the sign-up was cancelled.

  • billedboolean

    The sign-up was billed.

  • direct_billingboolean
  • direct_billing_check_datestring (date-time)
  • direct_billing_tokenstring
  • wait_list_confirmation_tokenstring
  • wait_list_confirmation_sent_atstring (date-time)
  • wait_list_confirmation_deadlinestring (date-time)
  • wait_list_confirmed_atstring (date-time)
  • wait_list_pending_confirmationboolean
  • wait_list_sort_orderinteger
  • birthdaystring (date-time)

    Birthday of the participant.

  • trialboolean

    Trial 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_channelstring

    Who booked the trial date: app, trainer, office

  • trial_session_numberinteger

    Number of this trial date within the pass (1 = first), for "Schnuppern 2/3"

  • trial_session_maxinteger

    Trial dates of the pass, for "Schnuppern 2/3"

  • nace_sectionstring

    NACE section code (letter A-U)

  • nace_codestring

    NACE code (numeric like 01.11, 62.01)

  • bib_numberinteger

    Startnummer (Zaehler). Bei PER_PREFIX nur zusammen mit dem Praefix eindeutig. Wird nur ueber BibNumberAssigner gesetzt, stornierte Anmeldungen behalten sie.

  • bib_labelstring

    Angezeigte Startnummer inkl. Praefix, z. B. W0123. Pro Event eindeutig.

  • bib_number_assigned_atstring (date-time)

    Time the bib number was assigned.

  • chip_codestring

    Transponder- oder QR-Kennung fuer die Zeitmessung. Pro Event eindeutig.

  • timing_tracking_consentboolean

    Einwilligung 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.

  • addressstring

    Address as text.

  • address_streetstring

    Street of the address.

  • address_house_numberstring

    House number of the address.

  • address_street_levelstring

    Street and house number of the address.

  • address_costring

    Care-of line of the address.

  • address_citystring

    City of the address.

  • address_zipstring

    Postal code of the address.

  • address_admin_level1string

    First administrative level of the address, e.g. the federal state.

  • address_countrystring

    Country code of the address.

  • address_full_countrystring

    Full name of the country of the address.

  • address_geo_latstring

    Latitude of the address.

  • address_geo_lngstring

    Longitude of the address.

  • address_external_provider_idstring

    field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE

  • namestring

    Name of the entity.

  • main_phonestring

    Main phone number.

  • main_faxstring

    Main fax number.

  • main_emailstring

    Main e-mail address.

  • websitestring

    Website address.

  • deletedboolean

    This property is used to mark an entity as deleted / archived

  • orderinteger

    Position of the entity in the order.

Request
curl --request PUT \
  --url https://your-instance.iw-erp.de/api/event/base_event_signup/42/bib_number \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "bib_label": "string",
  "chip_code": "string"
}
'
Response 200 application/json
{
  "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
}

Sets or removes the bib number and/or the chip code of a sign up. Only the keys sent are changed.

PATCH/api/event/base_event_signup/{identifier}/bib_number

Path parameters

identifierrequiredstring

Request body application/json

  • bib_labelstring
  • chip_codestring

Responses

200The updated sign upBaseEventSignUp10

Show fields (54)
  • bib_range_idinteger
  • age_classstring

    Altersklasse nach DLV, z. B. M40 - berechnet aus Geburtstag, Geschlecht und Eventdatum.

  • idinteger

    Primary key of the sign-up. Internal ID.

  • genderstring

    Gender of the participant.

  • tokenstring

    Public token of the sign-up. Used in links instead of the ID.

  • moments_tokenstring

    Participant-bound moments token: allows this participant to use the event moments (digital guestbook) page; uploads via this token are linked to the participant.

  • waitingboolean

    The sign-up is on the waiting list.

  • confirmedboolean

    The sign-up is confirmed.

  • externalboolean

    The sign-up was made by an external party.

  • deletion_reasonstring

    Reason the sign-up was cancelled.

  • billedboolean

    The sign-up was billed.

  • direct_billingboolean
  • direct_billing_check_datestring (date-time)
  • direct_billing_tokenstring
  • wait_list_confirmation_tokenstring
  • wait_list_confirmation_sent_atstring (date-time)
  • wait_list_confirmation_deadlinestring (date-time)
  • wait_list_confirmed_atstring (date-time)
  • wait_list_pending_confirmationboolean
  • wait_list_sort_orderinteger
  • birthdaystring (date-time)

    Birthday of the participant.

  • trialboolean

    Trial 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_channelstring

    Who booked the trial date: app, trainer, office

  • trial_session_numberinteger

    Number of this trial date within the pass (1 = first), for "Schnuppern 2/3"

  • trial_session_maxinteger

    Trial dates of the pass, for "Schnuppern 2/3"

  • nace_sectionstring

    NACE section code (letter A-U)

  • nace_codestring

    NACE code (numeric like 01.11, 62.01)

  • bib_numberinteger

    Startnummer (Zaehler). Bei PER_PREFIX nur zusammen mit dem Praefix eindeutig. Wird nur ueber BibNumberAssigner gesetzt, stornierte Anmeldungen behalten sie.

  • bib_labelstring

    Angezeigte Startnummer inkl. Praefix, z. B. W0123. Pro Event eindeutig.

  • bib_number_assigned_atstring (date-time)

    Time the bib number was assigned.

  • chip_codestring

    Transponder- oder QR-Kennung fuer die Zeitmessung. Pro Event eindeutig.

  • timing_tracking_consentboolean

    Einwilligung 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.

  • addressstring

    Address as text.

  • address_streetstring

    Street of the address.

  • address_house_numberstring

    House number of the address.

  • address_street_levelstring

    Street and house number of the address.

  • address_costring

    Care-of line of the address.

  • address_citystring

    City of the address.

  • address_zipstring

    Postal code of the address.

  • address_admin_level1string

    First administrative level of the address, e.g. the federal state.

  • address_countrystring

    Country code of the address.

  • address_full_countrystring

    Full name of the country of the address.

  • address_geo_latstring

    Latitude of the address.

  • address_geo_lngstring

    Longitude of the address.

  • address_external_provider_idstring

    field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE

  • namestring

    Name of the entity.

  • main_phonestring

    Main phone number.

  • main_faxstring

    Main fax number.

  • main_emailstring

    Main e-mail address.

  • websitestring

    Website address.

  • deletedboolean

    This property is used to mark an entity as deleted / archived

  • orderinteger

    Position of the entity in the order.

Request
curl --request PATCH \
  --url https://your-instance.iw-erp.de/api/event/base_event_signup/42/bib_number \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "bib_label": "string",
  "chip_code": "string"
}
'
Response 200 application/json
{
  "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
}