Exibir origem

Inicia a declaração de um método de Web Services (Client e/ou Server) em AdvPL.

Abrangência

ERP 11 e superiores

Sintaxe

Na declaração do Serviço REST:

WSMETHOD GET DESCRIPTION "<cDescription>" WSSYNTAX "<cSintax>"
WSMETHOD POST DESCRIPTION "<cDescription>" WSSYNTAX "<cSintax>"
WSMETHOD PUT DESCRIPTION "<cDescription>" WSSYNTAX "<cSintax>"
WSMETHOD DELETE DESCRIPTION "<cDescription>" WSSYNTAX "<cSintax>"

Na declaração do método:

WSMETHOD GET WSRECEIVE [ReceiveParms] WSSERVICE [WsRestFul]

Parâmetros

Nome	Tipo	Descrição	Obrigatório	Referência
cDescription	Caracter	Descrição do método REST	X
cSintax	Caracter	Sintaxe HTTP da chamada REST. Esta informação é utilizada na documentação do REST.	X
ReceiveParms		Indica os parâmetros, separados por vírgulas, que este método receberá. Caso um método recebe parâmetros, deve-se declarar que o mesmo recebe o parâmetro reservado NULLPARAM. O parâmetros indicados aqui devem ser declarados como WSDATA.	X
WsRestFul		Indica o nome da classe, do serviço, que o método atual pertence.

Observações

Este comando é utilizado para declarar um método da classe e para definir o método propriamente citado.
Todo método deve retornar um valor lógico indicando se houve sucesso ou falha na execução do método. Em caso de falha deve-se especificar o motivo da falha através da função SetRestFault.
Somente as operações PUT, POST, GET e DELETE estão disponíveis como métodos REST.

Exemplo de código

#INCLUDE "TOTVS.CH"
#INCLUDE "RESTFUL.CH"
 
WSRESTFUL Users DESCRIPTION "Classe Users"
 
WSDATA Count      AS INTEGER OPTIONAL
WSDATA StartIndex AS INTEGER OPTIONAL 
 
 
WSMETHOD GET DESCRIPTION "GET" WSSYNTAX "/Users/{Id} "
WSMETHOD POST DESCRIPTION "POST" WSSYNTAX "/Users/{Id} "
WSMETHOD PUT DESCRIPTION "PUT" WSSYNTAX "/Users/{Id} "
WSMETHOD DELETE DESCRIPTION "DELETE" WSSYNTAX "/Users/{Id} "
 
 
END WSRESTFUL
 
WSMETHOD GET WSRECEIVE StartIndex, Count WSSERVICE Users
 
::SetResponse("teste")
 
Return(.T.)