Obtiene el contenido (array de bytes) de un documento segun su identificador en ISOLUCIÓN.
HTTP GET: https://[service_address]/api/documento/{id}
[service_address]: Dirección disponible para conectividad con el API, debe validarse con su proveedor de ISOLUCIÓN.
[id]:Identificador del documento del cual se quiere obtener su contenido.
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,404,500] Exito,Error. |
Message | "Message":"Documento obtenido exitosamente." | Descripción de la respuesta exitosa o mensaje de error enviado por el servidor. |
Entity | "Entity": [] | Formato JSON con el listado de roles de usuario registradas en el sistema. En el caso de respuesta no exitosa el valor es nulo. |
Sample OK Response:
{ "StatusCode": 200, "Message": "Documento obtenido exitosamente..", "Entity": "[documento arreglo bytes]" }
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 }
Obtiene el contenido (array de bytes) de un documento por URL.
HTTP GET: https://[service_address]/api/documento
[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 | Tipo | Descripción | Obligatorio |
---|---|---|---|---|
URL | Texto | Ruta del documento dentro de isolucion. | Si. |
Sample:
[]
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":" Documento obtenido exitosamente." | Descripción de la respuesta exitosa o mensaje de error enviado por el servidor. |
Entity | "Entity": [] | 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": "Documento obtenido exitosamente.", "Entity": "[]" }
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 }