Obtiene la lista de funcionarios existentes en el sistema ISOLUCIÓN.
HTTP GET: https://[service_address]/api/Funcionarios/
[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. | |
MostrarInactivos | Booleano | Indica si quiere traer registros con estado inactivo. se debe indicar con true o false. | No. |
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 Funcionarios 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 Funcionarios registrados en el sistema. En el caso de respuesta no exitosa el valor es nulo. |
Sample Ok Response:
{ "StatusCode": 200, "Message": "Lista de funcionarios obtenida exitosamente.", "Entity": "[{\"IdSstFuncionario\":1,\"Idusuario\":0,\"ScoringSarlaft\":null,\"NomSstFuncionario\":\"Funcionario Prueba 1\",\"SegNombre\":null,\"PrimerApellido\":null,\"SegApellido\":null,\"CodTipoDocIdentidad\":1,\"NumIdentificacion\":\"123456789\",\"FechaNac\":\"1900-01-01T00:00:00\",\"LovSexo\":\"Masculino\",\"Direccion\":\"Bogotá\",\"Telefono\":\"1\",\"CodDepartamento\":2,\"Departamento\":\"ANTIOQUIA\",\"CodCiudad\":3,\"Ciudad\":\"ABEJORRAL\",\"LovZona\":\"Urbana\",\"CodCargo\":1,\"Cargo\":\"Ninguno\",\"FechaIngreso\":\"2019-09-01T00:00:00\",\"LovJornada\":\"Normal\",\"LovTipoVinculacion\":\"Laboral\",\"LovEps\":\"A.I.C.\",\"LovAfp\":\"Caxdac\",\"EsNivelGlobal\":1,\"LovArl\":\"Alfa\",\"Vigencia\":\"1900-01-01T00:00:00\",\"Activo\":true,\"HorasTrabajoxSemana\":null,\"Email\":null,\"NombreCompleto\":\"Funcionario Prueba 1 \",\"UserSstFacil\":null,\"EsSstFacil\":false,\"EsProductoSSTFacil\":false,\"CrearUsuario\":false,\"CodSSTidRequisitoCriterio\":null,\"CodIdioma\":null,\"CodSeccional\":null,\"OrigenRecursos\":null,\"ActividadEconomica\":null,\"SLFCanal\":null,\"CodOrigenRecursos\":null,\"CodActividadEconomica\":null,\"CodSLFCanal\":null,\"CodArea\":1,\"Sucursales\":\"1,3\"Login\":\"\Funcionario01"}]" }
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 funcionario en el sistema ISOLUCIÓN a través de esta opción. Esta opción tambien creará un usuario relacionado marcandolo como usuario de consulta.
HTTP POST: https://[service_address]/api/funcionarios/
[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 |
---|---|---|---|---|
TipoIdentificacion | Texto | varchar(255) | Nombre del tipo documento, sino existe se crea con el valor enviado. | Si. |
NumeroIdentificacion | Texto | varchar(20) | Número de identificación. | Si. |
Nombre | Texto | varchar(255) | Nombre completo del funcionario. | Si. |
Login | Texto | varchar(100) | Login del funcionario. Debe ser único, no puede existir otro funcionario 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. |
Correo | Texto | varchar(255) | Correo electronico. | No. |
FechaNacimiento | Fecha. ISO8601 yyyy-MM-ddTHH:mm:ss | Fecha de nacimiento. | No. | |
Genero | Valores Masculino o Femenino | varchar(50) | Genero del funcionario, si se envia otro valor diferente se crea el valor enviado. | Si. |
Departamento | Texto | varchar(255) | Departamento del funcionario, sino existe se crea con el valor enviado. | Si. |
Ciudad | Texto | varchar(150) | Ciudad del funcionario, sino existe se crea con el valor enviado. | Si. |
Zona | Texto | varchar(255) | Zona de trabajo del funcionario, sino existe se crea con el valor enviado. | Si. |
Cargo | Texto | varchar(200) | Cargo del funcionario, sino existe se crea con el valor enviado. | Si. |
FechaIngreso | Fecha. ISO8601 yyyy-MM-ddTHH:mm:ss | Fecha de Ingreso. | Si. | |
Jornada | Texto | varchar(255) | Jornada en que labora el funcionario. | Si. |
TipoVinculacion | Texto | varchar(255) | Tipo de contrato o vinvulacion del funcionario. | Si. |
Eps | Texto | varchar(255) | Empresa prestadora de Salud del Empleado. | Si. |
Afp | Texto | varchar(255) | Fondo de pensiones del funcionario. | Si. |
Arl | Texto | varchar(255) | Aseguradora de riesgos laborales del funcionario. | Si. |
Activo | Booleano [1,0] | Activo:1 , Inactivo:0. Indica si el funcionario se encuentra activo o no. Si el cambio no se envia se establecerá como inactivo. | No. | |
Direccion | Texto | varchar(100) | Dirección de residencia. | No. |
Telefono | Texto | varchar(100) | Telefono de contacto. | No. |
CodActividadEconomica | Entero | int | Codigo de la actividad economica a la que se dedica el funcionario. Debe existir previamente. | No. |
CodOrigenRecursos | Entero | int | Codigo delorigen de los recursos del funcionario. Debe existir previamente. | No. |
CodSLFCanal | Entero | int | Codigo del canal por el que el cliente conocio la empresa. Debe existir previamente | No. |
CodArea | Entero | int | Codigo del area por el que el cliente conocio la empresa. Debe existir previamente | No. |
EsNivelGlobal | Entero | int | Indica si el cliente es de nivel global (1) o pertenece a alguna sucursal (0) | Si (Para empresas con multicompañia) |
Sucursales | Texto | varchar(255) | Lista de sucursales a las que pertenece el cliente | Si (Para empresas con multicompañia) |
Sample:
{ "TipoIdentificacion": "Pasaporte", "NumeroIdentificacion": "19283465", "Nombre": "Funcionario Prueba 10", "Login": "email@compania.com", "Correo": "email@compania.com", "FechaNacimiento": "2018-08-01T13:50:55.476883-05:00", "Genero": "Masculino", "Departamento": "BOGOTÁ D.C.", "Ciudad": "BOGOTÁ D.C.", "Zona": "Urbana", "Cargo": "Ninguno", "FechaIngreso": "2018-08-01T13:50:55.476883-05:00", "Jornada": "Normal", "TipoVinculacion": "Laboral", "Eps": "A.I.C.", "Afp": "Caxdac", "Arl": "Alfa", "Activo": "1", "Direccion": "Bogotá", "Telefono": "1", "CodActividadEconomica":2, "CodOrigenRecursos":2, "CodSLFCanal":17, "CodArea": 1, "EsNivelGlobal":0, "Sucursales":"1,3" }
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 funcionario 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": "Usuario creado", "Entity": "{\"Id\":0,\"TipoIdentificacion\":\"Pasaporte\",\"NumeroIdentificacion\":\"19283465\",\"Nombre\":\"Funcionario Prueba 10\",\"Correo\":\"email@compania.com\",\"FechaNacimiento\":\"2018-08-01T13:50:55.476883-05:00\",\"Genero\":\"Masculino\",\"Departamento\":\"BOGOTÁ D.C.\",\"Ciudad\":\"BOGOTÁ D.C.\",\"Zona\":\"Urbana\",\"Cargo\":\"Ninguno\",\"FechaIngreso\":\"2018-08-01T13:50:55.476883-05:00\",\"Jornada\":\"Normal\",\"TipoVinculacion\":\"Laboral\",\"Eps\":\"A.I.C.\",\"Afp\":\"Caxdac\",\"Arl\":\"Alfa\",\"Activo\":null,\"Direccion\":\"Bogotá\",\"Telefono\":\"1\",\"CodOrigenRecursos\":2,\"CodActividadEconomica\":2,\"CodSLFCanal\":17,\"CodArea\":1,\"EsNivelGlobal\":0,\"Sucursales\":\"3\"}" }
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 funcionario en el sistema ISOLUCIÓN a través de esta opción.
HTTP PUT: https://[service_address]/api/funcionarios/
[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 |
---|---|---|---|---|
TipoIdentificacion | Texto | varchar(255) | Nombre del tipo documento, sino existe se crea con el valor enviado. | Si. |
NumeroIdentificacion | Texto | varchar(20) | Número de identificación. | Si. |
Nombre | Texto | varchar(255) | Nombre completo del funcionario. | Si. |
Login | Texto | varchar(100) | Login del funcionario. Debe ser único, no puede existir otro funcionario 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 | No. |
Correo | Texto | varchar(255) | Correo electronico. | No. |
FechaNacimiento | Fecha. ISO8601 yyyy-MM-ddTHH:mm:ss | Fecha de nacimiento. | No. | |
Genero | Valores Masculino o Femenino | varchar(50) | Genero del funcionario, si se envia otro valor diferente se crea el valor enviado. | Si. |
Departamento | Texto | varchar(255) | Departamento del funcionario, sino existe se crea con el valor enviado. | Si. |
Ciudad | Texto | varchar(150) | Ciudad del funcionario, sino existe se crea con el valor enviado. | Si. |
Zona | Texto | varchar(255) | Zona de trabajo del funcionario, sino existe se crea con el valor enviado. | Si. |
Cargo | Texto | varchar(200) | Cargo del funcionario, sino existe se crea con el valor enviado. | Si. |
FechaIngreso | Fecha. ISO8601 yyyy-MM-ddTHH:mm:ss | Fecha de Ingreso. | Si. | |
Jornada | Texto | varchar(255) | Jornada en que labora el funcionario. | Si. |
TipoVinculacion | Texto | varchar(255) | Tipo de contrato o vinvulacion del funcionario. | Si. |
Eps | Texto | varchar(255) | Empresa prestadora de Salud del Empleado. | Si. |
Afp | Texto | varchar(255) | Fondo de pensiones del funcionario. | Si. |
Arl | Texto | varchar(255) | Aseguradora de riesgos laborales del funcionario. | Si. |
Activo | Booleano [1,0] | Activo:1 , Inactivo:0. Indica si el funcionario se encuentra activo o no. | No. | |
Direccion | Texto | varchar(100) | Dirección de residencia. | No. |
Telefono | Texto | varchar(100) | Telefono de contacto. | No. |
CodActividadEconomica | Entero | int | Codigo de la actividad economica a la que se dedica el funcionario. Debe existir previamente. | No. |
CodOrigenRecursos | Entero | int | Codigo delorigen de los recursos del funcionario. Debe existir previamente. | No. |
CodSLFCanal | Entero | int | Codigo del canal por el que el cliente conocio la empresa. Debe existir previamente | No. |
CodArea | Entero | int | Codigo del area por el que el cliente conocio la empresa. Debe existir previamente | No. |
EsNivelGlobal | Entero | int | Indica si el cliente es de nivel global (1) o pertenece a alguna sucursal (0) | Si (Para empresas con multicompañia) |
Sucursales | Texto | varchar(255) | Lista de sucursales a las que pertenece el cliente | Si (Para empresas con multicompañia) |
Sample:
{ "TipoIdentificacion": "Pasaporte", "NumeroIdentificacion": "19283465", "Nombre": "Funcionario Prueba 10", "Login": "email@compania.com", "Correo": "email@compania.com", "FechaNacimiento": "2018-08-01T13:50:55.476883-05:00", "Genero": "Masculino", "Departamento": "BOGOTÁ D.C.", "Ciudad": "BOGOTÁ D.C.", "Zona": "Urbana", "Cargo": "Ninguno", "FechaIngreso": "2018-08-01T13:50:55.476883-05:00", "Jornada": "Normal", "TipoVinculacion": "Laboral", "Eps": "A.I.C.", "Afp": "Caxdac", "Arl": "Alfa", "Activo": "1", "Direccion": "Bogotá", "Telefono": "1", "CodActividadEconomica":2, "CodOrigenRecursos":2, "CodSLFCanal":17, "CodArea":1, "EsNivelGlobal":0, "Sucursales":"3,1" }
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 Funcionario 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": "Message": "Funcionario actualizado", "Entity": "{\"Id\":0,\"TipoIdentificacion\":\"Pasaporte\",\"NumeroIdentificacion\":\"19283465\",\"Nombre\":\"Funcionario Prueba 10\",\"Correo\":\"email@compania.com\",\"FechaNacimiento\":\"2018-08-01T13:50:55.476883-05:00\",\"Genero\":\"Masculino\",\"Departamento\":\"BOGOTÁ D.C.\",\"Ciudad\":\"BOGOTÁ D.C.\",\"Zona\":\"Urbana\",\"Cargo\":\"Ninguno\",\"FechaIngreso\":\"2018-08-01T13:50:55.476883-05:00\",\"Jornada\":\"Normal\",\"TipoVinculacion\":\"Laboral\",\"Eps\":\"A.I.C.\",\"Afp\":\"Caxdac\",\"Arl\":\"Alfa\",\"Activo\":null,\"Direccion\":\"Bogotá\",\"Telefono\":\"1\",\"CodOrigenRecursos\":2,\"CodActividadEconomica\":2,\"CodSLFCanal\":17,\"Login\":\"email@compania.com\"\"CodArea\":1,\"EsNivelGlobal\":0,\"Sucursales\":\"3,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": 404, "Message": "Not Found : *DESCRIPCION ERROR ELEMENTO NO EXISTE*.", "Entity": null }
{ "StatusCode": 500, "Message": "InternalServerError : La solicitud no fue procesada.", "Entity": null }
Relaciona un tercero existente a un funcionario en el sistema ISOLUCIÓN.
HTTP POST: https://[service_address]/api/funcionarios/[idFuncionario]/Tercero
[service_address]: Dirección disponible para conectividad con el API, debe validarse con su proveedor de ISOLUCIÓN.
[idFuncionario]: Identificador único de funcionario (id) en isolucion (Ver Objeto funcionario).
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 |
---|---|---|---|---|
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. |
Sample:
{ "IdTercero": 12, "Porcentaje": 30, "TipoRelacion": 3 }
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,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 }
Elimina relación de un tercero existente a un funcionario en el sistema ISOLUCIÓN.
HTTP DELETE: https://[service_address]/api/funcionarios/[idFuncionario]/Tercero/[idTercero]/TipoRelacion/[idTipoRelacion]
[service_address]: Dirección disponible para conectividad con el API, debe validarse con su proveedor de ISOLUCIÓN.
[idFuncionario]: Identificador único de funcionario (id) en isolucion (Ver Objeto funcionario).
[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) .
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,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 }