Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

ServiceDescription
SendHTTPRequest

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

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:

  • 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 Sets the indicated HTTP web service routineRequest 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:
The HTTP response body from the server.N/A

SetRequestHeaderField

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

Comments:
Calls Sets the indicated Request Header Field with the indicated HTTP web service routinevalue.

Returns:
The HTTP response body from the server.N/A

GetRequestHeaderFields

Usage:
HTTPClient_Services('GetRequestHeaderFields')

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

Returns:
The HTTP response body from the serverAn @FM/@VM list of request header names and values.

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.

...