How To : Accessing a REST Web Service

Page Status: Beta

[edit] Description

This document describes how to access a REST web service using Bungee Builder.

To access a REST web service:

Build your URL: Create a means of entering information so that a URL is created. For example, in the case of Google Maps, the user types the address they want mapped into a text box.
Pass the URL to the Web service: Use the HTTP class to make a Get request (use the returnGet function with two arguments: the first argument is the URL and the second is the response that is returned).
Parse the response: An XML string is returned by returnGet. Use XMLDocObject to parse the string.

XMLDocObject and HTTP are classes that already exist under Runtime (in typelib Utility). Note: There are three additional XML classes available: XMLAttribute , XMLDataObject, and XMLElement).
For parsing the XML string, use the function of XMLDocObject. It creates a DOM tree from the XML string, and produces the root object. From then on, you’re accessing the root (the string is reflected now in an object structure that’s been parsed in by XMLDocObject).
Use the functions on XMLElement to fully traverse the tree. You use getChild or getAttribute to actually get the objects you’re looking for in the call (you could also use getChildByAttrName to get a child that matches both the childName argument and the attrName argument.
The root (from the kml tag in the XML file) has a list of children, and may have attributes (those are the two datasets besides content and name).
In XML you have either children or content, not both. So a child can either have more children or it can have content. As you traverse the tree, you either traverse through a child list or you grab the content.