Histórico da Página
| Composition Setup |
|---|
import.css=/download/attachments/327912/newLayout.css |
Classe: FWRest
| Compatível Países: | Todos |
| Sistemas Operacionais: | Todos |
| Compatível às Bases de Dados: | Todos |
| Nível de Acesso: | Nível 1 (Acesso Clientes) |
| Idiomas: | Português, Inglês, Espanhol |
Descrição
Classe Client de REST
Exemplo
user Function tstFwRestTest()
Local oRestClient := FWRest():New("http://code.google.com")//)
oRestClient:setPath("/p/json-path/")
If oRestClient:Get()
ConOut(oRestClient:GetResult())
Else
conout(oRestClient:GetLastError())
Endif
Return
New
Sintaxe
FWREST():New(<cHost >)-> NIL
Descrição
Construtor
Parâmetros
| Nome | Tipo | Descrição | Default | Obrigatório | Referência |
| cHost | Caracteres | Endereço do Host que iremos fazer o consumo do REST | X |
SetPath
Sintaxe
FWREST():SetPath(<cPath >)-> NIL
Descrição
Informa o path aonde será feito a requisição
Parâmetros
| Nome | Tipo | Descrição | Default | Obrigatório | Referência |
| cPath | Caracteres | Path do caminho da requisição | X |
Get
Sintaxe
FWREST():Get(<aHeadStr >)-> lOK
Descrição
Efetua o Comando Get, no Host e Path informados anteriormente.
Utilize o metodo getResult para pegar o resultado
Ou o metodo GetLastError para verificar o erro.
Utilize o metodo getResult para pegar o resultado
Ou o metodo GetLastError para verificar o erro.
Parâmetros
| Nome | Tipo | Descrição | Default | Obrigatório | Referência |
| aHeadStr | Array | Array com parametros do head | X |
Retorno
lOK Retorna .T. se o Get retornar o HTTP code 200.
GetResult
Sintaxe
FWREST():GetResult()-> cResult
Descrição
Retorna o ultimo conteudo valido restornado pela uma chamada ao metodo
Get ou Post
Get ou Post
Retorno
cResult Resultado da Operação
GetLastError
Sintaxe
FWREST():GetLastError()-> cErro
Descrição
Retorna o ultimo erro restornado pela uma chamada ao metodo
Get ou Post
Get ou Post
Retorno
cErro Erro da Operação
Post
Sintaxe
FWREST():Post(<aHeadStr >)-> lOK
Descrição
Efetua o Comando POST, no Host e Path informados anteriormente.
Utilize o metodo getResult para pegar o resultado
Ou o metodo GetLastError para verificar o erro.
Utilize o metodo getResult para pegar o resultado
Ou o metodo GetLastError para verificar o erro.
Parâmetros
| Nome | Tipo | Descrição | Default | Obrigatório | Referência |
| aHeadStr | Array | Array com parametros do head | X |
Retorno
lOK Retorna .T. se o Get retornar o HTTP code 200 ou 201.
SetPostParams
Sintaxe
FWREST():SetPostParams(<cParams >)-> NIL
Descrição
Seta a stirng de parametro do Post
Parâmetros
| Nome | Tipo | Descrição | Default | Obrigatório | Referência |
| cParams | Caracteres | Parametros do Post | X |
Put
Sintaxe
FWREST():Put(<aHeadStr >)-> lOK
Descrição
Efetua o Comando Put, no Host e Path informados anteriormente.
Utilize o metodo getResult para pegar o resultado
Ou o metodo GetLastError para verificar o erro.
Utilize o metodo getResult para pegar o resultado
Ou o metodo GetLastError para verificar o erro.
Parâmetros
| Nome | Tipo | Descrição | Default | Obrigatório | Referência |
| aHeadStr | Array | Array com parametros do head | X |
Retorno
lOK Retorna .T. se o Get retornar o HTTP code 200 ou 201.
Delete
Sintaxe
FWREST():Delete(<aHeadStr >)-> lOK
Descrição
Efetua o Comando DELETE, no Host e Path informados anteriormente.
Utilize o metodo getResult para pegar o resultado
Ou o metodo GetLastError para verificar o erro.
Utilize o metodo getResult para pegar o resultado
Ou o metodo GetLastError para verificar o erro.
Parâmetros
| Nome | Tipo | Descrição | Default | Obrigatório | Referência |
| aHeadStr | Array | Array com parametros do head | X |
Retorno
lOK Retorna .T. se o Get retornar o HTTP code 200 ou 201.
SetlChkStatus
Sintaxe
FWRest():SetlChkStatus(lChk)-> Nil
Descrição
Seta a variável de controle de checagem do HTTP Code, onde se informado falso, apenas retornamos o lOk como true para indicar que realizamos a conexão, ficando a critério do responsável validar o HTTP Code retornado pela requisição.
Parâmetros
| Nome | Tipo | Descrição | Default | Obrigatório | Referência |
| lChk | Lógico | Variável de decisão sobre quem irá checar o retorno do HTTP Code | .T. |
Retorno
Nil
GetlChkStatus
Sintaxe
FWRest():GetlChkStatus()->lChk
Descrição
Retorna o conteúdo do parâmetro lChkStatusCode que será utilizado nos métodos get, post, put e delete onde é feito a decisão de quem irá tratar o HTTP Code.
Retorno
lChkStatusCode - Variável de decisão de quem trata a checagem de HTTP Code
GetHTTPCode
Sintaxe
FWRest():GetHTTPCode()
Descrição
Método que retorna o HTTPCode da requisição.
Retorno
cResult – Retorno HTTP Code da requisição
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas