Appointment

TMF 646

Visão Geral

A API Appointment permite a integração com a plataforma de serviços de campo da I-Systems, possibilitando consultar slots de tempo disponíveis e agendar atividades de campo de forma eficiente e padronizada.

Características

Praticidade

Operação para consulta de slots, agendamento, reagendamento e cancelamento

Agilidade

Integração com serviços de campo para garantir eficiência e visibilidade do serviço

Padrão TMForum

Adere aos padrões do TM Forum, facilitando a integração de parceiros

Notificações

Suporte a notificações de eventos para atualizações de agendamento

Pré-requisitos

Credenciais de API

Você precisa de credenciais de API ativas criadas na I-Systems para utilizar este serviço. Entre em contato com nossa equipe para obter acesso.

Recursos Disponíveis

Consulta de slots de tempo disponíveis para visitas técnicas

GET

/appointment/searchTimeSlot

Criação de agendamento para visita técnica

POST

/appointment/appointment

Reagendamento de visita técnica existente

PATCH

/appointment/appointment

Cancelamento de agendamento

DELETE

/appointment/appointment

Recuperação de informações de atividade/ordem de trabalho

GET

/appointment/appointment

Documentação

Swagger / OpenAPI

Acesse a documentação completa da API com exemplos de requisição e resposta:

Casos de Uso

Consulta de Disponibilidade

Consulte slots de tempo disponíveis para agendar visitas técnicas de campo

Agendamento de Visitas

Crie agendamentos para atividades de campo em horários disponíveis

Gestão de Agendamentos

Reagende ou cancele visitas técnicas conforme necessário

Acompanhamento de Ordens

Recupere informações detalhadas sobre ordens de trabalho e atividades de campo

Notificações

Essa API permite que a tenant receba notificações com os eventos de atualização de agendamentos realizados. Para receber esses eventos a tenant deve indicar para I-Systems as informações do canal que deseja receber as notificações desta API.

Abaixo estão listados os eventos que são enviados para o tenant via notificação.

Evento	Status	Descrição
`ACTIVITY_CREATED`	Não atribuído	Evento enviado quando a atividade é criada
`ACTIVITY_CREATED`	Atribuído	Evento enviado quando a atividade é atribuída
`IN_EXECUTION`	Em execução	Evento enviado quando a atividade passa para em execução
`ACTIVITY_DISPATCHED_WITHOUT_BOOKING`	Despachado	Notificação de mudança de status para despachado
`EN_ROUTE`	Em deslocamento	Evento enviado quando o técnico entra em deslocamento
`ACTIVITY_CONCLUDED_SUCCESSFULLY`	Concluído	Evento enviado quando a atividade é concluída
`ACTIVITY_CONCLUDED_UNSUCCESSFULLY`	Pendenciado	Evento enviado quando a atividade é pendenciada
`BOOKING_CREATED`	N/A	Notificação de agendamento de atividade
`BOOKING_RESCHEDULE`	N/A	Notificação de mudança nas datas de agendamento
`BOOKING_CANCELED`	N/A	Notificação de cancelamento de agendamento
`ACTIVITY_CANCELED`	Cancelado	Evento enviado quando a atividade é cancelada