Rendez-vous ouvert : GET /sn_tmf_api/appointment/searchTimeSlot
Renvoie le créneau horaire disponible dans une période fournie pour laquelle vous pouvez réserver des rendez-vous.
Format d'URL
/api/sn_tmf_api/appointment/searchTimeSlot
Paramètres de demande pris en charge
| Nom | Description |
|---|---|
| Aucun |
| Nom | Description |
|---|---|
| start_date | Requis. Date et heure de début de la période pendant laquelle vous souhaitez rechercher le rendez-vous. Format : JJ-MM-AAAA 00:00:00. Par exemple, Type de données : chaîne |
| end_date | Requis. Date et heure de fin de la période pendant laquelle vous souhaitez rechercher le rendez-vous. Format : JJ-MM-AAAA 00:00:00. Par exemple, Type de données : chaîne |
| catalog_id | Requis. Sys_id du créateur d’enregistrement configuré avec une configuration de service de réservation de rendez-vous. Situé dans la table Créateur d’enregistrement [sc_cat_item_producer]. Type de données : chaîne |
| emplacement | Sys_id du lieu (cmn_location) du rendez-vous. Situé dans la table Emplacement [cmn_location]. Type de données : chaîne |
| opened_for | Requis. Sys_id de l’utilisateur pour lequel le rendez-vous est réservé. Table Contact [customer_contact] localisée. Type de données : chaîne |
| Nom | Description |
|---|---|
| Aucun |
En-têtes
Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.
| En-tête | Description |
|---|---|
| Accepter | Format de données du corps de la réponse. Prend uniquement en charge application/json. |
| En-tête | Description |
|---|---|
| Aucun |
Codes d'état
Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.
| Code d'état | Description |
|---|---|
| 200 | Réussi. La demande a été correctement traitée. |
| 400 | Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté. |
| 500 | Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l'erreur. |
Paramètres du corps de réponse
| Nom | Description |
|---|---|
| availableTimeSlot | Liste des créneaux de rendez-vous dans le bloc de temps spécifié demandé. Type de données : objet |
| availableTimeSlot.available | Marqueur indiquant si le créneau horaire associé est disponible. Valeurs valides :
Type de données : booléennes |
| availableTimeSlot.end_date | Date et heure de fin du rendez-vous associé. Le fuseau horaire est basé sur la valeur du paramètre time_zone. Type de données : chaîne |
| availableTimeSlot.end_date_display | Affichez la date et l’heure de fin du rendez-vous associé. Le fuseau horaire est basé sur la valeur du paramètre time_zone_display_value. Type de données : chaîne |
| availableTimeSlot.end_dateUTC | Date et heure de fin du rendez-vous associé au format d’heure UTC. Type de données : chaîne |
| availableTimeSlot.start_date | Date et heure de début du rendez-vous associé. Reflète la valeur du paramètre time_zone. Type de données : chaîne |
| availableTimeSlot.start_date_display | Affichez la date et l’heure de début du rendez-vous associé. Reflète la valeur du paramètre time_zone_display_value. Type de données : chaîne |
| availableTimeSlot.start_dateUTC | Date et heure de début du rendez-vous associé au format UTC. Type de données : chaîne |
| hasMore | Marqueur indiquant s’il existe d’autres créneaux de rendez-vous à extraire après le renvoi de la limite. Valeurs valides :
Type de données : booléennes |
| noApptAvailable | Marqueur indiquant s’il existe d’autres créneaux de rendez-vous disponibles pour la date et l’heure spécifiées. Valeurs valides :
Type de données : booléennes |
| résultat de recherche | Résultats pour la disponibilité des rendez-vous dans le créneau horaire de recherche désigné. Valeurs possibles :
Type de données : chaîne |
| statut | État d’achèvement de la recherche de créneaux horaires disponibles. Type de données : chaîne |
| Fuseau horaire | Fuseau horaire dans lequel les créneaux de rendez-vous ont été rendus. En fonction des valeurs de la configuration du service de Prise de rendez-vous. Type de données : chaîne |
Demande cURL
L’exemple de code suivant montre comment appeler ce point de terminaison.
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'Résultat :
{
"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"
}