isolucion Data Connector      

6.0.25.06.20.25
  • Accionista
  • Actividad Economica
  • Area
  • Ausentismo
  • Cargo
  • Centros de costo
  • Cliente
  • Ciudad
  • Denuncia
  • Departamentos
  • Documento
  • Equipo
  • Familia
  • Financiera
  • Funcionarios
  • Furat
  • Furel
  • Furil
  • Grupos
  • Grupo Usuario
  • Indicador
  • Información Financiera
  • Listado Maestro
  • Medición
  • Objetivo
  • Oficina
  • Origen Recursos
  • Pais
  • Plantilla documental
  • PQR
  • Proceso
  • Productos
  • Proveedores
  • Registros
  • Roles de usuario
  • SLF Canal
  • Sucursales
  • Tercero
  • Tipo Acción
  • Tipo De Relación
  • Tipo Documento
  • Tipo Identificación
  • Tipo Persona
  • Tipo Problema
  • Usuario

  • Obtener
  • Obtener por ID
  • Obtener por login
  • Crear
  • Actualizar

USUARIOS Request information


Obtiene la lista de usuarios existentes en el sistema ISOLUCIÓN.


URI parameters

HTTP GET: https://[service_address]/api/usuarios/

[service_address]: Dirección disponible para conectividad con el API, debe validarse con su proveedor de ISOLUCIÓN.


GET Request HTTP Headers


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
The 'Basic' HTTP Authentication Scheme
Esquema de autenticación Basic

apiKey YWJjZDEyMzQYWJjZDEyMzQYWJjZDEyMzQ-localhost Llave otorgada para el uso del API.
Content-Type application/json Tipo de contenido enviado en la solicitud.


Query string parameters


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.

USUARIOS Response Information


Resource Description

Respuesta en Formato JSON a la solicitud de obtener los datos registrados en el sistema.


Response Formats

application/json/
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 Usuarios 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 Usuarios registrados en el sistema. En el caso de respuesta no exitosa el valor es nulo.

Sample Ok Response:

{
    "StatusCode": 200,
    "Message": "Lista de usuarios obtenida exitosamente.",
    "Entity": "[{\"IdUsuario\":0,\"NomUsuario\":\"PruebaJdcg9\",\"Oficina\":\"2010\",\"NumDocumento\":\"19268929\",\"Clave\":\"123456\",\"Descripcion\":\"Descripcion \",\"Email\":\"Email \",\"Area\":\"Compras\",\"Cargo\":\"LA DORADA\",\"Ciudad\":\"BOGOTÁ D.C.\",\"Login\":\"PruebaJdcg9\",\"Activo\":1,\"Fechanacimiento\":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
}

USUARIOS Request information


Obtiene un usuario por su identificador.


URI parameters

HTTP GET: https://[service_address]/api/usuarios/[codUsuario]

[service_address]: Dirección disponible para conectividad con el API, debe validarse con su proveedor de ISOLUCIÓN.

[codUsuario]: Identificador del usuario que se quiere obtener.


GET Request HTTP Headers


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
The 'Basic' HTTP Authentication Scheme
Esquema de autenticación Basic

apiKey YWJjZDEyMzQYWJjZDEyMzQYWJjZDEyMzQ-localhost Llave otorgada para el uso del API.
Content-Type application/json Tipo de contenido enviado en la solicitud.

USUARIOS Response Information


Resource Description

Respuesta en Formato JSON a la solicitud de obtener los datos registrados en el sistema.


Response Formats

application/json/
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":"Usuario obtenido 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 Usuarios registrados en el sistema. En el caso de respuesta no exitosa el valor es nulo.

Sample Ok Response:

{
    "StatusCode": 200,
    "Message": "Usuario obtenido exitosamente.",
    "Entity": "[{\"IdUsuario\":0,\"NomUsuario\":\"PruebaJdcg9\",\"Oficina\":\"2010\",\"NumDocumento\":\"19268929\",\"Clave\":\"123456\",\"Descripcion\":\"Descripcion \",\"Email\":\"Email \",\"Area\":\"Compras\",\"Cargo\":\"LA DORADA\",\"Ciudad\":\"BOGOTÁ D.C.\",\"Login\":\"PruebaJdcg9\",\"Activo\":1,\"Fechanacimiento\":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
}

USUARIOS Request information


Obtiene un usuario por su login.


URI parameters

HTTP POST: https://[service_address]/api/usuarios/login

[service_address]: Dirección disponible para conectividad con el API, debe validarse con su proveedor de ISOLUCIÓN.


