Markierung: 2017-Quelltext-Bearbeitung |
Keine Bearbeitungszusammenfassung Markierung: 2017-Quelltext-Bearbeitung |
||
Zeile 13: | Zeile 13: | ||
===Beispiele Personal=== | ===Beispiele Personal=== | ||
Neues Personal mit Personalnummer "PNR123" | Neues Personal mit Personalnummer "PNR123" ab 01.01.2020. | ||
/New?objectType=Employee&indexQuery=EmployeeIDX&matchString=PNR123&keyDate=01.01.2020 | /New?objectType=Employee&indexQuery=EmployeeIDX&matchString=PNR123&keyDate=01.01.2020 | ||
Zeile 44: | Zeile 44: | ||
/Set?objectType=Employee&indexQuery=EmployeeIDX&matchString=PNR123&importType=EmployeeEmailAddress&valueString=test@example.com | /Set?objectType=Employee&indexQuery=EmployeeIDX&matchString=PNR123&importType=EmployeeEmailAddress&valueString=test@example.com | ||
Setzen von Kartennummer "1234567" bei Personal mit Personalnummer "PNR123" | Setzen von Kartennummer "1234567" bei Personal mit Personalnummer "PNR123" ab 01.01.2020. | ||
/Set?objectType=Employee&indexQuery=EmployeeIDX&matchString=PNR123&importType=EmployeeCardID&valueString=1234567&keyDate=01.01.2020 | /Set?objectType=Employee&indexQuery=EmployeeIDX&matchString=PNR123&importType=EmployeeCardID&valueString=1234567&keyDate=01.01.2020 | ||
Setzen von Zuname "Mustermann" bei Personal mit Personalnummer "PNR123" | Setzen von Zuname "Mustermann" bei Personal mit Personalnummer "PNR123" ab 01.10.2020. | ||
/Set?objectType=Employee&indexQuery=EmployeeIDX&matchString=PNR123&importType=Surname&valueString=Mustermann&keyDate=01.10.2020 | /Set?objectType=Employee&indexQuery=EmployeeIDX&matchString=PNR123&importType=Surname&valueString=Mustermann&keyDate=01.10.2020 | ||
Zeile 93: | Zeile 93: | ||
} | } | ||
=== | === Beispiele Personal === | ||
Setzen von Kartennummer "1234567" bei Personal mit Personalnummer "1" ab 01.01.2020. | |||
{ | { | ||
Zeile 103: | Zeile 105: | ||
"matchString": "1", | "matchString": "1", | ||
"valueString": "1234567", | "valueString": "1234567", | ||
"keyDate": "01. | "keyDate": "01.01.2020" | ||
} | |||
] | |||
} | |||
Setzen von Email "test@example.com" bei Personal mit Personalnummer "1" ab 01.01.2020. | |||
{ | |||
"objectType": "Employee", | |||
"indexQuery": "EmployeeIDX", | |||
"importType": "EmployeeEmailAddress", | |||
"lines": [ | |||
{ | |||
"matchString": "1", | |||
"valueString": "test@example.com", | |||
"keyDate": "01.01.2020" | |||
} | } | ||
] | ] |
Version vom 12. August 2021, 15:00 Uhr
Ab Version 2021.16 können beliebige Objekte angelegt und deren Eigenschaften (z.B. Zuname, E-Mail Adressen, etc.) über diese Webservice Schnittstelle geändert werden.
Objekt anlegen
/New ?objectType=<Objekttyp des neuen Objektes> &indexQuery=<Index für Verifizierung> &matchString=<Wert für Suche auf Index> &keyDate=<Stichtag bei zeitlich begrenzbaren Eigenschaften>
Beispiele Personal
Neues Personal mit Personalnummer "PNR123" ab 01.01.2020.
/New?objectType=Employee&indexQuery=EmployeeIDX&matchString=PNR123&keyDate=01.01.2020
Beispiele Benutzer
Neuer Benutzer mit Username "USER1"
/New?objectType=AlexUser&indexQuery=UserX&matchString=USER1
Objekt ändern
/Set ?objectType=<Objekttyp auf dem geändert wird> &indexQuery=<Index über den das Objekt gefunden wird> &matchString=<Wert für Suche auf Index> &importType=<Eigenschaft die geändert werden soll> &valueString=<Wert der der Eigenschaft, URL-Encoded> &keyDate=<Stichtag bei zeitlich begrenzbaren Eigenschaften>
Format für Datum:
DD.MM.YYYY
Ergebnis:
Enthält eine etwaige Fehlermeldung.
Beispiele Personal
Beim Setzen von zeitlich abgrenzbaren Eigenschaften von Personal wird der Beginn automatisch begrenzt mit 'Ist bis'.
Setzen von Email "test@example.com" bei Personal mit Personalnummer "PNR123".
/Set?objectType=Employee&indexQuery=EmployeeIDX&matchString=PNR123&importType=EmployeeEmailAddress&valueString=test@example.com
Setzen von Kartennummer "1234567" bei Personal mit Personalnummer "PNR123" ab 01.01.2020.
/Set?objectType=Employee&indexQuery=EmployeeIDX&matchString=PNR123&importType=EmployeeCardID&valueString=1234567&keyDate=01.01.2020
Setzen von Zuname "Mustermann" bei Personal mit Personalnummer "PNR123" ab 01.10.2020.
/Set?objectType=Employee&indexQuery=EmployeeIDX&matchString=PNR123&importType=Surname&valueString=Mustermann&keyDate=01.10.2020
Setzen von Vorname "Max" bei Personal mit Personalnummer "PNR123".
/Set?objectType=Employee&indexQuery=EmployeeIDX&matchString=PNR123&importType=Forname&valueString=Max
Beispiele Benutzer
Setzen von Email "test@example.com" bei User mit Username "USER1".
/Set?objectType=AlexUser&indexQuery=UserX&matchString=USER1&importType=UserEmail&valueString=test@example.com
Setzen von Username "USER1NEU" bei User mit Username "USER1".
/Set?objectType=AlexUser&indexQuery=UserX&matchString=USER1&importType=Username&valueString=USER1NEU
Ausgabe
Json-Objekt in der Form:
{ "request" : "" , "status" : "" , "details" : "" }
- "request": Angeforderter Request als "Handshake"
- "status": "ok" oder "error"
- "details": Optionale Detailinformationen bei "error"
Dateiimport
Der Pfad für die Importfiles kann in den Systemeinstellungen in der Gruppe Object Import Einstellungen
im Property Eigenschaften-Import Pfad
. Die gewünschte Dateierweiterung kann im Property Eigenschaften-Import Dateierweiterung
eingestellt werden.
Format für Datei
{ "objectType": "string", "indexQuery": "string", "importType": "string", "lines": [ { "matchString": "string", "valueString": "string", "keyDate": "DD.MM.YYYY" } ] }
Beispiele Personal
Setzen von Kartennummer "1234567" bei Personal mit Personalnummer "1" ab 01.01.2020.
{ "objectType": "Employee", "indexQuery": "EmployeeIDX", "importType": "EmployeeCardID", "lines": [ { "matchString": "1", "valueString": "1234567", "keyDate": "01.01.2020" } ] }
Setzen von Email "test@example.com" bei Personal mit Personalnummer "1" ab 01.01.2020.
{ "objectType": "Employee", "indexQuery": "EmployeeIDX", "importType": "EmployeeEmailAddress", "lines": [ { "matchString": "1", "valueString": "test@example.com", "keyDate": "01.01.2020" } ] }