Webservice Personalstammdaten Export: Unterschied zwischen den Versionen

VisuellWikitext
(Die Seite wurde neu angelegt: „__NOTOC__ {{DISPLAYTITLE:Webservice Tagesinformationen}} Es gibt auch eine Variante als Export-Schnittstelle. Konfiguration fü…“)
 
Keine Bearbeitungszusammenfassung
Zeile 1: Zeile 1:
__NOTOC__ {{DISPLAYTITLE:Webservice Tagesinformationen}}
__NOTOC__ {{DISPLAYTITLE:Webservice Personalstammdaten}}
 
Es gibt auch eine Variante als [[Export_Tagesinformationen|Export-Schnittstelle.]]


Konfiguration für Config-File:
Konfiguration für Config-File:
  , "httpServicePlugins" :
  , "httpServicePlugins" :
   { "0" : "Bfx.Alex.AccountsReport.DayInterval.Model.dll"
   { "0" : "Bfx.Alex.Model.dll"
   }
   }
  , "serverDaemonPlugins" :
  , "serverDaemonPlugins" :
Zeile 13: Zeile 11:
= Aufruf =  
= Aufruf =  


  http://IP:PORT/EmployeeDayIntervals?PARAMETER
  http://IP:PORT/GetEmployees?PARAMETER


* IP: Wie im [[ALEX-Config-File]] eingestellt
* IP: Wie im [[ALEX-Config-File]] eingestellt
* HTTP-Server-PORT: Wie im ALEX-Config-File eingestellt
* HTTP-Server-PORT: Wie im ALEX-Config-File eingestellt
* PARAMETER:  
* PARAMETER:  
** Ressourcen können folgendermaßen angegeben werden
** "from": Begin-Datum des Datenauszuges Format "DD.MM.YYYY"
*** "allEmployees": gesamtes Personal
*** "id": Personalnummer
*** "planCode": Kurzzeichen von Plan
*** "resourcesBson": eine Zusammenfassung von Plan Kurzzeichen und Personalnummer zum Beispiel: "?resourcesBson={"employeeIDs":["E1","E2","E3"],"planCodes":["P1","P2","P3"]}"
** "begin": Begin-Datum des Datenauszuges Format "DD.MM.YYYY"
** "end": Ende-Datum des Datenauszuges Format "DD.MM.YYYY"
** "end": Ende-Datum des Datenauszuges Format "DD.MM.YYYY"
** "allstates": Statusdaten für alle aktuellen Status: Planung -> Planung, Ist -> Planung und Ist


== Beispiel ==  
== Beispiel ==  


Alle Tagesinformationen von gesamten Personal von 05.12.2017 bis einschließlich 07.12.2017:
Personal von 05.12.2017 bis einschließlich 07.12.2017:
<nowiki>http://localhost:4480/EmployeeDayIntervals?allEmployees=true&begin=05.12.2017&end=07.12.2017</nowiki>
  <nowiki>http://localhost:4480/GetEmployees?from=05.12.2017&end=07.12.2017</nowiki>
 
Alle Tagesinformationen von Personal mit Personalnummer "20" von 05.12.2017 bis einschließlich 07.12.2017:
<nowiki>http://localhost:4480/EmployeeDayIntervals?id=20&begin=05.12.2017&end=07.12.2017</nowiki>
 
Alle Tagesinformationen von Personal auf Plan "X" von 01.12.2017 bis einschließlich 31.12.2017:
<nowiki>http://localhost:4480/EmployeeDayIntervals?planCode=X&begin=01.12.2017&end=31.12.2017</nowiki>
 
Alle Tagesinformationen von Personal "E1", "E2", "E3" und Personal auf Plänen "P1", "P2", "P3" von 01.12.2017 bis einschließlich 31.12.2017:
<nowiki>http://localhost:4480/EmployeeDayIntervals?begin=01.12.2017&end=31.12.2017&resourcesBson={"employeeIDs":["E1","E2","E3"],"planCodes":["P1","P2","P3"]}</nowiki>
 