POST Request HTTP Headers


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
The 'Basic' HTTP Authentication Scheme
Esquema de autenticación Basic

apiKey YWJjZDEyMzQYWJjZDEyMzQYWJjZDEyMzQ-localhost Llave otorgada para el uso del API.
Content-Type application/json Tipo de contenido enviado en la solicitud.

Body parameters

Nombre del campo Formato Tamaño Descripción Obligatorio
Login Texto varchar(100) Login del usuario a consultar. Si posee autenticación por directorio activo este login debe ser el mismo pque se usa para autenticarse contra el directorio activo Si.

Request Formats

application/json/

Sample:

{
    "Login":"admin"
}

USUARIOS Response Information


Resource Description

Respuesta en Formato JSON a la solicitud de obtener los datos registrados en el sistema.


Response Formats

application/json/
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":"Usuario obtenido 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 Usuarios registrados en el sistema. En el caso de respuesta no exitosa el valor es nulo.

Sample Ok Response:

{
    "StatusCode": 200,
    "Message": "Usuario obtenido exitosamente.",
    "Entity": "[{\"IdUsuario\":0,\"NomUsuario\":\"PruebaJdcg9\",\"Oficina\":\"2010\",\"NumDocumento\":\"19268929\",\"Clave\":\"123456\",\"Descripcion\":\"Descripcion \",\"Email\":\"Email \",\"Area\":\"Compras\",\"Cargo\":\"LA DORADA\",\"Ciudad\":\"BOGOTÁ D.C.\",\"Login\":\"PruebaJdcg9\",\"Activo\":1,\"Fechanacimiento\":nul}]"
}

Sample ERROR Response:

{
    "StatusCode": 401,
    "Message": "Unauthorized : *DESCRIPCION ERROR NO AUTORIZADO*.",
    "Entity": null
}
{
    "StatusCode": 500,
    "Message": "InternalServerError : La solicitud no fue procesada.",
    "Entity": null
}

USUARIOS Request information


Crea un usuario en el sistema ISOLUCIÓN a través de esta opción.


Nota: Todos los usuarios creados mediante el API, se registran como usuarios de consulta.


URI parameters

HTTP POST: https://[service_address]/api/usuarios/

[service_address]: Dirección disponible para conectividad con el API, debe validarse con su proveedor de ISOLUCIÓN.


POST Request HTTP Headers


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
The 'Basic' HTTP Authentication Scheme
Esquema de autenticación Basic

apiKey YWJjZDEyMzQYWJjZDEyMzQYWJjZDEyMzQ-localhost Llave otorgada para el uso del API.
Content-Type application/json Tipo de contenido enviado en la solicitud.

Body parameters

Nombre del campo Formato Tamaño Descripción Obligatorio
NomUsuario Texto varchar(50) Nombre del usuario. Debe ser único, no puede existir otro usuario con el mismo nombre. Si.
Oficina Texto varchar(150) Oficina o sucursal del usuario. Si.
Area Texto varchar(100) Nombre del área. Debe ser único, no puede existir previamente. Si.
Cargo Texto varchar(200) Nombre del cargo. Si.
Ciudad Texto varchar(150) Ciudad o municipio del Cliente. Debe existir previamente. Si.
NumDocumento Texto varchar(20) Número de documento de identificación. El tipo de documento y el número de documento no deben existir previamente. No.
Login Texto varchar(100) Login del usuario. Debe ser único, no puede existir otro usuario con el mismo login. Si posee autenticación por directorio activo este login debe ser el mismo que se usa para autenticarse contra el directorio activo Si.
Descripcion Texto varchar(80) Descripción del usuario. No.
Email Texto varchar(100) Email del usuario. Se espera un formato válido. No.
Activo Booleano [1,0] Activo:1 , Inactivo:0. Indica si el usuario se encuentra activo o no. Valor por defecto: [0]. No.
Clave Texto varchar(128) Clave del usuario para ingresar al sistema. Si.
CodCentroCosto Numerico Int32 Identificador del centro de costo al que pertenece. (Ver metodos CENTRO COSTO) No.
Jefe Numerico Int32 Identificador del usuario que se asginara como jefe. Este usuario debe tener el rol de Jefe (Ver metodos ROL USUARIO No.

Request Formats

application/json/

Sample:

{
"NomUsuario":"PruebaJdcg9",
"Oficina":"2010",
"Area":"Compras",
"Cargo":"LA DORADA",
"Ciudad":"BOGOTÁ D.C.",
"NumDocumento":"19268929",
"Login":"PruebaJdcg9",
"Descripcion":"Descripcion ",
"Email":"Email ",
"Activo":"1",
"Clave":"123456",
"CodCentroCosto": 1,
"Jefe": 2
}

USUARIOS Response Information


Resource Description

Respuesta en Formato JSON a la solicitud de creación en el sistema.


Response Formats

application/json/
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 Usuario 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 Usuario ha sido creado exitosamente.",
        "Entity": "[{\"IdUsuario\":0,\"NomUsuario\":\"PruebaJdcg9\",\"Oficina\":\"2010\",\"NumDocumento\":\"19268929\",\"Clave\":\"123456\",\"Descripcion\":\"Descripcion \",\"Email\":\"Email \",\"Area\":\"Compras\",\"Cargo\":\"LA DORADA\",\"Ciudad\":\"BOGOTÁ D.C.\",\"Login\":\"PruebaJdcg9\",\"Activo\":1,\"CodCentroCosto\": 1,\"Jefe\": 2}]"
        }

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
}

