Activity Occasion Updated V1

View JSON Schema

Properties

NameTypeTitleDescriptionRequired
facilityobjectFacilityFacility informationyes
occasionobjectActivityOccasionyes
participantsobject[]yes

Example

{
    "facility": {
        "facilityId": "2344123",
        "facilityName": "Matchi Tennis Club"
    },
    "occasion": {
        "courts": [
            {
                "courtId": "2344123",
                "courtName": "Sponsored court nr1"
            }
        ]
    },
    "participants": [
        {
            "customerId": "12345",
            "userId": "123e4567-e89b-12d3-a456-426614174000",
            "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": true,
            "registrationDate": "2023-01-01T12:00:00Z"
        }
    ]
}

facility: Facility

Facility information

Properties

NameTypeTitleDescriptionRequired
facilityIdstringFacility IDA unique identifier for the facility.yes
facilityNamestringFacility NameThe name of the facility.yes

Example

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

occasion: ActivityOccasion

Properties

NameTypeTitleDescriptionRequired
typeOccasion TypeType of occasion. Main type is separated from subtype via a colon (:). For example, COMPETITION:AMERICANO.Enum: "NONE", "UNKNOWN", "COMPETITION:AMERICANO", "COMPETITION:MEXICANO", "COMPETITION:BEAT_THE_BOX", "COMPETITION:CHAMPION_OF_THE_COURT", "TRAINING:BALL_MACHINE", "TRAINING:PRIVATE", "TRAINING:GROUP"yes
activityIdstringActivity IDThe unique identifier for the activity associated with this occasion.yes
activityNamestringActivity NameThe name of the activity.yes
[courts](#### occasion.courts[]-courts)object[]CourtsA list of courts where the activity occasion will take place.yes
endTimestringEnd TimeThe date and time when the activity occasion endsFormat: "date-time"yes
maxNumParticipantsintegerMaximum Number of ParticipantsThe maximum number of participants allowed for this activity occasion.no
messagestringMessageAn optional message providing additional information about the activity occasion.no
minNumParticipantsintegerMinimum Number of ParticipantsThe minimum number of participants required for this activity occasion to take place.no
occasionIdstringOccasion IDThe unique identifier for this specific occasion.yes
startTimestringStart TimeThe date and time when the activity occasion starts, in ISO 8601 format.Format: "date-time"yes

Example

{
    "courts": [
        {
            "courtId": "2344123",
            "courtName": "Sponsored court nr1"
        }
    ]
}

occasion.courts[]: Courts

A list of courts where the activity occasion will take place.

Items: Court

Item Properties

NameTypeTitleDescriptionRequired
courtIdstringCourt IDThe unique identifier for the court.yes
courtNamestringCourt NameThe name of the court.yes
sportstringSportThe sport played on the court.yes

Example

[
    {
        "courtId": "2344123",
        "courtName": "Sponsored court nr1"
    }
]

participants[]: array

Items: Customer

Customer information

Item Properties

NameTypeTitleDescriptionRequired
customerIdstringCustomer IDA unique identifier for the customer.yes
userIdstringUser IDA unique identifier for the user, in UUID format.Format: "uuid"no
firstNamestringFirst NameThe first name of the customer.no
lastNamestringLast NameThe last name of the customer.no
emailstringEmailThe email address of the customer, in a valid email format.Format: "email"no
addressstringAddressThe street address of the customer.no
citystringCityThe city where the customer resides.no
zipcodestringZipcodeThe postal code of the customer’s address.no
countrystringCountryThe country where the customer resides.no
nationalitystringNationalityThe nationality of the customer.no
cellphonestringCellphoneThe cellphone number of the customer.no
telephonestringTelephoneThe telephone number of the customer.no
dateOfBirthstringDate of BirthThe date of birth of the customer, in YYYY-MM-DD format.Format: "date"no
genderstringGenderThe gender of the customer.no
isOrganizationbooleanIs OrganizationIndicates whether the customer is an organization.no
doNotEmailbooleanDo Not EmailIndicates whether the customer should not receive emails from facility.no
registrationDatestringRegistration DateThe date and time when the customer registered, in ISO 8601 format.Format: "date-time"no

Example

[
    {
        "customerId": "12345",
        "userId": "123e4567-e89b-12d3-a456-426614174000",
        "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": true,
        "registrationDate": "2023-01-01T12:00:00Z"
    }
]