| Índice |
|---|
| Dica |
|---|
Só são suportadas integrações no padrão REST. |
...
Endpoint | Método | Header Content-Type | Descrição | ||
|---|---|---|---|---|---|
http://exemplo.com/ / gravarConsulta
| POST | application/json | Endpoint para listar os registros de consultas relacionadas ao localizador (chaveUnica) |
...
| Bloco de código |
|---|
url:
https://www.operadoradesaude.com.br/mobilesaude/minhasConsultas/gravarConsulta
Body:
{
"chaveUnica":"101012",
"integracao":{
"xpto":"voluptatibus",
"xyz":"quibusdam",
"abcdef":9288701
},
"tipoAgenda":"1",
"paciente":{
"chaveUnica":"101012",
"numeroContrato":"616161",
"integracao":{
"xpto":"voluptatibus",
"xyz":"quibusdam",
"abcdef":9288701
}
},
"responsavelAtendimento":{
"chaveUnica":"3321",
"numeroContrato":"444456789",
"integracao":{
"xpto":"voluptatibus",
"xyz":"quibusdam",
"abcdef":9288701
}
},
"dadosContato:":{
"nome":"Nome do contato",
"celular":"289999999999",
"email":"email@teste.com"
},
"idEspecialidade":"716171919",
"idLocal":"818181",
"idProfissional":"81818",
"idAgenda":"123123",
"dataHora":"2022-02-01 11:30:00"
} |
Descrição dos objetos e atributos de retorno - Sucesso
Está indicado abaixo a estrutura de retorno do método. Esse método deve obedecer as regras indicadas no objeto principal e em seus desdobramentos.
Objeto principal
Atributo | Obrigatório | Tipo | Descrição |
|---|---|---|---|
paciente | M | Objeto | Objeto com dados do paciente |
profissional | M | Objeto profissional | Objeto com dados do profissional |
agenda | M | Objeto agenda | Objeto com dados da agenda |
numeroProtocolo | M | String | Numero do protocolo gerado pelo agendamento |
Objeto paciente
Atributo | Obrigatório | Tipo | Descrição |
|---|---|---|---|
nome | M | String | Nome do paciente |
chaveUnica | M | String | Chave unica do paciente |
telefone | M | String | Telefone do paciente |
Objeto profissional
Atributo | Obrigatório | Tipo | Descrição |
|---|---|---|---|
id | M | String | Id do profissional |
nome | M | String | Telefone do paciente |
conselho | M | String | Texto de informação do conselho do profissional |
especialidade | M | Objeto especialidade | Objeto com dados da especialidade do profissional |
Objeto especialidade
Atributo | Obrigatório | Tipo | Descrição |
|---|---|---|---|
id | M | String | Id da especialidade |
descricao | M | String | Texto de descrição da especialidade |
Objeto agenda
Atributo | Critério | Tipo | Descrição | Regra de preenchimento |
|---|---|---|---|---|
idAgenda | M | String | id da agenda |
|
dataHora |
|
| Data e hora disponível | Deve conter dia e hora. Formato: YYYY-MM-DD hh:mm:ss |
Retorno da API - Sucesso
| Bloco de código | ||
|---|---|---|
| ||
{
"numeroProtocolo":"001002003004005",
"paciente":{
"chaveUnica":"123123",
"nome":"Nome paciente",
"telefone":"27 99999-9999"
},
"profissional":{
"id":"1231231",
"nome":"Dr João Silva",
"conselho":"CRM-ES 123123",
"especialidade":{
"id":"123123",
"descricao":"Cardiologia"
}
},
"agenda":{
"idAgenda":"123123",
"dataHora":"2022-02-01 14:00:00"
}
}
|
Retorno da API - Falha
| Aviso |
|---|
|