You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Correct documentation errors found in implementation review
Fix discrepancies against the current implementation: recurring
rdate/exdate format, booking listing filters and start/end semantics,
service types and sellable listings, attribute types and required
flags, missing serialized attributes, public slots response shape,
CORS prerequisite, verification code status, six digit SMS token and
outdated locale lists. Switch private API examples to Bearer auth.
Also split the pagination guide into Pagination and a new Example
Requests guide.
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01ARj1YRv8rDzdq8SHKpMHrT
<tr><td>interval_rounding</td><td>Integer</td><td>Default setting for all services for rounding to next available time. '15' will round 10:07 to become 10:15 as next available slot time.</td></tr>
<tr><td>booked_by_person_id</td><td>Integer</td><td>Only for output. Person who made the booking (e.g. parent booking for child).</td></tr>
@@ -81,7 +81,7 @@ Bookings on a waitlist are set to `waitlisted`. A waitlisted booking is not acti
81
81
82
82
## Active bookings
83
83
84
-
Bookings with states `awaiting_verification`, `awaiting_payment`, `awaiting_confirmation` or `confirmed` are considered to be active. Bookings with state `awaiting_verification` will be updated with state `verification_expired` after the current time passes `expires_at`. However updating states rely on automatic tasks so you must use the `active` attribute to check whether a booking is active or not. Only active bookings will be returned unless you specify: a booking by id, a specific state such as bookings that are awaiting confirmation, to return all bookings for a resource or dates, or for a person.
84
+
Bookings with states `awaiting_verification`, `awaiting_payment`, `awaiting_confirmation` or `confirmed` are considered to be active. Bookings with state `awaiting_verification` will be updated with state `verification_expired` after the current time passes `expires_at`. However updating states rely on automatic tasks so you must use the `active` attribute to check whether a booking is active or not. Only active bookings will be returned unless you request a booking by id, specify a specific state such as bookings that are awaiting confirmation, or use the `all`or `visible` listings.
85
85
86
86
## Listing
87
87
@@ -97,11 +97,11 @@ See query parameters for filtering the output beyond the default outputs.
97
97
98
98
`GET /bookings/all` will return all bookings of all states (including `declined`, `cancelled`, `deleted`, and `verification_expired`). This is a useful output for synchronisation when you need to keep a track of deleted bookings.
99
99
100
-
`GET /bookings/visible` will return all active bookings as well as those declinedor cancelled. This is the preferred output if you want to provide a list of all bookings for visual presentation.
100
+
`GET /bookings/visible` will return all active bookings as well as those declined, cancelled or waitlisted. This is the preferred output if you want to provide a list of all bookings for visual presentation.
101
101
102
-
`GET /bookings/no_status` will return all active bookings with no status set.
102
+
`GET /bookings/no_status` will return past confirmed bookings with a person where the status is not `completed` or `no_show`.
103
103
104
-
Response
104
+
Abbreviated response. Responses include all attributes listed above, including the full `person` object and the related `resource`, `service` and `event` objects with id and title (use the `extended` parameter for their full data).
105
105
106
106
```json
107
107
[
@@ -136,8 +136,8 @@ Response
136
136
<tr><td>resource_id</td><td>Integer or array of integers</td><td></td></tr>
137
137
<tr><td>person_id</td><td>Integer or array of integers</td><td></td></tr>
<tr><td>start</td><td>Datetime</td><td>booked_from after param. Also accepts the values now and today.</td></tr>
140
-
<tr><td>end</td><td>Datetime</td><td>booked_to before param. Also accepts the values now and today.</td></tr>
139
+
<tr><td>start</td><td>Datetime</td><td>booked_to after param. Combine with end to return all bookings that overlap the period. Also accepts the values now and today.</td></tr>
140
+
<tr><td>end</td><td>Datetime</td><td>booked_from before param. Also accepts the values now and today.</td></tr>
141
141
<tr><td>since</td><td>Datetime</td><td>updated_at after param. Also accepts the values now and today.</td></tr>
Copy file name to clipboardExpand all lines: _endpoints/people.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -77,7 +77,7 @@ Response
77
77
78
78
### Query Parameters
79
79
80
-
You can search multiple columns at once, for example `email` and `phone_number`, or you can use the shorthand `search` to search email, phone number, national id no or name.
80
+
You can search multiple columns at once, for example `email` and `phone_number` — people matching any of the specified columns are returned. Or you can use the shorthand `search` to search email, phone number, national id no or name.
@@ -131,7 +131,7 @@ Please note that this token is perishable, meaning that it will be removed from
131
131
132
132
### Send perishable token
133
133
134
-
`POST /people/perishable_token/send` will send a SMS with a five digit code (the token) or an email with a link which includes the token in the URL. Specify either `email` or `phone_number`.
134
+
`POST /people/perishable_token/send` will send a SMS with a six digit code (the token) or an email with a link which includes the token in the URL. Specify either `email` or `phone_number`.
Copy file name to clipboardExpand all lines: _endpoints/resource-exception-dates.md
+5-4Lines changed: 5 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,7 +11,7 @@ If a resource should be closed for a week then you would add resource exception
11
11
If a resource should have opening hours 08:00 to 14:00 on January 5th 2016 instead of the default opening hours for that weekday which could be 09:00 to 15:00, then add it as a resource exception date.
12
12
See [resource opening hours](/endpoints/resources/#default-opening-hours) for how to specify.
13
13
14
-
A `null` value will fallback to the default availability for the resource. An empty array means the resource is closed on the specified exception date.
14
+
A `null` value or an empty array means the resource is closed on the specified exception date. To fall back to the default availability for the resource, delete the exception date.
15
15
16
16
Exception dates are related to a resource: `GET /resources/{resource_id}/exception_dates`.
17
17
@@ -37,7 +37,7 @@ An exception date without `service_id` applies to the resource. All endpoints be
37
37
38
38
## Listing
39
39
40
-
`GET /resources/{resource_id}/exception_dates` will return all exception dates for resource with id `{resource_id}`.
40
+
`GET /resources/{resource_id}/exception_dates` will return exception dates for resource with id `{resource_id}` within the specified period. Without `from` and `to` only the current week is returned.
<tr><td>from</td><td>Date</td><td>Default: beginning of the current week.</td></tr>
64
+
<tr><td>to</td><td>Date</td><td>Default: end of the current week.</td></tr>
64
65
<tr><td>service_id</td><td>Integer</td><td>Return exception dates scoped to this service. When not set only resource exception dates are returned.</td></tr>
@@ -58,13 +61,19 @@ Attendance at an event is also a booking but the individual booking datetime or
58
61
<tr><td>priority_strategy</td><td>String</td><td>Not required. Strategy for resource priority assignment.</td></tr>
59
62
<tr><td>availability_type</td><td>String</td><td>Not required. Values: resource (default), provider. With resource the opening hours on the resource are used. With provider the opening hours on the [provider](/endpoints/providers/) are used.</td></tr>
60
63
<tr><td>priority_value</td><td>Integer</td><td>Not required. Priority value for ordering.</td></tr>
64
+
<tr><td>quota</td><td>Integer</td><td>Number of uses. Required for subscription and pass unless `unlimited` is true. Not applicable for other types.</td></tr>
65
+
<tr><td>unlimited</td><td>Boolean</td><td>Unlimited number of uses. Only applicable for subscription and pass. Default: false.</td></tr>
66
+
<tr><td>billing_period</td><td>Integer</td><td>Required for subscription. Not applicable for other types.</td></tr>
67
+
<tr><td>renewal_price</td><td>Decimal</td><td>Only applicable for subscription.</td></tr>
68
+
<tr><td>validity_days</td><td>Integer</td><td>Number of days the pass is valid. Required for unlimited passes. Only applicable for pass.</td></tr>
69
+
<tr><td>linked_service_ids</td><td>Array</td><td>Ids of linked services.</td></tr>
0 commit comments