SIU-Kolla/Version 3.6.0/WS/Habilitaciones
Servicios Web sobre Habilitaciones
La definición de Habilitación podrá encontrarla en el glosario
Habilitaciones
Crear Habilitación
- Descripción: Crear una habilitación con los datos básicos
- Método HTTP: POST
- URL: /habilitaciones?unidad_gestion={id unidad gestión}
- Parámetro de body:
- Formato: JSON
- Estructura:
{"fecha_desde":"string"(requerido), "fecha_hasta":"string"(requerido), "paginado":"string", "anonima":"string", "estilo":"string", "password":"string", "descripcion":"string"(requerido), "texto_preliminar":"string", "generar_codigo_recuperacion":"string", "url_imagenes_base":"string", "unidad_gestion":"string" }
- Resultado:
- Formato: JSON
- Estructura:
{"habilitacion":"string"}
Listado de Habilitaciones
- Descripción: Retorna un listado de habilitaciones disponibles para una Unidad de Gestión dada.
- Método HTTP: GET
- URL: /habilitaciones?unidad_gestion={id unidad gestión}
- Resultado:
- Formato: JSON
- Estructura:
[{"habilitacion":"string", "fecha_desde":"string", "fecha_hasta":"string", "paginado":"string", "anonima":"string", "estilo":"string", "password":"string", "descripcion":"string", "texto_preliminar":"string", "generar_codigo_recuperacion":"string", "url_imagenes_base":"string", "unidad_gestion":"string" }]
Modificar Habilitación
- Descripción: Modifica los datos de una habilitación.
- Método HTTP: PUT
- URL: /habilitaciones/{id habilitacion}?unidad_gestion={id unidad gestión}
- Parámetro de body:
- Formato: JSON
- Estructura:
{"fecha_desde":"string"(requerido), "fecha_hasta":"string"(requerido), "paginado":"string", "anonima":"string", "estilo":"string", "password":"string", "descripcion":"string"(requerido), "texto_preliminar":"string", "generar_codigo_recuperacion":"string", "url_imagenes_base":"string", "unidad_gestion":"string" }
- Resultado:201 Modificación exitosa
Obtener Habilitación
- Descripción: Retorna los datos de una habilitación dada.
- Método HTTP: GET
- URL: /habilitaciones/{id habilitacion}?unidad_gestion={id unidad gestión}
- Resultado:
- Formato: JSON
- Estructura:
{"habilitacion":"string", "fecha_desde":"string", "fecha_hasta":"string", "paginado":"string", "anonima":"string", "estilo":"string", "password":"string", "descripcion":"string", "texto_preliminar":"string", "generar_codigo_recuperacion":"string", "url_imagenes_base":"string", "unidad_gestion":"string" }
Formularios
Crear Formularios masivamente
- Descripción: Crea un conjunto de formularios para una habilitación. Se procesan en orden e individualmente. En caso de errores se retorna un arreglo con la descripción según el indice.
- Método HTTP: PUT
- URL: /habilitaciones/{id habilitacion}/formularios/masivos?unidad_gestion={id unidad gestión}
- Parámetro de body:
- Formato: JSON
- Estructura:
[{ "formulario":"string", "nombre":"string", "concepto":"string", "estado":"string", "detalle": [{"encuesta":"string", "elemento":"string", "orden":"string"}] }]
- Resultado: 204 Los formularios se crearon correctamente
Crear Formularios individual
- Descripción: Crea un conjunto de formularios para una habilitación. Se procesan en orden e individualmente. En caso de errores se retorna un arreglo con la descripción según el indice.
- Método HTTP: PUT
- URL: /habilitaciones/{id habilitacion}/formularios/{id formulario}?unidad_gestion={id unidad gestión}
- Parámetro de body:
- Formato: JSON
- Estructura:
{ "formulario":"string", "nombre":"string", "concepto":"string", "estado":"string", "detalle": [{"encuesta":"string", "elemento":"string", "orden":"string"}] }]
- Resultado: 204 El formulario se creó correctamente
Obtener Formularios
- Descripción: Obtiene una lista de los formularios en una habilitación.
- Método HTTP: GET
- URL: /habilitaciones/{id habilitacion}/formularios?unidad_gestion={id unidad gestión}
- Resultado:
- Formato: JSON
- Estructura:
[{ "formulario":"string", "nombre":"string", "concepto":"string", "estado":"string", "detalle": [{"encuesta":"string", "elemento":"string", "orden":"string"}] }]
Obtener un Formulario
- Descripción: Obtiene un formulario en una habilitación.
- Método HTTP: GET
- URL: /habilitaciones/{id habilitacion}/formularios/{id formulario}?unidad_gestion={id unidad gestión}
- Resultado:
- Formato: JSON
- Estructura:
{ "formulario":"string", "nombre":"string", "concepto":"string", "estado":"string", "detalle": [{"encuesta":"string", "elemento":"string", "orden":"string"}] }
Eliminar un Formulario
- Descripción: Elimina el formulario si existe.
- Método HTTP: DELETE
- URL: /habilitaciones/{id habilitacion}/formulario/{id formulario}?unidad_gestion={id unidad gestión}
- Resultado: 204 El Formulario se elimino correctamente
