You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 7 Next »

Application service module that provides OpenInsight HTTP communication features.

Syntax

Response = HTTPClient_Services(Service, Param1, Param2, Param3, Param4, Param5, Param6, Param7, Param8, Param9, Param10)

Returns

The meaning of the response value depends on the service.

Parameters

ParameterDescription
ServiceThe name of the service being requested. Required.
Param1 - Param10Generic parameters.

Remarks 

HTTPClient_Services provides very useful application services so OpenInsight applications can make HTTP requests to other web servers. The response to each request is kept in memory until the next request is made, thus allowing the developer to get various HTTP response results when it is convenient (such as the body, status code, or response header values).

Services

ServiceDescription
SendHTTPRequest

Usage:
HTTPClient_Services('SendHTTPRequest', Method, URL, HeaderList, Body, ProxyUser, ProxyPassword, UseAsynchronous, UseXMLHTTP)

Comments:
Calls the indicated HTTP web service routine. The arguments are defined as follows:

  • Method. The HTTP method to submit to the server. - (Required)
  • URL. The URL receiving the HTTP request. - (Required)
  • HeaderList. An @FM/@VM list of request header names and values. - (Optional)
  • Body. The request body to be sent to the server. - (Optional)
  • ProxyUser. Username needed to authenticate against a proxy server. - (Optional)
  • ProxyPassword. Password needed to authenticate against a proxy server. - (Optional)
  • UseAsynchronous. Flag to determine if the HTTP request should be processed asynchronously. Default is True. - (Optional)
  • UseXMLHTTP. Flag to determine if client XMLHTTP or server XMLHTTP should be used. Default is server XMLHTTP. - (Optional)

Returns:
The HTTP response body from the server. The HTTP response body can also be retreived via the GetResponseBody service.

SetRequestHeaderFields

Usage:
HTTPClient_Services('SetRequestHeaderFields', HeaderList)

Comments:
Calls the indicated HTTP web service routine.

Returns:
The HTTP response body from the server.

SetRequestHeaderField

Usage:
HTTPClient_Services('SetRequestHeaderField', Name, Value)

Comments:
Calls the indicated HTTP web service routine.

Returns:
The HTTP response body from the server.

GetRequestHeaderFields

Usage:
HTTPClient_Services('GetRequestHeaderFields')

Comments:
Calls the indicated HTTP web service routine.

Returns:
The HTTP response body from the server.

GetRequestHeaderField

Usage:
HTTPClient_Services('GetRequestHeaderField', Name)

Comments:
Calls the indicated HTTP web service routine.

Returns:
The HTTP response body from the server.

SetResponseHeaderField

Usage:
HTTPClient_Services('SetResponseHeaderField', Name, Value)

Comments:
Calls the indicated HTTP web service routine.

Returns:
The HTTP response body from the server.

GetResponseHeaderFields

Usage:
HTTPClient_Services('GetResponseHeaderFields')

Comments:
Calls the indicated HTTP web service routine.

Returns:
The HTTP response body from the server.

GetResponseHeaderField

Usage:
HTTPClient_Services('GetResponseHeaderField', Name)

Comments:
Calls the indicated HTTP web service routine.

Returns:
The HTTP response body from the server. 

SetResponseStatusCode

Usage:
HTTPClient_Services('SetResponseStatusCode', Code)

Comments:
Calls the indicated HTTP web service routine.

Returns:
The HTTP response body from the server. 

GetResponseStatusCode

Usage:
HTTPClient_Services('GetResponseStatusCode')

Comments:
Calls the indicated HTTP web service routine.

Returns:
The HTTP response body from the server. 

SetResponseStatusPhrase

Usage:
HTTPClient_Services('SetResponseStatusPhrase', Phrase)

Comments:
Calls the indicated HTTP web service routine.

Returns:
The HTTP response body from the server. 

GetResponseStatusPhrase

Usage:
HTTPClient_Services('GetResponseStatusPhrase')

Comments:
Calls the indicated HTTP web service routine.

Returns:
The HTTP response body from the server. 

SetResponseBody

Usage:
HTTPClient_Services('SetResponseBody', Body)

Comments:
Calls the indicated HTTP web service routine.

Returns:
The HTTP response body from the server. 

GetResponseBody

Usage:
HTTPClient_Services('GetResponseBody')

Comments:
Calls the indicated HTTP web service routine.

Returns:
The HTTP response body from the server.

SetTimeoutDuration

Usage:
HTTPClient_Services('SetTimeoutDuration', TimeoutDuration)

Comments:
Calls the indicated HTTP web service routine.

Returns:
The HTTP response body from the server. 

GetTimeoutDuration

Usage:
HTTPClient_Services('GetTimeoutDuration')

Comments:
Calls the indicated HTTP web service routine.

Returns:
The HTTP response body from the server.

ClearResponseSettings

Usage:
HTTPClient_Services('ClearResponseSettings')

Comments:
Calls the indicated HTTP web service routine.

Returns:
The HTTP response body from the server.

ClearRequestSettings

Usage:
HTTPClient_Services('ClearRequestSettings')

Comments:
Calls the indicated HTTP web service routine.

Returns:
The HTTP response body from the server.

Param1 - Param10

The proper use of the generic arguments are defined in the definition of each service above.

  • No labels