V10 RecursosWeb API
RecursosWeb API
Web API
Voltar | Lista de artigos

Formato dos pedidos Web API ERP10

Última alteração a 30/09/2021

Os endpoints disponibilizados na Web API requerem parâmetros no pedido e devolvem respostas diferentes consoante a operação associada.

Ainda que existam endpoints que disponibilizam operações específicas sobre determinadas entidades, dependendo da lógica de negócio dessas entidades, os parâmetros de entrada e os resultados encontram-se tipificados para as seguintes operações principais:

  • Criação/Atualização de um registo (POST).
  • Anulação de um registo (DELETE).
  • Consulta de um registo (GET).
  • Consulta de atributos dos registos (GET).

Criação e atualização de um registo (POST)

URL:

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

Parâmetros:

  • Neste caso o único parâmetro é o próprio registo a criar, serializado em JSON, no corpo da mensagem.
  • Para atualizar um registo basta incluir no corpo da mensagem a seguinte informação "EmModoEdicao": true.

Status code esperado:

  • 204 (No Content): indica que o registo foi criado com sucesso.

Consulta de um registo (GET)

URL:

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

Parâmetros:

  • key: o identificador ou a chave do registo que se pretende consultar.

Status code esperado:

  • 200 (OK): indica que o registo foi retornado com sucesso.

Resultado esperado:

  • O registo selecionado, serializado em JSON, no corpo da mensagem.

Consulta de um valor de um registo (GET)

URL:

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

Parâmetros:

  • Chave: o identificador ou a chave do registo que se pretende consultar.
  • Atributo: o nome do campo da base dados que se quer consultar.

Status code esperado:

  • 200 (OK): indica que o registo foi retornado com sucesso.

Resultado esperado:

  • O registo selecionado, serializado em JSON, no corpo da mensagem.

Consulta de vários valores de um registo (GET)

URL:

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

Parâmetros:

  • Chave: o identificador ou a chave do registo que se pretende consultar.

Corpo da Mensagem

  • Incluir no corpo da mensagem em formato JSON, o nome dos campos dos vários atributos que se pretendem consultar.

Status code esperado:

  • 200 (OK): indica que o registo foi retornado com sucesso.

Resultado esperado:

  • O registo selecionado, serializado em JSON, no corpo da mensagem.

Os resultados documentados acima correspondem às situações de sucesso, quando o endpoint executa a operação esperada sem a ocorrência de erros. A Web API devolve outros códigos em caso de erro e, nesses casos, pode devolver outros resultados com informação sobre os erros (por exemplo, quando a validação dos parâmetros falha).

Adicionar aos favoritos ou partilhar este artigo
Esta página foi útil?
Obrigado pelo seu voto.

login para deixar a sua opinião.

Obrigado pelo seu feedback. Iremos analisá-lo para continuarmos a melhorar!
Artigos Relacionados
Utilizar o Postman para testar a WebAPI Características da Web API Como executar listas na WebAPI? Web API - Conceitos e Arquitetura Como estender a Web API?