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
  • Relación tercero
  • Eliminar relación tercero

ACCIONISTAS Request information


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


URI parameters

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

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

ACCIONISTAS 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 accionistas 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 Accionistas registrados en el sistema. En el caso de respuesta no exitosa el valor es nulo.

Sample OK Response:

{
"StatusCode": 200,
"Message": "Lista de accionistas obtenida exitosamente.",
"Entity": "{\"Id_Tercero\":9,\"NomTercero\":\"NELSON ROKEFELLER\",\"CodTipoidentificacion\":4,\"NumDocumento\":\"12345678\",\"Telefono\":null,\"Email\":null,\"CodTipoDeRelacion\":1,\"CodTipoPersona\":2,\"Porcentaje\":4,\"Activo\":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
}

ACCIONISTAS Request information


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


URI parameters

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

[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
NomAccionista Texto varchar(100) Nombre del accionista. Debe ser único, no puede existir otro cliente con el mismo nombre. Si.
NumDocumento Texto varchar(20) Número de documento de identificación. El número de documento no deben existir previamente. Si.
ScoringSarlaft Entero int No.
Particion Double float No.
Activo Booleano [1,0] Activo:1 , Inactivo:0. Indica si el accionista se encuentra activo o no. Valor por defecto: [0]. No.
Pais Texto varchar(150) Pais del accionista. Debe existir previamente. No.
Ciudad Texto varchar(150) Ciudad o municipio del accionista. Debe existir previamente. No.
OrigenRecursos Texto varchar(150) Origen de los recursos del accionista. Debe existir previamente. No.
ActividadEconomica Texto varchar(150) Actividad economica a la que se dedica el accionista. Debe existir previamente. No.
SLFCanal Texto varchar(150) No.

Request Formats

application/json/

Sample:

{
    "NomAccionista":"Accionista prueba 6",
    "ScoringSarlaft":2,
    "Particion":1,
    "NumDocumento":1234567894321,
    "Activo":1,"Pais":"Colombia",
    "Ciudad":"BOGOTÁ D.C.",
    "OrigenRecursos":"Ahorros",
    "ActividadEconomica":"CONSTRUCCION",
    "SLFCanal":"Inversionista (Accionista)"
}

Accionistas 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 Accionista 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 Accionista ha sido creado exitosamente.",
"Entity": "{\"Nombredelcliente\":\"SAMSUNG COMPANY\",\"Activo\":1,\"Celular\":null,\"ActividadEconomica\":\"COMERCIO POR MENOR\",\"Ciudad\":\"BOGOTA D.C.\",\"Sector\":\"Privado\",\"Tipocliente\":null,\"TipoDocIdentidad\":\"NIT\",\"Contacto\":\"Carolina Gomez\",\"Direccion\":null,\"Documento\":\"830987654\",\"Email\":\"cliente@cliente.com\",\"Fax\":null,\"Telefono\":null,\"URL\":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
}

ACCIONITAS Request information


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


URI parameters

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

