{"openapi":"3.0.1","info":{"title":"Purchase API","version":"5.0.0"},"servers":[{"url":"https://{api_url}/api/v5","variables":{"api_url":{"default":"example.jrni.com"}}}],"tags":[{"name":"Purchase"},{"name":"Booking"}],"paths":{"/purchases/{id}":{"delete":{"tags":["Purchase"],"summary":"Delete (Cancel) All Bookings associated with a given Purchase","operationId":"deleteV5PurchasesId","parameters":[{"name":"email","in":"query","schema":{"type":"boolean","default":true}},{"name":"include_cancelled","in":"query","description":"Include the bookings that were just cancelled","schema":{"type":"boolean"}},{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"204":{"description":"Delete (Cancel) All Bookings associated with a given Purchase","content":{}}}}},"/purchases/{obfuscated_id}":{"get":{"tags":["Purchase"],"summary":"Purchase Read","description":"Get a Specific Purchase","operationId":"getV5PurchasesObfuscatedId","parameters":[{"name":"obfuscated_id","in":"path","description":"Purchase id","required":true,"schema":{"type":"string"}},{"name":"include_cancelled","in":"query","description":"Include cancelled","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Purchase Read","content":{}}}}},"/purchases/{obfuscated_id}/attendees":{"get":{"tags":["Purchase"],"summary":"Obtains Attendees of Booking","description":"Obtains booking's attendees after it was added to booking","operationId":"getV5PurchasesObfuscatedIdAttendees","parameters":[{"name":"obfuscated_id","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"","content":{"application/vnd.bookingbug-hal-v2+json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/AttendeeCollection"}},"application/vnd.bookingbug-nolinks-v2+json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/AttendeeCollection"}}}}}},"post":{"tags":["Purchase"],"summary":"Add Attendees To Booking","description":"Add attendee to booking","operationId":"postV5PurchasesObfuscatedIdAttendees","parameters":[{"name":"obfuscated_id","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"required":["type"],"type":"object","properties":{"name":{"type":"string","description":"Attendee full name"},"first_name":{"type":"string","description":"Attendee first name"},"last_name":{"type":"string","description":"Attendee last name"},"telephone":{"type":"string","description":"Attendee telephone"},"consent":{"type":"boolean","description":"We have permission to store the attende data"},"relationship":{"type":"string","description":"Attendee relationship (i.e) lawyer, friend, or partner"},"type":{"type":"string","description":"customer, staff","enum":["customer"]},"email":{"type":"string","description":"Attendee email"},"notify_member":{"type":"boolean","description":"Send a notification to the main booker","default":true},"notify_attendees":{"type":"boolean","description":"Send a notification to the attendee","default":true}}}}},"required":true},"responses":{"201":{"description":"","content":{"application/vnd.bookingbug-hal-v2+json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/Attendee"}},"application/vnd.bookingbug-nolinks-v2+json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/Attendee"}}}}}}},"/purchases/{obfuscated_id}/attendees/{attendee_id}":{"put":{"tags":["Purchase"],"summary":"Modify Attendee","description":"Modifies an attendee of the booking","operationId":"putV5PurchasesObfuscatedIdAttendeesAttendeeId","parameters":[{"name":"obfuscated_id","in":"path","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"attendee_id","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Attendee full name"},"first_name":{"type":"string","description":"Attendee first name"},"last_name":{"type":"string","description":"Attendee last name"},"telephone":{"type":"string","description":"Attendee telephone"},"relationship":{"type":"string","description":"Attendee relationship (i.e) lawyer, friend, or partner"},"type":{"type":"string","description":"customer, staff"},"email":{"type":"string","description":"Attendee email"},"notify_member":{"type":"boolean","description":"Send a notification to the main booker","default":true}}}}}},"responses":{"200":{"description":"","content":{"application/vnd.bookingbug-hal-v2+json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/Attendee"}},"application/vnd.bookingbug-nolinks-v2+json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/Attendee"}}}}}},"delete":{"tags":["Purchase"],"summary":"Remove Attendee","description":"Deletes booking's attendees after it was added to booking","operationId":"deleteV5PurchasesObfuscatedIdAttendeesAttendeeId","parameters":[{"name":"notify_member","in":"query","description":"Send a notification to the main booker","schema":{"type":"boolean","default":true}},{"name":"notify_attendees","in":"query","description":"Send a notification to the attendee","schema":{"type":"boolean","default":true}},{"name":"obfuscated_id","in":"path","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"attendee_id","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"204":{"description":"Remove Attendee","content":{}}}}},"/purchases/{purchase_id}/bookings/{id}":{"get":{"tags":["Booking"],"description":"Booking Read","operationId":"getV5PurchasesPurchaseIdBookingsId","parameters":[{"name":"id","in":"path","description":"Booking ID","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"purchase_id","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Booking","content":{"application/vnd.bookingbug-hal-v2+json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/Booking"}},"application/vnd.bookingbug-nolinks-v2+json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/Booking"}}}}}},"put":{"tags":["Booking"],"description":"Update Booking","operationId":"putV5PurchasesPurchaseIdBookingsId","parameters":[{"name":"purchase_id","in":"path","description":"Purchase ID","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/putV5PurchasesPurchaseIdBookings"}}},"required":true},"responses":{"200":{"description":"Update Booking","content":{}},"401":{"description":"When the member is not authenticated","content":{"application/vnd.bookingbug-hal-v2+json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/Booking"}},"application/vnd.bookingbug-nolinks-v2+json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/Booking"}}}},"403":{"description":"Forbidden","content":{"application/vnd.bookingbug-hal-v2+json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/Booking"}},"application/vnd.bookingbug-nolinks-v2+json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/Booking"}}}},"404":{"description":"When the total does not exist<br/>When the space does not exist","content":{"application/vnd.bookingbug-hal-v2+json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/Booking"}},"application/vnd.bookingbug-nolinks-v2+json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/Booking"}}}}},"x-codegen-request-body-name":"V5PurchasesPurchaseIdBookings"},"delete":{"tags":["Booking"],"description":"Delete (Cancel) Booking","operationId":"deleteV5PurchasesPurchaseIdBookingsId","parameters":[{"name":"email","in":"query","schema":{"type":"boolean","default":true}},{"name":"cancel_reason","in":"query","description":"Reason for Cancelling the Booking","schema":{"type":"integer","format":"int32"}},{"name":"purchase_id","in":"path","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"204":{"description":"Delete (Cancel) Booking","content":{}}}}},"/purchases/{purchase_id}/bookings/confirm_waitlist":{"post":{"tags":["Booking"],"summary":"Confirm Waitlist Event Registration","description":"Confirms a waitlisted event registration.","operationId":"postV5PurchasesPurchaseIdBookingsConfirmWaitlist","parameters":[{"name":"purchase_id","in":"path","description":"Purchase ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"notify_member":{"type":"boolean","description":"Send notification to the member","default":true}}}}}},"responses":{"200":{"description":"Waitlist event registration confirmed successfully","content":{}},"400":{"description":"Invalid registration - no waitlisted attendees found or insufficient capacity","content":{}},"404":{"description":"Event registration not found","content":{}}}}},"/purchases/{purchase_id}/bookings/{id}/confirm":{"put":{"tags":["Booking"],"description":"Confirm Booking","operationId":"putV5PurchasesPurchaseIdBookingsIdConfirm","parameters":[{"name":"purchase_id","in":"path","description":"Purchase ID","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Confirm Booking","content":{}},"401":{"description":"When the member is not authenticated","content":{"application/vnd.bookingbug-hal-v2+json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/Booking"}},"application/vnd.bookingbug-nolinks-v2+json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/Booking"}}}},"403":{"description":"Forbidden","content":{"application/vnd.bookingbug-hal-v2+json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/Booking"}},"application/vnd.bookingbug-nolinks-v2+json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/Booking"}}}},"404":{"description":"When the total does not exist<br/>When the space does not exist","content":{"application/vnd.bookingbug-hal-v2+json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/Booking"}},"application/vnd.bookingbug-nolinks-v2+json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/Booking"}}}}}}}},"components":{"schemas":{"putV5PurchasesPurchaseIdBookings":{"type":"object","properties":{"datetime":{"type":"string","description":"ISO8601 DateTime","format":"date-time"},"duration":{"type":"integer","description":"New duration for Booking (defaults to current duration)","format":"int32"},"person_id":{"type":"integer","description":"ID for new staff member (defaults to current staff member ID)","format":"int32"},"resource_id":{"type":"integer","description":"ID for new resource (defaults to current resource ID)","format":"int32"},"service_id":{"type":"integer","description":"ID for new service (defaults to current service ID)","format":"int32"},"notify":{"type":"boolean","description":"Send email to client","default":true},"notify_admin":{"type":"boolean","description":"Send email to admin","default":true},"status":{"type":"string","description":"New status for the booking (defaults to the current status; options are 1 for enquired, 4 for booked, 2 for reserved)"},"position":{"type":"integer","description":"Position in Queue","format":"int32"},"attended":{"type":"boolean","description":"Set the attended flag to true or false"},"price":{"type":"integer","description":"Price of the booking","format":"int32"},"paid":{"type":"integer","description":"Amount of the booking that has been paid for","format":"int32"},"child_client_ids":{"type":"array","description":"List of other staff attending","items":{"type":"integer","format":"int32"}},"private_note":{"type":"string","description":"Private Note"},"current_multi_status":{"type":"string","description":"Multi Status"},"move_reason":{"type":"integer","description":"Reason for moving the booking","format":"int32"},"update_reason":{"type":"string","description":"Provides the reason why the booking was updated e.g. 'The customer requested the booking to be moved to a different time as they were unable to attend the original time.'"},"client_id":{"type":"integer","description":"A new client to move this booking to","format":"int32"},"client":{"type":"object","properties":{"id":{"type":"integer","description":"A new client to move this booking to","format":"int32"}}},"assets":{"type":"array","items":{"type":"object","properties":{"company_id":{"type":"integer","format":"int32"},"person_id":{"type":"integer","format":"int32"},"resource_id":{"type":"integer","format":"int32"},"pre_time":{"type":"integer","description":"Pre Time. Overrides service configuration","format":"int32"},"post_time":{"type":"integer","description":"Post Time. Overrides service configuration","format":"int32"},"resource_group_id":{"type":"integer","description":"Resource Group ID","format":"int32"},"person_group_id":{"type":"integer","description":"Person Group ID","format":"int32"}}}},"requested_assets":{"type":"array","items":{"type":"object","properties":{}}},"attendees":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Attendee full name"},"first_name":{"type":"string","description":"Attendee first name"},"last_name":{"type":"string","description":"Attendee last name"},"telephone":{"type":"string","description":"Attendee telephone"},"relationship":{"type":"string","description":"Attendee relationship (i.e) lawyer, friend, or partner"},"type":{"type":"string","description":"Type"},"email":{"type":"string","description":"Attendee email"},"notify_member":{"type":"boolean","description":"Send a notification to the main booker"}}}}},"description":"Update Booking"},"Attendee":{"type":"object","properties":{"id":{"type":"string","example":"5896-658995-65893"},"first_name":{"type":"string","example":"John"},"last_name":{"type":"string","example":"Smith"},"email":{"type":"string","example":"john@smith.com"},"telephone":{"type":"string","example":"+447 956 235 789"},"relationship":{"type":"string","example":"friend, lawyer"},"type":{"type":"string","example":"external"},"primary_attendee":{"type":"boolean","example":false},"name":{"type":"string","example":"John Smith"},"consent":{"type":"boolean","example":false},"created_at":{"type":"string","example":"null"},"extra":{"type":"object","properties":{},"example":"{\"any\": \"additional data\"}"}},"description":"Modifies an attendee of the booking"},"AttendeeCollection":{"type":"object","properties":{"_embedded":{"type":"object","properties":{"attendees":{"type":"array","items":{"type":"string"},"example":null}}}},"description":"Obtains booking's attendees after it was added to booking"},"Booking":{"type":"object","properties":{"id":{"type":"string","example":"null"},"full_describe":{"type":"string","example":"null"},"describe":{"type":"string","example":"null"},"resource_name":{"type":"string","example":"null"},"person_name":{"type":"string","example":"null"},"datetime":{"type":"string","example":"null"},"end_datetime":{"type":"string","example":"null"},"duration":{"type":"string","example":"null"},"duration_span":{"type":"string","example":"null"},"listed_duration":{"type":"string","example":"null"},"on_waitlist":{"type":"string","example":"null"},"company_id":{"type":"string","example":"null"},"attended":{"type":"string","example":"null"},"price":{"type":"string","example":"null"},"original_price":{"type":"string","example":"null"},"due_now":{"type":"string","example":"null"},"paid":{"type":"string","example":"null"},"quantity":{"type":"string","example":"null"},"event_id":{"type":"string","example":"null"},"session_id":{"type":"string","example":"null"},"service_id":{"type":"string","example":"null"},"purchase_id":{"type":"string","example":"null"},"purchase_ref":{"type":"string","example":"null"},"settings":{"type":"string","example":"null"},"slot_settings":{"type":"string","example":"null"},"min_cancellation_time":{"type":"string","example":"null"},"service_name":{"type":"string","example":"null"},"category_name":{"type":"string","example":"null"},"time_zone":{"type":"string","example":"null"},"ticket_name":{"type":"string","example":"null"},"address":{"type":"string","example":"null"},"booking_type":{"type":"string","example":"null"},"slot_id":{"type":"string","example":"null"},"first_name":{"type":"string","example":"null"},"first_name_extra":{"type":"string","example":"null"},"last_name":{"type":"string","example":"null"},"last_name_extra":{"type":"string","example":"null"},"email":{"type":"string","example":"null"},"coupon_paid":{"type":"string","example":"null"},"coupon_title":{"type":"string","example":"null"},"coupon_code":{"type":"string","example":"null"},"tickets":{"type":"string","example":"null"},"recurrence_type":{"type":"string","example":"null"},"num_bookings":{"type":"string","example":"null"},"remaining":{"type":"string","example":"null"},"is_cancelled":{"type":"string","example":"null"},"private_note":{"type":"string","example":"null"},"channel":{"type":"string","example":"null"},"user_id":{"type":"string","example":"null"},"unpaid_cancel_time":{"type":"string","example":"null"},"_embedded":{"type":"object","properties":{"answers":{"type":"array","items":{"type":"string"},"example":null},"survey_answers":{"type":"array","items":{"type":"string"},"example":null}}},"person_id":{"type":"string","example":"null"},"person_ids":{"type":"string","example":"null"},"checked_in":{"type":"string","example":"null"},"check_in_code":{"type":"string","example":"null"},"price_in_major_units":{"type":"string","example":"null"},"original_price_in_major_units":{"type":"string","example":"null"},"paid_in_major_units":{"type":"string","example":"null"},"due_now_in_major_units":{"type":"string","example":"null"},"method_of_appointment":{"type":"string","example":"null"},"source":{"type":"string","example":"null"},"medium":{"type":"string","example":"null"},"campaign":{"type":"string","example":"null"},"assets":{"type":"string","example":"null"},"status":{"type":"string","example":"null"},"member_can_confirm_now":{"type":"string","example":"null"},"member_will_need_to_confirm_in_the_future":{"type":"string","example":"null"},"notification_preferences":{"type":"string","example":"null"}},"description":"Update Booking"},"PrePaidBooking":{"type":"object","properties":{"id":{"type":"integer","example":198883},"price":{"type":"integer","example":2419},"number_of_bookings":{"type":"integer","example":10},"number_of_bookings_remaining":{"type":"integer","example":5},"use_from":{"type":"string","example":"2024-01-11"},"use_by":{"type":"string","example":"2024-02-04"},"book_by":{"type":"string","example":"2024-01-18"},"paid":{"type":"integer","example":5500},"service_name":{"type":"string","example":"Tennis Coaching"},"linked_package_id":{"type":"integer","example":89826}}},"Client":{"type":"object","properties":{"first_name":{"type":"string","example":"Ada"},"first_name_extra":{"type":"string","example":"null"},"last_name":{"type":"string","example":""},"last_name_extra":{"type":"string","example":"null"},"name":{"type":"string","example":"Ada Lovelace"},"email":{"type":"string","example":"ada.lovelace@email.com"},"address1":{"type":"string","example":"3-7 Herbal Hill"},"address2":{"type":"string","example":"Farringdon"},"address3":{"type":"string","example":"London"},"address4":{"type":"string","example":"Address Line 4"},"address5":{"type":"string","example":"Address Line 5"},"postcode":{"type":"string","example":"EC1R 5EJ"},"country":{"type":"string","example":"UK"},"phone":{"type":"string","example":"081-811-8181"},"mobile":{"type":"string","example":"293-482-342"},"phone_prefix":{"type":"string","example":"+44"},"phone_prefix_country_code":{"type":"string","example":"CA"},"mobile_prefix":{"type":"string","example":"+44"},"mobile_prefix_country_code":{"type":"string","example":"CA"},"id":{"type":"integer","example":54924},"answers":{"type":"object","properties":{},"example":[{"question_id":23,"name":"Question 1","answer":"Answer To Question 1"},{"question_id":88,"name":"Question 2","answer":"Answer To Question 2"},{"question_id":59,"name":"Question 3","answer":"Answer To Question 3"}]},"deleted":{"type":"boolean","example":true},"notifications":{"type":"object","properties":{},"example":{"1":"Notification 1","2":"Notification 2","3":"Notification 3"}},"client_type":{"type":"string","example":"Member|Contact"},"default_company_id":{"type":"integer","example":7859763},"reference":{"type":"string","example":"REF123"},"locale":{"type":"string","example":"UK"},"consent":{"type":"boolean","example":true},"time_zone":{"type":"string","example":"America/Los_Angeles"}}},"Member":{"type":"object","properties":{"id":{"type":"integer","example":23},"name":{"type":"string","example":"John Smith"},"first_name":{"type":"string","example":"John"},"first_name_extra":{"type":"string","example":"Furigana John"},"last_name":{"type":"string","example":"Smith"},"last_name_extra":{"type":"string","example":" Furigana Smith"},"comp_ref":{"type":"string","example":"REF423"},"wallet_amount":{"type":"integer","example":100},"client_type":{"type":"string","example":"Member"},"email":{"type":"string","example":"john.smith@test.org"},"address1":{"type":"string","example":"A Street and No."},"address2":{"type":"string","example":"An Area"},"address3":{"type":"string","example":"Some Town"},"address4":{"type":"string","example":"Some County"},"address5":{"type":"string","example":"Address Line 5"},"postcode":{"type":"string","example":"AB1 C22"},"country":{"type":"string","example":"United Kingdom"},"phone":{"type":"string","example":"+44 203 984 434"},"phone_prefix":{"type":"string","example":"+44"},"phone_prefix_country_code":{"type":"string","example":"CA"},"mobile":{"type":"string","example":"+44 7733 567 890"},"mobile_prefix":{"type":"string","example":"+44"},"mobile_prefix_country_code":{"type":"string","example":"CA"},"auth_token":{"type":"string","example":"A9rtuy842sasa3S"},"path":{"type":"string","example":"path"},"company_id":{"type":"integer","example":37000},"has_active_wallet":{"type":"boolean","example":false},"default_company_id":{"type":"integer","example":37000},"has_wallet":{"type":"boolean","example":false},"member_level_id":{"type":"integer"},"time_zone":{"type":"string","example":"America/Los_Angeles"},"consent":{"type":"boolean","example":true},"locale":{"type":"string","example":"en"},"space_details":{"type":"object","properties":{},"example":{"form 1":"form 1 value","form 2":"form 2 value","form 3":true,"form 4":false}},"q":{"type":"object","properties":{},"example":{"1":{"name":"What's your role?","answer":"Manager"}}},"answers":{"type":"array","items":{"type":"string"},"example":null},"_embedded":{"type":"object","properties":{"bookings":{"type":"array","items":{"$ref":"#/components/schemas/Booking"},"example":null},"pre_paid_bookings":{"type":"array","items":{"$ref":"#/components/schemas/PrePaidBooking"},"example":null},"child_clients":{"type":"array","items":{"type":"string"},"example":null}}}}},"ExternalPurchase":{"type":"object","properties":{"id":{"type":"integer","example":634588},"name":{"type":"string","example":"Name of External Purchase"},"description":{"type":"string","example":"A description of the purchase"},"settings":{"type":"object","properties":{},"example":{"key_1":"value_1","key_2":"value_2"}},"reference":{"type":"string","example":"REF1234"},"purchase_item_id":{"type":"integer","example":949323},"is_cancelled":{"type":"boolean","example":false}}},"Refund":{"type":"object","properties":{"amount_refunded":{"type":"integer"},"amount_remaining":{"type":"integer"}}},"Event":{"type":"object","properties":{"id":{"type":"integer","example":11111},"updated_at":{"type":"string","example":"2017-08-17T16:30:27Z"},"datetime":{"type":"string","example":"2017-08-17T17:30:27Z"},"description":{"type":"string","example":"A description"},"status":{"type":"integer","example":4},"status_name":{"type":"string","example":"booked"},"spaces_booked":{"type":"integer","example":3},"spaces_reserved":{"type":"integer","example":4},"spaces_blocked":{"type":"integer","example":5},"spaces_held":{"type":"integer","example":6},"num_spaces":{"type":"integer","example":18},"spaces_wait":{"type":"integer","example":2},"event_chain_id":{"type":"integer","example":9348539},"person_id":{"type":"integer","example":341995},"resource_id":{"type":"integer","example":23888},"service_id":{"type":"integer","example":1112344},"duration":{"type":"integer","example":30},"price":{"type":"integer","example":2500},"ticket_spaces":{"type":"object","properties":{},"example":{"1":{"name":"Name 1","left":1},"2":{"name":"Name 2","left":1},"6":{"name":"Name 6","left":5}}},"units":{"type":"string","example":"minute|day|week"},"company_id":{"type":"integer","example":59305},"session_num":{"type":"integer","example":42},"bookable":{"type":"boolean","example":true},"modified_date":{"type":"string","example":"2017-09-27T17:30:27Z"},"detail_group_id":{"type":"integer"},"price_in_major_units":{"type":"string","example":"null"},"multi_day":{"type":"boolean","example":true},"end_datetime":{"type":"string","example":"2017-08-17T17:30:27Z"},"_embedded":{"type":"object","properties":{"person":{"$ref":"#/components/schemas/Person"},"images":{"type":"array","items":{"$ref":"#/components/schemas/GlobalImage"},"example":null}}}}},"EventChain":{"type":"object","properties":{"id":{"type":"integer","example":69855},"updated_at":{"type":"string","example":"2024-01-01T12:44:23Z"},"created_at":{"type":"string","example":"2024-01-01T12:44:23Z"},"name":{"type":"string","example":"Event Chain"},"description":{"type":"string","example":"A description"},"duration":{"type":"integer","example":34},"group":{"type":"string","example":"Name of service"},"time":{"type":"string","example":"2024-01-07T12:44:23Z"},"waitlength":{"type":"integer","example":60},"long_description":{"type":"string","example":"Detailed description"},"capacity_view":{"type":"integer","example":3},"start_date":{"type":"string","example":"2024-01-04"},"end_date":{"type":"string","example":"2024-01-07"},"spaces":{"type":"integer","example":1},"person_name":{"type":"string","example":"Dr. Carol Smilie"},"resource_name":{"type":"string","example":"Surgery Room 1"},"price":{"type":"integer","example":2000},"max_num_bookings":{"type":"integer","example":1},"max_advance_time":{"type":"string","example":"2024-01-04T13:14:23Z"},"min_advance_time":{"type":"string","example":"2024-02-01T12:44:23Z"},"min_advance":{"type":"integer","example":4},"min_advance_unit":{"type":"string","example":"minute"},"min_cancel":{"type":"integer","example":30},"min_cancel_unit":{"type":"string","example":"minute"},"ticket_type":{"type":"string","example":"multi_space"},"email_per_ticket":{"type":"boolean","example":true},"questions_per_ticket":{"type":"boolean","example":false},"extra":{"type":"object","properties":{},"example":{"question_1":"answer to question_1","checkbox_question":["possible answer 1","possible answer 2","possible answer 3"]}},"course":{"type":"boolean","example":true},"recurrence_type":{"type":"string","example":"WEEKLY"},"company_id":{"type":"integer","example":589345},"occurances":{"type":"integer","example":23},"price_in_major_units":{"type":"string","example":"null"},"invitation_only":{"type":"string","example":"null"},"_embedded":{"type":"object","properties":{"slots":{"type":"array","items":{"$ref":"#/components/schemas/Event"},"example":null},"events":{"type":"array","items":{"$ref":"#/components/schemas/Event"},"example":null},"ticket_sets":{"type":"array","example":{"name":"Name","type":"type","price":2700,"event_chain_id":50348,"id":9482948,"min_num_bookings":3,"max_num_bookings":30,"pool_name":"Pool Name","pool_id":3290485,"pool_description":"Description","valid_from":"2024-01-07","valid_to":"2024-02-22","spaces":30,"counts_as":"string","price_type_id":75862},"items":{"type":"object","properties":{}}},"questions":{"$ref":"#/components/schemas/QuestionGroup"},"images":{"type":"array","items":{"$ref":"#/components/schemas/Image"},"example":null}}}}},"EventGroup":{"type":"object","properties":{"id":{"type":"integer","example":3234},"name":{"type":"string","example":"Name of event group"},"description":{"type":"string","example":"Description of the event group"},"colour":{"type":"string","example":"#800000"},"company_id":{"type":"integer","example":40001},"api_ref":{"type":"string","example":"REF123"},"reference":{"type":"string","example":"REF123"},"extra":{"type":"object","properties":{},"example":{"standard_question_1":"answer to question_1","checkbox_question_2":["option_1_for_question_2","option_2_for_question_2"]}},"_embedded":{"type":"object","properties":{"images":{"type":"array","items":{"$ref":"#/components/schemas/Image"},"example":null}}}}},"Person":{"type":"object","properties":{"id":{"type":"integer","example":254543},"name":{"type":"string","example":"John Bull"},"description":{"type":"string","example":"A little bit about them"},"type":{"type":"string","example":"person"},"extra":{"type":"object","properties":{},"example":{"question_one":"Answer to question_one","question_two":"Answer to question two"}},"group_id":{"type":"integer","example":58459},"deleted":{"type":"boolean","example":false},"disabled":{"type":"boolean","example":false},"company_id":{"type":"integer","example":37000},"order":{"type":"integer","example":1},"group_name":{"type":"string","example":"Group"},"created_at":{"type":"string","example":"null"},"updated_at":{"type":"string","example":"null"},"_embedded":{"type":"object","properties":{"images":{"type":"array","items":{"$ref":"#/components/schemas/Image"},"example":null}}}}},"GlobalImage":{"type":"object","properties":{"id":{"type":"string","example":"null"},"company_id":{"type":"string","example":"null"},"name":{"type":"string","example":"null"},"image_file_name":{"type":"string","example":"null"},"foreign_key":{"type":"string","example":"null"},"url":{"type":"string","example":"null"}}},"Question":{"type":"object","properties":{"id":{"type":"integer","example":69556},"name":{"type":"string","example":"Name of The Question"},"position":{"type":"integer","example":3},"required":{"type":"boolean","example":false},"important":{"type":"boolean","example":true},"admin_only":{"type":"boolean","example":true},"applies_to":{"type":"integer"},"ask_member":{"type":"boolean","example":true},"detail_type":{"type":"string","example":"select-price"},"default":{"type":"string","example":"1"},"help_text":{"type":"string","example":"This relates to your current health"},"options":{"type":"object","properties":{},"example":[{"name":"Option 1","price":3200,"is_default":false,"id":95834},{"name":"Option 2","price":5200,"is_default":true,"id":584},{"name":"Option 3","price":7310,"is_default":false,"id":934}]},"settings":{"type":"object","properties":{},"example":{"conditional_question":"Question","conditional_answer":"Answer"}},"price":{"type":"number","example":8890},"price_per_booking":{"type":"boolean","example":true},"outcome":{"type":"boolean","example":false},"hide_on_customer_journey":{"type":"boolean","example":false}}},"QuestionGroup":{"type":"object","properties":{"company_id":{"type":"integer","example":37001},"questions":{"$ref":"#/components/schemas/Question"},"name":{"type":"string","example":"Default group"}}},"Image":{"type":"object","properties":{"id":{"type":"string","example":"null"},"company_id":{"type":"string","example":"null"},"name":{"type":"string","example":"null"},"image_file_name":{"type":"string","example":"null"},"foreign_key":{"type":"string","example":"null"},"url":{"type":"string","example":"null"}}}},"securitySchemes":{"App-Id":{"type":"apiKey","name":"App-Id","in":"header"}}},"x-original-swagger-version":"2.0","security":[{"App-Id":[]}],"x-readme":{"explorer-enabled":true,"proxy-enabled":true}}