POST Agendamentos/Agendar
Agenda um cliente existente em uma data e horário específicos, criando o horário caso não exista e agendando o cliente. Não é possível agendar em um dia que está vazio. Caso o id_ocorrencia e id_convenio não sejam informados, os valores atribuidos a eles nos parâmetros serão utilizados.
Os campos aceitos no corpo da requisição são: chave_api*, hora*, (id_dentista ou id_equipo)*, id_cliente*, id_especializacao*, tipo_agenda, id_ocorrencia, id_convenio, id_colaborador e observacao.
O id_dentista ou o id_equipo precisa ser enviado. O tipo_agenda definirá qual será utilizado, podendo assumir os seguintes valores: 1 para dentista e 2 para equipo, sendo 1 o padrão.
* Campos obrigatórios.
Informações da Requisição
Parâmetros URI
Nenhuma.
Parâmetros do Corpo
Dados do agendamento.
AgendamentosAgendarModelNome | Descrição | Tipo | Informações adicionais |
---|---|---|---|
chave_api | string |
Nenhuma. |
|
tipo_agenda | integer |
Nenhuma. |
|
hora |
Data e hora do agendamento. |
date |
Nenhuma. |
id_dentista | integer |
Nenhuma. |
|
id_equipo | string |
Nenhuma. |
|
id_cliente | integer |
Nenhuma. |
|
id_ocorrencia | integer |
Nenhuma. |
|
id_especializacao | integer |
Nenhuma. |
|
id_convenio | integer |
Nenhuma. |
|
observacao | string |
Nenhuma. |
|
id_colaborador | integer |
Nenhuma. |
Request Formats
application/json, text/json
{ "chave_api": "sample string 1", "id_empresa": 2, "tipo_agenda": 3, "hora": "2025-05-11T14:12:45.2516431-03:00", "id_dentista": 5, "id_equipo": "sample string 6", "id_cliente": 7, "id_ocorrencia": 1, "id_especializacao": 8, "id_convenio": 1, "observacao": "sample string 9", "id_colaborador": 1 }
text/html
{"chave_api":"sample string 1","id_empresa":2,"tipo_agenda":3,"hora":"2025-05-11T14:12:45.2516431-03:00","id_dentista":5,"id_equipo":"sample string 6","id_cliente":7,"id_ocorrencia":1,"id_especializacao":8,"id_convenio":1,"observacao":"sample string 9","id_colaborador":1}
application/xml, text/xml
<AgendamentosAgendarModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SerodontoREST.Models"> <chave_api>sample string 1</chave_api> <hora>2025-05-11T14:12:45.2516431-03:00</hora> <id_cliente>7</id_cliente> <id_colaborador>1</id_colaborador> <id_convenio>1</id_convenio> <id_dentista>5</id_dentista> <id_empresa>2</id_empresa> <id_equipo>sample string 6</id_equipo> <id_especializacao>8</id_especializacao> <id_ocorrencia>1</id_ocorrencia> <observacao>sample string 9</observacao> <tipo_agenda>3</tipo_agenda> </AgendamentosAgendarModel>
application/x-www-form-urlencoded
Informações da Resposta
Descrição do Recurso
Dados em JSON.
Nenhum.