You are here: Start » FIL.NET » Function Reference » System » HTTP » FIL.Http_SendRequest_PATCH

FIL.Http_SendRequest_PATCH

Sends a PATCH request to the server and receives a text answer.

Namespace:FilNet
Assembly:FIL.NET.dll

Syntax

C++
C#
 
public static void Http_SendRequest_PATCH
(
	string inUrl,
	IList<string> inHeaders,
	IList<string> inHeadersData,
	IList<string> inFields,
	IList<string> inFieldsData,
	int inTimeout,
	bool inAllowUntrusted,
	NullableRef<string> inCaCertFile,
	INullable<string> outAnswer,
	out int outResponseCode
)

Parameters

Name Type Range Default Description
inUrlstringURL of request.
inHeadersSystem.Collections.Generic.IList<string>Request headers to send. They will be automatically encoded.
inHeadersDataSystem.Collections.Generic.IList<string>Request headers to send. They will be automatically encoded.
inFieldsSystem.Collections.Generic.IList<string>Request data to send. It will be automatically encoded.
inFieldsDataSystem.Collections.Generic.IList<string>Request data to send. It will be automatically encoded.
inTimeoutint<0, INF>60Request timeout in seconds. Default value: 60.
inAllowUntrustedboolFalseWhether or not to allow untrusted SSL certificates. Default value: False.
inCaCertFileFilNet.NullableRef<string>File holding one or more certificates to verify the peer with. Default value: ftl::NIL.
outAnswerFilNet.INullable<string>Answer text if provided in UTF-8 encoding. This parameter cannot be null.
outResponseCodeintAnswer code. Typically 200 for OK.

Description

Filter sends a PATCH request to the server using application/x-www-form-urlencoded format. Filter 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:

PATCH /test HTTP/1.1
Host: localhost
User-Agent: FabImage/1.0
Accept: */*
Content-Length: 17
Content-Type: application/x-www-form-urlencoded

param1=1&param2=2

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_PATCH_ByteBuffer.

Errors

List of possible exceptions:

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

Function Overrides

See also