Tmp
API for retrieving/dealing with TMP data.
| API | Description |
|---|---|
| GET v1/tmp |
Gets the current user's TMP data derived from the session key |
| GET v1/tmp/{id} |
Get single TMP record by ID |
| GET v1/tmp/{term}?customErrMsg={customErrMsg} |
Search for all TMP records within current user's company whose name matches the term passed in |
| GET v1/tmp/customcontent |
Gets custom content to be used as text in the app |
| POST v1/tmp?share={share} |
Update current user's share score value |
| GET v1/tmp?term={term}&customErrMsg={customErrMsg} |
Search for all TMP records within current user's company whose name matches the term passed in |
Files
API for serving up static content. TMP images and Pacing Tips can be retrieved from this API.
| API | Description |
|---|---|
| GET v1/files/chart/{id}?dark={dark} |
Get HTML for the chart page depending on passed in parameter |
| GET v1/files/chart?id={id}&dark={dark} |
Get HTML for the chart page depending on passed in parameter |
| GET v1/files/org/{orglogo} |
Gets the consultant organisation logo |
| GET v1/files/org?orglogo={orglogo} |
Gets the consultant organisation logo |
| GET v1/files/pdf/{id} |
PDF summary depending on passed in parameter |
| GET v1/files/pdf?id={id} |
PDF summary depending on passed in parameter |
| GET v1/files/tips/{id}?dark={dark} |
Get HTML for pacing tips depending on passed in parameter |
| GET v1/files/tips?id={id}&dark={dark} |
Get HTML for pacing tips depending on passed in parameter |
| GET v1/files/tmpwheel/{wheel} |
Get TMP chart based on passed in score parameter |
| GET v1/files/tmpwheel?wheel={wheel} |
Get TMP chart based on passed in score parameter |
Accounts
API for accounts management (authentication, session validation, signout)
| API | Description |
|---|---|
| POST v1/accounts/auth?email={email}&code={code} |
Authenticate the user using the email and the code given from email |
| POST v1/accounts/delete |
Request for user's account and related data to be deleted |
| GET v1/accounts/request |
Requests a TMP refresh, sends an email to TMS |
| POST v1/accounts/signout |
User signout. Deletes the user's session key. Requires session key. |
| POST v1/accounts?email={email} |
Generate a code for user authentication. This will send an email to the passed in email address and will either have a code or say that the TMP data associated with the email cannot be found |