REST Class

Properties   Methods   Events   Configuration Settings   Errors  

The REST Class can be used to retrieve XML documents from the World Wide Web.

Syntax

class ipworks.REST

Remarks

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

The REST Class implements a standard REST client with the added option of SSL security.

The class contains a number of properties that map directly to HTTP request headers. All XML data received is parsed by the component and provided to the user through properties such as x_path, x_element, x_text, etc. which allow traversal of the document structure. The on_header event will provide the HTTP headers as returned by the server.

To receive a document, call the get method with the URL to retrieve specified in the URL parameter. The class will automatically parse the XML data, depending on the content type that is returned. Call the delete method to delete a resource specified by the URL parameter.

The post and put methods are used to create and update resources. post is commonly used to both create and update resources, however each service may have its own requirements. To send data to the server set post_data and call the post or put method.

To add authorization credentials to an outgoing request, you should specify the user and password properties. The REST Class supports Basic, Digest, and NTLM authentication through the auth_scheme property.