Package DE_EPAGES::WebService::API::JSONRestClient
Generic client for RESTful web services using JSON messages.
Functions
buildRequest
Builds a HTTP request object for a REST call.
Syntax |
$Request = $Client->buildRequest($Method, $SubPath, $RequestData); |
Example |
my $Request = $Client->buildRequest($Method, $SubPath, $RequestData); my $Response = $Client->send($Request); my $Data = $Client->decodeResponse($Response); |
Input |
|
Return |
|
decodeResponse
Extracts and decodes information from a HTTP response object. Throws a HttpError exception if the response contains an error. See also buildRequest.
Syntax |
$ResponseData = $Client->decodeResponse($Response); |
Input |
|
Return |
|
delete
Executes a DELETE request.
Syntax |
$Client->delete($ID); |
Input |
|
get
Executes a GET request.
Syntax |
$Data = $Client->get($ID); |
Input |
|
Return |
|
new
Creates a new REST client object.
Syntax |
$Client = DE_EPAGES::WebService::API::JSONRestClient->new( $BaseURL, $hptions ); |
Input |
|
Return |
|
patch
Executes a PATCH request.
Syntax |
$ID = $Client->patch($Data); |
Input |
|
Return |
|
post
Executes a POST request.
Syntax |
$ID = $Client->post($Data); |
Input |
|
Return |
|
put
Executes a PUT request.
Syntax |
$Client->put($ID, $Data); |
Input |
|
request
Executes a REST request.
Syntax |
$ResponseData = $Client->request($Method, $SubPath, $RequestData); |
Input |
|
Return |
|
send
Sends a HTTP request and return the corresponding HTTP response object. See also buildRequest.
Syntax |
$Response = $Client->send($Request); |
Input |
|
Return |
|
userAgent
Returns the HTTP user agent.
Syntax |
$UserAgent = $Client->userAgent; |
Return |
|