USUARIOS Request information


Actualiza un usuario en el sistema ISOLUCIÓN a través de esta opción.


Nota: El campo Login es la clave principal para ubicar un usuario en ISOLUCIÓN.


URI parameters

HTTP PUT: https://[service_address]/api/usuarios/

[service_address]: Dirección disponible para conectividad con el API, debe validarse con su proveedor de ISOLUCIÓN.


PUT Request HTTP Headers


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
The 'Basic' HTTP Authentication Scheme
Esquema de autenticación Basic

apiKey YWJjZDEyMzQYWJjZDEyMzQYWJjZDEyMzQ-localhost Llave otorgada para el uso del API.
Content-Type application/json Tipo de contenido enviado en la solicitud.

Body parameters

Nombre del campo Formato Tamaño Descripción Obligatorio
NomUsuario Texto varchar(50) Nombre del usuario. Debe ser único, no puede existir otro usuario con el mismo nombre. No.
Oficina Texto varchar(150) Oficina o sucursal del usuario. Si.
Area Texto varchar(100) Nombre del área. Debe ser único, no puede existir previamente. Si.
Cargo Texto varchar(200) Nombre del cargo. Si.
Ciudad Texto varchar(150) Ciudad o municipio del Cliente. Debe existir previamente. Si.
NumDocumento Texto varchar(20) Número de documento de identificación. El tipo de documento y el número de documento no deben existir previamente. No.
Login Texto varchar(100) Login del usuario. Debe ser único, no puede existir otro usuario con el mismo login. Si.
Descripcion Texto varchar(80) Descripción del usuario. No.
Email Texto varchar(100) Email del usuario. Se espera un formato válido. No.
Activo Booleano [1,0] Activo:1 , Inactivo:0. Indica si el usuario se encuentra activo o no. Valor por defecto: [0]. No.
Clave Texto varchar(128) Clave del usuario para ingresar al sistema. No.
CentroCosto Numerico Int32 Identificador del centro de costo al que pertenece. (Ver metodos CENTRO COSTO) No.
Jefe Numerico Int32 Identificador del usuario que se asginara como jefe. Este usuario debe tener el rol de Jefe (Ver metodos ROL USUARIO No.

Request Formats

application/json/

Sample:

{
"NomUsuario":"PruebaJdcg9",
"Oficina":"2010",
"Area":"Compras",
"Cargo":"LA DORADA",
"Ciudad":"BOGOTÁ D.C.",
"NumDocumento":"19268929",
"Login":"PruebaJdcg9",
"Descripcion":"Descripcion ",
"Email":"Email ",
"Activo":"1",
"Clave":"123456",
"CentroCosto": 1,
"Jefe": 2
}

USUARIOS Response Information


Resource Description

Respuesta en Formato JSON a la solicitud de actualización en el sistema.


Response Formats

application/json/
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 Usuario 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.

Response Formats

application/json/

Sample OK Response:

        {
        "StatusCode": 200,
        "Message": "El Usuario ha sido actualizado exitosamente.",
        "Entity": "[{\"IdUsuario\":0,\"NomUsuario\":\"PruebaJdcg9\",\"Oficina\":\"2010\",\"NumDocumento\":\"19268929\",\"Clave\":\"123456\",\"Descripcion\":\"Descripcion \",\"Email\":\"Email \",\"Area\":\"Compras\",\"Cargo\":\"LA DORADA\",\"Ciudad\":\"BOGOTÁ D.C.\",\"Login\":\"PruebaJdcg9\",\"Activo\":1,\"CentroCosto\": 1,\"Jefe\": 2}]"
        }

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
}