Obtiene la lista de terceros existentes en el sistema ISOLUCIÓN.
HTTP GET: https://[service_address]/api/terceros/
[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 terceros 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 Terceros registrados en el sistema. En el caso de respuesta no exitosa el valor es nulo. |
Sample Ok Response:
{ "StatusCode": 200, "Message": "Lista de terceros obtenida exitosamente.", "Entity": "[{\"Id_Tercero\":1,\"Id_TerceroAcept\":0,\"IdContraparte\":null,\"NomTercero\":\"Pedro Pablo Castiblanco\",\"TipoPersona\":null,\"CodTipoDeRelacion\":null,\"RiesgoLaft\":2,\"Descripcion\":null,\"CodTipoIdentificacion\":1,\"LabelTipoIdentificacion\":\"Cédula\",\"LabelTipoDeRelacion\":\"\",\"NumeroIdentificacion\":\"798562300\",\"UsuarioCreador\":0,\"Porcentaje\":null,\"TipoContraparte\":null,\"Email\":\"\",\"Telefono\":\"325689750\",\"CodTipoPersona\":null,\"LabelRiesgoLAft\":null,\"LabelPorcentaje\":null,\"AplicaPorcentaje\":null,\"Fecha\":\"2020-07-13T16:53:51.197\",\"CodUsuario\":null,\"Activo\":null,\"LabelTipoPersona\":\"\"}]" }
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 tercero en el sistema ISOLUCIÓN a través de esta opción.
HTTP POST: https://[service_address]/api/terceros
[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 |
---|---|---|---|---|
NomTercero | Texto | varchar(255) | Nombre del Tercero. Debe ser único, no puede existir otro tercero con el mismo nombre | Si. |
NumeroIdentificacion | Texto | varchar(80) | Número de identificación. | Si. |
CodTipoidentificacion | Entero | int) | Codigo de la tipo decumento, debe existir en Isolucion (Ver Objeto identificación) | Si. |
Telefono | Texto | varchar(30) | Telefono. | No. |
Texto | varchar(250) | Email. | No. | |
Activo | Booleano [1,0] | Activo:1 , Inactivo:0. Indica si el proveedor se encuentra activo o no. | No. | |
Porcentaje | Entero | int | Porcentaje de peso en reisgo laft. | No. |
Descripcion | Texto | varchar(250) | Descripición adicional del tercero. | No. |
CodTipoPersona | Entero | int | Codigo de la tipo de persona, debe existir en Isolucion (Ver Objeto persona) | No. |
Sample:
{ "NomTercero": "dario santana", "NumeroIdentificacion": "14231343", "CodTipoIdentificacion": 1, "Telefono": "sample string 7", "Email": "sample string 8", "Descripcion": "descripción adicional", "Porcentaje":17, "Activo": 1, "CodTipoPersona":2, }
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 tercero 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 tercero ha sido creado 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": 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 tercero en el sistema ISOLUCIÓN a través de esta opción.
HTTP PUT: https://[service_address]/api/tercero/
[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 |
---|---|---|---|---|
NomTercero | Texto | varchar(255) | Nombre del Tercero. Debe ser único, no puede existir otro tercero con el mismo nombre | Si. |
NumeroIdentificacion | Texto | varchar(80) | Número de identificación. | Si. |
CodTipoidentificacion | Entero | int) | Codigo de la tipo decumento, debe existir en Isolucion (Ver Objeto identificación) | Si. |
Telefono | Texto | varchar(30) | Telefono. | No. |
Texto | varchar(250) | Email. | No. | |
Activo | Booleano [1,0] | Activo:1 , Inactivo:0. Indica si el proveedor se encuentra activo o no. | No. | |
Porcentaje | Entero | int | Porcentaje de peso en reisgo laft. | No. |
Descripcion | Texto | varchar(250) | Descripición adicional del tercero. | No. |
CodTipoPersona | Entero | int | Codigo de la tipo de persona, debe existir en Isolucion (Ver Objeto persona) | No. |
Sample:
{ "NomTercero": "dario santana", "NumeroIdentificacion": "14231343", "CodTipoIdentificacion": 1, "Telefono": "sample string 7", "Email": "sample string 8", "Descripcion": "descripción adicional", "Porcentaje":17, "Activo": 1, "CodTipoPersona":2, }
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 Tercero 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 Tercero ha sido actualizado exitosamente.", "Entity": "{\"IdProveedor\":0,\"TipoIdentificacion\":\"Pasaporte\",\"NumeroIdentificacion\":\"1423\",\"Nombre\":\"sample string 4\",\"Contacto\":\"sample string 5\",\"Telefono\":\"sample string 7\",\"Email\":\"sample string 8\",\"Fax\":\"sample string 9\",\"Direccion\":\"sample string 10\",\"Pais\":\"Colombia\",\"Activo\":\"1\",\"CodActividadEconomica\":2,\"CodOrigenRecursos\":2,\"CodSLFCanal\":17}" }
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 }