SOAP Class

Properties   Methods   Events   Config Settings   Errors  

The SOAP Class is a generic SOAP client supporting SOAP 1.1 that is used to communicate with SOAP servers.

Syntax

ipworks.soap()

Remarks

The SOAP Class supports both plaintext and SSL/TLS connections. When connecting over SSL/TLS the SSLServerAuthentication event allows you to check the server identity and other security attributes. The SSLStatus event provides information about the SSL handshake. Additional SSL related settings are also supported via the Config method.

The SOAP Class implements a standard SOAP client as specified in the SOAP 1.1 specification.

The class uses HTTP to communicate with SOAP servers, and an internal XML parser to process the results. The SOAP requests are specified by first setting the SOAP Method and MethodURI, as well as optional parameters in the Params properties. Then set the target URL and call the SendRequest method.

The results will be provided through the ReturnValue property and the Params properties (for output parameters). Additionally, properties such as XPath, XElement, XText, etc. allow for more granular traversal of the SOAP response.

If the server returns an error, the FaultCode, FaultString, and FaultActor properties will provide information about the error condition.

The class may also be used in offline mode. This is supported by methods such as BuildPacket and EvalPacket. The corresponding SOAP packet will be stored in the SOAPPacket property. Offline mode is important in cases where the underlying SOAP transport is not HTTP, but another mechanism (e.g. SMTP and POP for email).

By providing direct access to the SOAP packet in offline mode, the class allows for possible extension and full control over the SOAPPacket. The SendPacket method may then be used to send the custom-created SOAPPacket to the destination URL.

Property List

The following is the full list of the properties of the class with short descriptions. Click on the links for further details.

Method List

The following is the full list of the methods of the class with short descriptions. Click on the links for further details.

Event List

The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.

Config Settings

The following is a list of config settings for the class with short descriptions. Click on the links for further details.

SOAP.Accept Property

This property includes a list of acceptable MIME types for the request.

Syntax

getAccept(): string;
setAccept(accept: string): void;

Default Value

""

Remarks

If this property contains a nonempty string, an HTTP Accept header is added to the request.

The Accept header is used for content negotiation. It provides the server with a comma-separated list of MIME types that are acceptable for its response.

SOAP.ActionURI Property

The value of the SOAP-Action header.

Syntax

getActionURI(): string;
setActionURI(actionURI: string): void;

Default Value

""

Remarks

When the MethodURI or Method properties are set, the ActionURI property is automatically updated to MethodURI#Method.

SOAP.Authorization Property

This property includes the Authorization string to be sent to the server.

Syntax

getAuthorization(): string;
setAuthorization(authorization: string): void;

Default Value

""

Remarks

If the Authorization property contains a nonempty string, an Authorization HTTP request header is added to the request. This header conveys Authorization information to the server.

A common use for this property is to specify OAuth authorization string.

This property is provided so that the HTTP class can be extended with other security schemes in addition to the authorization schemes already implemented by the class.

The AuthScheme property defines the authentication scheme used. In the case of HTTP Basic Authentication (default), every time User and Password are set, they are Base64 encoded, and the result is put in the Authorization property in the form "Basic [encoded-user-password]".

SOAP.AuthScheme Property

The authentication scheme to use when server authentication is required.

Syntax

getAuthScheme(): SoapAuthSchemes;
setAuthScheme(authScheme: SoapAuthSchemes): void;

enum SoapAuthSchemes {
  authBasic,
  authDigest,
  authProprietary,
  authNone,
  authNtlm,
  authNegotiate,
  authOAuth
}

Default Value

0

Remarks

This property will tell the class which type of authorization to perform when the User and Password properties are set.

This property should be set to authNone (3) when no authentication is to be performed.

By default, this property is authBasic (0), and if the User and Password properties are set, the class will attempt HTTP Basic Authentication. If AuthScheme is set to authDigest (1), authNtlm (4), or authNegotiate (5), then Digest, NTLM, or Windows Negotiate (Kerberos) authentication will be attempted instead.

If AuthScheme is set to authProprietary (2), then the authorization token must be supplied through the Authorization property.

If AuthScheme is set to authOAuth (6), then the authorization string must be supplied through the Authorization property.

Note: If you set the Authorization property and AuthScheme is not authProprietary or authOAuth, then the AuthScheme will be set automatically to authProprietary (2) by the class.

For security, changing the value of this property will cause the class to clear the values of User, Password, and Authorization.

SOAP.Connected Property

This shows whether the class is connected.

Syntax

isConnected(): boolean;

Default Value

FALSE

Remarks

This property is used to determine whether or not the class is connected to the remote host.

Note: It is recommended to use the Connect or Disconnect method instead of setting this property.

This property is not available at design time.

SOAP.ContentType Property

Content type for SOAP request data.

Syntax

getContentType(): string;
setContentType(contentType: string): void;

Default Value

