Registro y consulta de expedientes SINCO SGD

Registro de expedientes

A través de este endpoint será posible realizar el registro de expedientes en SINCO SGD, proporcionando la información necesaria en formato JSON. A continuación, se describen los pasos y los campos requeridos para realizar el registro.

Encabezados

Authorization (string): Token de autorización necesario para acceder al recurso.

Cuerpo de la solicitud (JSON):

Campos del DTO

• IdSubserie (int): Código valido y obligatorio de una subserie. Número obligatorio del ID de una subserie existente y activa, el usuario debe contar con permisos sobre la subserie.
• IdUbicación (int): Código valido y no obligatorio de la ubicación de una bodega. Utilice el endpoint: para seleccionar una ubicación para la creación del expediente. Se admiten valores nulos.
• NumeroDeFolios: (int) Dato numérico el cual se guardará como la cantidad de folios que posee el expediente, campo obligatorio y no admite valores nulos.
• Consecutivo inicial: (int) Dato numérico el cual se guardará como la cantidad de folios que posee el expediente, campo obligatorio y no admite valores nulos.
• Consecutivo final: (int) Dato numérico el cual se guardará como la cantidad de folios que posee el expediente, campo obligatorio y no admite valores nulos.
• FechaInicial: Dato tipo fecha obligatorio, donde su formato dependerá de la configuración del servidor donde se encuentre la base de datos. Este campo no admite valores nulos.
• FechaFinal: Dato tipo fecha no obligatorio, donde su formato dependerá de la configuración del servidor donde se encuentre la base de datos.
• Descripción: (string) Descripción alfanumérica obligatoria de máximo 200 caracteres, si tiene el config de descripción duplicada no debe existir otra con la misma descripción.
• UnidadConservacion: (string) Código valido y obligatorio de una unidad de conservación. Utilice el endpoint: para seleccionar una unidad de conservación para la creación del expediente. Este campo no permite valores nulos.
• DescriptoresValor: (list) Lista de los descriptores asociados a la subserie, debe validar los que tienen fuentes de datos, los que son obligatorios, en caso que los descriptores no sean múltiples debe ingresar 1, adicional, si tienen fuente externa deben ingresar el mismo valor en los campos 'valor' y 'valor mostrar', debe validar que existan, por último, es indispensable que se ingrese correctamente el tipo de dato el descriptor (numérico, texto, fecha,etc)
  1. IdDescriptor: (int) Número obligatorio del ID del descriptor.
  2. Valor: (String) Texto obligatoriocon el valor del descriptor
  3. ValorMostrar: (String) Texto obligatorio con el valor a mostrar del descriptor
• FechaRegistro: (Date) Campo de fecha obligatorio, donde su formato dependerá de la configuración del servidor donde se encuentre la base de datos. Este campo no admite valores nulos.

Respuestas

• Código 200:
  Retorna id del expediente
• Código 400:
  Retorna error: parámetros obligatorios incorrectos o faltantes.
• Código 500:
  Retorna error: mensaje con descripción del error.

Cerrar expedientes

Este endpoint permite cerrar los expedientes creados en SINCO SGD. A continuación, se describen los pasos y los campos requeridos.

Parametros en URL

idExpediente: Dato obligatorio en el que se debe relacionar el id expediente que fue creado en SINCO SGD.

Respuestas

• Código 200:
  Expediente cerrado correctamente (Retorna un true cuando el expediente es cerrado correctamente).

• Código 400:
  Expediente no existente o id erróneo.

• Código 500:
  Expediente ya se encuentra en estado 'Cerrado'.

Consulta de expedientes

Este endpoint permite obtener la lista de expedientes creados en SINCO SGD usando una subserie y descriptores como filtro opcional. A continuación, se describen los pasos y los campos requeridos.

Encabezados

Cuerpo de la solicitud

Parametros en URL

CodigoSubserie(String): Dato obligatorio en el que se debe relacionar el Código de subserie asignado en la política de retención documental de SINCO SGD.

Respuestas

• Código 200:
  Retorna consulta con el listado de los expedientes creados bajo los parámetros de consulta (ConsultaExpedienteDto).

• Código 404:
  Retorna diferentes excepciones:
  Indicando que la subserie no existe.
  

Indicando que el descriptor que se está tomando como referencia NO se encuentra configurado en la subserie seleccionado.

Indicando que no existen expedientes con coincidencias con la información ingresadas.

• Código 500:
  Retorna una excepción indicando que no existen expedientes creados bajo la subserie.

Consultar subseries

Este endpoint permite consultar subseries usando un dato string que buscará a través del código, la descripción y/o el id.

Parámetros en URL

Id, descripción o código de la subserie: A través de los parámetros de id, descripción o código de la subserie ya creada en SINCO SGD, se deben de enviar dentro de la URL, es necesario ingresar al menos 1.

Respuestas

• Código 200: Retorna consulta de la subserie que coincide con los parámetros indicados. (SubserieGeneral).

* Código 500: Retorna una excepción indicando que no existe una subserie con los parámetros indicados:

Consultar listado de tipologías

Este Endpoint permite consultar una lista de tipologías a partir de la subserie a la que pertenecen.

Parámetros en URL

idSubserie: Dato obligatorio en el que se debe relacionar el id subserie de una subserie registrada dentro de SINCO SGD, ingresándolo como parámetro dentro de la URL.

Respuestas

• Código 200: Retorna la consulta del listado de las tipologías creadas bajo la subserie relacionada en el parámetro (ConsultaTipologiaDTO).

