SIIT.CoreApi 0.1.0

SDK del proyecto Core.Api

El SDK del proyecto Core.Api es una biblioteca diseñada para encapsular y simplificar las peticiones generales utilizadas en el proyecto. Proporciona una interfaz fácil de usar y abstrae la complejidad de las llamadas a la API, lo que permite a los desarrolladores interactuar con el sistema Core.Api de manera más eficiente.

Características

• Proporciona métodos para realizar peticiones HTTP a través de la API del proyecto Core.Api.
• Abstrae la lógica subyacente de las llamadas a la API, lo que facilita su uso y reduce la cantidad de código necesario.
• Maneja la autenticación y la autorización necesarias para acceder a los recursos protegidos del proyecto.
• Ofrece soporte para el manejo de errores y el control de excepciones durante las peticiones a la API.
• Permite la configuración de opciones personalizadas, como la configuración del tiempo de espera de las peticiones y el manejo de cabeceras adicionales.

Instalación

El SDK del proyecto Core.Api está disponible a través de Paquete NUGET y se puede instalar utilizando el siguiente comando:

dotnet add package SIIT.CoreApi --version 0.0.1

Uso

A continuación se muestra un ejemplo básico de cómo utilizar el SDK para realizar una petición GET a la API del proyecto Core.Api:

using Core.SDK;
var coreApi = new CoreApi("API_URL", "API_KEY");
var a = await coreApi.EstadoCivil.GetAll();
var b = await coreApi.EstadoCivil.Get(Guid.Parse("95ba7149-97f6-49ce-8c93-3dffe921dd33"));

Ten en cuenta que debes reemplazar 'API_KEY' con tu propia clave de API válida para acceder a los recursos protegidos del proyecto Core.Api.

Clases y Métodos

La clase "EstadoCivil" proporciona métodos para obtener información relacionada con el estado civil.

Método "Obtener":

• Descripción: Este método obtiene un estado civil basado en un identificador único.
• Parámetros:
  • "orid": Un GUID que representa el identificador del estado civil.
• Tipo de retorno: Una tarea asincrónica que devuelve un objeto "EstadoCivil" de la biblioteca "Core.SDK.Models".
• Excepciones: Puede lanzar una excepción de tipo "HttpRequestException" si ocurre algún error durante la solicitud HTTP.

Método "ObtenerTodos":

• Descripción: Este método obtiene todos los estados civiles disponibles.
• Parámetros: Ninguno.
• Tipo de retorno: Una tarea asincrónica que devuelve una lista de objetos "EstadoCivil" de la biblioteca "Core.SDK.Models".
• Excepciones: Puede lanzar una excepción de tipo "HttpRequestException" si ocurre algún error durante la solicitud HTTP.

La clase "GrupoSanguineo" proporciona métodos para obtener información relacionada con los grupos sanguíneos.

Método "Obtener":

• Descripción: Este método obtiene un grupo sanguíneo basado en un identificador único.
• Parámetros:
  • "orid": Un GUID que representa el identificador del grupo sanguíneo.
• Tipo de retorno: Una tarea asincrónica que devuelve un objeto "GrupoSanguineo" de la biblioteca "Core.SDK.Models".
• Excepciones: Puede lanzar una excepción de tipo "HttpRequestException" si ocurre algún error durante la solicitud HTTP.

Método "ObtenerTodos":

• Descripción: Este método obtiene todos los grupos sanguíneos disponibles.
• Parámetros: Ninguno.
• Tipo de retorno: Una tarea asincrónica que devuelve una lista de objetos "GrupoSanguineo" de la biblioteca "Core.SDK.Models".
• Excepciones: Puede lanzar una excepción de tipo "HttpRequestException" si ocurre algún error durante la solicitud HTTP.

La clase "Localidad" proporciona métodos para obtener información relacionada con las localidades.

Método "Obtener":

• Descripción: Este método obtiene una localidad basada en un identificador único.
• Parámetros:
  • "orid": Un GUID que representa el identificador de la localidad.
• Tipo de retorno: Una tarea asincrónica que devuelve un objeto "Localidad" de la biblioteca "Core.SDK.Models".
• Excepciones: Puede lanzar una excepción de tipo "HttpRequestException" si ocurre algún error durante la solicitud HTTP.

Método "ObtenerLocalidadLomas":

