API Dashboard

Taffy 3.6.0

Resources:

usersemailavailable DELETE PATCH PUT POST GET /users/emailavailable

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

post
Returns if a email already exists for any user excluding a specific user id
Inputs
optional string email (default: "")
optional numeric excludeUserId (default: 0)

userswelcome DELETE PATCH PUT POST GET /users/{id}/welcome

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

get
Resend the users welcome email
Inputs
required numeric id

usersswitchaccount DELETE PATCH PUT POST GET /users/{id}/switchaccount

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

post
Move the user to a new account
Inputs
required numeric id
required numeric newAccountId
optional boolean createKnowledgeHubLicense (default: false)
optional boolean deactiveAccount (default: false)
optional array newLicenseIds (default: [runtime expression])

usersmember DELETE PATCH PUT POST GET /users/{id}

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

get
Get an users if the current requestor is authorized to see it
Inputs
required numeric id
optional boolean includeLicenseCheck (default: false)
optional boolean includeinactive (default: false)
put
Update an account record
Inputs
optional any id (default: 0)

userscollection DELETE PATCH PUT POST GET /users

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

get
List all users (paged) that the current requestor is authorized to see
Inputs
optional string searchString (default: "")
optional string sort (default: "")
optional numeric offset (default: 0)
optional numeric limit (default: 10)
optional numeric accountId (default: 0)
optional boolean paged (default: true)
post
Create a new user record
Inputs

testerror DELETE PATCH PUT POST GET /testerror

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

get
Test the error handler
Inputs

testemail DELETE PATCH PUT POST GET /testemail

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

get
Test the email service
Inputs

testkey DELETE PATCH PUT POST GET /testapikey

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

get
Test the error handler
Inputs

registrationsstatistics DELETE PATCH PUT POST GET /registrations/statistics

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

get
Returns a structure representing the statistics for user registrations
Inputs

registrationsverify DELETE PATCH PUT POST GET /registrations/{id}/verify

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

post
verify a new registration record
Inputs
required numeric id

registrationsresend DELETE PATCH PUT POST GET /registrations/{id}/resendemail

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

post
Create a new registration record
Inputs
required numeric id

registrationsmember DELETE PATCH PUT POST GET /registrations/{id}

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

get
Get a registration record
Inputs
required numeric id

registrationscollection DELETE PATCH PUT POST GET /registrations

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

post
Create a new registration record
Inputs

profilelicensetypesmember DELETE PATCH PUT POST GET /profile/licensetypes/{typeId}

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

post
Allows a user to self assign a license seat of a public type
Inputs
optional numeric typeId (default: 0)
optional boolean marketingEmail (default: false)
optional boolean marketingPhone (default: false)
optional boolean newsletter (default: false)

profilelicenses DELETE PATCH PUT POST GET /profile/licenses

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

get
List all licenses for the current user
Inputs

organisationtypesmember DELETE PATCH PUT POST GET /organisationtypes/{id}

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

get
Get an organisation type by ID
Inputs
required numeric id

organisationtypescollection DELETE PATCH PUT POST GET /organisationtypes

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

get
List all available organisation types and their associated groups
Inputs

logsdownloads DELETE PATCH PUT POST GET /logs/downloads

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

post
Inputs

logscollection DELETE PATCH PUT POST GET /logs

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

post
Inputs

licensesuserscollection DELETE PATCH PUT POST GET /licenses/{id}/users

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

delete
un-associates the specified user(s) and license
Inputs
optional array userIds (default: [runtime expression])
post
Associates the specified user(s) and license
Inputs
required array userIds
optional boolean sendNotification (default: false)

licensesmember DELETE PATCH PUT POST GET /licenses/{id}

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

get
Get a licenses if the current requestor is authorized to see it
Inputs
required numeric id
put
Update a license record
Inputs

licensescollection DELETE PATCH PUT POST GET /licenses

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

get
List all licenses (paged) that the current requestor is authorized to see
Inputs
optional string searchString (default: "")
optional string sort (default: "")
optional numeric offset (default: 0)
optional numeric limit (default: 10)
optional boolean paged (default: true)
post
Create a new license record
Inputs

