GET ListaAgendamentos
Retorna os agendamentos agrupando-os por cliente utilizando os filtros de: chave_api*, 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/ListaAgendamentos?chave_api=chave&id_dentista=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.
Collection of ListaAgendamentosModelNome | Descrição | Tipo | Informações adicionais |
---|---|---|---|
cliente | string |
Nenhuma. |
|
agendamentos | Collection of Agendamento |
Nenhuma. |
Formatos da Resposta
application/json, text/json
Sample:
[ { "cliente": "sample string 1", "agendamentos": [ { "id_agenda": 1, "hora": "2025-05-11T14:37:47.5592788-03:00", "frequencia": "sample string 2", "ocorrencia": "sample string 3", "observacao": "sample string 4", "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": 1, "hora": "2025-05-11T14:37:47.5592788-03:00", "frequencia": "sample string 2", "ocorrencia": "sample string 3", "observacao": "sample string 4", "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" } } ] }, { "cliente": "sample string 1", "agendamentos": [ { "id_agenda": 1, "hora": "2025-05-11T14:37:47.5592788-03:00", "frequencia": "sample string 2", "ocorrencia": "sample string 3", "observacao": "sample string 4", "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": 1, "hora": "2025-05-11T14:37:47.5592788-03:00", "frequencia": "sample string 2", "ocorrencia": "sample string 3", "observacao": "sample string 4", "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:
[{"cliente":"sample string 1","agendamentos":[{"id_agenda":1,"hora":"2025-05-11T14:37:47.5592788-03:00","frequencia":"sample string 2","ocorrencia":"sample string 3","observacao":"sample string 4","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":1,"hora":"2025-05-11T14:37:47.5592788-03:00","frequencia":"sample string 2","ocorrencia":"sample string 3","observacao":"sample string 4","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"}}]},{"cliente":"sample string 1","agendamentos":[{"id_agenda":1,"hora":"2025-05-11T14:37:47.5592788-03:00","frequencia":"sample string 2","ocorrencia":"sample string 3","observacao":"sample string 4","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":1,"hora":"2025-05-11T14:37:47.5592788-03:00","frequencia":"sample string 2","ocorrencia":"sample string 3","observacao":"sample string 4","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:
<ArrayOfListaAgendamentosModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SerodontoREST.Models"> <ListaAgendamentosModel> <agendamentos> <Agendamento> <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 2</frequencia> <hora>2025-05-11T14:37:47.5592788-03:00</hora> <id_agenda>1</id_agenda> <observacao>sample string 4</observacao> <ocorrencia>sample string 3</ocorrencia> </Agendamento> <Agendamento> <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 2</frequencia> <hora>2025-05-11T14:37:47.5592788-03:00</hora> <id_agenda>1</id_agenda> <observacao>sample string 4</observacao> <ocorrencia>sample string 3</ocorrencia> </Agendamento> </agendamentos> <cliente>sample string 1</cliente> </ListaAgendamentosModel> <ListaAgendamentosModel> <agendamentos> <Agendamento> <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 2</frequencia> <hora>2025-05-11T14:37:47.5592788-03:00</hora> <id_agenda>1</id_agenda> <observacao>sample string 4</observacao> <ocorrencia>sample string 3</ocorrencia> </Agendamento> <Agendamento> <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 2</frequencia> <hora>2025-05-11T14:37:47.5592788-03:00</hora> <id_agenda>1</id_agenda> <observacao>sample string 4</observacao> <ocorrencia>sample string 3</ocorrencia> </Agendamento> </agendamentos> <cliente>sample string 1</cliente> </ListaAgendamentosModel> </ArrayOfListaAgendamentosModel>