"text/xml"

Remarks

The default value for ContentType is "text/xml".

This property is not available at design time.

SOAP.Cookies Property

This property includes a collection of cookies.

Syntax

getCookies(): HTTPCookieList;
setCookies(cookies: HTTPCookieList): void;

Default Value

Remarks

This property contains a collection of cookies. To add cookies to outgoing HTTP requests, add cookies (of type HTTPCookie) to this collection.

To see cookies that are set by the server, use the SetCookie event, which displays the cookies and their properties as set by the server. Those cookies also are added to Cookies.

MaxHTTPCookies can be used to control the maximum number of cookies saved.

This property is not available at design time.

SOAP.FaultActor Property

Actor of any faults returned by the SOAP server.

Syntax

getFaultActor(): string;

Default Value

""

Remarks

FaultCode and FaultString provide the corresponding fault code and description.

This property is read-only.

SOAP.FaultCode Property

Code of any faults returned by the SOAP server.

Syntax

getFaultCode(): string;

Default Value

""

Remarks

FaultString and FaultActor provide the corresponding fault description and actor.

This property is read-only.

SOAP.FaultString Property

Textual description of any faults returned by the SOAP server.

Syntax

getFaultString(): string;

Default Value

""

Remarks

FaultCode and FaultActor provide the corresponding fault code and actor.

This property is read-only.

SOAP.Firewall Property

A set of properties related to firewall access.

Syntax

getFirewall(): Firewall;
setFirewall(firewall: Firewall): void;

Default Value

Remarks

This is a Firewall-type property, which contains fields describing the firewall through which the class will attempt to connect.

SOAP.FollowRedirects Property

This property determines what happens when the server issues a redirect.

Syntax

getFollowRedirects(): SoapFollowRedirects;
setFollowRedirects(followRedirects: SoapFollowRedirects): void;

enum SoapFollowRedirects {
  frNever,
  frAlways,
  frSameScheme
}

Default Value

0

Remarks

This property determines what happens when the server issues a redirect. Normally, the class returns an error if the server responds with an "Object Moved" message. If this property is set to frAlways (1), the new URL for the object is retrieved automatically every time.

If this property is set to frSameScheme (2), the new URL is retrieved automatically only if the URLScheme is the same; otherwise, the class .

Note: Following the HTTP specification, unless this property is set to frAlways (1), automatic redirects will be performed only for GET or HEAD requests. Other methods potentially could change the conditions of the initial request and create security vulnerabilities.

Furthermore, if either the new URL server or port are different from the existing one, User and Password are also reset to empty. If, however, this property is set to frAlways (1), the same credentials are used to connect to the new server.

A Redirect event is fired for every URL the product is redirected to. In the case of automatic redirections, the Redirect event is a good place to set properties related to the new connection (e.g., new authentication parameters).

The default value is frNever (0). In this case, redirects are never followed, and the class instead.

SOAP.Idle Property

The current status of the class.

Syntax

isIdle(): boolean;

Default Value

TRUE

Remarks

Idle will be False if the component is currently busy (communicating and/or waiting for an answer), and True at all other times.

This property is read-only.

SOAP.IfModifiedSince Property

This property includes a date determining the maximum age of the desired document.

Syntax

getIfModifiedSince(): string;
setIfModifiedSince(ifModifiedSince: string): void;

Default Value

""

Remarks

If this property contains a nonempty string, an If-Modified-Since HTTP header is added to the request. The value of this header is used to make the HTTP request conditional: If the requested documented has not been modified since the time specified in the field, a copy of the document will not be returned from the server; instead, a 304 (not modified) response will be returned by the server and the class

The format of the date value for IfModifiedSince is detailed in the HTTP specs. An example is Sat, 29 Oct 1994 19:43:31 GMT.

This property is not available at design time.

SOAP.LocalFile Property

This property includes the path to a local file for downloading. If the file exists, it is overwritten.

Syntax

getLocalFile(): string;
setLocalFile(localFile: string): void;

Default Value

""

Remarks

This property is used when getting a document.

If this property is empty, then the received data are provided through TransferredData and the Transfer event.

SOAP.LocalHost Property

The name of the local host or user-assigned IP interface through which connections are initiated or accepted.

Syntax

getLocalHost(): string;
setLocalHost(localHost: string): void;

Default Value

""

Remarks

The LocalHost property contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.

In multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface.

If the class is connected, the LocalHost property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multi-homed hosts (machines with more than one IP interface).

NOTE: LocalHost is not persistent. You must always set it in code, and never in the property window.

SOAP.Method Property

The remote Method .

Syntax

getMethod(): string;
setMethod(method: string): void;

Default Value

""

Remarks

When the MethodURI or Method properties are set, the ActionURI property is automatically updated to MethodURI#Method.

SOAP.MethodURI Property

The URI corresponding to the SOAP Method .

Syntax

