Activity Occasion Updated V1
Properties
Name | Type | Title | Description | Required |
---|---|---|---|---|
facility | object | Facility | Facility information | yes |
occasion | object | ActivityOccasion | yes | |
participants | object[] | 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
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"
}
occasion: ActivityOccasion
Properties
Name | Type | Title | Description | Required |
---|---|---|---|---|
type | Occasion Type | Type 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 | |
activityId | string | Activity ID | The unique identifier for the activity associated with this occasion. | yes |
activityName | string | Activity Name | The name of the activity. | yes |
[courts](#### occasion.courts[]-courts) | object[] | Courts | A list of courts where the activity occasion will take place. | yes |
endTime | string | End Time | The date and time when the activity occasion endsFormat: "date-time" | yes |
maxNumParticipants | integer | Maximum Number of Participants | The maximum number of participants allowed for this activity occasion. | no |
message | string | Message | An optional message providing additional information about the activity occasion. | no |
minNumParticipants | integer | Minimum Number of Participants | The minimum number of participants required for this activity occasion to take place. | no |
occasionId | string | Occasion ID | The unique identifier for this specific occasion. | yes |
startTime | string | Start Time | The 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
Name | Type | Title | Description | Required |
---|---|---|---|---|
courtId | string | Court ID | The unique identifier for the court. | yes |
courtName | string | Court Name | The name of the court. | yes |
sport | string | Sport | The sport played on the court. | yes |
Example
[
{
"courtId": "2344123",
"courtName": "Sponsored court nr1"
}
]
participants[]: array
Items: Customer
Customer information
Item 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 customer. | no |
lastName | string | Last Name | The last name of the customer. | no |
string | The email address of the customer, in a valid email format.Format: "email" | no | ||
address | string | Address | The street address of the customer. | no |
city | string | City | The city where the customer resides. | no |
zipcode | string | Zipcode | The postal code of the customer’s address. | no |
country | string | Country | The country where the customer resides. | no |
nationality | string | Nationality | The nationality of the customer. | no |
cellphone | string | Cellphone | The cellphone number of the customer. | no |
telephone | string | Telephone | The telephone number of the customer. | no |
dateOfBirth | string | Date of Birth | The date of birth of the customer, in YYYY-MM-DD format.Format: "date" | no |
gender | string | Gender | The gender of the customer. | no |
isOrganization | boolean | Is Organization | Indicates whether the customer is an organization. | no |
doNotEmail | boolean | Do Not Email | Indicates whether the customer should not receive emails from facility. | no |
registrationDate | string | Registration Date | The 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"
}
]