Formato dos pedidos e respostas
Os endpoints disponibilizados na Web API requerem parâmetros no pedido e devolvem respostas diferentes consoante a operação associada. Apesar de existirem endpoints com operações específicas para determinadas entidades que dependem da lógica de negócio dessas entidades, os parâmetros de entrada e os resultados estão tipificados para as seguintes operações principais: Parâmetros obrigatórios para todos os endpoints Todos os endpoints têm o seguinte URL base: Os seguintes parâmetros são sempre necessários em todos os pedidos à Web API e são definidos no URL: Para assegurar a autenticação do utilizador e da aplicação é também necessário incluir sempre os seguintes valores nos headers do pedido: Mais informação: O que é a Web API? Parâmetros obrigatórios por tipo de operação Os outros parâmetros dependem do tipo de operação associado ao endpoint e devem ser definidos no URL, na query string ou no corpo da mensagem, dependendo do parâmetro. A resposta a cada pedido será sempre um status code que indica o estado da operação e, opcionalmente, um resultado no corpo da mensagem. Esses dois resultados variam também por tipo de operação. Criação de um registo (POST) URL: Parâmetros: Status code esperado: Resultado esperado: Atualização de um atributo de um registo (PUT) URL: Parâmetros: Status code esperado: Resultado esperado: Anulação de um registo (DELETE) URL: Parâmetros: Status code esperado: Resultado esperado: Consulta de um registo (GET) URL: Parâmetros: Status code esperado: Resultado esperado: Listagem de todos os registos (GET) URL: Parâmetros: Status code esperado: Resultado esperado: Listagem de uma página de registos (GET) URL: Parâmetros: Status code esperado: Resultado esperado: Os resultados documentados antes correspondem às situações de sucesso, quando o endpoint executa sem erros e realiza a operação esperada. 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). Pode consultar mais informação sobre esses cenários no seguinte documento:Parâmetros
https:///api/{account}/{subscription}/{module}/{resource}
Resultado por tipo de operação
Tipos de operação
https:///api/{account}/{subscription}/{module}/{resource}
https:///api/{account}/{subscription}/{module}/{resource}/{key}/{attributeName}
https:///api/{account}/{subscription}/{module}/{resource}/{key}
https:///api/{account}/{subscription}/{module}/{resource}/{key}
https:///api/{account}/{subscription}/{module}/{resource}
https:///api/{account}/{subscription}/{module}/{resource}?page={page}&pageSize={pageSize}
Resultados especiais
login para deixar a sua opinião.