약속 오픈 - GET /sn_tmf_api/약속/searchTimeSlot

  • 릴리스 버전: Xanadu
  • 업데이트 날짜 2024년 08월 01일
  • 읽기7분

    • 약속을 예약할 수 있는 제공된 기간 내에서 사용 가능한 시간 슬롯을 반환합니다.

    URL 형식

    /api/sn_tmf_api/약속/searchTimeSlot

    지원되는 요청 매개변수

    표 1. 경로 매개변수
    이름 설명
    없음
    표 2. 쿼리 매개변수
    이름 설명
    start_date 필수 약속을 검색하려는 기간의 시작 날짜 및 시간입니다.

    형식: YYYY-MM-DD 00:00:00. 예: 2025-01-31 09:00:00.

    데이터 유형: 문자열
    end_date 필수 약속을 검색하려는 기간의 종료 날짜 및 시간입니다.

    형식: YYYY-MM-DD 00:00:00. 예: 2025-01-31 12:00:00.

    데이터 유형: 문자열
    catalog_id 필수 약속 예약 서비스 구성으로 구성된 기록 생성자의 Sys_id입니다. 기록 생성자 [sc_cat_item_producer] 테이블에 있습니다.

    데이터 유형: 문자열
    위치 약속 위치(cmn_location)의 Sys_id입니다. 위치 [cmn_location] 테이블에 있습니다.

    데이터 유형: 문자열
    opened_for 필수 약속을 예약할 사용자의 Sys_id입니다. 연락처 [customer_contact] 테이블을 찾았습니다.

    데이터 유형: 문자열
    표 3. 요청 본문 매개변수
    이름 설명
    없음

    헤더

    다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.

    표 4. 요청 헤더
    헤더 설명
    수용 응답 본문의 데이터 형식입니다. application/json만 지원합니다.
    표 5. 응답 헤더
    헤더 설명
    없음

    상태 코드

    다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.

    표 6. 상태 코드
    상태 코드 설명
    200 성공입니다. 요청이 성공적으로 처리되었습니다.
    400 잘못된 요청입니다. 잘못된 요청 유형 또는 잘못된 형식의 요청이 탐지되었습니다.
    500 내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다.

    응답 본문 매개변수

    이름 설명
    availableTimeSlot (사용 가능한 시간 슬롯) 요청된 지정된 시간 블록 내의 약속 슬롯 목록입니다.

    데이터 유형: 객체

    'availableTimeSlot': [
 { 
  'available': Boolean,
  'end_date': 'String',
  'end_date_display': 'String',
  'end_dateUTC': 'String',
  'start_date': 'String',
  'start_date_display': 'String',
  'start_dateUTC': 'String',
 }
]
    availableTimeSlot.available 연결된 시간 슬롯을 사용할 수 있는지 여부를 나타내는 플래그입니다.
    유효한 값은 다음과 같습니다.
    • true: 시간 슬롯을 사용할 수 있습니다.
    • false: 시간 슬롯을 사용할 수 없습니다.

    데이터 유형: 부울
    availableTimeSlot.end_date 연결된 약속의 종료 날짜 및 시간입니다. 시간대는 time_zone 매개변수의 값을 기반으로 합니다.

    데이터 유형: 문자열
    availableTimeSlot.end_date_display 연결된 약속의 종료 날짜 및 시간을 표시합니다. 시간대는 time_zone_display_value 매개변수의 값을 기반으로 합니다.

    데이터 유형: 문자열
    availableTimeSlot.end_dateUTC 연결된 약속의 종료 날짜 및 시간(UTC 시간 형식)입니다.

    데이터 유형: 문자열
    availableTimeSlot.start_date 연결된 약속의 시작 날짜 및 시간입니다. time_zone 매개변수의 값을 반영합니다.

    데이터 유형: 문자열
    availableTimeSlot.start_date_display 연결된 약속의 시작 날짜 및 시간을 표시합니다. time_zone_display_value 매개변수의 값을 반영합니다.

    데이터 유형: 문자열
    availableTimeSlot.start_dateUTC 연결된 약속의 시작 날짜 및 시간(UTC 시간 형식)입니다.

    데이터 유형: 문자열
    hasMore 제한을 반환한 후 가져올 약속 슬롯이 더 있는지 여부를 나타내는 플래그입니다.
    유효한 값은 다음과 같습니다.
    • true: 더 많은 약속 슬롯을 가져올 수 있습니다.
    • false: 사용할 수 있는 약속 슬롯이 없습니다.

    데이터 유형: 부울
    noApptAvailable 지정된 날짜 및 시간에 사용할 수 있는 약속 슬롯이 더 있는지 여부를 나타내는 플래그입니다.
    유효한 값은 다음과 같습니다.
    • true: 지정된 날짜 및 시간에 더 많은 약속 슬롯을 사용할 수 있습니다.
    • false: 지정된 날짜 및 시간에 사용할 수 있는 약속 슬롯이 없습니다.

    데이터 유형: 부울
    검색 결과 지정된 검색 시간 슬롯 내의 약속 가용성에 대한 결과입니다.
    가능한 값:
    • 성공
    • 실패

    데이터 유형: 문자열
    상태 사용 가능한 시간 슬롯에 대한 검색의 완료 상태입니다.

    데이터 유형: 문자열
    시간대 약속 슬롯이 렌더링된 시간대입니다. 약속 예약 서비스 구성의 값을 기준으로 합니다.

    데이터 유형: 문자열

    cURL 요청

    다음 코드 예제에서는 이 끝점을 호출하는 방법을 보여 줍니다.

    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'

    결과:

    {
  "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"
}