---
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 turno do WSD

# API de turno 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) 3 min. de leitura

A API de turnoPrestação de serviços no local de trabalho (WSD) fornece um endpoint que retorna períodos de tempo de turno para uma data e hora especificadas.
Para acessar esta API, o solicitante deve ter a função sn_wsd_core.workplace_user e os plug-ins Workplace Safety Management (sn_wsd_core) e Workplace Reservation Management (sn_wsd_rsv) devem estar ativados.

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).

## Turno do WSD -- GET /api/sn_wsd_rsv/wsd_shift/{shift_id}/timespan {#ariaid-title2}

Retorna o período de tempo do turno para uma data/hora e turno especificados.
<br />

### Formato da URL

URL com controle de versão: /api/sn_wsd_rsv/{api_version}/wsd_shift/{shift_id}/timespan

URL padrão: /api/sn_wsd_rsv/wsd_shift/{shift_id}/timespan

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

{#wsd_shift-GET-timespan__entry__2}{#wsd_shift-GET-timespan__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 |
| shift_id | Sys_id do turno para o qual o intervalo de tempo será recuperado. Localizado na tabela Turno \[sn_wsd_core_shift\]. Para obter informações adicionais sobre reservas baseadas em turno, consulte [Habilitar reserva baseada em turno](https://www.servicenow.com/docs/access?context=wsd-reservation-setup&version=xanadu&pubname=xanadu-employee-service-management&ft:locale=en-US). Tipo de dados: cadeia de caracteres |
[Tabela 1. Parâmetros de caminho]

{#wsd_shift-GET-timespan__entry__8}

| Nome | Descrição |
|-|-|
| tentativa_anterior_início | Sinalizador que indica se uma hora de início antecipada deve ser definida se o valor de início especificado estiver dentro do período de tempo do turno. Valores válidos: * verdadeiro: se o turno especificado incluir a data/hora especificada no parâmetro start, retorne a data/hora de início especificada como o início do período de tempo. * falso: retorna o intervalo de tempo do turno conforme definido no registro associado. Tipo de dados: booliano Padrão: falso |
| iniciar | Obrigatório. Data e hora do início dos períodos de tempo do turno a serem retornados. Formato: UTC - yyyy-mm-ddThh:mm:ssZ, como 2022-05-23T08:00:00Z |
| fuso horário | Fuso horário a ser usado ao qualificar os períodos de tempo do turno, como ECT ou PST. Também retorna os períodos de tempo do turno neste fuso horário. Formato: UTC Tipo de dados: cadeia de caracteres Padrão: fuso horário do usuário |
[Tabela 2. Parâmetros de consulta]

{#wsd_shift-GET-timespan__entry__16}

| 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_shift-GET-timespan__entry__20}{#wsd_shift-GET-timespan__accept-reserv-entry}

| 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 |
[Tabela 4. Cabeçalhos da solicitação]

{#wsd_shift-GET-timespan__entry__24}

| 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_shift-GET-timespan__entry__28}{#wsd_shift-GET-timespan__entry-200-status-code}{#wsd_shift-GET-timespan__entry-401-status-code}{#wsd_shift-GET-timespan__entry-404-status-code}{#wsd_shift-GET-timespan__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_shift-GET-timespan__entry__38}

| Nome | Descrição |
|-|-|
| resultado | Detalhes sobre o intervalo de tempo do turno que correspondeu aos critérios de pesquisa. Tipo de dados: objeto "result":{ "end": "String", "start": "String" } |
| resultado.término | Data e hora de término do intervalo de tempo do turno no fuso horário especificado. Formato: UTC: aaaa-mm-ddThh:mm:ssZ, como 2022-05-23T08:00:00Z Tipo de dados: cadeia de caracteres |
| resultado.início | Data e hora de início do intervalo de tempo do turno no fuso horário especificado. Formato: UTC: aaaa-mm-ddThh:mm:ssZ, como 2022-05-23T08:00:00Z Tipo de dados: cadeia de caracteres |
[ ]

### Solicitação de cURL

O exemplo de código a seguir mostra como recuperar o intervalo de tempo de um turno.

    curl "https://instance.servicenow.com/api/sn_wsd_rsv/wsd_shift/e5d23acfdb42a01097acc9003996193a/timespan?attempt_earlier_start=true&start=2022-05-23T08:00:00Z&timezone=ECT" \
    --request GET \
    --header "Accept:application/json" \
    --user "username":"password"

Retornar resultados:

    {
      "result": {
        "start": "2022-05-23T08:00:00Z",
        "end": "2022-05-23T15:00:00Z"
      }
    }