OnSiteForm API

This is a brief explanation of how to use the API..

Authentication

The API uses digest authentication. You will be asked for a username and password before you can retrieve any data
from the system. This is the same username and password you use to log into the OnSiteForm website.
Every request made to the system must be accompanied by a valid username and password.

API

Notes

Where examples specify "?", this implies that a value of your choosing needs to be included without the brackets. For example /site=? means /site=1234.

Where examples specify "("live" / "archived")", this implies that only these values are supported. For example /status=live.

Base URL

The base URL is:

https://api.onsiteform.com/

Get available Sites

You can get a list of available sites for the current user by including the following after the base URL:

getavailablesites

Get available Locations

You can get a list of available location for the current user by including the following after the base URL:

getavailablelocations

Get available Locations By Site Id

You can get a list of available locations at a given site by including the following after the base URL:

getavailablelocationsbysiteid/site=?

Get Latest Asset Certificate

You can get the latest asset certificate for a given asset by including the following after the base URL:

getlatestassetcertificate/assetidno=?

Data returned will be in a JSON format.

Get Summary Report

You can get a Summary Report by including the following after the base URL:

getsummaryreport/site=?/

The current supported search parameters are as follows:

location=?/ condition=?/ customerorderno=?/ status=("live" / "archived" / "live&archived" / "indate&live" / "overdue&live" / "obsolete")/ inspector=? (Options include the name of an inspector, e.g., Formability Admin)/ lastinspectionfromdate=(0000-00-00 (Year-Month-Day))/ lastinspectiontodate=(0000-00-00 (Year-Month-Day))/ resultordering=(asc or desc)/ orderby=("assetid" / "swl" / "location" / "last inspection" / "next inspection" )/ assetidno=?/ assetid=?/

Get Full Batch Certificate Report

You can get a Full Batch Certificate by including the following after the base URL:

getfullbatchcertificatereport/site=?

Data returned will be in a JSON format.

The current supported search parameters are as follows:

site=?/ location=?/ condition=?/ customerorderno=?/ status=("live" / "archived" / "live&archived" / "indate&live" / "overdue&live" / "obsolete")/ inspector=? (Options include the name of an inspector, e.g., Formability Admin)/ lastinspectionfromdate=(0000-00-00 (Year-Month-Day))/ lastinspectiontodate=(0000-00-00 (Year-Month-Day))/ resultordering=(asc or desc)/ orderby=("assetid" / "swl" / "location" / "last inspection" / "next inspection" )/ assetidno=?/ assetid=?/

Get All Past Inspections For An Asset

You can get a complete output of all inspections for a given asset by including the following after the base URL:

getallinspectionsforanasset/assetid=?

Get All Assets That Have Changed Within A Date Range

You can get a complete output of all assets that have been inspected or amended in a given date range by including the following after the base URL:

getallassetsthathavechanged/datefrom="0000-00-00 (Year-Month-Day)"/

For example, /getallassetsthathavechanged/datefrom=2023-06-28

An optional extra parameter is as follows:

dateto="0000-00-00 (Year-Month-Day)"/