getMethodURI(): string;
setMethodURI(methodURI: string): void;

Default Value

""

Remarks

When the MethodURI or Method properties are set, the ActionURI property is automatically updated to MethodURI#Method.

SOAP.Namespaces Property

A collection of namespaces in the current stack.

Syntax

getNamespaces(): XMLNamespaceList;
setNamespaces(namespaces: XMLNamespaceList): void;

Default Value

Remarks

This property contains a collection of XML namespaces, which are standards for providing uniquely named elements and attributes in an XML instance.

If the SOAP Envelope URI is not found in the namespaces collection, it will be added with the prefix 'SOAP-ENV' when generating a SOAP request. The SOAP Envelope URI is 'http://schemas.xmlsoap.org/soap/envelope/'.

This property is not available at design time.

SOAP.OtherHeaders Property

This property includes other headers as determined by the user (optional).

Syntax

getOtherHeaders(): string;
setOtherHeaders(otherHeaders: string): void;

Default Value

""

Remarks

This property can be set to a string of headers to be appended to the HTTP request headers created from other properties like ContentType and From.

The headers must follow the format Header: Value as described in the HTTP specifications. Header lines should be separated by .

Use this property with caution. If this property contains invalid headers, HTTP requests may fail.

This property is useful for extending the functionality of the class beyond what is provided.

This property is not available at design time.

SOAP.Params Property

A collection of parameters for the SOAP Method .

Syntax

getParams(): SOAPParamList;
setParams(params: SOAPParamList): void;

Default Value

0

Remarks

When using SendRequest, this property can be populated with the parameters to include in the request to the SOAP Method.

When receiving SOAP responses from the server, the component parses the response envelope parameters into the collection.

This property is not available at design time.

SOAP.ParsedHeaders Property

This property includes a collection of headers returned from the last request.

Syntax

getParsedHeaders(): HeaderList;

Default Value

Remarks

This property contains a collection of headers returned from the last request. Whenever headers are returned from the server, the headers are parsed into a collection of headers. Each Header in this collection contains information describing that header.

MaxHeaders can be used to control the maximum number of headers saved.

This property is read-only and not available at design time.

SOAP.Password Property

This property includes a password if authentication is to be used.

Syntax

getPassword(): string;
setPassword(password: string): void;

Default Value

""

Remarks

This property contains a password if authentication is to be used. If AuthScheme is set to HTTP Basic Authentication, the User and Password are Base64 encoded and the result is put in the Authorization configuration setting in the form "Basic [encoded-user-password]".

If AuthScheme is set to HTTP Digest Authentication, the User and Password properties are used to respond to the HTTP Digest Authentication challenge from the server.

If AuthScheme is set to NTLM, NTLM authentication will be attempted. If AuthScheme is set to NTLM and User and Password are empty, the class will attempt to authenticate using the current user's credentials.

SOAP.Pragma Property

This property includes a browser- or server-specific header line (optional).

Syntax

getPragma(): string;
setPragma(pragma: string): void;

Default Value

""

Remarks

If this property contains a nonempty string, a Pragma HTTP request header is added to the request. The meaning of the header depends on the implementation. It can be used to send or receive proprietary information to or from the server.

This property is not available at design time.

SOAP.Proxy Property

A set of properties related to proxy access.

Syntax

getProxy(): Proxy;
setProxy(proxy: Proxy): void;

Default Value

Remarks

This property contains fields describing the proxy through which the class will attempt to connect.

SOAP.Referer Property

This property includes the referer URL/document (optional).

Syntax

getReferer(): string;
setReferer(referer: string): void;

Default Value

""

Remarks

If this property contains a nonempty string, a Referer HTTP request header is added to the request. The purpose of the header is to show the document referring the requested URL.

This property is not available at design time.

SOAP.ReturnValue Property

Value returned by the SOAP Method .

Syntax

getReturnValue(): string;

Default Value

""

Remarks

ReturnValue corresponds to the first item in the Params properties.

This property is read-only.

SOAP.SOAPEncoding Property

The type of SOAP Encoding used for SOAP requests.

Syntax

getSOAPEncoding(): string;
setSOAPEncoding(SOAPEncoding: string): void;

Default Value

"http://schemas.xmlsoap.org/soap/encoding/"

Remarks

This is the value of the 'encodingStyle' attribute of the SOAP envelope.

SOAP.SOAPHeader Property

Contents of the optional SOAP header sent to the server.

Syntax

getSOAPHeader(): string;
setSOAPHeader(SOAPHeader: string): void;

Default Value

""

Remarks

This property is used only while building SOAP requests.

This property is not available at design time.

SOAP.SOAPPacket Property

Full contents of the SOAP packet.

Syntax

getSOAPPacket(): string;
setSOAPPacket(SOAPPacket: string): void;

Default Value

""

Remarks

