Availability

This routine is available starting with SIL Engine™ 4.1.0.

Syntax

httpOptions(url, request)

Starting with SIL Engine™ 4.5.0:

httpOptions(url, request [, proxy])

Description

Executes an HTTP OPTIONS for the given URL using the specified HttpRequest object. Returns the message body of the response converted to the requested left operand type (if any).

Requests can also be sent through a proxy.

Parameters

Parameter name

Type

Required

Description

url

string

Yes

The URL.

requestHttpRequestYesAn HttpRequest object containing headers, cookies, parameters.
proxyHttpProxyNoAn HttpProxy object containing the host and port of the proxy server.

The request parameter should have the HttpRequest type described here. The HttpProxy type is described here.

Return type

variable return type - depending on the left hand side operator type

Example

HttpRequest request;
request.headers += httpCreateHeader("Host", "cprime.com");
string url = "http://example.org";
httpOptions(url, request);
number statusCode = httpGetStatusCode();
if (statusCode >= 200 && statusCode < 300) {
	return httpGetHeader("Allow");
}

See also