Inicia a declaração de um método de Web Services (Client e/ou Server) em AdvPL.
ERP 11 e superiores
Na declaração do Serviço REST: WSMETHOD <cVerb> [cId] DESCRIPTION <cDescription> [WSSYNTAX <cSintax>] [PATH <cPath>] [CONSUMES <cConsumes>] [PRODUCES <cProduces>] [REQUEST <cRequest>] [RESPONSE <cResponse>] Na declaração do método: WSMETHOD <cVerb> [cId] [QUERYPARAM <ReceiveParms>] [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. | ||
ReceiveParms | Indica os parâmetros, separados por vírgulas, que este método receberá. 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. | X | ||
WsRestFul | Indica o nome da classe, do serviço, que o método atual pertence. |
cVerb