{"openapi":"3.0.0","servers":[{"description":"SwaggerHub API Auto Mocking","url":"https://virtserver.swaggerhub.com/AB-Apartment-BCN/AB-Helping-API/1.0.0"},{"description":"AB Apartment Barcelona API","url":"https://api.apartmentbarcelona.com/api/v1/helping"}],"info":{"version":"1.0.0","title":"AB Helping API","contact":{"email":"webmaster@apartmentbarcelona.com"},"license":{"name":"Apache 2.0","url":"http://www.apache.org/licenses/LICENSE-2.0.html"}},"paths":{"/booking-list":{"post":{"requestBody":{"required":true,"description":"Priority filter:<br>1) bookingID<br>2) Property ID<br>3) Customer email<br>4) Customer phone<br>5) Data updates (true: updates; false: other filters)<br>6) DateFrom-DateTo booking date (max 31 days diff between them)<br>7) Year and month booking date<br>8) Any filter: active and future bookings","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BookingsBodyPost"}}}},"tags":["API Endpoints"],"summary":"List of bookings","security":[{"ApiKeyAuth":[]}],"operationId":"booking-list","description":"Get list of bookings\n","responses":{"200":{"description":"Response was received and processed","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Bookings"}}}}},"401":{"description":"Invalid integration API key value"},"404":{"description":"Not Found"}}}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"Authorization"}},"schemas":{"BookingsBodyPost":{"type":"object","required":["year","month","dateFrom","dateTo","bookingID","propertyID","customerEmail","customerPhone","dataUpdates"],"properties":{"year":{"type":"integer","description":"Get booking data by year/month"},"month":{"type":"integer","description":"Get booking data by year/month"},"dateFrom":{"type":"string","description":"Date from to get booking data [MM/dd/yyyy]"},"dateTo":{"type":"string","description":"Date to to get booking data [MM/dd/yyyy]"},"bookingID":{"type":"integer","description":"Get booking by ID"},"propertyID":{"type":"integer","description":"Get property bookings by property ID"},"customerEmail":{"type":"string","description":"Get property bookings by customer email"},"customerPhone":{"type":"string","description":"Get property bookings by customer phone"},"dataUpdates":{"type":"boolean","description":"Get only booking updates"}}},"Bookings":{"type":"object","properties":{"bookingID":{"type":"integer","description":"Booking ID"},"bookingLocator":{"type":"string","description":"Booking Locator"},"bookingDate":{"type":"string","description":"Booking date of creation [yyyy/MM/dd]"},"bookingDateCheckin":{"type":"string","description":"Booking date of check-in [yyyy/MM/dd]"},"bookingDateCheckout":{"type":"string","description":"Booking date of check-out [yyyy/MM/dd]"},"bookingCheckinEntranceTime":{"type":"string","description":"Booking time of check-in [HH:mm]"},"bookingCheckinDepartureTime":{"type":"string","description":"Booking time of check-out [HH:mm]"},"bookingNights":{"type":"integer","description":"Booking number of stay nights"},"bookingCancelled":{"type":"boolean","description":"Booking status cancelled"},"bookingCheckinOnline":{"type":"boolean","description":"Booking checkin online completed"},"bookingCheckinAllowed":{"type":"boolean","description":"Booking checkin allowed"},"bookingPrepayment":{"type":"number","description":"Booking pre-payment (amount)"},"bookingChannel":{"type":"string","description":"Booking source ['AB', 'Airbnb', etc.]"},"bookingCases":{"type":"boolean","description":"Booking has cases"},"numGuests":{"type":"integer","description":"Number of guests"},"ownerOwnMaintenance":{"type":"boolean","description":"Owner with own maintenance"},"guestExperience":{"type":"array","items":{"type":"string","maxLength":1},"description":"Guest experience [R,K,B,S]"},"customer":{"$ref":"#/components/schemas/Customer"},"property":{"$ref":"#/components/schemas/Property"},"cases":{"type":"array","items":{"$ref":"#/components/schemas/Cases"}}}},"Customer":{"type":"object","properties":{"customerName":{"type":"string"},"customerEmail":{"type":"string"},"customerPhonenumber":{"type":"string"},"customerLanguage":{"type":"string"}}},"Property":{"type":"object","properties":{"propertyID":{"type":"integer"},"propertyName":{"type":"string"},"propertyAddress":{"type":"string"},"propertyKey":{"type":"string"},"propertyWifiID":{"type":"string"},"propertyWifiPassword":{"type":"string"},"propertyManageType":{"type":"string"},"propertyDistrict":{"type":"string"},"propertyNumBedrooms":{"type":"integer"},"propertyNumBeds":{"type":"integer"},"propertySingleBeds":{"type":"integer"},"propertyDoubleBeds":{"type":"integer"},"propertySingleSofaBeds":{"type":"integer"},"propertyDoubleSofaBeds":{"type":"integer"},"propertyNumBathrooms":{"type":"number"},"propertyCapacity":{"type":"integer"},"propertySquareMeters":{"type":"integer"},"propertyAmenities":{"$ref":"#/components/schemas/PropertyAmenities"}}},"PropertyAmenities":{"type":"object","properties":{"propertyAmenityPetsAllowed":{"type":"boolean"},"propertyAmenityWheelchairAccess":{"type":"boolean"},"propertyAmenityAirConditioning":{"type":"boolean"},"propertyAmenityAirConditioningHotCold":{"type":"boolean"},"propertyAmenityCentralHeating":{"type":"boolean"},"propertyAmenityElevator":{"type":"boolean"},"propertyAmenityBedLinen":{"type":"boolean"},"propertyAmenityTowels":{"type":"boolean"},"propertyAmenityTV":{"type":"boolean"},"propertyAmenitySmartTV":{"type":"boolean"},"propertyAmenityInternet":{"type":"boolean"},"propertyAmenityIron":{"type":"boolean"},"propertyAmenityIronBoard":{"type":"boolean"},"propertyAmenityHairDryer":{"type":"boolean"},"propertyAmenityWashingMachine":{"type":"boolean"},"propertyAmenityDryer":{"type":"boolean"},"propertyAmenitySafe":{"type":"boolean"}}},"Cases":{"type":"object","properties":{"caseID":{"type":"integer"},"caseActive":{"type":"boolean"},"caseStatusID":{"type":"integer"},"caseStatus":{"type":"string"},"caseSubject":{"type":"string"},"caseDescription":{"type":"string"},"caseCreatedDate":{"type":"string"},"caseUpdatedDate":{"type":"string"}}}}}}