• Descripción: Este método obtiene una lista de localidades relacionadas con Lomas.
• Parámetros: Ninguno.
• Tipo de retorno: Una tarea asincrónica que devuelve una lista de objetos "Localidad" de la biblioteca "Core.SDK.Models".
• Excepciones: Puede lanzar una excepción de tipo "HttpRequestException" si ocurre algún error durante la solicitud HTTP.

Método "ObtenerProvinciaPartido":

• Descripción: Este método obtiene la provincia y el partido de una localidad basada en su identificador.
• Parámetros:
  • "idLocalidad": Un GUID que representa el identificador de la localidad.
• Tipo de retorno: Una tarea asincrónica que devuelve un objeto "Localidad" de la biblioteca "Core.SDK.Models" con los identificadores de la provincia y el partido.
• Excepciones: Puede lanzar una excepción de tipo "HttpRequestException" si ocurre algún error durante la solicitud HTTP.

Método "ObtenerPorIdPartido":

• Descripción: Este método obtiene una lista de localidades basadas en el identificador del partido.
• Parámetros:
  • "idPartido": Un GUID que representa el identificador del partido.
• Tipo de retorno: Una tarea asincrónica que devuelve una lista de objetos "Localidad" de la biblioteca "Core.SDK.Models".
• Excepciones: Puede lanzar una excepción de tipo "HttpRequestException" si ocurre algún error durante la solicitud HTTP.

La clase "ObraSocial" proporciona métodos para obtener información relacionada con las obras sociales.

Método "ObtenerTodos":

• Descripción: Este método obtiene un listado completo de todas las obras sociales disponibles.
• Parámetros: Ninguno.
• Tipo de retorno: Una tarea asincrónica que devuelve una lista de objetos "ObraSocial" de la biblioteca "Core.SDK.Models".
• Excepciones: Puede lanzar una excepción de tipo "HttpRequestException" si ocurre algún error durante la solicitud HTTP.

Método "Obtener":

• Descripción: Este método obtiene una obra social basada en un identificador único.
• Parámetros:
  • "orid": Un GUID que representa el identificador de la obra social.
• Tipo de retorno: Una tarea asincrónica que devuelve un objeto "ObraSocial" de la biblioteca "Core.SDK.Models".
• Excepciones: Puede lanzar una excepción de tipo "HttpRequestException" si ocurre algún error durante la solicitud HTTP.

La clase "Pais" proporciona métodos para obtener información relacionada con los países.

Método "ObtenerTodos":

• Descripción: Este método obtiene un listado completo de todos los países disponibles.
• Parámetros: Ninguno.
• Tipo de retorno: Una tarea asincrónica que devuelve una lista de objetos "Pais" de la biblioteca "Core.SDK.Models".
• Excepciones: Puede lanzar una excepción de tipo "HttpRequestException" si ocurre algún error durante la solicitud HTTP.

Método "Obtener":

• Descripción: Este método obtiene un país basado en un identificador único.
• Parámetros:
  • "orid": Un GUID que representa el identificador del país.
• Tipo de retorno: Una tarea asincrónica que devuelve un objeto "Pais" de la biblioteca "Core.SDK.Models".
• Excepciones: Puede lanzar una excepción de tipo "HttpRequestException" si ocurre algún error durante la solicitud HTTP.

La clase "Partido" proporciona métodos para obtener información relacionada con los partidos.

Método "ObtenerPorIdProvincia":

• Descripción: Este método obtiene un listado de partidos basado en el identificador único de una provincia.
• Parámetros:
  • "orid": Un GUID que representa el identificador único de la provincia.
• Tipo de retorno: Una tarea asincrónica que devuelve una lista de objetos "Partido" de la biblioteca "Core.SDK.Models".
• Excepciones: Puede lanzar una excepción de tipo "HttpRequestException" si ocurre algún error durante la solicitud HTTP.

Método "Obtener":

• Descripción: Este método obtiene un partido basado en un identificador único.
• Parámetros:
  • "orid": Un GUID que representa el identificador único del partido.
• Tipo de retorno: Una tarea asincrónica que devuelve un objeto "Partido" de la biblioteca "Core.SDK.Models".
• Excepciones: Puede lanzar una excepción de tipo "HttpRequestException" si ocurre algún error durante la solicitud HTTP.

La clase "Persona" proporciona métodos para realizar operaciones relacionadas con personas.

