WSD 예약 초대 대상자 API

워싱턴 DC API 참조

Release

washingtondc

ft:locale

ko-KR

ft:publication_title

워싱턴 DC API 참조

ft:clusterId

crapiref

bundleId

crapiref

workflow

Creator

WSD 예약 초대 대상자 API

릴리스 버전: Washingtondc

업데이트 날짜 2024년 02월 01일

읽기21분

(WSD) 예약 초대 대상자 API는 Workplace Service Delivery 예약에 초대 대상자를 추가하고, 예약의 초대 대상자를 가져오고, 예약 초대 대상자를 재할당할 수 있는 엔드포인트를 제공합니다.

이 API에 액세스하려면 호출자에게 sn_wsd_core.workplace_user 역할이 있어야 하며 Workplace Reservation Management(sn_wsd_rsv) 플러그인이 활성화되어 있어야 합니다.

이 API는 sn_wsd_rsv 네임스페이스에서 실행됩니다.

에 대한 Workplace Reservation Management자세한 내용은 Workplace Reservation Management를 참조하십시오.

WSD 예약 초대 대상자 - GET /api/sn_wsd_rsv/wsd_reservation_invitees/reservation/{sys_id}

지정된 예약과 연결된 초대 대상자에 대한 상세 정보를 조회합니다.

URL 형식

버전이 지정된 URL: /api/sn_wsd_rsv/{api_version}/ wsd_reservation_invitees/reservation/{sys_id}

기본 URL: / api/sn_wsd_rsv/reservation/{sys_id}

지원되는 요청 매개변수

표 1. 경로 매개변수
이름	설명
api_version	옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들면 `v1` 또는 `v2`입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다. 데이터 유형: 문자열
sys_id	초대 대상자 상세 정보를 반환할 예약의 Sys_id입니다. 데이터 유형: 문자열

표 2. 쿼리 매개변수
이름	설명
없음

표 3. 요청 본문 매개변수
이름	설명
없음

헤더

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

표 4. 요청 헤더
헤더	설명
수용	응답 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다. 기본값: application/json

표 5. 응답 헤더
헤더	설명
없음

상태 코드

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

표 6. 상태 코드
상태 코드	설명
200	성공입니다. 요청이 성공적으로 처리되었습니다.
401	승인되지 않았습니다. 사용자 자격 증명이 잘못되었거나 전달되지 않았습니다.
404	찾을 수 없습니다. 요청한 항목을 찾을 수 없습니다.
500	내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다.

응답 본문 매개변수