The SOAPPacket property contains the contents of the SOAP packet created by the component before submitting a request, and the full, unmodified contents of the SOAP response as received from the server after the request.

This property is not available at design time.

SOAP.SSLAcceptServerCert Property

Instructs the class to unconditionally accept the server certificate that matches the supplied certificate.

Syntax

getSSLAcceptServerCert(): Certificate;
setSSLAcceptServerCert(SSLAcceptServerCert: Certificate): void;

Default Value

Remarks

If it finds any issues with the certificate presented by the server, the class will normally terminate the connection with an error.

You may override this behavior by supplying a value for SSLAcceptServerCert. If the certificate supplied in SSLAcceptServerCert is the same as the certificate presented by the server, then the server certificate is accepted unconditionally, and the connection will continue normally.

Please note that this functionality is provided only for cases where you otherwise know that you are communicating with the right server. If used improperly, this property may create a security breach. Use it at your own risk.

SOAP.SSLCert Property

The certificate to be used during SSL negotiation.

Syntax

getSSLCert(): Certificate;
setSSLCert(SSLCert: Certificate): void;

Default Value

Remarks

The digital certificate that the class will use during SSL negotiation. Set this property to a valid certificate before starting SSL negotiation. To set a certificate, you may set the field to the encoded certificate. To select a certificate, use the store and subject fields.

SOAP.SSLProvider Property

This specifies the SSL/TLS implementation to use.

Syntax

getSSLProvider(): SoapSSLProviders;
setSSLProvider(SSLProvider: SoapSSLProviders): void;

enum SoapSSLProviders {
  sslpAutomatic,
  sslpPlatform,
  sslpInternal
}

Default Value

0

Remarks

This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic) the class will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.

Possible values are:

In most cases using the default value (Automatic) is recommended. The class will select a provider depending on the current platform.

When Automatic is selected the platform implementation will be used by default in all cases in the JavaScript edition.

Note: The Internal provider is not support at this time.

SOAP.SSLServerCert Property

The server certificate for the last established connection.

Syntax

getSSLServerCert(): Certificate;

Default Value

Remarks

SSLServerCert contains the server certificate for the last established connection.

SSLServerCert is reset every time a new connection is attempted.

This property is read-only.

SOAP.StatusLine Property

This property is the first line of the last server response.

Syntax

getStatusLine(): string;

Default Value

""

Remarks

This property contains the first line of the last server response. This value can be used for diagnostic purposes. If an HTTP error is returned when calling a method of the class, the error string is the same as the StatusLine property.

The HTTP protocol specifies the structure of the StatusLine as follows: [HTTP version] [Result Code] [Description].

This property is read-only and not available at design time.

SOAP.Timeout Property

A timeout for the class.

Syntax

getTimeout(): number;
setTimeout(timeout: number): void;

Default Value

60

Remarks

If the Timeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.

If Timeout is set to a positive value, the class will wait for the operation to complete before returning control.

The class will use DoEvents to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not "freeze" and remains responsive.

If Timeout expires, and the operation is not yet complete, the class .

Please note that by default, all timeouts are inactivity timeouts, i.e. the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.

The default value for the Timeout property is 60 seconds.

SOAP.TransferredData Property

This property includes the contents of the last response from the server.

Syntax

getTransferredData(): Uint8Array;

Default Value

""

Remarks

This property contains the contents of the last response from the server. If the LocalFile is empty, the data are accumulated in TransferredData and also can be received in the Transfer event. Otherwise, this property returns an empty string.

TransferredDataLimit controls the maximum amount of data accumulated in TransferredData (by default there is no limit).

This property is read-only and not available at design time.

SOAP.TransferredDataLimit Property

This property specifies the the maximum amount of data to be transferred.

Syntax

getTransferredDataLimit(): number;
setTransferredDataLimit(transferredDataLimit: number): void;

Default Value

0

Remarks

This property contains the maximum amount of data to be transferred. The default value is 0, which will not impose any limits on the amount of data accumulated in the TransferredData property.

SOAP.TransferredHeaders Property

This property includes the full set of headers as received from the server.

Syntax

getTransferredHeaders(): string;

Default Value

""

Remarks

This property returns the complete set of raw headers as received from the server.

The Header event shows the individual headers as parsed by the class.

This property is read-only and not available at design time.

SOAP.URL Property

This property specifies the URL to fetch.

Syntax

getURL(): string;
setURL(URL: string): void;

Default Value

""

Remarks

This property contains the URL of the document. This value is parsed, and the results are put in the URLScheme, URLServer, URLPort, and URLPath properties.

SOAP.User Property

This property includes a user name if authentication is to be used.

Syntax

getUser(): string;
setUser(user: string): void;

Default Value

""

Remarks

This property contains a user name if authentication is to be used. If AuthScheme is set to HTTP Basic Authentication, The User and Password are Base64 encoded, and the result is put in the Authorization property in the form "Basic [encoded-user-password]".

