Back to Aurora Vision Library website

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

Http_SendRequest_POST_JSON


Header: AVL.h
Namespace: avl
Module: FoundationBasic

Sends a POST request in JSON format to the server and receives a text answer.

Syntax

C++
C#
 
void avl::Http_SendRequest_POST_JSON
(
	const atl::String& inUrl,
	const atl::String& inJsonData,
	int inTimeout,
	atl::Conditional<atl::String>& outAnswer,
	int& outResponseCode
)

Parameters

Name Type Range Default Description
Input value
 inUrl const String& URL of request.
Input value
 inJsonData const String& Request JSON to send.
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 POST request to the server using application/json format. Filter waits for the text sever answer.

Examples

Filter executed with parameters:

  • inUrl = http://localhost/test
  • inJsonData = "{'value': 5}"

Request sent to the server:

POST /test HTTP/1.1
Host: localhost
User-Agent: Aurora Vision/1.0
Accept: application/json
Content-Type: application/json
charset: utf-8
Content-Length: 12

{'value': 5}

Remarks

Filter only accepts text answers encoded using UTF-8 or plain ASCII.

Errors

List of possible exceptions:

Error type Description
DomainError Empty inUrl in Http_SendRequest_POST_JSON.
DomainError Invalid inUrl in Http_SendRequest_POST_JSON.
DomainError Secured HTTPS connection is not supported Http_SendRequest_POST_JSON.

See Also