Information API

The information API can be used to get a list of schedules or forms in your account and their internal IDs. It also provides an endpoint to list the available services in a Service type schedule, and to list the resources in a Resource type schedule.

Authentication

The API calls in this section require that you pass in the account name and password, either as URL parameters or as Basic Authentication parameters in the header of the request. For security reasons it is important to send requests over an SSL (“https”) connection, and using Basic Authentication is preferable to sending the password as a query parameter.

List Schedules or Forms in an account

You can retrieve a list of schedules or forms from an account through the API by using /api/schedules or /api/super_forms respectively. These require that the account name and password are passed URL parameters or as Basic Auth.

Example

https://www.supersaas.com/api/schedules.json?account=&password=password
https://www.supersaas.com/api/super_forms.json?account=&password=password

The API will return an array of tuples containing the schedule IDs and schedule names.

List Resources or Service in a schedule

Send an HTTP GET request to www.supersaas.com/api/resources and include the following parameters:

FieldComment
schedule_idThe ID of the schedule for which to list the Resources or Services

Example

Try it out
https://www.supersaas.com/api/resources.json?schedule_id=999999&account=&password=password

The API will return an array of tuples, containing the IDs and names of the resources or services. It is not possible to use this API on a Capacity schedule. You can select whether this call should return a result as JSON or XML by adding .xml or .json at the end of the URL.

List available fields on the Schedule or User object

Send an HTTP GET request to www.supersaas.com/api/field_list and include the following parameters:

FieldComment
schedule_id
(optional)
The ID of the schedule, omit this parameters to list the fields for the User object

Example

Try it out
https://www.supersaas.com/api/field_list.json?schedule_id=999999&account=&password=password

The API will return a JSON encoded field list.

This tutorial can display code snippets relevant to your account if you log in.