Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

  • empty(com e sem status).

Métodos

Nome

Descrição

okCria um retorno positivo com o payload e com o código do status HTTP 200 (é possível informar um status).
asError

Cria um retorno de erro com uma lista erros da RowErrors e com o código do status HTTP informado.

asWarning

Cria um retorno positivo com uma lista warnings da RowErrors e com o código do status HTTP 200 (é possível informar um status).

emptyCria um retorno vazio e com o código do status HTTP 200 (é possível informar um status).

Exemplos

Bloco de código
titleJsonAPIResponseBuilder:ok()
...
DEFINE OUTPUT PARAM jsonOutput AS JsonObject NO-UNDO.

DEFINE VARIABLE oJsonObject  AS JsonObject      NO-UNDO.
DEFINE VARIABLE oResponse    AS JsonAPIResponse NO-UNDO.

ASSIGN oJsonObject = NEW JSONObject().

jsonOutput = JsonAPIResponseBuilder:ok(oJsonObject).
...
Bloco de código
titleJsonAPIResponseBuilder:asError()
...
DEFINE OUTPUT PARAM jsonOutput AS JsonObject NO-UNDO.

DEFINE VARIABLE oJsonObject  AS JsonObject      NO-UNDO.
DEFINE VARIABLE oResponse    AS JsonAPIResponse NO-UNDO.

ASSIGN oJsonObject = NEW JSONObject().

jsonOutput = JsonAPIResponseBuilder:asError(oJsonObject).
...
Bloco de código
titleJsonAPIResponseBuilder:asWarning()
...
DEFINE OUTPUT PARAM jsonOutput AS JsonObject NO-UNDO.

DEFINE VARIABLE oJsonObject  AS JsonObject      NO-UNDO.
DEFINE VARIABLE oResponse    AS JsonAPIResponse NO-UNDO.

ASSIGN oJsonObject = NEW JSONObject().

jsonOutput = JsonAPIResponseBuilder:asWarning(oJsonObject).
...
Bloco de código
titleJsonAPIResponseBuilder:empty()
...
DEFINE OUTPUT PARAM jsonOutput AS JsonObject NO-UNDO.

DEFINE VARIABLE oJsonObject  AS JsonObject      NO-UNDO.
DEFINE VARIABLE oResponse    AS JsonAPIResponse NO-UNDO.

ASSIGN oJsonObject = NEW JSONObject().

jsonOutput = JsonAPIResponseBuilder:empty().
...
Nota
titleImportante

O retorno dos objetos seguem o padrão conforme o "Guia de implementação de API V2.0".