7 Things To Remember

• DO check if a similar function exists before adding
• DO add comments to new functions immediately
• DO make sure changes are backwards compatible, else make a new function
• DO code like this will be released to the public
• ALWAYS new Controller must inherit from BaseController
• ALWAYS separate who to modify from who is authenticated. Authenticated user just means they have API access.
• ALWAYS always check for rights (clients only modify their data. trainers modify group's data. API partners can modify any)
• ALWAYS fail out an error code. Only a success is 200.

HTTP Status Response

Evaluate the actual HTTP status instead of JSON status codes.

200 : success.
401 : unauthorized (auth creds not correct, cannot login)
403 : Exceeded max access count for api.
403 : forbidden (client can only modify own records, trainer can modifies group's records)
404 : user or entity ID not found
406 : unable to parse params, or params don't make sense or give errors
500 : error occured(any error or crashes)

Success Codes

0 : Indicates success

Error Codes

The API may send the following error codes. Other codes may be added in the future.

rate_limit_exceeded : The rate limit for the App has been exceeded
api_plan_restricted : The API is not available on this App’s Plan
client_only : this feature is for a client only
trainer_only : this feature is for a trainer only
type_mismatch : The JSON value type is incorrect for the field
parameter_not_found : A required parameter was not supplied
parameter_invalid : A parameter’s value is invalid

Tech Notes

To get the current Authenticated user.
Use SignedIn

To get the group of Authenticated user.
Use CurrentGroup

Authentication headers scheme

Titanium permanent token:
v6 Browser temporary token:

Authentication is through the header
Sample: Authorization : TRAUV1 3_OAFMBQLSUWYGUWYADEXD
TRAUV1 is a hard coded string to identify the type of the token
3_OAFMBQLSUWYGUWYADEXD will combine the userid and login token


Permanent partner API token:
Trainerize use the Basic Authentication for permanent partner API.
The Authentication token will base64 encoding of groupID:APIToken.
Sample: Authorization: Basic [Base64Encoded(groupID:APIToken)] Please get the token from Trainerize Dev Team

Access control

API will have limit number of access. It controlled by pre-IP/pre-day.
See the current limit: SYS/GetAccessLimit
Changet the current limits: SYS/SetAccessLimit
Get the current stats: SYS/GetAccessStats
Clear stats: SYS/ClearAccessStats

Referrer API to web app/ mobile app

referral (www.trainerize.com/referral.aspx)	mobile	mobile behaviour	web	web behaviour
action=msg.new&recipients=1,2,3	trainerize://?action=msg.new&recipients=1,2,3	opens msg dialog and adds userID as recipients	/app/messages/?view=inbox#mode=newMsg&recipients=1,2,3	open new mesage dialog
action=clients.viewNotSetupAfter3Days	trainerize://?action=clients.viewNotSetupAfter3Days	opens client grid	/app/group/client.aspx#mode=clients.viewNotSetupAfter3Days	opens client grid - goes to tag not setup after 3 days
action=clients.viewNeedNewTrainingPlan	trainerize://?action=clients.viewNeedNewTrainingPlan	opens client grid	/app/group/client.aspx#mode=clients.viewNeedNewTrainingPlan	opens client grid - goes to tag needs new training plan
action=clients.viewNotSignedInLately	trainerize://?action=clients.viewNotSignedInLately	opens client grid	/app/group/client.aspx#mode=clients.viewNotSignedInLately	opens client grid - goes to tag not signed in lately
action=clients.viewLastMessaged	trainerize://?action=clients.viewLastMessaged	opens client grid	/app/group/client.aspx#mode=clients.viewLastMessaged	opens client grid - goes to all activated (last message)
action=clients.viewActive	trainerize://?action=clients.viewActive	opens client grid	/app/group/client.aspx#mode=clients.viewActive	opens client grid - goes to all activated
action=msg.open	trainerize://?action=msg.open&threadID=123	opens up msg dialog for the thread	not implemented
action=group.open	trainerize://?action=group.open&groupID=123	opens up group dialog from groupID	not implemented
action=dailyWorkout.open	trainerize://?action=dailyWorkout.open&dailyWorkoutID=123	(For client)opens up workout dialog	not implemented
not implemented	trainerize://?action=trainerUpdate.calendar	opens up calendar and updates	not implemented
not implemented	trainerize://?action=trainerUpdate.trainingPlan	opens up training plan and updates	not implemented