Formato de los pedidos Web API ERP10

Los endpoints disponibles en la Web API requieren parámetros en la petición y devuelven respuestas diferentes en función de la operación asociada.

Aunque hay endpoints que proporcionan operaciones específicas sobre determinadas entidades, dependiendo de la lógica de negocio de las mismas, los parámetros de entrada y los resultados están tipificados para las siguientes operaciones principales:

• Crear/Actualizar un registro (POST).
• Anular un registro (DELETE).
• Consultar un registro (GET).
• Consultar atributos de los registros (GET).

Crear y actualizar un registro (POST)

URL:

http://localhost:2018/WebApi/Base/Artigos/Actualiza

Parámetros:

• En este caso, el único parámetro es el registro a crear, serializado en JSON, en el cuerpo del mensaje.
• Para actualizar un registro, solo tiene que incluir la siguiente información "EmModoEdicao": true.

Status code esperado:

• 204 (No Content): indica que el registro se ha creado correctamente.

Consultar un registro (GET)

URL:

http://localhost:2018/WebApi/Base/Artigos/Edita/{key}

Parámetros:

• key: el identificador o clave del registro que se desea consultar.

Status code esperado:

• 200 (OK): indica que el registro se ha devuelto correctamente.

Resultado esperado:

• El registro seleccionado, serializado en JSON, en el cuerpo del mensaje.

Consultar un valor de un registro (GET)

URL:

http://localhost:2018/WebApi/Base/Artigos/Edita/{chave}/{Atributo}

Parámetros:

• Clave: el identificador o clave del registro que quiere consultar.
• Atributo: el nombre del campo de la base de datos que quiere consultar.

Status code esperado:

• 200 (OK): indica que el registro se ha devuelto correctamente.

Resultado esperado:

• El registro seleccionado, serializado en JSON, en el cuerpo del mensaje.

Consultar varios valores de un registro (GET)

URL:

http://localhost:2018/WebApi/Base/Artigos/Edita/{chave}

Parámetros:

• Clave: el identificador o clave del registro que se desea consultar.

Cuerpo del mensaje

• Incluir en el cuerpo del mensaje, en formato JSON, los nombres de los campos de los distintos atributos que desee consultar.

Status code esperado:

• 200 (OK): indica que el registro se ha devuelto correctamente.

Resultado esperado:

• El registro seleccionado, serializado en JSON, en el cuerpo del mensaje.

Los resultados documentados anteriormente corresponden a situaciones de éxito, cuando el endpoint realiza la operación esperada sin que se produzcan errores. La Web API devuelve otros códigos en caso de error y, en esos casos, puede devolver otros resultados con información sobre los errores (por ejemplo, cuando falla la validación de parámetros).