Junction Networks

Junction Networks Web Services API

Context Element

The Context element is a child of the Response element and contains
  • Action element - containing information about the action taken
  • Request element - containing information about the request made
  • Session element - containing information about the authenticated session

Action Element

If the requested action completed successfully, the IsCompleted element will be true and the Response element will contain a Result element.

Otherwise, the IsCompleted element will be false, the Response element will not contain a Result element, and the Action element may contain an Errors element detailing the reason for the failure.

For example,

<Action>
  <IsCompleted>true</IsCompleted>
</Action>
          
A RELAX NG schema module for the Action element is located here: Action.rng

Request Element

If the parameters associated with the requested action validated, the IsValid element will be true.

Otherwise, the IsValid element will be false and the Request element may contain an Errors element detailing reasons one or more parameters failed to validate. A request which fails to validate will never be completed.

For example,

<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>
          
A RELAX NG schema module for the Request element is located here: Request.rng

Session Element

If an authenticated session is established, the IsEstablished element will be true and the Session element will contain a SessionId element containing the session token.

Otherwise, the IsValid element will be false.

For example,

<Session>
  <IsEstablished>false</IsEstablished>
</Session>
          
A RELAX NG schema module for the Session element is located here: Session.rng