API Salas

Owned by Netex Sistemas
Last updated: Aug 30, 2019
7 min read

Usar codificación de caracteres UTF-8 en el envío de datos

Manual de autenticación y versionado: manual (autenticación y versionado)

Por motivos de seguridad el external_id no puede contener los caracteres \ ni /  (http://tomcat.apache.org/security-6.html).


Crear sala física

Método: POST

URL: /admin/rest/administration/api/physicalrooms

Ejemplo:


Recuerda que por motivos de seguridad, el external_id no puede contener los caracteres \ ni /

Parámetros

  • type = tipo de sala (String, obligatorio)
    • Valores permitidos
      • PHYSICAL_ROOM
      • EXTERNAL_PHYSICAL_ROOM
  • external_id = Id externo (String, obligatorio) (warning) Recuerda que por motivos de seguridad, el external_id no puede contener los caracteres \ ni /
  • name = Nombre (String, obligatorio)
  • capacity = Capacidad de la sala (Integer, opcional)
  • address = Dirección (String, opcional)
  • telephone = Teléfono de contacto (String, opcional)
  • postalCode = Código postal (String, opcional)
  • city = Ciudad (String, opcional)
  • province = Provincia (String, opcional)
  • observations = Observaciones (String, opcional)
  • contactEmail = Dirección de correo electrónico (String, opcional*)
    *El email sólo existe en las salas de tipo EXTERNAL_PHYSICAL_ROOM

Validaciones

  • Lista de parámetros vacía o algún campo obligatorio sin cubrir --> Error ERR001 / 400 (Bad Request)
  • Tipo de sala inválido --> Error ROO001 / 400 (Bad Request)
  • Formato de correo electrónico incorrecto --> Error ROO003 / 400 (Bad Request)
  • External id duplicado --> Error ERR006 / 400 (Bad Request)

Respuesta OK

  • 201 (Created) + cabecera 'Location' con el link al recurso creado

Modificar sala física

Método: PUT

URL:

  • Modificar por id:
    • /admin/rest/administration/api/physicalrooms/id/{id}
  • Modificar por id externo:
    • /admin/rest/administration/api/physicalrooms/externalid/{external_id}


Recuerda que por motivos de seguridad, el external_id no puede contener los caracteres \ ni /

Ejemplo:

Parámetros

  • external_id = Id externo (String, obligatorio) (warning) Recuerda que por motivos de seguridad, el external_id no puede contener los caracteres \ ni /
  • name = Nombre (String, obligatorio)
  • capacity = Capacidad de la sala (Integer, opcional)
  • address = Dirección (String, opcional)
  • telephone = Teléfono de contacto (String, opcional)
  • postalCode = Código postal (String, opcional)
  • city = Ciudad (String, opcional)
  • province = Provincia (String, opcional)
  • observations = Observaciones (String, opcional)
  • contactEmail = Dirección de correo electrónico (String, opcional*)
    *El email sólo existe en las salas de tipo EXTERNAL_PHYSICAL_ROOM

Validaciones

  • Lista de parámetros vacía o algún campo obligatorio sin cubrir --> Error ERR001 / 400 (Bad Request)  
  • Formato de correo electrónico incorrecto --> Error ROO003 / 400 (Bad Request)
  • Si al ampliar la capacidad se produce un error al mover usuarios de la lista de espera a la acción formativa --> Error ROO005 / 400 (Bad Request)
  • External id duplicado --> Error ERR006 / 400 (Bad Request)
  • La sala no existe --> Error 404 (Not Found)
  • Todo OK --> 200 (OK)

Obtener todas las salas físicas

Método: GET

URL:

  • Obtener todas las salas sin paginación:
    • /admin/rest/administration/api/physicalrooms
  • Obtener todas las salas con paginación:
    • /admin/rest/administration/api/physicalrooms?startIndex={startIndex}&count={count}

Ejemplo:

Parámetros

  • startindex = índice inicial para el paginado (Integer, opcional)
  • count = total de elementos a recuperar para el paginado (Integer, opcional)

Campos devueltos en el Json

Listado de salas, cada sala consta de los siguientes campos:

  • id = Identificador
  • external_id = Id externo
  • name = Nombre de sala
  • capacity = Capacidad de la sala (Integer, opcional)
  • address = Dirección (String, opcional)
  • telephone = Teléfono de contacto (String, opcional)
  • postalCode = Código postal (String, opcional)
  • city = Ciudad (String, opcional)
  • province = Provincia (String, opcional)
  • observations = Observaciones (String, opcional)

Validaciones

  • Índices erróneos --> Error 416 (Requested Range Not Satisfiable)
    • Usando paginación, ambos índices deben tener un valor
  • No hay salas--> Error 204 (No Content)
  • Error en la generación del Json --> Error 503 (Service Unavailable)
  • Todo OK
    • Si no hay paginación --> 200 (OK) + JSON
    • Si hay paginación --> 206 (Partial Content) + JSON


Obtener sala física

Método: GET

URL:

  • Obtener por id:
    • /admin/rest/administration/api/physicalrooms/id/{id}
  • Obtener por external id:
    • /admin/rest/administration/api/physicalrooms/externalid/{external_id}


Recuerda que por motivos de seguridad, el external_id no puede contener los caracteres \ ni /

Ejemplo:

Campos devueltos en el Json

Salas físicas, cada grupo consta de los siguientes campos:

  • id = Identificador
  • external_id = Id externo
  • name = Nombre de sala
  • capacity = Capacidad de la sala (Integer, opcional)
  • address = Dirección (String, opcional)
  • telephone = Teléfono de contacto (String, opcional)
  • postalCode = Código postal (String, opcional)
  • city = Ciudad (String, opcional)
  • province = Provincia (String, opcional)
  • observations = Observaciones (String, opcional)

Validaciones

  • El nombre de sala por Id no existe --> Error ERR004 / 404 (Not Found)
  • El nombre de sala por External Id no existe --> Error ERR005 / 404 (Not Found)
  • Error en la generación del Json --> Error 503 (Service Unavailable)
  • Todo OK --> 200 (OK) + JSON

Activar/Desactivar sala física

Método: PUT

URL:

  • Cambiar por id:
    • /admin/rest/administration/api/physicalrooms/id/{id}/status
  • Campiar por external id:
    • /admin/rest/administration/api/physicalrooms/externalid/{externalid}/status


Recuerda que por motivos de seguridad, el external_id no puede contener los caracteres \ ni /

Ejemplo:

Parámetros

  • value = estado al que se desea cambiar la sala (activar o desactivar sala) (String, obligatorio)
    • Valores permitidos
      • active
      • inactive

Validaciones

  • El nombre de sala por Id no existe --> Error ERR004 / 404 (Not Found)
  • El nombre de sala por External Id no existe --> Error ERR005 / 404 (Not Found)
  • Error en la generación del Json --> Error 503 (Service Unavailable)
  • Todo OK --> 200 (OK) + JSON

Eliminar sala física

Método: DELETE

URL:

  • Obtener por id:
    • /admin/rest/administration/api/physicalrooms/id/{id}
  • Obtener por external id:
    • /admin/rest/administration/api/physicalrooms/externalid/{external_id}


Recuerda que por motivos de seguridad, el external_id no puede contener los caracteres \ ni /

Ejemplo:

Validaciones

  • El nombre de sala por Id no existe --> Error ERR004 / 404 (Not Found)
  • El nombre de sala por External Id no existe --> Error ERR005 / 404 (Not Found)
  • La sala está reservada --> Error ROO004 / Error 400 (Bad Request)
  • Error en la generación del Json --> Error 503 (Service Unavailable)
  • Todo OK --> 200 (OK) + JSON


Usar codificación de caracteres UTF-8 en el envío de datos

Información del versionado: Básicos (español)

Por motivos de seguridad el external_id no puede contener los caracteres \ ni /  (http://tomcat.apache.org/security-6.html).


Crear sala física

Método: POST

URL: /admin/rest/administration/api/physicalrooms

Ejemplo:


Recuerda que por motivos de seguridad, el external_id no puede contener los caracteres \ ni /

Parámetros

  • type = tipo de sala (String, obligatorio)
    • Valores permitidos
      • PHYSICAL_ROOM
      • EXTERNAL_PHYSICAL_ROOM
  • external_id = Id externo (String, obligatorio) (warning) Recuerda que por motivos de seguridad, el external_id no puede contener los caracteres \ ni /
  • name = Nombre (String, obligatorio)
  • capacity = Capacidad de la sala (Integer, opcional)
  • address = Dirección (String, opcional)
  • telephone = Teléfono de contacto (String, opcional)
  • postalCode = Código postal (String, opcional)
  • city = Ciudad (String, opcional)
  • province = Provincia (String, opcional)
  • observations = Observaciones (String, opcional)
  • contactEmail = Dirección de correo electrónico (String, opcional*) 
    *El email sólo existe en las salas de tipo EXTERNAL_PHYSICAL_ROOM

Validaciones

  • Lista de parámetros vacía o algún campo obligatorio sin cubrir --> Error ERR001 / 400 (Bad Request)
  • Tipo de sala inválido --> Error ROO001 / 400 (Bad Request)
  • Formato de correo electrónico incorrecto --> Error ROO003 / 400 (Bad Request)
  • External id duplicado --> Error ERR006 / 400 (Bad Request)

Respuesta OK

  • 201 (Created) + cabecera 'Location' con el link al recurso creado

Modificar sala física

Método: PUT

URL:

  • Modificar por id: 
    • /admin/rest/administration/api/physicalrooms/id/{id}
  • Modificar por id externo:
    • /admin/rest/administration/api/physicalrooms/externalid/{external_id}


Recuerda que por motivos de seguridad, el external_id no puede contener los caracteres \ ni /

Ejemplo:

Parámetros

  • external_id = Id externo (String, obligatorio) (warning) Recuerda que por motivos de seguridad, el external_id no puede contener los caracteres \ ni /
  • name = Nombre (String, obligatorio)
  • capacity = Capacidad de la sala (Integer, opcional)
  • address = Dirección (String, opcional)
  • telephone = Teléfono de contacto (String, opcional)
  • postalCode = Código postal (String, opcional)
  • city = Ciudad (String, opcional)
  • province = Provincia (String, opcional)
  • observations = Observaciones (String, opcional)
  • contactEmail = Dirección de correo electrónico (String, opcional*) 
    *El email sólo existe en las salas de tipo EXTERNAL_PHYSICAL_ROOM

Validaciones

  • Lista de parámetros vacía o algún campo obligatorio sin cubrir --> Error ERR001 / 400 (Bad Request)  
  • Formato de correo electrónico incorrecto --> Error ROO003 / 400 (Bad Request)
  • Si al ampliar la capacidad se produce un error al mover usuarios de la lista de espera a la acción formativa --> Error ROO005 / 400 (Bad Request)
  • External id duplicado --> Error ERR006 / 400 (Bad Request)
  • La sala no existe --> Error 404 (Not Found)
  • Todo OK --> 200 (OK)

Obtener todas las salas físicas

Método: GET

URL:

  • Obtener todas las salas sin paginación: 
    • /admin/rest/administration/api/physicalrooms
  • Obtener todas las salas con paginación: 
    • /admin/rest/administration/api/physicalrooms?startIndex={startIndex}&count={count}

Ejemplo:

Parámetros

  • startindex = índice inicial para el paginado (Integer, opcional)
  • count = total de elementos a recuperar para el paginado (Integer, opcional)

Campos devueltos en el Json

Listado de salas, cada sala consta de los siguientes campos:

  • id = Identificador
  • external_id = Id externo
  • name = Nombre de sala
  • capacity = Capacidad de la sala (Integer, opcional)
  • address = Dirección (String, opcional)
  • telephone = Teléfono de contacto (String, opcional)
  • postalCode = Código postal (String, opcional)
  • city = Ciudad (String, opcional)
  • province = Provincia (String, opcional)
  • observations = Observaciones (String, opcional)

Validaciones

  • Índices erróneos --> Error 416 (Requested Range Not Satisfiable)
    • Usando paginación, ambos índices deben tener un valor
  • No hay salas--> Error 204 (No Content)
  • Error en la generación del Json --> Error 503 (Service Unavailable)
  • Todo OK 
    • Si no hay paginación --> 200 (OK) + JSON
    • Si hay paginación --> 206 (Partial Content) + JSON


Obtener sala física

Método: GET

URL:

  • Obtener por id: 
    • /admin/rest/administration/api/physicalrooms/id/{id}
  • Obtener por external id: 
    • /admin/rest/administration/api/physicalrooms/externalid/{external_id}


Recuerda que por motivos de seguridad, el external_id no puede contener los caracteres \ ni /

Ejemplo:

Campos devueltos en el Json

Salas físicas, cada grupo consta de los siguientes campos:

  • id = Identificador
  • external_id = Id externo
  • name = Nombre de sala
  • capacity = Capacidad de la sala (Integer, opcional)
  • address = Dirección (String, opcional)
  • telephone = Teléfono de contacto (String, opcional)
  • postalCode = Código postal (String, opcional)
  • city = Ciudad (String, opcional)
  • province = Provincia (String, opcional)
  • observations = Observaciones (String, opcional)

Validaciones

  • El nombre de sala por Id no existe --> Error ERR004 / 404 (Not Found)
  • El nombre de sala por External Id no existe --> Error ERR005 / 404 (Not Found)
  • Error en la generación del Json --> Error 503 (Service Unavailable)
  • Todo OK --> 200 (OK) + JSON

Activar/Desactivar sala física

Método: PUT

URL:

  • Cambiar por id:
    • /admin/rest/administration/api/physicalrooms/id/{id}/status
  • Campiar por external id:
    • /admin/rest/administration/api/physicalrooms/externalid/{externalid}/status


Recuerda que por motivos de seguridad, el external_id no puede contener los caracteres \ ni /

Ejemplo:

Parámetros

  • value = estado al que se desea cambiar la sala (activar o desactivar sala) (String, obligatorio)
    • Valores permitidos
      • active
      • inactive

Validaciones

  • El nombre de sala por Id no existe --> Error ERR004 / 404 (Not Found)
  • El nombre de sala por External Id no existe --> Error ERR005 / 404 (Not Found)
  • Error en la generación del Json --> Error 503 (Service Unavailable)
  • Todo OK --> 200 (OK) + JSON

Eliminar sala física

Método: DELETE

URL:

  • Obtener por id: 
    • /admin/rest/administration/api/physicalrooms/id/{id}
  • Obtener por external id: 
    • /admin/rest/administration/api/physicalrooms/externalid/{external_id}


Recuerda que por motivos de seguridad, el external_id no puede contener los caracteres \ ni /

Ejemplo:

Validaciones

  • El nombre de sala por Id no existe --> Error ERR004 / 404 (Not Found)
  • El nombre de sala por External Id no existe --> Error ERR005 / 404 (Not Found)
  • La sala está reservada --> Error ROO004 / Error 400 (Bad Request)
  • Error en la generación del Json --> Error 503 (Service Unavailable)
  • Todo OK --> 200 (OK) + JSON