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>"]
WSMETHOD POST [DESCRIPTION "<cDescription>"]
WSMETHOD PUT [DESCRIPTION "<cDescription>"]
WSMETHOD DELETE [DESCRIPTION "<cDescription>"]

 

Na declaração do método:

WSMETHOD GET WSRECEIVE [ReceiveParms] WSSEND [Response] WSSERVICE [WsRestFul]

Parâmetros

NomeTipoDescriçãoObrigatórioReferência
cDescriptionCaracterDescrição do método RESTX  
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  
ResponseCaracterIndica a declaração de apenas um parâmetro de retorno de um Web Services.  
WsRestFul Indica o nome da classe, do serviço, que o método atual pertence.  

Observações

Exemplo de código

#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
 
WSMETHOD GET WSRECEIVE StartIndex,Count  WSSEND cResponse WSSERVICE Users
 
::cResponse := "teste"
 
Return(.T.)