StaffApiV11 Resource

Funktionalität rund um das Personal

GET /api/v11/staff/list

Eine Liste aller Mitarbeiter ermitteln

Request Parameters
name type description constraints
limit query die Anzahl der auszugebenden Datensätze. Wird der Parameter nicht angegeben, so werden bis zu 50 Datensätze geliefert. Wird 0 angegeben, werden alle Sätze ausgegeben int
startIndex query ist jene (staffEntry.)Id ab der die Auflistung erfolgen soll. Speziell bei seitenweiser Auflistung - Parameter limit ist gesetzt - hilfreich um den Startdatensatz der Seite zu erhalten int
userid query des am HELIUM V Servers angemeldeten Benutzers  
Response Body
media type data type description
application/json array of StaffEntry (JSON) eine (leere) Liste aller Mitarbeiter auf die der angemeldete Benutzer zugreifen darf
application/xml;charset=UTF-8 object

Example

Request
GET /api/v11/staff/list
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
[ {
  "personalNr" : "...",
  "identityCnr" : "...",
  "shortMark" : "...",
  "name" : "...",
  "firstName" : "...",
  "id" : 12345
} ]

POST /api/v11/staff/synch

Der Mitarbeiter hat synchronisiert.

Request Body
media type data type
application/json SynchEntry (JSON)
application/xml;charset=UTF-8 object

Example

Request
POST /api/v11/staff/synch
Content-Type: application/json

                
{
  "userId" : "...",
  "where" : "..."
}
Response
HTTP/1.1 201 Created

GET /api/v11/staff/{userid}

Einen Mitarbeiter liefern.

Request Parameters
name type description constraints
userid path des am HELIUM V Servers angemeldeten Benutzers  
forStaffCnr query ist die optionale Personalnummer des Mitarbeiters, der abgerufen werden soll.  
forStaffId query ist die optionale PersonalId des Mitarbeiters, der abgerufen werden soll. int
forStaffIdCard query ist die optionale Ausweisnummer des Mitarbeiters, der abgerufen werden soll. Sind zumindest zwei der drei Parameter forStaffId, forStaffCnr und forStaffIdCard angegeben, werden die Parameter nach dieser Reihenfolge priorisiert verwendet. Sind alle drei nicht angegeben, wird der Mitarbeiter geliefert, der dem angemeldeten Benutzer zugewiesen ist.  
Response Body
media type data type description
application/json StaffEntry (JSON) der gefundene Mitarbeiter als StaffEntry
application/xml;charset=UTF-8 object

Example

Request
GET /api/v11/staff/{userid}
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "personalNr" : "...",
  "identityCnr" : "...",
  "shortMark" : "...",
  "name" : "...",
  "firstName" : "...",
  "id" : 12345
}