Keine Bearbeitungszusammenfassung |
Keine Bearbeitungszusammenfassung Markierung: 2017-Quelltext-Bearbeitung |
||
| Zeile 1: | Zeile 1: | ||
{{DISPLAYTITLE:Webservice Eigenschaften Import}} | {{DISPLAYTITLE:Webservice Eigenschaften Import}} | ||
====Ab Version 2021.16 | == Allgemein == | ||
Ab Version 2021.16 können beliebige Eigenschaften (z.B. Zuname, E-Mail Adressen, etc.) über diese Webservice Schnittstelle importiert werden. | |||
==Anlegen von Objekten== | ==Anlegen von Objekten== | ||
| Zeile 77: | Zeile 72: | ||
*"status": "ok" oder "error" | *"status": "ok" oder "error" | ||
*"details": Optionale Detailinformationen bei "error" | *"details": Optionale Detailinformationen bei "error" | ||
<br /> | |||
== Bit Factory interne Zusatzinfos == | |||
[[Intern:Webservice Eigenschaften Import Aktivierung|Aktivierung]] | |||
Version vom 25. Juni 2021, 11:29 Uhr
Allgemein
Ab Version 2021.16 können beliebige Eigenschaften (z.B. Zuname, E-Mail Adressen, etc.) über diese Webservice Schnittstelle importiert werden.
Anlegen von Objekten
/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" von 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
Import von Eigenschaften
/Set ?objectType=<Objekttyp auf dem importiert wird> &indexQuery=<Index über den das Objekt gefunden wird> &matchString=<Wert für Suche auf Index> &importType=<Eigenschaft die importiert 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
Import von Email "test@example.com" bei Personal mit Personalnummer "PNR123".
/Set?objectType=Employee&indexQuery=EmployeeIDX&matchString=PNR123&importType=EmployeeEmailAddress&valueString=test@example.com
Import von Kartennummer "1234567" bei Personal mit Personalnummer "PNR123" von 01.01.2020.
/Set?objectType=Employee&indexQuery=EmployeeIDX&matchString=PNR123&importType=EmployeeCardID&valueString=1234567&keyDate=01.01.2020
Import von Zuname "Mustermann" bei Personal mit Personalnummer "PNR123" von 01.10.2020.
/Set?objectType=Employee&indexQuery=EmployeeIDX&matchString=PNR123&importType=Surname&valueString=Mustermann&keyDate=01.10.2020
Import von Vorname "Max" bei Personal mit Personalnummer "PNR123".
/Set?objectType=Employee&indexQuery=EmployeeIDX&matchString=PNR123&importType=Forname&valueString=Max
Beispiele Benutzer:
Import von Email "test@example.com" bei User mit Username "USER1".
/Set?objectType=AlexUser&indexQuery=UserX&matchString=USER1&importType=UserEmail&valueString=test@example.com
Import 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"
Diskussionen