Alle Tagesinformationen von Personal mit Personalnummer "20" von 05.12.2017 bis einschließlich 07.12.2017, alle Status:
  <nowiki>http://localhost:4480/EmployeeDayIntervals?id=20&begin=05.12.2017&end=07.12.2017&allstates=true</nowiki>


= Ergebnis =
= Ergebnis =
Zeile 48: Zeile 28:
Tagesinformation im [https://www.json.org/ JSON-Format] UTF8 codiert in der Form:
Tagesinformation im [https://www.json.org/ JSON-Format] UTF8 codiert in der Form:


  { "Employees" : [
  { "Employees" : [  
{ "EmployeeID" : "string"
{ "EmployeeID" : "string"
, "Surname" : "string"
, "Surname" : "string"
, "Forename" : "string"
, "Forename" : "string"
, "MasterAllocation" : "string"
, "DayOfBirth" : "string"
, "EmployeeJobGroup" : "string"
, "EmployeeSignature" : "string"
, "Days" : [
, "Sex" : "string"
{ "ForDate" : "string"
, "MasterAllocation" : "string"
, "ForState" : "string"
, "EmployeeJobGroup" : "string"
, "TextCategory" : "string"
, "EmployeeQualifications" : [ "string" ]
, "InfoText" : "string"
, "EmployeeEmailAddress" : "string"
, "DayPlanSymbol" : "string"
, "EmployeePhoneNumber" : "string"
, "DayShift1" : "string"
, "EmployeeSocialInsurance" : "string"
, "DayShift2" : "string"
, "EmployeeStreet" : "string"
, "DayRequestKind" : "string"
, "EmployeeCity" : "string"
, "DayTotalMinutesComputed" : "float"
, "PostalCode" : "string"
, "DayIntervals" : [
, "ForNation" : "string"
{ "From" : "string"
, "EmployeeLastEmployedFrom" : "string"
, "To" : "string"
, "EmployeeLastEmployedTo" : "string"  
, "DayIntervalPlanSymbol" : "string"  
  }
        , "DayIntervalInfoTextCategory" : "string"
, "DayIntervalInfoText" : "string"  
}
]}
  ]}
  ]}
  ]}
Glossar:
Glossar:
* Employees: Array aller Personen
* Employees: Array aller Personen
Zeile 82: Zeile 56:
* MasterAllocation: Stammplanungseinheit
* MasterAllocation: Stammplanungseinheit
* EmployeeJobGroup: Berufsgruppe
* EmployeeJobGroup: Berufsgruppe
* Days: Array aller Tage
* DayOfBirth: Geburtstag
* ForDate: Datum von Tag
* EmployeeSignature: Handzeichen
* ForState: Status von Tag
* Sex: Geschlecht
* InfoText: Text auf Tag
* EmployeeQualifications: Array aller Qualifikationen
* DayPlanSymbol: Abwesenheit auf Tag (nur Planungscodes mit Typ "Abwesenheit")
* EmployeeEmailAddress: Email
* DayShift1: Dienst 1 auf Tag
* EmployeePhoneNumber: Telefonnummer
* DayShift2: Dienst 2 auf Tag
* EmployeeSocialInsurance: Sozialversicherungsnummer
* DayRequestKind: Aufgabe auf Tag
* EmployeeStreet: Straße
* DayTotalMinutesComputed: Total in Minuten aus Status
* EmployeeCity: Stadt
* DayIntervals: Array aller Kommt/Geht-Zeiten
* PostalCode: Postleitzahl
* From: Komme
* ForNation: Land
* To: Gehe
* EmployeeLastEmployedFrom: Eintritt
* DayIntervalPlanSymbol: Abwesenheit auf Kommt/Geht (nur Planungscodes mit Typ "Abwesenheit")
* EmployeeLastEmployedTo: Austritt
* DayIntervalInfoText: Text auf Kommt/Geht


= Beispiel =
= Beispiel =
[[Datei:EmployeeDayIntervalsExample.txt]]
 
{
  "Employees": [
    {
      "EmployeeID": "123",
      "Surname": "Mayr",
      "Forename": "Max",
      "DayOfBirth": "01.01.1981",
      "EmployeeSignature": "MYM",
      "Sex": "m├ñnnlich",
      "MasterAllocation": "S1",
      "EmployeeJobGroup": "Berufsgruppe1",
      "EmployeeQualifications": [
        "SP",
        "V"
      ],
      "EmployeeEmailAddress": "mayr@mail.com",
      "EmployeePhoneNumber": "07252 / 82 68 5",
      "EmployeeSocialInsurance": "1234",
      "EmployeeStreet": "Gleinkergasse 50",
      "EmployeeCity": "Steyr",
      "PostalCode": "4400",
      "ForNation": "├ûsterreich",
      "EmployeeLastEmployedFrom": "01.08.2020",
      "EmployeeLastEmployedTo": "31.12.2099"
    },
    {
      "EmployeeID": "345",
      "Surname": "Huber",
      "Forename": "Franz",
      "DayOfBirth": "01.02.1983",
      "EmployeeSignature": "HUF",
      "Sex": "m├ñnnlich",
      "MasterAllocation": "S1",
      "EmployeeJobGroup": "Berufsgruppe1",
      "EmployeeQualifications": [
        "SP"
      ],
      "EmployeeEmailAddress": "huber@mail.com",
      "EmployeePhoneNumber": "07252 / 4400 12345",
      "EmployeeSocialInsurance": "4321",
      "EmployeeStreet": "Fischergasse 22",
      "EmployeeCity": "Steyr",
      "PostalCode": "4400",
      "ForNation": "├ûsterreich",
      "EmployeeLastEmployedFrom": "01.08.2020",
      "EmployeeLastEmployedTo": "31.12.2099"
    },
    {
      "EmployeeID": "567",
      "Surname": "M├╝ller",
      "Forename": "Hilde",
      "DayOfBirth": "09.03.1985",
      "EmployeeSignature": "MUH",
      "Sex": "weiblich",
      "MasterAllocation": "S2",
      "EmployeeJobGroup": "Berufsgruppe1",
      "EmployeeQualifications": [
        "V"
      ],
      "EmployeeEmailAddress": "mueller@mail.com",
      "EmployeePhoneNumber": "0732 / 4010 98765",
      "EmployeeSocialInsurance": "9999",
      "EmployeeStreet": "Kirchengasse 57",
      "EmployeeCity": "Linz",
      "PostalCode": "4010",
      "ForNation": "├ûsterreich",
      "EmployeeLastEmployedFrom": "01.08.2020",
      "EmployeeLastEmployedTo": "31.12.2099"
    }
  ]
}




[[Kategorie:Neu ab Version 2018.04]]
[[Kategorie:Neu ab Version 2020.20]]

Version vom 24. August 2020, 14:27 Uhr


Konfiguration für Config-File: 

, "httpServicePlugins" :
 { "0" : "Bfx.Alex.Model.dll"
 }
, "serverDaemonPlugins" :
 { "0" : "Bfx.HTTP.Server.dll"
 }

Aufruf

http://IP:PORT/GetEmployees?PARAMETER
  • IP: Wie im ALEX-Config-File eingestellt
  • HTTP-Server-PORT: Wie im ALEX-Config-File eingestellt
  • PARAMETER:
    • "from": Begin-Datum des Datenauszuges Format "DD.MM.YYYY"
    • "end": Ende-Datum des Datenauszuges Format "DD.MM.YYYY"

Beispiel

Personal von 05.12.2017 bis einschließlich 07.12.2017: 

http://localhost:4480/GetEmployees?from=05.12.2017&end=07.12.2017

Ergebnis

Tagesinformation im JSON-Format UTF8 codiert in der Form: 

{ "Employees" : [ 
	{ "EmployeeID" : "string"
	, "Surname" : "string"
	, "Forename" : "string"
	, "DayOfBirth" : "string"
	, "EmployeeSignature" : "string"
	, "Sex" : "string"
	, "MasterAllocation" : "string"
	, "EmployeeJobGroup" : "string"
	, "EmployeeQualifications" : [ "string" ]
	, "EmployeeEmailAddress" : "string"
	, "EmployeePhoneNumber" : "string"
	, "EmployeeSocialInsurance" : "string"
	, "EmployeeStreet" : "string"
	, "EmployeeCity" : "string"
	, "PostalCode" : "string"
	, "ForNation" : "string"
	, "EmployeeLastEmployedFrom" : "string"
	, "EmployeeLastEmployedTo" : "string" 
	}
]}

Glossar:

  • Employees: Array aller Personen
  • EmployeeID: Personalnummer
  • Surname: Zuname
  • Forename: Vorname
  • MasterAllocation: Stammplanungseinheit
  • EmployeeJobGroup: Berufsgruppe
  • DayOfBirth: Geburtstag
  • EmployeeSignature: Handzeichen
  • Sex: Geschlecht
  • EmployeeQualifications: Array aller Qualifikationen
  • EmployeeEmailAddress: Email
  • EmployeePhoneNumber: Telefonnummer
  • EmployeeSocialInsurance: Sozialversicherungsnummer
  • EmployeeStreet: Straße
  • EmployeeCity: Stadt
  • PostalCode: Postleitzahl
  • ForNation: Land
  • EmployeeLastEmployedFrom: Eintritt
  • EmployeeLastEmployedTo: Austritt

Beispiel

{
 "Employees": [
   {
     "EmployeeID": "123",
     "Surname": "Mayr",
     "Forename": "Max",
     "DayOfBirth": "01.01.1981",
     "EmployeeSignature": "MYM",
     "Sex": "männlich",
     "MasterAllocation": "S1",
     "EmployeeJobGroup": "Berufsgruppe1",
     "EmployeeQualifications": [
       "SP",
       "V"
     ],
     "EmployeeEmailAddress": "mayr@mail.com",
     "EmployeePhoneNumber": "07252 / 82 68 5",
     "EmployeeSocialInsurance": "1234",
     "EmployeeStreet": "Gleinkergasse 50",
     "EmployeeCity": "Steyr",
     "PostalCode": "4400",
     "ForNation": "Österreich",
     "EmployeeLastEmployedFrom": "01.08.2020",
     "EmployeeLastEmployedTo": "31.12.2099"
   },
   {
     "EmployeeID": "345",
     "Surname": "Huber",
     "Forename": "Franz",
     "DayOfBirth": "01.02.1983",
     "EmployeeSignature": "HUF",
     "Sex": "männlich",
     "MasterAllocation": "S1",
     "EmployeeJobGroup": "Berufsgruppe1",
     "EmployeeQualifications": [
       "SP"
     ],
     "EmployeeEmailAddress": "huber@mail.com",
     "EmployeePhoneNumber": "07252 / 4400 12345",
     "EmployeeSocialInsurance": "4321",
     "EmployeeStreet": "Fischergasse 22",
     "EmployeeCity": "Steyr",
     "PostalCode": "4400",
     "ForNation": "Österreich",
     "EmployeeLastEmployedFrom": "01.08.2020",
     "EmployeeLastEmployedTo": "31.12.2099"
   },
   {
     "EmployeeID": "567",
     "Surname": "M├╝ller",
     "Forename": "Hilde",
     "DayOfBirth": "09.03.1985",
     "EmployeeSignature": "MUH",
     "Sex": "weiblich",
     "MasterAllocation": "S2",
     "EmployeeJobGroup": "Berufsgruppe1",
     "EmployeeQualifications": [
       "V"
     ],
     "EmployeeEmailAddress": "mueller@mail.com",
     "EmployeePhoneNumber": "0732 / 4010 98765",
     "EmployeeSocialInsurance": "9999",
     "EmployeeStreet": "Kirchengasse 57",
     "EmployeeCity": "Linz",
     "PostalCode": "4010",
     "ForNation": "Österreich",
     "EmployeeLastEmployedFrom": "01.08.2020",
     "EmployeeLastEmployedTo": "31.12.2099"
   }
 ]
}
Abgerufen von „https://alexwiki.bitfactory.at/w/index.php?title=Webservice_Personalstammdaten_Export&oldid=24389“