이름	설명
결과	지정된 예약과 연결된 초대 대상자에 대한 결과를 반환합니다. 데이터 유형: 객체 `{ "result": { "invitees": [Array], "reservationId": "String", "reservationSubType": "String", "success": Boolean } }`
결과.초대받은 사람	예약과 연결된 초대 대상자에 대한 상세 정보입니다. 데이터 유형: 객체 배열 `"invitees": [ { "email": "String", "firstName": "String", "inviteeId": "String", "inviteState": {Object}, "inviteeType": "String", "isVIP": Boolean, "isWifiRequired": Boolean, "isParkingRequired": Boolean, "lastName": "String", "licensePlate": "String", "location": {Object}, "name": "String", "org": "String", "parkingType": "String", "phoneNumber": "String", "privateNotes": "String", "reservationId": "String", "reservationInviteeId": "String", "title": "String", "visitorType": "String" } ]`
result.invitees.email	초대 대상자의 이메일 주소입니다. 데이터 유형: 문자열
result.invitees.firstName	초대 대상자의 이름입니다. 데이터 유형: 문자열
result.invitees.inviteeId	직원의 사용자 기록 Sys_id입니다. 사용자 [sys_user] 테이블에 있습니다. 데이터 유형: 문자열
result.invitees.inviteState	예약에 대한 초대 대상자의 현재 상태에 대한 세부 정보입니다. 데이터 유형: 객체 `"inviteState": { "displayValue": "String", "value": "String" }`
result.invitees.inviteState.displayValue	초대 대상자 상태(예: 신규 또는 제거됨)의 표시 값입니다. 데이터 유형: 문자열
result.invitees.inviteState.value	초대 대상자 상태에 대한 내부 값입니다. 데이터 유형: 문자열
result.invitees.inviteeType	초대 대상자 유형입니다. 유효한 값은 다음과 같습니다. (대/소문자 구분) 직원 visitor 데이터 유형: 문자열
result.invitees.isVIP	초대 대상자가 VIP로 분류되었는지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다. true: 초대 대상자가 VIP입니다. false: 초대 대상자가 VIP가 아닙니다. 데이터 유형: 부울
result.invitees.isWifiRequired	입장 시 방문자에게 WIFI 암호를 제공해야 하는지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다. true: WIFI 비밀번호를 제공합니다. false: WIFI 비밀번호를 제공하지 않습니다. 데이터 유형: 부울
result.invitees.isParkingRequired	초대 대상자가 주차를 필요로 하는지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다. true: 주차가 필요합니다. false: 주차가 필요 없습니다. 데이터 유형: 부울
result.invitees.lastName	초대 대상자의 성입니다. 데이터 유형: 문자열
result.invitees.licensePlate	초대 대상자의 차량 번호입니다. 데이터 유형: 문자열
결과.초대 대상자.위치	초대 대상자의 직장 위치에 대한 세부 정보입니다. 데이터 유형: 객체 `"location": { "displayName": "String", "sysId": "String" }`
result.invitees.location.displayName	초대 대상자의 직장 위치를 더블린처럼 표시하는 이름입니다. 데이터 유형: 문자열
result.invitees.location.sysId	초대 대상자 직장 위치의 Sys_id입니다. 직장 위치[sn_wsd_core_worplace_location] 테이블에 있습니다. 데이터 유형: 문자열
result.invitees.name	초대 대상자의 이름입니다. 데이터 유형: 문자열
result.invitees.org	초대 대상자의 조직입니다. 데이터 유형: 문자열
result.초대 대상자 parkingType	초대 대상자에 필요한 주차 유형입니다. 유효한 값은 다음과 같습니다. (대/소문자 구분) ev_parking normal_parking 없음 van_accessible_parking 데이터 유형: 문자열
result.invitees.phoneNumber	초대 대상자의 전화 번호입니다. 데이터 유형: 문자열
결과.초대 대상자 .privateNotes	초대 대상자가 제공한 추가 메모입니다. 데이터 유형: 문자열
result.초대 대상자 예약 ID	초대 대상자가 연결된 예약의 Sys_id입니다. 직장 예약[sn_wsd_rsv_reservation] 테이블에 있습니다. 데이터 유형: 문자열
result.invitees.reservationInviteeId	방문자에 대한 예약 초대 대상자의 Sys_id입니다. 예약 초대 대상자 [sn_wsd_rsv_m2m_reservation_invitee] 테이블에 있습니다. 데이터 유형: 문자열
결과.초대 대상자 .제목	초대 대상자의 직함입니다. 데이터 유형: 문자열
result.invitees.visitorType	초대 대상자 유형입니다. 유효한 값은 다음과 같습니다. (대/소문자 구분) 클라이언트 계약자 friend_family 기타 데이터 유형: 문자열
result.reservationId	초대 대상자가 연결된 예약의 Sys_id입니다. 직장 예약[sn_wsd_rsv_reservation] 테이블에 있습니다. 데이터 유형: 문자열
result.reservationSubType	예약 기록의 하위 유형입니다(예: 미혼 또는 복수). 데이터 유형: 문자열
결과.성공	호출이 성공했는지 여부를 나타내는 플래그입니다. 가능한 값: true: 엔드포인트 호출이 성공했습니다. false: 엔드포인트 호출이 실패했습니다. 데이터 유형: 부울

cURL 요청

다음 코드 예제에서는 예약에 대한 초대 대상자를 검색하는 방법을 보여 줍니다.

curl 
"http://instance.servicenow.com/api/sn_wsd_rsv/wsd_reservation_invitees/reservation/17979dc9536b01103cf7ddeeff7b12b3" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

반환 결과:

{
  "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 예약 초대 대상자 - POST /api/sn_wsd_rsv/wsd_reservation_invitees/reassign

지정된 초대 대상자를 한 예약에서 다른 예약으로 재할당합니다.

URL 형식

버전이 지정된 URL: / api/sn_wsd_rsv/{api_version}/wsd_reservation_invitees/reassign

기본 URL: / api/sn_wsd_rsv/wsd_reservation_invitees/reassign

지원되는 요청 매개변수

표 7. 경로 매개변수
이름	설명
api_version	옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들면 `v1` 또는 `v2`입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다. 데이터 유형: 문자열

표 8. 쿼리 매개변수
이름	설명
없음

표 9. 요청 본문 매개변수
이름	설명
예약 ID	필수 초대 대상을 재할당할 예약의 Sys_id입니다. 직장 예약[sn_wsd_rsv_reservation] 테이블에 있습니다. 데이터 유형: 문자열
예약초대 대상자	매개변수에서 식별 reservationId 된 예약에 재할당할 초대 대상자의 목록입니다. 예약 초대 대상자 [sn_wsd_rsv_m2m_reservation_invitee] 테이블에 있습니다. 이렇게 하면 예약 초대 대상자 테이블에 따라 있었던 이전 예약에서 지정된 초대 대상자가 제거되고 이 예약으로 이동합니다. 데이터 유형: 문자열 배열

헤더

표 10. 요청 헤더
헤더	설명
수용	요청 본문의 데이터 형식입니다. 지원되는 유형: application/json, 또는, text/xmlapplication/xml . 기본값: application/json
컨텐츠-형식	요청 본문의 데이터 형식입니다. application/json만 지원합니다.

표 11. 응답 헤더
헤더	설명
없음

상태 코드

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

표 12. 상태 코드
상태 코드	설명
200	성공입니다. 요청이 성공적으로 처리되었습니다.
401	승인되지 않았습니다. 사용자 자격 증명이 잘못되었거나 전달되지 않았습니다.
404	찾을 수 없습니다. 요청한 항목을 찾을 수 없습니다.
500	내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다.

응답 본문 매개변수


이름	설명
결과	초대 대상자 재할당에 대한 세부 정보입니다. 데이터 유형: 객체 `"result": { "reservationInviteeIds": Array, "success": Boolean }`
result.reservationInviteeIds	지정된 예약에 재할당된 예약 초대 대상자의 sys_ids 목록입니다. 데이터 유형: 문자열 배열
결과.성공	초대 대상자가 예약에 재할당되었는지 여부를 나타내는 플래그입니다. 가능한 값: true: 초대 대상자가 성공적으로 재할당되었습니다. false: 초대 대상자가 재할당되지 않았습니다. 데이터 유형: 부울

cURL 요청

다음 코드 예제에서는 초대 대상을 예약에 다시 할당하는 방법을 보여 줍니다.

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'

반환 결과:

{
  "result": {
    "success": true,
    "reservationInviteeIds": [
      "aa31427f531701103cf7ddeeff7b1243",
      "e231427f531701103cf7ddeeff7b1243"
    ]
  }
}

WSD 예약 초대 대상자 - POST /api/sn_wsd_rsv/wsd_reservation_invitees/submit

지정된 예약에 지정된 초대 대상자를 추가합니다.

URL 형식

버전이 지정된 URL: / api/sn_wsd_rsv/{api_version}/wsd_reservation_invitees/submit

기본 URL: / api/sn_wsd_rsv/wsd_reservation_invitees/submit

지원되는 요청 매개변수

표 13. 경로 매개변수
이름	설명
api_version	옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들면 `v1` 또는 `v2`입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다. 데이터 유형: 문자열

표 14. 쿼리 매개변수
이름	설명
없음

표 15. 요청 본문 매개변수(XML 또는 JSON)
이름	설명
초대	지정된 예약에 추가할 초대 대상자의 목록입니다. 데이터 유형: 객체 `"invitees": [ { "email": "String", "firstName": "String", "inviteeId": "String", "inviteeType": "String", "isVIP": Boolean, "isWifiRequired": Boolean, "lastName": "String", "licensePlate": "String", "org": "String", "parkingType": "String", "phone": "String", "privateNotes": "String", "title": "String", "visitorType": "String" } ]`
invitees.email	"방문자"인 경우 inviteeType 필요합니다. 초대 대상자의 이메일 주소입니다. 데이터 유형: 문자열
초대 대상자 이름.	초대 대상자의 이름입니다. 데이터 유형: 문자열
초대 대상자 초대 대상자 ID	"직원"인 경우 inviteType 필요합니다. 직원의 사용자 기록 Sys_id입니다. 사용자 [sys_user] 테이블에 있습니다. 데이터 유형: 문자열
invitees.inviteeType	필수 초대 대상자 유형입니다. 유효한 값은 다음과 같습니다. (대/소문자 구분) 직원 visitor 데이터 유형: 문자열
초대 대상자 isVIP	초대 대상자가 VIP로 분류되었는지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다. true: 초대 대상자가 VIP입니다. false: 초대 대상자가 VIP가 아닙니다. 데이터 유형: 부울
invitees.isWifiRequired	입장 시 방문자에게 WIFI 암호를 제공해야 하는지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다. true: WIFI 비밀번호를 제공합니다. false: WIFI 비밀번호를 제공하지 않습니다. 데이터 유형: 부울
초대받은 사람.성	초대 대상자의 성입니다. 데이터 유형: 문자열
초대받은 사람.licensePlate	초대 대상자의 차량 번호입니다. 데이터 유형: 문자열
invitees.org	초대 대상자의 조직입니다. 데이터 유형: 문자열
초대 대상자 .parkingType	초대 대상자에 필요한 주차 유형입니다. 유효한 값은 다음과 같습니다. (대/소문자 구분) ev_parking normal_parking 없음 van_accessible_parking 데이터 유형: 문자열
초대받은 사람.전화	초대 대상자의 전화 번호입니다. 데이터 유형: 문자열
초대 대상자 .privateNotes	초대 대상자가 제공한 추가 메모입니다. 데이터 유형: 문자열
초대 대상.제목	초대 대상자의 직함입니다. 데이터 유형: 문자열
초대 대상.방문자 유형	초대 대상자 유형입니다. 유효한 값은 다음과 같습니다. (대/소문자 구분) 클라이언트 계약자 friend_family 기타 데이터 유형: 문자열
예약 ID	필수 초대 대상을 추가할 예약의 Sys_id입니다. 직장 예약[sn_wsd_rsv_reservation] 테이블에 있습니다. 데이터 유형: 문자열

헤더

표 16. 요청 헤더
헤더	설명
수용	요청 본문의 데이터 형식입니다. 지원되는 유형: application/json, 또는, text/xmlapplication/xml . 기본값: application/json
컨텐츠-형식	요청 본문의 데이터 형식입니다. application/json만 지원합니다.

표 17. 응답 헤더
헤더	설명
없음

상태 코드

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

표 18. 상태 코드
상태 코드	설명
200	성공입니다. 요청이 성공적으로 처리되었습니다.
401	승인되지 않았습니다. 사용자 자격 증명이 잘못되었거나 전달되지 않았습니다.
404	찾을 수 없습니다. 요청한 항목을 찾을 수 없습니다.
500	내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다.

응답 본문 매개변수


이름	설명
결과	초대 대상자를 예약에 추가한 결과입니다. 데이터 유형: 객체 `"result": { "reservationId": "String", "success": Boolean }`
result.reservationId	초대 대상자가 추가된 예약의 Sys_id입니다. 데이터 유형: 문자열
결과.성공	초대 대상자가 예약에 추가되었는지 여부를 나타내는 플래그입니다. 가능한 값: true: 초대 대상자가 성공적으로 추가되었습니다. false: 초대 대상자가 추가되지 않았습니다. 데이터 유형: 부울

cURL 요청

다음 코드 예제에서는 예약에 방문자와 직원을 모두 추가하는 방법을 보여 줍니다.

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'

반환 결과:

{
  "result": {
    "success": true,
    "reservationId": "17979dc9536b01103cf7ddeeff7b12b3"
  }
}