Keine Bearbeitungszusammenfassung Markierung: 2017-Quelltext-Bearbeitung |
Markierung: 2017-Quelltext-Bearbeitung |
||
Zeile 25: | Zeile 25: | ||
/Set | /Set | ||
?objectType=<Objekttyp auf dem | ?objectType=<Objekttyp auf dem geändert wird> | ||
&indexQuery=<Index über den das Objekt gefunden wird> | &indexQuery=<Index über den das Objekt gefunden wird> | ||
&matchString=<Wert für Suche auf Index> | &matchString=<Wert für Suche auf Index> | ||
&importType=<Eigenschaft die | &importType=<Eigenschaft die geändert werden soll> | ||
&valueString=<Wert der der Eigenschaft, URL-Encoded> | &valueString=<Wert der der Eigenschaft, URL-Encoded> | ||
&keyDate=<Stichtag bei zeitlich begrenzbaren Eigenschaften> | &keyDate=<Stichtag bei zeitlich begrenzbaren Eigenschaften> |
Version vom 25. Juni 2021, 11:45 Uhr
Allgemein
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" 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
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
Ändern von Email "test@example.com" bei Personal mit Personalnummer "PNR123".
/Set?objectType=Employee&indexQuery=EmployeeIDX&matchString=PNR123&importType=EmployeeEmailAddress&valueString=test@example.com
Ändern 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
Ändern 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
Ändern von Vorname "Max" bei Personal mit Personalnummer "PNR123".
/Set?objectType=Employee&indexQuery=EmployeeIDX&matchString=PNR123&importType=Forname&valueString=Max
Beispiele Benutzer:
Ändern von Email "test@example.com" bei User mit Username "USER1".
/Set?objectType=AlexUser&indexQuery=UserX&matchString=USER1&importType=UserEmail&valueString=test@example.com
Ändern 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"