Web Service: Login Interface

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


Login interface for the Jetfire Web Service

(return to Jetfire Web Service)

The Jetfire Web Service has a Login service included with it. The Client must log in to gain access to data in a Jetfire subscription. Login includes:


Workflow based utilities

This section contains a set of utilities used for workflows.

Login as Guest

The Login as Guest interface sends the following message to the server.

Prerequisites: None
Send: Subscription for the string. 
<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>
    <LoginGuest xmlns="http://Jetfire.ca/WebService">
      <subscription>string</subscription>
    </LoginGuest>
  </soap:Body>
</soap:Envelope>

Receive example: The Nexus Key is returned with the subscription confirmed and a list of Roles that the use has and a message.

Success Response: 
<?xml version='1.0' encoding='utf-8' ?>
<LoginResponse xmlns="http://schemas.Jetfire.ca/LoginResponse">
  <LoginKey NexusKey="49c55cb8-908c-4d2b-ba0b-70cfcbe05f16" Subscription="localhost" Roles="" Message="Successful Login"/>
</LoginResponse>

Failure Response: 
<?xml version='1.0' encoding='utf-8' ?>
<Errors xmlns="http://schemas.Jetfire.ca/Errors">
  <Error Name="Error 1" Value="Guest not allowed to login."/>
</Errors>

Login as Named User

The Login as Named User interface sends the following message to the server.

Prerequisites: None.
Send: The required parameters are: 
<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>
    <Login xmlns="http://Jetfire.ca/WebService">
      <user>string</user>
      <password>string</password>
      <subscription>string</subscription>
    </Login>
  </soap:Body>
</soap:Envelope>

Receive:

Success Response: 
<?xml version='1.0' encoding='utf-8' ?>
<LoginResponse xmlns="http://schemas.Jetfire.ca/LoginResponse">
  <LoginKey NexusKey="49c55cb8-908c-4d2b-ba0b-70cfcbe05f16" Subscription="localhost" Roles="Admin" Message="Successful Login"/>
</LoginResponse>

Failure Response: failures are caused if the user/password/subscription combination is invalid. 
<?xml version='1.0' encoding='utf-8' ?>
<Errors xmlns="http://schemas.Jetfire.ca/Errors">
  <Error Name="Error 1" Value="Cannot login."/>
</Errors>

Login as Guest with Encryption

Encryption may be used with the Web Service interface. Additional parameters are used as part of login to specify the encryption direction and the encryption seed. The Login as Guest interface sends the following message to the server.

Prerequisites: None.
Send: The required parameters are: 
<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>
    <LoginGuestWithEncryption xmlns="http://Jetfire.ca/WebService">
      <subscription>string</subscription>
      <direction>string</direction>
      <encryptionKey>string</encryptionKey>
    </LoginGuestWithEncryption>
  </soap:Body>
</soap:Envelope>

Receive:

Success Response: 
<?xml version='1.0' encoding='utf-8' ?>
<LoginResponse xmlns="http://schemas.Jetfire.ca/LoginResponse">
  <LoginKey NexusKey="49c55cb8-908c-4d2b-ba0b-70cfcbe05f16" Subscription="localhost" Roles="" Message="Successful Login"/>
</LoginResponse>

Failure Response: 
<?xml version='1.0' encoding='utf-8' ?>
<Errors xmlns="http://schemas.Jetfire.ca/Errors">
  <Error Name="Error 1" Value="Guest not allowed to login."/>
</Errors>

Login with Encryption

Encryption may be used with the Web Service interface. Additional parameters are used as part of login to specify the encryption direction and the encryption seed. The Login as Guest interface sends the following message to the server.

Prerequisites: None.
Send: The required parameters are: 
<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>
    <LoginWithEncryption xmlns="http://Jetfire.ca/WebService">
      <user>string</user>
      <password>string</password>
      <subscription>string</subscription>
      <direction>string</direction>
      <encryptionKey>string</encryptionKey>
    </LoginWithEncryption>
  </soap:Body>
</soap:Envelope>

Receive:

Sucessful Response: 
<?xml version='1.0' encoding='utf-8' ?>
<LoginResponse xmlns="http://schemas.Jetfire.ca/LoginResponse">
  <LoginKey NexusKey="49c55cb8-908c-4d2b-ba0b-70cfcbe05f16" Subscription="localhost" Roles="Admin" Message="Successful Login"/>
</LoginResponse>

Failure Response: failures are caused if the user/password/subscription combination is invalid. 
<?xml version='1.0' encoding='utf-8' ?>
<Errors xmlns="http://schemas.Jetfire.ca/Errors">
  <Error Name="Error 1" Value="Cannot login"/>
</Errors>

Logout

The Logout method is used to log out of the Nexus. This should be used when access to the Nexus is complete.

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>
    <Logout xmlns="http://Jetfire.ca/WebService">
      <nexusKey>string</nexusKey>
    </Logout>
  </soap:Body>
</soap:Envelope>

Receive: A logged out response is received. 
<?xml version='1.0' encoding='utf-8' ?>
<Errors xmlns="http://schemas.Jetfire.ca/Errors">
  <Error Name="Error 1" Value="logged out"/>
</Errors>