---
sourceDocument: Referência de API do Xanadu
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/pt-BR/xanadu/api-reference

 Release :

    - xanadu

ft:locale :

    - pt-BR

ft:publication_title :

    - Referência de API do Xanadu

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# API de convidados de reserva do WSD

# API de convidados de reserva do WSD {#ariaid-title1}

* Versão de lançamento: Xanadu
* 
* Atualizado 1 de ago. de 2024
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 11 min. de leitura

A API de convidados de reserva Prestação de serviços no local de trabalho (WSD) fornece endpoints para adicionar convidados a reservas, buscar convidados de uma reserva e reatribuir convidados de uma reserva.
Para acessar esta API, o solicitante deve ter a função sn_wsd_core.workplace_user e o plug-in Workplace Reservation Management (sn_wsd_rsv) deve estar ativado.

Esta API é executada no namespace `sn_wsd_rsv`.

Para obter informações adicionais sobre Gestão de reservas do local de trabalho, consulte [Workplace Reservation Management](https://www.servicenow.com/docs/access?context=workplace-rsv-mgmt-feat&version=xanadu&pubname=xanadu-employee-service-management&ft:locale=en-US).

## Convidados de reserva do WSD - GET /api/sn_wsd_rsv/wsd_reservation_invitees/reservation/{sys_id} {#ariaid-title2}

Recupera detalhes sobre os convidados associados a uma reserva especificada.
<br />

### Formato da URL

URL com controle de versão: /api/sn_wsd_rsv/{api_version}/wsd_reservation_invitees/reservation/{sys_id}

URL padrão: /api/sn_wsd_rsv/reservation/{sys_id}

### Parâmetros de solicitação compatíveis

{#wsd_reserv_invite-GET-reservation__entry__2}{#wsd_reserv_invite-GET-reservation__version-RESTAPI}

| Nome | Descrição |
|-|-|
| api_version | Opcional. Versão do endpoint a ser acessada. Por exemplo, <kbd class="ph userinput">v1</kbd> ou <kbd class="ph userinput">v2</kbd>. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres |
| sys_id | Sys_id da reserva para a qual os detalhes do convidado serão retornados. Tipo de dados: cadeia de caracteres |
[Tabela 1. Parâmetros de caminho]

{#wsd_reserv_invite-GET-reservation__entry__8}

| Nome | Descrição |
|-|-|
| Nenhum(a) |   |
[Tabela 2. Parâmetros de consulta]

{#wsd_reserv_invite-GET-reservation__entry__12}

| Nome | Descrição |
|-|-|
| Nenhum(a) |   |
[Tabela 3. Parâmetros do corpo da solicitação]

### Cabeçalhos

Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte [Cabeçalhos de REST API compatíveis](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles.").
{#wsd_reserv_invite-GET-reservation__entry__16}{#wsd_reserv_invite-GET-reservation__accept-RESTAPI}

| Cabeçalho | Descrição |
|-|-|
| Aceitar | Formato de dados do corpo da resposta. Tipos compatíveis: application/json ou application/xml. Padrão: application/json |
[Tabela 4. Cabeçalhos da solicitação]

{#wsd_reserv_invite-GET-reservation__entry__20}

| Cabeçalho | Descrição |
|-|-|
| Nenhum(a) |   |
[Tabela 5. Cabeçalhos de resposta]

### Códigos de status

Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte [Códigos de resposta HTTP de REST API](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles.").
{#wsd_reserv_invite-GET-reservation__entry__24}{#wsd_reserv_invite-GET-reservation__entry-200-status-code}{#wsd_reserv_invite-GET-reservation__entry-401-status-code}{#wsd_reserv_invite-GET-reservation__entry-404-status-code}{#wsd_reserv_invite-GET-reservation__entry-500-status-code}

| Código de status | Descrição |
|-|-|
| 200 | Bem-sucedido. A solicitação foi processada com sucesso. |
| 401 | Não autorizado. As credenciais do usuário estão incorretas ou não foram aprovadas. |
| 404 | Não encontrado. O item solicitado não foi encontrado. |
| 500 | Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. A resposta contém informações adicionais sobre o erro. |
[Tabela 6. Códigos de status]

### Parâmetros do corpo da resposta

{#wsd_reserv_invite-GET-reservation__entry__34}

| Nome | Descrição |
|-|-|
| resultado | Retorna resultados para os convidados associados à reserva especificada. Tipo de dados: objeto { "result": { "invitees": [Array], "reservationId": "String", "reservationSubType": "String", "success": Boolean } } |
| resultado.convidados | Detalhes sobre os convidados associados à reserva. Tipo de dados: matriz de objetos "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 | Endereço de e-mail do convidado. Tipo de dados: cadeia de caracteres |
| resultado.convidados.primeiroNome | Nome do convidado. Tipo de dados: cadeia de caracteres |
| result.invites.inviteeId | Sys_id do registro de usuário do funcionário. Localizado na tabela Usuário \[sys_user\]. Tipo de dados: cadeia de caracteres |
| result.invitees.inviteState | Detalhes sobre o estado atual do convidado para a reserva. Tipo de dados: objeto "inviteState": { "displayValue": "String", "value": "String" } |
| result.invitees.inviteState.displayValue | Valor de exibição para o estado do convidado, como Novo ou Removido. Tipo de dados: cadeia de caracteres |
| result.invitees.inviteState.value | Valor interno para o estado do convidado. Tipo de dados: cadeia de caracteres |
| result.invites.inviteeType | Tipo de convidado. Valores válidos: (diferencia maiúsculas de minúsculas) * funcionário * visitante Tipo de dados: cadeia de caracteres |
| resultado.convidados.éVIP | Sinalizador que indica se o convidado está classificado como VIP. Valores válidos: * verdadeiro: o convidado é um VIP. * falso: o convidado não é um VIP. Tipo de dados: booliano |
| result.invitees.isWifiRequired | Sinalizador que indica se a senha do WIFI deve ser fornecida ao visitante na entrada. Valores válidos: * verdadeiro: forneça a senha do WIFI. * falso: não forneça a senha do WIFI. Tipo de dados: booliano |
| result.invitees.isEstacionamentoObrigatório | Sinalizador que indica se o convidado precisa de estacionamento. Valores válidos: * verdadeiro: estacionamento necessário. * falso: o estacionamento não é necessário. Tipo de dados: booliano |
| resultado.convidados.últimoNome | Sobrenome do convidado. Tipo de dados: cadeia de caracteres |
| result.invitees.licensePlate | Placa do veículo do convidado. Tipo de dados: cadeia de caracteres |
| resultado.convidados.local | Detalhes sobre o local de trabalho do convidado. Tipo de dados: objeto "location": { "displayName": "String", "sysId": "String" } |
| result.invitees.location.displayName | Nome de exibição do local de trabalho do convidado, como Dublin. Tipo de dados: cadeia de caracteres |
| result.invitees.location.sysId | Sys_id do local de trabalho do convidado. Localizado na tabela Local do local de trabalho \[sn_wsd_core_workplace_location\]. Tipo de dados: cadeia de caracteres |
| result.invitees.name | Nome do convidado. Tipo de dados: cadeia de caracteres |
| result.invitees.org | Organização do convidado. Tipo de dados: cadeia de caracteres |
| resultado.convidados.tipoestacionamento | Tipo de estacionamento necessário para o convidado. Valores válidos: (diferencia maiúsculas de minúsculas) * ev_estacionamento * nenhum * normal_estacionamento * van_acessível_estacionamento Tipo de dados: cadeia de caracteres |
| result.invitees.phoneNumber | Número de telefone do convidado. Tipo de dados: cadeia de caracteres |
| resultado.convidados.anotaçõesprivadas | Quaisquer anotações adicionais fornecidas pelo convidado. Tipo de dados: cadeia de caracteres |
| result.invitees.reservationId | Sys_id da reserva à qual o convidado está associado. Localizado na tabela Reserva de local de trabalho \[sn_wsd_rsv_reservation\]. Tipo de dados: cadeia de caracteres |
| result.inviteees.reservationInviteeId | Sys_id do convidado da reserva para o visitante. Localizado na tabela Convidado de reserva \[sn_wsd_rsv_m2m_reservation_invitee\]. Tipo de dados: cadeia de caracteres |
| resultado.convidados.título | Título do convidado. Tipo de dados: cadeia de caracteres |
| result.invitees.visitorType | Tipo de convidado. Valores válidos: (diferencia maiúsculas de minúsculas) * cliente * prestador de serviço * amigo_família * outros Tipo de dados: cadeia de caracteres |
| result.reservationId | Sys_id da reserva à qual o convidado está associado. Localizado na tabela Reserva de local de trabalho \[sn_wsd_rsv_reservation\]. Tipo de dados: cadeia de caracteres |
| result.reservationSubType | Subtipo do registro de reserva, como secundário único ou secundário. Tipo de dados: cadeia de caracteres |
| resultado.sucesso | Sinalizador que indica se a chamada foi bem-sucedida. Valores possíveis: * verdadeiro: a chamada do endpoint foi bem-sucedida. * falso: falha na chamada do endpoint. Tipo de dados: booliano |
[ ]

### Solicitação de cURL

O exemplo de código a seguir mostra como recuperar os convidados para uma reserva.

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

Retornar resultados:

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

## Convidados de reserva do WSD - POST /api/sn_wsd_rsv/wsd_reservation_invitees/reassign {#ariaid-title3}

Reatribui os convidados especificados de uma reserva para outra.
<br />

### Formato da URL {#wsd_reserv_invite-POST-reassign__section_dwx_myh_wtb}

URL com controle de versão: /api/sn_wsd_rsv/{api_version}/wsd_reservation_invitees/reassign

URL padrão: /api/sn_wsd_rsv/wsd_reservation_invitees/reassign

### Parâmetros de solicitação compatíveis

{#wsd_reserv_invite-POST-reassign__entry__2}{#wsd_reserv_invite-POST-reassign__version-RESTAPI}

| Nome | Descrição |
|-|-|
| api_version | Opcional. Versão do endpoint a ser acessada. Por exemplo, <kbd class="ph userinput">v1</kbd> ou <kbd class="ph userinput">v2</kbd>. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres |
[Tabela 7. Parâmetros de caminho]

{#wsd_reserv_invite-POST-reassign__entry__6}

| Nome | Descrição |
|-|-|
| Nenhum(a) |   |
[Tabela 8. Parâmetros de consulta]

{#wsd_reserv_invite-POST-reassign__entry__10}

| Nome | Descrição |
|-|-|
| ID da reserva | Obrigatório. Sys_id da reserva para a qual os convidados serão reatribuídos. Localizado na tabela Reserva de local de trabalho \[sn_wsd_rsv_reservation\]. Tipo de dados: cadeia de caracteres |
| reservaConvidados | Lista de convidados a serem reatribuídos à reserva identificada no parâmetro reservationId. Localizado na tabela Convidado de reserva \[sn_wsd_rsv_m2m_reservation_invitee\]. Isso remove os convidados especificados de uma reserva anterior na qual eles estavam presentes de acordo com a tabela de convidados da reserva e os move para esta reserva. Tipo de dados: matriz de cadeias de caracteres |
[Tabela 9. Parâmetros do corpo da solicitação]

### Cabeçalhos

Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte [Cabeçalhos de REST API compatíveis](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles.").
{#wsd_reserv_invite-POST-reassign__entry__16}{#wsd_reserv_invite-POST-reassign__accept-reserv-entry}{#wsd_reserv_invite-POST-reassign__content_type-JSON-only-entry-RESTAPI}

| Cabeçalho | Descrição |
|-|-|
| Aceitar | Formato de dados do corpo da solicitação. Tipos compatíveis: application/json, application/xml ou, text/xml. Padrão: application/json |
| Tipo de conteúdo | Formato de dados do corpo da solicitação. Oferece suporte somente a application/json. |
[Tabela 10. Cabeçalhos da solicitação]

{#wsd_reserv_invite-POST-reassign__entry__22}

| Cabeçalho | Descrição |
|-|-|
| Nenhum(a) |   |
[Tabela 11. Cabeçalhos de resposta]

### Códigos de status

Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte [Códigos de resposta HTTP de REST API](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles.").
{#wsd_reserv_invite-POST-reassign__entry__26}{#wsd_reserv_invite-POST-reassign__entry-200-status-code}{#wsd_reserv_invite-POST-reassign__entry-401-status-code}{#wsd_reserv_invite-POST-reassign__entry-404-status-code}{#wsd_reserv_invite-POST-reassign__entry-500-status-code}

| Código de status | Descrição |
|-|-|
| 200 | Bem-sucedido. A solicitação foi processada com sucesso. |
| 401 | Não autorizado. As credenciais do usuário estão incorretas ou não foram aprovadas. |
| 404 | Não encontrado. O item solicitado não foi encontrado. |
| 500 | Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. A resposta contém informações adicionais sobre o erro. |
[Tabela 12. Códigos de status]

### Parâmetros do corpo da resposta

{#wsd_reserv_invite-POST-reassign__entry__36}

| Nome | Descrição |
|-|-|
| resultado | Detalhes sobre a reatribuição do convidado. Tipo de dados: objeto "result": { "reservationInviteeIds": Array, "success": Boolean } |
| result.reservationInviteeIds | Lista de sys_ids dos convidados da reserva que foram reatribuídos à reserva especificada. Tipo de dados: matriz de cadeias de caracteres |
| resultado.sucesso | Sinalizador que indica se os convidados foram reatribuídos à reserva. Valores possíveis: * verdadeiro: os convidados foram reatribuídos com sucesso. * falso: os convidados não foram reatribuídos. Tipo de dados: booliano |
[ ]

### Solicitação de cURL

O exemplo de código a seguir mostra como reatribuir convidados a uma reserva.

    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'

Retornar resultados:

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

## Convidados de reserva do WSD - POST /api/sn_wsd_rsv/wsd_reservation_invitees/submit {#ariaid-title4}

Adiciona os convidados especificados a uma reserva especificada.
<br />

### Formato da URL

URL com controle de versões: /api/sn_wsd_rsv/{api_version}/wsd_reservation_invitees/submit

URL padrão: /api/sn_wsd_rsv/wsd_reservation_invitees/submit

### Parâmetros de solicitação compatíveis

{#wsd_reserv_invite-POST-submit__entry__2}{#wsd_reserv_invite-POST-submit__version-RESTAPI}

| Nome | Descrição |
|-|-|
| api_version | Opcional. Versão do endpoint a ser acessada. Por exemplo, <kbd class="ph userinput">v1</kbd> ou <kbd class="ph userinput">v2</kbd>. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres |
[Tabela 13. Parâmetros de caminho]

{#wsd_reserv_invite-POST-submit__entry__6}

| Nome | Descrição |
|-|-|
| Nenhum(a) |   |
[Tabela 14. Parâmetros de consulta]

{#wsd_reserv_invite-POST-submit__entry__10}{#wsd_reserv_invite-POST-submit__invitees_email-reserv-entry}{#wsd_reserv_invite-POST-submit__invitees_firstName-reserv-entry}{#wsd_reserv_invite-POST-submit__invitees_inviteeId-reserv-entry}{#wsd_reserv_invite-POST-submit__invitees_inviteeType-reserv-entry}{#wsd_reserv_invite-POST-submit__invitees_isVIP-reserv-entry}{#wsd_reserv_invite-POST-submit__invitees_isWifiRequired-reserv-entry}{#wsd_reserv_invite-POST-submit__invitees_lastName-reserv-entry}{#wsd_reserv_invite-POST-submit__invitees_licensePlate-reserv-entry}{#wsd_reserv_invite-POST-submit__invitees_org-reserv-entry}{#wsd_reserv_invite-POST-submit__invitees_parkingType-reserv-entry}{#wsd_reserv_invite-POST-submit__invitees_phone-reserv-entry}{#wsd_reserv_invite-POST-submit__invitees_privateNotes-reserv-entry}{#wsd_reserv_invite-POST-submit__invitees_title-reserv-entry}{#wsd_reserv_invite-POST-submit__invitees_type-reserv-entry}{#wsd_reserv_invite-POST-submit__reservationId-reserv-entry}

| Nome | Descrição |
|-|-|
| convidados | Lista de convidados a serem adicionados à reserva especificada. Tipo de dados: objeto "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" } ] |
| convidados.e-mail | Obrigatório quando inviteeType for "visitante". Endereço de e-mail do convidado. Tipo de dados: cadeia de caracteres |
| convidados.firstName | Nome do convidado. Tipo de dados: cadeia de caracteres |
| convidados.conviteId | Obrigatório se inviteType for "funcionário". Sys_id do registro de usuário do funcionário. Localizado na tabela Usuário \[sys_user\]. Tipo de dados: cadeia de caracteres |
| convidados.convidadoTipo | Obrigatório. Tipo de convidado. Valores válidos: (diferencia maiúsculas de minúsculas) * funcionário * visitante Tipo de dados: cadeia de caracteres |
| convidados.sãoVIP | Sinalizador que indica se o convidado está classificado como VIP. Valores válidos: * verdadeiro: o convidado é um VIP. * falso: o convidado não é um VIP. Tipo de dados: booliano |
| convidados.isWifiRequired | Sinalizador que indica se a senha do WIFI deve ser fornecida ao visitante na entrada. Valores válidos: * verdadeiro: forneça a senha do WIFI. * falso: não forneça a senha do WIFI. Tipo de dados: booliano |
| convidados.lastName | Sobrenome do convidado. Tipo de dados: cadeia de caracteres |
| convidados.placadelicença | Placa do veículo do convidado. Tipo de dados: cadeia de caracteres |
| invitees.org | Organização do convidado. Tipo de dados: cadeia de caracteres |
| convidados.estacionamentoTipo | Tipo de estacionamento necessário para o convidado. Valores válidos: (diferencia maiúsculas de minúsculas) * ev_estacionamento * nenhum * normal_estacionamento * van_acessível_estacionamento Tipo de dados: cadeia de caracteres |
| convidados.telefone | Número de telefone do convidado. Tipo de dados: cadeia de caracteres |
| convidados.anotaçõesprivadas | Quaisquer anotações adicionais fornecidas pelo convidado. Tipo de dados: cadeia de caracteres |
| convidados.título | Título do convidado. Tipo de dados: cadeia de caracteres |
| convidados.visitanteTipo | Tipo de convidado. Valores válidos: (diferencia maiúsculas de minúsculas) * cliente * prestador de serviço * amigo_família * outros Tipo de dados: cadeia de caracteres |
| ID da reserva | Obrigatório. Sys_id da reserva à qual os convidados serão adicionados. Localizado na tabela Reservas de local de trabalho \[sn_wsd_rsv_reservation\]. Tipo de dados: cadeia de caracteres |
[Tabela 15. Parâmetros do corpo da solicitação (XML ou JSON)]

### Cabeçalhos

Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte [Cabeçalhos de REST API compatíveis](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles.").
{#wsd_reserv_invite-POST-submit__entry__44}{#wsd_reserv_invite-POST-submit__accept-reserv-entry}{#wsd_reserv_invite-POST-submit__content_type-JSON-only-entry-RESTAPI}

| Cabeçalho | Descrição |
|-|-|
| Aceitar | Formato de dados do corpo da solicitação. Tipos compatíveis: application/json, application/xml ou, text/xml. Padrão: application/json |
| Tipo de conteúdo | Formato de dados do corpo da solicitação. Oferece suporte somente a application/json. |
[Tabela 16. Cabeçalhos da solicitação]

{#wsd_reserv_invite-POST-submit__entry__50}

| Cabeçalho | Descrição |
|-|-|
| Nenhum(a) |   |
[Tabela 17. Cabeçalhos de resposta]

### Códigos de status

Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte [Códigos de resposta HTTP de REST API](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles.").
{#wsd_reserv_invite-POST-submit__entry__54}{#wsd_reserv_invite-POST-submit__entry-200-status-code}{#wsd_reserv_invite-POST-submit__entry-401-status-code}{#wsd_reserv_invite-POST-submit__entry-404-status-code}{#wsd_reserv_invite-POST-submit__entry-500-status-code}

| Código de status | Descrição |
|-|-|
| 200 | Bem-sucedido. A solicitação foi processada com sucesso. |
| 401 | Não autorizado. As credenciais do usuário estão incorretas ou não foram aprovadas. |
| 404 | Não encontrado. O item solicitado não foi encontrado. |
| 500 | Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. A resposta contém informações adicionais sobre o erro. |
[Tabela 18. Códigos de status]

### Parâmetros do corpo da resposta

{#wsd_reserv_invite-POST-submit__entry__64}

| Nome | Descrição |
|-|-|
| resultado | Resultado da adição de convidados à reserva. Tipo de dados: objeto "result": { "reservationId": "String", "success": Boolean } |
| result.reservationId | Sys_id da reserva à qual o convidado foi adicionado. Tipo de dados: cadeia de caracteres |
| resultado.sucesso | Sinalizador que indica se os convidados foram adicionados à reserva. Valores possíveis: * verdadeiro: os convidados foram adicionados com sucesso. * falso: os convidados não foram adicionados. Tipo de dados: booliano |
[ ]

### Solicitação de cURL

O exemplo de código a seguir mostra como adicionar um visitante e um funcionário a uma reserva.

    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'

Retornar resultados:

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