Versões comparadas
Chave
- Esta linha foi adicionada.
- Esta linha foi removida.
- A formatação mudou.
Tópicos:
Índice
1- URL base
2- Exemplo endpoints
Endpoint | Método | Descrição |
---|---|---|
POST | Cria um novo atendente/médico do Mosia. |
3- Parâmetros body
3.1 Nó "usuario":
Parâmetro | Obrigatório | Tipo | Descrição | |||||||
---|---|---|---|---|---|---|---|---|---|---|
nome | true |
| Nome do atendente. | |||||||
false |
| Email do atendente. | ||||||||
login | true |
| Login do atendente. | |||||||
senha | true |
| Senha do atendente. | |||||||
telefone | true |
| Telefone do atendente com prefixo, exemplo: 27999999999 | |||||||
id_perfil | true |
| Perfil do usuário. 1 - Atendente 2 - Supervisor | |||||||
cpf | Condicional (Obrigatório na telemedicina) |
| CPF do atendente, apenas números. | |||||||
data_nasc | Condicional (Obrigatório na telemedicina) |
| Data de nascimento do atendente no formato dd/mm/aaaa. | |||||||
sexo | Condicional (Obrigatório na telemedicina) |
| Sexo do atendente. F - Feminino M - Masculino | |||||||
atendimentos_simultaneos | true |
| Número de atendimentos simultâneos que este atendente realiza. Na telemedicina torna-se obrigatório apenas 1 atendimento simultâneo. | |||||||
visualiza_historico_chamador | false |
| Parâmetro que permite o atendente visualizar no histórico de chamados dos atendimentos apenas dele ou todos os atendimentos realizados. 0 - Desativado 1 - Ativado | |||||||
codigo_integracao_crm | Condicional (Obrigatório na telemedicina) |
| Código de integração CRM do atendente. Na telemedicina este é o campo responsável por referenciar o médico e obter a lista de agendamentos. |
3.1 Nó "filas":
Parâmetro | Obrigatório | Tipo | Descrição | |||||||
---|---|---|---|---|---|---|---|---|---|---|
fila_atendimento_padrao | false |
| ID da fila de atendimento padrão. Obrigatório caso seja passado o parâmetro filas_atendimento. Caso fila_atendimento_padrao e filas_atendimento não sejam passados, uma fila será criada automaticamente para este atendente. | |||||||
filas_atendimento | false |
| IDs das filas que o atendente pode atender. Obrigatório caso seja passado o parâmetro fila_atendimento_padrao. Caso fila_atendimento_padrao e filas_atendimento não sejam passados, uma fila será criada automaticamente para este atendente e adicionada ao array filas_atendimento. |
3.1 Nó "telemedicina":
Parâmetro | Obrigatório | Tipo | Descrição | |||||||
---|---|---|---|---|---|---|---|---|---|---|
numero_conselho | Condicional (Obrigatório na telemedicina) |
| Número do conselho do médico. | |||||||
sigla_conselho | Condicional (Obrigatório na telemedicina) |
| Sigla do conselho do médico. | |||||||
uf_conselho | Condicional (Obrigatório na telemedicina) |
| UF do conselho que do médico. | |||||||
id_especialidade | Condicional (Obrigatório na telemedicina) |
| CBO da especialidade. Exemplo: O código 225120 se refere a especialidade "Cardiologista". | |||||||
id_prontuario_modelo | false |
| ID do modelo de prontuário que será utilizado. Caso seja utilizado é possível obter o ID no painel admin do Mosia, http://admin.mosia.chat/. Acessar o Menu Telecare > Modelos de Prontuário > Clicar em editar o item desejado. Nesta página será o último item do link, exemplo: ....modelosProntuario/editar/22. | |||||||
tempo_duracao_agenda | false |
| Estimativa de tempo de duração de uma consulta em minutos. Caso não seja informado o tempo padrão passado será de 20 minutos. Obs: item apenas informativo. | |||||||
visualiza_resumo_prontuario_geral | false |
| Permite o médico visualizar o resumo de prontuário completo do paciente. Atendimentos realizados por ele e/ou outros médicos na plataforma. 0 - Desativado 1 - Ativado | |||||||
visualiza_resumo_prontuario_no_historico | false |
| Permite o médico visualizar o resumo do prontuário do paciente no histórico de chamados. 0 - Desativado 1 - Ativado | |||||||
habilita_encaminhamento | false |
| Parâmetro que permite o médico gerar encaminhamento. ... 0 - Desativado 1 - Ativado |
4- Exemplo de body (JSON)
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
{ "usuario": { "nome": "User Teste 8", "email": "userteste@gmail.com", "login": "userteste8", "senha": "123456", "telefone": "(27) 99999-9999", "id_perfil": 2, "cpf": "12345678910", "data_nasc": "31/01/1996", "sexo": "M", "atendimentos_simultaneos": 1, "visualiza_historico_chamador": 1, "codigo_integracao_crm": "123" }, "filas": { "filas_atendimento": [], "fila_atendimento_padrao": null }, "telemedicina": { "numero_conselho": "111999", "sigla_conselho": "CRM", "uf_conselho": "ES", "id_especialidade": "221105", "id_prontuario_modelo": 22, "tempo_duracao_agenda": 30, "visualiza_resumo_prontuario_geral": 0, "visualiza_resumo_prontuario_no_historico": 0, "habilita_encaminhamento": 0 } } |
5- Exemplo de retorno API (Sucesso)
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
{ "status": true, "data": [], "critica": [ null ], "timestamp": "2021-05-07T17:47:47-03:00", "msg": "Usuário criado com sucesso." } |
6- Exemplo de retorno API (Erro)
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
{ "status": false, "data": [], "critica": [ null ], "timestamp": "2021-05-07T17:47:47-03:00", "msg": "Falha na autenticação." } |