Bookker API Documentation logo Bookker API Documentation

DEPRECATED - Comprobar disponibilidad de los espacios y puestos

Última modificación: 04/02/2021

Comprobar disponibilidad

Comprueba la disponibilidad de los recursos teniendo en cuenta los siguientes criterios:

Request

HTTP request
Workstations

GET /api/v1/users/me/buildings/{buildingId}/workstations/subcategories/{subcategoryId}/free
GET /api/v1/users/{userId}/buildings/{buildingId}/workstations/subcategories/{subcategoryId}/free


Spaces

GET /api/v1/users/me/buildings/{buildingId}/spaces/subcategories/{subcategoryId}/free
GET /api/v1/users/{userId}/buildings/{buildingId}/spaces/subcategories/{subcategoryId}/free
Headers
Header Value Required
Authorization Bearer eyJ0eXBlIjoiSldUIiwiYWxnIjoiSFM1MT… true
Params
Param Value Required
bookingDays List<BookingDay> true
features Array de identificadores de las características por las que se quiere filtrar. false
capacity Capacidad mínima de los espacios. Solo disponible para espacios. false
isSupervisedBooking Indica si se está intentando realizar una reserva supervisada. Solo disponible para puestos. false
allDayBookings Indica si se está intentando realizar una reserva para todo el día. Solo disponible para puestos. false
createOnlineMeeting Booleano que indica si se va a intentar crear una reserva online. Solo disponible para espacios. false
¡Importante! - Ejemplo de uso del parámetro bookingDays.

Para utilizar una lista en los parámetros de una petición GET hay que hacerlo de la siguiente forma:

http://localhost:9010/api/v1/users/{userId}/buildings/{buildingId}/workstations/subcategories/{subcategoryId}/free?bookingDays[0].startDate=1561708800000&bookingDays[0].endDate=1561712400000&bookingDays[1].startDate=1561723200000&bookingDays[1].endDate=1561730400000

Sin embargo, para poder realizar la petición correctamente hay que encodear la URL ya que los corchetes "[]" son carácteres no válidos.

Request Example
GET http://localhost:9010/api/v1/users/me/buildings/5068c634-064d-4e15-b17f-1a420c68f051/workstations/subcategories/eaacb523-7a8b-44d4-a3b2-d67f036a3b1c/free?bookingDays%5B0%5D.startDate=1561708800000&bookingDays%5B0%5D.endDate=1561712400000&bookingDays%5B1%5D.startDate=1561723200000&bookingDays%5B1%5D.endDate=1561730400000&features=faf57caf-53ed-410f-bf3d-39f220593ba7,asd57caf-53ed-230f-bf3d-39f220593c4r

Response

Si se han conseguido procesar la petición, se devuelve un código 200 con la información de los recursos disponibles.

Workstation Response

HTTP/1.1 200 OK
Content-type: application/json
{
    "freeResources": [
        {
            "id": "50b5e144-025d-4693-8645-f8c2ae450995",
            "name": "Puesto #1",
            "posterCode": "A01PB",
            "image": "https://api.develop.bookkercorp.com/api/v1/bookker/download/organizations/8aee218a-fce2-4900-9410-00f485a2729e/users/5432a51ff76e4e349a0fcd6759eeaa0a.jpeg",
            "phone": "941576132",
            "mapCoordinates": {
                "topLeftX": 692,
                "topLeftY": 3209,
                "bottomRightX": 742,
                "bottomRightY": 3259
            },
            "approachable": true,
            "floor": {
                "id": "f2f67b2e-6726-4df5-b0c6-a52d9d994a95"
            },
            "subcategory": {
                "id": "eaacb523-7a8b-44d4-a3b2-d67f036a3b1c"
            },
            "visible": true
        }
    ]
}

Space Response

HTTP/1.1 200 OK
Content-type: application/json
{
    "freeResources": [
        {
            "id": "b5fcf35f-bba2-4050-a246-631dac18e014",
            "name": "Despacho principal",
            "posterCode": "D01P3",
            "image": "https://api.develop.bookkercorp.com/api/v1/bookker/download/organizations/8aee218a-fce2-4900-9410-00f485a2729e/users/5432a51ff76e4e349a0fcd6759eeaa0a.jpeg",
            "phone": "941827392",
            "mapCoordinates": {
                "topLeftX": 803,
                "topLeftY": 685,
                "bottomRightX": 1042,
                "bottomRightY": 894
            },
            "approachable": true,
            "floor": {
                "id": "f2f67b2e-6726-4df5-b0c6-a52d9d994a95"
            },
            "subcategory": {
                "id": "9badbe29-e0d3-4dfc-a4b0-1093066db89e"
            },
            "visible": true,
            "capacity": 30
        }
    ]
}

BookingDay

Properties

Name Type Description
startDate Long Fecha y hora en milisegundos del inicio de la reserva.
endDate Long Fecha y hora en milisegundos del fin de la reserva.
{
    "startDate": 1561557600000,
    "endDate": 1561559400000
}