isolucion Data Connector      

6.0.25.05.02.18
  • 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
  • Crear
  • Actualizar

GRUPO Request information


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


URI parameters

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

[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.

GRUPO 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 grupos 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 grupos registradas en el sistema. En el caso de respuesta no exitosa el valor es nulo.

Sample OK Response:

{
"StatusCode": 200,
"Message": "Lista de grupos obtenida exitosamente..",
"Entity": "[{\"IdGrupo\":2,\"NomGrupo\":\"Administradores\",\"Descripcion\":\"Grupo de Administradores\"}]"
}

Sample ERROR Response:

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

GRUPO Request information


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


URI parameters

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

[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
NomGrupo Texto varchar(100) Nombre del grupo. Debe ser único, no puede existir previamente. Si.
Descripcion Texto varchar(20) Descripcion dada al grupo. No.

Request Formats

application/json/

Sample:

{"NomGrupo":"Administradores","Descripcion":"Grupo de administradores"}

GRUPO 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":"Grupo 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": "Grupo creado exitosamente.",
"Entity": "[{\"IdGrupo\":2,\"NomGrupo\":\"Administradores\",\"Descripcion\":\"Grupo de Administradores\"}]"
}

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
}

GRUPO Request information


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


URI parameters

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

[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
IdGrupo Numerico Identificador del grupo. Por medio de este campo se actualiza el grupo. Si.
NomGrupo Texto varchar(100) Nombre del grupo. No.
Descripcion Texto varchar(20) Descripcion del grupo. No.

Request Formats

application/json/

Sample:

{"IdGrupo": 1,"NomGrupo":"Administradores","Descripcion":"Grupo de administradores"}

GRUPO 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":" Grupo 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": "Grupo actualizado exitosamente.",
"Entity": "{\"IdGrupo\":2,\"NomGrupo\":\"Administradores\",\"Descripcion\":\"Grupo de Administradores\"}"
}

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
}