Configuración
Esta sección aborda la configuración de los cálculos (calculations).
GET /calculations
Este método devuelve la lista de tipos de cálculos.
Parámetros de solicitud (Request parameters):
- company [obligatorio]: el nombre o Id. de la compañía.
- session [obligatorio]: el Id. de la sesión activa.
- process [obligatorio]: el Id. del proceso.
Respuesta (Response):
- status: devuelve "0" en caso de éxito y un código de error en cualquier otro caso.
- data: devuelve la lista de tipos de cálculo.
- message: "Success" o una información descriptiva del error en cualquier otro caso.
Request: { "session": "cJvqHJcEssmpGukxrZF73migL5M4LVUZniyesQHBatOvTkrbpkYgrHKvfVpP", "company": "demo01", "process": "P0001" } Response: { "status": "0", "data": [ { "name": "Euros", "variables": "Euros", "units": "Euros", "formula": ""Euros"" } "message": "Success" } |
POST/calculations
Este método crea un tipo de cálculo. El usuario debe ser administrador.
Parámetros de solicitud (Request parameters, para obtener información adicional, revise la configuración de los tipos de cálculo):
- company [obligatorio]: el nombre o Id. de la compañía.
- session [obligatorio]: el Id. de la sesión activa.
- name [obligatorio]: el nombre del tipo de cálculo.
- variables: variables que se solicitarán para calcular la cantidad. Consulte en la configuración las variables predefinidas.
- Unidad (units): unidades de medida que se usarán para expresar el resultado del cálculo.
- Fórmula (formula): función matemática utilizada para calcular el resultado. Las variables deben incluirse entre comillas, por ejemplo así: "Ancho".
Request: { "session": "cJvqHJcEssmpGukxrZF73migL5M4LVUZniyesQHBatOvTkrbpkYgrHKvfVpP", "company": "demo01", "id": "Calc" } Response: { "status": 0, "data": true, "message": "Success" } |
DELETE/calculations/{id}
Este método elimina un tipo de cálculo. El usuario debe ser administrador.
Atributo de solicitud (Request attribute):
- id [obligatorio]: Id. del tipo de cálculo a eliminar.
Parámetros de solicitud (Request parameters):
- company [obligatoria]: el nombre o Id. de la compañía.
- session [obligatorio]: el Id. de la sesión activa.
Respuesta (Response):
- status: devuelve "0" en caso de éxito y un código de error en cualquier otro caso.
- data: "Success" en caso de éxito, y vacío en caso de error.
- message: "Success" o una información descriptiva del error en cualquier otro caso.
Request: { /calculations/Calc } { "session": "cJvqHJcEssmpGukxrZF73migL5M4LVUZniyesQHBatOvTkrbpkYgrHKvfVpP", "company": "demo01" } Response: { "status": 0, "data": null, "message": "Success" } |