Saltearse al contenido
Koibox Documentación para desarrolladores de Koibox

Recuperar el listado de bloqueos en la agenda

GET
/api/bloqueos/

Authorizations

Parameters

Query Parameters

id__in
Array<integer>
fecha__gte
string format: date-time
fecha__lte
string format: date-time
hora_inicio__gte
string format: date-time
hora_inicio__lte
string format: date-time
hora_fin__gte
string format: date-time
hora_fin__lte
string format: date-time
user
integer
user__in
Array<integer>
is_online
boolean
cita__isnull
boolean
cita
integer
limit
integer
offset
integer

Responses

200

Listado de los bloqueos solicitados

object
count
integer
next
One of:
string format: uri
previous
One of:
string format: uri
results
Array
<= 50 items
object
id

Solo lectura

integer
created

Solo lectura

string format: date-time
updated

Solo lectura

string format: date-time
created_by

Id del usuario creador, solo lectura

integer
user
required

Id del usuario al que afecta el bloqueo

integer
centro
required
integer
fecha
required

Fecha del bloqueo, se espera en zona horaria del centro

string format: date
hora_inicio
required
string format: time
hora_fin
required
string format: time
titulo
required
string
recurrencia
required

Cada cuanto se repite el bloqueo, day_1___ == cada día

string
Allowed values: none day_1___ week_1___ week_2___ month_1___
is_online

Determina si el bloqueo afecta a las reservas online. Obligatorio si cita no es nulo

boolean
cita

Cita online que ha creado el bloqueo. Obligatorio si is_online es true

integer
employee_name

Nombre completo del empleado, solo lectura

string
recurrence_description

Solo lectura

string

401

No se ha proporcionado la clave de acceso en la header X-Koibox-Key

Headers

WWW-Authenticate
string
default: X-Koibox-Key

Indica la cabecera requerida para la autenticación

403

No se ha proporcionado una clave de acceso válida