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

Http_SendRequest_DELETE

Header:	FIL.h
Namespace:	fil
Module:	FoundationLite

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

Syntax

void fil::Http_SendRequest_DELETE
(
	const ftl::String& inUrl,
	const ftl::Array<ftl::String>& inHeaders,
	const ftl::Array<ftl::String>& inHeadersData,
	const ftl::Array<ftl::String>& inFields,
	const ftl::Array<ftl::String>& inFieldsData,
	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. Without parameters.
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.
inFields	const Array<String>&			Request data to send. It will be automatically encoded.
inFieldsData	const Array<String>&			Request data to send. It will be automatically encoded.
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 DELETE request to the server then waits for the server text 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
inFields = ["param1", "param2"]
inFieldsData = ["1", "2"]

Request sent to the server:

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

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. To receive answer in arbitrary format please use Http_SendRequest_DELETE_ByteBuffer.

Errors

List of possible exceptions:

Error type	Description
DomainError	Different size of inFields and inFieldsData in Http_SendRequest_DELETE.
DomainError	Different size of inHeaders and inHeadersData in Http_SendRequest_DELETE.
DomainError	Empty inUrl in Http_SendRequest_DELETE.
DomainError	Invalid inUrl in Http_SendRequest_DELETE.