Obtiene la lista de productos existentes en el sistema ISOLUCIÓN.
HTTP GET: https://[service_address]/api/Producto/
[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 Productos 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 Productos registrados en el sistema. En el caso de respuesta no exitosa el valor es nulo. |
Sample Ok Response:
{
"StatusCode": 200,
"Message": "Lista de productos obtenida exitosamente.",
"Entity": "[{\"IdProducto\":1,\"IdProceso\":0,\"NomProducto\":\"Calibración y Mantenimiento servicios\"},{\"IdProducto\":2,\"IdProceso\":0,\"NomProducto\":\"CARACTERISTICAS DE EMBALAJE\"},{\"IdProducto\":3,\"IdProceso\":0,\"NomProducto\":\"EXTRACCION DE MADERA\"},{\"IdProducto\":4,\"IdProceso\":0,\"NomProducto\":\"Nuevo servicio\"}]"
}
Sample ERROR Response:
{
"StatusCode": 401,
"Message": "Unauthorized : *DESCRIPCION ERROR NO AUTORIZADO*.",
"Entity": null
}
{
"StatusCode": 500,
"Message": "InternalServerError : La solicitud no fue procesada.",
"Entity": null
}
Obtiene la lista de productos por proceso.
HTTP GET: https://[service_address]/api/Producto/
[service_address]: Dirección disponible para conectividad con el API, debe validarse con su proveedor de ISOLUCIÓN.
[IdProceso]: Identificador del proceso del que se quiere obtener.
| 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 |
|---|---|---|---|---|
| IdProceso | Entero | Id del Proceso. | Si. |
Sample:
{ "IdProceso" : 2}
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 productos 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 PRODUCTOS registrados en el sistema. En el caso de respuesta no exitosa el valor es nulo. |
Sample Ok Response:
{
"StatusCode": 200,
"Message": "Lista de PRODUCTOS obtenida exitosamente.",
"Entity": "[[{\"IdProducto\":1,\"IdProceso\":2,\"NomProducto\":\"producto 1\"}]]"
}
Sample ERROR Response:
{
"StatusCode": 401,
"Message": "Unauthorized : *DESCRIPCION ERROR NO AUTORIZADO*.",
"Entity": null
}
{
"StatusCode": 500,
"Message": "InternalServerError : La solicitud no fue procesada.",
"Entity": null
}