Histórico da Página

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

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"

#INCLUDE "TOTVS.CH"
#INCLUDE "RESTFUL.CH"
 
WSRESTFUL Users DESCRIPTION "Classe Users"
 
WSDATA cResponse   AS STRING
WSDATA Count      AS INTEGER OPTIONAL
WSDATA StartIndex AS INTEGER OPTIONAL 
 
 
WSMETHOD GET DESCRIPTION "GET"
WSMETHOD POST DESCRIPTION "POST"
WSMETHOD PUT DESCRIPTION "PUT"
WSMETHOD DELETE DESCRIPTION "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.

Tratamento de erro

Dada a natureza envolvida no processamento REST, a rotina de tratamento de erro prevê o tratamento de ocorrências, desde advertência de carga dos serviços, falhas de inicialização de ambiente, passando por erros que invalidam um determinado serviço compilado, até as ocorrências de inconsistência de parâmetros de chamada do serviço, inconsistência de retorno, ocorrências de erro fatal de processamento na aplicação e ocorrências de processamento que não constituam um erro fatal, porém devem retornar um pacote de ocorrência de erro, conhecido por REST FAULT.

Portanto, não é necessário a implementação de rotinas de tratamento de erro nos métodos REST, porém se faz necessário a verificação de erros de chamada do método REST, tais como: Valores errados, ausência de parametros ou dados, etc...

Para gerar um REST FAULT, deve-se utilizar a função SetRestFault. Esta função faz o tratamento adequado de erro e comunica ao requisitante.