Back to Aurora Vision Library website

You are here: Start » Function Reference » System » HTTP » Http_SendRequest_GET

Http_SendRequest_GET


Header: AVL.h
Namespace: avl
Module: FoundationBasic

Sends a GET request to server and receives a text answer.

Syntax

C++
C#
 
void avl::Http_SendRequest_GET
(
	const atl::String& inUrl,
	const atl::Array<atl::String>& inFields,
	const atl::Array<atl::String>& inFieldsData,
	int inTimeout,
	atl::Conditional<atl::String>& outAnswer,
	int& outResponseCode
)

Parameters

Name Type Range Default Description
Input value
 inUrl const String& URL of request. Without parameters.
Input value
 inFields const Array<String>& Request data to send. It will be automatically encoded.
Input value
 inFieldsData const Array<String>& Request data to send. It will be automatically encoded.
Input value
 inTimeout int 0 - 60 Request timeout in seconds.
Output value
 outAnswer Conditional<String>& Answer text if provided in UTF-8 encoding.
Output value
 outResponseCode int& Answer code. Typically 200 for OK.

Description

Filter sends a GET request to the server. Filter waits for the sever text answer.

Examples

Filter executed with parameters:

  • inUrl = http://localhost/test
  • inFields = ["param1", "param2"]
  • inFieldsData = ["1", "2"]

Request sent to the server:

GET /test?param1=1&param2=2 HTTP/1.1
Host: localhost
User-Agent: Aurora Vision/1.0
Accept: */*

Remarks

Filter only accepts text answers encoded using UTF-8 or plain ASCII. To receive answer in arbitrary format please use Http_SendRequest_GET_ByteBuffer.

Errors

List of possible exceptions:

Error type Description
DomainError Different size of inFields and inFieldsData in Http_SendRequest_GET.
DomainError Empty inUrl in Http_SendRequest_GET.
DomainError Invalid inUrl in Http_SendRequest_GET.
DomainError Secured HTTPS connection is not supported Http_SendRequest_GET.

See Also