Obtiene la lista de mediciones existentes en el sistema ISOLUCIÓN.
HTTP GET: https://[service_address]/api/mediciones/
[service_address]: Dirección disponible para conectividad con el API, debe validarse con su proveedor de ISOLUCIÓN.
Header | Ejemplo | Descripción |
---|---|---|
Authorization | Basic Tm9tYnJlVXN1YXJpbzpDb250cmFzZcOxYQ== |
Para la autorización sobre el API es necesario un usuario y contraseña, este usuario debe ser creado en el modulo de Usuarios de Isolucion, se recomienda crear un usuario único para la integración. Una vez creado el usuario se debe cifrar en base64 de la siguiente manera NombreUsuario:Contraseña el resultado debe ser algo parecido a Tm9tYnJlVXN1YXJpbzpDb250cmFzZcOxYQ== Cuando se tenga este dato se debe enviar en el encabezado de la petición de la siguiente manera Basic Tm9tYnJlVXN1YXJpbzpDb250cmFzZcOxYQ==
Referencias |
apiKey | YWJjZDEyMzQYWJjZDEyMzQYWJjZDEyMzQ-localhost | Llave otorgada para el uso del API. |
Content-Type | application/json | Tipo de contenido enviado en la solicitud. |
Si requiere paginar los registros se deben enviar estos parametros por query string.
HTTP GET: https://[service_address]/api/[metodo]?RegistroActual=0&TamanoPagina=20
[service_address]: Dirección disponible para conectividad con el API, debe validarse con su proveedor de ISOLUCIÓN.
[metodo]: Hace referencia al objeto de isolucion que queremos consultar (Funcionarios, Mediciones, Cargos, etc).
Nombre del campo | Formato | Tamaño | Descripción | Obligatorio |
---|---|---|---|---|
RegistroActual | Númerico | Indice del registro en el cual se encuentra la consulta. Indice inicial debe ser 0. | Si. | |
TamanoPagina | Númerico | Cantidad total de registros que se quiere traer. Si el tamaño es 0 se consultaran todos los datos | Si. |
Respuesta en Formato JSON a la solicitud de obtener los datos registrados en el sistema.
Campo | Ejemplo | Descripción |
---|---|---|
StatusCode | "StatusCode":200 | Códigos HTTP de respuesta indicando si fue exitoso o no el request realizado. [200,500] Exito,Error. |
Message | "Message":"Lista de Mediciones obtenida exitosamente." | Descripción de la respuesta exitosa o mensaje de error enviado por el servidor. |
Entity | "Entity": [[{data1},{data2}...],null] | Formato JSON con el listado de Mediciones registrados en el sistema. En el caso de respuesta no exitosa el valor es nulo. |
Sample OK Response:
{ "StatusCode": 200, "Message": "Lista de valor Medición obtenida exitosamente.", "Entity": "[{ "StatusCode": 200, "Message": "Lista de valor Medición obtenida exitosamente.", "Entity": "[{\"Indicador\":\"test px1\",\"FechaLectura\":\"2018-01-31T09:34:00\",\"ValorReal\":\"0\",\"ValorEstimado\":\"0\",\"Descripcion\":null,\"Meta\":\"100\",\"ToleranciaSuperior\":\"100\",\"ToleranciaInferior\":\"0\",\"Objeto\":null,\"Numerador\":\"\",\"Denominador\":\"\",\"Oficina\":null,\"Cliente\":null},{\"Indicador\":\"test px1\",\"FechaLectura\":\"2018-01-17T10:45:00\",\"ValorReal\":\"0\",\"ValorEstimado\":\"0\",\"Descripcion\":null,\"Meta\":\"100\",\"ToleranciaSuperior\":\"100\",\"ToleranciaInferior\":\"0\",\"Objeto\":null,\"Numerador\":\"\",\"Denominador\":\"\",\"Oficina\":null,\"Cliente\":null},{\"Indicador\":\"test px1\",\"FechaLectura\":\"2018-04-01T00:00:00\",\"ValorReal\":\"6,67\",\"ValorEstimado\":\"6,67\",\"Descripcion\":\"test1\",\"Meta\":\"65\",\"ToleranciaSuperior\":\"75\",\"ToleranciaInferior\":\"45\",\"Objeto\":\"NoConf\",\"Numerador\":\"0\",\"Denominador\":\"0\",\"Oficina\":null,\"Cliente\":null},{\"Indicador\":\"test px1\",\"FechaLectura\":\"2017-07-01T00:00:00\",\"ValorReal\":\"28,09\",\"ValorEstimado\":\"28,09\",\"Descripcion\":\"dfgfdgfg\",\"Meta\":\"65\",\"ToleranciaSuperior\":\"75\",\"ToleranciaInferior\":\"45\",\"Objeto\":\"No Conformidad de Auditoría No.5\",\"Numerador\":\"0\",\"Denominador\":\"0\",\"Oficina\":null,\"Cliente\":null},{\"Indicador\":\"test px1\",\"FechaLectura\":\"2017-07-01T00:00:00\",\"ValorReal\":\"13,33\",\"ValorEstimado\":\"13,33\",\"Descripcion\":\"123456\",\"Meta\":\"65\",\"ToleranciaSuperior\":\"75\",\"ToleranciaInferior\":\"45\",\"Objeto\":\"NoConf\",\"Numerador\":\"0\",\"Denominador\":\"0\",\"Oficina\":null,\"Cliente\":null},{\"Indicador\":\"test px1\",\"FechaLectura\":\"2018-01-01T00:00:00\",\"ValorReal\":\"100\",\"ValorEstimado\":\"100\",\"Descripcion\":\"Test periodo 2\",\"Meta\":\"65\",\"ToleranciaSuperior\":\"75\",\"ToleranciaInferior\":\"45\",\"Objeto\":\"NotaMejora\",\"Numerador\":\"0\",\"Denominador\":\"0\",\"Oficina\":null,\"Cliente\":null},{\"Indicador\":\"test px1\",\"FechaLectura\":\"2018-01-01T00:00:00\",\"ValorReal\":\"100\",\"ValorEstimado\":\"100\",\"Descripcion\":\"sss\",\"Meta\":\"65\",\"ToleranciaSuperior\":\"75\",\"ToleranciaInferior\":\"45\",\"Objeto\":\"NotaMejora\",\"Numerador\":\"0\",\"Denominador\":\"0\",\"Oficina\":null,\"Cliente\":null}]" }]" }
Sample ERROR Response:
{ "StatusCode": 401, "Message": "Unauthorized : *DESCRIPCION ERROR NO AUTORIZADO*.", "Entity": null }
{ "StatusCode": 500, "Message": "InternalServerError : La solicitud no fue procesada.", "Entity": null }
Obtiene la lista de mediciones existentes en el sistema ISOLUCIÓN de un indicador.
HTTP GET: https://[service_address]/api/mediciones/[codIndicador]
[service_address]: Dirección disponible para conectividad con el API, debe validarse con su proveedor de ISOLUCIÓN.
[codIndicador]: Identificador del indicador, los indentificadores se pueden obtener del metodo Obtener Indicadores
Header | Ejemplo | Descripción |
---|---|---|
Authorization | Basic Tm9tYnJlVXN1YXJpbzpDb250cmFzZcOxYQ== |
Para la autorización sobre el API es necesario un usuario y contraseña, este usuario debe ser creado en el modulo de Usuarios de Isolucion, se recomienda crear un usuario único para la integración. Una vez creado el usuario se debe cifrar en base64 de la siguiente manera NombreUsuario:Contraseña el resultado debe ser algo parecido a Tm9tYnJlVXN1YXJpbzpDb250cmFzZcOxYQ== Cuando se tenga este dato se debe enviar en el encabezado de la petición de la siguiente manera Basic Tm9tYnJlVXN1YXJpbzpDb250cmFzZcOxYQ==
Referencias |
apiKey | YWJjZDEyMzQYWJjZDEyMzQYWJjZDEyMzQ-localhost | Llave otorgada para el uso del API. |
Content-Type | application/json | Tipo de contenido enviado en la solicitud. |
Si requiere paginar los registros se deben enviar estos parametros por query string.
HTTP GET: https://[service_address]/api/[metodo]?RegistroActual=0&TamanoPagina=20
[service_address]: Dirección disponible para conectividad con el API, debe validarse con su proveedor de ISOLUCIÓN.
[metodo]: Hace referencia al objeto de isolucion que queremos consultar (Funcionarios, Mediciones, Cargos, etc).
Nombre del campo | Formato | Tamaño | Descripción | Obligatorio |
---|---|---|---|---|
RegistroActual | Númerico | Indice del registro en el cual se encuentra la consulta. Indice inicial debe ser 0. | Si. | |
TamanoPagina | Númerico | Cantidad total de registros que se quiere traer. Si el tamaño es 0 se consultaran todos los datos | Si. |
Respuesta en Formato JSON a la solicitud de obtener los datos registrados en el sistema.
Campo | Ejemplo | Descripción |
---|---|---|
StatusCode | "StatusCode":200 | Códigos HTTP de respuesta indicando si fue exitoso o no el request realizado. [200,500] Exito,Error. |
Message | "Message":"Lista de Mediciones obtenida exitosamente." | Descripción de la respuesta exitosa o mensaje de error enviado por el servidor. |
Entity | "Entity": [[{data1},{data2}...],null] | Formato JSON con el listado de Mediciones registrados en el sistema. En el caso de respuesta no exitosa el valor es nulo. |
Sample OK Response:
{ "StatusCode": 200, "Message": "Lista de valor Medición obtenida exitosamente.", "Entity": "[{ "StatusCode": 200, "Message": "Lista de valor Medición obtenida exitosamente.", "Entity": "[{\"Indicador\":\"test px1\",\"FechaLectura\":\"2018-01-31T09:34:00\",\"ValorReal\":\"0\",\"ValorEstimado\":\"0\",\"Descripcion\":null,\"Meta\":\"100\",\"ToleranciaSuperior\":\"100\",\"ToleranciaInferior\":\"0\",\"Objeto\":null,\"Numerador\":\"\",\"Denominador\":\"\",\"Oficina\":null,\"Cliente\":null},{\"Indicador\":\"test px1\",\"FechaLectura\":\"2018-01-17T10:45:00\",\"ValorReal\":\"0\",\"ValorEstimado\":\"0\",\"Descripcion\":null,\"Meta\":\"100\",\"ToleranciaSuperior\":\"100\",\"ToleranciaInferior\":\"0\",\"Objeto\":null,\"Numerador\":\"\",\"Denominador\":\"\",\"Oficina\":null,\"Cliente\":null},{\"Indicador\":\"test px1\",\"FechaLectura\":\"2018-04-01T00:00:00\",\"ValorReal\":\"6,67\",\"ValorEstimado\":\"6,67\",\"Descripcion\":\"test1\",\"Meta\":\"65\",\"ToleranciaSuperior\":\"75\",\"ToleranciaInferior\":\"45\",\"Objeto\":\"NoConf\",\"Numerador\":\"0\",\"Denominador\":\"0\",\"Oficina\":null,\"Cliente\":null},{\"Indicador\":\"test px1\",\"FechaLectura\":\"2017-07-01T00:00:00\",\"ValorReal\":\"28,09\",\"ValorEstimado\":\"28,09\",\"Descripcion\":\"dfgfdgfg\",\"Meta\":\"65\",\"ToleranciaSuperior\":\"75\",\"ToleranciaInferior\":\"45\",\"Objeto\":\"No Conformidad de Auditoría No.5\",\"Numerador\":\"0\",\"Denominador\":\"0\",\"Oficina\":null,\"Cliente\":null},{\"Indicador\":\"test px1\",\"FechaLectura\":\"2017-07-01T00:00:00\",\"ValorReal\":\"13,33\",\"ValorEstimado\":\"13,33\",\"Descripcion\":\"123456\",\"Meta\":\"65\",\"ToleranciaSuperior\":\"75\",\"ToleranciaInferior\":\"45\",\"Objeto\":\"NoConf\",\"Numerador\":\"0\",\"Denominador\":\"0\",\"Oficina\":null,\"Cliente\":null},{\"Indicador\":\"test px1\",\"FechaLectura\":\"2018-01-01T00:00:00\",\"ValorReal\":\"100\",\"ValorEstimado\":\"100\",\"Descripcion\":\"Test periodo 2\",\"Meta\":\"65\",\"ToleranciaSuperior\":\"75\",\"ToleranciaInferior\":\"45\",\"Objeto\":\"NotaMejora\",\"Numerador\":\"0\",\"Denominador\":\"0\",\"Oficina\":null,\"Cliente\":null},{\"Indicador\":\"test px1\",\"FechaLectura\":\"2018-01-01T00:00:00\",\"ValorReal\":\"100\",\"ValorEstimado\":\"100\",\"Descripcion\":\"sss\",\"Meta\":\"65\",\"ToleranciaSuperior\":\"75\",\"ToleranciaInferior\":\"45\",\"Objeto\":\"NotaMejora\",\"Numerador\":\"0\",\"Denominador\":\"0\",\"Oficina\":null,\"Cliente\":null}]" }]" }
Sample ERROR Response:
{ "StatusCode": 401, "Message": "Unauthorized : *DESCRIPCION ERROR NO AUTORIZADO*.", "Entity": null }
{ "StatusCode": 500, "Message": "InternalServerError : La solicitud no fue procesada.", "Entity": null }
Crea una medición en el sistema ISOLUCIÓN a través de esta opción.
HTTP POST: https://[service_address]/api/mediciones/
[service_address]: Dirección disponible para conectividad con el API, debe validarse con su proveedor de ISOLUCIÓN.
Header | Ejemplo | Descripción |
---|---|---|
Authorization | Basic Tm9tYnJlVXN1YXJpbzpDb250cmFzZcOxYQ== |
Para la autorización sobre el API es necesario un usuario y contraseña, este usuario debe ser creado en el modulo de Usuarios de Isolucion, se recomienda crear un usuario único para la integración. Una vez creado el usuario se debe cifrar en base64 de la siguiente manera NombreUsuario:Contraseña el resultado debe ser algo parecido a Tm9tYnJlVXN1YXJpbzpDb250cmFzZcOxYQ== Cuando se tenga este dato se debe enviar en el encabezado de la petición de la siguiente manera Basic Tm9tYnJlVXN1YXJpbzpDb250cmFzZcOxYQ==
Referencias |
apiKey | YWJjZDEyMzQYWJjZDEyMzQYWJjZDEyMzQ-localhost | Llave otorgada para el uso del API. |
Content-Type | application/json | Tipo de contenido enviado en la solicitud. |
Nombre del campo | Formato | Tamaño | Descripción | Obligatorio |
---|---|---|---|---|
Indicador | Texto | varchar(500) | Nombre del indicador. Debe existir previamente. | Si. |
FechaLectura | Fecha. ISO8601 yyyy-MM-ddTHH:mm:ss | Fecha de la medición del indicador. | Si. | |
ValorReal | Numérico | Float | Valor real del indicador. | Si. |
ValorEstimado | Numérico | Float | Valor estimado del indicador. | Si. |
Meta | Numérico | float | Meta del indicador. | No. |
Descripcion | Texto | varchar(4000) | Descripción del inidicador. | No. |
ToleranciaInferior | Texto | float | Tolerancia inferior del indicador. | No. |
ToleranciaSuperior | Texto | float | Tolerancia superior del indicador. | No. |
Objeto | Texto | varchar(50) | Objeto del inidicador. | No. |
Numerador | Numérico | float | Numerador del inidicador. | No. |
Denomidador | Numérico | float | Denominador del inidicador. | No. |
Oficina | Texto | varchar(150) | Oficina del inidicador. Lista de valores, sino existe se crea con el valor enviado. | No. |
Cliente | Texto | varchar(100) | Nombre del Cliente del inidicador. Debe existir previamente en el sistema. | No. |
Sample:
{"Indicador":"Productividad Laboral","FechaLectura":"2018-02-20T18:34:02","ValorReal":"80","ValorEstimado":"90","Descripcion":null,"Meta":"100","ToleranciaSuperior":"120","ToleranciaInferior":"90","Objeto":null,"Numerador":"","Denominador":"","Oficina":"","Cliente":null}
Respuesta en Formato JSON a la solicitud de creación en el sistema.
Campo | Ejemplo | Descripción |
---|---|---|
StatusCode | "StatusCode":200 | Códigos HTTP de respuesta indicando si fue exitoso o no el request realizado. [200,400,500] Exito,Error. |
Message | "Message":" El registro de Medición para el Indicador ha sido creado exitosamente.." | Descripción de la respuesta exitosa o mensaje de error enviado por el servidor. |
Entity | "Entity": [[{data1},{data2}...],null] | Formato JSON con los datos creados en el sistema. En el caso de respuesta no exitosa el valor es nulo. |
Sample OK Response:
{ "StatusCode": 200, "Message": " El registro de Medición para el Indicador ha sido creado exitosamente.", "Entity": "{\"Indicador\":\"Productividad Laboral\",\"FechaLectura\":\"2018-02-20T18:34:02\",\"ValorReal\":\"80\",\"ValorEstimado\":\"90\",\"Descripcion\":null,\"Meta\":\"100\",\"ToleranciaSuperior\":\"120\",\"ToleranciaInferior\":\"90\",\"Objeto\":null,\"Numerador\":\"\",\"Denominador\":\"\",\"Oficina\":\"\",\"Cliente\":null}" }
Sample ERROR Response:
{ "StatusCode": 400, "Message": "Bad Request : *DESCRIPCION DEL ERROR PARAMETRO ENTRADA ERRADO*.", "Entity": null }
{ "StatusCode": 401, "Message": "Unauthorized : *DESCRIPCION ERROR NO AUTORIZADO*.", "Entity": null }
{ "StatusCode": 500, "Message": "InternalServerError : La solicitud no fue procesada.", "Entity": null }
Actualiza una medición en el sistema ISOLUCIÓN a través de esta opción.
HTTP PUT: https://[service_address]/api/mediciones/
[service_address]: Dirección disponible para conectividad con el API, debe validarse con su proveedor de ISOLUCIÓN.
Header | Ejemplo | Descripción |
---|---|---|
Authorization | Basic Tm9tYnJlVXN1YXJpbzpDb250cmFzZcOxYQ== |
Para la autorización sobre el API es necesario un usuario y contraseña, este usuario debe ser creado en el modulo de Usuarios de Isolucion, se recomienda crear un usuario único para la integración. Una vez creado el usuario se debe cifrar en base64 de la siguiente manera NombreUsuario:Contraseña el resultado debe ser algo parecido a Tm9tYnJlVXN1YXJpbzpDb250cmFzZcOxYQ== Cuando se tenga este dato se debe enviar en el encabezado de la petición de la siguiente manera Basic Tm9tYnJlVXN1YXJpbzpDb250cmFzZcOxYQ==
Referencias |
apiKey | YWJjZDEyMzQYWJjZDEyMzQYWJjZDEyMzQ-localhost | Llave otorgada para el uso del API. |
Content-Type | application/json | Tipo de contenido enviado en la solicitud. |
Nombre del campo | Formato | Tamaño | Descripción | Obligatorio |
---|---|---|---|---|
Indicador | Texto | varchar(500) | Nombre del indicador. Debe existir previamente. No puede ser modificado. | Si. |
FechaLectura | Fecha. ISO8601 yyyy-MM-ddTHH:mm:ss | Fecha de la medición del indicador. No puede ser modificada, se usa en conjunto con el indicador para identificar el valor de medición a actualizar. | Si. | |
ValorReal | Numérico | Float | Valor real del indicador. | Si. |
ValorEstimado | Numérico | Float | Valor estimado del indicador. | Si. |
Meta | Numérico | float | Meta del indicador. | No. |
Descripcion | Texto | varchar(4000) | Descripción del inidicador. | No. |
ToleranciaInferior | Texto | float | Tolerancia inferior del indicador. | No. |
ToleranciaSuperior | Texto | float | Tolerancia superior del indicador. | No. |
Objeto | Texto | varchar(50) | Objeto del inidicador. | No. |
Numerador | Numérico | float | Numerador del inidicador. | No. |
Denomidador | Numérico | float | Denominador del inidicador. | No. |
Oficina | Texto | varchar(150) | Oficina del inidicador. Lista de valores, sino existe se crea con el valor enviado. | No. |
Cliente | Texto | varchar(100) | Nombre del Cliente del inidicador. Debe existir previamente en el sistema. | No. |
Sample:
{"Indicador":"Productividad Laboral","FechaLectura":"2018-02-20T18:34:00","ValorReal":"85","ValorEstimado":"90","Descripcion":"","Meta":"98","ToleranciaSuperior":"120","ToleranciaInferior":"90","Objeto":null,"Numerador":"","Denominador":"","Oficina":"Oficina Principal","Cliente":null}
Respuesta en Formato JSON a la solicitud de actualización en el sistema.
Campo | Ejemplo | Descripción |
---|---|---|
StatusCode | "StatusCode":200 | Códigos HTTP de respuesta indicando si fue exitoso o no el request realizado. [200,400,404,500] Exito,Error. |
Message | "Message":" El registro de Medición para el Indicador ha sido actualizado exitosamente." | Descripción de la respuesta exitosa o mensaje de error enviado por el servidor. |
Entity | "Entity": [[{data1},{data2}...],null] | Formato JSON con los datos actualizados en el sistema. En el caso de respuesta no exitosa el valor es nulo. |
Sample OK Response:
{ "StatusCode": 200, "Message": " El registro de Medición para el Indicador ha sido actualizado exitosamente.", "Entity": "{\"Indicador\":\"Productividad Laboral\",\"FechaLectura\":\"2018-02-20T18:34:00\",\"ValorReal\":\"85\",\"ValorEstimado\":\"90\",\"Descripcion\":\"\",\"Meta\":\"98\",\"ToleranciaSuperior\":\"120\",\"ToleranciaInferior\":\"90\",\"Objeto\":null,\"Numerador\":\"\",\"Denominador\":\"\",\"Oficina\":\"Oficina Principal\",\"Cliente\":null}" }
Sample ERROR Response:
{ "StatusCode": 400, "Message": "Bad Request : *DESCRIPCION DEL ERROR PARAMETRO ENTRADA ERRADO*.", "Entity": null }
{ "StatusCode": 401, "Message": "Unauthorized : *DESCRIPCION ERROR NO AUTORIZADO*.", "Entity": null }
{ "StatusCode": 404, "Message": "Not Found : *DESCRIPCION ERROR ELEMENTO NO EXISTE*.", "Entity": null }
{ "StatusCode": 500, "Message": "InternalServerError : La solicitud no fue procesada.", "Entity": null }