If AuthScheme is set to HTTP Digest Authentication, the User and Password properties are used to respond to the HTTP Digest Authentication challenge from the server.

If AuthScheme is set to NTLM, NTLM authentication will be attempted. If AuthScheme is set to NTLM, and User and Password are empty, the class will attempt to authenticate using the current user's credentials.

SOAP.ValueFormat Property

Format of data returned or set.

Syntax

getValueFormat(): SoapValueFormats;
setValueFormat(valueFormat: SoapValueFormats): void;

enum SoapValueFormats {
  vfText,
  vfXML,
  vfFullXML
}

Default Value

1

Remarks

The ValueFormat property specifies the format of the data set or received into/from value properties such as XText, ReturnValue, and the Params properties.

The following are the possible values:

SOAP.XAttributes Property

A collection of attributes of the current element.

Syntax

getXAttributes(): XMLAttributeList;

Default Value

Remarks

This collection consists of all attributes of the current XML element. The component parses each attribute into a collection of XMLAttribute types.

This property is read-only and not available at design time.

SOAP.XChildren Property

Collection of child elements of the current element.

Syntax

getXChildren(): XMLElementList;

Default Value

Remarks

The elements are provided in the collection in the same order they are found in the document.

This property is read-only and not available at design time.

SOAP.XElement Property

The name of the element pointed to by XPath .

Syntax

getXElement(): string;

Default Value

""

Remarks

The corresponding prefix is provided by XPrefix.

This property is read-only.

SOAP.XNamespace Property

The namespace of the element pointed to by XPath .

Syntax

getXNamespace(): string;

Default Value

""

Remarks

The corresponding namespace prefix is provided by XPrefix.

This property is read-only.

SOAP.XParent Property

The parent of the element pointed to by XPath .

Syntax

getXParent(): string;

Default Value

""

Remarks

If XPath points to the top element, XParent is an empty string.

This property is read-only.

SOAP.XPath Property

A path into the SOAPPacket received by the server.

Syntax

getXPath(): string;
setXPath(XPath: string): void;

Default Value

""

Remarks

The syntax is a subset of the XPath language.

Use this property to look at details of the SOAPPacket received by the server.

SOAP.XPrefix Property

The prefix of the element pointed to by XPath .

Syntax

getXPrefix(): string;

Default Value

""

Remarks

The corresponding element name is provided by XElement.

This property is read-only.

SOAP.XText Property

The text of the element pointed to by XPath .

Syntax

getXText(): string;

Default Value

""

Remarks

The ValueFormat property controls the format in which the value is returned.

This property is read-only.

SOAP.addCookie Method

This method adds a cookie and the corresponding value to the outgoing request headers.

Syntax

async soap.addCookie(cookieName : string, cookieValue : string): Promise<void>

Remarks

This property adds a cookie and the corresponding value to the outgoing request headers. Please refer to the Cookies property for more information on cookies and how they are managed.

SOAP.addNamespace Method

Adds a namespace to the Namespaces properties.

Syntax

async soap.addNamespace(prefix : string, namespaceURI : string): Promise<void>

Remarks

Prefix specifies the namespace prefix, and NamespaceURI specifies the namespace.

SOAP.addParam Method

Adds a parameter-value pair.

Syntax

async soap.addParam(paramName : string, paramValue : string): Promise<void>

Remarks

Please refer to the parameter name and value provided in the Params properties for more information on SOAP parameters and how they are managed.

Example (Send SOAP Request)

SOAPControl.Reset() SOAPControl.AddParam("paramname", "paramvalue") SOAPControl.AddParam("paramname", "paramvalue") SOAPControl.MethodURI = "methoduri" SOAPControl.Method = "methodname" SOAPControl.URL = "endpointURL" SOAPControl.SendRequest() Example (Send SOAP Request using Param Arrays) SOAPControl.Reset() SOAPControl.ParamCount = 2 SOAPControl.ParamName(0) = "paramname" SOAPControl.ParamValue(0) = "paramvalue" SOAPControl.ParamName(1) = "paramname2" SOAPControl.ParamValue(1) = "paramvalue2" SOAPControl.ParamAttrs(1) = "customattr=value" SOAPControl.MethodURI = "methoduri" SOAPControl.Method = "methodname" SOAPControl.URL = "endpointURL" SOAPControl.SendRequest()

SOAP.attr Method

This method returns the value of the specified attribute.

Syntax

async soap.attr(attrName : string): Promise<string>

Remarks

If the attribute does not exist, an empty string is returned if ErrorOnEmptyAttr is set to False; otherwise, an exception is thrown.

Please refer to the XAttributes properties for more information.

SOAP.buildPacket Method

Build the request packet.

Syntax

async soap.buildPacket(): Promise<void>

Remarks

The resulting packet is placed in SOAPPacket.

SOAP.config Method