jobfunctionscollection DELETE PATCH PUT POST GET /jobfunctions

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

get
List all jobfunctions
Inputs

exoneausers DELETE PATCH PUT POST GET /exonea/users

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

get
Trigger the exonea users export function
Inputs
optional string key (default: "")
optional boolean test (default: false)

exoneaaccounts DELETE PATCH PUT POST GET /exonea/accounts

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

get
Trigger the exonea accounts export function
Inputs
optional string key (default: "")
optional boolean test (default: false)

countriesmember DELETE PATCH PUT POST GET /countries/{id}

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

get
Get a single country by ID
Inputs
required any id

countriescollection DELETE PATCH PUT POST GET /countries

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

get
List all countries with preferred sorting (UK/USA first)
Inputs

blinklogsmember DELETE PATCH PUT POST GET /blinklogs/{id}

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

get
Get a Blink API log record
Inputs
required any id

blinklogscollection DELETE PATCH PUT POST GET /blinklogs

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

get
Retrieve Blink API log records (paged)
Inputs
optional numeric api_action_id (default: 0)
optional numeric related_object_record_id (default: 0)
optional numeric offset (default: 0)
optional numeric limit (default: 10)
optional string sort (default: "")
post
Create a new Blink API log record
Inputs

authenticationtoken DELETE PATCH PUT POST GET /authentication/token

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

post
Accepts user credentials, validates them, and generates tokens to be used for subsequent requests to other protected endpoints.
Inputs
optional string username (default: "")
optional string password (default: "")
optional numeric applicationId (default: 0)
optional string forwardedIPAddress (default: "")

authenticationrefreshtokens DELETE PATCH PUT POST GET /authentication/refreshtokens

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

post
Takes a refresh token and returns a new access token
Inputs
optional string refreshToken (default: "")

authenticationpasswordset DELETE PATCH PUT POST GET /authentication/password/set

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

put
Sets a new password for a logged in user
Inputs

authenticationpasswordreset DELETE PATCH PUT POST GET /authentication/password/reset

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

post
Resets a forgotten password using a supplied email and reset code
Inputs
optional string username (default: "")
optional string resetcode (default: "")
optional string newPassword (default: "")
optional string confirmPassword (default: "")

authenticationpasswordforgot DELETE PATCH PUT POST GET /authentication/password/forgot

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

post
Triggers the forgot password process for a given username
Inputs
optional string username (default: "")
optional numeric applicationId (default: 0)

authenticationpasswordactivate DELETE PATCH PUT POST GET /authentication/password/activate

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

post
Resets a forgotten password using a supplied email and reset code
Inputs
optional string username (default: "")
optional string activationCode (default: "")
optional string newPassword (default: "")
optional string confirmPassword (default: "")

authenticationaccesscode DELETE PATCH PUT POST GET /authentication/accessCode

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

get
Returns a one time use accessCode for a currently logged in user to access another sub application
Inputs
post
Accepts user credentials, validates them, and returns a user structure
Inputs
optional string username (default: "")
optional string accessCode (default: "")
optional numeric applicationId (default: 0)
optional string forwardedIPAddress (default: "")

accountsmember DELETE PATCH PUT POST GET /accounts/{id}

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

get
Get an accounts if the current requestor is authorized to see it
Inputs
required numeric id
put
Update an account record
Inputs
optional any id (default: 0)
optional boolean active (default: true)
optional boolean autoRenew (default: false)
optional string expiryDate (default: "")
optional numeric numberOfSeats
optional array options (default: [runtime expression])
optional string reminderDate (default: "")
optional string startDate (default: "")
optional boolean trial (default: true)
optional numeric typeId
optional string registrationcode (default: "")

accountscollection DELETE PATCH PUT POST GET /accounts

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

get
List all accounts (paged) that the current requestor is authorized to see
Inputs
optional string searchString (default: "")
optional string sort (default: "")
optional numeric offset (default: 0)
optional numeric limit (default: 10)
optional numeric accountId (default: 0)
optional boolean paged (default: true)
post
Create a new account record
Inputs

Warning: Your reload key and password are using the framework default settings. It's advised that you change these in production.
Resources are listed in matching order. From top to bottom, the first URI to match the request is used.