Método "InsertarPersona":

• Descripción: Este método inserta una nueva persona en la API.
• Parámetros:
  • "persona": Un objeto de tipo "Persona" de la biblioteca "Core.SDK.Models" que representa la persona a insertar.
• Tipo de retorno: Una tarea asincrónica que devuelve un objeto de tipo "Persona" de la biblioteca "Core.SDK.Models" con el nuevo GUID generado para la persona.
• Excepciones: Puede lanzar una excepción de tipo "HttpRequestException" si ocurre algún error durante la solicitud HTTP.

Método "ActualizarPersona":

• Descripción: Este método actualiza la información de una persona en la API.
• Parámetros:
  • "persona": Un objeto de tipo "Persona" de la biblioteca "Core.SDK.Models" que representa la persona a actualizar.
• Tipo de retorno: Una tarea asincrónica que devuelve un objeto de tipo "Persona" de la biblioteca "Core.SDK.Models" que representa la persona actualizada.
• Excepciones: Puede lanzar una excepción de tipo "HttpRequestException" si ocurre algún error durante la solicitud HTTP.

Método "ObtenerOrids":

• Descripción: Este método obtiene una lista de identificadores únicos (GUID) relacionados con un documento o nombre específico.
• Parámetros:
  • "documento" (opcional): Un string que representa el documento relacionado.
  • "nombre" (opcional): Un string que representa el nombre relacionado.
• Tipo de retorno: Una tarea asincrónica que devuelve una lista de GUID.
• Excepciones: Puede lanzar una excepción de tipo "HttpRequestException" si ocurre algún error durante la solicitud HTTP.

Método "ObtenerPorDocumento":

• Descripción: Este método obtiene una persona basada en un documento específico.
• Parámetros:
  • "documento": Un string que representa el documento de la persona a buscar.
• Tipo de retorno: Una tarea asincrónica que devuelve un objeto de tipo "Persona" de la biblioteca "Core.SDK.Models".
• Excepciones: Puede lanzar una excepción de tipo "HttpRequestException" si ocurre algún error durante la solicitud HTTP.

Método "ObtenerPorId":

• Descripción: Este método obtiene una persona basada en un identificador único (GUID).
• Parámetros:
  • "orid": Un GUID que representa el identificador único de la persona a buscar.
• Tipo de retorno: Una tarea asincrónica que devuelve un objeto de tipo "Persona" de la biblioteca "Core.SDK.Models".
• Excepciones: Puede lanzar una excepción de tipo "HttpRequestException" si ocurre algún error durante la solicitud HTTP.

Método "EliminarPersona":

• Descripción: Este método elimina una persona basada en un identificador único (GUID).
• Parámetros:
  • "orid": Un GUID que representa el identificador único de la persona a eliminar.
• Tipo de retorno: Una tarea asincrónica que devuelve un objeto de tipo "Persona" de la biblioteca "Core.SDK.Models".
• Excepciones: Puede lanzar una excepción de tipo "HttpRequestException" si ocurre algún error durante la solicitud HTTP.

La clase "Provincia" proporciona métodos para realizar operaciones relacionadas con provincias.

Método "ObtenerTodos":

• Descripción: Este método obtiene un listado de todas las provincias disponibles en la API.
• Parámetros: No tiene parámetros.
• Tipo de retorno: Una tarea asincrónica que devuelve una lista de objetos de tipo "Provincia" de la biblioteca "Core.SDK.Models".
• Excepciones: Puede lanzar una excepción de tipo "HttpRequestException" si ocurre algún error durante la solicitud HTTP.

Método "Obtener":

• Descripción: Este método obtiene una provincia basada en un identificador único (GUID).
• Parámetros:
  • "orid": Un GUID que representa el identificador único de la provincia a buscar.
• Tipo de retorno: Una tarea asincrónica que devuelve un objeto de tipo "Provincia" de la biblioteca "Core.SDK.Models".
• Excepciones: Puede lanzar una excepción de tipo "HttpRequestException" si ocurre algún error durante la solicitud HTTP.

La clase "Sexo" proporciona métodos para realizar operaciones relacionadas con los sexos.

Método "ObtenerTodos":

