Import of ticketowner

POST{{API_BASE_URL}}/terp/v1/import/ticketowners

Import Ticket Owners

This endpoint allows you to import ticket owner information into the system.

Request Body

  • faireventId (integer or string)
    Here you can use one of the following properties of the fair event:
    - internal Id: 42 or "42"
    - unique id: "C8847785-CF69-EE11-93CF-00155D960409"
    - slug: "hmmcc23"
    - year and faireventnumber: "2023-6189" (format: YYYY-nnn)

  • faireventExternalId (string) - The external id 1 or 2 or 3 of the fairevent.
    You can also use the fairevent external id. For this you must set faireventId to null

  • articleId (integer or string)
    Here you can use one of the following properties of the article:
    - internal Id: 186 or "186"
    - unique id: "37A8A129-D669-EE11-93CF-00155D960409"

  • articleNumber (string) - The article number of the article
    You can also use the article number. For this you must set articleId to null

  • articleExternalId (string) - The external id 1 or 2 or 3 of the article.
    You can also use the article external id. For this you must set articleId and article number to null

  • importTicketLinksOrQuicodes (number) – controls whether ticket links and/or Quicodes should be created/linked during import.

    • 0 = Show none (Default)

    • 1 = Only show TicketLinks

    • 2 = Only show Quicodes

    • 3 = Show both

  • sendComfirmationMail (boolean) - Controls whether a confirmation mail is sent to the ticket owner or not. Default: true

  • TicketOwners (array) - An array of ticket owner data including their personal information, contacts, and addresses.

Each TicketOwners object contains the following properties:

  • OwnershipExternalId (string) (optional) - External Id that identifies the ticket assignment to the owner. This allows to update registration data afterwards but does not allow to assign the respective ticket to another owner.

  • ExternalId (string) - The external ID of the ticket owner.

  • FirstName (string) - The first name of the ticket owner.

  • LastName (string) - The last name of the ticket owner.

  • GenderCode (string) - The gender code of the ticket owner.

  • SalutationLookup (string) - The salutation of the ticket owner.

  • NationalityLookup (string) - The nationality of the ticket owner.

  • JobTitle (string) - The job title of the ticket owner.

  • DataObjectType (string) - The data object type.

  • Company (string) - The company of the ticket owner.

  • Info (array) - Additional information about the ticket owner.

    • Key (string) - The key of the information.

    • Value (string) - The value of the information.

  • EMail (string) - The email of the ticket owner.

  • Phone (string) - The phone number of the ticket owner.

  • Contacts (array) - An array of contacts for the ticket owner.

    • ExternalId (string) - The external ID of the contact.

    • Value (string) - The contact value.

    • ContactNameLookup (string) - The contact name lookup.

    • ContactTypeLookup (string) - The contact type lookup.

    • IsMainContact (boolean) - Indicates if it is the main contact.

    • Info (array) - Additional information about the contact.

  • Addresses (array) - An array of addresses for the ticket owner.

    • ExternalId (string) - The external ID of the address.

    • Street (string) - The street of the address.

    • StreetNumber (string) - The street number of the address.

    • Line1 (string) - The address line 1.

    • Line2 (string) - The address line 2.

    • Line3 (string) - The address line 3.

    • City (string) - The city of the address.

    • StateOrProvince (string) - The state or province of the address.

    • County (string) - The county of the address.

    • CountryLookup (string) - The country lookup of the address.

    • PostalCode (string) - The postal code of the address.

    • PostOfficeBox (string) - The post office box of the address.

    • AddressTypeLookup (string) - The address type lookup.

    • IsMainAddress (boolean) - Indicates if it is the main address.

    • Info (array) - Additional information about the address.

Response

  • The response of this request is a JSON schema. Here is the schema for the response:
{
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"importedCount": {
"type": "integer"
},
"errorCount": {
"type": "integer"
},
"failedData": {
"type": "array",
"items": {
"type": "object",
"properties": {
"ticketOwnerExternalId": {
"type": "string"
},
"message": {
"type": "string"
}
}
}
},
"importedTicketOwners": {
"type": "array",
"items": {
"type": "object",
"properties": {
"ticket": {
"type": "object",
"properties": {
"ticketNumber": {
"type": "string"
},
"ticketBarcode": {
"type": "string"
},
"regcode": {
"type": "string"
},
"ticketId": {
"type": "string"
},
"pdfTicketLink": {
"type": "string"
},
"mTicketLink": {
"type": "string"
},
"appleWalletTicketLink": {
"type": "string"
},
"googleWalletTicketLink": {
"type": "string"
},
"pdfQuicode": {
"type": "string"
},
"mTicketQuicode": {
"type": "string"
},
"walletQuicode": {
"type": "string"
}
}
},
"ticketOwner": {
"type": "object",
"properties": {
"externalID": {
"type": "string"
},
"firstName": {
"type": "string"
},
"lastName": {
"type": "string"
},
"internalId": {
"type": "integer"
},
"uniqueId": {
"type": "string"
}
}
}
}
}
}
}
}
}
}

Authentication#auth

Requires a bearer token with the matching scope. Mint via OAuth 2.0 client credentials and send it in the Authorization header.

Responses#responses

200OKImport of ticketowner