Each Tempest API account is configured with unique permissions, giving it access to one or more Tempest instances, as well as specific API functions within each instance. The API-Account-Get function can be used to get information about the Tempest instances that your account has access to, and the specific functions that have been granted for each instance.

Here's an example of an API-Account-Get API request.

Here's a sample response.

In this example, the account has access to a single Tempest instance (named "tempest_pro_demo"), and for that instance, the account can send requests that utilize three functions: Tickets-Insert, Tickets-Select, and Units-Select.

Assignees are the users (staff, students, etc) that units can be assigned to. The Assignees-Select function can be used to retrieve one of more assignees, and do so using a variety of filters (last name, first name, and so on).

Here's an example of an Assignees-Select API request.

Here's a sample response.

In this example, the account has access to a single Tempest instance (named "tempest_pro_demo"), and for that instance, the account can send requests that utilize three functions: Tickets-Insert, Tickets-Select, and Units-Select.

Claims are used to receive compensation from manufacturers for repairs that have been made to units. The Claims-Select function can be used to retrieve one of more claims, and do so using filters such as the date that the claim was submitted, payment status, etc.

Here's an example of a Claims-Select API request.

Claim Lineitems are the specific parts or services that were submitted with a claim.

Here's an example of a Claim-Lineitems-Select API request.

The Databases-Select function can be used to retrieve a list of the Tempest database instances that are available.

Here's an example of a Databases-Select API request.

Tempest's Events table is used for logging purposes. Most events are associated with an entity (a table) and an instance of that entity (a record in that table). The Events-Insert function can be used to log an event.

Here's an example of an Events-Insert API request.

Some instances of Tempest support the concept of Funding Sources. The Funding-Sources-Select function can be used to obtain a list of the funding sources that are on file.

Here's an example of a Funding-Sources-Select API request.

Tempest uses a Locations table to keep track of where users and units are located. The Locations-Select function can be used to obtain a list of the locations that are on file.

Here's an example of a Locations-Select API request, which will returns data for all of the locations in the Tempest instance.

In this example, a Locations-Select API request is being sent to get data for a specific location (based on its Location_ID, Tempest's internally assigned, unique identifier for the location).

Tempest uses a Parts table to keep track of the spare parts that are used to repair units. The Parts-Select function can be used to obtain a list of the parts that are on file.

Here's an example of a Parts-Select API request.

Tempest uses a generic Property table to manage detailed settings and configuration for its instances. The Property-Select function can be used to obtain a list of the properties and their values.

Here's an example of a Property-Select API request. In this example, the request is for property values associated with a specific district (indicated by the Table_Name and Table_UID filters) - and specifically the values associated with Tempest's Unit Configuration functions (indicated by the Context filter). Additionally, the request is being made for specific columns (property.Name, property."Values", dbo.property.default_value, dbo.property_value.value), indicated by the Columns parameter.

Tempest stores service requests in a Tickets table, and the Tickets-Select function can be used to obtain detailed information on one or more tickets. You can filter the tickets by status, location, and so on. You can also request a specific ticket based on the Tempest Ticket_ID or by an external ticket number ("Ext_Ticket_Number").

Here's an example of a call to Tickets-Select API function, requesting all open tickets.

To add a new ticket to Tempest, use the Tickets-Insert function. Note that you can specify an alternate ticket ID so that you map tickets generated in an external system with those in Tempest. Do so by specifying an "Ext_Ticket_Number" value.

How you call the Tickets-Insert function will depend on the type of Tempest instance that you are working with. There are currently two Tempest instance types: Pro and Education. The Pro instance type is primarily designed to handle the servicing of devices for commercial clients, while the Education type handles educational clients. The primary difference between the two instance types is that with Education instances, the devices and users assigned to them is usually known ahead of time and is tracked in Tempest. With Pro instances, the devices and users are not always known. As a result, the used to call the Tickets-Insert function can vary significantly.

Here's an example of a Tickets-Insert API request being sent to a Pro instance of Tempest.

Here's an example of a Tickets-Insert API request being sent to an Education instance of Tempest. Note that the API supports an optional "Ext_Ticket_Number_Friendly" parameter for requests made against a Tempest Education instance.

If the call to the Tickets-Insert function is successful, the API will return either a "200 OK" response or a "202 Accepted" response. A "200" response indicates that a ticket has been created. A "202" response indicates that the request has been received and is pending review before being fully processed.

In Tempest, Units are the devices that are to be managed, assigned to users, repaired, and so on. The Units-Select function can be used to obtain detailed information on one or more units. You can filter the units by status, model number, location, and so on. You can also request a specific unit based on the Tempest Unit_ID, by its serial number, asset tag, and so on.

Here's an example of a Units-Select API request.

To add a new unit to Tempest, use the Units-Insert function.

Here's an example of a Units-Insert API request.

If you need technical support for the Tempest API, please contact:

Tim Dietrich
timdietrich@me.com