Chamar um método
POST ou GET, corpo versus query string, e o que o validador de campos espera.
O nome do método faz parte do URL. Todos os outros dados de entrada, incluindo um id, são parâmetros: um campo do corpo JSON
em POST, um parâmetro da query string em GET. Ambas as formas chegam ao mesmo método e devolvem
o mesmo envelope.
POST: um corpo JSON
A forma normal para tudo o que tenha mais do que um par de parâmetros, ou com um objeto aninhado ou um array.
GET: uma query string
Útil para uma verificação rápida na barra de endereço de um navegador ou numa linha de curl. O servidor converte a
query string no mesmo corpo que o handler do método vê, pelo que as regras abaixo importam mais aqui do que
em POST.
O tipo declarado de um campo decide como o valor da query string é lido:
- string: usado tal como está.
- number: passado por
Number(...). - boolean: apenas a string literal
trueé lida comotrue. Qualquer outra coisa que passe para um campo booleano emGET, incluindofalse, é convertida num1verdadeiro. Se um booleano for importante, envie-o emPOSTcom umtrue/falseJSON real, ou simplesmente omita o parâmetro da query para o deixar no valor predefinido do método. - object / array: o valor é passado por
JSON.parse(...), pelo que um valor aninhado emGETtem de ser um parâmetro da query com uma string JSON (filters=%7B%22status%22%3A%22open%22%7D), não um aninhamento de query ao estilo de parênteses retos.
Campos obrigatórios e erros de tipo
Cada campo de um método tem um indicador mandatory e um type. Faltar um campo obrigatório, ou
enviar o tipo errado em POST (onde nada é convertido automaticamente), devolve um -1 antes de o
próprio método sequer correr:
A referência da API interativa lista os campos de todos os métodos com os seus tipos e indicadores de obrigatoriedade, e permite executar uma chamada a partir do navegador para ver o pedido exato que construiu.