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

Http_SendRequest_PUT_JSON

Header:	FIL.h
Namespace:	fil
Module:	FoundationLite

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

Syntax

void fil::Http_SendRequest_PUT_JSON
(
	const ftl::String& inUrl,
	const ftl::Array<ftl::String>& inHeaders,
	const ftl::Array<ftl::String>& inHeadersData,
	const ftl::String& inJsonData,
	int inTimeout,
	bool inAllowUntrusted,
	const ftl::Optional<ftl::File>& inCaCertFile,
	ftl::Conditional<ftl::String>& outAnswer,
	int& outResponseCode
)

Parameters

Name	Type	Range	Default	Description
inUrl	const String&			URL of request.
inHeaders	const Array<String>&			Request headers to send. They will be automatically encoded.
inHeadersData	const Array<String>&			Request headers to send. They will be automatically encoded.
inJsonData	const String&			Request JSON to send.
inTimeout	int	0 -	60	Request timeout in seconds.
inAllowUntrusted	bool		False	Whether or not to allow untrusted SSL certificates.
inCaCertFile	const Optional<File>&		NIL	File holding one or more certificates to verify the peer with.
outAnswer	Conditional<String>&			Answer text if provided in UTF-8 encoding.
outResponseCode	int&			Answer code. Typically 200 for OK.

Description

Filter sends a PUT request to the server using application/json format. Filter waits for the text server answer.

When inCaCertFile is set to Auto, certificates installed in the operating system are used, otherwise only certificates from the input file are used.

Examples

Filter executed with parameters:

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

Request sent to the server:

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

{'value': 5}

It is also possible to include custom headers in the request. For this purpose, inHeaders and inHeadersData parameters are used.

Using the following values for these parameters:

inHeaders = ["Header1", "Header2"]
inHeadersData = ["value1", "value2"]

causes the following headers to be added to the request:

Header1: value1
Header2: value2

Remarks

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

Errors

List of possible exceptions:

Error type	Description
DomainError	Different size of inHeaders and inHeadersData in Http_SendRequest_PUT_JSON.
DomainError	Empty inUrl in Http_SendRequest_PUT_JSON.
DomainError	Invalid inUrl in Http_SendRequest_PUT_JSON.