Check
POST/registration_eligibility/check
This endpoint helps you understand a customer's options for completing a registration action on either a new or existing customer membership.
The presence of any global_restrictions means the action is impossible. The customer's active memberships are listed in membership_options, and each includes applicable restrictions and prerequisites, along with the on-allotment price for completing the registration with it.
Error Code Overview
| Code | Reasons | Provider Applicability | Customer Applicability |
|---|---|---|---|
| age_restricted | Age requirement not met. | - | appointment, class, room_rental |
| already_attending | The customer is already attending. | appointment, class, room_rental | appointment, class, room_rental |
| appointment_slot_unavailable | This appointment slot is not available | appointment, room_rental | appointment, room_rental |
| customer_registration_block | You are unable to register for events. Please contact us for more information. | - | appointment, class, room_rental |
| event_cancelled | This event is not active | appointment, class, room_rental | appointment, class, room_rental |
| event_full | The event is full. | appointment, class | appointment, class, room_rental |
| invalid_slot | invalid_slot | appointment, room_rental | appointment, room_rental |
| max_daily_checkins | The customer has reached the daily checkin limit. | checkin | checkin |
| maximum_daily_registrations | Maximum registrations reached. Cannot join waitlist because maximum registrations reached. | appointment | appointment, class, room_rental |
| maximum_daily_waitlists | Maximum waitlists reached. | - | class |
| maximum_weekly_registrations | Maximum registrations reached. Cannot join waitlist because maximum registrations reached. | appointment | appointment, class, room_rental |
| membership_blocked_after_failed_payment | The membership is blocked due to failed payments. | appointment, checkin, room_rental | appointment, checkin, class, room_rental |
| membership_blocked_manually | The membership has been manually blocked. | appointment, checkin, room_rental | appointment, checkin, class, room_rental |
| membership_completed | The membership is not active because it has been completed. | appointment, checkin, room_rental | appointment, checkin, class, room_rental |
| membership_expired | The membership is not active on this date because it has expired. | appointment, checkin, room_rental | appointment, checkin, class, room_rental |
| membership_not_applicable | This membership does not apply to this registration. | appointment, checkin, room_rental | appointment, checkin, class, room_rental |
| membership_on_hold | The membership is not active because it is on hold. | appointment, checkin, room_rental | appointment, checkin, class, room_rental |
| membership_pending | The membership is not active because it has not started yet. | appointment, checkin, room_rental | appointment, checkin, class, room_rental |
| membership_usage_restricted | The membership's usage limits have been met. | appointment, checkin, room_rental | appointment, checkin, class, room_rental |
| registrations_closed | Registrations closed. | appointment | appointment, class, room_rental |
| registrations_not_open | Registrations not open yet. | appointment | appointment, class, room_rental |
Providers
- Any provider can perform this action.
Customers
- Any customer can perform this action.
Unregistered Customers
- No access.
Request
Responses
- 200