Sets or retrieves a configuration setting.

Syntax

async soap.config(configurationString : string): Promise<string>

Remarks

Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

SOAP.doEvents Method

Processes events from the internal message queue.

Syntax

async soap.doEvents(): Promise<void>

Remarks

When DoEvents is called, the class processes any available events. If no events are available, it waits for a preset period of time, and then returns.

SOAP.evalPacket Method

Evaluate the packet in SOAPPacket .

Syntax

async soap.evalPacket(): Promise<void>

Remarks

Use this method to evaluate SOAP packets received through other means (i.e. not directly through the class).

SOAP.hasXPath Method

Determines whether a specific element exists in the document.

Syntax

async soap.hasXPath(XPath : string): Promise<boolean>

Remarks

This method determines whether a particular XPath exists within the document. This may be used to check if a path exists before setting it via XPath.

This method returns True if the xpath exists, False if not.

See XPath for details on the XPath syntax.

SOAP.interrupt Method

Interrupt the current method.

Syntax

async soap.interrupt(): Promise<void>

Remarks

If there is no method in progress, Interrupt simply returns, doing nothing.

SOAP.reset Method

Reset the class.

Syntax

async soap.reset(): Promise<void>

Remarks

Calling this method also resets all HTTP headers to their default values.

SOAP.sendPacket Method

Send the packet.

Syntax

async soap.sendPacket(): Promise<void>

Remarks

This method may also be used to send a packet placed in SOAPPacket.

Example (Send SOAP Request)

SOAPControl.Reset() SOAPControl.AddParam("paramname", "paramvalue") SOAPControl.AddParam("paramname", "paramvalue") SOAPControl.MethodURI = "methoduri" SOAPControl.Method = "methodname" SOAPControl.URL = "endpointURL" SOAPControl.BuildPacket() SOAPControl.SendPacket() SOAPControl.EvalPacket()

SOAP.sendRequest Method

Send the request.

Syntax

async soap.sendRequest(): Promise<void>

Remarks

Calling this method is equivalent to calling BuildPacket, SendPacket, and EvalPacket in succession.

Example (Send SOAP Request)

SOAPControl.Reset() SOAPControl.AddParam("paramname", "paramvalue") SOAPControl.AddParam("paramname", "paramvalue") SOAPControl.MethodURI = "methoduri" SOAPControl.Method = "methodname" SOAPControl.URL = "endpointURL" SOAPControl.SendRequest()

SOAP.tryXPath Method

Navigates to the specified XPath if it exists.

Syntax

async soap.tryXPath(xpath : string): Promise<boolean>

Remarks

This method will attempt to navigate to the specified XPath parameter if it exists within the document.

If the XPath exists the XPath property will be updated and this method returns True.

If the XPath does not exist the XPath property is not updated and this method returns False.

SOAP.value Method

Returns the value of a parameter.

Syntax

async soap.value(paramName : string): Promise<string>

Remarks

The class will search through the Params properties for the parameter identified by ParamName and will return the value associated with it provided in the properties.

SOAP.Connected Event

This event is fired immediately after a connection completes (or fails).

Syntax

soap.on('Connected', listener: (e: {readonly statusCode: number, readonly description: string}) => void )

Remarks

If the connection is made normally, StatusCode is 0 and Description is "OK".

If the connection fails, StatusCode has the error code returned by the Transmission Control Protocol (TCP)/IP stack. Description contains a description of this code. The value of StatusCode is equal to the value of the error.

Please refer to the Error Codes section for more information.

SOAP.ConnectionStatus Event

This event is fired to indicate changes in the connection state.

Syntax

soap.on('ConnectionStatus', listener: (e: {readonly connectionEvent: string, readonly statusCode: number, readonly description: string}) => void )

Remarks

The ConnectionStatus event is fired when the connection state changes: for example, completion of a firewall or proxy connection or completion of a security handshake.

The ConnectionEvent parameter indicates the type of connection event. Values may include the following:

SOAP.Disconnected Event

This event is fired when a connection is closed.

Syntax

soap.on('Disconnected', listener: (e: {readonly statusCode: number, readonly description: string}) => void )

Remarks

If the connection is broken normally, StatusCode is 0 and Description is "OK".

If the connection is broken for any other reason, StatusCode has the error code returned by the Transmission Control Protocol (TCP/IP) subsystem. Description contains a description of this code. The value of StatusCode is equal to the value of the TCP/IP error.

Please refer to the Error Codes section for more information.

SOAP.EndTransfer Event

Fired when a document finishes transferring.

Syntax

soap.on('EndTransfer', listener: (e: {readonly direction: number}) => void )

Remarks

The EndTransfer event is fired when the document text finishes transferring from the server to the local host.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

SOAP.Error Event

Fired when information is available about errors during data delivery.

Syntax

soap.on('Error', listener: (e: {readonly errorCode: number, readonly description: string}) => void )

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the class .

