This schema is used internally by Spark, not for OpCo integration.
Object used to describe the Marketing Events, including core event details as well as event registrations.
This JSON schema is mainly designed to display marketing events on the ecommerce website.
If the conditions in the "If" tab are respected, then the conditions in the "Then" tab should be respected. Otherwise, the conditions in the "Else" tab should be respected.
"EVENT"
If the conditions in the "If" tab are respected, then the conditions in the "Then" tab should be respected. Otherwise, the conditions in the "Else" tab should be respected.
"EVENT_REGISTRATION"
{
"eventHeader": {
"source": "OPCO",
"version": "1.0",
"scope": "EVENT"
},
"identifier": {
"eventId": "789e4567-e89b-12d3-a456-426614174000"
},
"eventDetails": {
"name": {
"fr-FR": "Meilleur événement",
"en-GB": "Best event"
},
"theme": {
"id": "456e4567-e89b-12d3-a456-426614174000",
"label": {
"fr-FR": "Evénement VIP",
"en-GB": "VIP Event"
}
},
"venue": {
"buildingId": "123e4567-e89b-12d3-a456-426614174001",
"name": "Hilton Hotel",
"capacity": 500,
"address": {
"addressLine1": "Belleboslaan 17",
"city": "Montesson",
"country": "FRA",
"postalCode": "78360",
"area": "South of France"
}
},
"type": {
"typeId": "123e4567-e89b-12d3-a456-426614174002",
"label": {
"fr-FR": "Formation",
"en-GB": "Training"
}
},
"registrationFormId": {
"fr-FR": "AXB-FR-EVENT-PPR-FR",
"en-GB": "AXB-FR-EVENT-PPR-EN"
},
"description": {
"fr-FR": "Voici la description",
"en-GB": "This is the description"
},
"allowUsersRegistration": true,
"pricingType": "PAID",
"displayPrice": true,
"price": {
"amount": 205987,
"scale": 2,
"currency": "EUR"
},
"capacity": 300,
"registrationEndDate": "2024-08-20T23:59:59Z",
"startDate": "2024-09-01T09:00:00Z",
"endDate": "2024-09-01T17:00:00Z",
"displayOnListPage": true,
"publishedStatus": "LIVE",
"displayStartDate": "2024-07-01T00:00:00Z",
"displayEndDate": "2024-09-01T23:59:59Z",
"imageUrl": "https://assets-eur.mkt.dynamics.com/dcd18fa1-bbeb-486b-b2a8-ca91bcd6baeb/digitalassets/images/24b86064-c3fc-4a6c-95c0-3529977cb365?ts=638206709748768415",
"sponsorships": [
{
"id": "123e4567-e89b-12d3-a456-426614174003",
"name": "Company A",
"description": {
"fr-FR": "Ceci est un texte décrivant l'activité du sponsor dans le détail",
"en-GB": "This is a text describing the sponsor activity in detail"
},
"displayOrder": "1"
}
]
}
}
Contains information about the event hub message, including the source, version, and scope.
Represents the origin of the event. It could be either 'OPCO' or 'SPARK_AX'.
Represents the version of the event schema. It's used to handle changes and evolution of the event structure over time.
Must be at least 1 characters long
Represents the scopes of the event. Each string is a scope that the event pertains to. The possible values are EVENT or EVENT_REGISTRATION.
Contains the unique identifier for the marketing event.
Marketing Event Id - 36 character GUID
Must be at most 36 characters long
Event Registration Id - 36 character GUID. Unique for each contact registration to an event
Must be at most 36 characters long
If the conditions in the "If" tab are respected, then the conditions in the "Then" tab should be respected. Otherwise, the conditions in the "Else" tab should be respected.
true
If the conditions in the "If" tab are respected, then the conditions in the "Then" tab should be respected. Otherwise, the conditions in the "Else" tab should be respected.
"PAID"
If the conditions in the "If" tab are respected, then the conditions in the "Then" tab should be respected. Otherwise, the conditions in the "Else" tab should be respected.
true
Name of the event displayed as a title that is translated into the eCommerce website languages
{
"fr-FR": "Meilleur événement",
"en-GB": "Best event"
}
Each additional property must conform to the following schema
Type: stringEvent Theme: This represents the theme of the event. Each Opco has got a predefined list of event Themes, e.g., Black Friday, Christmas, New Products, Valentines Day. The theme must match one name of event theme stored in Spark AX.
Event Theme Id - 36 character GUID
Must be at most 36 characters long
Translated label of the event theme
{
"fr-FR": "Evénement VIP",
"en-GB": "VIP Event"
}
Each additional property must conform to the following schema
Type: stringVenue details displaying the event location information
Event Building Id - 36 character GUID
Must be at most 36 characters long
Name of the venue (ex: building name, hotel name, etc.)
Must be at least 1 characters long
"Hilton Hotel"
Maximum capacity of the venue itself. The eventCapacity must always be less of equal to the venueCapacity.
Venue Address
According to ISO 19060, this field contains one third of the address. In most cases this usually contains the whole addres though.
"Belleboslaan 17"
City.
"Montesson"
The ISO 3166-1 alpha-3 of the country
"FRA"
Zip code.
"78360"
area
"South of France"
This represents the type of the event. Each Opco has got a predefined list of event Types. (Ex: training, commercial workshop, technical workshop
Event Type Id - 36 character GUID
Must be at most 36 characters long
Translated label of the event type
{
"fr-FR": "Formation",
"en-GB": "Training"
}
Each additional property must conform to the following schema
Type: stringRepresents the CoreMedia Form Id for each language that the event supports.
{
"fr-FR": "AXB-FR-EVENT-PPR-FR",
"en-GB": "AXB-FR-EVENT-PPR-EN"
}
Each additional property must conform to the following schema
Type: stringStored as HTML: Description of the event: stores all the details related to the event agenda, important notices, and any other relevant details to be displayed to the customers.
{
"fr-FR": "Voici la description",
"en-GB": "This is the description"
}
Each additional property must conform to the following schema
Type: stringWhen set to true, displays the registration form to the customers; false would hide it.
2 options : PAID or FREE
"PAID"
Only applicable when the PricingType = "PAID". When DisplayPrice is set to false, then the price of the event will not be displayed (a "PAID" mention will only be displayed in this case, and customers would be invited to contact the sales reps to get a custom pricing)
Event Capacity is the maximum number of registrations that an event can accept (example: nature of a technical workshop event that needs a restricted number of participants)
Whenever overdue, the registration form does not allow anymore registrants to submit an additional registration. This is usually set to the same start date of the event, or a couple of days before to stop receiving late registrations. The time is in UTC timezone
Only applicable when the PricingType = "PAID". Represents the Price of the event, in the chosen currency.
The actual unscaled amount based on list or customer
205987
The scale to be applied on the unscaled amount
2
The currency code following the ISO 4217 standard 3 letter in which the prices are being displayed
Must be at least 3 characters long
"EUR"
Start date & time of the event. The time is in UTC timezone
End date & time of the event. The time is in UTC timezone
When set to true, the event displays on the home page list of all current events. If the event is private, set this checkbox to false and the event will only be accessible via its custom URL.
Event status: DRAFT | LIVE | CANCELED | DELETED
"DRAFT"
Only applicable if Event DisplayOnListPage = true. This represents the Date at which the event will start showing on the website list of events. (ex: Events can start getting prepared 6months ahead of the event, while they only get announced & displayed a couple of weeks ahead of their start date). The time is in UTC timezone
Only applicable if EventDisplayOnListPage = true. This represents the Date at which the event will stop showing on the website list of events. (ex: If this date is overdue, then the event is hidden from the list of events). The time is in UTC timezone
This is the main image of the event. The URL must be publicly available.
Must match regular expression:https://[a-zA-Z0-9/.?=_-]+
"https://assets-eur.mkt.dynamics.com/dcd18fa1-bbeb-486b-b2a8-ca91bcd6baeb/digitalassets/images/24b86064-c3fc-4a6c-95c0-3529977cb365?ts=638206709748768415"
List of sponsors of the event
No Additional ItemsSponsorship Id - 36 character GUID
Must be at most 36 characters long
Name of the sponsor company: Account -> accountName
Short description about the sponsor to showcase their company or sponsorship details.
{
"fr-FR": "Ceci est un texte décrivant l'activité du sponsor dans le détail",
"en-GB": "This is a text describing the sponsor activity in detail"
}
Each additional property must conform to the following schema
Type: stringOrder of display of the sponsors, based on sponsorship importance (ex: 1 for the first displayed sponsor)
Registration Id - 36 character GUID: Unique identifier of the registration to the event
Must be at most 36 characters long
Marketing Event Id - 36 character GUID
Must be at most 36 characters long
Contact Id - 36 character GUID
Must be at most 36 characters long
Contact Email
Must be at least 1 characters long
Date & time at which the registrant has registered to the event by submitting the event registration form. The time is in UTC timezone
2 options : REGISTERED or CANCELED: Indicates whether the registrant is still registered or has cancelled their registration to the event.
"REGISTERED"