{"openapi":"3.0.1","info":{"title":"Baskets API","version":"5.0.0"},"servers":[{"url":"https://{api_url}/api/v5","variables":{"api_url":{"default":"example.jrni.com"}}}],"tags":[{"name":"Basket"},{"name":"Basket Service Item"},{"name":"Basket Attachment"},{"name":"Basket Service Item Attendee"},{"name":"Basket Event Item"},{"name":"Basket Coupon"}],"paths":{"/baskets":{"get":{"tags":["Basket"],"summary":"Retrieve all baskets","description":"Lists all Baskets associated with your token, will a new token if ons is not provided","operationId":"getV5Baskets","parameters":[{"name":"company_id","in":"query","description":"If used will return only baskets belonging to this company","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Basket","content":{"application/vnd.bookingbug-hal-v2+json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/BasketCollection"}},"application/vnd.bookingbug-nolinks-v2+json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/BasketCollection"}}}}}},"post":{"tags":["Basket"],"summary":"Create A Basket","description":"Creates a new Basket associated with your token, will a new token if ons is not provided","operationId":"postV5Baskets","requestBody":{"content":{"application/json":{"schema":{"required":["company_id"],"type":"object","properties":{"company_id":{"type":"string"}}}}},"required":true},"responses":{"201":{"description":"Basket","content":{"application/vnd.bookingbug-hal-v2+json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/Baskets"}},"application/vnd.bookingbug-nolinks-v2+json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/Baskets"}}}}}},"delete":{"tags":["Basket"],"summary":"Clears all baskets on your token","description":"Removes all baskets associated with your token","operationId":"deleteV5Baskets","responses":{"200":{"description":"Basket","content":{"application/vnd.bookingbug-hal-v2+json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/BasketCollection"}},"application/vnd.bookingbug-nolinks-v2+json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/BasketCollection"}}}}}}},"/baskets/{basket_id}/checkout":{"post":{"tags":["Basket"],"summary":"Basket Checkout","description":"Confirms the transaction and generates a Purchase.\n- Will generate all the necessary bookings, will generate tickets\n- Will generate the slots on the relevant people / resources / services / companies\n- Will alert both the associated client and all the relevant stakeholders through various channels.\n- Will delete the current basket.","operationId":"postV5BasketsBasketIdCheckout","parameters":[{"name":"basket_id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/postV5BasketsBasketIdCheckout"}}},"required":true},"responses":{"201":{"description":"Basket","content":{"application/vnd.bookingbug-hal-v2+json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/Purchase"}},"application/vnd.bookingbug-nolinks-v2+json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/Purchase"}}}}},"x-codegen-request-body-name":"V5BasketsBasketIdCheckout"}},"/baskets/{basket_id}/refresh":{"put":{"tags":["Basket"],"summary":"Refreshes your lock on all held items","description":"This allows for extra time in choosing more items to put into the basket","operationId":"putV5BasketsBasketIdRefresh","parameters":[{"name":"basket_id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Basket","content":{"application/vnd.bookingbug-hal-v2+json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/Baskets"}},"application/vnd.bookingbug-nolinks-v2+json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/Baskets"}}}}}}},"/baskets/{basket_id}":{"get":{"tags":["Basket"],"summary":"Get Basket","description":"Get Contents of the Basket","operationId":"getV5BasketsBasketId","parameters":[{"name":"basket_id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Basket","content":{"application/vnd.bookingbug-hal-v2+json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/Baskets"}},"application/vnd.bookingbug-nolinks-v2+json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/Baskets"}}}}}},"delete":{"tags":["Basket"],"summary":"Delete basket","description":"Deletes the Basket. Releasing all held items.","operationId":"deleteV5BasketsBasketId","parameters":[{"name":"basket_id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Basket","content":{"application/vnd.bookingbug-hal-v2+json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/BasketCollection"}},"application/vnd.bookingbug-nolinks-v2+json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/BasketCollection"}}}}}}},"/baskets/{basket_id}/service_items":{"post":{"tags":["Basket Service Item"],"summary":"Creates a Service Item","description":"Assets (`assets`), this parameters describe a list of rules which a time must\nsatisfy to be considered available.\nAn Asset consists of a\n* company_rule -> can be either `default` (it will respect the company of the URL), `any` (it can be any company that provides the service), or `Array<CompanyID>` one of these companies (which must provide the service).\n* person_rule -> can be either `any` (any person which provides the service), `any_or_none` (the user is indifferent as to whether a person is associated to the booking), `Array<PersonID>` one of these people who provide the service.\n* resource_rule -> same as person_rule:  can be either `any` (any resource which provides the service), `any_or_none` (the user is indifferent as to whether a resource is associated to the booking), `Array<PersonID>` one of these resources with which the service can be provided.","operationId":"postV5BasketsBasketIdServiceItems","parameters":[{"name":"basket_id","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"required":["questions[answer]","questions[id]","service_id","start"],"type":"object","properties":{"service_item_id":{"type":"string"},"service_id":{"type":"integer","description":"The global_id of the service which is being booked","format":"int32"},"start":{"type":"string","description":"Date time in which the appointment will take place"},"duration":{"type":"integer","description":"Duration of the appointment, in minutes. Must be one of the durations of the service","format":"int32"},"company_id":{"type":"integer","description":"The branch in which the appointment is taking place","format":"int32"},"person_id":{"type":"integer","description":"The staff member that will participate in the appointment","format":"int32"},"resource_id":{"type":"integer","description":"The resource that will be used in the appointment","format":"int32"},"assets[company_rule]":{"type":"array","description":"This asset must be on a company matching a rule. Valid values: 'default', 'any', Array<CompanyID>"},"assets[person_rule]":{"type":"array","description":"This asset must book a person matching a rule. Valid values: 'any', 'any_or_none', Array<PersonID>"},"assets[resource_rule]":{"type":"array","description":"This asset must book a resource matching a rule. Valid values: 'any', 'any_or_none', Array<ResourceID>"},"assets[pre_time]":{"type":"array","description":"Pre Time. Overrides service configuration","items":{"type":"integer","format":"int32","enum":[0,5,10,15,20,25,30,35,40,45,50,55,60,65,70,75,80,85,90,95,100,105,110,115,120,125,130,135,140,145,150,155,160,165,170,175,180,185,190,195,200,205,210,215,220,225,230,235,240,245,250,255,260,265,270,275,280,285,290,295,300,305,310,315,320,325,330,335,340,345,350,355,360,365,370,375,380,385,390,395,400,405,410,415,420,425,430,435,440,445,450,455,460,465,470,475,480,485,490,495,500,505,510,515,520,525,530,535,540,545,550,555,560,565,570,575,580,585,590,595,600,605,610,615,620,625,630,635,640,645,650,655,660,665,670,675,680,685,690,695,700,705,710,715,720,725,730,735,740,745,750,755,760,765,770,775,780,785,790,795,800,805,810,815,820,825,830,835,840,845,850,855,860,865,870,875,880,885,890,895,900,905,910,915,920,925,930,935,940,945,950,955,960,965,970,975,980,985,990,995,1000,1005,1010,1015,1020,1025,1030,1035,1040,1045,1050,1055,1060,1065,1070,1075,1080,1085,1090,1095,1100,1105,1110,1115,1120,1125,1130,1135,1140,1145,1150,1155,1160,1165,1170,1175,1180,1185,1190,1195,1200,1205,1210,1215,1220,1225,1230,1235,1240,1245,1250,1255,1260,1265,1270,1275,1280,1285,1290,1295,1300,1305,1310,1315,1320,1325,1330,1335,1340,1345,1350,1355,1360,1365,1370,1375,1380,1385,1390,1395,1400,1405,1410,1415,1420,1425,1430,1435,1440]}},"assets[post_time]":{"type":"array","description":"Post Time. Overrides service configuration","items":{"type":"integer","format":"int32","enum":[0,5,10,15,20,25,30,35,40,45,50,55,60,65,70,75,80,85,90,95,100,105,110,115,120,125,130,135,140,145,150,155,160,165,170,175,180,185,190,195,200,205,210,215,220,225,230,235,240,245,250,255,260,265,270,275,280,285,290,295,300,305,310,315,320,325,330,335,340,345,350,355,360,365,370,375,380,385,390,395,400,405,410,415,420,425,430,435,440,445,450,455,460,465,470,475,480,485,490,495,500,505,510,515,520,525,530,535,540,545,550,555,560,565,570,575,580,585,590,595,600,605,610,615,620,625,630,635,640,645,650,655,660,665,670,675,680,685,690,695,700,705,710,715,720,725,730,735,740,745,750,755,760,765,770,775,780,785,790,795,800,805,810,815,820,825,830,835,840,845,850,855,860,865,870,875,880,885,890,895,900,905,910,915,920,925,930,935,940,945,950,955,960,965,970,975,980,985,990,995,1000,1005,1010,1015,1020,1025,1030,1035,1040,1045,1050,1055,1060,1065,1070,1075,1080,1085,1090,1095,1100,1105,1110,1115,1120,1125,1130,1135,1140,1145,1150,1155,1160,1165,1170,1175,1180,1185,1190,1195,1200,1205,1210,1215,1220,1225,1230,1235,1240,1245,1250,1255,1260,1265,1270,1275,1280,1285,1290,1295,1300,1305,1310,1315,1320,1325,1330,1335,1340,1345,1350,1355,1360,1365,1370,1375,1380,1385,1390,1395,1400,1405,1410,1415,1420,1425,1430,1435,1440]}},"assets[person_group_id]":{"type":"array","description":"Person Group ID. This will overwrite the person_rule","items":{"type":"integer","format":"int32"}},"assets[resource_group_id]":{"type":"array","description":"Resource Group ID. This will overwrite the resource_rule","items":{"type":"integer","format":"int32"}},"requested_assets[company_rule]":{"type":"array","description":"This asset must be on a company matching a rule. Valid values: 'default', 'any', Array<CompanyID>. requested_assets is deprecated, please assets"},"requested_assets[person_rule]":{"type":"array","description":"This asset must book a person matching a rule. Valid values: 'any', 'any_or_none', Array<PersonID>. requested_assets is deprecated, please assets"},"requested_assets[resource_rule]":{"type":"array","description":"This asset must book a resource matching a rule. Valid values: 'any', 'any_or_none', Array<ResourceID>. requested_assets is deprecated, please assets"},"questions[id]":{"type":"array","items":{"type":"integer","format":"int32"}},"questions[answer]":{"type":"array","items":{"type":"string"}},"pre_time":{"type":"integer","description":"Pre Time. Overrides service configuration","format":"int32","enum":["0","5","10","15","20","25","30","35","40","45","50","55","60","65","70","75","80","85","90","95","100","105","110","115","120","125","130","135","140","145","150","155","160","165","170","175","180","185","190","195","200","205","210","215","220","225","230","235","240","245","250","255","260","265","270","275","280","285","290","295","300","305","310","315","320","325","330","335","340","345","350","355","360","365","370","375","380","385","390","395","400","405","410","415","420","425","430","435","440","445","450","455","460","465","470","475","480","485","490","495","500","505","510","515","520","525","530","535","540","545","550","555","560","565","570","575","580","585","590","595","600","605","610","615","620","625","630","635","640","645","650","655","660","665","670","675","680","685","690","695","700","705","710","715","720","725","730","735","740","745","750","755","760","765","770","775","780","785","790","795","800","805","810","815","820","825","830","835","840","845","850","855","860","865","870","875","880","885","890","895","900","905","910","915","920","925","930","935","940","945","950","955","960","965","970","975","980","985","990","995","1000","1005","1010","1015","1020","1025","1030","1035","1040","1045","1050","1055","1060","1065","1070","1075","1080","1085","1090","1095","1100","1105","1110","1115","1120","1125","1130","1135","1140","1145","1150","1155","1160","1165","1170","1175","1180","1185","1190","1195","1200","1205","1210","1215","1220","1225","1230","1235","1240","1245","1250","1255","1260","1265","1270","1275","1280","1285","1290","1295","1300","1305","1310","1315","1320","1325","1330","1335","1340","1345","1350","1355","1360","1365","1370","1375","1380","1385","1390","1395","1400","1405","1410","1415","1420","1425","1430","1435","1440"]},"post_time":{"type":"integer","description":"Post Time. Overrides service configuration","format":"int32","enum":["0","5","10","15","20","25","30","35","40","45","50","55","60","65","70","75","80","85","90","95","100","105","110","115","120","125","130","135","140","145","150","155","160","165","170","175","180","185","190","195","200","205","210","215","220","225","230","235","240","245","250","255","260","265","270","275","280","285","290","295","300","305","310","315","320","325","330","335","340","345","350","355","360","365","370","375","380","385","390","395","400","405","410","415","420","425","430","435","440","445","450","455","460","465","470","475","480","485","490","495","500","505","510","515","520","525","530","535","540","545","550","555","560","565","570","575","580","585","590","595","600","605","610","615","620","625","630","635","640","645","650","655","660","665","670","675","680","685","690","695","700","705","710","715","720","725","730","735","740","745","750","755","760","765","770","775","780","785","790","795","800","805","810","815","820","825","830","835","840","845","850","855","860","865","870","875","880","885","890","895","900","905","910","915","920","925","930","935","940","945","950","955","960","965","970","975","980","985","990","995","1000","1005","1010","1015","1020","1025","1030","1035","1040","1045","1050","1055","1060","1065","1070","1075","1080","1085","1090","1095","1100","1105","1110","1115","1120","1125","1130","1135","1140","1145","1150","1155","1160","1165","1170","1175","1180","1185","1190","1195","1200","1205","1210","1215","1220","1225","1230","1235","1240","1245","1250","1255","1260","1265","1270","1275","1280","1285","1290","1295","1300","1305","1310","1315","1320","1325","1330","1335","1340","1345","1350","1355","1360","1365","1370","1375","1380","1385","1390","1395","1400","1405","1410","1415","1420","1425","1430","1435","1440"]},"time_zone":{"type":"string","description":"The time zone the booking was made in","enum":["Africa/Abidjan","Africa/Accra","Africa/Addis_Ababa","Africa/Algiers","Africa/Asmara","Africa/Asmera","Africa/Bamako","Africa/Bangui","Africa/Banjul","Africa/Bissau","Africa/Blantyre","Africa/Brazzaville","Africa/Bujumbura","Africa/Cairo","Africa/Casablanca","Africa/Ceuta","Africa/Conakry","Africa/Dakar","Africa/Dar_es_Salaam","Africa/Djibouti","Africa/Douala","Africa/El_Aaiun","Africa/Freetown","Africa/Gaborone","Africa/Harare","Africa/Johannesburg","Africa/Juba","Africa/Kampala","Africa/Khartoum","Africa/Kigali","Africa/Kinshasa","Africa/Lagos","Africa/Libreville","Africa/Lome","Africa/Luanda","Africa/Lubumbashi","Africa/Lusaka","Africa/Malabo","Africa/Maputo","Africa/Maseru","Africa/Mbabane","Africa/Mogadishu","Africa/Monrovia","Africa/Nairobi","Africa/Ndjamena","Africa/Niamey","Africa/Nouakchott","Africa/Ouagadougou","Africa/Porto-Novo","Africa/Sao_Tome","Africa/Timbuktu","Africa/Tripoli","Africa/Tunis","Africa/Windhoek","America/Adak","America/Anchorage","America/Anguilla","America/Antigua","America/Araguaina","America/Argentina/Buenos_Aires","America/Argentina/Catamarca","America/Argentina/ComodRivadavia","America/Argentina/Cordoba","America/Argentina/Jujuy","America/Argentina/La_Rioja","America/Argentina/Mendoza","America/Argentina/Rio_Gallegos","America/Argentina/Salta","America/Argentina/San_Juan","America/Argentina/San_Luis","America/Argentina/Tucuman","America/Argentina/Ushuaia","America/Aruba","America/Asuncion","America/Atikokan","America/Atka","America/Bahia","America/Bahia_Banderas","America/Barbados","America/Belem","America/Belize","America/Blanc-Sablon","America/Boa_Vista","America/Bogota","America/Boise","America/Buenos_Aires","America/Cambridge_Bay","America/Campo_Grande","America/Cancun","America/Caracas","America/Catamarca","America/Cayenne","America/Cayman","America/Chicago","America/Chihuahua","America/Ciudad_Juarez","America/Coral_Harbour","America/Cordoba","America/Costa_Rica","America/Creston","America/Cuiaba","America/Curacao","America/Danmarkshavn","America/Dawson","America/Dawson_Creek","America/Denver","America/Detroit","America/Dominica","America/Edmonton","America/Eirunepe","America/El_Salvador","America/Ensenada","America/Fort_Nelson","America/Fort_Wayne","America/Fortaleza","America/Glace_Bay","America/Godthab","America/Goose_Bay","America/Grand_Turk","America/Grenada","America/Guadeloupe","America/Guatemala","America/Guayaquil","America/Guyana","America/Halifax","America/Havana","America/Hermosillo","America/Indiana/Indianapolis","America/Indiana/Knox","America/Indiana/Marengo","America/Indiana/Petersburg","America/Indiana/Tell_City","America/Indiana/Vevay","America/Indiana/Vincennes","America/Indiana/Winamac","America/Indianapolis","America/Inuvik","America/Iqaluit","America/Jamaica","America/Jujuy","America/Juneau","America/Kentucky/Louisville","America/Kentucky/Monticello","America/Knox_IN","America/Kralendijk","America/La_Paz","America/Lima","America/Los_Angeles","America/Louisville","America/Lower_Princes","America/Maceio","America/Managua","America/Manaus","America/Marigot","America/Martinique","America/Matamoros","America/Mazatlan","America/Mendoza","America/Menominee","America/Merida","America/Metlakatla","America/Mexico_City","America/Miquelon","America/Moncton","America/Monterrey","America/Montevideo","America/Montreal","America/Montserrat","America/Nassau","America/New_York","America/Nipigon","America/Nome","America/Noronha","America/North_Dakota/Beulah","America/North_Dakota/Center","America/North_Dakota/New_Salem","America/Nuuk","America/Ojinaga","America/Panama","America/Pangnirtung","America/Paramaribo","America/Phoenix","America/Port-au-Prince","America/Port_of_Spain","America/Porto_Acre","America/Porto_Velho","America/Puerto_Rico","America/Punta_Arenas","America/Rainy_River","America/Rankin_Inlet","America/Recife","America/Regina","America/Resolute","America/Rio_Branco","America/Rosario","America/Santa_Isabel","America/Santarem","America/Santiago","America/Santo_Domingo","America/Sao_Paulo","America/Scoresbysund","America/Shiprock","America/Sitka","America/St_Barthelemy","America/St_Johns","America/St_Kitts","America/St_Lucia","America/St_Thomas","America/St_Vincent","America/Swift_Current","America/Tegucigalpa","America/Thule","America/Thunder_Bay","America/Tijuana","America/Toronto","America/Tortola","America/Vancouver","America/Virgin","America/Whitehorse","America/Winnipeg","America/Yakutat","America/Yellowknife","Antarctica/Casey","Antarctica/Davis","Antarctica/DumontDUrville","Antarctica/Macquarie","Antarctica/Mawson","Antarctica/McMurdo","Antarctica/Palmer","Antarctica/Rothera","Antarctica/South_Pole","Antarctica/Syowa","Antarctica/Troll","Antarctica/Vostok","Arctic/Longyearbyen","Asia/Aden","Asia/Almaty","Asia/Amman","Asia/Anadyr","Asia/Aqtau","Asia/Aqtobe","Asia/Ashgabat","Asia/Ashkhabad","Asia/Atyrau","Asia/Baghdad","Asia/Bahrain","Asia/Baku","Asia/Bangkok","Asia/Barnaul","Asia/Beirut","Asia/Bishkek","Asia/Brunei","Asia/Calcutta","Asia/Chita","Asia/Choibalsan","Asia/Chongqing","Asia/Chungking","Asia/Colombo","Asia/Dacca","Asia/Damascus","Asia/Dhaka","Asia/Dili","Asia/Dubai","Asia/Dushanbe","Asia/Famagusta","Asia/Gaza","Asia/Harbin","Asia/Hebron","Asia/Ho_Chi_Minh","Asia/Hong_Kong","Asia/Hovd","Asia/Irkutsk","Asia/Istanbul","Asia/Jakarta","Asia/Jayapura","Asia/Jerusalem","Asia/Kabul","Asia/Kamchatka","Asia/Karachi","Asia/Kashgar","Asia/Kathmandu","Asia/Katmandu","Asia/Khandyga","Asia/Kolkata","Asia/Krasnoyarsk","Asia/Kuala_Lumpur","Asia/Kuching","Asia/Kuwait","Asia/Macao","Asia/Macau","Asia/Magadan","Asia/Makassar","Asia/Manila","Asia/Muscat","Asia/Nicosia","Asia/Novokuznetsk","Asia/Novosibirsk","Asia/Omsk","Asia/Oral","Asia/Phnom_Penh","Asia/Pontianak","Asia/Pyongyang","Asia/Qatar","Asia/Qostanay","Asia/Qyzylorda","Asia/Rangoon","Asia/Riyadh","Asia/Saigon","Asia/Sakhalin","Asia/Samarkand","Asia/Seoul","Asia/Shanghai","Asia/Singapore","Asia/Srednekolymsk","Asia/Taipei","Asia/Tashkent","Asia/Tbilisi","Asia/Tehran","Asia/Tel_Aviv","Asia/Thimbu","Asia/Thimphu","Asia/Tokyo","Asia/Tomsk","Asia/Ujung_Pandang","Asia/Ulaanbaatar","Asia/Ulan_Bator","Asia/Urumqi","Asia/Ust-Nera","Asia/Vientiane","Asia/Vladivostok","Asia/Yakutsk","Asia/Yangon","Asia/Yekaterinburg","Asia/Yerevan","Atlantic/Azores","Atlantic/Bermuda","Atlantic/Canary","Atlantic/Cape_Verde","Atlantic/Faeroe","Atlantic/Faroe","Atlantic/Jan_Mayen","Atlantic/Madeira","Atlantic/Reykjavik","Atlantic/South_Georgia","Atlantic/St_Helena","Atlantic/Stanley","Australia/ACT","Australia/Adelaide","Australia/Brisbane","Australia/Broken_Hill","Australia/Canberra","Australia/Currie","Australia/Darwin","Australia/Eucla","Australia/Hobart","Australia/LHI","Australia/Lindeman","Australia/Lord_Howe","Australia/Melbourne","Australia/NSW","Australia/North","Australia/Perth","Australia/Queensland","Australia/South","Australia/Sydney","Australia/Tasmania","Australia/Victoria","Australia/West","Australia/Yancowinna","Brazil/Acre","Brazil/DeNoronha","Brazil/East","Brazil/West","CET","CST6CDT","Canada/Atlantic","Canada/Central","Canada/Eastern","Canada/Mountain","Canada/Newfoundland","Canada/Pacific","Canada/Saskatchewan","Canada/Yukon","Chile/Continental","Chile/EasterIsland","Cuba","EET","EST","EST5EDT","Egypt","Eire","Etc/GMT","Etc/GMT+0","Etc/GMT+1","Etc/GMT+10","Etc/GMT+11","Etc/GMT+12","Etc/GMT+2","Etc/GMT+3","Etc/GMT+4","Etc/GMT+5","Etc/GMT+6","Etc/GMT+7","Etc/GMT+8","Etc/GMT+9","Etc/GMT-0","Etc/GMT-1","Etc/GMT-10","Etc/GMT-11","Etc/GMT-12","Etc/GMT-13","Etc/GMT-14","Etc/GMT-2","Etc/GMT-3","Etc/GMT-4","Etc/GMT-5","Etc/GMT-6","Etc/GMT-7","Etc/GMT-8","Etc/GMT-9","Etc/GMT0","Etc/Greenwich","Etc/UCT","Etc/UTC","Etc/Universal","Etc/Zulu","Europe/Amsterdam","Europe/Andorra","Europe/Astrakhan","Europe/Athens","Europe/Belfast","Europe/Belgrade","Europe/Berlin","Europe/Bratislava","Europe/Brussels","Europe/Bucharest","Europe/Budapest","Europe/Busingen","Europe/Chisinau","Europe/Copenhagen","Europe/Dublin","Europe/Gibraltar","Europe/Guernsey","Europe/Helsinki","Europe/Isle_of_Man","Europe/Istanbul","Europe/Jersey","Europe/Kaliningrad","Europe/Kiev","Europe/Kirov","Europe/Kyiv","Europe/Lisbon","Europe/Ljubljana","Europe/London","Europe/Luxembourg","Europe/Madrid","Europe/Malta","Europe/Mariehamn","Europe/Minsk","Europe/Monaco","Europe/Moscow","Europe/Nicosia","Europe/Oslo","Europe/Paris","Europe/Podgorica","Europe/Prague","Europe/Riga","Europe/Rome","Europe/Samara","Europe/San_Marino","Europe/Sarajevo","Europe/Saratov","Europe/Simferopol","Europe/Skopje","Europe/Sofia","Europe/Stockholm","Europe/Tallinn","Europe/Tirane","Europe/Tiraspol","Europe/Ulyanovsk","Europe/Uzhgorod","Europe/Vaduz","Europe/Vatican","Europe/Vienna","Europe/Vilnius","Europe/Volgograd","Europe/Warsaw","Europe/Zagreb","Europe/Zaporozhye","Europe/Zurich","Factory","GB","GB-Eire","GMT","GMT+0","GMT-0","GMT0","Greenwich","HST","Hongkong","Iceland","Indian/Antananarivo","Indian/Chagos","Indian/Christmas","Indian/Cocos","Indian/Comoro","Indian/Kerguelen","Indian/Mahe","Indian/Maldives","Indian/Mauritius","Indian/Mayotte","Indian/Reunion","Iran","Israel","Jamaica","Japan","Kwajalein","Libya","MET","MST","MST7MDT","Mexico/BajaNorte","Mexico/BajaSur","Mexico/General","NZ","NZ-CHAT","Navajo","PRC","PST8PDT","Pacific/Apia","Pacific/Auckland","Pacific/Bougainville","Pacific/Chatham","Pacific/Chuuk","Pacific/Easter","Pacific/Efate","Pacific/Enderbury","Pacific/Fakaofo","Pacific/Fiji","Pacific/Funafuti","Pacific/Galapagos","Pacific/Gambier","Pacific/Guadalcanal","Pacific/Guam","Pacific/Honolulu","Pacific/Johnston","Pacific/Kanton","Pacific/Kiritimati","Pacific/Kosrae","Pacific/Kwajalein","Pacific/Majuro","Pacific/Marquesas","Pacific/Midway","Pacific/Nauru","Pacific/Niue","Pacific/Norfolk","Pacific/Noumea","Pacific/Pago_Pago","Pacific/Palau","Pacific/Pitcairn","Pacific/Pohnpei","Pacific/Ponape","Pacific/Port_Moresby","Pacific/Rarotonga","Pacific/Saipan","Pacific/Samoa","Pacific/Tahiti","Pacific/Tarawa","Pacific/Tongatapu","Pacific/Truk","Pacific/Wake","Pacific/Wallis","Pacific/Yap","Poland","Portugal","ROC","ROK","Singapore","Turkey","UCT","US/Alaska","US/Aleutian","US/Arizona","US/Central","US/East-Indiana","US/Eastern","US/Hawaii","US/Indiana-Starke","US/Michigan","US/Mountain","US/Pacific","US/Samoa","UTC","Universal","W-SU","WET","Zulu"]}}}}},"required":true},"responses":{"201":{"description":"Basket","content":{"application/vnd.bookingbug-hal-v2+json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/ServiceItem"}},"application/vnd.bookingbug-nolinks-v2+json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/ServiceItem"}}}}}}},"/baskets/{basket_id}/service_items/{service_item_id}/attachments/{id}":{"get":{"tags":["Basket Attachment"],"summary":"Get an attachment of the basket item","description":"Get an attchment","operationId":"getV5BasketsBasketIdServiceItemsServiceItemIdAttachmentsId","parameters":[{"name":"id","in":"path","description":"Attachment Id","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"basket_id","in":"path","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"service_item_id","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"201":{"description":"Basket","content":{"application/vnd.bookingbug-hal-v2+json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/Attachment"}},"application/vnd.bookingbug-nolinks-v2+json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/Attachment"}}}}}},"delete":{"tags":["Basket Attachment"],"summary":"Remove attachment from the basket item","description":"Remove attachment from the the basket item","operationId":"deleteV5BasketsBasketIdServiceItemsServiceItemIdAttachmentsId","parameters":[{"name":"id","in":"path","description":"Attachment Id","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"basket_id","in":"path","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"service_item_id","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"201":{"description":"Basket","content":{"application/vnd.bookingbug-hal-v2+json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/Attachment"}},"application/vnd.bookingbug-nolinks-v2+json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/Attachment"}}}}}}},"/baskets/{basket_id}/service_items/{service_item_id}/attachments":{"get":{"tags":["Basket Attachment"],"summary":"List attachments of the basket item","description":"List attchments","operationId":"getV5BasketsBasketIdServiceItemsServiceItemIdAttachments","parameters":[{"name":"basket_id","in":"path","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"service_item_id","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"201":{"description":"Basket","content":{"application/vnd.bookingbug-hal-v2+json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/AttachmentCollection"}},"application/vnd.bookingbug-nolinks-v2+json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/AttachmentCollection"}}}}}},"post":{"tags":["Basket Attachment"],"summary":"Add an attachment to basket item","description":"Upload an attachment and add it to the basket item","operationId":"postV5BasketsBasketIdServiceItemsServiceItemIdAttachments","parameters":[{"name":"basket_id","in":"path","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"service_item_id","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"required":["file"],"type":"object","properties":{"file":{"type":"string","description":"File to attach","format":"binary"}}}}},"required":true},"responses":{"201":{"description":"Basket","content":{"application/vnd.bookingbug-hal-v2+json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/Attachment"}},"application/vnd.bookingbug-nolinks-v2+json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/Attachment"}}}}}}},"/baskets/{basket_id}/service_items/{service_item_id}":{"get":{"tags":["Basket Service Item"],"summary":"Read Basket Item","description":"Get the Details of a Specific Item in the Shopping Basket","operationId":"getV5BasketsBasketIdServiceItemsServiceItemId","parameters":[{"name":"service_item_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"basket_id","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Basket Item","content":{"application/vnd.bookingbug-hal-v2+json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/ServiceItem"}},"application/vnd.bookingbug-nolinks-v2+json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/ServiceItem"}}}}}},"put":{"tags":["Basket Service Item"],"summary":"Updates a Service Item","description":"This API endpoint is unique in that it requires all the same params as creating a new Service Item\nThe newly created Service Item will replace the existing Service Item on the Basket.\nYou will only be able to book this if the time is available*\n* Ignoring the fact that you already may hold a reservation on the time with the Service Item that is being replaced\nAssets (`assets`), this parameters describe a list of rules which a time must\nsatisfy to be considered available.\nA Asset consists of a\n* company_rule -> can be either `default` (it will respect the company of the URL), `any` (it can be any company that provides the service), or `Array<CompanyID>` one of these companies (which must provide the service).\n* person_rule -> can be either `any` (any person which provides the service), `any_or_none` (the user is indifferent as to whether a person is associated to the booking), `Array<PersonID>` one of these people who provide the service.\n* resource_rule -> same as person_rule:  can be either `any` (any resource which provides the service), `any_or_none` (the user is indifferent as to whether a resource is associated to the booking), `Array<PersonID>` one of these resources with which the service can be provided.","operationId":"putV5BasketsBasketIdServiceItemsServiceItemId","parameters":[{"name":"service_item_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"basket_id","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"required":["questions[answer]","questions[id]","service_id","start"],"type":"object","properties":{"service_id":{"type":"integer","description":"The global_id of the service which is being booked","format":"int32"},"start":{"type":"string","description":"Date time in which the appointment will take place"},"duration":{"type":"integer","description":"Duration of the appointment, in minutes. Must be one of the durations of the service","format":"int32"},"company_id":{"type":"integer","description":"The branch in which the appointment is taking place","format":"int32"},"person_id":{"type":"integer","description":"The staff member that will participate in the appointment","format":"int32"},"resource_id":{"type":"integer","description":"The resource that will be used in the appointment","format":"int32"},"time_zone":{"type":"string","description":"The time zone the booking was made in","enum":["Africa/Abidjan","Africa/Accra","Africa/Addis_Ababa","Africa/Algiers","Africa/Asmara","Africa/Asmera","Africa/Bamako","Africa/Bangui","Africa/Banjul","Africa/Bissau","Africa/Blantyre","Africa/Brazzaville","Africa/Bujumbura","Africa/Cairo","Africa/Casablanca","Africa/Ceuta","Africa/Conakry","Africa/Dakar","Africa/Dar_es_Salaam","Africa/Djibouti","Africa/Douala","Africa/El_Aaiun","Africa/Freetown","Africa/Gaborone","Africa/Harare","Africa/Johannesburg","Africa/Juba","Africa/Kampala","Africa/Khartoum","Africa/Kigali","Africa/Kinshasa","Africa/Lagos","Africa/Libreville","Africa/Lome","Africa/Luanda","Africa/Lubumbashi","Africa/Lusaka","Africa/Malabo","Africa/Maputo","Africa/Maseru","Africa/Mbabane","Africa/Mogadishu","Africa/Monrovia","Africa/Nairobi","Africa/Ndjamena","Africa/Niamey","Africa/Nouakchott","Africa/Ouagadougou","Africa/Porto-Novo","Africa/Sao_Tome","Africa/Timbuktu","Africa/Tripoli","Africa/Tunis","Africa/Windhoek","America/Adak","America/Anchorage","America/Anguilla","America/Antigua","America/Araguaina","America/Argentina/Buenos_Aires","America/Argentina/Catamarca","America/Argentina/ComodRivadavia","America/Argentina/Cordoba","America/Argentina/Jujuy","America/Argentina/La_Rioja","America/Argentina/Mendoza","America/Argentina/Rio_Gallegos","America/Argentina/Salta","America/Argentina/San_Juan","America/Argentina/San_Luis","America/Argentina/Tucuman","America/Argentina/Ushuaia","America/Aruba","America/Asuncion","America/Atikokan","America/Atka","America/Bahia","America/Bahia_Banderas","America/Barbados","America/Belem","America/Belize","America/Blanc-Sablon","America/Boa_Vista","America/Bogota","America/Boise","America/Buenos_Aires","America/Cambridge_Bay","America/Campo_Grande","America/Cancun","America/Caracas","America/Catamarca","America/Cayenne","America/Cayman","America/Chicago","America/Chihuahua","America/Ciudad_Juarez","America/Coral_Harbour","America/Cordoba","America/Costa_Rica","America/Creston","America/Cuiaba","America/Curacao","America/Danmarkshavn","America/Dawson","America/Dawson_Creek","America/Denver","America/Detroit","America/Dominica","America/Edmonton","America/Eirunepe","America/El_Salvador","America/Ensenada","America/Fort_Nelson","America/Fort_Wayne","America/Fortaleza","America/Glace_Bay","America/Godthab","America/Goose_Bay","America/Grand_Turk","America/Grenada","America/Guadeloupe","America/Guatemala","America/Guayaquil","America/Guyana","America/Halifax","America/Havana","America/Hermosillo","America/Indiana/Indianapolis","America/Indiana/Knox","America/Indiana/Marengo","America/Indiana/Petersburg","America/Indiana/Tell_City","America/Indiana/Vevay","America/Indiana/Vincennes","America/Indiana/Winamac","America/Indianapolis","America/Inuvik","America/Iqaluit","America/Jamaica","America/Jujuy","America/Juneau","America/Kentucky/Louisville","America/Kentucky/Monticello","America/Knox_IN","America/Kralendijk","America/La_Paz","America/Lima","America/Los_Angeles","America/Louisville","America/Lower_Princes","America/Maceio","America/Managua","America/Manaus","America/Marigot","America/Martinique","America/Matamoros","America/Mazatlan","America/Mendoza","America/Menominee","America/Merida","America/Metlakatla","America/Mexico_City","America/Miquelon","America/Moncton","America/Monterrey","America/Montevideo","America/Montreal","America/Montserrat","America/Nassau","America/New_York","America/Nipigon","America/Nome","America/Noronha","America/North_Dakota/Beulah","America/North_Dakota/Center","America/North_Dakota/New_Salem","America/Nuuk","America/Ojinaga","America/Panama","America/Pangnirtung","America/Paramaribo","America/Phoenix","America/Port-au-Prince","America/Port_of_Spain","America/Porto_Acre","America/Porto_Velho","America/Puerto_Rico","America/Punta_Arenas","America/Rainy_River","America/Rankin_Inlet","America/Recife","America/Regina","America/Resolute","America/Rio_Branco","America/Rosario","America/Santa_Isabel","America/Santarem","America/Santiago","America/Santo_Domingo","America/Sao_Paulo","America/Scoresbysund","America/Shiprock","America/Sitka","America/St_Barthelemy","America/St_Johns","America/St_Kitts","America/St_Lucia","America/St_Thomas","America/St_Vincent","America/Swift_Current","America/Tegucigalpa","America/Thule","America/Thunder_Bay","America/Tijuana","America/Toronto","America/Tortola","America/Vancouver","America/Virgin","America/Whitehorse","America/Winnipeg","America/Yakutat","America/Yellowknife","Antarctica/Casey","Antarctica/Davis","Antarctica/DumontDUrville","Antarctica/Macquarie","Antarctica/Mawson","Antarctica/McMurdo","Antarctica/Palmer","Antarctica/Rothera","Antarctica/South_Pole","Antarctica/Syowa","Antarctica/Troll","Antarctica/Vostok","Arctic/Longyearbyen","Asia/Aden","Asia/Almaty","Asia/Amman","Asia/Anadyr","Asia/Aqtau","Asia/Aqtobe","Asia/Ashgabat","Asia/Ashkhabad","Asia/Atyrau","Asia/Baghdad","Asia/Bahrain","Asia/Baku","Asia/Bangkok","Asia/Barnaul","Asia/Beirut","Asia/Bishkek","Asia/Brunei","Asia/Calcutta","Asia/Chita","Asia/Choibalsan","Asia/Chongqing","Asia/Chungking","Asia/Colombo","Asia/Dacca","Asia/Damascus","Asia/Dhaka","Asia/Dili","Asia/Dubai","Asia/Dushanbe","Asia/Famagusta","Asia/Gaza","Asia/Harbin","Asia/Hebron","Asia/Ho_Chi_Minh","Asia/Hong_Kong","Asia/Hovd","Asia/Irkutsk","Asia/Istanbul","Asia/Jakarta","Asia/Jayapura","Asia/Jerusalem","Asia/Kabul","Asia/Kamchatka","Asia/Karachi","Asia/Kashgar","Asia/Kathmandu","Asia/Katmandu","Asia/Khandyga","Asia/Kolkata","Asia/Krasnoyarsk","Asia/Kuala_Lumpur","Asia/Kuching","Asia/Kuwait","Asia/Macao","Asia/Macau","Asia/Magadan","Asia/Makassar","Asia/Manila","Asia/Muscat","Asia/Nicosia","Asia/Novokuznetsk","Asia/Novosibirsk","Asia/Omsk","Asia/Oral","Asia/Phnom_Penh","Asia/Pontianak","Asia/Pyongyang","Asia/Qatar","Asia/Qostanay","Asia/Qyzylorda","Asia/Rangoon","Asia/Riyadh","Asia/Saigon","Asia/Sakhalin","Asia/Samarkand","Asia/Seoul","Asia/Shanghai","Asia/Singapore","Asia/Srednekolymsk","Asia/Taipei","Asia/Tashkent","Asia/Tbilisi","Asia/Tehran","Asia/Tel_Aviv","Asia/Thimbu","Asia/Thimphu","Asia/Tokyo","Asia/Tomsk","Asia/Ujung_Pandang","Asia/Ulaanbaatar","Asia/Ulan_Bator","Asia/Urumqi","Asia/Ust-Nera","Asia/Vientiane","Asia/Vladivostok","Asia/Yakutsk","Asia/Yangon","Asia/Yekaterinburg","Asia/Yerevan","Atlantic/Azores","Atlantic/Bermuda","Atlantic/Canary","Atlantic/Cape_Verde","Atlantic/Faeroe","Atlantic/Faroe","Atlantic/Jan_Mayen","Atlantic/Madeira","Atlantic/Reykjavik","Atlantic/South_Georgia","Atlantic/St_Helena","Atlantic/Stanley","Australia/ACT","Australia/Adelaide","Australia/Brisbane","Australia/Broken_Hill","Australia/Canberra","Australia/Currie","Australia/Darwin","Australia/Eucla","Australia/Hobart","Australia/LHI","Australia/Lindeman","Australia/Lord_Howe","Australia/Melbourne","Australia/NSW","Australia/North","Australia/Perth","Australia/Queensland","Australia/South","Australia/Sydney","Australia/Tasmania","Australia/Victoria","Australia/West","Australia/Yancowinna","Brazil/Acre","Brazil/DeNoronha","Brazil/East","Brazil/West","CET","CST6CDT","Canada/Atlantic","Canada/Central","Canada/Eastern","Canada/Mountain","Canada/Newfoundland","Canada/Pacific","Canada/Saskatchewan","Canada/Yukon","Chile/Continental","Chile/EasterIsland","Cuba","EET","EST","EST5EDT","Egypt","Eire","Etc/GMT","Etc/GMT+0","Etc/GMT+1","Etc/GMT+10","Etc/GMT+11","Etc/GMT+12","Etc/GMT+2","Etc/GMT+3","Etc/GMT+4","Etc/GMT+5","Etc/GMT+6","Etc/GMT+7","Etc/GMT+8","Etc/GMT+9","Etc/GMT-0","Etc/GMT-1","Etc/GMT-10","Etc/GMT-11","Etc/GMT-12","Etc/GMT-13","Etc/GMT-14","Etc/GMT-2","Etc/GMT-3","Etc/GMT-4","Etc/GMT-5","Etc/GMT-6","Etc/GMT-7","Etc/GMT-8","Etc/GMT-9","Etc/GMT0","Etc/Greenwich","Etc/UCT","Etc/UTC","Etc/Universal","Etc/Zulu","Europe/Amsterdam","Europe/Andorra","Europe/Astrakhan","Europe/Athens","Europe/Belfast","Europe/Belgrade","Europe/Berlin","Europe/Bratislava","Europe/Brussels","Europe/Bucharest","Europe/Budapest","Europe/Busingen","Europe/Chisinau","Europe/Copenhagen","Europe/Dublin","Europe/Gibraltar","Europe/Guernsey","Europe/Helsinki","Europe/Isle_of_Man","Europe/Istanbul","Europe/Jersey","Europe/Kaliningrad","Europe/Kiev","Europe/Kirov","Europe/Kyiv","Europe/Lisbon","Europe/Ljubljana","Europe/London","Europe/Luxembourg","Europe/Madrid","Europe/Malta","Europe/Mariehamn","Europe/Minsk","Europe/Monaco","Europe/Moscow","Europe/Nicosia","Europe/Oslo","Europe/Paris","Europe/Podgorica","Europe/Prague","Europe/Riga","Europe/Rome","Europe/Samara","Europe/San_Marino","Europe/Sarajevo","Europe/Saratov","Europe/Simferopol","Europe/Skopje","Europe/Sofia","Europe/Stockholm","Europe/Tallinn","Europe/Tirane","Europe/Tiraspol","Europe/Ulyanovsk","Europe/Uzhgorod","Europe/Vaduz","Europe/Vatican","Europe/Vienna","Europe/Vilnius","Europe/Volgograd","Europe/Warsaw","Europe/Zagreb","Europe/Zaporozhye","Europe/Zurich","Factory","GB","GB-Eire","GMT","GMT+0","GMT-0","GMT0","Greenwich","HST","Hongkong","Iceland","Indian/Antananarivo","Indian/Chagos","Indian/Christmas","Indian/Cocos","Indian/Comoro","Indian/Kerguelen","Indian/Mahe","Indian/Maldives","Indian/Mauritius","Indian/Mayotte","Indian/Reunion","Iran","Israel","Jamaica","Japan","Kwajalein","Libya","MET","MST","MST7MDT","Mexico/BajaNorte","Mexico/BajaSur","Mexico/General","NZ","NZ-CHAT","Navajo","PRC","PST8PDT","Pacific/Apia","Pacific/Auckland","Pacific/Bougainville","Pacific/Chatham","Pacific/Chuuk","Pacific/Easter","Pacific/Efate","Pacific/Enderbury","Pacific/Fakaofo","Pacific/Fiji","Pacific/Funafuti","Pacific/Galapagos","Pacific/Gambier","Pacific/Guadalcanal","Pacific/Guam","Pacific/Honolulu","Pacific/Johnston","Pacific/Kanton","Pacific/Kiritimati","Pacific/Kosrae","Pacific/Kwajalein","Pacific/Majuro","Pacific/Marquesas","Pacific/Midway","Pacific/Nauru","Pacific/Niue","Pacific/Norfolk","Pacific/Noumea","Pacific/Pago_Pago","Pacific/Palau","Pacific/Pitcairn","Pacific/Pohnpei","Pacific/Ponape","Pacific/Port_Moresby","Pacific/Rarotonga","Pacific/Saipan","Pacific/Samoa","Pacific/Tahiti","Pacific/Tarawa","Pacific/Tongatapu","Pacific/Truk","Pacific/Wake","Pacific/Wallis","Pacific/Yap","Poland","Portugal","ROC","ROK","Singapore","Turkey","UCT","US/Alaska","US/Aleutian","US/Arizona","US/Central","US/East-Indiana","US/Eastern","US/Hawaii","US/Indiana-Starke","US/Michigan","US/Mountain","US/Pacific","US/Samoa","UTC","Universal","W-SU","WET","Zulu"]},"assets[company_rule]":{"type":"array","description":"This asset must be on a company matching a rule. Valid values: 'default', 'any', Array<CompanyID>"},"assets[person_rule]":{"type":"array","description":"This asset must book a person matching a rule. Valid values: 'any', 'any_or_none', Array<PersonID>"},"assets[resource_rule]":{"type":"array","description":"This asset must book a resource matching a rule. Valid values: 'any', 'any_or_none', Array<ResourceID>"},"assets[pre_time]":{"type":"array","description":"Pre Time. Overrides service configuration","items":{"type":"integer","format":"int32","enum":[0,5,10,15,20,25,30,35,40,45,50,55,60,65,70,75,80,85,90,95,100,105,110,115,120,125,130,135,140,145,150,155,160,165,170,175,180,185,190,195,200,205,210,215,220,225,230,235,240,245,250,255,260,265,270,275,280,285,290,295,300,305,310,315,320,325,330,335,340,345,350,355,360,365,370,375,380,385,390,395,400,405,410,415,420,425,430,435,440,445,450,455,460,465,470,475,480,485,490,495,500,505,510,515,520,525,530,535,540,545,550,555,560,565,570,575,580,585,590,595,600,605,610,615,620,625,630,635,640,645,650,655,660,665,670,675,680,685,690,695,700,705,710,715,720,725,730,735,740,745,750,755,760,765,770,775,780,785,790,795,800,805,810,815,820,825,830,835,840,845,850,855,860,865,870,875,880,885,890,895,900,905,910,915,920,925,930,935,940,945,950,955,960,965,970,975,980,985,990,995,1000,1005,1010,1015,1020,1025,1030,1035,1040,1045,1050,1055,1060,1065,1070,1075,1080,1085,1090,1095,1100,1105,1110,1115,1120,1125,1130,1135,1140,1145,1150,1155,1160,1165,1170,1175,1180,1185,1190,1195,1200,1205,1210,1215,1220,1225,1230,1235,1240,1245,1250,1255,1260,1265,1270,1275,1280,1285,1290,1295,1300,1305,1310,1315,1320,1325,1330,1335,1340,1345,1350,1355,1360,1365,1370,1375,1380,1385,1390,1395,1400,1405,1410,1415,1420,1425,1430,1435,1440]}},"assets[post_time]":{"type":"array","description":"Post Time. Overrides service configuration","items":{"type":"integer","format":"int32","enum":[0,5,10,15,20,25,30,35,40,45,50,55,60,65,70,75,80,85,90,95,100,105,110,115,120,125,130,135,140,145,150,155,160,165,170,175,180,185,190,195,200,205,210,215,220,225,230,235,240,245,250,255,260,265,270,275,280,285,290,295,300,305,310,315,320,325,330,335,340,345,350,355,360,365,370,375,380,385,390,395,400,405,410,415,420,425,430,435,440,445,450,455,460,465,470,475,480,485,490,495,500,505,510,515,520,525,530,535,540,545,550,555,560,565,570,575,580,585,590,595,600,605,610,615,620,625,630,635,640,645,650,655,660,665,670,675,680,685,690,695,700,705,710,715,720,725,730,735,740,745,750,755,760,765,770,775,780,785,790,795,800,805,810,815,820,825,830,835,840,845,850,855,860,865,870,875,880,885,890,895,900,905,910,915,920,925,930,935,940,945,950,955,960,965,970,975,980,985,990,995,1000,1005,1010,1015,1020,1025,1030,1035,1040,1045,1050,1055,1060,1065,1070,1075,1080,1085,1090,1095,1100,1105,1110,1115,1120,1125,1130,1135,1140,1145,1150,1155,1160,1165,1170,1175,1180,1185,1190,1195,1200,1205,1210,1215,1220,1225,1230,1235,1240,1245,1250,1255,1260,1265,1270,1275,1280,1285,1290,1295,1300,1305,1310,1315,1320,1325,1330,1335,1340,1345,1350,1355,1360,1365,1370,1375,1380,1385,1390,1395,1400,1405,1410,1415,1420,1425,1430,1435,1440]}},"assets[person_group_id]":{"type":"array","description":"Person Group ID. This will overwrite the person_rule","items":{"type":"integer","format":"int32"}},"assets[resource_group_id]":{"type":"array","description":"Resource Group ID. This will overwrite the resource_rule","items":{"type":"integer","format":"int32"}},"requested_assets[company_rule]":{"type":"array","description":"This asset must be on a company matching a rule. Valid values: 'default', 'any', Array<CompanyID>. requested_assets is deprecated, please assets"},"requested_assets[person_rule]":{"type":"array","description":"This asset must book a person matching a rule. Valid values: 'any', 'any_or_none', Array<PersonID>. requested_assets is deprecated, please assets"},"requested_assets[resource_rule]":{"type":"array","description":"This asset must book a resource matching a rule. Valid values: 'any', 'any_or_none', Array<ResourceID>. requested_assets is deprecated, please assets"},"questions[id]":{"type":"array","items":{"type":"integer","format":"int32"}},"questions[answer]":{"type":"array","items":{"type":"string"}}}}}},"required":true},"responses":{"201":{"description":"Basket","content":{"application/vnd.bookingbug-hal-v2+json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/ServiceItem"}},"application/vnd.bookingbug-nolinks-v2+json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/ServiceItem"}}}}}},"delete":{"tags":["Basket Service Item"],"summary":"Delete Basket Item","description":"Remove an item from the shopping basket. If the basket or item\ncannot be found, a HTTP 404 status is yielded.","operationId":"deleteV5BasketsBasketIdServiceItemsServiceItemId","parameters":[{"name":"service_item_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"basket_id","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"204":{"description":"Delete Basket Item","content":{"application/vnd.bookingbug-hal-v2+json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/Baskets"}},"application/vnd.bookingbug-nolinks-v2+json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/Baskets"}}}},"404":{"description":"When the basket or item in it cannot be found","content":{}}}}},"/baskets/{basket_id}/service_items/{service_item_id}/attendees":{"get":{"tags":["Basket Service Item Attendee"],"summary":"Obtains Attendees of Booking","description":"Obtains booking's attendees after it was added to booking","operationId":"getV5BasketsBasketIdServiceItemsServiceItemIdAttendees","parameters":[{"name":"basket_id","in":"path","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"service_item_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":["Basket Service Item Attendee"],"summary":"Add Attendees To Booking","description":"Add attendee to booking","operationId":"postV5BasketsBasketIdServiceItemsServiceItemIdAttendees","parameters":[{"name":"basket_id","in":"path","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"service_item_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"}}}}}}},"/baskets/{basket_id}/service_items/{service_item_id}/attendees/{attendee_id}":{"put":{"tags":["Basket Service Item Attendee"],"summary":"Modify Attendee","description":"Modifies an attendee of the booking","operationId":"putV5BasketsBasketIdServiceItemsServiceItemIdAttendeesAttendeeId","parameters":[{"name":"basket_id","in":"path","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"service_item_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":["Basket Service Item Attendee"],"summary":"Remove Attendee","description":"Deletes booking's attendees after it was added to booking","operationId":"deleteV5BasketsBasketIdServiceItemsServiceItemIdAttendeesAttendeeId","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":"basket_id","in":"path","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"service_item_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":{}}}}},"/baskets/{basket_id}/event_items":{"post":{"tags":["Basket Event Item"],"summary":"Create a Event Item","operationId":"postV5BasketsBasketIdEventItems","parameters":[{"name":"basket_id","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"required":["event_id","questions[answer]","questions[id]","tickets[qty]","tickets[type]"],"type":"object","properties":{"event_id":{"type":"integer","description":"Event id","format":"int32"},"first_name":{"type":"string","description":"First name of the main holder of the tickets"},"last_name":{"type":"string","description":"Last name of the main holder of the tickets"},"email":{"type":"string","description":"The email"},"tickets[qty]":{"type":"integer","description":"How many tickets?","format":"int32"},"tickets[id]":{"type":"integer","description":"If you are using complex tickets and Ticket Pools or Bulk Purchase. This is the id of the Ticket Pool or Bulk Purchase","format":"int32"},"tickets[type]":{"type":"string","description":"Which ticket type do you want?","enum":["normal","group","bulk"]},"questions[id]":{"type":"array","description":"The id of the question you are answering","items":{"type":"integer","format":"int32"}},"questions[answer]":{"type":"array","description":"The answer to the question in text form.","items":{"type":"string"}},"questions[answer_id]":{"type":"array","description":"If this answer relates to one of a list of answers. I.e. from a select box or radio button","items":{"type":"integer","format":"int32"}}}}}},"required":true},"responses":{"201":{"description":"Basket","content":{"application/vnd.bookingbug-hal-v2+json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/EventItem"}},"application/vnd.bookingbug-nolinks-v2+json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/EventItem"}}}}}}},"/baskets/{basket_id}/event_items/{event_item_id}":{"get":{"tags":["Basket Event Item"],"summary":"Read Basket Item","description":"Get the Details of a Specific Item in the Shopping Basket","operationId":"getV5BasketsBasketIdEventItemsEventItemId","parameters":[{"name":"event_item_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"basket_id","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Basket Item","content":{"application/vnd.bookingbug-hal-v2+json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/EventItem"}},"application/vnd.bookingbug-nolinks-v2+json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/EventItem"}}}}}},"put":{"tags":["Basket Event Item"],"summary":"Updates an Event Item","description":"Updates the Event Item in the basket","operationId":"putV5BasketsBasketIdEventItemsEventItemId","parameters":[{"name":"event_item_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"basket_id","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"required":["event_id","questions[answer]","questions[id]","tickets[qty]","tickets[type]"],"type":"object","properties":{"event_id":{"type":"integer","description":"Event id","format":"int32"},"first_name":{"type":"string","description":"First name of the main holder of the tickets"},"last_name":{"type":"string","description":"Last name of the main holder of the tickets"},"email":{"type":"string","description":"The email"},"tickets[qty]":{"type":"integer","description":"How many tickets?","format":"int32"},"tickets[id]":{"type":"integer","description":"If you are using complex tickets and Ticket Pools or Bulk Purchase. This is the id of the Ticket Pool or Bulk Purchase","format":"int32"},"tickets[type]":{"type":"string","description":"Which ticket type do you want?","enum":["normal","group","bulk"]},"questions[id]":{"type":"array","description":"The id of the question you are answering","items":{"type":"integer","format":"int32"}},"questions[answer]":{"type":"array","description":"The answer to the question in text form.","items":{"type":"string"}},"questions[answer_id]":{"type":"array","description":"If this answer relates to one of a list of answers. I.e. from a select box or radio button","items":{"type":"integer","format":"int32"}}}}}},"required":true},"responses":{"201":{"description":"Basket","content":{"application/vnd.bookingbug-hal-v2+json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/EventItem"}},"application/vnd.bookingbug-nolinks-v2+json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/EventItem"}}}}}},"delete":{"tags":["Basket Event Item"],"summary":"Delete Basket Item","description":"Remove an item from the shopping basket. If the basket or item\ncannot be found, a HTTP 404 status is yielded.","operationId":"deleteV5BasketsBasketIdEventItemsEventItemId","parameters":[{"name":"event_item_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"basket_id","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"204":{"description":"Delete Basket Item","content":{"application/vnd.bookingbug-hal-v2+json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/Basket"}},"application/vnd.bookingbug-nolinks-v2+json; charset=utf-8":{"schema":{"$ref":"#/components/schemas/Basket"}}}},"404":{"description":"When the basket or item in it cannot be found","content":{}}}}},"/baskets/{basket_id}/coupons/{code}":{"put":{"tags":["Basket Coupon"],"summary":"Apply coupon to the basket","description":"Apply coupon to the basket","operationId":"putV5BasketsBasketIdCouponsCode","parameters":[{"name":"code","in":"path","description":"Coupon code","required":true,"schema":{"type":"string"}},{"name":"basket_id","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"201":{"description":"OK","content":{}}}},"delete":{"tags":["Basket Coupon"],"summary":"Delete Basket Coupon","description":"Delete a coupon from a basket","operationId":"deleteV5BasketsBasketIdCouponsCode","parameters":[{"name":"code","in":"path","description":"Coupon code","required":true,"schema":{"type":"string"}},{"name":"basket_id","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"204":{"description":"OK","content":{}}}}}},"components":{"schemas":{"postV5BasketsBasketIdCheckout":{"required":["client"],"type":"object","properties":{"client":{"required":["id"],"type":"object","properties":{"id":{"type":"integer","format":"int32"}}},"take_from_wallet":{"type":"boolean","description":"Use money stored in wallet (true/false)"},"reference":{"type":"string","description":"A custom reference for the booking invoice"},"no_notifications":{"type":"boolean","description":"Determines whether or not to send notifications to Customers & Admins"},"guest_uuid":{"type":"string","description":"The UUID of the invited guest to register for the event"}},"description":"Basket Checkout"},"BasketCollection":{"type":"object","properties":{"_embedded":{"type":"object","properties":{"baskets":{"type":"array","items":{"type":"string"},"example":null}}}},"description":"        Deletes the Basket. Releasing all held items.\n"},"Baskets":{"type":"object","properties":{"company_id":{"type":"integer","example":37009},"expiry_time":{"type":"string","example":"null"},"settings":{"type":"string","example":"null"},"total_price":{"type":"integer","example":2599},"total_due_price":{"type":"integer","example":2599},"deposit":{"type":"integer","example":2599},"id":{"type":"string","example":"null"},"total_price_in_major_units":{"type":"string","example":"null"},"deposit_in_major_units":{"type":"string","example":"null"},"total_due_price_in_major_units":{"type":"string","example":"null"},"service_items":{"type":"array","items":{"type":"string"},"example":null},"event_items":{"type":"array","items":{"type":"string"},"example":null},"_embedded":{"type":"object","properties":{"items":{"type":"array","items":{"type":"string"},"example":null},"items_removed":{"type":"array","items":{"type":"string"},"example":null}}}},"description":"          Remove an item from the shopping basket. If the basket or item\n          cannot be found, a HTTP 404 status is yielded.\n"},"Purchase":{"type":"object","properties":{"total_price":{"type":"number","example":35.9},"price":{"type":"integer","example":2599},"paid":{"type":"integer","example":1399},"deposit":{"type":"integer","example":1200},"tax_payable_on_price":{"type":"integer","example":320},"tax_payable_on_deposit":{"type":"integer","example":434},"tax_payable_on_due_now":{"type":"integer","example":999},"due_now":{"type":"integer","example":1099},"long_id":{"type":"string","example":"hm9S8Yx9oiB_AhyVNjc2"},"id":{"type":"integer","example":92458394},"affiliate_ref":{"type":"string","example":"REFcomd53490"},"client_name":{"type":"string","example":"Joan Feynman"},"created_at":{"type":"string","example":"2024-01-01T12:44:23Z"},"certificate_paid":{"type":"integer","example":5023},"payment_type":{"type":"string","example":"online"},"original_price":{"type":"integer","example":999},"last_payment_log":{"type":"object","properties":{},"example":{"success":1,"response":"last_response_logged"}},"payment_reference":{"type":"string","example":"A48283dfkslf"},"external_ref":{"type":"string","example":"EXTREF321"},"_embedded":{"type":"object","properties":{"client":{"$ref":"#/components/schemas/Client"},"member":{"$ref":"#/components/schemas/Member"},"bookings":{"type":"array","items":{"$ref":"#/components/schemas/Booking"},"example":null},"packages":{"type":"array","items":{"$ref":"#/components/schemas/Package"},"example":null},"products":{"type":"array","items":{"$ref":"#/components/schemas/Product"},"example":null},"pre_paid_bookings":{"type":"array","items":{"$ref":"#/components/schemas/PrePaidBooking"},"example":null},"deals":{"type":"array","items":{"$ref":"#/components/schemas/Deal"},"example":null},"course_bookings":{"type":"array","items":{"$ref":"#/components/schemas/Booking"},"example":null},"external_purchases":{"type":"array","items":{"$ref":"#/components/schemas/ExternalPurchase"},"example":null},"payment_callbacks":{"type":"array","items":{"$ref":"#/components/schemas/PaymentCallback"},"example":null},"confirm_messages":{"type":"array","items":{"$ref":"#/components/schemas/BookingText"},"example":null}}},"refund":{"$ref":"#/components/schemas/Refund"},"price_in_major_units":{"type":"number","example":2599},"total_price_in_major_units":{"type":"number","example":35.9},"paid_in_major_units":{"type":"number","example":1399},"deposit_in_major_units":{"type":"number","example":1200},"tax_payable_on_price_in_major_units":{"type":"number","example":320},"tax_payable_on_deposit_in_major_units":{"type":"number","example":434},"tax_payable_on_due_now_in_major_units":{"type":"number","example":999},"due_now_in_major_units":{"type":"number","example":1099}},"description":"        Confirms the transaction and generates a Purchase.\n        - Will generate all the necessary bookings, will generate tickets\n        - Will generate the slots on the relevant people / resources / services / companies\n        - Will alert both the associated client and all the relevant stakeholders through various channels.\n        - Will delete the current basket.\n"},"ServiceItem":{"type":"object","properties":{"id":{"type":"string","example":"null"},"type":{"type":"string","example":"null"},"company_id":{"type":"integer","example":37009},"service_id":{"type":"integer","example":37009},"person_id":{"type":"integer","example":37009},"resource_id":{"type":"integer","example":37009},"attachment_id":{"type":"integer","example":37009},"questions":{"type":"array","example":[{"id":1,"answer":"Some answer"}],"items":{"type":"string"}},"duration":{"type":"integer","example":60},"start":{"type":"string","example":"2019/09/05T09:00"},"expires":{"type":"string","example":"null"},"price":{"type":"integer"},"total_price":{"type":"number","example":2500.23},"discount_price":{"type":"integer","example":4355},"price_in_major_units":{"type":"integer"},"total_price_in_major_units":{"type":"number","example":100.98},"discount_price_in_major_units":{"type":"integer"},"requested_assets":{"type":"array","example":[{"company_id":"default","person_id":[14]}],"items":{"type":"string"}},"held_assets":{"type":"array","example":[{"company_id":2,"person_id":14}],"items":{"type":"string"}}},"description":"          Get the Details of a Specific Item in the Shopping Basket\n"},"DateCollection":{"type":"object","properties":{"dates":{"type":"array","items":{"type":"string"},"example":null}},"description":"          Get a list of available dates in which bookings can occur\n\n          The amount of times left available on each day are specified\n\n          If person_id and resource_id are not specified and the service has multiple people\n          or resources (as specified by the who/what/where config), it will count the times\n          for any given date\n"},"ServiceItemAvailability":{"type":"object","properties":{"start":{"type":"string","example":"null"},"available":{"type":"string","example":"null"},"durations":{"type":"string","example":"null"},"prices":{"type":"string","example":"null"},"listed_durations":{"type":"string","example":"null"}},"description":"Read Time"},"ServiceItemAvailabilityCollection":{"type":"object","properties":{"_embedded":{"type":"object","properties":{"times":{"type":"array","items":{"type":"string"},"example":null}}}},"description":"          Get a list of available booking start times for a particular day.\n\n          The available durations and prices are included under each start time.\n\n          If person_id and resource_id are not specified and the service has multiple people or\n          resources (as specified by the who/what/where config), times that are the same but differ by\n          person or resource are merged together by default. If booking a particular person or\n          resource either pass in their IDs in the person_id and resource_id params or pass the\n          merge_times param as false.\n\n          Requested Assets (`requested_assets`), this parameters describe a list of rules which a time must\n          satisfy to be considered available.\n\n          A Requested asset consists of a\n          * company_rule -> can be either `default` (it will respect the company of the URL), `any` (it can be any company that provides the service), or `Array<CompanyID>` one of these companies (which must provide the service).\n          * person_rule -> can be either `any` (any person which provides the service), `any_or_none` (the user is indifferent as to whether a person is associated to the booking), `Array<PersonID>` one of these people who provide the service.\n          * resource_rule -> same as person_rule:  can be either `any` (any resource which provides the service), `any_or_none` (the user is indifferent as to whether a resource is associated to the booking), `Array<PersonID>` one of these resources with which the service can be provided.\n\n          Factors that influence availability include:\n\n          * Service, Person and Resource schedules\n          * Bookings and blocked time\n          * Company opening hours\n          * Max/min advance\n          * Min/max consecutive bookings (fixed time service)\n          * Durations (flex time service)\n          * Travel time (flex time service)\n          * Booking time step\n"},"Attachment":{"type":"object","properties":{"id":{"type":"integer","example":1},"name":{"type":"string","example":"MyUploadedFile"},"file_type":{"type":"string","example":"application/pdf"},"url":{"type":"string","example":"https://s3.amazonaws.com/test/uk/files/1/MyUploadedFile?AWSAccessKeyId=<AMAZON_ACCESS_KEY>&Expires=1504872516&Signature=<SIGNATURE>"},"file_size":{"type":"string","example":"null"},"created_at":{"type":"string","example":"null"},"updated_at":{"type":"string","example":"null"},"user_name":{"type":"string","example":"user one"}},"description":"        Get an attchment\n"},"AttachmentCollection":{"type":"object","properties":{"_embedded":{"type":"object","properties":{"attachments":{"type":"array","items":{"type":"string"},"example":null}}}},"description":"        List attchments\n"},"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"},"EventItem":{"type":"object","properties":{"_embedded":{"type":"object","properties":{"attendees":{"type":"array","items":{"type":"string"},"example":null},"event":{"$ref":"#/components/schemas/Event"},"event_chain":{"$ref":"#/components/schemas/EventChain"},"event_group":{"$ref":"#/components/schemas/EventGroup"}}},"event_id":{"type":"integer","example":69504},"member_id":{"type":"integer","example":4334},"person_id":{"type":"integer","example":590213},"resource_id":{"type":"integer","example":1053},"event_chain_id":{"type":"integer","example":86543},"price":{"type":"integer","example":2500},"paid":{"type":"integer","example":1250},"num_book":{"type":"integer","example":54},"person_name":{"type":"string","example":"Emmy Noether"},"event_chain_name":{"type":"string","example":"Physics 101"},"resource_name":{"type":"string","example":"Class 1A"},"event_group_name":{"type":"string","example":"Electronics 101"},"status":{"type":"integer","example":4},"id":{"type":"integer","example":23423},"date":{"type":"string","example":"2024-01-11"},"time":{"type":"integer","example":630},"questions":{"type":"array","example":[{"id":1,"answer":"Some answer"}],"items":{"type":"string"}},"settings":{"type":"object","properties":{},"example":{"setting_1":"value_1","setting_2":2}},"private_note":{"type":"string","example":"A private note"},"tickets":{"type":"object","properties":{},"example":{"id":1,"qty":"2","type":"normal"}},"total_price":{"type":"number","example":2500.23},"available_slot":{"type":"integer","example":73462},"recipient":{"type":"string","example":"The Recipient"},"recipient_mail":{"type":"string","example":"t.recipient@email.com"},"first_name":{"type":"string","example":"Augustus"},"first_name_extra":{"type":"string","example":"Furigana first"},"last_name":{"type":"string","example":"De Morgan"},"last_name_extra":{"type":"string","example":"Furigana last"},"email":{"type":"string","example":"a.demorgan@email.com"},"service_group_id":{"type":"integer","example":18594},"ref":{"type":"integer"},"person_group_id":{"type":"integer","example":43895834},"type":{"type":"string","example":"event_item"},"expires":{"type":"string","example":"null"},"price_in_major_units":{"type":"string","example":"null"},"paid_in_major_units":{"type":"string","example":"null"},"total_price_in_major_units":{"type":"string","example":"null"},"discount_price_in_major_units":{"type":"string","example":"null"},"custom_price_in_major_units":{"type":"string","example":"null"},"certificate_paid_in_major_units":{"type":"string","example":"null"}},"description":"          Get the Details of a Specific Item in the Shopping Basket\n"},"Basket":{"type":"object","properties":{"company_id":{"type":"integer","example":37009},"expiry_time":{"type":"string","example":"null"},"settings":{"type":"string","example":"null"},"total_price":{"type":"integer","example":2599},"total_due_price":{"type":"integer","example":2599},"deposit":{"type":"integer","example":2599},"id":{"type":"string","example":"null"},"_embedded":{"type":"object","properties":{"items_removed":{"type":"array","items":{"type":"string"},"example":null},"items":{"type":"array","items":{"type":"string"},"example":null}}}},"description":"          Remove an item from the shopping basket. If the basket or item\n          cannot be found, a HTTP 404 status is yielded.\n"},"Package":{"type":"object","properties":{"id":{"type":"integer","example":952693},"name":{"type":"string","example":"Name of package"},"description":{"type":"string","example":"Description of package"},"price":{"type":"integer","example":2500},"paid":{"type":"integer","example":1250}}},"Product":{"type":"object","properties":{"id":{"type":"integer","example":107470},"name":{"type":"string","example":"Name of product"},"description":{"type":"string","example":"A description of the product"},"group":{"type":"string","example":"Group"},"make":{"type":"string","example":"Make of the product"},"sku":{"type":"string","example":"BB-CM-LGE-WH"},"qty":{"type":"integer","example":3},"price":{"type":"integer","example":100},"paid":{"type":"integer","example":0}}},"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}}},"Deal":{"type":"object","properties":{"id":{"type":"integer","example":712133},"name":{"type":"integer"},"ref":{"type":"string","example":"REF1234"},"num":{"type":"integer","example":2},"description":{"type":"integer"},"category_id":{"type":"integer","example":40190},"service_id":{"type":"integer","example":394279},"affiliate_id":{"type":"integer","example":101758},"price":{"type":"integer","example":822},"link":{"type":"string","example":"hyperlink/to/deal"},"tandc":{"type":"string","example":"Terms and Conditions"},"vendor":{"type":"string","example":"Deal vendor"},"allow_mixed_bookings":{"type":"boolean","example":false},"widget_show":{"type":"boolean","example":true},"detail_group_id":{"type":"integer","example":462655},"recipient":{"type":"object","properties":{},"example":{"recipient_name":"Robert Hooke","recipient_email":"r.hooke@email.com"}},"deal_code":{"type":"string","example":"CODE299"}}},"DealCode":{"type":"object","properties":{"id":{"type":"integer","example":208334},"description":{"type":"string","example":"Deal description"},"value":{"type":"integer","example":499},"num_used":{"type":"integer","example":2},"part_used":{"type":"boolean","example":true},"deal_code":{"type":"string","example":"CODE14"}}},"PaymentCallback":{"type":"object","properties":{"verification_key":{"type":"string","example":"44kgjer54964c5e349gjkfgj485"},"payer_name":{"type":"string","example":"Carl Payer"},"payer_email":{"type":"string","example":"carl.payer@email.com"},"payer_id":{"type":"integer","example":512687},"receiver_email":{"type":"integer"},"payment_date":{"type":"string","example":"2024-01-03"},"amount":{"type":"integer","example":30000}}},"BookingText":{"type":"object","properties":{"id":{"type":"integer","example":801502},"message":{"type":"string","example":"Booking made successfully"},"message_type":{"type":"string","example":"Booking"},"item_type":{"type":"string","example":"Person"}}},"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}}}}},"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"}}},"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}}