The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

SOAP.Header Event

This event is fired every time a header line comes in.

Syntax

soap.on('Header', listener: (e: {readonly field: string, readonly value: string}) => void )

Remarks

The Field parameter contains the name of the HTTP header (which is the same as it is delivered). The Value parameter contains the header contents.

If the header line being retrieved is a continuation header line, then the Field parameter contains "" (empty string).

SOAP.Log Event

This event fires once for each log message.

Syntax

soap.on('Log', listener: (e: {readonly logLevel: number, readonly message: string, readonly logType: string}) => void )

Remarks

This event fires once for each log message generated by the class. The verbosity is controlled by the LogLevel setting.

LogLevel indicates the level of message. Possible values are as follows:

The value 1 (Info) logs basic information, including the URL, HTTP version, and status details.

The value 2 (Verbose) logs additional information about the request and response.

The value 3 (Debug) logs the headers and body for both the request and response, as well as additional debug information (if any).

Message is the log entry.

LogType identifies the type of log entry. Possible values are as follows:

• "Info"
• "RequestHeaders"
• "ResponseHeaders"
• "RequestBody"
• "ResponseBody"
• "ProxyRequest"
• "ProxyResponse"
• "FirewallRequest"
• "FirewallResponse"

SOAP.Redirect Event

This event is fired when a redirection is received from the server.

Syntax

soap.on('Redirect', listener: (e: {readonly location: string, accept: boolean}) => void )

Remarks

This event is fired in cases in which the client can decide whether or not to continue with the redirection process. The Accept parameter is always True by default, but if you do not want to follow the redirection, Accept may be set to False, in which case the class . Location is the location to which the client is being redirected. Further control over redirection is provided in the FollowRedirects property.

SOAP.SetCookie Event

This event is fired for every cookie set by the server.

Syntax

soap.on('SetCookie', listener: (e: {readonly name: string, readonly value: string, readonly expires: string, readonly domain: string, readonly path: string, readonly secure: boolean}) => void )

Remarks

The SetCookie event is fired for every Set-Cookie: header received from the HTTP server.

The Name parameter contains the name of the cookie, with the corresponding value supplied in the Value parameter.

The Expires parameter contains an expiration time for the cookie (if provided by the server). The time format used is "Weekday, DD-Mon-YY HH:MM:SS GMT". If the server does not provide an expiration time, the Expires parameter will be an empty string. In this case, the convention is to drop the cookie at the end of the session.

The Domain parameter contains a domain name to limit the cookie to (if provided by the server). If the server does not provide a domain name, the Domain parameter will be an empty string. The convention in this case is to use the server specified in the URL (URLServer) as the cookie domain.

The Path parameter contains a path name to limit the cookie to (if provided by the server). If the server does not provide a cookie path, the Path parameter will be an empty string. The convention in this case is to use the path specified in the URL (URLPath) as the cookie path.

The Secure parameter specifies whether the cookie is secure. If the value of this parameter is True, the cookie value must be submitted only through a secure (HTTPS) connection.

SOAP.SSLServerAuthentication Event

Fired after the server presents its certificate to the client.

Syntax

soap.on('SSLServerAuthentication', listener: (e: {readonly certEncoded: string, readonly certEncodedB: Uint8Array, readonly certSubject: string, readonly certIssuer: string, readonly status: string, accept: boolean}) => void )

Remarks

This event fires with information about the server certificate. The Status property shows why verification failed (otherwise, Status contains the string OK). To manually accept an untrusted certificate, the SSLAcceptAnyServerCert setting must be set to True before initiating the connection.

SOAP.SSLStatus Event

Fired when secure connection progress messages are available.

Syntax

soap.on('SSLStatus', listener: (e: {readonly message: string}) => void )

Remarks

The event is fired for informational and logging purposes only. This event tracks the progress of the connection.

SOAP.StartTransfer Event

Fired when a document starts transferring (after the headers).

Syntax

soap.on('StartTransfer', listener: (e: {readonly direction: number}) => void )

Remarks

The StartTransfer event is fired when the document text starts transferring from the server to the local host.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

SOAP.Status Event

This event is fired when the HTTP status line is received from the server.

Syntax

soap.on('Status', listener: (e: {readonly HTTPVersion: string, readonly statusCode: number, readonly description: string}) => void )

Remarks

HTTPVersion is a string containing the HTTP version string as returned from the server (e.g., "1.1").

StatusCode contains the HTTP status code (e.g., 200), and Description the associated message returned by the server (e.g., "OK").

SOAP.Transfer Event

Fired while the response transfers.

Syntax

soap.on('Transfer', listener: (e: {readonly direction: number, readonly bytesTransferred: number, readonly percentDone: number}) => void )

Remarks

The BytesTransferred parameter contains the number of bytes transferred since the beginning of the response (excluding HTTP response headers).

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

