GETADITUS/Attendees/Use Case Examples/Use Case – By Ticket Code

Use Case – By Ticket Code

GET{{API_BASE_URL}}/terp/v1/events/{{EVENT_ID}}/attendees?ticketCode=0333602070000017

This endpoint is used to retrieve specific personal data for an attendee of a fair event who is identified by the barcode of their ticket. This data contains details about the event and the ticket that was purchased.

User-Rools

To use this use case, the user must have the following role assigned.

  • Required role

    • ApiAttendeeGetByTicketcode
  • Optional role

    • ApiAttendeeWithAdditionalSalesInformation

Role- and Article-Based Data Access

  • Fine-grained access control:
    Third parties can only access attendee registrations for the specific badge categories (articles) and user roles that have been explicitly granted to them. For example, a matchmaking provider may only receive data for VIP and EXHIBITOR categories.

  • Standardised roles:
    The API supports a standard set of badge category roles, such as Visitor, Exhibitor, Press, Services, and more. If there are additional badge categories in the system used, corresponding roles must also be created in the system. Please note the naming convention for roles!
    Example roles include:

    • ApiAttendeeBadgeCategoryCONTRACTOR

    • ApiAttendeeBadgeCategoryCREW

    • ApiAttendeeBadgeCategoryDELEGATE

    • ApiAttendeeBadgeCategoryEXHIBITOR

    • ApiAttendeeBadgeCategoryMEDIA

    • ApiAttendeeBadgeCategoryORGANIZER

    • ApiAttendeeBadgeCategoryPRESS

    • ApiAttendeeBadgeCategorySPEAKER

    • ApiAttendeeBadgeCategorySPONSOR

    • ApiAttendeeBadgeCategorySTAFF

    • ApiAttendeeBadgeCategorySTUDENT

    • ApiAttendeeBadgeCategoryVIP

    • ApiAttendeeBadgeCategoryVISITOR

    • ApiAttendeeBadgeCategoryNONE

      • for all articles that do not have a BadgeCategory

If one of these new roles is configured, all other articles will be filtered out. BadgeCategory roles can be combined.

Block-Scoped Payloads

  • Modular response structure:
    The API response is organised into logical blocks (such as attendee, address, customFields, termsOfService, ticket, article, booth, exhibitor, additionalSalesInformation).
    Each block can be enabled or disabled based on the assigned user role.

  • Default behaviour:
    If no specific role configuration is set, a baseline set of blocks is returned (e.g., attendee, address, customFields, ticket, article, booth, exhibitor)

    • the same as before version 4.135
  • Full access roles:
    Special roles are available to grant full access to all attendee or ticket blocks:

    • ApiAttendeeWithAttendeeFullAccess (includes all attendee-related blocks)

      • ApiAttendeeWithAttendeeInformation

      • ApiAttendeeWithAddressInformation

      • ApiAttendeeWithCustomFieldsInformation

      • ApiAttendeeWithTermsOfServicesInformation

      • ApiAttendeeWithUserInformation

    • ApiAttendeeWithTicketFullAccess (includes all ticket-related blocks)

      • ApiAttendeeWithTicketsInformation

      • ApiAttendeeWithArtcleInformation

      • ApiAttendeeWithBoothInformation

      • ApiAttendeeWithExhibitorInformation

      • ApiAttendeeWithBarcodeInformation

      • ApiAttendeeWithTicketLinksInformation

      • ApiAttendeeWithTicketPromotionCodesInformation (available from version 139 or later)

      • ApiAttendeeWithTicketSalePropertiesInformation (available from version 139 or later)

If one of these new roles is configured, all other areas that are not configured will be deactivated. Roles can be combined.

Authentication#auth

This endpoint does not require authentication.

Headers#headers

Acceptapplication/json

Query parameters#query

ticketCode0333602070000017optional

use for barcode, quicode, registration code or ticketUniqueId

useOwnerEMailfalseoptional

(Optional) If this parameter is set to true, the result will also contain all other registrations we have for the barcode holder's email

includingCancellationsfalseoptional

(Optional) When set to true, the response includes cancelled tickets in addition to non-cancelled tickets. When false (or omitted), cancelled tickets are excluded from the result set.

includingBlockedTicketsfalseoptional

(Optional) When set to true, the response includes blocked tickets in addition to non-blocked tickets. When false (or omitted), blocked tickets are excluded from the result set.

ticketBarcodeIsUniqueIdfalseoptional

(Optional) Indicates whether the provided ticket code should be interpreted as a ticket barcode. Set this parameter to true (the default is false) when searching for non-ADITUS tickets whose barcode value is a GUID. Otherwise, every GUID is interpreted as an ADITUS ticket unique ID. (only from version 4.135 or higher)

Responses#responses

200OKUse Case – By Ticket Code