Page History

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

Comments:
Calls the indicated HTTP web service routine. This is the primary service of this module. All other services either support this SendHTTPRequest or are dependent upon SendHTTPRequest completing a request. The arguments are defined as follows:

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:
Sets the Request Header Fields as indicated by the HeaderList argument. The HeaderList should not be formatted as a list rather than an associated multivalue array. This is easier for the developer to manage in the code that calls this service.

Returns:
N/A

SetRequestHeaderField

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

Comments:
Sets the indicated Request Header Field with the indicated value.

Returns:
N/A

GetRequestHeaderFields

Usage:
HTTPClient_Services('GetRequestHeaderFields')

Comments:
Returns all of the Request Header Field names and values. This returns an @FM/@VM list of names and values. This is called from the SendHTTPRequest service automatically. The developer does not need to use this service.

Returns:
An @FM/@VM list of request header names and values.

GetRequestHeaderField

Usage:
HTTPClient_Services('GetRequestHeaderField', Name)

Comments:
Returns the value previously set for the indicated Request Header Field.

Returns:
The value previously set for the indicated Request Header Field.

SetResponseHeaderField

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

Comments:
Sets the indicated Response Header Field with the indicated value. This is called from the SendHTTPRequest service automatically after retrieving the response headers fields from the server.

Returns:
N/A

Usage:
HTTPClient_Services('GetResponseHeaderFields')

Comments:
Returns all of the Response Header Field names and values. This returns an @FM/@VM list of names and values.

Returns:
An @FM/@VM list of response header names and values.

Usage:
HTTPClient_Services('GetResponseHeaderField', Name)

Comments:
Returns the value previously set for the indicated Response Header Field. The Name argument is case-insensitive but if the indicated Response Header Field has not been set then an error condition will be set.

Returns:
The value previously set for the indicated Response Header Field. 

Usage:
HTTPClient_Services('SetResponseStatusCode', Code)

Comments:
Sets the response status code generated by the most recent HTTP request. This is called from the SendHTTPRequest service automatically after retrieving the response status from the server.

Returns:
N/A

Usage:
HTTPClient_Services('GetResponseStatusCode')

Comments:
Gets the response status code generated by the most recent HTTP request.

Returns:
The response status code generated by the most recent HTTP request.

Usage:
HTTPClient_Services('SetResponseStatusPhrase', Phrase)

Comments:
Sets the response status phrase generated by the most recent HTTP request. This is called from the SendHTTPRequest service automatically after retrieving the response status phrase from the server.

Returns:
N/A

Usage:
HTTPClient_Services('GetResponseStatusPhrase')

Comments:
Gets the response status phrase generated by the most recent HTTP request.

Returns:
The response status phrase generated by the most recent HTTP request.

Usage:
HTTPClient_Services('SetResponseBody', Body)

Comments:
Sets the response body generated by the most recent HTTP request. This is called from the SendHTTPRequest service automatically after retrieving the response body from the server.

Returns:
N/A

Usage:
HTTPClient_Services('GetResponseBody')

Comments:
Gets the response body generated by the most recent HTTP request. This is the same response that the SendHTTPRequest service returns.

Returns:
The response body generated by the most recent HTTP request.

Usage:
HTTPClient_Services('SetTimeoutDuration', TimeoutDuration)

Comments:
Sets the timeout duration that will be used before an HTTP request will abort. This is only applicable if the request is asynchronous. If the timeout duration is empty, a default setting of 30 minutes (1800 seconds) will be set.

Returns:
N/A

Usage:
HTTPClient_Services('GetTimeoutDuration')

Comments:
Returns the timeout duration that will be used before an HTTP request will abort. This is only applicable if the request is asynchronous. If the timeout duration is empty, a default setting of 30 minutes (1800) seconds) will be returned.

Returns:
The timeout duration that will be used before an HTTP request will abort.

Usage:
HTTPClient_Services('ClearResponseSettings')

Comments:
Clears all of the global common variables used for responses. This is called from the SendHTTPRequest service automatically. The developer does not need to use this service.

Returns:
N/A

Usage:
HTTPClient_Services('ClearRequestSettings')

Comments:
Clears all of the global common variables used for requests. This is called from the SendHTTPRequest service automatically. The developer does not need to use this service.

Returns:
N/A