• Descripción: Este método obtiene un listado completo de todos los sexos disponibles en la API.
• Parámetros: No tiene parámetros.
• Tipo de retorno: Una tarea asincrónica que devuelve una lista de objetos de tipo "Sexo" de la biblioteca "Core.SDK.Models".
• Excepciones: Puede lanzar una excepción de tipo "HttpRequestException" si ocurre algún error durante la solicitud HTTP.

Método "Obtener":

• Descripción: Este método obtiene un objeto de sexo basado en un identificador único (GUID).
• Parámetros:
  • "orid": Un GUID que representa el identificador único del sexo a buscar.
• Tipo de retorno: Una tarea asincrónica que devuelve un objeto de tipo "Sexo" de la biblioteca "Core.SDK.Models".
• Excepciones: Puede lanzar una excepción de tipo "HttpRequestException" si ocurre algún error durante la solicitud HTTP.

La clase "TipoDocumento" proporciona métodos para realizar operaciones relacionadas con los tipos de documentos.

Método "ObtenerTodos":

• Descripción: Este método obtiene un listado completo de todos los tipos de documentos disponibles en la API.
• Parámetros: No tiene parámetros.
• Tipo de retorno: Una tarea asincrónica que devuelve una lista de objetos de tipo "TipoDocumento" de la biblioteca "Core.SDK.Models".
• Excepciones: Puede lanzar una excepción de tipo "HttpRequestException" si ocurre algún error durante la solicitud HTTP.

Método "Obtener":

• Descripción: Este método obtiene un objeto de tipo de documento basado en un identificador único (GUID).
• Parámetros:
  • "orid": Un GUID que representa el identificador único del tipo de documento a buscar.
• Tipo de retorno: Una tarea asincrónica que devuelve un objeto de tipo "TipoDocumento" de la biblioteca "Core.SDK.Models".
• Excepciones: Puede lanzar una excepción de tipo "HttpRequestException" si ocurre algún error durante la solicitud HTTP.

La clase "Profesiones" proporciona métodos para realizar operaciones relacionadas con las profesiones.

Método "ObtenerTodos":

• Descripción: Este método obtiene un listado completo de todas las profesiones disponibles en la API.
• Parámetros: No tiene parámetros.
• Tipo de retorno: Una tarea asincrónica que devuelve una lista de objetos de tipo "Profesion" de la biblioteca "Core.SDK.Models".
• Excepciones: Puede lanzar una excepción de tipo "HttpRequestException" si ocurre algún error durante la solicitud HTTP.

Método "Obtener":

• Descripción: Este método obtiene un objeto de profesión basado en un identificador único (GUID).
• Parámetros:
  • "orid": Un GUID que representa el identificador único de la profesión a buscar.
• Tipo de retorno: Una tarea asincrónica que devuelve un objeto de tipo "Profesion" de la biblioteca "Core.SDK.Models".
• Excepciones: Puede lanzar una excepción de tipo "HttpRequestException" si ocurre algún error durante la solicitud HTTP.

Método "Insertar":

• Descripción: Este método inserta un nuevo objeto de profesión en la API.
• Parámetros:
  • "profesion": Un objeto de tipo "Profesion" que representa la profesión a insertar.
• Tipo de retorno: Una tarea asincrónica que devuelve un objeto de tipo "Profesion" de la biblioteca "Core.SDK.Models".
• Excepciones: Puede lanzar una excepción de tipo "HttpRequestException" si ocurre algún error durante la solicitud HTTP.

Método "Actualizar":

• Descripción: Este método actualiza un objeto de profesión existente en la API.
• Parámetros:
  • "profesion": Un objeto de tipo "Profesion" que representa la profesión a actualizar.
• Tipo de retorno: Una tarea asincrónica que devuelve un objeto de tipo "Profesion" de la biblioteca "Core.SDK.Models".
• Excepciones: Puede lanzar una excepción de tipo "HttpRequestException" si ocurre algún error durante la solicitud HTTP.

Método "Eliminar":

• Descripción: Este método elimina un objeto de profesión de la API basado en un identificador único (GUID).
• Parámetros:
  • "orid": Un GUID que representa el identificador único de la profesión a eliminar.
• Tipo de retorno: Una tarea asincrónica que devuelve un objeto de tipo "Profesion" de la biblioteca "Core.SDK.Models".
• Excepciones: Puede lanzar una excepción de tipo "HttpRequestException" si ocurre algún error durante la solicitud HTTP.

Licencia

El SDK del proyecto Core.Api se distribuye bajo la Licencia GNU.