-
Notifications
You must be signed in to change notification settings - Fork 1
API specification
Frank Hangler edited this page Dec 9, 2019
·
2 revisions
API documentation (in progress).
All API methods are assumed to be prefixed (e.g. by https://deployed.to.address/api/).
- Need more information on how the current authentication system works. JWTs?
GET /Users
POST /Users
DELETE /Users/:Id
| Parameter | Description |
|---|---|
id |
The id of the user |
PATCH /Users/:Id
| Parameter | Description |
|---|---|
id |
The id of the user |
- Assumes that we are only replacing some of the fields
GET /Employees
- Any [?] field from the
Employeetable in the data model, along with its filtered value, e.g.name=Frank
GET /Employees/:Id
| Parameter | Description |
|---|---|
id |
The id of the employee |
POST /Employees
PATCH /Employees/:Id
| Parameter | Description |
|---|---|
id |
The id of the employee |
POST /Employees/:Id/Timeline
| Parameter | Description |
|---|---|
id |
The id of the employee |
GET /Employees/:Id/Timeline
GET /Logs
- Any [?] field from the
TaskLogEntrytable in the data model, along with its filtered value, e.g.TaskOutcome=Success
POST /Logs
GET /EmailTemplates
PATCH /EmailTemplates/:Id
POST /EmailService/:EmployeeId
POST /RetrieveCSVService
- Or does this belong in the scheduled task itself?
POST /ReconciliationService
POST /EmailService
POST /SurveyStatusService