Frameworksp

Atalhos

Páginas filhas
  • 01. Web Services REST/Server
6 mais filhas

Versões comparadas

Versão antiga 3

changes.mady.by.user Eduardo Perusso Riera

Gravado em

comparado com

Nova versão 4

changes.mady.by.user Eduardo Perusso Riera

Gravado em

Chave

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

...

O retorno de um recurso REST deve ser sempre do tipo STRING. Um recurso REST deve ser desenvolvido tendo dois formatos de retorno (JSON ou XML). Para consultar o retorno esperado pelo requisitante do serviço, verifique o conteúdo da propriedade cFormat. Esta propriedade contém os valores JSON ou XML.

Tipos básicos de dados

São considerados e suportados, pelo TOTVS | Application Server, quando da declaração dos parâmetros e retorno, os seguintes tipos básicos:

TipoDescrição
StringDado AdvPL do tipo string.
DateDado AdvPL do tipo data.
IntegerDado AdvPL do tipo numérico (apenas números inteiros).
FloatDado AdvPL do tipo numérico (pode conter números inteiros e não-inteiros).
BooleanDado AdvPL do tipo booleano (lógico).
Base64BinaryDado AdvPL do tipo string binária, aceitando todos os caracteres da tabela ASCII, de CHR(0) à CHR(255).

 

Exemplo:

WSRESTFUL Users DESCRIPTION "Descrição do serviço"

WSDATA cResponse AS STRING
WSDATA Count AS INTEGER OPTIONAL
WSDATA StartIndex AS INTEGER OPTIONAL

WSMETHOD GET DESCRIPTION "Descrição do método GET"
WSMETHOD POST DESCRIPTION "Descrição do método POST"
WSMETHOD PUT DESCRIPTION "Descrição do método PUT"
WSMETHOD DELETE DESCRIPTION "Descrição do método DELETE"

END WSRESTFUL

Os parametros podem ser Obrigatório ou Opcionais. Para informar ao Framework que o parametro é Opcional deve-se incluir a expressão OPTIONAL ao final da linha de declaração da propriedade ou parâmetro.