Implementation Considerations
Review the following topics to make sure you understand how the API manages data and communication before building your client applications.
XML Compliance
The API is based on XML, which requires all documents to be well-formed. Part of that requirement is that certain Unicode characters are not allowed, even in an escaped form, and that others must be encoded according to the API location. Normally, this is handled by any standard SOAP or XML client. Clients must be able to parse any normal XML escape sequence and must not pass up invalid XML characters. Some characters, as mentioned, are illegal even if they are escaped. The illegal characters include the Unicode surrogate blocks and a few other Unicode characters. All are seldom-used control characters that are usually not important in any data and tend to cause problems with many programs. Although they are not allowed in XML documents, illegal characters are allowed in HTML documents and may be present in TIBCO Reward data.
The illegal characters will be stripped from any API response. The following characters are illegal:
Content Type Requirement
In the API, all requests must contain a correct content type HTTP header, for example: Content-Type:text/xml;. Earlier versions of the API do not enforce this requirement.
HTML Persistent Connections
Most clients achieve better performance if they use HTTP 1.1 persistent connection to reuse the socket connection for multiple requests. Persistent connections are normally handled by your SOAP/WSDL client automatically. For more details, see the HTTP 1.1 specification at: http://www.w3.org/Protocols/rfc2616/rfc2616-sec8.html#sec8.1.