Data
Controller for endpoints to retrieve and update database records
| API | Description |
|---|---|
| GET api/data/{procedure}?param={param}&tableName={tableName}&maxRecords={maxRecords} |
GetData - Returns a dataset to the client |
| POST api/data/{procedure} |
SetData - Updates a database record |
| GET api/parameter/{procedure}?param={param}&length={length} |
GetParameter - Returns a SQL Procedure OUTPUT parameter to the client as a string |
| GET api/data/parameter/{procedure}?param={param}&length={length} |
GetParameter - Returns a SQL Procedure OUTPUT parameter to the client as a string |
| POST api/dataitem |
SetDataItem - Updates a Data Item |
Auth
Controller for Authorisation endpoints
| API | Description |
|---|---|
| GET api/auth/user |
GetUser - Returns the applicaiton identity user name |
| POST api/auth/authenticate |
Authenticate - Checks users credentials |
| GET api/sites2 |
GetSites - Returns a List of sites stored in the database |
| POST api/auth/login |
CreateSessionToken - Checks users credentials and returns a token to be used for further assess |
| POST api/auth/token |
CreateToken - Generates a user token for the supplied credentials |
| POST api/auth/token?database={database}&username={username}&password={password} |
CreateToken - Generates a user token for the supplied credentials |
| GET api/auth/current |
CreateToken - Generates a user token for the supplied credentials |
| GET api/auth/tokencache |
GetTokenCache - Returns all cached user tokens |
| DELETE api/auth/tokencache |
ClearTokenCache - Clears all cached user tokens |
| GET api/database/account |
Authenticate - Checks users credentials |
Licence
Controller for endpoints view and generate TRACE Licence keys
| API | Description |
|---|---|
| GET api/licence-options |
GetLicenceHistory - Gets the saved history of TRACE Licence key generation |
| GET api/licence |
GetLicenceHistory - Gets the saved history of TRACE Licence key generation |
| POST api/licence |
GenerateLicence - Generates a new TRACE Licence key |
Basic
Controller for basic endpoints with no authorisation needed
| API | Description |
|---|---|
| GET api/test |
BasicTest - Returns 'Hello' |
| GET api/test/xml |
BasicTestXML - Returns details of the request |
| GET api/date |
GetDate - Returns the current date |
| GET api/databases |
GetDataBases - Returns a List of available Databases |
| GET api/locales |
GetLocale - Returns a List of Countries (Languages) |
| GET api/countries |
GetLocale - Returns a List of Countries (Languages) |
| GET api/sites |
GetSites - Returns a List of sites stored in the database |
| GET api/database/test |
GetDataBases - Returns a List of available Databases |
| GET api/errors |
GetErrors - Reutrns all recorded service errors |