The PercentDone parameter shows the progress of the transfer in the corresponding direction. If PercentDone can not be calculated the value will be -1.

Note: Events are not re-entrant. Performing time-consuming operations within this event will prevent it from firing again in a timely manner and may affect overall performance.

Certificate Type

This is the digital certificate being used.

Remarks

This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates.

Fields

Constructors

public Certificate();

Creates a Certificate instance whose properties can be set. This is useful for use with CERTMGR when generating new certificates.

public Certificate(String certificateFile);

Opens CertificateFile and reads out the contents as an X.509 public key.

public Certificate(byte[] certificateData);

Parses CertificateData as an X.509 public key.

public Certificate(int certStoreType, String store, String storePassword, String subject);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN).

public Certificate(int certStoreType, String store, String storePassword, String subject, String configurationString);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. ConfigurationString is a newline separated list of name-value pairs that may be used to modify the default behavior. Possible values include "PersistPFXKey", which shows whether or not the PFX key is persisted after performing operations with the private key. This correlates to the PKCS12_NO_PERSIST_KEY CryptoAPI option. The default value is True (the key is persisted). "Thumbprint" - an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load. When specified, this value is used to select the certificate in the store. This is applicable to cstUser, cstMachine, cstPublicKeyFile, and cstPFXFile store types. "UseInternalSecurityAPI" shows whether the platform (default) or the internal security API is used when performing certificate-related operations. After the store has been successfully opened, the class will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN).

public Certificate(int certStoreType, String store, String storePassword, byte[] encoded);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will load Encoded as an X.509 certificate and search the opened store for a corresponding private key.

public Certificate(int certStoreType, byte[] storeBlob, String storePassword, String subject);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. StoreBlob is a string (binary- or Base64-encoded) containing the certificate data. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN).

public Certificate(int certStoreType, byte[] storeBlob, String storePassword, String subject, String configurationString);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. StoreBlob is a string (binary- or Base64-encoded) containing the certificate data. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN).

public Certificate(int certStoreType, byte[] storeBlob, String storePassword, byte[] encoded);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a string (binary- or Base64-encoded) containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will load Encoded as an X.509 certificate and search the opened store for a corresponding private key.

Firewall Type

The firewall the class will connect through.

Remarks

When connecting through a firewall, this type is used to specify different properties of the firewall, such as the firewall and the .

Fields

Constructors

public Firewall();

Header Type

This is an HTTP header as it is received from the server.

Remarks

When a header is received through a Header event, it is parsed into a Header type. This type contains a , and its corresponding .

Fields

Constructors

public Header();

public Header(String field, String value);

HTTPCookie Type

An HTTP cookie can be either sent to or received from the server.

Remarks

An HTTP cookie can store the cookies that are to be sent to the server. It also may store the cookies sent by the server.

Cookies that are to be sent to the server must have the and fields supplied before submitting the URL. When the SetCookie event is fired, however, all of the fields of an HTTPCookie are filled out accordingly.

Fields

Constructors

public HTTPCookie();

public HTTPCookie(String name, String value);

Proxy Type

The proxy the class will connect to.

Remarks

When connecting through a proxy, this type is used to specify different properties of the proxy, such as the and the .

Fields

Constructors

public Proxy();

public Proxy(String server, int port);

public Proxy(String server, int port, String user, String password);

SOAPParam Type

A parameter for the SOAP Method .

Remarks

This type describes a parameter of the SOAP Method. SOAPParam has fields to describe the name, value, and any attributes of the parameter being described.

Fields

Constructors

public SOAPParam();

public SOAPParam(String name, String value);

XMLAttribute Type

An XML attribute from the current XML element.

Remarks

This type describes an XML attribute from the current element. It includes fields to denote information about the attribute being defined.

Fields

Constructors

public XMLAttribute();

XMLElement Type

An element contained within the XML document.

Remarks

This type describes an XML element. The fields for this type describe the element , , and of the given element.

The elements are inserted into the array in the same order they are found in the document.

Fields

Constructors

public XMLElement();

XMLNamespace Type

An XML namespace from the current namespace stack.

Remarks

This type describes an XML namespace from the current stack. It includes fields to denote the and the of the namespace being defined.

The default namespace exists at index 0. The field at index 0 is "xmlns", and the field contains the default namespace.

Fields

Constructors

public XMLNamespace();

public XMLNamespace(String name, String prefix);

Config Settings (class ipworks.soap)

SOAP Config Settings

HTTP Config Settings

TCPClient Config Settings

SSL Config Settings

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
..
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
..
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

Socket Config Settings

XML Config Settings

<?xml version="1.0" encoding="utf-8" standalone="yes" ?>
...

Base Config Settings

Trappable Errors (class ipworks.soap)

SOAP Errors

HTTP Errors

TCPClient Errors

SSL Errors

TCP/IP Errors

XML Errors