• Código 500: Retorna errores no controlados como por ejemplo que se ingrese información diferente a la permitida en el parámetro (string).

Crear un documento dentro de un expediente

A través de este endpoint será posible crear documentos asignados a tipologías dentro de un expediente ya registrado en SINCO SGD.

Parámetros en URL

idExpediente: Dato obligatorio en el que se debe relacionar el id del expediente de una carpeta registrada dentro de SINCO SGD, ingresandolo como parámetro dentro de la URL.

JSON (campos del DTO)

• IdExpediente: (int) Campo obligatorio en el que se debe especificar el ID de expediente existente en SINCO SGD, importante tener presente que el ID del expediente debe ser el mismo del ingresado en la URL.
• IdTipología: (int) Campo obligatorio en el que se debe especificar el ID de la tipología bajo la cual se creará el documento, importante tener presente que la tipología debe pertenecer a la subserie de creación del expediente.
• IdUbicacion: (int) Campo no obligatorio en el que se debe especificar el ID de la ubicación del documento, este dato debe coinicidir con la ubicación de la carpeta.
• FechaInicial y FechaFinal: Campos obligatorios los cuales indican las fechas del documento, importante tener presente que ambos datos deben ser iguales y que el formato de la fecha depende de la configuración del servidor SQL.
• Descripción: (string) Campo obligatorio donde se debe asignar una descripción al documento.
• UnidadConservación: (String) Campo obligatorio en el que se debe especificar el código de la unidad de conservación que se le asignará al documento.
• DescriptoresValor: Dado el caso que el documento tenga vinculación a descriptores se deben llenar los siguientes datos para que se registre el descriptor:
  • IdDescriptor: Campo obligatorio en el que se debe especificar el ID del descriptor que se desea diligenciar.
  • Valor: Campo obligatorio que debe ser diligenciado con el valor que corresponda al descriptor, para el caso de descriptores que llaman información del sistema se debe ingresar el ID de la misma.
  • Valor a mostrar: Campo obligatorio que debe ser ingresado con el valor que se desea ver dentro del documento.
• EsDigitalizado: Campo obligatorio true o false, el cual debe ser diligenciado indicando si el documento es digitalizado.
• FechaRegistro: Campo obligatorio indicando la fecha de registro del documento, mportante tener presente que el formato de la fecha depende de la configuración del servidor SQL.

Respuestas

• Código 200: Retorna el ID del documento, indicando creación exitosa dentro de SINCO SGD.

• Código 400: Retorna Expediente incorrecto cuando el ID del expediente ingresado en el JSON es diferente al ID de la URL.

• Código 500: Retorna diferentes excepciones:
  Indicando expediente no encontrado cuando el expediente no existe en SINCO SGD.
  

Indicando excepciones no controladas, las cuales pueden ser que el ID de la tipología no existe, el formato de la fecha no corresponde y/o la unidad de conservación no existe.

Indicando que la unidad de conservación, las fechas, descripción, id's son obligatorios, según el dato que falte.

Cargar adjuntos

A través de este endpoint será posible cargar adjuntos a los documentos registrados en SINCO SGD.

Body (cuerpo solicitud)

Para el request de la solicitud es necesario que el tipo de dato sea 'FromData', donde en el objeto se deben de enviar dos JSON, uno llamado CargaDocumentos y el otro Parametros

• CargaDocumentos: Dentro de este objeto se debe incluir un objeto String el cual se debe generar con base en el siguiente JSON:

1. OrdenImagenes: (String) Campo no obligatorio que recibe el nombre de las imágenes que se están intentando cargar separado por comas y se usa para ordenar la digitalización, ejemplo: "3.jpg,1.jpg,2.jpg,0.jpg".

2. Digitalizado: Campo verdadero o falso en el cual se indica si el documento proviene de un proceso de digitalización.
3. Operacion: (input) Campo obligatorio a través del cual se debe indicar el tipo de operación que se desea realizar al documento, las cuales se pueden tomar de la siguiente tabla:

• Parametros: Para el caso de este JSON solo recibe un parámetro que corresponde al id del archivo al que se le cargará el adjunto.

• File: Campo obligatorio tipo file a través del cual se carga el adjunto que se desea subir a través del endpoint.

Respuestas

• Código 200: Retorna la confirmación de que el adjunto se ha guardado, anexado o remplazado de forma correcta, según la operación enviada en el body.

• Código 400: Retorna diferentes excepciones:
  Indicando que la operación ingresada no es válida.

Indicando que el expediente o tipología al que se le desea cargar el adjunto no se encuentra registrado en SINCO SGD.

Indicando que no se encuentra un adjunto para cargar en el sistema

• Código 500: Retorna una excepción indicando eventos no controlados por el aplicativo.

Descarga de adjuntos

A través de este endpoint será posible descargar los adjuntos que tengan relacionados los documentos y/o expedientes registrados en SINCO SGD.

Parámetros en URL

idExpediente o documento: Dato obligatorio en el que se debe relacionar el id del expediente o documento de una carpeta o documento registrado dentro de SINCO SGD, ingresandolo como parámetro dentro de la URL.

Respuestas

• Código 200: Retorna el adjunto del expediente o documento consultado para poder ser descargado.

• Código 500: Retorna dos excepciones:

Indicando que no se encuentra el archivo bajo el ID creado, lo que hace referencia a que no existe un registro bajo ese ID.

Indicando que no hay un adjunto vigente, lo que hace referencia a que no se ha cargado un adjunto al ID consultado.