API Consulta Contatos Equipes
Visão Geral:
A API de Consulta de Contatos das Equipes permite acessar informações detalhadas sobre os contatos associados a equipes de atendimento.
Funcionalidades Principais:
Consulta de Contatos: Obter informações sobre os contatos das equipes de atendimento.
Endpoints Disponíveis:
A API oferece o endpoint que inclui:
Lista todos os contatos vinculados às equipes.
Formato de Resposta:
As respostas da API são retornadas em formato JSON, contendo informações detalhadas sobre os contatos, como:
{
"Equipes": [
{
"Id": 0,
"Nome": "string",
"Contatos": [
{
"CoeqId": 0,
"Id": 0,
"Cpf": 0,
"CNS": 0,
"Ativo": true,
"MotivoId": 0,
"Inicio": "string",
"Final": "string",
"Pontuar": true,
"Obs": "string"
}
],
"Participantes": [
{
"Profissional": {
"Id": 0,
"Cpf": 0,
"Numero": "string",
"TipoIdentidade": "string",
"LocalExpedicao": "string",
"Nome": "string"
},
"LimitePontos": 0,
"PontosLivres": 0,
"PontosOcupados": 0
}
]
}
]
}
Autenticação e Segurança:
A API utiliza um método de autenticação baseado em Access Token, garantindo que apenas usuários autorizados possam acessar e consultar os dados dos contatos. Detalhes sobre o método de autenticação podem ser encontrados na documentação.
Erros Comuns:
A API pode retornar erros padrão, como:
400 Bad Request: Para requisições malformadas.
401 Unauthorized: Quando a autenticação falha.
Conclusão
A API de Consulta de Contatos das Equipes oferece funcionalidades essenciais para acessar informações de contato, promovendo uma integração eficiente com sistemas de saúde e melhorando a experiência do usuário. Para mais detalhes, consulte a documentação completa disponível no Swagger UI.
Swagger ambiente de TRN (treinamento):
https://trn-apis.pepunimed.com.br/swagger/ui/index#!/Contatos/Contatos_ConsultaContatosEquipes
Swagger ambiente de HML (homologação):
https://hml-apis.pepunimed.com.br/swagger/ui/index#!/Contatos/Contatos_ConsultaContatosEquipes