--- sourceDocument: Xanadu-API-Referenz sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/de-DE/xanadu/api-reference Release : - xanadu ft:locale : - de-DE ft:publication_title : - Xanadu-API-Referenz ft:clusterId : - crapiref bundleId : - crapiref workflow : - Creator --- # Termin offen: GET /sn_tmf_api/appointment/searchTimeSlot # Termin offen: GET /sn_tmf_api/appointment/searchTimeSlot {#ariaid-title1} * Freigeben Version: Xanadu * * Aktualisiert 1. August 2024 * * ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 3 Minuten Lesedauer Gibt das verfügbare Zeitfenster innerhalb eines angegebenen Zeitraums zurück, für das Sie Termine buchen können. ## URL-Format /api/sn_tmf_api/appointment/searchTimeSlot ## Unterstützte Anforderungsparameter {#apptOpen-GET-searchTimeSlot__table_fb3_nwt_dcc__entry__2} | Name | Beschreibung | |-|-| | Keine | | [Tabelle : 1. Pfadparameter] {#apptOpen-GET-searchTimeSlot__table_fb3_nwt_dcc} {#apptOpen-GET-searchTimeSlot__entry__6}{#apptOpen-GET-searchTimeSlot__serviceTest-response-testMeasureDefinition.thresholdRule.consequence.validFor.startDateTime}{#apptOpen-GET-searchTimeSlot__serviceTest-response-testMeasureDefinition.thresholdRule.consequence.validFor.endDateTime} | Name | Beschreibung | |-|-| | start_date | Erforderlich. Startdatum und -uhrzeit des Zeitraums, in dem Sie nach dem Termin suchen möchten. Format: JJJJ-MM-TT 00:00:00. Beispiel: `2025-01-31 09:00:00`. Datentyp: Zeichenfolge | | end_date | Erforderlich. Enddatum und -uhrzeit des Zeitraums, in dem Sie nach dem Termin suchen möchten. Format: JJJJ-MM-TT 00:00:00. Beispiel: `2025-01-31 12:00:00`. Datentyp: Zeichenfolge | | catalog_id | Erforderlich. Sys_id des Datensatzerstellers, der mit einer Konfiguration für einen Terminbuchungsservice konfiguriert ist. Befindet sich in der Tabelle „Datensatzersteller" \[sc_cat_item_producer\]. Datentyp: Zeichenfolge | | location | Sys_id des Standorts (cmn_location) des Termins. Befindet sich in der Standorttabelle \[cmn_location\]. Datentyp: Zeichenfolge | | opened_for | Erforderlich. Sys_id des Anwenders, für den der Termin gebucht wird. Tabelle „Gefundener Kontakt" \[customer_contact\]. Datentyp: Zeichenfolge | [Tabelle : 2. Abfrageparameter] {#apptOpen-GET-searchTimeSlot__entry__18} | Name | Beschreibung | |-|-| | Keine | | [Tabelle : 3. Anforderungstextparameter] ## 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](https://servicenow-prod.fluidtopics.net/bHLogaRspC43ztA1sd~MJg "REST (REpresentational State Transfer) ist eine einfache zustandslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, sodass sie leichter miteinander kommunizieren können."). {#apptOpen-GET-searchTimeSlot__entry__22}{#apptOpen-GET-searchTimeSlot__accept-JSON-only-entry-RESTAPI} | Kopfzeile | Beschreibung | |-|-| | Akzeptieren | Datenformat des Antworttexts. Unterstützt nur application/json. | [Tabelle : 4. Anforderungskopfzeilen] {#apptOpen-GET-searchTimeSlot__entry__26} | Kopfzeile | Beschreibung | |-|-| | Keine | | [Tabelle : 5. Antwortkopfzeilen] ## 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 [HTTP-Antwortcodes](https://servicenow-prod.fluidtopics.net/bHLogaRspC43ztA1sd~MJg "REST (REpresentational State Transfer) ist eine einfache zustandslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, sodass sie leichter miteinander kommunizieren können.")der REST-API. {#apptOpen-GET-searchTimeSlot__entry__30}{#apptOpen-GET-searchTimeSlot__entry-200-status-code}{#apptOpen-GET-searchTimeSlot__entry-400-status-code}{#apptOpen-GET-searchTimeSlot__entry-500-status-code} | Statuscode | Beschreibung | |-|-| | 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. | | 400 | Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt. | | 500 | Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler. | [Tabelle : 6. Statuscodes] ## Parameter des Antwort-Haupttexts {#apptOpen-GET-searchTimeSlot__entry__38} | Name | Beschreibung | |-|-| | VerfügbaresZeitfenster | Liste der Terminfenster innerhalb des angegebenen angeforderten Zeitblocks Datentyp: Objekt 'availableTimeSlot': [ { 'available': Boolean, 'end_date': 'String', 'end_date_display': 'String', 'end_dateUTC': 'String', 'start_date': 'String', 'start_date_display': 'String', 'start_dateUTC': 'String', } ] | | VerfügbaresZeitfenster.verfügbar | Kennzeichnung, die angibt, ob das zugeordnete Zeitfenster verfügbar ist. Gültige Werte: * wahr: Zeitfenster ist verfügbar. * „falsch": Zeitfenster ist nicht verfügbar. {#apptOpen-GET-searchTimeSlot__ul_nf5_mvb_2cc} Datentyp: Boolesch | | VerfügbareZeitSlot.Enddatum | Enddatum und -uhrzeit des zugeordneten Termins. Die Zeitzone basiert auf dem Wert im Parameter „time_zone". Datentyp: Zeichenfolge | | availableTimeSlot.end_date_display | Zeigt Enddatum und -uhrzeit des zugeordneten Termins an. Die Zeitzone basiert auf dem Wert im Parameter „time_zone_display_value". Datentyp: Zeichenfolge | | availableTimeSlot.end_dateUTC | Enddatum und -uhrzeit des zugeordneten Termins im UTC-Zeitformat. Datentyp: Zeichenfolge | | VerfügbareZeitSlot.start_date | Startdatum und -uhrzeit des zugeordneten Termins. Entspricht dem Wert des Parameters „time_zone". Datentyp: Zeichenfolge | | availableTimeSlot.start_date_display | Zeigt Startdatum und -uhrzeit des zugeordneten Termins an. Entspricht dem Wert des Parameters „time_zone_display_value". Datentyp: Zeichenfolge | | availableTimeSlot.start_dateUTC | Startdatum und -uhrzeit des zugeordneten Termins im UTC-Zeitformat. Datentyp: Zeichenfolge | | hasMore | Kennzeichnung, die angibt, ob nach der Rückgabe des Grenzwerts weitere Terminfenster zum Abrufen vorhanden sind. Gültige Werte: * wahr: Weitere Terminfenster können abgerufen werden. * „falsch": Es sind keine Terminfenster mehr verfügbar. {#apptOpen-GET-searchTimeSlot__ul_rqd_bwb_2cc} Datentyp: Boolesch | | noApptAvailable | Kennzeichnung, die angibt, ob für das angegebene Datum und die angegebene Uhrzeit weitere Terminfenster verfügbar sind. Gültige Werte: * wahr: Für das angegebene Datum und die angegebene Uhrzeit sind weitere Terminfenster verfügbar. * „falsch": Für den angegebenen Zeitpunkt (Datum/Uhrzeit) sind keine Terminfenster mehr verfügbar. {#apptOpen-GET-searchTimeSlot__ul_jc4_cwb_2cc} Datentyp: Boolesch | | searchResult | Ergebnisse für Terminverfügbarkeit innerhalb des angegebenen Suchzeitfensters. Mögliche Werte: * Erfolg * fehlgeschlagen {#apptOpen-GET-searchTimeSlot__ul_vkp_jzb_2cc} Datentyp: Zeichenfolge | | status | Abschlussstatus der Suche nach verfügbaren Zeitfenstern. Datentyp: Zeichenfolge | | Zeitzone | Zeitzone, in der die Terminfenster gerendert wurden. Basierend auf den Werten in der Konfiguration des Terminbuchungsservice. Datentyp: Zeichenfolge | [ ] ## cURL-Anforderung Das folgende Codebeispiel zeigt, wie dieser Endpunkt aufgerufen wird. curl --location --request GET 'https://instance.service-now.com/api/sn_tmf_api/appointment/searchTimeSlot? start_date=2024-07-10 09:00:00&end_date=2024-07-20 23:00:00&catalog_id=ada50a93f0220210f8776517d8c8e776& opened_for=51670151c35420105252716b7d40ddfe&location=f48b21850a0a0ba7004182b18099696d ' \ --user 'username':'password' Ergebnis: { "searchResult": "success", "status": "done", "availableTimeSlot": [ { "start_date": "2024-07-10 09:00:00", "end_date": "2024-07-10 12:00:00", "start_date_display": "09:00", "end_date_display": "12:00", "start_dateUTC": "2024-07-10 16:00:00", "end_dateUTC": "2024-07-10 19:00:00", "available": false },... { "start_date": "2024-07-11 13:00:00", "end_date": "2024-07-11 16:00:00", "start_date_display": "13:00", "end_date_display": "16:00", "start_dateUTC": "2024-07-11 20:00:00", "end_dateUTC": "2024-07-11 23:00:00", "available": true }, { "start_date": "2024-07-12 09:00:00", "end_date": "2024-07-12 12:00:00", "start_date_display": "09:00", "end_date_display": "12:00", "start_dateUTC": "2024-07-12 16:00:00", "end_dateUTC": "2024-07-12 19:00:00", "available": true }, { "start_date": "2024-07-12 13:00:00", "end_date": "2024-07-12 16:00:00", "start_date_display": "13:00", "end_date_display": "16:00", "start_dateUTC": "2024-07-12 20:00:00", "end_dateUTC": "2024-07-12 23:00:00", "available": true },... { "start_date": "2024-07-19 13:00:00", "end_date": "2024-07-19 16:00:00", "start_date_display": "13:00", "end_date_display": "16:00", "start_dateUTC": "2024-07-19 20:00:00", "end_dateUTC": "2024-07-19 23:00:00", "available": true } ], "hasMore": false, "noApptAvailable": false, "timeZone": "US/Arizona" }