API — HR¶
The HTTP surface of the HR module: the employee master file and every record hanging off it,
plus daily attendance. HumanResourceController is the second-largest controller in the solution —
most of its actions are the per-tab Manage* / Add* / Edit* / Delete* fragments behind the
employee card.
See HR module for what these screens do, and HR Onboarding for the end-to-end flow.
115 actions across 3 controllers
Routing, the permission model, response kinds and error behaviour are described
once in the API Overview. Unless a row says otherwise the route is
/{Controller}/{Action}, id is a GUID string, and a Details page is a
full View while Manage* / Create fragments are PartialViews loaded into a modal.
HumanResourceController¶
The employee master file — the approved and draft employee grids, the employee card, and every sub-record tab (identity documents, family, relatives, contracts, positions, insurance, allowances, deductions, attachments, e-signatures).
Source: NKO.Main/NKO.Main/Controllers/HumanResourceController.cs · route prefix: /HumanResource · 97 actions · 1 ungated
| Route | Verb | Parameters | Permission | Returns |
|---|---|---|---|---|
/ |
GET | string id, bool? type |
Human |
PartialView |
/ |
POST | App |
Human |
JSON |
/ |
GET | string id, string return |
Human |
PartialView |
/ |
POST | Note model, string return |
Human |
PartialView / JSON |
/ |
GET | int sign, int user |
Human |
Redirect |
/ |
GET | string id, string err, int? edit |
Human |
View |
/ |
GET | string id |
Human |
View |
/ |
GET | string id |
Human |
View |
/ |
GET | string id |
Human |
View |
/ |
POST | App |
Human |
View |
/ |
GET | string u, int? t |
Human |
PartialView |
/ |
GET | — | Human |
PartialView |
/ |
POST | Custom |
Human |
PartialView / JSON |
/ |
GET | int Job, string applicant |
Human |
Redirect |
/ |
GET | string id |
Human |
View |
/ |
GET | string id |
Human |
PartialView / Redirect |
/ |
POST | App |
Human |
PartialView / JSON |
/ |
GET | string id |
Human |
PartialView / Redirect |
/ |
POST | App |
Human |
JSON |
/ |
GET | int id |
Human |
PartialView |
/ |
POST | App |
Human |
PartialView / JSON |
/ |
GET | int id |
Human |
PartialView / Redirect |
/ |
POST | App |
Human |
PartialView / JSON |
/ |
GET | string id |
Human |
PartialView / Redirect |
/ |
POST | App |
Human |
PartialView / JSON |
/ |
GET | int t, string u |
Human |
PartialView |
/ |
POST | Deduction |
Human |
PartialView / JSON |
/ |
GET | int id |
Human |
PartialView / Redirect |
/ |
POST | App |
Human |
PartialView / JSON |
/ |
POST | string id |
Human |
JSON |
/ |
POST | string id |
Human |
JSON |
/ |
GET | string id |
Human |
PartialView / Redirect |
/ |
POST | Note model |
Human |
JSON |
/ |
GET | int t, string u |
Human |
PartialView |
/ |
POST | Reward |
Human |
PartialView / JSON |
/ |
GET | int id |
Human |
PartialView |
/ |
POST | User |
Human |
PartialView / JSON |
/ |
GET | string id |
Human |
View |
/ |
GET | string attachment |
— open | Redirect / NotFound |
/ |
GET | int id |
Human |
File |
/ |
GET | int id |
Human |
Task< |
/ |
GET | string sort, string current, string search, int? page, string type, string current, int? current, int? enabled, int? filter, int? filter |
Human |
View |
/ |
GET | string id |
Human |
View |
/ |
POST | Custom, IForm, List< |
Human |
View |
/ |
GET | string id |
Human |
View |
/ |
POST | Custom, IForm |
Human |
View |
/ |
GET | int id |
Human |
PartialView |
/ |
POST | App |
Human |
JSON |
/ |
GET | string id |
Human |
View |
/ |
GET | string id |
Human |
View |
/ |
GET | string user |
Human |
View |
/ |
GET | string id |
Human |
View |
/ |
GET | string id |
Human |
View |
/ |
GET | — | Payroll |
View |
/ |
POST | IForm |
Payroll |
View |
/ |
GET | string sort, string current, string search, int? filter, int? filter, int? page, string type, string current, int? current, int? enabled, bool? is, int active |
Human |
View |
/ |
GET | string id, int? page, int? filter, int? filter |
Human |
View |
/ |
POST | App |
Human |
PartialView / JSON |
/ |
GET | string u, int? t |
Human |
PartialView |
/ |
POST | App |
Human |
PartialView / JSON |
/ |
GET | string u, int? t |
Human |
Redirect |
/ |
POST | App |
Human |
Redirect |
/ |
GET | int user, int? id |
Human |
PartialView |
/ |
POST | App |
Human |
PartialView / JSON |
/ |
GET | string u, int? t |
Human |
PartialView |
/ |
POST | App |
Human |
PartialView / JSON |
/ |
GET | string u, int? t |
Human |
PartialView |
/ |
POST | App |
Human |
JSON |
/ |
GET | string u, int? t |
Human |
PartialView |
/ |
POST | App |
Human |
JSON |
/ |
GET | string u, int? t |
Human |
PartialView |
/ |
POST | App |
Human |
PartialView / JSON |
/ |
GET | string u, int? t |
Human |
PartialView |
/ |
GET | string u, int? t |
Human |
PartialView |
/ |
POST | App |
Human |
JSON |
/ |
GET | string id, int? sign |
Human |
Redirect |
/ |
POST | User |
Human |
Redirect |
/ |
GET | string id, string side, string current, int status |
Human |
View / Redirect |
/ |
GET | string id |
Human |
View |
/ |
GET | string id |
Human |
View |
/ |
GET | int contract |
Human |
PartialView |
/ |
POST | App |
Human |
JSON |
/ |
GET | int sign, int user |
Human |
PartialView |
/ |
POST | User |
Human |
PartialView / JSON |
/ |
GET | int contract |
Human |
Redirect |
/ |
GET | int tab, int? page, string search, List<, List<, List<, bool? sex, List<, List<, List<, List<, List<, List<, List<, Date, Date, Date, Date, int active, int? res, int? governorate, int? district, bool? notes, bool? bank, bool? pac, bool? pac, List<, bool? is, bool? relative, bool? signture, bool? is, int? project, int? contract, int? work, int? position, int? contract, Date, Date, Date, int? level, int? step, int? from, int? to, bool? total, int? currency, int? default, int? default, int? salary, bool? passport, bool? turkish, bool? residency, bool? temp, bool? work, bool? syrian, bool? c, bool? noconviction, bool? scientific, bool? training, bool? medical, bool? personal, bool? other, bool? census, bool? residence, bool? s, bool? signature, bool? isim, int? charge, bool? is, bool has, bool has, bool has, bool has, bool has, bool has, bool has, bool has, bool has, bool has, bool has, bool has, bool reset |
Human |
View |
/ |
GET | string id |
Human |
View |
/ |
GET | string id, string current |
Human |
View / Redirect |
/ |
GET | string id, int? sign, string msg |
Human |
View |
/ |
GET | — | Payroll |
View |
/ |
POST | IForm |
Payroll |
View |
/ |
POST | — | Human |
JSON |
/ |
POST | — | Human |
JSON |
/ |
POST | int id |
Human |
Content |
/ |
GET | string u, int t |
Human |
PartialView |
/ |
GET | string u, int t |
Human |
PartialView |
/ |
GET | string id |
Human |
View |
AttendancesController¶
Daily attendance: check-in / check-out, the justification queue, the monthly and yearly calendar reconciliation, and the exports that feed payroll.
Source: NKO.Main/NKO.Main/Controllers/AttendancesController.cs · route prefix: /Attendances · 16 actions · 5 ungated
| Route | Verb | Parameters | Permission | Returns |
|---|---|---|---|---|
/ |
GET | string id, int year, int month, int? pdf |
Attendances |
View |
/ |
POST | int? Check, int? Check |
Attendances |
Redirect |
/ |
GET | int month, int year |
Human |
Redirect |
/ |
GET | int year, int month, int? Sub |
Attendances |
Redirect |
/ |
GET | string id, int? year |
Attendances |
View |
/ |
GET | int year, int month, int? Sub, App |
— open | List< — internal helper, unintentionally routable |
/ |
GET | int year, int month, int user |
— open | Missings — internal helper, unintentionally routable |
/ |
GET | Month |
— open | Tuple< — internal helper, unintentionally routable |
/ |
GET | int year, int month, int user |
Attendances |
View |
/ |
GET | int year, int month, string sort, int? Sub, int? page |
Attendances |
View |
/ |
GET | string id, string side, int month, int year |
Attendances |
JSON |
/ |
GET | Month |
— open | double — internal helper, unintentionally routable |
/ |
GET | int id, int type |
Reset |
PartialView |
/ |
POST | Reset |
Reset |
PartialView / JSON |
/ |
GET | Day |
— open | bool |
/ |
GET | int year, int month |
Human |
View |
DocumentController¶
Header and footer fragments requested by the PDF renderer while exporting a document. Both are [AllowAnonymous] because the renderer fetches them without the user session.
Source: NKO.Main/NKO.Main/Controllers/DocumentController.cs · route prefix: /Document · 2 actions · 2 ungated
| Route | Verb | Parameters | Permission | Returns |
|---|---|---|---|---|
/ |
GET | — | [Allow |
PartialView |
/ |
GET | — | [Allow |
PartialView |
Related¶
- HR module
- HR Onboarding
- HR database
- API Overview — routing, auth, responses and error behaviour.