Web Service: Utilities

Modified on 2011/10/11 19:21 by Charles — Categorized as: Web Service

Table of Contents [Hide/Show]

   Utilities for the Jetfire Web Service
      Allowed Subscriptions
      Allowed Web Methods
      ID
      IsFound
      Get Jetfire Configuration
      Is Logged In
      Is Nexus Active
      Ping

Utilities for the Jetfire Web Service¶

(return to Jetfire Web Service)

This section examines utilities used with the Web Service.

AllowedSubscriptions
AllowedWebMethods
GetJetfireConfig
ID
IsFound
IsLoggedIn
IsNexusActive
Ping

Allowed Subscriptions¶

This method is used to identify what subscriptions are accessible through the Web Service.

Prerequisites: None.
Send: no parameters are required.

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <AllowedSubscriptions xmlns="http://Jetfire.ca/WebService" />
  </soap:Body>
</soap:Envelope>

Receive (example when all subscriptions are allowed):

<?xml version='1.0' encoding='utf-8' ?>
<Errors xmlns="http://schemas.Jetfire.ca/Errors">
  <Error Name="Error 1" Value="Access to all subscriptions allowed"/>
</Errors>

Allowed Web Methods¶

This method is used to identify what web methods are accessible through the Web Service.

Prerequisites: Must be logged in.
Send: substitute the Nexus Key received during login.

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <AllowedWebMethods xmlns="http://Jetfire.ca/WebService">
      <nexusKey>string</nexusKey>
    </AllowedWebMethods>
  </soap:Body>
</soap:Envelope>

Receive example: A comma-delimited list of web methods is returned.

<?xml version='1.0' encoding='utf-8' ?>
<Errors xmlns="http://schemas.Jetfire.ca/Errors">
  <Error Name="Error 1" Value="Access to all web methods allowed"/>
</Errors>

ID¶

This method returns the ID of the Web Service.

Prerequisites: None. Send:

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <ID xmlns="http://Jetfire.ca/WebService" />
  </soap:Body>
</soap:Envelope>

Receive: This is NOT an xml string.

Jetfire WebService built by TrackerRealm Corporation

IsFound¶

This method returns the number of workflows found in the database.

Prerequisites: Must be logged in.
Send: Substitute

the Nexus key received during login.

an optional filter for identifying a subset of workflows in the database. The format of the filter is:

ClassName=OawaContact;CurrentState=Active; - this filter looks for workflows of class name = OawaContact and are in the Active Cureent State.


<?xml version="1.0" encoding="utf-8"?>

<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">

<soap:Body>

<IsFound xmlns="http://Jetfire.ca/WebService">

<nexusKey>string</nexusKey>

<filter>string</filter>

</IsFound>

</soap:Body>

</soap:Envelope>

Receive: the message contains the number of workflows found.

<?xml version='1.0' encoding='utf-8' ?>
<Errors xmlns="http://schemas.Jetfire.ca/Errors">
  <Error Name="Error 1" Value="Count found: 281"/>
</Errors>

Get Jetfire Configuration¶

This method retrieves a set of classes that are useful for populating date and time related controls.

Prerequisites: None.
Send:

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetJetfireConfig xmlns="http://Jetfire.ca/WebService" />
  </soap:Body>
</soap:Envelope>

Receive: an xml string that includes Calendar, Duration and DateControl.

<?xml version="1.0" encoding="utf-8"?>
<Jetfire>
	<Calendar>
		<Hours>
			<Hour Name="24" DisplayName=""></Hour>
			<Hour Name="0" DisplayName="00"></Hour>
			<Hour Name="1" DisplayName="01"></Hour>
			<Hour Name="2" DisplayName="02"></Hour>
<-- snip -->
			<Minute Name="58" DisplayName="58"></Minute>
			<Minute Name="59" DisplayName="59"></Minute>
		</Minutes>
	</Calendar>
	<Duration>
		<Days>
			<Day Name="0" DisplayName="0 days"></Day>
			<Day Name="1" DisplayName="1 day"></Day>
			<Day Name="2" DisplayName="2 days"></Day>
<-- snip -->
			<Minute Name="58" DisplayName="58 minutes"></Minute>
			<Minute Name="59" DisplayName="59 minutes"></Minute>
		</Minutes>
	</Duration>
	<DateControl>
		<StartYear Name="0" DisplayName="1950" />
	</DateControl>
</Jetfire>

Is Logged In¶

This method identifies if the user is logged in or not.

Prerequisites: Must be logged in
Send: substitute the Nexus Key received during login.

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <IsLoggedIn xmlns="http://Jetfire.ca/WebService">
      <nexusKey>string</nexusKey>
    </IsLoggedIn>
  </soap:Body>
</soap:Envelope>

Receive: example shows the value returned if the user is logged in.

<boolean>true</boolean>

Is Nexus Active¶

This method identifies if the nexus associated with the user is active.

Prerequisite: Must be logged in
Send: Substitute the Nexus Key received during login.

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <IsNexusActive xmlns="http://Jetfire.ca/WebService">
      <nexusKey>string</nexusKey>
    </IsNexusActive>
  </soap:Body>
</soap:Envelope>

Receive:

<?xml version='1.0' encoding='utf-8' ?>
<Errors xmlns="http://schemas.Jetfire.ca/Errors">
  <Error Name="Error 1" Value="Nexus is Active"/>
</Errors>

Ping¶

This method is used to ping the server.

Prerequisites: Must be logged in
Send: the Nexus Key received during login.

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <IsLoggedIn xmlns="http://Jetfire.ca/WebService">
      <nexusKey>string</nexusKey>
    </IsLoggedIn>
  </soap:Body>
</soap:Envelope>

Receive: example shows the value returned if the user is logged in.

<?xml version='1.0' encoding='utf-8' ?>
<Errors xmlns="http://schemas.Jetfire.ca/Errors">
  <Error Name="Error 1" Value="Connection Active"/>
</Errors>