Junction Networks

Junction Networks Web Services API

REST Response Format

The REST response is a simple format to use - it's a simple XML document.

For example, a call to the Echo action returns this: 

<?xml version="1.0" encoding="UTF-8"?>
<Response xmlns="http://www.jnctn.net/ns/rest/2006-01">
  <Context>
    <Action>
      <IsCompleted>true</IsCompleted>
    </Action>
    <Request>
      <IsValid>true</IsValid>
      <DateTime>2006-12-18T00:36:49-05:00</DateTime>
      <Duration>2</Duration>
      <Parameters>
        <Parameter>
          <Name>Action</Name>
          <Value>Echo</Value>
        </Parameter>
        <Parameter>
          <Name>TestName</Name>
          <Value>TestValue</Value>
        </Parameter>
      </Parameters>
    </Request>
    <Session>
      <IsEstablished>false</IsEstablished>
    </Session>
  </Context>
  <Result>
    <Echo/>
  </Result>
</Response>
You can see an example response here.

The RELAX NG schema for the response XML document is located here: jnctn.rng

Response Element

The Response element contains a Context element and a Result element.

The Context element contains information regarding the action taken, the request processed, and the session.

The Result element contains information specific to the action taken and is only present if the action completed.

Result elements are documented on the action's spec page. Actions are listed on the API index page

A RELAX NG schema module for the Response element is located here: Response.rng

A RELAX NG schema module for the Context element is located here: Context.rng

A RELAX NG schema module for the Result element is located here: Result.rng.

Exception Element

If an exception occurs, a document like the following is returned: 
<?xml version="1.0" encoding="UTF-8"?>
<Exception xmlns="http://www.jnctn.net/ns/rest/2006-01">
<![CDATA[
Textual description of the exception.
]]>
</Exception>

Exceptions should not occur. An Exception indicates an issue with the API.

Please email any Exceptions received to support@junctionnetworks.com.

A RELAX NG schema module for the Exception element is located here: Exception.rng