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

Na declaração do Serviço REST:

WSMETHOD <cVerb> [cId] DESCRIPTION <cDescription> [WSSYNTAX <cSintax>] [PATH <cPath>]

Na declaração do método:

WSMETHOD <cVerb> [cId] [QUERYPARAM <QueryParms>] [PATHPARAM <PathParms>] [HEADERPARAM <HeaderParms>] WSRESTFUL <WsRestFul>

Nome	Tipo	Descrição	Obrigatório	Referência
cVerb	-	PUT, POST, GET ou DELETE	X
cId	Caracter	ID para diferenciar e possibilitar a criação de métodos que utilizam verbos http repetidos
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.
cPath	Caracter	Trecho final da rota, utilizado para diferenciar e validar separadamente os parâmetros de QueryString e de path.
QueryParms	-	Indica os parâmetros, separados por vírgulas, que este método receberá via QueryString. Caso um método não receba parâmetros, deve-se declarar que o mesmo recebe o parâmetro reservado NULLPARAM. O parâmetros indicados aqui devem ser declarados como WSDATA.
PathParms	-	Indica os parâmetros, separados por vírgulas, que este método receberá via QueryString.
HeaderParms	-	Indica os parâmetros, separados por vírgulas, que este método receberá via Header na requisição HTTP.
WsRestFul	Caracter	Indica o nome da classe, do serviço, que o método atual pertence.	X

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.
O último parâmetro WSRESTFUL pode ser encontrado também como WSSERVICE ou WSREST. O comportamento é o mesmo nos 3 casos.