Obtiene la lista de indicadores existentes en el sistema ISOLUCIÓN.
HTTP GET: https://[service_address]/api/indicadores/
[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. |
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 Procesos 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 Indicadores registrados en el sistema. En el caso de respuesta no exitosa el valor es nulo. |
Sample OK Response:
{ "StatusCode": 200, "Message": "Lista de indicadores obtenida exitosamente.", "Entity": "[{\"IdIndicador\":1,\"Nombredelindicador\":\"indicador 09092019\",\"Area\":\"Financiera\",\"FrecuenciaMedición\":\"Mensual\",\"Tipo\":\"Eficacia\",\"Proceso\":\"Comerciales\",\"Tendencia\":\"Negativa\",\"UnidaddeMedida\":\"Porcentaje\",\"Formula\":null,\"FuenteInformacion\":null,\"Familia\":\"Gestión\",\"Meta\":78.0,\"Objetivo\":null,\"QuienMide\":null,\"ToleranciaInferior\":99.0,\"ToleranciaSuperior\":45.0,\"Oficinas\":[{\"IdOficina\":1,\"NomOficina\":\"Ninguna\",\"CodCiudad\":null,\"CodOficina\":null,\"NomOficinaPadre\":null}],\"ObjetivosIndicador\":[{\"IdObjetivo\":2,\"NomObjetivo\":\"Obejtivo estrategico 1\",\"CodTipoObjetivo\":1},{\"IdObjetivo\":3,\"NomObjetivo\":\"Objetivo estrategico 1.1\",\"CodTipoObjetivo\":2},{\"IdObjetivo\":4,\"NomObjetivo\":\"Objetivo estrategico 2\",\"CodTipoObjetivo\":1},{\"IdObjetivo\":5,\"NomObjetivo\":\"objetivo estrategico 2.1\",\"CodTipoObjetivo\":2}]}] }
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 un indicador en el sistema ISOLUCIÓN a través de esta opción.
HTTP POST: https://[service_address]/api/indicadores/
[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 |
---|---|---|---|---|
Nombredelindicador | Texto | varchar(500) | Nombre del indicador. | Si. |
FrecuenciaMedición | Texto | varchar(120) | Tipo de medición realizada. Debe existir previamente en el sistema. | Si. |
Tendencia | Texto | varchar(64) | Tendencia del indicador.Lista de valores, sino existe se crea con el valor enviado. | Si. |
Proceso | Texto | varchar(100) | Proceso del inidicador. Debe existir previamente en el sistema. | Si. |
Area | Texto | varchar(100) | Area del inidicador. Debe existir previamente en el sistema. | No. |
Tipo | Texto | varchar(120) | Tipo del inidicador. Lista de valores, sino existe se crea con el valor enviado. | No. |
Formula | Texto | varchar(1000) | Fórmula del inidicador. | No. |
FuenteInformacion | Texto | varchar(2000) | Fuente de información del inidicador. | No. |
Objetivo | Texto | varchar(2000) | Objetivo del inidicador. Debe existir previamente en el sistema. | No. |
UnidaddeMedida | Texto | varchar(100) | Unidad de medida del indicador. Debe existir previamente en el sistema. | No. |
QuienMide | Texto | varchar(200) | Cargo de quien mide el indicador. Debe existir previamente en el sistema. | No. |
Meta | Numérico | Float | Meta esperada del indicador. | No. |
ToleranciaInferior | Numérico | Float | Tolerancia inferior del indicador. | No. |
ToleranciaSuperior | Numérico | Float | Tolerancia superior del indicador. | No. |
Sample:
{"Nombredelindicador":"Productividad Laboral","Area":" ","FrecuenciaMedición":"Mensual","Tipo":null,"Proceso":"QA","Tendencia":"Positiva","UnidaddeMedida":null,"Formula":null,"FuenteInformacion":null,"Meta":null,"QuienMide":null,"ToleranciaInferior":90,"ToleranciaSuperior":120}
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 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 Indicador ha sido creado exitosamente.", "Entity": "{"IdIndicador":"0",\"Nombredelindicador\":\"Productividad Laboral\",\"Area\":\" \",\"FrecuenciaMedición\":\"Mensual\",\"Tipo\":null,\"Proceso\":\"QA\",\"Tendencia\":\"Positiva\",\"UnidaddeMedida\":null,\"Formula\":null,\"FuenteInformacion\":null,\"Familia\":null,\"Meta\":0.0,\"Objetivo\":null,\"QuienMide\":null,\"ToleranciaInferior\":90.0,\"ToleranciaSuperior\":120.0\"Oficinas\":null\"ObjetivosIndicador\":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 un indicador en el sistema ISOLUCIÓN a través de esta opción.
HTTP PUT: https://[service_address]/api/indicadores/
[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 |
---|---|---|---|---|
Nombredelindicador | Texto | varchar(500) | Nombre del indicador. Debe existir previamente en el sistema. Se usa para identificar el indicador a actualizar. No puede ser modificado. | Si. |
FrecuenciaMedición | Texto | varchar(120) | Tipo de medición realizada. | Si. |
Tendencia | Texto | varchar(64) | Tendencia del indicador.Lista de valores, sino existe se crea con el valor enviado. | Si. |
Proceso | Texto | varchar(100) | Proceso del inidicador. Debe existir previamente en el sistema. | Si. |
Area | Texto | varchar(100) | Area del inidicador. Debe existir previamente en el sistema. | No. |
Tipo | Texto | varchar(120) | Tipo del inidicador. Lista de valores, sino existe se crea con el valor enviado. | No. |
Formula | Texto | varchar(1000) | Fórmula del inidicador. | No. |
FuenteInformacion | Texto | varchar(2000) | Fuente de información del inidicador. | No. |
Objetivo | Texto | varchar(2000) | Objetivo del inidicador. Debe existir previamente en el sistema. | No. |
UnidaddeMedida | Texto | varchar(100) | Unidad de medida del indicador. Debe existir previamente en el sistema. | No. |
QuienMide | Texto | varchar(200) | Cargo de quien mide el indicador. Debe existir previamente en el sistema. | No. |
Meta | Numérico | Float | Meta esperada del indicador. | No. |
ToleranciaInferior | Numérico | Float | Tolerancia inferior del indicador. | No. |
ToleranciaSuperior | Numérico | Float | Tolerancia superior del indicador. | No. |
Sample:
{"Nombredelindicador":"Productividad Laboral","Area":" ","FrecuenciaMedición":"Mensual","Tipo":null,"Proceso":"QA","Tendencia":"Positiva","UnidaddeMedida":null,"Formula":null,"FuenteInformacion":null,"Meta":100,"QuienMide":null,"ToleranciaInferior":90,"ToleranciaSuperior":120}
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 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 Indicador ha sido actualizado exitosamente.", "Entity": "{\"Nombredelindicador\":\"Productividad Laboral\",\"Area\":\" \",\"FrecuenciaMedición\":\"Mensual\",\"Tipo\":null,\"Proceso\":\"QA\",\"Tendencia\":\"Positiva\",\"UnidaddeMedida\":null,\"Formula\":null,\"FuenteInformacion\":null,\"Familia\":null,\"Meta\":100.0,\"Objetivo\":null,\"QuienMide\":null,\"ToleranciaInferior\":90.0,\"ToleranciaSuperior\":120.0}" }
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 }
Obtener las familias de un indicador.
HTTP GET: https://[service_address]/api/indicador/[codIndicador]/familia
[service_address]: Dirección disponible para conectividad con el API, debe validarse con su proveedor de ISOLUCIÓN.
[codIndicador]: Identificador del indicador del cual se quiere traer la informacion de las familias.
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. |
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,500] Exito,Error. |
Message | "Message":"Familias obtenidas exitosamente." | Descripción de la respuesta exitosa o mensaje de error enviado por el servidor. |
Entity | "Entity": [{"Id_IndicadorFamilia": 1 ,"NomFamilia":"Nombre de la Familia","codFamilia": null,"codIndicador": 1}] | 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": "Familias obtenidas exitosamente.", "Entity": "{"Id_IndicadorFamilia": 1 ,"NomFamilia":"Nombre de la Familia","codFamilia": null,"codIndicador": 1}
Sample ERROR Response:
{ "StatusCode": 401, "Message": "Unauthorized : *DESCRIPCION ERROR NO AUTORIZADO*.", "Entity": null }
{ "StatusCode": 500, "Message": "InternalServerError : La solicitud no fue procesada.", "Entity": null }
Agregar familias a un indicador. Se agregaran a las familias existentes.
HTTP POST: https://[service_address]/api/indicador/[codIndicador]/agregarfamilia
[service_address]: Dirección disponible para conectividad con el API, debe validarse con su proveedor de ISOLUCIÓN.
[codIndicador]: Identificador del indicador al cual se le agregaran familias.
Header | Formato | Descripción | Obligatorio |
---|---|---|---|
Authorization | Base YWJjZDEyMzQY | Autenticación de acceso básica con las credenciales de usuario y clave otorgadas para el uso del API. | Si |
apiKey | YWJjZDEyMzQYWJjZDEyMzQYWJjZDEyMzQ | Llave otorgada para el uso del API. | Si |
Content-Type | application/json | Tipo de contenido enviado en la solicitud. | Si |
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. |
Sample:
[1, 2, 3]
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,500] Exito,Error. |
Message | "Message":"Familias agregadas exitosamente." | Descripción de la respuesta exitosa o mensaje de error enviado por el servidor. |
Entity | "Entity": true/false | true si la operacion se realizo correctamente, false si no. En el caso de respuesta no exitosa el valor es nulo. |
Sample OK Response:
{ "StatusCode": 200, "Message": "Familias agregadas exitosamente.", "Entity": "true"
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 }
Actualizar familias a un indicador. Se eliminaran las existentes y se agregaran las enviadas.
HTTP PUT: https://[service_address]/api/indicador/[codIndicador]/actualizarfamilia
[service_address]: Dirección disponible para conectividad con el API, debe validarse con su proveedor de ISOLUCIÓN.
[codIndicador]: Identificador del indicador al cual se le actualizaran sus familias.
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 |
---|---|---|---|---|
Identificador de la familia | Lista enteros | Entero | Identificador de la familia que se quiere agregar (Ver objeto FAMILIA). | Si. |
Sample:
[1, 2, 3]
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,500] Exito,Error. |
Message | "Message":"Familias actualizadas exitosamente." | Descripción de la respuesta exitosa o mensaje de error enviado por el servidor. |
Entity | "Entity": true/false | true si la operacion se realizo correctamente, false si no. En el caso de respuesta no exitosa el valor es nulo. |
Sample OK Response:
{ "StatusCode": 200, "Message": "Familias actualizadas exitosamente.", "Entity": "true"
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 }
Actualizar objetivos a un indicador. Se eliminaran las existentes y se agregaran las enviadas.
HTTP PUT: https://[service_address]/api/indicador/[codIndicador]/actualizarobjetivo
[service_address]: Dirección disponible para conectividad con el API, debe validarse con su proveedor de ISOLUCIÓN.
[codIndicador]: Identificador del indicador al cual se le actualizaran sus objetivos.
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 |
---|---|---|---|---|
Identificador de los objetivos | Lista enteros | Entero | Identificador de los objetivos que se quiere agregar (Ver objeto OBJETIVO). | Si. |
Sample:
[1, 2, 3]
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":"Objetivos actualizados exitosamente." | Descripción de la respuesta exitosa o mensaje de error enviado por el servidor. |
Entity | "Entity": true/false | true si la operacion se realizo correctamente, false si no. En el caso de respuesta no exitosa el valor es nulo. |
Sample OK Response:
{ "StatusCode": 200, "Message": "Objetivos actualizados exitosamente.", "Entity": "true" }
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 }
Agregar objetivos a un indicador. Se agregaran a los objetivos existentes.
HTTP POST: https://[service_address]/api/indicador/[codIndicador]/agregarobjetivo
[service_address]: Dirección disponible para conectividad con el API, debe validarse con su proveedor de ISOLUCIÓN.
[codIndicador]: Identificador del indicador al cual se le agregaran objetivos.
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 |
---|---|---|---|---|
Identificador del objetivo | Lista enteros | Entero | Identificador de los objetivos que se quiere agregar (Ver objeto OBJETIVO). | Si. |
Sample:
[1, 2, 3]
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,500] Exito,Error. |
Message | "Message":"Objetivos agregados exitosamente." | Descripción de la respuesta exitosa o mensaje de error enviado por el servidor. |
Entity | "Entity": true/false | true si la operacion se realizo correctamente, false si no. En el caso de respuesta no exitosa el valor es nulo. |
Sample OK Response:
{ "StatusCode": 200, "Message": "Objetivos agregados exitosamente.", "Entity": "true" }
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 }
Agregar oficinas a un indicador. Se agregaran a las oficinas existentes.
HTTP POST: https://[service_address]/api/indicador/[codIndicador]/agregaroficina
[service_address]: Dirección disponible para conectividad con el API, debe validarse con su proveedor de ISOLUCIÓN.
[codIndicador]: Identificador del indicador al cual se le agregaran oficinas.
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 |
---|---|---|---|---|
Identificador de las oficinas | Lista enteros | Entero | Identificador de las oficinas que se quiere agregar (Ver objeto OFICINA). | Si. |
Sample:
[1, 2, 3]
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,500] Exito,Error. |
Message | "Message":"Oficinas agregadas exitosamente." | Descripción de la respuesta exitosa o mensaje de error enviado por el servidor. |
Entity | "Entity": true/false | true si la operacion se realizo correctamente, false si no. En el caso de respuesta no exitosa el valor es nulo. |
Sample OK Response:
{ "StatusCode": 200, "Message": "Oficinas agregadas exitosamente.", "Entity": "true" }
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 }
Actualizar oficinas a un indicador. Se eliminaran las existentes y se agregaran las enviadas.
HTTP PUT: https://[service_address]/api/indicador/[codIndicador]/actualizaroficina
[service_address]: Dirección disponible para conectividad con el API, debe validarse con su proveedor de ISOLUCIÓN.
[codIndicador]: Identificador del indicador al cual se le actualizaran sus oficinas.
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 |
---|---|---|---|---|
Identificador de las oficinas | Lista enteros | Entero | Identificador de las oficinas que se quiere agregar (Ver objeto OFICINA). | Si. |
Sample:
[1, 2, 3]
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":"Oficinas actualizadas exitosamente." | Descripción de la respuesta exitosa o mensaje de error enviado por el servidor. |
Entity | "Entity": true/false | true si la operacion se realizo correctamente, false si no. En el caso de respuesta no exitosa el valor es nulo. |
Sample OK Response:
{ "StatusCode": 200, "Message": "Oficinas actualizadas exitosamente.", "Entity": "true" }
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 }