iTP Active Transaction Pages (iTP ATP) Programmer's Guide

ATP Objects, Properties, and Methods
iTP Active Transaction Pages (iTP ATP) Programmer’s Guide—522292-002
4-2
HTTP Object
HTTP Object
The HTTP client interface provides client-side HTTP protocol support for
communication with HTTP servers. The current version supports only HTTP 1.0
protocol. This API is part of the ATP core package.
Refer to Sample Application
on page 4-13 for a sample application demonstrating use of
the HTTP object.
Table 4-1
summarizes the properties of the HTTP object.
Table 4-2
summarizes the methods of the HTTP object.
Table 4-1. Properties of the HTTP Object
Properties Description
host Contains the server host name.
path Contains the Path value from the URL.
port Specifies the TCP port number to be used for the OPEN method.
queryString Contains the QueryString value from the URL.
statusText Contains the HTTP reason phrase of the reply message from the
GET or POST method.
status Contains the HTTP status code of the reply message from the GET
or POST method.
timeout Contains the timeout value for TCP socket operations. The default
value is 100 (1 second).
url Contains the URL value for the HTTP request.
responseHeaderNames Contains an array of header names returned by the server after the
GET and POST methods.
responseText Represents the response entity body as a UTF-8 string.
responseBinary Represents the response entity body as a UTF-16 string.
responseXML Represents the response entity body as parsed by the XML parser.
This property is available only upon XML for ATP add-on package
installation.
Table 4-2. Methods of the HTTP Object (page 1 of 2)
Method Description
open Opens a HTTP connection to the server.
close Closes the socket connection and destroys the response header
fields and entity body, if they exist.
GET HTTP GET request.
POST HTTP POST request. The post data will be converted UTF-8
format.