UNPKG

@openactive/data-models

Version:

Data models used to drive that OpenActive validator, developer documentation, and model libraries

www.openactive.io

openactive/data-models

112 lines • 2.4 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
{ "type": "EventSeries", "hasId": true, "subClassOf": "#Event", "derivedFrom": "https://pending.schema.org/EventSeries", "sampleId": "https://api.example.com/event-series/12345", "requiredFields": [ "type", "name", "activity", "organizer" ], "requiredOptions": [ { "description": [ "An `id` and/or `identifier` must be provided in order to allow data users to group `EventSeries` together consistently." ], "options": [ "id", "identifier" ] } ], "recommendedFields": [ "id", "ageRange", "description", "genderRestriction", "image", "isCoached", "level", "programme" ], "shallNotInclude": [ "eventSchedule" ], "validationMode": { "C1Response": "response", "C1ResponseOrderItemError": "response", "C2Response": "response", "C2ResponseOrderItemError": "response", "PResponse": "response", "PResponseOrderItemError": "response", "BResponse": "response", "BResponseOrderItemError": "response", "OrdersFeed": "response", "OrderProposalsFeed": "response", "OrderStatus": "response" }, "imperativeConfigurationWithContext": {}, "imperativeConfiguration": { "response": { "requiredFields": [ "type", "name", "activity" ] } }, "inSpec": [ "id", "type", "identifier", "url", "name", "description", "image", "startDate", "endDate", "duration", "location", "organizer", "contributor", "maximumAttendeeCapacity", "maximumVirtualAttendeeCapacity", "remainingAttendeeCapacity", "eventStatus", "subEvent", "superEvent", "activity", "category", "ageRange", "genderRestriction", "ageRestriction", "additionalAdmissionRestriction", "customerAccountBookingRestriction", "isOpenBookingWithCustomerAccountAllowed", "programme", "attendeeInstructions", "leader", "accessibilitySupport", "accessibilityInformation", "isCoached", "level", "meetingPoint", "isAccessibleForFree", "offers", "schedulingNote", "eventAttendanceMode" ], "notInSpec": [ "startDate", "endDate" ], "fields": { "type": { "fieldName": "type", "requiredType": "https://schema.org/Text", "requiredContent": "EventSeries" } } }