Painel da empresa › Médicos
Listar médicos
GET/api/v1/doctorsPede sessãoComo funciona
A lista de médicos da empresa, paginada, com os dados de cadastro, a situação do vínculo, a validação do cadastro, os documentos e as verificações de antecedentes de cada um.
Sem parâmetro, vem o quadro efetivo da empresa. Com pool=true, vem o Banco de Talentos: médicos que se candidataram ou foram guardados para chamar depois, mas ainda não trabalham na empresa.
- Pagine com
pageepageSize(padrão 50, máximo 100). O total vem empagination. checksNotInPlanlista as verificações que o plano da empresa não inclui, para a tela explicar por que elas não aparecem.
Pede a permissão de ver médicos.
Parâmetros
pageQuery · integerPágina, a partir de 1. Padrão: 1.pageSizeQuery · integerItens por página. Padrão: 50; máximo: 100.poolQuery · stringCom `true`, lista o Banco de Talentos em vez do quadro efetivo.
Respostas
200 · doctors da página pedida e pagination com o total.
doctorsobject[] · Os médicos.doctors[].accountstring · Conta.doctors[].agencystring · Agência.doctors[].availabilitystring · Disponibilidade informada pelo médico.doctors[].bankstring · Banco.doctors[].biometrystring · Resultado da biometria.doctors[].birthDatestring · Data de nascimento.doctors[].birthplacestring · Naturalidade (cidade de nascimento).doctors[].bondTypestring · Tipo de vínculo com a empresa.doctors[].cepstring · CEP, só dígitos.doctors[].checksobject[] · Verificações de antecedentes, a mais recente de cada tipo. Tipo ausente quer dizer nunca consultado, e não "nada consta".doctors[].checks[].attemptinteger · Número da tentativa.doctors[].checks[].awaitingSourceboolean · Aguardando a resposta do órgão.doctors[].checks[].casesobject · Os processos criminais, um a um: número, UF, tribunal, classe, situação e participação. Só na verificação de processos criminais.doctors[].checks[].checkedAtstring · Quando foi verificado.doctors[].checks[].hasCertificateboolean · Há certidão em PDF.doctors[].checks[].nextAttemptAtstring · Quando será a próxima tentativa.doctors[].checks[].notestring · Observação.doctors[].checks[].resultstring · Resultado:clear(nada consta),found(consta),pending(consultando) ouunavailable(não foi possível consultar).doctors[].checks[].scopestring · Verificação:antecedentes_pf,antecedentes_pc,mandado_prisaoouprocessos_criminais.doctors[].checks[].validUntilstring · Até quando a certidão vale (a próxima consulta automática).doctors[].checksNotInPlanstring[] · Verificações que o plano da empresa não inclui.doctors[].citystring · Cidade.doctors[].complementstring · Complemento.doctors[].contractSignedboolean · O contrato com a empresa já foi assinado.doctors[].contractStatusstring · Situação do contrato:terminatingenquanto o distrato espera assinatura,terminateddepois de assinado.doctors[].coordinatorstring · Coordenador das jornadas em que o médico atua; vazio quando não há.doctors[].cpfstring · CPF, só dígitos.doctors[].createdAtstring · Quando foi criado.doctors[].crmstring · Número do CRM.doctors[].crmStatusstring · Situação do CRM no conselho: descrição e código oficial.doctors[].crmStatusCodestring · Código oficial da situação do CRM no conselho.doctors[].crmUfstring · UF do CRM.doctors[].graduationobject · Graduação (ADR 0134). A consulta ao CFM (médico, por CRM) ou ao histórico escolar (outras profissões, pelo CPF) preenche; quem cadastra pode corrigir.doctors[].graduation.institutionstring · Instituição de ensino.doctors[].graduation.yearinteger · Ano de formatura.doctors[].graduation.firstRegistrationstring · Primeira inscrição no CRM (só médico).doctors[].graduation.sourcestring: conselho | historico | · De onde veio: do conselho, do histórico escolar ou digitada.doctors[].degreesobject[] · Formações, uma por item, com o RQE quando houver.doctors[].degrees[].detailstring · Detalhe do evento.doctors[].degrees[].typestring · Tipo.doctors[].districtstring · Bairro.doctors[].doctorIdstring · Identificador do médico nesta empresa (o vínculo).doctors[].documentsobject[] · Documentos.doctors[].documents[].expiresAtstring · Validade do documento (AAAA-MM-DD); ausente quando não tem data.doctors[].documents[].fileNamestring · Nome do arquivo.doctors[].documents[].filesinteger · Quantos arquivos o documento tem: 0, 1 ou 2 (frente e verso).doctors[].documents[].kindstring · Tipo.doctors[].documents[].resendReasonstring · Motivo do pedido de reenvio.doctors[].documents[].resendRequestedboolean · A empresa pediu que o médico envie de novo.doctors[].documents[].optionalboolean · A empresa pede o documento, mas não cobra. Não enviado não conta como pendência.doctors[].documents[].statusstring · Situação.doctors[].documents[].typestring · Tipo do documento, da lista da plataforma.doctors[].documents[].validationobject · Validação do cadastro:pending,approvedourejected.doctors[].documents[].validation.alertsstring[] · Alertas da fonte, ou os motivos da foto recusada.doctors[].documents[].validation.checkedAtstring · Quando foi verificado.doctors[].documents[].validation.consultaIdstring · Identificador da consulta no serviço de verificação.doctors[].documents[].validation.expiresAtstring · Validade impressa no documento (AAAA-MM-DD), quando a leitura encontra.doctors[].documents[].validation.fieldsstring[] · Valores dos marcadores do texto que não vêm do cadastro, como valor e prazo.doctors[].documents[].validation.possibleFraudboolean · A divergência veio de alerta de fraude da fonte, e não de dado que não bate.doctors[].documents[].validation.statusstring · Situação.doctors[].documents[].validation.summarystring · A frase do resultado, como "Documento verdadeiro e válido".doctors[].emailstring · E-mail.doctors[].emergencyContactstring · Telefone do contato de emergência.doctors[].emergencyNamestring · Nome do contato de emergência.doctors[].escalistastring · Escalista responsável pela jornada.doctors[].fatherNamestring · Nome do pai.doctors[].fixedShiftboolean · O médico tem plantão fixo.doctors[].futureShiftsinteger · Plantões que o médico ainda vai fazer; inativar deixa esses plantões vagos.doctors[].genderstring · Sexo:MouF.doctors[].idstring · Identificador do registro.doctors[].maritalStatusstring · Estado civil.doctors[].marriageRegimestring · Regime de casamento.doctors[].motherNamestring · Nome da mãe.doctors[].namestring · Nome.doctors[].nationalitystring · Nacionalidade.doctors[].numberstring · Número.doctors[].paymentTermstring · Prazo de pagamento: à vista ou a prazo.doctors[].phonestring · Telefone.doctors[].pixKeystring · Chave PIX.doctors[].punctualityobject · Pontualidade dos últimos 12 meses; ausente quando não houve plantão.doctors[].punctuality.correctPunchesinteger · Plantões com o ponto certo.doctors[].punctuality.scorePctinteger · Pontualidade, em porcentagem.doctors[].punctuality.shiftsCountinteger · Plantões no período.doctors[].rejectionReasonstring · Motivo da recusa.doctors[].rgstring · Número do RG.doctors[].rgIssueDatestring · Data de emissão do RG.doctors[].rgIssuerstring · Órgão emissor do RG.doctors[].rgIssuerStatestring · UF que emitiu o RG.doctors[].rqesobject[] · Os RQE do médico, um por especialidade.doctors[].rqes[].numberstring · Número.doctors[].rqes[].specialtystring · Especialidade.doctors[].scalesstring[] · Escalas.doctors[].shiftTypestring · Tipo de plantão.doctors[].categorystring · Profissão do profissional (medicina,enfermagem…). Ausente no cadastro antigo.doctors[].specialtystring · Especialidade.doctors[].statestring · Estado.doctors[].statusstring · Situação.doctors[].streetstring · Logradouro.doctors[].validatedAtstring · Quando foi validado.doctors[].validatedBystring · Quem validou; ausente enquanto ninguém validou.doctors[].validationstring · Validação do cadastro:pending,approvedourejected.paginationobject · Paginação: página, tamanho e total.pagination.pageinteger · Página.pagination.pageSizeinteger · Itens por página.pagination.totalinteger · Total.
Corpo de exemplo
{
"doctors": [
{
"account": "texto",
"agency": "texto",
"availability": "texto",
"bank": "texto",
"biometry": "texto",
"birthDate": "texto",
"birthplace": "texto",
"bondType": "texto",
"cep": "texto",
"checks": [
{}
],
"checksNotInPlan": [
null
],
"city": "texto",
"complement": "texto",
"contractSigned": true,
"contractStatus": "texto",
"coordinator": "texto",
"cpf": "texto",
"createdAt": "texto",
"crm": "texto",
"crmStatus": "texto",
"crmStatusCode": "texto",
"crmUf": "texto",
"graduation": {
"institution": null,
"year": null,
"firstRegistration": null,
"source": "conselho"
},
"degrees": [
{}
],
"district": "texto",
"doctorId": "3f0c2a5e-9b1d-4c7e-8a21-6d0f5b7ca91e",
"documents": [
{}
],
"email": "medico@exemplo.com.br",
"emergencyContact": "texto",
"emergencyName": "texto",
"escalista": "texto",
"fatherName": "texto",
"fixedShift": true,
"futureShifts": 1,
"gender": "texto",
"id": "3f0c2a5e-9b1d-4c7e-8a21-6d0f5b7ca91e",
"maritalStatus": "texto",
"marriageRegime": "texto",
"motherName": "texto",
"name": "texto",
"nationality": "texto",
"number": "texto",
"paymentTerm": "texto",
"phone": "texto",
"pixKey": "texto",
"punctuality": {
"correctPunches": null,
"scorePct": null,
"shiftsCount": null
},
"rejectionReason": "texto",
"rg": "texto",
"rgIssueDate": "texto",
"rgIssuer": "texto",
"rgIssuerState": "texto",
"rqes": [
{}
],
"scales": [
null
],
"shiftType": "texto",
"category": "texto",
"specialty": "texto",
"state": "texto",
"status": "texto",
"street": "texto",
"validatedAt": "texto",
"validatedBy": "texto",
"validation": "texto"
}
],
"pagination": {
"page": 1,
"pageSize": 1,
"total": 1
}
}