Formatos de dados

Esta documentação define os formatos padrão de dados utilizados em toda a API, para garantir consistência e evitar repetição nas especificações.

Data

Formato: YYYY-MM-DD

A especificação utiliza datas no formato ISO 8601, seguindo o padrão de data internacional.

Toda e qualquer entidade que possua um campo de data deve utilizar esse formato.

Exemplos:

• 2025-01-15 - 15 de janeiro de 2025
• 1990-12-31 - 31 de dezembro de 1990
• 2024-02-29 - 29 de fevereiro de 2024 (ano bissexto)

Hora

Formato: HH:mm

A especificação de hora utiliza o formato local não qualificado, do padrão ISO 8601. Ou seja, sem os segundos e sem o qualificador de fuso horário.

Toda e qualquer entidade que possua um campo de hora deve utilizar esse formato.

Exemplos:

• 09:00 - 9 horas da manhã
• 14:30 - 2 horas e 30 minutos da tarde
• 23:59 - 11 horas e 59 minutos da noite

Intervalo de hora

Formato:

{
  "start": "HH:mm",
  "end": "HH:mm"
}

O intervalo de hora é um objeto que representa um intervalo de tempo. Hoje é usado para representar um intervalo de hora disponível, no endpoint de Agenda.

O formato de hora no start e end é o mesmo do formato de hora especificado acima.

Exemplos:

• {"start": "09:00", "end": "10:00"} - Intervalo de 1 hora, de 9:00 até 10:00
• {"start": "14:30", "end": "15:30"} - Intervalo de 1 hora, de 14:30 até 15:30

ID

Formato: string

Identificador único alfanumérico. Pode conter letras, números e hífens. Espaços não são permitidos.

Toda e qualquer entidade que possua um campo de ID deve utilizar esse formato.

Exemplos:

• 123
• abc-def-456
• client_789

Telefone

Formato: string

Número de telefone no formato internacional, sem formatação adicional. No caso do Brasil, o formato internacional é equivalente a: DDI + DDD + telefone. Por exemplo, o número 5551912341234 é representado por:

DDI	DDD	Resto
55	51	912341234

Exemplos:

• 5511999999999 - Telefone brasileiro (DDI 55 + DDD 11 + número)
• 1234567890 - Telefone internacional

Estado de agendamento

Formato: string

Estes são os valores enumerados (enums) de estado de agendamento definidos no nosso sistema.

O sistema de terceiros pode possuir mais, menos ou diferentes estados possíveis. A responsabilidade de mapear e garantir a equivalência entre os estados do sistema de terceiros e os estados definidos do nosso lado é do integrador.

Possíveis valores:

• WAITING - Aguardando
• CONFIRMED - Confirmado
• REJECTED - Rejeitado/Cancelado
• SHOW - Compareceu
• NO_SHOW - Não compareceu