WSD-Reservierungs-API für eingeladene Personen
Die Workplace Service Delivery(WSD) Eingeladene Personen Für Reservierung Die API stellt Endpunkte bereit, um eingeladene Personen zu Reservierungen hinzuzufügen, eingeladene Personen einer Reservierung abzurufen und eingeladene Personen einer Reservierung neu zuzuweisen.
Um auf diese API zuzugreifen, muss der Anrufer über die Rolle sn_wsd_Core.Workplace_user verfügen, und das Plugin „Workplace Reservation Management“ (sn_wsd_rsv) muss aktiviert sein.
Diese API wird in ausgeführt sn_wsd_rsv Namespace.
Für zusätzliche Informationen zu Workplace Reservation Management, Siehe Management Von Arbeitsplatzreservierungen .
WSD-Reservierung eingeladene Personen – GET /api/sn_wsd_rsv/wsd_reservation_Invitees/reservation/{sys_ID}
Ruft Details zu den eingeladenen Personen ab, die einer angegebenen Reservierung zugeordnet sind.
URL-Format
Versionierte URL: /api/sn_wsd_rsv/{api_Version}/wsd_reservation_Invitees/reservation/{sys_ID}
Standard-URL: /api/sn_wsd_rsv/reservation/{sys_ID}
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge |
| sys_id | SYS_ID der Reservierung, für die die Details der eingeladenen Person zurückgegeben werden sollen. Datentyp: Zeichenfolge |
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| Keine |
Kopfzeilen
Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter Unterstützte REST-API-Header .
| Kopfzeile | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
| Kopfzeile | Beschreibung |
|---|---|
| Keine |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter REST API-HTTP-Antwortcodes .
| Statuscode | Beschreibung |
|---|---|
| 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 401 | Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben. |
| 404 | Nicht gefunden. Das angeforderte Element wurde nicht gefunden. |
| 500 | Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler. |
Parameter des Antwort-Haupttexts
| Name | Beschreibung |
|---|---|
| Ergebnis | Ergebnisse für die eingeladenen Personen zurückgeben, die der angegebenen Reservierung zugeordnet sind. Datentyp: Objekt |
| result.invitees | Details zu den eingeladenen Personen, die der Reservierung zugeordnet sind. Datentyp: Array von Objekten |
| result.invitees.email | E-Mail-Adresse der eingeladenen Person. Datentyp: Zeichenfolge |
| result.invitees.firstName | Vorname der eingeladenen Person. Datentyp: Zeichenfolge |
| result.invitees.inviteeId | SYS_ID des Anwenderdatensatzes des Mitarbeiters. Datentyp: Zeichenfolge Tabelle: Benutzer [sys_user] |
| result.invitees.inviteState | Details zum aktuellen Status der eingeladenen Person für die Reservierung. Datentyp: Objekt |
| result.invitees.inviteState.displayValue | Anzeigewert für den Status der eingeladenen Person, z. B. Neu oder entfernt. Datentyp: Zeichenfolge |
| result.invitees.inviteState.value | Interner Wert für den Status der eingeladenen Person. Datentyp: Zeichenfolge |
| result.invitees.inviteeType | Typ der eingeladenen Person. Gültige Werte: (Groß-/Kleinschreibung beachten)
Datentyp: Zeichenfolge |
| result.invitees.isVIP | Kennzeichnung, die angibt, ob die eingeladene Person als VIP klassifiziert ist. Gültige Werte:
Datentyp: Boolesch |
| result.invitees.isWifiRequired | Kennzeichnung, die angibt, ob dem Besucher beim Eintritt das WLAN-Passwort mitgeteilt werden soll. Gültige Werte:
Datentyp: Boolesch |
| result.invitees.isParkingRequired | Kennzeichnung, die angibt, ob für die eingeladene Person ein Parken erforderlich ist. Gültige Werte:
Datentyp: Boolesch |
| result.invitees.lastName | Nachname der eingeladenen Person. Datentyp: Zeichenfolge |
| result.invitees.licensePlate | Nummernschild der eingeladenen Person. Datentyp: Zeichenfolge |
| result.invitees.location | Details zum Arbeitsplatzstandort der eingeladenen Person. Datentyp: Objekt |
| result.invitees.location.displayName | Anzeigename des Arbeitsplatzstandorts der eingeladenen Person, z. B. Dublin. Datentyp: Zeichenfolge |
| result.invitees.location.sysId | SYS_ID des Arbeitsplatzstandorts der eingeladenen Person. Datentyp: Zeichenfolge Tabelle: Arbeitsplatzstandort [sn_wsd_Core_Worplace_location] |
| result.invitees.name | Name der eingeladenen Person. Datentyp: Zeichenfolge |
| result.invitees.org | Organisation der eingeladenen Person. Datentyp: Zeichenfolge |
| result.invitees.parkingType | Typ des für die eingeladene Person erforderlichen Parkens. Gültige Werte: (Groß-/Kleinschreibung beachten)
Datentyp: Zeichenfolge |
| result.invitees.phoneNumber | Telefonnummer der eingeladenen Person. Datentyp: Zeichenfolge |
| result.invitees.privateNotes | Alle zusätzlichen Notizen, die von der eingeladenen Person bereitgestellt werden. Datentyp: Zeichenfolge |
| result.invitees.reservationId | SYS_ID der Reservierung, der die eingeladene Person zugeordnet ist. Datentyp: Zeichenfolge Tabelle: Arbeitsplatzreservierung [sn_wsd_rsv_reservation] |
| result.invitees.reservationInviteeId | SYS_ID des eingeladenen Reservierungsempfängers für Besucher. Datentyp: Zeichenfolge Tabelle: Eingeladener Reservierungsempfänger [sn_wsd_rsv_m2m_reservation_invitee] |
| result.invitees.title | Titel der eingeladenen Person. Datentyp: Zeichenfolge |
| result.invitees.visitorType | Typ der eingeladenen Person. Gültige Werte: (Groß-/Kleinschreibung beachten)
Datentyp: Zeichenfolge |
| Ergebnis.ReservierungId | SYS_ID der Reservierung, der die eingeladene Person zugeordnet ist. Datentyp: Zeichenfolge Tabelle: Arbeitsplatzreservierung [sn_wsd_rsv_reservation] |
| Ergebnis.ReservierungUntertyp | Untertyp des Reservierungsdatensatzes, z. B. einzeln oder mehrfach untergeordnet. Datentyp: Zeichenfolge |
| Ergebnis.Erfolg | Kennzeichnung, die angibt, ob der Anruf erfolgreich war. Mögliche Werte:
Datentyp: Boolesch |
cURL-Anforderung
Das folgende Codebeispiel zeigt, wie die eingeladenen Personen für eine Reservierung abgerufen werden.
curl
"http://instance.servicenow.com/api/sn_wsd_rsv/wsd_reservation_invitees/reservation/17979dc9536b01103cf7ddeeff7b12b3" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'
Ergebnisse zurückgeben:
{
"result": {
"success": true,
"reservationId": "17979dc9536b01103cf7ddeeff7b12b3",
"reservationSubType": "single",
"invitees": [
{
"reservationId": "17979dc9536b01103cf7ddeeff7b12b3",
"location": {
"sysId": "19efb84edb7650106c731dcd1396193c",
"displayName": "Dublin"
},
"reservationInviteeId": "1f97d58d53e701103cf7ddeeff7b129a",
"inviteeType": "employee",
"inviteState": {
"displayValue": "New",
"value": "new"
},
"inviteeId": "6816f79cc0a8016401c5a33be04be441",
"name": "System Administrator",
"email": "admin@example.com"
},
{
"reservationId": "17979dc9536b01103cf7ddeeff7b12b3",
"location": {
"sysId": "19efb84edb7650106c731dcd1396193c",
"displayName": "Dublin"
},
"reservationInviteeId": "8ee7ddc9536b01103cf7ddeeff7b1219",
"inviteeType": "employee",
"inviteState": {
"displayValue": "New",
"value": "new"
},
"inviteeId": "62826bf03710200044e0bfc8bcbe5df1",
"name": "Abel Tuter",
"email": "abel.tuter@example.com"
},
{
"reservationId": "17979dc9536b01103cf7ddeeff7b12b3",
"location": {
"sysId": "19efb84edb7650106c731dcd1396193c",
"displayName": "Dublin"
},
"reservationInviteeId": "4ae7d10d536b01103cf7ddeeff7b126b",
"inviteeType": "visitor",
"inviteState": {
"displayValue": "New",
"value": "new"
},
"inviteeId": "86e7d10d536b01103cf7ddeeff7b1267",
"firstName": "Visitor",
"lastName": "User",
"name": "Visitor User",
"email": "visitoruser@example.com",
"phoneNumber": "+919876543210",
"isVIP": true,
"parkingType": "normal_parking",
"licensePlate": "1234",
"isParkingRequired": true,
"org": "Senow",
"visitorType": "contractor",
"title": "President",
"isWifiRequired": true,
"privateNotes": "Visiting"
}
]
}
}
WSD-Reservierung eingeladene Personen: VERÖFFENTLICHEN SIE /api/sn_wsd_rsv/wsd_reservation_Invitees/reassign
Weist die angegebenen eingeladenen Personen von einer Reservierung einer anderen zu.
URL-Format
Versionierte URL: /api/sn_wsd_rsv/{api_Version}/wsd_reservation_Invitees/reassign
Standard-URL: /api/sn_wsd_rsv/wsd_reservation_Invitees/reassign
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge |
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| Reservierungs-ID | Erforderlich. SYS_ID der Reservierung, für die die eingeladenen Personen neu zugewiesen werden sollen. Datentyp: Zeichenfolge Tabelle: Arbeitsplatzreservierung [sn_wsd_rsv_reservation] |
| ReservierungEingeladene Personen | Liste der eingeladenen Personen, die der in identifizierten Reservierung neu zugewiesen werden sollen reservationIdParameter. Dadurch werden die angegebenen eingeladenen Personen aus einer früheren Reservierung entfernt, in der sie gemäß der Tabelle der eingeladenen Personen für die Reservierung vorhanden waren, und in diese Reservierung verschoben. Datentyp: Array von Zeichenfolgen Tabelle: Eingeladener Reservierungsempfänger [sn_wsd_rsv_m2m_reservation_invitee] |
Header
Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter Unterstützte REST-API-Header .
| Kopfzeile | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Anforderungstexts. Unterstützte Typen: application/json, application/xmlOder, text/xml. Standard: application/json |
| Content-Type | Datenformat des Anforderungstexts. Unterstützt nur application/json. |
| Kopfzeile | Beschreibung |
|---|---|
| Keine |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter REST API-HTTP-Antwortcodes .
| Statuscode | Beschreibung |
|---|---|
| 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 401 | Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben. |
| 404 | Nicht gefunden. Das angeforderte Element wurde nicht gefunden. |
| 500 | Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler. |
Parameter des Antwort-Haupttexts
| Name | Beschreibung |
|---|---|
| Ergebnis | Details zur Neuzuweisung der eingeladenen Person. Datentyp: Objekt |
| Ergebnis.ReservierungEinladenIds | Liste der sys_IDs der eingeladenen Reservierungsmitarbeiter, die der angegebenen Reservierung neu zugewiesen wurden. Datentyp: Array von Zeichenfolgen |
| Ergebnis.Erfolg | Kennzeichnung, die angibt, ob die eingeladenen Personen der Reservierung neu zugewiesen wurden. Mögliche Werte:
Datentyp: Boolesch |
cURL-Anforderung
Das folgende Codebeispiel zeigt, wie eingeladene Personen einer Reservierung neu zugewiesen werden.
curl "http://instance.servicenow.com/api/sn_wsd_rsv/wsd_reservation_invitees/reassign" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
\"reservationId\":\"3984e6c1532f01103cf7ddeeff7b129b\",
\"reservationInvitees\":{\"aa31427f531701103cf7ddeeff7b1243\",\"e231427f531701103cf7ddeeff7b1243\"}
}" \
--user 'username':'password'
Ergebnisse zurückgeben:
{
"result": {
"success": true,
"reservationInviteeIds": [
"aa31427f531701103cf7ddeeff7b1243",
"e231427f531701103cf7ddeeff7b1243"
]
}
}
WSD-Reservierung eingeladene Personen: VERÖFFENTLICHEN SIE /api/sn_wsd_rsv/wsd_reservation_Invitees/Submit
Fügt die angegebenen eingeladenen Personen einer angegebenen Reservierung hinzu.
URL-Format
Versionierte URL: /api/sn_wsd_rsv/{api_Version}/wsd_reservation_Invitees/Submit
Standard-URL: /api/sn_wsd_rsv/wsd_reservation_Invitees/Submit
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge |
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| Eingeladene Personen | Liste der eingeladenen Personen, die der angegebenen Reservierung hinzugefügt werden sollen. Datentyp: Objekt |
| Eingeladene.email | Erforderlich, wenn inviteeTypeIst „Besucher“. E-Mail-Adresse der eingeladenen Person. Datentyp: Zeichenfolge |
| Eingeladene Personen.Vorname | Vorname der eingeladenen Person. Datentyp: Zeichenfolge |
| invitees.inviteeId | Erforderlich, wenn inviteTypeIst „Mitarbeiter“. SYS_ID des Anwenderdatensatzes des Mitarbeiters. Datentyp: Zeichenfolge Tabelle: Benutzer [sys_user] |
| invitees.inviteeType | Erforderlich. Typ der eingeladenen Person. Gültige Werte: (Groß-/Kleinschreibung beachten)
Datentyp: Zeichenfolge |
| Eingeladene.isVIP | Kennzeichnung, die angibt, ob die eingeladene Person als VIP klassifiziert ist. Gültige Werte:
Datentyp: Boolesch |
| Eingeladene.isWifiRequired | Kennzeichnung, die angibt, ob dem Besucher beim Eintritt das WLAN-Passwort mitgeteilt werden soll. Gültige Werte:
Datentyp: Boolesch |
| Eingeladene Personen.Nachname | Nachname der eingeladenen Person. Datentyp: Zeichenfolge |
| Eingeladene.Lizenzschild | Nummernschild der eingeladenen Person. Datentyp: Zeichenfolge |
| invitees.org | Organisation der eingeladenen Person. Datentyp: Zeichenfolge |
| Eingeladene Personen.parkingType | Typ des für die eingeladene Person erforderlichen Parkens. Gültige Werte: (Groß-/Kleinschreibung beachten)
Datentyp: Zeichenfolge |
| Eingeladene Personen.Telefon | Telefonnummer der eingeladenen Person. Datentyp: Zeichenfolge |
| Eingeladene Personen.privateNotes | Alle zusätzlichen Notizen, die von der eingeladenen Person bereitgestellt werden. Datentyp: Zeichenfolge |
| Eingeladene Personen.Titel | Titel der eingeladenen Person. Datentyp: Zeichenfolge |
| Eingeladene Personen.visitorType | Typ der eingeladenen Person. Gültige Werte: (Groß-/Kleinschreibung beachten)
Datentyp: Zeichenfolge |
| Reservierungs-ID | Erforderlich. SYS_ID der Reservierung, für die die eingeladenen Personen hinzugefügt werden sollen. Datentyp: Zeichenfolge Tabelle: Arbeitsplatzreservierungen [sn_wsd_rsv_reservation] |
Header
Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter Unterstützte REST-API-Header .
| Kopfzeile | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Anforderungstexts. Unterstützte Typen: application/json, application/xmlOder, text/xml. Standard: application/json |
| Content-Type | Datenformat des Anforderungstexts. Unterstützt nur application/json. |
| Kopfzeile | Beschreibung |
|---|---|
| Keine |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter REST API-HTTP-Antwortcodes .
| Statuscode | Beschreibung |
|---|---|
| 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 401 | Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben. |
| 404 | Nicht gefunden. Das angeforderte Element wurde nicht gefunden. |
| 500 | Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler. |
Parameter des Antwort-Haupttexts
| Name | Beschreibung |
|---|---|
| Ergebnis | Ergebnis des Hinzufügens der eingeladenen Personen zur Reservierung. Datentyp: Objekt |
| Ergebnis.ReservierungId | SYS_ID der Reservierung, der die eingeladene Person hinzugefügt wurde. Datentyp: Zeichenfolge |
| Ergebnis.Erfolg | Kennzeichnung, die angibt, ob die eingeladenen Personen der Reservierung hinzugefügt wurden. Mögliche Werte:
Datentyp: Boolesch |
cURL-Anforderung
Das folgende Codebeispiel zeigt, wie Sie einer Reservierung sowohl einen Besucher als auch einen Mitarbeiter hinzufügen.
curl "http://instance.servicenow.com/api/sn_wsd_rsv/v1/wsd_reservation_invitees/submit" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{[
\"reservationId\": \"041c4a13532f01103cf7ddeeff7b12c0\",
\"invitees\": [
{
\"inviteeType\": \"employee\",
\"inviteeId\": \"62826bf03710200044e0bfc8bcbe5df1\"
},
{
\"inviteeType\": \"visitor\",
\"email\": \"visitoruser@example.com\",
\"firstName\": \"Visitor\",
\"lastName\":\"User\",
\"isVIP\":true,
\"visitorType\":\"contractor\",
\"title\": \"ServiceNow Developer\",
\"phone\": \"+91 9876543210\",
\"isWifiRequired\": true,
\"parkingType\": \"ev_parking\",
\"licensePlate\": \"TS00TS0000\",
\"org\": \"ServiceNow\",
\"privateNotes\": \"Remarks\"
}
]}" \
--user 'username':'password'
Ergebnisse zurückgeben:
{
"result": {
"success": true,
"reservationId": "17979dc9536b01103cf7ddeeff7b12b3"
}
}