[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
NomAccionista Texto varchar(100) Nombre del accionista. Debe ser único, no puede existir otro cliente con el mismo nombre. Si.
NumDocumento Texto varchar(20) Número de documento de identificación. El número de documento no deben existir previamente. Si.
ScoringSarlaft Entero int No.
Particion Double float No.
Activo Booleano [1,0] Activo:1 , Inactivo:0. Indica si el accionista se encuentra activo o no. Valor por defecto: [0]. No.
Pais Texto varchar(150) Pais del accionista. Debe existir previamente. No.
Ciudad Texto varchar(150) Ciudad o municipio del accionista. Debe existir previamente. No.
OrigenRecursos Texto varchar(150) Origen de los recursos del accionista. Debe existir previamente. No.
ActividadEconomica Texto varchar(150) Actividad economica a la que se dedica el accionista. Debe existir previamente. No.
SLFCanal Texto varchar(150) No.

Request Formats

application/json/

Sample:

{
    "NomAccionista":"Accionista prueba 6",
    "ScoringSarlaft":2,
    "Particion":1,
    "NumDocumento":1234567894321,
    "Activo":1,"Pais":"Colombia",
    "Ciudad":"BOGOTÁ D.C.",
    "OrigenRecursos":"Ahorros",
    "ActividadEconomica":"CONSTRUCCION",
    "SLFCanal":"Inversionista (Accionista)"
}

ACCIONISTAS 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 Accionista 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 Accionista ha sido actualizado exitosamente.",
"Entity": "[{\"Id_Accionista\":1,\"NomAccionista\":\"Accionista 1\",\"ScoringSarlaft\":2,\"Particion\":1,\"NumDocumento\":\"10101010\",\"Activo\":true,\"Pais\":\"Colombia\",\"Ciudad\":\"BOGOTÁ D.C.\",\"OrigenRecursos\":\"Ahorros\","ActividadEconomica\":\"CONSTRUCCION\",\"SLFCanal\":\"Inversionista (Accionista)\"}]"
}

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
}

ACCIONISTAS Request information


Relaciona un tercero existente a un accionista en el sistema ISOLUCIÓN.


URI parameters

HTTP POST: https://[service_address]/api/accionistas/[idAccionista]/Tercero

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

[idAccionista]: Identificador único de accionista (id) en isolucion (Ver Objeto accionista).


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
IdTercero Entero int Identificador único de tercero (id) en isolucion (Ver Objeto tercero). Si.
Porcentaje Entero Int) Participacion de tercero en la relación con su contraparte No.
TipoRelacion Entero Int Identificador único de tipo de relacion (id) en isolucion (Ver Objeto tipo relación) . Si.

Request Formats

application/json/

Sample:

{
    "IdTercero": 12,
    "Porcentaje": 30,
    "TipoRelacion": 3
}

ACCIONISTAS 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,400,500] Exito,Error.
Message "Message":"Tercero relacionado agregado correctamente" Descripción de la respuesta exitosa o mensaje de error enviado por el servidor.
Entity "Entity": [{data1}] Formato JSON con el Tercero registrado en el sistema. En el caso de respuesta no exitosa el valor es nulo.

Sample Ok Response:

{
    "StatusCode": 200,
    "Message": "Tercero relacionado agregado correctamente.",
    "Entity": "{\"Id_Tercero\":9,\"Porcentaje\":22,\"IdContraparte\":2,\"TipoRelacion\":4,\"TipoContraparte\":1}"
}

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
}

ACCIONISTAS Request information


Elimina relación de un tercero existente a un accionista en el sistema ISOLUCIÓN.


URI parameters

HTTP DELETE: https://[service_address]/api/accionistas/[idAccionista]/Tercero/[idTercero]/TipoRelacion/[idTipoRelacion]

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

[idAccionista]: Identificador único de accionista (id) en isolucion (Ver Objeto accionista).

[idTercero]: Identificador único de tercero (id) en isolucion (Ver Objeto tercero).

[idTipoRelacion]: Identificador único de tipo de relacion en isolucion (Ver Objeto tipo relación) .


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

ACCIONISTAS 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,400,500] Exito,Error.
Message "Message":"Tercero relacionado agregado correctamente" Descripción de la respuesta exitosa o mensaje de error enviado por el servidor.
Entity "Entity": [{data1}] Formato JSON con el Tercero registrado en el sistema. En el caso de respuesta no exitosa el valor es nulo.

Sample Ok Response:

{
    "StatusCode": 200,
    "Message": "Tercero relacionado eliminado correctamente",
    "Entity": "{\"Id_Tercero\":9,\"NomTercero\":\"NELSON ROKEFELLER\",\"CodTipoidentificacion\":4,\"NumDocumento\":\"12345678\",\"Telefono\":null,\"Email\":null,\"CodTipoDeRelacion\":1,\"CodTipoPersona\":2,\"Porcentaje\":4,\"Activo\":1}"
}

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
}