API v1 Documentation

Overview

Authentication
Log In POST /api/v1/log-in
Sign Up POST /api/v1/sign-up
Log Out POST /api/v1/log-out
Check If You Are Logged In GET /api/v1/is-logged-in
Remind Password POST /api/v1/remind-password
Reset Password POST /api/v1/reset-password
Verify Email POST /api/v1/verify-email
Send Verification Email POST /api/v1/send-verification-email
Time Zones
Get My Time Zones GET /api/v1/time-zones
Add Time Zone PUT /api/v1/time-zone
Rename time zone POST /api/v1/time-zone
Remove Time Zone DELETE /api/v1/time-zone
My Profile
Get My Profile GET /api/v1/profile
Change My Profile POST /api/v1/profile
Delete My Account DELETE /api/v1/profile
Change My Password POST /api/v1/profile/change-password
Managing
Get User's Time Zones GET /api/v1/manage/time-zones
Add User's Time Zone PUT /api/v1/manage/time-zone
Rename User's Time Zone POST /api/v1/manage/time-zone
Remove User's Time Zone DELETE /api/v1/manage/time-zone
Get Users Count GET /api/v1/manage/users-count
Get List of Users GET /api/v1/manage/users
Get User's Profile GET /api/v1/manage/user-profile
Change User's Profile POST /api/v1/manage/user-profile
Remove User's Profile DELETE /api/v1/manage/user-profile
Log Out User POST /api/v1/manage/logout-user
Change User's Role POST /api/v1/manage/user-role

Authentication

Log In
http://timezonely.com/api/v1/log-in POST
Response format: JSON
Required authorization level
None
Request parameters
`email`
`password`
Result data format
None
Sign Up
http://timezonely.com/api/v1/sign-up POST
Response format: JSON
Required authorization level
None
Request parameters
`email`
`password`
`confirmPassword`
Result data format
None
Log Out
http://timezonely.com/api/v1/log-out POST
Response format: JSON
Required authorization level
User
Request parameters
None
Result data format
None
Check If You Are Logged In
http://timezonely.com/api/v1/is-logged-in GET
Response format: JSON
Required authorization level
User
Request parameters
None
Result data format
None
Remind Password
http://timezonely.com/api/v1/remind-password POST
Response format: JSON
Required authorization level
User
Request parameters
`email`
Result data format
None
Reset Password
http://timezonely.com/api/v1/reset-password POST
Response format: JSON
Required authorization level
User
Request parameters
`password`
`confirm`
`token`
Result data format
None
Verify email
http://timezonely.com/api/v1/verify-email POST
Response format: JSON
Required authentication level
User
Request parameters
`token`
Result data format
None
Send Verification Email
http://timezonely.com/api/v1/send-verification-email POST
Response format: JSON
Required authentication level
User
Request parameters
None
Result data format
None

Time Zones

Get My Time Zones
http://timezonely.com/api/v1/time-zones GET
Response format: JSON
Required authentication level
User
Request parameters
None
Result data format
[
  {
    "updatedAt": "2017-08-01T19:14:55.810Z",
    "createdAt": "2017-08-01T19:14:55.810Z",
    "name": "Pacific/Honolulu",
    "displayName": "Custom Name"
  },
...
]
Add Time Zone
http://timezonely.com/api/v1/time-zone PUT
Response format: JSON
Required authentication level
User
Request parameters
`name`
`displayName`
Result data format
None
Rename Time Zone
http://timezonely.com/api/v1/time-zone POST
Response format: JSON
Required authentication level
User
Request parameters
`name`
`displayName`
Result data format
None
Remove Time Zone
http://timezonely.com/api/v1/time-zone DELETE
Response format: JSON
Required authentication level
User
Request parameters
`name`
Result data format
None

My Profile

Get My Profile
http://timezonely.com/api/v1/profile GET
Response format: JSON
Required authentication level
User
Request parameters
None
Result data format
{
  "updatedAt": "2017-08-01T19:13:56.574Z",
  "createdAt": "2017-08-01T19:13:56.574Z",
  "name": "Test Admin",
  "email": "admin@test.com",
  "role": "Admin",
  "verificationEmailSentDate": "1970-01-01T00:00:00.000Z",
  "emailVerified": true
}
Change My Profile
http://timezonely.com/api/v1/profile POST
Response format: JSON
Required authentication level
User
Request parameters
`name`
Result data format
None
Change My Password
http://timezonely.com/api/v1/profile/change-password POST
Response format: JSON
Required authentication level
User
Request parameters
`password`
`confirmPassword`
Result data format
None

Managing

Get User's Time Zones
http://timezonely.com/api/v1/manage/time-zones GET
Response format: JSON
Required authentication level
User Manager
Request parameters
`email`
Result data format
[
  {
    "updatedAt": "2017-08-01T19:14:55.810Z",
    "createdAt": "2017-08-01T19:14:55.810Z",
    "name": "Pacific/Honolulu",
    "displayName": "Custom Name"
  },
...
]
Add User's Time Zone
http://timezonely.com/api/v1/manage/time-zone PUT
Response format: JSON
Required authentication level
Admin
Request parameters
`email`
`name`
`displayName`
Result data format
None
Rename User's Time Zone
http://timezonely.com/api/v1/manage/time-zone POST
Response format: JSON
Required authentication level
Admin
Request parameters
`email`
`name`
`displayName`
Result data format
None
Remove User's Time Zone
http://timezonely.com/api/v1/manage/time-zone DELETE
Response format: JSON
Required authentication level
Admin
Request parameters
`email`
`name`
Result data format
None
Get Users Count
http://timezonely.com/api/v1/manage/users-count GET
Response format: JSON
Required authentication level
User Manager
Request parameters
`filter` (Optional)
Result data format
None
Get List of Users
http://timezonely.com/api/v1/manage/users GET
Response format: JSON
Required authentication level
User Manager
Request parameters
`filter` (Optional)
`fromPosition`
`usersMax`
Result data format
[
  {
    "updatedAt": "2017-08-01T19:13:56.575Z",
    "createdAt": "2017-08-01T19:13:56.575Z",
    "name": "Test Regular User",
    "email": "user@test.com",
    "role": "User",
    "verificationEmailSentDate": "1970-01-01T00:00:00.000Z",
    "emailVerified": true
  },
  ...
]
Get User's Profile
http://timezonely.com/api/v1/manage/user-profile GET
Response format: JSON
Required authentication level
User Manager
Request parameters
`email`
Result data format
{
  "updatedAt": "2017-08-01T19:13:56.575Z",
  "createdAt": "2017-08-01T19:13:56.575Z",
  "name": "Test Regular User",
  "email": "user@test.com",
  "role": "User",
  "verificationEmailSentDate": "1970-01-01T00:00:00.000Z",
  "emailVerified": true
}
Change User's Profile
http://timezonely.com/api/v1/manage/user-profile POST
Response format: JSON
Required authentication level
User Manager
Request parameters
`email`
`name`
Result data format
None
Remove User's Profile
http://timezonely.com/api/v1/manage/user-profile DELETE
Response format: JSON
Required authentication level
User Manager
Request parameters
`email`
Result data format
None
Log Out User
http://timezonely.com/api/v1/manage/logout-user POST
Response format: JSON
Required authentication level
User Manager
Request parameters
`sessionId`
Result data format
None
Change User's Role
http://timezonely.com/api/v1/manage/user-role POST
Response format: JSON
Required authentication level
User Manager
Request parameters
`email`
`role` - One of following values: Admin, Manager, User
Result data format
None
page-api-docs