GET Agendamentos
Retorna os agendamentos utilizando os filtros de: chave_api*, id_cliente*, data_inicial*, data_final*, tipo_agenda, id_dentista, id_equipo, id_convenio e id_especializacao.
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.
Exemplo: https://api.serodonto.com.br/agendamentos?chave_api=chave&id_dentista=1&id_cliente=1&data_inicial=2000-04-15&data_final=2000-04-20&id_convenio=1&id_especializacao=1
* Filtros obrigatórios.
Informações da Requisição
Parâmetros URI
Nenhuma.
Parâmetros do Corpo
Nenhum.
Informações da Resposta
Descrição do Recurso
Dados em JSON.
AgendamentosResultModelNome | Descrição | Tipo | Informações adicionais |
---|---|---|---|
id_empresa | integer |
Nenhuma. |
|
cliente | ClientesBaseModel |
Nenhuma. |
|
agendamentos | Collection of AgendamentosModel |
Nenhuma. |
Formatos da Resposta
application/json, text/json
Sample:
{ "id_empresa": 1, "cliente": { "identificador": "faad9743-bc3c-4b8e-bee3-c26ad4911dd1", "id_cliente": 1, "nome_completo": "sample string 2", "cpf": "sample string 3", "sexo": "sample string 4", "telefone": "sample string 5", "data_nascimento": "2025-05-11T16:25:50.662541-03:00", "email": "sample string 6" }, "agendamentos": [ { "id_agenda_primeiro": 1, "id_agenda_ultimo": 1, "hora": "2025-05-11T16:25:50.6635417-03:00", "hora_final": "2025-05-11T16:25:50.6635417-03:00", "frequencia": "sample string 3", "ocorrencia": "sample string 4", "observacao": "sample string 5", "dentista": { "id_dentista": 1, "nome_tratamento": "sample string 2", "identificador": "sample string 3", "tipo": 4 }, "equipo": { "id_dentista": 1, "nome_tratamento": "sample string 2", "identificador": "sample string 3", "tipo": 4 }, "especializacao": { "id_especializacao": 1, "especializacao": "sample string 2" }, "convenio": { "id_convenio": 1, "convenio": "sample string 2" } }, { "id_agenda_primeiro": 1, "id_agenda_ultimo": 1, "hora": "2025-05-11T16:25:50.6635417-03:00", "hora_final": "2025-05-11T16:25:50.6635417-03:00", "frequencia": "sample string 3", "ocorrencia": "sample string 4", "observacao": "sample string 5", "dentista": { "id_dentista": 1, "nome_tratamento": "sample string 2", "identificador": "sample string 3", "tipo": 4 }, "equipo": { "id_dentista": 1, "nome_tratamento": "sample string 2", "identificador": "sample string 3", "tipo": 4 }, "especializacao": { "id_especializacao": 1, "especializacao": "sample string 2" }, "convenio": { "id_convenio": 1, "convenio": "sample string 2" } } ] }
text/html
Sample:
{"id_empresa":1,"cliente":{"identificador":"faad9743-bc3c-4b8e-bee3-c26ad4911dd1","id_cliente":1,"nome_completo":"sample string 2","cpf":"sample string 3","sexo":"sample string 4","telefone":"sample string 5","data_nascimento":"2025-05-11T16:25:50.662541-03:00","email":"sample string 6"},"agendamentos":[{"id_agenda_primeiro":1,"id_agenda_ultimo":1,"hora":"2025-05-11T16:25:50.6635417-03:00","hora_final":"2025-05-11T16:25:50.6635417-03:00","frequencia":"sample string 3","ocorrencia":"sample string 4","observacao":"sample string 5","dentista":{"id_dentista":1,"nome_tratamento":"sample string 2","identificador":"sample string 3","tipo":4},"equipo":{"id_dentista":1,"nome_tratamento":"sample string 2","identificador":"sample string 3","tipo":4},"especializacao":{"id_especializacao":1,"especializacao":"sample string 2"},"convenio":{"id_convenio":1,"convenio":"sample string 2"}},{"id_agenda_primeiro":1,"id_agenda_ultimo":1,"hora":"2025-05-11T16:25:50.6635417-03:00","hora_final":"2025-05-11T16:25:50.6635417-03:00","frequencia":"sample string 3","ocorrencia":"sample string 4","observacao":"sample string 5","dentista":{"id_dentista":1,"nome_tratamento":"sample string 2","identificador":"sample string 3","tipo":4},"equipo":{"id_dentista":1,"nome_tratamento":"sample string 2","identificador":"sample string 3","tipo":4},"especializacao":{"id_especializacao":1,"especializacao":"sample string 2"},"convenio":{"id_convenio":1,"convenio":"sample string 2"}}]}
application/xml, text/xml
Sample:
<AgendamentosResultModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SerodontoREST.Models"> <agendamentos> <AgendamentosModel> <convenio> <convenio>sample string 2</convenio> <id_convenio>1</id_convenio> </convenio> <dentista> <id_dentista>1</id_dentista> <identificador>sample string 3</identificador> <nome_tratamento>sample string 2</nome_tratamento> <tipo>4</tipo> </dentista> <equipo> <id_dentista>1</id_dentista> <identificador>sample string 3</identificador> <nome_tratamento>sample string 2</nome_tratamento> <tipo>4</tipo> </equipo> <especializacao> <especializacao>sample string 2</especializacao> <id_especializacao>1</id_especializacao> </especializacao> <frequencia>sample string 3</frequencia> <hora>2025-05-11T16:25:50.6635417-03:00</hora> <hora_final>2025-05-11T16:25:50.6635417-03:00</hora_final> <id_agenda_primeiro>1</id_agenda_primeiro> <id_agenda_ultimo>1</id_agenda_ultimo> <observacao>sample string 5</observacao> <ocorrencia>sample string 4</ocorrencia> </AgendamentosModel> <AgendamentosModel> <convenio> <convenio>sample string 2</convenio> <id_convenio>1</id_convenio> </convenio> <dentista> <id_dentista>1</id_dentista> <identificador>sample string 3</identificador> <nome_tratamento>sample string 2</nome_tratamento> <tipo>4</tipo> </dentista> <equipo> <id_dentista>1</id_dentista> <identificador>sample string 3</identificador> <nome_tratamento>sample string 2</nome_tratamento> <tipo>4</tipo> </equipo> <especializacao> <especializacao>sample string 2</especializacao> <id_especializacao>1</id_especializacao> </especializacao> <frequencia>sample string 3</frequencia> <hora>2025-05-11T16:25:50.6635417-03:00</hora> <hora_final>2025-05-11T16:25:50.6635417-03:00</hora_final> <id_agenda_primeiro>1</id_agenda_primeiro> <id_agenda_ultimo>1</id_agenda_ultimo> <observacao>sample string 5</observacao> <ocorrencia>sample string 4</ocorrencia> </AgendamentosModel> </agendamentos> <cliente> <cpf>sample string 3</cpf> <data_nascimento>2025-05-11T16:25:50.662541-03:00</data_nascimento> <email>sample string 6</email> <id_cliente>1</id_cliente> <identificador>faad9743-bc3c-4b8e-bee3-c26ad4911dd1</identificador> <nome_completo>sample string 2</nome_completo> <sexo>sample string 4</sexo> <telefone>sample string 5</telefone> </cliente> <id_empresa>1</id_empresa> </AgendamentosResultModel>