UNPKG

@openactive/data-models

Version:

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

www.openactive.io

openactive/data-models

135 lines • 3.01 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
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
{ "type": "HeadlineEvent", "hasId": true, "subClassOf": "#Event", "sampleId": "https://api.example.com/headline-events/12345", "shallNotInclude": [ "eventSchedule" ], "requiredOptions": [], "requiredFields": [ "type", "id", "url", "name", "location", "activity", "organizer", "startDate" ], "recommendedFields": [ "description", "image", "eventStatus", "ageRange", "genderRestriction", "leader", "level", "maximumAttendeeCapacity", "remainingAttendeeCapacity", "offers", "endDate" ], "validationMode": { "C1Request": "request", "C1Response": "response", "C1ResponseOrderItemError": "response", "C2Request": "request", "C2Response": "response", "C2ResponseOrderItemError": "response", "PRequest": "request", "PResponse": "response", "PResponseOrderItemError": "response", "BRequest": "request", "BResponse": "response", "BResponseOrderItemError": "response", "OrdersFeed": "response", "OrderProposalsFeed": "response", "OrderStatus": "response", "TestInterface": "testInterface" }, "imperativeConfiguration": { "testInterface": { "requiredFields": [ "type" ], "recommendedFields": [], "shallNotInclude": [] }, "request": { "requiredFields": [ "type", "id" ], "shallNotInclude": [ "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" ] }, "response": { "requiredFields": [ "type", "url", "name", "location", "activity", "startDate" ], "recommendedFields": [ "endDate", "duration", "ageRange", "genderRestriction", "eventStatus", "maximumAttendeeCapacity", "remainingAttendeeCapacity" ], "shallNotInclude": [ "organizer", "offers", "subEvent" ] } }, "fields": { "type": { "fieldName": "type", "requiredType": "https://schema.org/Text", "requiredContent": "HeadlineEvent" } } }