Accounts Service
Global
Globally available endpoints which work even without being authenticated
| Method | Path | Auth | Details |
|---|
| GET | /global/settings | | Description |
| GET | /global/genders | | Description |
Authentication
Login, registration and password reset (for Staff and Admins)
| Method | Path | Auth | Details |
|---|
| POST | /user/login | | Description |
| POST | /user/setLastActive | | Description |
| GET | /hasura/auth-webhook | | Description |
| GET | /org-metadata/get | | Description |
| GET | /org-metadata/get-shift-creation | | Description |
| GET | /org-policies | | Description |
| POST | /invite/sendBankInvite | | Description |
| POST | /invite/redeem-bank-invite | | Description |
| POST | /account/create | | Description |
| POST | /user/invite | | Description |
| POST | /user/getInvite | | Description |
| POST | /user/register | | Description |
| GET | /password-reset/get | | Description |
| GET | /password-reset/get-requirements | | Description |
| POST | /password-reset/reset | | Description |
| POST | /password-reset/send | | Description |
Candidate Profile
Endpoints which allow staff to manage their own profile. And endpoints which allow admins to manage staff profiles
| Method | Path | Auth | Details |
|---|
| POST | /ocr/get | | Description |
| GET | /candidate/get | | Description |
| POST | /account/addDetails | | Description |
| POST | /account/changeSpecialitiesByGrade | | Description |
| POST | /account/clearToken | | Description |
| GET | /account/get-self | | Description |
| POST | /account/remove-location | | Description |
| POST | /account/saveToken | | Description |
| POST | /account/set-location | | Description |
| POST | /account/update-sites | | Description |
| GET | /candidate/audit-trail | | Description |
| GET | /candidate/banks | | Description |
| POST | /candidate/cancelRemoval | | Description |
| POST | /candidate/reinstate | | Description |
| POST | /candidate/remove | | Description |
| POST | /candidate/suspend | | Description |
| POST | /candidate/update | | Description |
| POST | /sites/get | | Description |
| POST | /sites/update | | Description |
| POST | /staff-contracts/create | | Description |
| GET | /staff-contracts/get | | Description |
| POST | /staff-contracts/update | | Description |
| GET | /unavailability/get | | Description |
| POST | /unavailability/remove | | Description |
| POST | /unavailability/set | | Description |
| POST | /newSites/delete | | Description |
Admins & Admin Groups
View, list and manage admins, admin groups and permissions
| Method | Path | Auth | Details |
|---|
| GET | /admin-group/list | | Description |
| GET | /admin-group/details | | Description |
| GET | /user/list | | Description |
| GET | /user/admin-groups | | Description |
| GET | /permissions/get | | Description |
| POST | /permissions/update | | Description |
| GET | /services/list | | Description |
| POST | /sites/fetch | | Description |
| POST | /user/update-services | | Description |
| POST | /user/update-sites | | Description |
Notification Management
Endpoints for users to manage their own notifications, seperated by staff vs admin
| Method | Path | Auth | Details |
|---|
| POST | /notification/markAllAsRead | | Description |
| POST | /notification/markAsRead | | Description |
| POST | /notification/send-test-push | | Description |
| POST | /employerNotifications/mark-as-read | | Description |
| POST | /employerNotifications/remove | | Description |
| POST | /employerNotifications/remove-all | | Description |
Rating
See ms-timesheets for rating submission endpoints. These endpoints probably ought to live there too.
| Method | Path | Auth | Details |
|---|
| GET | /rating/categories | | Description |
| GET | /rating/fetch-candidate-detail | | Description |
| GET | /rating/fetch-candidate-summary | | Description |
| GET | /rating/fetch-site-detail | | Description |
| GET | /rating/fetch-site-summary | | Description |
Org/Collab Configuration
| Method | Path | Auth | Details |
|---|
| GET | /payment-rates/list | | Description |
Deprecated
| Method | Path | Auth | Details |
|---|
| GET | /rgsConfig/get | | Description |
| POST | /status/update | | Description |
| POST | /locations/check | | Description |
| POST | /locations/search | | Description |
