1- Objeto “raiz” do retorno
Campos | Tipo | Descrição |
---|---|---|
| boolean | Status do response, indica se todo o processo ocorreu corretamente para o retorno. Retorno vazio também se caracteriza status TRUE. |
| object | Objeto que reúne todo o conjunto de dados |
2- Objeto “data” do retorno
Campos | Tipo | Descrição |
---|---|---|
| object | Objeto com informações do médico |
| object | Objeto com informações do agendamento |
3- Objeto “profissional” do retorno
Campos | Tipo | Descrição |
---|---|---|
| string | Nome do médico |
| string | Número do conselho do médico |
| string | Sigla do conselho do médico |
| string | UF do conselho do médico |
| string | Especialidade do médico |
| string | CPF/CNPJ do médico |
| string | ID do médico |
4- Objeto “agenda” do retorno
Campos | Tipo | Descrição |
---|---|---|
| string | ID do local de atendimento |
| string | Nome do local de atendimento |
| array | Retorno de agendamentos |
5- Objeto “horario” do retorno do array “horarios“
Campos | Tipo | Descrição |
---|---|---|
| string | ID da agenda |
| string | Data do agendamento (aaaa-mm-dd) |
| array | Hora do agendamento (hh:mm) |
| object | Objeto com informações do paciente |
| object | Objeto com informações do Mensageria |
| object | Objeto com informações do status do agendamento |
| object | Objeto com informações da especialidade |
| object | Objeto com informações do tipo de agenda |
6- Objeto “paciente” do retorno do array “horarios“
Campos | Tipo | Descrição |
---|---|---|
| string | Nome do paciente |
| string | Email do paciente |
| string | Celular do paciente |
| string | Matrícula do paciente |
| string | CPF do paciente |
| string | Chave única do paciente |
7- Objeto “mensageria” do retorno do array “horarios“
Campos | Tipo | Descrição |
---|---|---|
| string | Localizador Mensageria |
8- Objeto “status” do retorno do array “horarios“
Campos | Tipo | Descrição |
---|---|---|
| string | ID do status |
| string | Nome do Status |
| string | Hexadecimal para renderização da cor da label, exemplo: “#ff0000” |
9- Objeto “especialidade” do retorno do array “horarios“
Campos | Tipo | Descrição |
---|---|---|
| string | ID da especialidade |
| string | Nome do especialidade |
10- Objeto “tipoAgenda” do retorno do array “horarios“
Campos | Tipo | Descrição |
---|---|---|
| string | ID do tipo de agenda |
| string | Nome do tipo de agenda |
11- Retorno com sucesso (StatusCode 200)
Bloco de código |
---|
{
"status": true,
"data": {
"profissional": {
"nome": "Dr. João Passos",
"numeroConselho": "101010",
"siglaConselho": "CRM",
"ufConselho": "DF",
"especialidade": "Cardiologia",
"cpfCnpj": "10010010000",
"idChaveUnica": "12321"
},
"agenda": {
"localAtendimentoId": "1234",
"localAtendimentoNome": "Unidade Virtual",
"horarios": [
{
"idAgenda": "101004",
"data": "2020-03-24",
"hora": "10:00",
"paciente": {
"nome": "Rafael Simão AG: 1001010",
"email": "rafael@mobilesaude.com.br",
"celular": "27998554785",
"matricula": "000001",
"cpf": "05869310741",
"idChaveUnica": "rafael@mobilesaude.com.br"
},
"mensageria": {
"localizador": "rafael@mobilesaude.com.br"
},
"status": {
"id": "0",
"nome": "Agendado",
"corLabel": "#E7A566"
},
"especialidade": {
"id": "223910",
"nome": "Ortoptista"
},
"tipoAgenda": {
"id": "0",
"nome": "Consulta"
}
}
]
}
}
} |
12- Retorno com sucesso, sem conteúdo (StatusCode 200)
Bloco de código |
---|
{
"status": true,
"data": {
"profissional": {
"nome": "Dr. João Passos",
"numeroConselho": "101010",
"siglaConselho": "CRM",
"ufConselho": "DF",
"especialidade": "Cardiologia",
"cpfCnpj": "10010010000",
"idChaveUnica": "12321"
},
"agenda": {
"horarios": []
}
}
} |
13- Retorno com erro (StatusCode 200)
Bloco de código |
---|
{
"status": false,
"msg": "Texto com a descrição do erro para impressão na interface do atendente"
} |