1. Listar Sobreaviso
Endpoint:
GET https://api1.tradingworks.net/v1/oncall
Parâmetros (opcionais):
Language— define o idioma dos campos retornados:'en-US'(padrão)'pt-BR'— retorna os nomes de propriedade em português.
FromDate— data de início da pesquisa. Se não informado, retorna os últimos 7 dias (D-7).ToDate— data de término da pesquisa. Se não informado, considera os próximos 30 dias (D+30).
(Limite de 180 dias entre FromDate e ToDate.)
Headers:
AUTH-TOKEN: sua_chave_privada
Exemplo (Português):
GET https://api1.tradingworks.net/v1/oncall?Language=pt-BR&fromdate=2020-09-01&todate=2020-09-30
Resposta:
{
"OnCallID":28617,
"Matricula":"9002472",
"DataBase":"2021-03-15T00:00:00",
"DeHora":"2021-03-15T18:00:00",
"AteHora":"2021-03-16T08:00:00"
}Exemplo (Inglês):
GET https://api1.tradingworks.net/v1/oncall?fromdate=2020-09-01&todate=2020-09-30
Resposta:
{
"OnCallID":28617,
"EmployeeNumber":"9002472",
"BaseDate":"2021-03-15T00:00:00",
"FromTime":"2021-03-15T18:00:00",
"ToTime":"2021-03-16T08:00:00"
}2. Tabela de Campos Esperados (GET /oncall)
Campo | Tipo | Requerido | Exemplo | Observações |
Language | string | Não | "pt-BR" | Define idioma dos campos retornados |
FromDate | DATE | Não | "2020-09-01" | Início do período; padrão: D-7 |
ToDate | DATE | Não | "2020-09-30" | Fim do período; padrão: D+30 |
3. Dicas e Observações
Intervalo máximo: o período entre
FromDateeToDatenão pode exceder 180 dias.Campos em português vs. inglês:
pt-BR:"Matricula","DataBase","DeHora","AteHora"en-US:"EmployeeNumber","BaseDate","FromTime","ToTime"
Uso de token: todo acesso requer um token válido no cabeçalho.
Não existem endpoints para inclusão, edição ou remoção de sobreaviso via API— apenas listagem.