Webservice Personalstammdaten Export: Unterschied zwischen den Versionen

Keine Bearbeitungszusammenfassung
Keine Bearbeitungszusammenfassung
Zeile 12: Zeile 12:
   }
   }


= Aufruf =  
=Aufruf=  


  http://IP:PORT/GetEmployees?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:  
** "from": Begin-Datum des Datenauszuges Format "DD.MM.YYYY"
**"from": 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"


== Beispiel ==  
 
Personal welches mit "Löschen umschalten" versteckt wurde ist nicht im Ergebnis enthalten.
 
==Beispiel==  


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/GetEmployees?from=05.12.2017&end=07.12.2017</nowiki>
  <nowiki>http://localhost:4480/GetEmployees?from=05.12.2017&end=07.12.2017</nowiki>


= Ergebnis =
=Ergebnis=


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:
Zeile 53: Zeile 56:
  ]}
  ]}
Glossar:
Glossar:
* Employees: Array aller Personen
* EmployeeID: Personalnummer
* Surname: Zuname
* Forename: Vorname
* MasterAllocation: Stammplanungseinheit (externes Kennzeichen wie in ALEX angegeben)
* EmployeeJobGroup: Berufsgruppe (externes Kennzeichen wie in ALEX angegeben)
* DayOfBirth: Geburtstag
* EmployeeSignature: Handzeichen
* Sex: Geschlecht
* EmployeeQualifications: Array aller Qualifikationen (externes Kennzeichen wie in ALEX angegeben)
* EmployeeEmailAddress: Email
* EmployeePhoneNumber: Telefonnummer
* EmployeeSocialInsurance: Sozialversicherungsnummer
* EmployeeStreet: Straße
* EmployeeCity: Stadt
* PostalCode: Postleitzahl
* ForNation: Land
* EmployeeLastEmployedFrom: Eintritt
* EmployeeLastEmployedTo: Austritt


= Beispiel =
*Employees: Array aller Personen
*EmployeeID: Personalnummer
*Surname: Zuname
*Forename: Vorname
*MasterAllocation: Stammplanungseinheit (externes Kennzeichen wie in ALEX angegeben)
*EmployeeJobGroup: Berufsgruppe (externes Kennzeichen wie in ALEX angegeben)
*DayOfBirth: Geburtstag
*EmployeeSignature: Handzeichen
*Sex: Geschlecht
*EmployeeQualifications: Array aller Qualifikationen (externes Kennzeichen wie in ALEX angegeben)
*EmployeeEmailAddress: Email
*EmployeePhoneNumber: Telefonnummer
*EmployeeSocialInsurance: Sozialversicherungsnummer
*EmployeeStreet: Straße
*EmployeeCity: Stadt
*PostalCode: Postleitzahl
*ForNation: Land
*EmployeeLastEmployedFrom: Eintritt
*EmployeeLastEmployedTo: Austritt
 
=Beispiel=


  {
  {
Zeile 146: Zeile 150:
   ]
   ]
  }
  }
 
[[Kategorie:Schnittstellen]]
[[Kategorie:Schnittstellen]]

Version vom 12. Mai 2021, 08:46 Uhr


Ab der Version 2020.20 gibt es die Personalstammdaten Exportschnittstelle auch als Webservice.


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"


Personal welches mit "Löschen umschalten" versteckt wurde ist nicht im Ergebnis enthalten.

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" : "DD.MM.YYYY"
	, "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 (externes Kennzeichen wie in ALEX angegeben)
  • EmployeeJobGroup: Berufsgruppe (externes Kennzeichen wie in ALEX angegeben)
  • DayOfBirth: Geburtstag
  • EmployeeSignature: Handzeichen
  • Sex: Geschlecht
  • EmployeeQualifications: Array aller Qualifikationen (externes Kennzeichen wie in ALEX angegeben)
  • 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"
   }
 ]
}