Booking Created V1

View JSON Schema

A message that is sent when a booking is created. The message contains information about the booking, the owner of the booking, the facility that the booking was made for and the players that are included in the booking. This event is triggered when a booking is created.This is data part of the message please read the event section for more information of the metadata envelop.

Properties

Name	Type	Title	Description	Required
issuerId	`string`	Issuer ID	A unique identifier for the issuer of the booking, in UUID format.Format: `"uuid"`	no
players	`object[]`	Players	List of players	yes
owner	`object`	Owner	Booking owner information	yes
booking	`object`	Booking	Booking information	yes
facility	`object`	Facility	Facility information	yes

Example

{
    "players": [
        {
            "userId": "550e8400-e29b-41d4-a716-446655440000",
            "email": "john.doe@example.com",
            "isCustomer": false
        }
    ],
    "owner": {
        "customerId": "CUST123456",
        "userId": "550e8400-e29b-41d4-a716-446655440000",
        "firstName": "John",
        "lastName": "Doe",
        "email": "john.doe@example.com",
        "address": "123 Main St",
        "city": "Anytown",
        "zipcode": "12345",
        "country": "USA",
        "nationality": "American",
        "cellphone": "+1234567890",
        "telephone": "+0987654321",
        "dateOfBirth": "1980-01-01",
        "gender": "Male",
        "isOrganization": false,
        "doNotEmail": false,
        "registrationDate": "2023-07-04T10:00:00Z"
    },
    "booking": {
        "bookingId": "1234555",
        "startTime": "2024-07-04T10:00:00Z",
        "endTime": "2024-07-04T11:00:00Z",
        "courtId": "C001",
        "courtName": "Main Court",
        "accessCode": "ACCESS1234",
        "splitPayment": true
    },
    "facility": {
        "facilityId": "2344123",
        "facilityName": "Matchi Tennis Club"
    }
}

players[]: Players

List of players

Items: Player

Player information

Item Properties

Name	Type	Title	Description	Required
userId	`string`	User ID	A unique identifier for the player, in UUID format.Format: `"uuid"`	no
email	`string`	Email	The email address of the player, in a valid email format.Format: `"email"`	no
isCustomer	`boolean`	Is Customer	Indicates whether the player is a customer.	yes

Option 1 (optional): Required Properties:

userId

Option 2 (optional): Required Properties:

Example

[
    {
        "userId": "550e8400-e29b-41d4-a716-446655440000",
        "email": "john.doe@example.com",
        "isCustomer": false
    }
]

owner: Owner

Booking owner information

Properties

Name	Type	Title	Description	Required
customerId	`string`	Customer ID	A unique identifier for the customer.	yes
userId	`string`	User ID	A unique identifier for the user, in UUID format.Format: `"uuid"`	no
firstName	`string`	First Name	The first name of the booking owner.	no
lastName	`string`	Last Name	The last name of the booking owner.	no
email	`string`	Email	The email address of the booking owner, in a valid email format.Format: `"email"`	no
address	`string`	Address	The street address of the booking owner.	no
city	`string`	City	The city where the booking owner resides.	no
zipcode	`string`	Zipcode	The postal code of the booking owner’s address.	no
country	`string`	Country	The country where the booking owner resides.	no
nationality	`string`	Nationality	The nationality of the booking owner.	no
cellphone	`string`	Cellphone	The cellphone number of the booking owner.	no
telephone	`string`	Telephone	The telephone number of the booking owner.	no
dateOfBirth	`string`	Date of Birth	The date of birth of the booking owner, in YYYY-MM-DD format.Format: `"date"`	no
gender	`string`	Gender	The gender of the booking owner.	no
isOrganization	`boolean`	Is Organization	Indicates whether the booking owner is an organization.	no
doNotEmail	`boolean`	Do Not Email	Indicates whether the booking owner should not receive emails from facility.	no
registrationDate	`string`	Registration Date	The date and time when the booking owner registered, in ISO 8601 format.Format: `"date-time"`	no

Example

{
    "customerId": "CUST123456",
    "userId": "550e8400-e29b-41d4-a716-446655440000",
    "firstName": "John",
    "lastName": "Doe",
    "email": "john.doe@example.com",
    "address": "123 Main St",
    "city": "Anytown",
    "zipcode": "12345",
    "country": "USA",
    "nationality": "American",
    "cellphone": "+1234567890",
    "telephone": "+0987654321",
    "dateOfBirth": "1980-01-01",
    "gender": "Male",
    "isOrganization": false,
    "doNotEmail": false,
    "registrationDate": "2023-07-04T10:00:00Z"
}

booking: Booking

Booking information

Properties

Name	Type	Title	Description	Required
bookingId	`string`	Booking ID	A unique identifier for the booking.	yes
startTime	`string`	Start Time	The start time of the booking, in ISO 8601 format.Format: `"date-time"`	yes
endTime	`string`	End Time	The end time of the booking, in ISO 8601 format.Format: `"date-time"`	yes
courtId	`string`	Court ID	A unique identifier for the court.	yes
courtName	`string`	Court Name	The name of the court.	yes
accessCode	`string`	Access Code	A code to access the court.	no
splitPayment	`boolean`	Split Payment	Indicates whether the booking type is a split payment booking.	no

Example

{
    "bookingId": "1234555",
    "startTime": "2024-07-04T10:00:00Z",
    "endTime": "2024-07-04T11:00:00Z",
    "courtId": "C001",
    "courtName": "Main Court",
    "accessCode": "ACCESS1234",
    "splitPayment": true
}

facility: Facility

Facility information

Properties

Name	Type	Title	Description	Required
facilityId	`string`	Facility ID	A unique identifier for the facility.	yes
facilityName	`string`	Facility Name	The name of the facility.	yes

Example

{
    "facilityId": "2344123",
    "facilityName": "Matchi Tennis Club"
}