{"openapi":"3.0.1","info":{"title":"Básico","description":"\n# Introdução\n\nBem-vindo à documentação da API. Este documento fornece as informações necessárias para que os desenvolvedores utilizem os recursos do **SWA.JACAD**, sejam eles baseados em servidor ou no lado do cliente.\n\nEsta página contém todos os métodos de consulta de dados básicos, como nacionalidades, cidades, estados, forma de conhecimento, etc.\n\n\n\n### Quadro de Relacionamentos -JACAD\n\n \n## Segurança\n\nA API REST do JACAD utiliza o protocolo HTTPS para uma comunicação criptografada, além disso, todas as solicitações na API são obrigadas a informar um **token de acesso** (Access Token) para garantir a .\n\n### Obtendo uma Chave de API\n\nPara obter um Token de Acesso é necessário se autenticar com uma **Chave de API**. Você pode obter sua Chave de API no painel de administração da plataforma SWA.JACAD.\n\nUma Chave de API tem o seguinte formato:\n\n```json\n5837fa342c8a14c50c2d7c9a73369dce\n```\n\nUma chave de API deve ser definido na plataforma SWA.JACAD para autenticação na API.\n\nNavegue até:`Integrações` > `API de Integrações` > `Tokens de Acesso` > `Cadastro de Token de Acesso`.\n\n1. Clique em **Inserir**.\n2. Selecione um usuário.\n3. Insira a data de vigência do token ou marque a flag para não validar datas.\n4. Clique em salvar para gerar automaticamente um Token.\n\n**Nota:** É necessário possuir privilégios de administrador para obter uma chave de API.\n\n![SWA.JACAD Desktop](/gerando-token.png \"Gerando Token de acesso\")\n\n\n### Aviso\n\nTokens de API podem representar um risco de segurança para sua organização se usados por uma pessoa não autorizada. Certifique-se de mantê-los seguros, exclua as chaves antigas e substitua-as em seu sistema se suspeitar de alguma violação de segurança.\n\n> Você pode entrar em contato conosco para obter suporte adicional.\n\n## Rate Limit\n\nTokens de requisição são uma abordagem eficiente para gerenciar o acesso a recursos, impedindo abusos e assegurando uma distribuição equitativa. No seu sistema, há dois principais filtros de controle de tokens:\n\n### Bloqueio Técnico:\n\n- **Quantidade Inicial:** 10 tokens por IP.\n- **Taxa de Recarga:** 1 token por segundo.\n- **Restrição:** Cada IP pode fazer 10 requisições por segundo. Após atingir esse limite, é necessário aguardar até que novos tokens sejam disponibilizados.\n\n### Filtro de Negócio:\n\n- **Quantidade Inicial:** Definida pelo usuário (por exemplo, 1000 tokens).\n- **Taxa de Recarga:** Recarregado a cada 1 hora.\n- **Restrição Adicional:** Se todos os tokens forem usados antes do período de uma hora, a recarga só ocorre após o término desse período, contado a partir do momento da última recarga. Por exemplo, se 1000 tokens forem usados em 55 minutos, a próxima recarga só ocorrerá 5 minutos após a última recarga.\n\nEste sistema oferece um equilíbrio entre acesso rápido (Bloqueio Técnico) e controle de uso a longo prazo (Filtro de Negócio), garantindo uma distribuição justa e evitando abusos.\n\n\n### Configuração do Controle de Requisições:\n\nNavegue até:`Preferências` > `Segurança` > `Políticas de Segurança`.\n\nEm nossa plataforma, oferecemos total controle sobre como gerenciar suas requisições. Aqui está um guia simples para configurar o Filtro de Negócio:\n\n#### 1. Habilitar Controle de Requisições:\n\n- Para começar, marque a caixa de seleção \"Habilitar Controle de Requisições\". Isso permite que você personalize a quantidade máxima de requisições.\n\n- [ ] Habilitar Controle de Requisições\n\n#### 2. Definir Quantidade Máxima (Padrão: 1000 por Hora):\n- Abaixo da opção habilitar, você encontrará um campo para inserir a quantidade desejada de tokens. O valor padrão é 1000 por hora.\n\nAo marcar a opção e inserir sua preferência, você tem o poder de moldar como deseja que o Filtro de Negócio funcione para você.\n\nLembre-se: Se não desejar modificar, a configuração padrão de 1000 por hora permanecerá em vigor.\n\n![SWA.JACAD Desktop](/configurando-token.png \"Configurando entrada maxima de tokens\")\n\n\n## Jacad API Rest\n\nA API utiliza os princípios das APIs REST, permitindo que os desenvolvedores realizem consultas na plataforma SWA.JACAD utilizando o protocolo HTTP.\n\nUse uma solicitação **GET** para recuperar informações, um **POST** para criar ou atualizar e um **DELETE** para remover uma informação.\n\n### Bearer Token (JWT)\n\nTodas as solicitações de API requerem um token de autorização para validar a autenticidade e indicar ao sistema quais módulos, operações e recursos o usuário pode acessar. \n\nO Token JWT deve ser informado no cabeçalho (header) da solicitação como no formato abaixo:\n\n```json\nAuthorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c\n```\n\n**Nota:** O token JWT é obtido após realizar a autenticação na API.\n\n\n\n\n### Respostas de Erros\n\nA API usa códigos de status HTTP padrão para indicar o sucesso ou a falha como acontece com qualquer resposta de API, seu cliente deve estar preparado para lidar com erros de resposta. Normalmente, o corpo da resposta será JSON no seguinte formato:\n\n```json\n{\n\t\"timestamp\": \"2023-09-19T16:23:53-0300\",\n\t\"message\": \"Failed to convert property 'anoConsolidacao'\",\n\t\"details\": \"/api/v4/resource\",\n\t\"errorCode\": {\n\t\t\"code\": \"VFLD01\",\n\t\t\"desc\": \"Valor informado inválido\"\n\t},\n\t\"validationErrors\": [\n\t\t{\n\t\t\t\"field\": \"anoConsolidacao\",\n\t\t\t\"rejectedValue\": \"2022-ASDF\",\n\t\t\t\"message\": \"Failed to convert property 'anoConsolidacao'\"\n\t\t}\n\t]\n}\n\n```\n\n### Código de Status\n\n| CÓDIGO | DESCRIÇÃO | NOTA |\n| ------ | ------ | ------ |\n| 200 | OK | A requisição foi bem sucedida. |\n| 201 | Created | Os dados foram gravados com sucesso no sistema |\n| 400 | Bad Request | A solicitação não pôde ser compreendida pelo servidor. Os parâmetros recebidos podem não ser válidos |\n| 401 | Unauthorized | As credenciais fornecidas, se houver, não são suficientes para acessar o recurso |\n| 403 | Forbidden | As credenciais fornecidas não possui permissão para acessar o recurso. |\n| 404 | Not Found | A informação requerida não foi encontrada |\n| 422 | Unprocessable Entity | Não foi possível processar a informação devido a restrições de uso. |\n| 500 | Server Error | Erro inesperado, ocorreu algum erro interno no servidor |\n| 429 | Too Many Requests | Limite de requisições |","termsOfService":"https://www.swa.com.br/termo-de-uso/","contact":{"name":"Suporte","url":"https://ajuda.jacad.com.br","email":"suporte@swa.com.br"},"version":"v3.1.60.213"},"servers":[{"url":"https://fce-developer.jacad.com.br","description":"Generated server url"}],"security":[{"Access Token":[]}],"tags":[{"name":"Autenticação"}],"paths":{"/api/v1/basicos/perfis/{id_perfil}/contatos":{"get":{"tags":["Perfis"],"summary":"Consulta contatos perfil","description":"Lista os contatos associados a um perfil","operationId":"findById_2","parameters":[{"name":"id_perfil","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PerfilContatoRest"}}}}},"400":{"description":"Solicitação inválida, contém erros de tipos ou de formatação","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.964+00:00","message":"Um ou mais campos estão inválidos","details":"/api/v1/resource","errorCode":{"code":"VFLD01","desc":"Valor informado inválido"},"validationErrors":[{"field":"anoConsolidacao","rejectedValue":"202A","message":"Falha ao converter a propriedade 'anoConsolidacao'"}]}}}},"401":{"description":"Acesso negado, O usuário não está autenticado ou possui credenciais inválidas","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.964+00:00","message":"É necessário estar autenticado para acessar este recurso","details":"/api/v1/resource","errorCode":{"code":"EXPTK01","desc":"Token inválido ou expirado"}}}}},"403":{"description":"Proibido, o usuário autenticado não possui a permissão de acesso para o recurso solicitado.","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.964+00:00","message":"Voce nao tem permissao para acessar este recurso","details":"/api/v1/resource"}}}},"404":{"description":"Recurso não encontrado","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.964+00:00","message":"Registro de código '123' não encontrado","details":"/api/v1/resource"}}}},"500":{"description":"Erro inesperado, ocorreu algum erro interno no servidor","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.964+00:00","message":"Erro desconhecido","details":"/api/v1/resource"}}}}}},"put":{"tags":["Perfis"],"summary":"Atualizar Contatos perfil","description":"Atualiza o contato vinculado a um perfil.","operationId":"atualizarContatoPerfil","parameters":[{"name":"id_perfil","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AtualizarPerfilContatoDtoReq"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PerfilContatoRest"}}}},"400":{"description":"Solicitação inválida, contém erros de tipos ou de formatação","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.654+00:00","message":"Um ou mais campos estão inválidos","details":"/api/v1/resource","errorCode":{"code":"VFLD01","desc":"Valor informado inválido"},"validationErrors":[{"field":"anoConsolidacao","rejectedValue":"202A","message":"Falha ao converter a propriedade 'anoConsolidacao'"}]}}}},"401":{"description":"Acesso negado, O usuário não está autenticado ou possui credenciais inválidas","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.654+00:00","message":"É necessário estar autenticado para acessar este recurso","details":"/api/v1/resource","errorCode":{"code":"EXPTK01","desc":"Token inválido ou expirado"}}}}},"403":{"description":"Proibido, o usuário autenticado não possui a permissão de acesso para o recurso solicitado.","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.654+00:00","message":"Voce nao tem permissao para acessar este recurso","details":"/api/v1/resource"}}}},"404":{"description":"Recurso não encontrado","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.654+00:00","message":"Registro de código '123' não encontrado","details":"/api/v1/resource"}}}},"500":{"description":"Erro inesperado, ocorreu algum erro interno no servidor","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.654+00:00","message":"Erro desconhecido","details":"/api/v1/resource"}}}}}},"post":{"tags":["Perfis"],"summary":"Cadastrar Contatos perfil","description":"Cria um contato vinculado a um perfil. Informe ao menos um dentre os seguintes campos no momento do cadastro: 'telefone', 'celular', 'email' ou 'fax'","operationId":"cadastroContatoPerfil","parameters":[{"name":"id_perfil","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PerfilContatoDtoReq"}}},"required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PerfilContatoRest"}}}},"400":{"description":"Solicitação inválida, contém erros de tipos ou de formatação","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.772+00:00","message":"Um ou mais campos estão inválidos","details":"/api/v1/resource","errorCode":{"code":"VFLD01","desc":"Valor informado inválido"},"validationErrors":[{"field":"anoConsolidacao","rejectedValue":"202A","message":"Falha ao converter a propriedade 'anoConsolidacao'"}]}}}},"401":{"description":"Acesso negado, O usuário não está autenticado ou possui credenciais inválidas","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.772+00:00","message":"É necessário estar autenticado para acessar este recurso","details":"/api/v1/resource","errorCode":{"code":"EXPTK01","desc":"Token inválido ou expirado"}}}}},"403":{"description":"Proibido, o usuário autenticado não possui a permissão de acesso para o recurso solicitado.","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.772+00:00","message":"Voce nao tem permissao para acessar este recurso","details":"/api/v1/resource"}}}},"404":{"description":"Recurso não encontrado","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.772+00:00","message":"Registro de código '123' não encontrado","details":"/api/v1/resource"}}}},"500":{"description":"Erro inesperado, ocorreu algum erro interno no servidor","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.772+00:00","message":"Erro desconhecido","details":"/api/v1/resource"}}}}}}},"/api/v1/basicos/perfil-responsavel/{idPerfilResponsavel}":{"put":{"tags":["Responsável"],"summary":"Edição de perfil responsável","description":"Edição de perfil responsável","operationId":"update","parameters":[{"name":"idPerfilResponsavel","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PerfilResponsavelDtoReq"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PerfilResponsavelRest"}}}},"400":{"description":"Solicitação inválida, contém erros de tipos ou de formatação","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.664+00:00","message":"Um ou mais campos estão inválidos","details":"/api/v1/resource","errorCode":{"code":"VFLD01","desc":"Valor informado inválido"},"validationErrors":[{"field":"anoConsolidacao","rejectedValue":"202A","message":"Falha ao converter a propriedade 'anoConsolidacao'"}]}}}},"401":{"description":"Acesso negado, O usuário não está autenticado ou possui credenciais inválidas","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.664+00:00","message":"É necessário estar autenticado para acessar este recurso","details":"/api/v1/resource","errorCode":{"code":"EXPTK01","desc":"Token inválido ou expirado"}}}}},"403":{"description":"Proibido, o usuário autenticado não possui a permissão de acesso para o recurso solicitado.","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.664+00:00","message":"Voce nao tem permissao para acessar este recurso","details":"/api/v1/resource"}}}},"404":{"description":"Recurso não encontrado","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.664+00:00","message":"Registro de código '123' não encontrado","details":"/api/v1/resource"}}}},"500":{"description":"Erro inesperado, ocorreu algum erro interno no servidor","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.664+00:00","message":"Erro desconhecido","details":"/api/v1/resource"}}}}}},"delete":{"tags":["Responsável"],"summary":"Deletar um perfil responsável","operationId":"delete","parameters":[{"name":"idPerfilResponsavel","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK"},"400":{"description":"Solicitação inválida, contém erros de tipos ou de formatação","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:03.036+00:00","message":"Um ou mais campos estão inválidos","details":"/api/v1/resource","errorCode":{"code":"VFLD01","desc":"Valor informado inválido"},"validationErrors":[{"field":"anoConsolidacao","rejectedValue":"202A","message":"Falha ao converter a propriedade 'anoConsolidacao'"}]}}}},"401":{"description":"Acesso negado, O usuário não está autenticado ou possui credenciais inválidas","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:03.036+00:00","message":"É necessário estar autenticado para acessar este recurso","details":"/api/v1/resource","errorCode":{"code":"EXPTK01","desc":"Token inválido ou expirado"}}}}},"403":{"description":"Proibido, o usuário autenticado não possui a permissão de acesso para o recurso solicitado.","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:03.036+00:00","message":"Voce nao tem permissao para acessar este recurso","details":"/api/v1/resource"}}}},"404":{"description":"Recurso não encontrado","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:03.036+00:00","message":"Registro de código '123' não encontrado","details":"/api/v1/resource"}}}},"500":{"description":"Erro inesperado, ocorreu algum erro interno no servidor","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:03.036+00:00","message":"Erro desconhecido","details":"/api/v1/resource"}}}}}}},"/api/v1/basicos/funcionarios/api/v1/basicos/funcionarios/{idFuncionario}/email-institucional":{"put":{"tags":["Funcionários"],"summary":"Informar E-mail Institucional de Funcionário","description":"Insere um e-mail institucional para um funcionário.","operationId":"insertEmailInstitucional","parameters":[{"name":"idFuncionario","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailInstitucionalDtoReq"}}},"required":true},"responses":{"200":{"description":"OK"},"400":{"description":"Solicitação inválida, contém erros de tipos ou de formatação","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.667+00:00","message":"Um ou mais campos estão inválidos","details":"/api/v1/resource","errorCode":{"code":"VFLD01","desc":"Valor informado inválido"},"validationErrors":[{"field":"anoConsolidacao","rejectedValue":"202A","message":"Falha ao converter a propriedade 'anoConsolidacao'"}]}}}},"401":{"description":"Acesso negado, O usuário não está autenticado ou possui credenciais inválidas","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.667+00:00","message":"É necessário estar autenticado para acessar este recurso","details":"/api/v1/resource","errorCode":{"code":"EXPTK01","desc":"Token inválido ou expirado"}}}}},"403":{"description":"Proibido, o usuário autenticado não possui a permissão de acesso para o recurso solicitado.","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.667+00:00","message":"Voce nao tem permissao para acessar este recurso","details":"/api/v1/resource"}}}},"404":{"description":"Recurso não encontrado","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.667+00:00","message":"Registro de código '123' não encontrado","details":"/api/v1/resource"}}}},"500":{"description":"Erro inesperado, ocorreu algum erro interno no servidor","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.667+00:00","message":"Erro desconhecido","details":"/api/v1/resource"}}}}}}},"/api/v1/basicos/bloqueio-perfil/{idPerfilBloqueio}":{"put":{"tags":["Bloqueios de Perfis"],"summary":"Inativação do bloqueio de perfil","operationId":"inativar","parameters":[{"name":"idPerfilBloqueio","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PerfilBloqueioDtoRes"}}}},"400":{"description":"Solicitação inválida, contém erros de tipos ou de formatação","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.672+00:00","message":"Um ou mais campos estão inválidos","details":"/api/v1/resource","errorCode":{"code":"VFLD01","desc":"Valor informado inválido"},"validationErrors":[{"field":"anoConsolidacao","rejectedValue":"202A","message":"Falha ao converter a propriedade 'anoConsolidacao'"}]}}}},"401":{"description":"Acesso negado, O usuário não está autenticado ou possui credenciais inválidas","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.672+00:00","message":"É necessário estar autenticado para acessar este recurso","details":"/api/v1/resource","errorCode":{"code":"EXPTK01","desc":"Token inválido ou expirado"}}}}},"403":{"description":"Proibido, o usuário autenticado não possui a permissão de acesso para o recurso solicitado.","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.672+00:00","message":"Voce nao tem permissao para acessar este recurso","details":"/api/v1/resource"}}}},"404":{"description":"Recurso não encontrado","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.672+00:00","message":"Registro de código '123' não encontrado","details":"/api/v1/resource"}}}},"500":{"description":"Erro inesperado, ocorreu algum erro interno no servidor","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.672+00:00","message":"Erro desconhecido","details":"/api/v1/resource"}}}}}}},"/api/v2/basicos/perfis":{"get":{"tags":["Perfis V2"],"summary":"Consulta de Perfis","description":"Consulta perfis cadastrados na instuição.","operationId":"list_1","parameters":[{"name":"search","in":"query","description":"Realiza busca por: Nome, CPF, RG e CNPJ","required":false,"schema":{"type":"string"},"example":"Foo Bar"},{"name":"idPerfil","in":"query","description":"ID do Perfil","required":false,"schema":{"type":"integer","format":"int32"},"example":1},{"name":"email","in":"query","description":"E-mail do Perfil","required":false,"schema":{"type":"string"},"example":"emailaluno@email.com.br"},{"name":"cpf","in":"query","description":"CPF do Perfil","required":false,"schema":{"type":"string"},"example":99999999999},{"name":"cnpj","in":"query","description":"CNPJ do Perfil","required":false,"schema":{"type":"string"},"example":99999999000999},{"name":"rne","in":"query","description":"RNE do Perfil","required":false,"schema":{"type":"string"},"example":"R1234567"},{"name":"dataAlteracaoInicio","in":"query","description":"Data alteração início","required":false,"schema":{"type":"string","format":"date-time"},"example":"2024-01-30"},{"name":"horaAlteracaoInicio","in":"query","description":"Hora alteração início (Requer a Data alteração início)","required":false,"schema":{"type":"string","format":"date-time"},"example":"00:00:00"},{"name":"dataAlteracaoFim","in":"query","description":"Data alteração fim","required":false,"schema":{"type":"string","format":"date-time"},"example":"2024-01-30"},{"name":"horaAlteracaoFim","in":"query","description":"Hora alteração fim (Requer a Data alteração fim)","required":false,"schema":{"type":"string","format":"date-time"},"example":"23:59:59"},{"name":"pageSize","in":"query","description":"Total de registros que serão retornados a cada consulta (máximo de 5000)","required":true,"schema":{"maximum":5000,"type":"integer","format":"int32"},"example":5000},{"name":"idCursor","in":"query","description":"Código primário da consulta, começa com 0, utilizado para páginação","required":false,"schema":{"type":"integer","format":"int32"},"example":0},{"name":"currentPage","in":"query","description":"Página atual dos resultados","required":false,"schema":{"type":"integer","format":"int32"},"example":1}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginationPerfilDtoResPageCursor"}}}},"400":{"description":"Solicitação inválida, contém erros de tipos ou de formatação","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.884+00:00","message":"Um ou mais campos estão inválidos","details":"/api/v1/resource","errorCode":{"code":"VFLD01","desc":"Valor informado inválido"},"validationErrors":[{"field":"anoConsolidacao","rejectedValue":"202A","message":"Falha ao converter a propriedade 'anoConsolidacao'"}]}}}},"401":{"description":"Acesso negado, O usuário não está autenticado ou possui credenciais inválidas","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.884+00:00","message":"É necessário estar autenticado para acessar este recurso","details":"/api/v1/resource","errorCode":{"code":"EXPTK01","desc":"Token inválido ou expirado"}}}}},"403":{"description":"Proibido, o usuário autenticado não possui a permissão de acesso para o recurso solicitado.","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.884+00:00","message":"Voce nao tem permissao para acessar este recurso","details":"/api/v1/resource"}}}},"404":{"description":"Recurso não encontrado","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.884+00:00","message":"Registro de código '123' não encontrado","details":"/api/v1/resource"}}}},"500":{"description":"Erro inesperado, ocorreu algum erro interno no servidor","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.884+00:00","message":"Erro desconhecido","details":"/api/v1/resource"}}}}}},"post":{"tags":["Perfis V2"],"summary":"Cadastrar um Perfil","description":"Permite cadastrar uma Pessoa Fisica ou Juridica","operationId":"cadastroPerfil","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PerfilDtoReq"}}},"required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PerfilDtoRes"}}}},"400":{"description":"Solicitação inválida, contém erros de tipos ou de formatação","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.724+00:00","message":"Um ou mais campos estão inválidos","details":"/api/v1/resource","errorCode":{"code":"VFLD01","desc":"Valor informado inválido"},"validationErrors":[{"field":"anoConsolidacao","rejectedValue":"202A","message":"Falha ao converter a propriedade 'anoConsolidacao'"}]}}}},"401":{"description":"Acesso negado, O usuário não está autenticado ou possui credenciais inválidas","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.724+00:00","message":"É necessário estar autenticado para acessar este recurso","details":"/api/v1/resource","errorCode":{"code":"EXPTK01","desc":"Token inválido ou expirado"}}}}},"403":{"description":"Proibido, o usuário autenticado não possui a permissão de acesso para o recurso solicitado.","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.724+00:00","message":"Voce nao tem permissao para acessar este recurso","details":"/api/v1/resource"}}}},"404":{"description":"Recurso não encontrado","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.724+00:00","message":"Registro de código '123' não encontrado","details":"/api/v1/resource"}}}},"500":{"description":"Erro inesperado, ocorreu algum erro interno no servidor","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.724+00:00","message":"Erro desconhecido","details":"/api/v1/resource"}}}}}}},"/api/v2/basicos/perfis/{idPerfil}/foto":{"get":{"tags":["Perfis V2"],"summary":"Visualizar Foto de Perfil","description":"Mostra a foto de um perfil selecionado","operationId":"visualizarFotoPerfil","parameters":[{"name":"idPerfil","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"application/octet-stream":{"schema":{"type":"array","items":{"type":"string","format":"byte"}}}}},"400":{"description":"Solicitação inválida, contém erros de tipos ou de formatação","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.902+00:00","message":"Um ou mais campos estão inválidos","details":"/api/v1/resource","errorCode":{"code":"VFLD01","desc":"Valor informado inválido"},"validationErrors":[{"field":"anoConsolidacao","rejectedValue":"202A","message":"Falha ao converter a propriedade 'anoConsolidacao'"}]}}}},"401":{"description":"Acesso negado, O usuário não está autenticado ou possui credenciais inválidas","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.902+00:00","message":"É necessário estar autenticado para acessar este recurso","details":"/api/v1/resource","errorCode":{"code":"EXPTK01","desc":"Token inválido ou expirado"}}}}},"403":{"description":"Proibido, o usuário autenticado não possui a permissão de acesso para o recurso solicitado.","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.902+00:00","message":"Voce nao tem permissao para acessar este recurso","details":"/api/v1/resource"}}}},"404":{"description":"Recurso não encontrado","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.902+00:00","message":"Registro de código '123' não encontrado","details":"/api/v1/resource"}}}},"500":{"description":"Erro inesperado, ocorreu algum erro interno no servidor","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.902+00:00","message":"Erro desconhecido","details":"/api/v1/resource"}}}}}},"post":{"tags":["Perfis V2"],"summary":"Upload da Foto de Perfil","description":"Adiciona foto ao Perfil. A imagem deve ter um tamanho máximo de 5024KBytes e ser do tipo PNG, JPG ou JPEG.","operationId":"uploadFotoPerfil","parameters":[{"name":"idPerfil","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"required":["file"],"type":"object","properties":{"file":{"type":"string","format":"binary"}}}}}},"responses":{"201":{"description":"Created"},"400":{"description":"Solicitação inválida, contém erros de tipos ou de formatação","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.727+00:00","message":"Um ou mais campos estão inválidos","details":"/api/v1/resource","errorCode":{"code":"VFLD01","desc":"Valor informado inválido"},"validationErrors":[{"field":"anoConsolidacao","rejectedValue":"202A","message":"Falha ao converter a propriedade 'anoConsolidacao'"}]}}}},"401":{"description":"Acesso negado, O usuário não está autenticado ou possui credenciais inválidas","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.727+00:00","message":"É necessário estar autenticado para acessar este recurso","details":"/api/v1/resource","errorCode":{"code":"EXPTK01","desc":"Token inválido ou expirado"}}}}},"403":{"description":"Proibido, o usuário autenticado não possui a permissão de acesso para o recurso solicitado.","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.727+00:00","message":"Voce nao tem permissao para acessar este recurso","details":"/api/v1/resource"}}}},"404":{"description":"Recurso não encontrado","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.727+00:00","message":"Registro de código '123' não encontrado","details":"/api/v1/resource"}}}},"500":{"description":"Erro inesperado, ocorreu algum erro interno no servidor","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.727+00:00","message":"Erro desconhecido","details":"/api/v1/resource"}}}}}}},"/api/v1/basicos/perfis":{"get":{"tags":["Perfis"],"summary":"Consulta de Perfis","description":"Consulta perfis cadastrados na instuição.","operationId":"list_4","parameters":[{"name":"search","in":"query","description":"Realiza busca por: Nome, CPF, RG e CNPJ","required":false,"schema":{"type":"string"},"example":"Foo Bar"},{"name":"pageSize","in":"query","description":"Total de registros que serão retornados a cada consulta (máximo de 500)","required":true,"schema":{"type":"integer","format":"int32"},"example":100},{"name":"currentPage","in":"query","description":"Página atual dos resultados","required":false,"schema":{"type":"integer","format":"int32"},"example":1}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginationPerfilDtoResPage"}}}},"400":{"description":"Solicitação inválida, contém erros de tipos ou de formatação","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.941+00:00","message":"Um ou mais campos estão inválidos","details":"/api/v1/resource","errorCode":{"code":"VFLD01","desc":"Valor informado inválido"},"validationErrors":[{"field":"anoConsolidacao","rejectedValue":"202A","message":"Falha ao converter a propriedade 'anoConsolidacao'"}]}}}},"401":{"description":"Acesso negado, O usuário não está autenticado ou possui credenciais inválidas","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.941+00:00","message":"É necessário estar autenticado para acessar este recurso","details":"/api/v1/resource","errorCode":{"code":"EXPTK01","desc":"Token inválido ou expirado"}}}}},"403":{"description":"Proibido, o usuário autenticado não possui a permissão de acesso para o recurso solicitado.","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.941+00:00","message":"Voce nao tem permissao para acessar este recurso","details":"/api/v1/resource"}}}},"404":{"description":"Recurso não encontrado","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.941+00:00","message":"Registro de código '123' não encontrado","details":"/api/v1/resource"}}}},"500":{"description":"Erro inesperado, ocorreu algum erro interno no servidor","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.941+00:00","message":"Erro desconhecido","details":"/api/v1/resource"}}}}}},"post":{"tags":["Perfis"],"summary":"Cadastrar um Perfil","description":"Permite cadastrar uma Pessoa Fisica ou Juridica","operationId":"cadastroPerfil_1","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PerfilDtoReq"}}},"required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PerfilDtoRes"}}}},"400":{"description":"Solicitação inválida, contém erros de tipos ou de formatação","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.766+00:00","message":"Um ou mais campos estão inválidos","details":"/api/v1/resource","errorCode":{"code":"VFLD01","desc":"Valor informado inválido"},"validationErrors":[{"field":"anoConsolidacao","rejectedValue":"202A","message":"Falha ao converter a propriedade 'anoConsolidacao'"}]}}}},"401":{"description":"Acesso negado, O usuário não está autenticado ou possui credenciais inválidas","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.766+00:00","message":"É necessário estar autenticado para acessar este recurso","details":"/api/v1/resource","errorCode":{"code":"EXPTK01","desc":"Token inválido ou expirado"}}}}},"403":{"description":"Proibido, o usuário autenticado não possui a permissão de acesso para o recurso solicitado.","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.766+00:00","message":"Voce nao tem permissao para acessar este recurso","details":"/api/v1/resource"}}}},"404":{"description":"Recurso não encontrado","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.766+00:00","message":"Registro de código '123' não encontrado","details":"/api/v1/resource"}}}},"500":{"description":"Erro inesperado, ocorreu algum erro interno no servidor","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.766+00:00","message":"Erro desconhecido","details":"/api/v1/resource"}}}}}}},"/api/v1/basicos/perfis/{idPerfil}/foto":{"get":{"tags":["Perfis"],"summary":"Visualizar Foto de Perfil","description":"Mostra a foto de um perfil selecionado","operationId":"visualizarFotoPerfil_1","parameters":[{"name":"idPerfil","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"application/octet-stream":{"schema":{"type":"array","items":{"type":"string","format":"byte"}}}}},"400":{"description":"Solicitação inválida, contém erros de tipos ou de formatação","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.965+00:00","message":"Um ou mais campos estão inválidos","details":"/api/v1/resource","errorCode":{"code":"VFLD01","desc":"Valor informado inválido"},"validationErrors":[{"field":"anoConsolidacao","rejectedValue":"202A","message":"Falha ao converter a propriedade 'anoConsolidacao'"}]}}}},"401":{"description":"Acesso negado, O usuário não está autenticado ou possui credenciais inválidas","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.965+00:00","message":"É necessário estar autenticado para acessar este recurso","details":"/api/v1/resource","errorCode":{"code":"EXPTK01","desc":"Token inválido ou expirado"}}}}},"403":{"description":"Proibido, o usuário autenticado não possui a permissão de acesso para o recurso solicitado.","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.965+00:00","message":"Voce nao tem permissao para acessar este recurso","details":"/api/v1/resource"}}}},"404":{"description":"Recurso não encontrado","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.965+00:00","message":"Registro de código '123' não encontrado","details":"/api/v1/resource"}}}},"500":{"description":"Erro inesperado, ocorreu algum erro interno no servidor","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.965+00:00","message":"Erro desconhecido","details":"/api/v1/resource"}}}}}},"post":{"tags":["Perfis"],"summary":"Upload da Foto de Perfil","description":"Adiciona foto ao Perfil. A imagem deve ter um tamanho máximo de 5024KBytes e ser do tipo PNG, JPG ou JPEG.","operationId":"uploadFotoPerfil_1","parameters":[{"name":"idPerfil","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"required":["file"],"type":"object","properties":{"file":{"type":"string","format":"binary"}}}}}},"responses":{"201":{"description":"Created"},"400":{"description":"Solicitação inválida, contém erros de tipos ou de formatação","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.774+00:00","message":"Um ou mais campos estão inválidos","details":"/api/v1/resource","errorCode":{"code":"VFLD01","desc":"Valor informado inválido"},"validationErrors":[{"field":"anoConsolidacao","rejectedValue":"202A","message":"Falha ao converter a propriedade 'anoConsolidacao'"}]}}}},"401":{"description":"Acesso negado, O usuário não está autenticado ou possui credenciais inválidas","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.774+00:00","message":"É necessário estar autenticado para acessar este recurso","details":"/api/v1/resource","errorCode":{"code":"EXPTK01","desc":"Token inválido ou expirado"}}}}},"403":{"description":"Proibido, o usuário autenticado não possui a permissão de acesso para o recurso solicitado.","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.774+00:00","message":"Voce nao tem permissao para acessar este recurso","details":"/api/v1/resource"}}}},"404":{"description":"Recurso não encontrado","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.774+00:00","message":"Registro de código '123' não encontrado","details":"/api/v1/resource"}}}},"500":{"description":"Erro inesperado, ocorreu algum erro interno no servidor","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.774+00:00","message":"Erro desconhecido","details":"/api/v1/resource"}}}}}}},"/api/v1/basicos/perfil-responsavel":{"get":{"tags":["Responsável"],"summary":"Consultar responsáveis dos perfis","description":"Lista todos os responsáveis dos perfis","operationId":"list_6","parameters":[{"name":"idPerfilResponsavel","in":"query","description":"ID do responsável financeiro","required":false,"schema":{"type":"integer","format":"int32"},"example":1},{"name":"idPerfil","in":"query","description":"ID do perfil do aluno","required":false,"schema":{"type":"integer","format":"int32"},"example":1},{"name":"search","in":"query","description":"Realiza busca por: Nome do Responsável financeiro","required":false,"schema":{"type":"string"},"example":"Foo Bar"},{"name":"pageSize","in":"query","description":"Total de registros que serão retornados a cada consulta (máximo de 500)","required":true,"schema":{"type":"integer","format":"int32"},"example":100},{"name":"currentPage","in":"query","description":"Página atual dos resultados","required":false,"schema":{"type":"integer","format":"int32"},"example":1}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginationPerfilResponsavelDtoResPage"}}}},"400":{"description":"Solicitação inválida, contém erros de tipos ou de formatação","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.973+00:00","message":"Um ou mais campos estão inválidos","details":"/api/v1/resource","errorCode":{"code":"VFLD01","desc":"Valor informado inválido"},"validationErrors":[{"field":"anoConsolidacao","rejectedValue":"202A","message":"Falha ao converter a propriedade 'anoConsolidacao'"}]}}}},"401":{"description":"Acesso negado, O usuário não está autenticado ou possui credenciais inválidas","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.973+00:00","message":"É necessário estar autenticado para acessar este recurso","details":"/api/v1/resource","errorCode":{"code":"EXPTK01","desc":"Token inválido ou expirado"}}}}},"403":{"description":"Proibido, o usuário autenticado não possui a permissão de acesso para o recurso solicitado.","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.973+00:00","message":"Voce nao tem permissao para acessar este recurso","details":"/api/v1/resource"}}}},"404":{"description":"Recurso não encontrado","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.973+00:00","message":"Registro de código '123' não encontrado","details":"/api/v1/resource"}}}},"500":{"description":"Erro inesperado, ocorreu algum erro interno no servidor","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.973+00:00","message":"Erro desconhecido","details":"/api/v1/resource"}}}}}},"post":{"tags":["Responsável"],"summary":"Cadastrar perfil responsável","description":"Permite cadastrar um perfil responsável","operationId":"create","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PerfilResponsavelDtoReq"}}},"required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PerfilResponsavelDtoRes"}}}},"400":{"description":"Solicitação inválida, contém erros de tipos ou de formatação","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.783+00:00","message":"Um ou mais campos estão inválidos","details":"/api/v1/resource","errorCode":{"code":"VFLD01","desc":"Valor informado inválido"},"validationErrors":[{"field":"anoConsolidacao","rejectedValue":"202A","message":"Falha ao converter a propriedade 'anoConsolidacao'"}]}}}},"401":{"description":"Acesso negado, O usuário não está autenticado ou possui credenciais inválidas","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.783+00:00","message":"É necessário estar autenticado para acessar este recurso","details":"/api/v1/resource","errorCode":{"code":"EXPTK01","desc":"Token inválido ou expirado"}}}}},"403":{"description":"Proibido, o usuário autenticado não possui a permissão de acesso para o recurso solicitado.","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.783+00:00","message":"Voce nao tem permissao para acessar este recurso","details":"/api/v1/resource"}}}},"404":{"description":"Recurso não encontrado","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.783+00:00","message":"Registro de código '123' não encontrado","details":"/api/v1/resource"}}}},"500":{"description":"Erro inesperado, ocorreu algum erro interno no servidor","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.783+00:00","message":"Erro desconhecido","details":"/api/v1/resource"}}}}}}},"/api/v1/basicos/locais/paises":{"get":{"tags":["Locais"],"summary":"Consultar Países","description":"Lista todos os países cadastrados na instituição.","operationId":"list_8","parameters":[{"name":"idPais","in":"query","description":"ID do País","required":false,"schema":{"type":"integer","format":"int32"},"example":1},{"name":"pageSize","in":"query","description":"Total de registros que serão retornados a cada consulta (máximo de 500)","required":true,"schema":{"type":"integer","format":"int32"},"example":100},{"name":"currentPage","in":"query","description":"Página atual dos resultados","required":false,"schema":{"type":"integer","format":"int32"},"example":1}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginationPaisDtoResPage"}}}},"400":{"description":"Solicitação inválida, contém erros de tipos ou de formatação","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.984+00:00","message":"Um ou mais campos estão inválidos","details":"/api/v1/resource","errorCode":{"code":"VFLD01","desc":"Valor informado inválido"},"validationErrors":[{"field":"anoConsolidacao","rejectedValue":"202A","message":"Falha ao converter a propriedade 'anoConsolidacao'"}]}}}},"401":{"description":"Acesso negado, O usuário não está autenticado ou possui credenciais inválidas","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.984+00:00","message":"É necessário estar autenticado para acessar este recurso","details":"/api/v1/resource","errorCode":{"code":"EXPTK01","desc":"Token inválido ou expirado"}}}}},"403":{"description":"Proibido, o usuário autenticado não possui a permissão de acesso para o recurso solicitado.","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.984+00:00","message":"Voce nao tem permissao para acessar este recurso","details":"/api/v1/resource"}}}},"404":{"description":"Recurso não encontrado","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.984+00:00","message":"Registro de código '123' não encontrado","details":"/api/v1/resource"}}}},"500":{"description":"Erro inesperado, ocorreu algum erro interno no servidor","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.984+00:00","message":"Erro desconhecido","details":"/api/v1/resource"}}}}}},"post":{"tags":["Locais"],"summary":"Cadastrar País","description":"Permite cadastrar um País.","operationId":"cadastroPais","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaisDtoReq"}}},"required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaisRest"}}}},"400":{"description":"Solicitação inválida, contém erros de tipos ou de formatação","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.789+00:00","message":"Um ou mais campos estão inválidos","details":"/api/v1/resource","errorCode":{"code":"VFLD01","desc":"Valor informado inválido"},"validationErrors":[{"field":"anoConsolidacao","rejectedValue":"202A","message":"Falha ao converter a propriedade 'anoConsolidacao'"}]}}}},"401":{"description":"Acesso negado, O usuário não está autenticado ou possui credenciais inválidas","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.789+00:00","message":"É necessário estar autenticado para acessar este recurso","details":"/api/v1/resource","errorCode":{"code":"EXPTK01","desc":"Token inválido ou expirado"}}}}},"403":{"description":"Proibido, o usuário autenticado não possui a permissão de acesso para o recurso solicitado.","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.789+00:00","message":"Voce nao tem permissao para acessar este recurso","details":"/api/v1/resource"}}}},"404":{"description":"Recurso não encontrado","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.789+00:00","message":"Registro de código '123' não encontrado","details":"/api/v1/resource"}}}},"500":{"description":"Erro inesperado, ocorreu algum erro interno no servidor","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.789+00:00","message":"Erro desconhecido","details":"/api/v1/resource"}}}}}}},"/api/v1/basicos/locais/estados":{"get":{"tags":["Locais"],"summary":"Consultar Estados","description":"Lista todos os estados cadastrados na instituição.","operationId":"list_10","parameters":[{"name":"idEstado","in":"query","description":"ID do Estado","required":false,"schema":{"type":"integer","format":"int32"},"example":1},{"name":"idPais","in":"query","description":"ID do País","required":false,"schema":{"type":"integer","format":"int32"},"example":1},{"name":"pageSize","in":"query","description":"Total de registros que serão retornados a cada consulta (máximo de 500)","required":true,"schema":{"type":"integer","format":"int32"},"example":100},{"name":"currentPage","in":"query","description":"Página atual dos resultados","required":false,"schema":{"type":"integer","format":"int32"},"example":1}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginationEstadoDtoResPage"}}}},"400":{"description":"Solicitação inválida, contém erros de tipos ou de formatação","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.995+00:00","message":"Um ou mais campos estão inválidos","details":"/api/v1/resource","errorCode":{"code":"VFLD01","desc":"Valor informado inválido"},"validationErrors":[{"field":"anoConsolidacao","rejectedValue":"202A","message":"Falha ao converter a propriedade 'anoConsolidacao'"}]}}}},"401":{"description":"Acesso negado, O usuário não está autenticado ou possui credenciais inválidas","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.995+00:00","message":"É necessário estar autenticado para acessar este recurso","details":"/api/v1/resource","errorCode":{"code":"EXPTK01","desc":"Token inválido ou expirado"}}}}},"403":{"description":"Proibido, o usuário autenticado não possui a permissão de acesso para o recurso solicitado.","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.995+00:00","message":"Voce nao tem permissao para acessar este recurso","details":"/api/v1/resource"}}}},"404":{"description":"Recurso não encontrado","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.995+00:00","message":"Registro de código '123' não encontrado","details":"/api/v1/resource"}}}},"500":{"description":"Erro inesperado, ocorreu algum erro interno no servidor","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.995+00:00","message":"Erro desconhecido","details":"/api/v1/resource"}}}}}},"post":{"tags":["Locais"],"summary":"Cadastrar Estado","description":"Permite cadastrar um Estado.","operationId":"cadastroEstado","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EstadoDtoReq"}}},"required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EstadoRest"}}}},"400":{"description":"Solicitação inválida, contém erros de tipos ou de formatação","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.796+00:00","message":"Um ou mais campos estão inválidos","details":"/api/v1/resource","errorCode":{"code":"VFLD01","desc":"Valor informado inválido"},"validationErrors":[{"field":"anoConsolidacao","rejectedValue":"202A","message":"Falha ao converter a propriedade 'anoConsolidacao'"}]}}}},"401":{"description":"Acesso negado, O usuário não está autenticado ou possui credenciais inválidas","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.796+00:00","message":"É necessário estar autenticado para acessar este recurso","details":"/api/v1/resource","errorCode":{"code":"EXPTK01","desc":"Token inválido ou expirado"}}}}},"403":{"description":"Proibido, o usuário autenticado não possui a permissão de acesso para o recurso solicitado.","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.796+00:00","message":"Voce nao tem permissao para acessar este recurso","details":"/api/v1/resource"}}}},"404":{"description":"Recurso não encontrado","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.796+00:00","message":"Registro de código '123' não encontrado","details":"/api/v1/resource"}}}},"500":{"description":"Erro inesperado, ocorreu algum erro interno no servidor","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.796+00:00","message":"Erro desconhecido","details":"/api/v1/resource"}}}}}}},"/api/v1/basicos/locais/cidades":{"get":{"tags":["Locais"],"summary":"Consultar Cidades","description":"Lista todas as cidades cadastradas na instituição.","operationId":"list_11","parameters":[{"name":"idCidade","in":"query","description":"ID da Cidade","required":false,"schema":{"type":"integer","format":"int32"},"example":1},{"name":"idEstado","in":"query","description":"ID do Estado","required":false,"schema":{"type":"integer","format":"int32"},"example":1},{"name":"idPais","in":"query","description":"ID do País","required":false,"schema":{"type":"integer","format":"int32"},"example":1},{"name":"uf","in":"query","description":"UF","required":false,"schema":{"type":"string"},"example":"PR"},{"name":"search","in":"query","description":"Realiza busca por: Nome","required":false,"schema":{"type":"string"},"example":"São Paulo"},{"name":"pageSize","in":"query","description":"Total de registros que serão retornados a cada consulta (máximo de 500)","required":true,"schema":{"type":"integer","format":"int32"},"example":100},{"name":"currentPage","in":"query","description":"Página atual dos resultados","required":false,"schema":{"type":"integer","format":"int32"},"example":1}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginationCidadeDtoResPage"}}}},"400":{"description":"Solicitação inválida, contém erros de tipos ou de formatação","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:03.001+00:00","message":"Um ou mais campos estão inválidos","details":"/api/v1/resource","errorCode":{"code":"VFLD01","desc":"Valor informado inválido"},"validationErrors":[{"field":"anoConsolidacao","rejectedValue":"202A","message":"Falha ao converter a propriedade 'anoConsolidacao'"}]}}}},"401":{"description":"Acesso negado, O usuário não está autenticado ou possui credenciais inválidas","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:03.001+00:00","message":"É necessário estar autenticado para acessar este recurso","details":"/api/v1/resource","errorCode":{"code":"EXPTK01","desc":"Token inválido ou expirado"}}}}},"403":{"description":"Proibido, o usuário autenticado não possui a permissão de acesso para o recurso solicitado.","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:03.001+00:00","message":"Voce nao tem permissao para acessar este recurso","details":"/api/v1/resource"}}}},"404":{"description":"Recurso não encontrado","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:03.001+00:00","message":"Registro de código '123' não encontrado","details":"/api/v1/resource"}}}},"500":{"description":"Erro inesperado, ocorreu algum erro interno no servidor","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:03.001+00:00","message":"Erro desconhecido","details":"/api/v1/resource"}}}}}},"post":{"tags":["Locais"],"summary":"Cadastrar Cidade","description":"Permite cadastrar uma Cidade.","operationId":"cadastroCidade","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CidadeDtoReq"}}},"required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CidadeRest"}}}},"400":{"description":"Solicitação inválida, contém erros de tipos ou de formatação","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.800+00:00","message":"Um ou mais campos estão inválidos","details":"/api/v1/resource","errorCode":{"code":"VFLD01","desc":"Valor informado inválido"},"validationErrors":[{"field":"anoConsolidacao","rejectedValue":"202A","message":"Falha ao converter a propriedade 'anoConsolidacao'"}]}}}},"401":{"description":"Acesso negado, O usuário não está autenticado ou possui credenciais inválidas","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.800+00:00","message":"É necessário estar autenticado para acessar este recurso","details":"/api/v1/resource","errorCode":{"code":"EXPTK01","desc":"Token inválido ou expirado"}}}}},"403":{"description":"Proibido, o usuário autenticado não possui a permissão de acesso para o recurso solicitado.","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.800+00:00","message":"Voce nao tem permissao para acessar este recurso","details":"/api/v1/resource"}}}},"404":{"description":"Recurso não encontrado","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.800+00:00","message":"Registro de código '123' não encontrado","details":"/api/v1/resource"}}}},"500":{"description":"Erro inesperado, ocorreu algum erro interno no servidor","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.800+00:00","message":"Erro desconhecido","details":"/api/v1/resource"}}}}}}},"/api/v1/basicos/bloqueio-perfil":{"get":{"tags":["Bloqueios de Perfis"],"summary":"Consulta de bloqueio de perfil","operationId":"list_16","parameters":[{"name":"search","in":"query","description":"Like sobre o campo 'nome pagador e mensagem'","required":false,"schema":{"type":"string"}},{"name":"idPagador","in":"query","description":"Código do pagador (perfil)","required":false,"schema":{"type":"integer","format":"int32"},"example":12345},{"name":"idOrg","in":"query","description":"Organização do pagador","required":false,"schema":{"type":"integer","format":"int32"},"example":1},{"name":"idPerfilBloqueio","in":"query","description":"Código do bloqueio","required":false,"schema":{"type":"integer","format":"int32"},"example":678},{"name":"recurso","in":"query","description":"Recurso bloqueado (MATRICULA, REMATRICULA, AVA)","required":false,"schema":{"type":"string","enum":["AVA","REMATRICULA","MATRICULA"]},"example":"AVA"},{"name":"status","in":"query","description":"Status da retenção (ATIVO ou INATIVO)","required":false,"schema":{"type":"string","enum":["ATIVO","INATIVO"]},"example":"ATIVO"},{"name":"tipoReferencia","in":"query","description":"Tipo de referência de integração","required":false,"schema":{"type":"string"},"example":"PARCELA"},{"name":"idReferencia","in":"query","description":"ID da referência de integração","required":false,"schema":{"type":"integer","format":"int32"},"example":1234},{"name":"pageSize","in":"query","description":"Total de registros que serão retornados a cada consulta (máximo de 500)","required":true,"schema":{"type":"integer","format":"int32"},"example":100},{"name":"currentPage","in":"query","description":"Página atual dos resultados","required":false,"schema":{"type":"integer","format":"int32"},"example":1}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginationPerfilBloqueioDtoResPage"}}}},"400":{"description":"Solicitação inválida, contém erros de tipos ou de formatação","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:03.035+00:00","message":"Um ou mais campos estão inválidos","details":"/api/v1/resource","errorCode":{"code":"VFLD01","desc":"Valor informado inválido"},"validationErrors":[{"field":"anoConsolidacao","rejectedValue":"202A","message":"Falha ao converter a propriedade 'anoConsolidacao'"}]}}}},"401":{"description":"Acesso negado, O usuário não está autenticado ou possui credenciais inválidas","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:03.035+00:00","message":"É necessário estar autenticado para acessar este recurso","details":"/api/v1/resource","errorCode":{"code":"EXPTK01","desc":"Token inválido ou expirado"}}}}},"403":{"description":"Proibido, o usuário autenticado não possui a permissão de acesso para o recurso solicitado.","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:03.035+00:00","message":"Voce nao tem permissao para acessar este recurso","details":"/api/v1/resource"}}}},"404":{"description":"Recurso não encontrado","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:03.035+00:00","message":"Registro de código '123' não encontrado","details":"/api/v1/resource"}}}},"500":{"description":"Erro inesperado, ocorreu algum erro interno no servidor","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:03.035+00:00","message":"Erro desconhecido","details":"/api/v1/resource"}}}}}},"post":{"tags":["Bloqueios de Perfis"],"summary":"Cadastro de bloqueio de perfil","operationId":"create_1","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PerfilBloqueioDtoReq"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PerfilBloqueioDtoRes"}}}},"400":{"description":"Solicitação inválida, contém erros de tipos ou de formatação","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.803+00:00","message":"Um ou mais campos estão inválidos","details":"/api/v1/resource","errorCode":{"code":"VFLD01","desc":"Valor informado inválido"},"validationErrors":[{"field":"anoConsolidacao","rejectedValue":"202A","message":"Falha ao converter a propriedade 'anoConsolidacao'"}]}}}},"401":{"description":"Acesso negado, O usuário não está autenticado ou possui credenciais inválidas","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.803+00:00","message":"É necessário estar autenticado para acessar este recurso","details":"/api/v1/resource","errorCode":{"code":"EXPTK01","desc":"Token inválido ou expirado"}}}}},"403":{"description":"Proibido, o usuário autenticado não possui a permissão de acesso para o recurso solicitado.","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.803+00:00","message":"Voce nao tem permissao para acessar este recurso","details":"/api/v1/resource"}}}},"404":{"description":"Recurso não encontrado","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.803+00:00","message":"Registro de código '123' não encontrado","details":"/api/v1/resource"}}}},"500":{"description":"Erro inesperado, ocorreu algum erro interno no servidor","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.803+00:00","message":"Erro desconhecido","details":"/api/v1/resource"}}}}}}},"/api/v1/auth/token":{"post":{"tags":["Autenticação"],"summary":"Realiza a autenticação via token","description":"Autentica o usuário a partir de um token de acesso a API cadastrado através do sistema acadêmico (desktop)","operationId":"token","parameters":[{"name":"token","in":"header","required":true,"schema":{"maximum":40,"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserInfo"}}}},"400":{"description":"Solicitação inválida, contém erros de tipos ou de formatação","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.845+00:00","message":"Um ou mais campos estão inválidos","details":"/api/v1/resource","errorCode":{"code":"VFLD01","desc":"Valor informado inválido"},"validationErrors":[{"field":"anoConsolidacao","rejectedValue":"202A","message":"Falha ao converter a propriedade 'anoConsolidacao'"}]}}}},"401":{"description":"Acesso negado, O usuário não está autenticado ou possui credenciais inválidas","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.845+00:00","message":"É necessário estar autenticado para acessar este recurso","details":"/api/v1/resource","errorCode":{"code":"EXPTK01","desc":"Token inválido ou expirado"}}}}},"403":{"description":"Proibido, o usuário autenticado não possui a permissão de acesso para o recurso solicitado.","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.845+00:00","message":"Voce nao tem permissao para acessar este recurso","details":"/api/v1/resource"}}}},"404":{"description":"Recurso não encontrado","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.845+00:00","message":"Registro de código '123' não encontrado","details":"/api/v1/resource"}}}},"500":{"description":"Erro inesperado, ocorreu algum erro interno no servidor","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.845+00:00","message":"Erro desconhecido","details":"/api/v1/resource"}}}}},"security":[]}},"/api/v2/basicos/unidades-fisicas":{"get":{"tags":["Câmpus/Polo V2"],"summary":"Consulta de Câmpus/Polo","description":"Lista todas os Câmpus/Polo cadastrados.","operationId":"list","parameters":[{"name":"idEstado","in":"query","description":"ID do Estado","required":false,"schema":{"type":"integer","format":"int32"},"example":1},{"name":"idCidade","in":"query","description":"ID da Cidade","required":false,"schema":{"type":"integer","format":"int32"},"example":1},{"name":"idPerfilResponsavel","in":"query","description":"ID do Supervisor","required":false,"schema":{"type":"integer","format":"int32"},"example":1},{"name":"idUnidadeFisica","in":"query","description":"ID da Unidade Fisica","required":false,"schema":{"type":"integer","format":"int32"},"example":1},{"name":"nome","in":"query","description":"Nome do Câmpus/Polo","required":false,"schema":{"type":"string"},"example":"Polo Exemplo"},{"name":"cnpj","in":"query","description":"CNPJ do Câmpus/Polo","required":false,"schema":{"type":"string"},"example":99999999000999},{"name":"status","in":"query","description":"Status da Unidade","required":false,"schema":{"type":"string","enum":["ATIVO","INATIVO"]},"example":"ATIVO"},{"name":"tipoUnidade","in":"query","description":"Tipo da Unidade","required":false,"schema":{"type":"string","enum":["NAO_INFORMADO","CAMPUS","POLO"]},"example":"NAO_INFORMADO"},{"name":"dataAlteracaoInicio","in":"query","description":"Data alteração início","required":false,"schema":{"type":"string","format":"date-time"},"example":"2024-01-30"},{"name":"horaAlteracaoInicio","in":"query","description":"Hora alteração início (Requer a Data alteração início)","required":false,"schema":{"type":"string","format":"date-time"},"example":"00:00:00"},{"name":"dataAlteracaoFim","in":"query","description":"Data alteração fim","required":false,"schema":{"type":"string","format":"date-time"},"example":"2024-01-30"},{"name":"horaAlteracaoFim","in":"query","description":"Hora alteração fim (Requer a Data alteração fim)","required":false,"schema":{"type":"string","format":"date-time"},"example":"23:59:59"},{"name":"pageSize","in":"query","description":"Total de registros que serão retornados a cada consulta (máximo de 5000)","required":true,"schema":{"maximum":5000,"type":"integer","format":"int32"},"example":5000},{"name":"idCursor","in":"query","description":"Código primário da consulta, começa com 0, utilizado para páginação","required":false,"schema":{"type":"integer","format":"int32"},"example":0},{"name":"currentPage","in":"query","description":"Página atual dos resultados","required":false,"schema":{"type":"integer","format":"int32"},"example":1}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginationUnidadeFisicaDtoResPageCursor"}}}},"400":{"description":"Solicitação inválida, contém erros de tipos ou de formatação","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.858+00:00","message":"Um ou mais campos estão inválidos","details":"/api/v1/resource","errorCode":{"code":"VFLD01","desc":"Valor informado inválido"},"validationErrors":[{"field":"anoConsolidacao","rejectedValue":"202A","message":"Falha ao converter a propriedade 'anoConsolidacao'"}]}}}},"401":{"description":"Acesso negado, O usuário não está autenticado ou possui credenciais inválidas","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.858+00:00","message":"É necessário estar autenticado para acessar este recurso","details":"/api/v1/resource","errorCode":{"code":"EXPTK01","desc":"Token inválido ou expirado"}}}}},"403":{"description":"Proibido, o usuário autenticado não possui a permissão de acesso para o recurso solicitado.","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.858+00:00","message":"Voce nao tem permissao para acessar este recurso","details":"/api/v1/resource"}}}},"404":{"description":"Recurso não encontrado","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.858+00:00","message":"Registro de código '123' não encontrado","details":"/api/v1/resource"}}}},"500":{"description":"Erro inesperado, ocorreu algum erro interno no servidor","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.858+00:00","message":"Erro desconhecido","details":"/api/v1/resource"}}}}}}},"/api/v2/basicos/perfis/{id_perfil}":{"get":{"tags":["Perfis V2"],"summary":"Dados do Perfil","description":"Retorna todos os dados cadastrais de um perfil informado","operationId":"findById","parameters":[{"name":"id_perfil","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PerfilRest"}}}},"400":{"description":"Solicitação inválida, contém erros de tipos ou de formatação","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.900+00:00","message":"Um ou mais campos estão inválidos","details":"/api/v1/resource","errorCode":{"code":"VFLD01","desc":"Valor informado inválido"},"validationErrors":[{"field":"anoConsolidacao","rejectedValue":"202A","message":"Falha ao converter a propriedade 'anoConsolidacao'"}]}}}},"401":{"description":"Acesso negado, O usuário não está autenticado ou possui credenciais inválidas","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.900+00:00","message":"É necessário estar autenticado para acessar este recurso","details":"/api/v1/resource","errorCode":{"code":"EXPTK01","desc":"Token inválido ou expirado"}}}}},"403":{"description":"Proibido, o usuário autenticado não possui a permissão de acesso para o recurso solicitado.","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.900+00:00","message":"Voce nao tem permissao para acessar este recurso","details":"/api/v1/resource"}}}},"404":{"description":"Recurso não encontrado","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.900+00:00","message":"Registro de código '123' não encontrado","details":"/api/v1/resource"}}}},"500":{"description":"Erro inesperado, ocorreu algum erro interno no servidor","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.900+00:00","message":"Erro desconhecido","details":"/api/v1/resource"}}}}}}},"/api/v1/basicos/unidades-fisicas":{"get":{"tags":["Câmpus/Polo"],"summary":"Consulta de Câmpus/Polo","description":"Lista todas os Câmpus/Polo cadastrados.","operationId":"list_2","parameters":[{"name":"idEstado","in":"query","description":"ID do Estado","required":false,"schema":{"type":"integer","format":"int32"},"example":1},{"name":"idCidade","in":"query","description":"ID da Cidade","required":false,"schema":{"type":"integer","format":"int32"},"example":1},{"name":"idPerfilResponsavel","in":"query","description":"ID do Supervisor","required":false,"schema":{"type":"integer","format":"int32"},"example":1},{"name":"idUnidadeFisica","in":"query","description":"ID da Unidade Fisica","required":false,"schema":{"type":"integer","format":"int32"},"example":1},{"name":"status","in":"query","description":"Status da Unidade","required":false,"schema":{"type":"string","enum":["ATIVO","INATIVO"]},"example":"ATIVO"},{"name":"tipoUnidade","in":"query","description":"Tipo da Unidade","required":false,"schema":{"type":"string","enum":["NAO_INFORMADO","CAMPUS","POLO"]},"example":"NAO_INFORMADO"},{"name":"pageSize","in":"query","description":"Total de registros que serão retornados a cada consulta (máximo de 500)","required":true,"schema":{"type":"integer","format":"int32"},"example":100},{"name":"currentPage","in":"query","description":"Página atual dos resultados","required":false,"schema":{"type":"integer","format":"int32"},"example":1}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginationUnidadeFisicaDtoResPage"}}}},"400":{"description":"Solicitação inválida, contém erros de tipos ou de formatação","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.914+00:00","message":"Um ou mais campos estão inválidos","details":"/api/v1/resource","errorCode":{"code":"VFLD01","desc":"Valor informado inválido"},"validationErrors":[{"field":"anoConsolidacao","rejectedValue":"202A","message":"Falha ao converter a propriedade 'anoConsolidacao'"}]}}}},"401":{"description":"Acesso negado, O usuário não está autenticado ou possui credenciais inválidas","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.914+00:00","message":"É necessário estar autenticado para acessar este recurso","details":"/api/v1/resource","errorCode":{"code":"EXPTK01","desc":"Token inválido ou expirado"}}}}},"403":{"description":"Proibido, o usuário autenticado não possui a permissão de acesso para o recurso solicitado.","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.914+00:00","message":"Voce nao tem permissao para acessar este recurso","details":"/api/v1/resource"}}}},"404":{"description":"Recurso não encontrado","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.914+00:00","message":"Registro de código '123' não encontrado","details":"/api/v1/resource"}}}},"500":{"description":"Erro inesperado, ocorreu algum erro interno no servidor","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.914+00:00","message":"Erro desconhecido","details":"/api/v1/resource"}}}}}}},"/api/v1/basicos/setores":{"get":{"tags":["Setores"],"summary":"Consulta de Setores","description":"Retorna os dados de todos os setores da instituição.","operationId":"list_3","parameters":[{"name":"idSetor","in":"query","description":"ID da Função","required":false,"schema":{"type":"integer","format":"int32"},"example":1},{"name":"tipo","in":"query","description":"Tipo","required":false,"schema":{"$ref":"#/components/schemas/TipoSetor"},"example":"NAO_INFORMADO"},{"name":"search","in":"query","description":"Realiza busca por: Nome do setor","required":false,"schema":{"type":"string"},"example":"Foo Bar"},{"name":"pageSize","in":"query","description":"Total de registros que serão retornados a cada consulta (máximo de 500)","required":true,"schema":{"type":"integer","format":"int32"},"example":100},{"name":"currentPage","in":"query","description":"Página atual dos resultados","required":false,"schema":{"type":"integer","format":"int32"},"example":1}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginationSetorDtoResPage"}}}},"400":{"description":"Solicitação inválida, contém erros de tipos ou de formatação","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.922+00:00","message":"Um ou mais campos estão inválidos","details":"/api/v1/resource","errorCode":{"code":"VFLD01","desc":"Valor informado inválido"},"validationErrors":[{"field":"anoConsolidacao","rejectedValue":"202A","message":"Falha ao converter a propriedade 'anoConsolidacao'"}]}}}},"401":{"description":"Acesso negado, O usuário não está autenticado ou possui credenciais inválidas","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.922+00:00","message":"É necessário estar autenticado para acessar este recurso","details":"/api/v1/resource","errorCode":{"code":"EXPTK01","desc":"Token inválido ou expirado"}}}}},"403":{"description":"Proibido, o usuário autenticado não possui a permissão de acesso para o recurso solicitado.","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.922+00:00","message":"Voce nao tem permissao para acessar este recurso","details":"/api/v1/resource"}}}},"404":{"description":"Recurso não encontrado","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.922+00:00","message":"Registro de código '123' não encontrado","details":"/api/v1/resource"}}}},"500":{"description":"Erro inesperado, ocorreu algum erro interno no servidor","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.922+00:00","message":"Erro desconhecido","details":"/api/v1/resource"}}}}}}},"/api/v1/basicos/perfis/{id_perfil}":{"get":{"tags":["Perfis"],"summary":"Dados do Perfil","description":"Retorna todos os dados cadastrais de um perfil informado","operationId":"findById_1","parameters":[{"name":"id_perfil","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PerfilRest"}}}},"400":{"description":"Solicitação inválida, contém erros de tipos ou de formatação","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.960+00:00","message":"Um ou mais campos estão inválidos","details":"/api/v1/resource","errorCode":{"code":"VFLD01","desc":"Valor informado inválido"},"validationErrors":[{"field":"anoConsolidacao","rejectedValue":"202A","message":"Falha ao converter a propriedade 'anoConsolidacao'"}]}}}},"401":{"description":"Acesso negado, O usuário não está autenticado ou possui credenciais inválidas","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.960+00:00","message":"É necessário estar autenticado para acessar este recurso","details":"/api/v1/resource","errorCode":{"code":"EXPTK01","desc":"Token inválido ou expirado"}}}}},"403":{"description":"Proibido, o usuário autenticado não possui a permissão de acesso para o recurso solicitado.","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.960+00:00","message":"Voce nao tem permissao para acessar este recurso","details":"/api/v1/resource"}}}},"404":{"description":"Recurso não encontrado","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.960+00:00","message":"Registro de código '123' não encontrado","details":"/api/v1/resource"}}}},"500":{"description":"Erro inesperado, ocorreu algum erro interno no servidor","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.960+00:00","message":"Erro desconhecido","details":"/api/v1/resource"}}}}}}},"/api/v1/basicos/perfis/{id_perfil}/credenciais":{"get":{"tags":["Perfis"],"summary":"Dados de Acesso do Perfil","description":"Retorna os dados de login e senha de um perfil informado","operationId":"list_5","parameters":[{"name":"id_perfil","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PerfilDadosAcessoRest"}}}},"400":{"description":"Solicitação inválida, contém erros de tipos ou de formatação","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.962+00:00","message":"Um ou mais campos estão inválidos","details":"/api/v1/resource","errorCode":{"code":"VFLD01","desc":"Valor informado inválido"},"validationErrors":[{"field":"anoConsolidacao","rejectedValue":"202A","message":"Falha ao converter a propriedade 'anoConsolidacao'"}]}}}},"401":{"description":"Acesso negado, O usuário não está autenticado ou possui credenciais inválidas","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.962+00:00","message":"É necessário estar autenticado para acessar este recurso","details":"/api/v1/resource","errorCode":{"code":"EXPTK01","desc":"Token inválido ou expirado"}}}}},"403":{"description":"Proibido, o usuário autenticado não possui a permissão de acesso para o recurso solicitado.","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.962+00:00","message":"Voce nao tem permissao para acessar este recurso","details":"/api/v1/resource"}}}},"404":{"description":"Recurso não encontrado","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.962+00:00","message":"Registro de código '123' não encontrado","details":"/api/v1/resource"}}}},"500":{"description":"Erro inesperado, ocorreu algum erro interno no servidor","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.962+00:00","message":"Erro desconhecido","details":"/api/v1/resource"}}}}}}},"/api/v1/basicos/organizacoes":{"get":{"tags":["Organizações"],"summary":"Consulta de Organizações","description":"Lista todos as organizações cadastradas.","operationId":"list_7","parameters":[{"name":"search","in":"query","description":"Realiza busca por: Nome da organização","required":false,"schema":{"type":"string"},"example":"Foo Bar"},{"name":"pageSize","in":"query","description":"Total de registros que serão retornados a cada consulta (máximo de 500)","required":true,"schema":{"type":"integer","format":"int32"},"example":100},{"name":"currentPage","in":"query","description":"Página atual dos resultados","required":false,"schema":{"type":"integer","format":"int32"},"example":1}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginationOrganizacaoDtoResPage"}}}},"400":{"description":"Solicitação inválida, contém erros de tipos ou de formatação","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.979+00:00","message":"Um ou mais campos estão inválidos","details":"/api/v1/resource","errorCode":{"code":"VFLD01","desc":"Valor informado inválido"},"validationErrors":[{"field":"anoConsolidacao","rejectedValue":"202A","message":"Falha ao converter a propriedade 'anoConsolidacao'"}]}}}},"401":{"description":"Acesso negado, O usuário não está autenticado ou possui credenciais inválidas","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.979+00:00","message":"É necessário estar autenticado para acessar este recurso","details":"/api/v1/resource","errorCode":{"code":"EXPTK01","desc":"Token inválido ou expirado"}}}}},"403":{"description":"Proibido, o usuário autenticado não possui a permissão de acesso para o recurso solicitado.","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.979+00:00","message":"Voce nao tem permissao para acessar este recurso","details":"/api/v1/resource"}}}},"404":{"description":"Recurso não encontrado","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.979+00:00","message":"Registro de código '123' não encontrado","details":"/api/v1/resource"}}}},"500":{"description":"Erro inesperado, ocorreu algum erro interno no servidor","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.979+00:00","message":"Erro desconhecido","details":"/api/v1/resource"}}}}}}},"/api/v1/basicos/locais/nacionalidades":{"get":{"tags":["Locais"],"summary":"Consultar Nacionalidades","description":"Lista todos as nacionalidades cadastradas na instituição.","operationId":"list_9","parameters":[{"name":"pageSize","in":"query","description":"Total de registros que serão retornados a cada consulta (máximo de 500)","required":true,"schema":{"type":"integer","format":"int32"},"example":100},{"name":"currentPage","in":"query","description":"Página atual dos resultados","required":false,"schema":{"type":"integer","format":"int32"},"example":1}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginationNacionalidadeDtoResPage"}}}},"400":{"description":"Solicitação inválida, contém erros de tipos ou de formatação","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.989+00:00","message":"Um ou mais campos estão inválidos","details":"/api/v1/resource","errorCode":{"code":"VFLD01","desc":"Valor informado inválido"},"validationErrors":[{"field":"anoConsolidacao","rejectedValue":"202A","message":"Falha ao converter a propriedade 'anoConsolidacao'"}]}}}},"401":{"description":"Acesso negado, O usuário não está autenticado ou possui credenciais inválidas","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.989+00:00","message":"É necessário estar autenticado para acessar este recurso","details":"/api/v1/resource","errorCode":{"code":"EXPTK01","desc":"Token inválido ou expirado"}}}}},"403":{"description":"Proibido, o usuário autenticado não possui a permissão de acesso para o recurso solicitado.","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.989+00:00","message":"Voce nao tem permissao para acessar este recurso","details":"/api/v1/resource"}}}},"404":{"description":"Recurso não encontrado","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.989+00:00","message":"Registro de código '123' não encontrado","details":"/api/v1/resource"}}}},"500":{"description":"Erro inesperado, ocorreu algum erro interno no servidor","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:02.989+00:00","message":"Erro desconhecido","details":"/api/v1/resource"}}}}}}},"/api/v1/basicos/instituicoes":{"get":{"tags":["Instituições"],"summary":"Consulta de Instituições","description":"Lista todas as instituições cadastradas.","operationId":"list_12","parameters":[{"name":"idEstado","in":"query","description":"ID do Estado","required":false,"schema":{"type":"integer","format":"int32"},"example":1},{"name":"idCidade","in":"query","description":"ID da Cidade","required":false,"schema":{"type":"integer","format":"int32"},"example":1},{"name":"search","in":"query","description":"Realiza busca por: Nome da instituição","required":false,"schema":{"type":"string"},"example":"Foo Bar"},{"name":"pageSize","in":"query","description":"Total de registros que serão retornados a cada consulta (máximo de 500)","required":true,"schema":{"type":"integer","format":"int32"},"example":100},{"name":"currentPage","in":"query","description":"Página atual dos resultados","required":false,"schema":{"type":"integer","format":"int32"},"example":1}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginationInstituicaoDtoResPage"}}}},"400":{"description":"Solicitação inválida, contém erros de tipos ou de formatação","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:03.007+00:00","message":"Um ou mais campos estão inválidos","details":"/api/v1/resource","errorCode":{"code":"VFLD01","desc":"Valor informado inválido"},"validationErrors":[{"field":"anoConsolidacao","rejectedValue":"202A","message":"Falha ao converter a propriedade 'anoConsolidacao'"}]}}}},"401":{"description":"Acesso negado, O usuário não está autenticado ou possui credenciais inválidas","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:03.007+00:00","message":"É necessário estar autenticado para acessar este recurso","details":"/api/v1/resource","errorCode":{"code":"EXPTK01","desc":"Token inválido ou expirado"}}}}},"403":{"description":"Proibido, o usuário autenticado não possui a permissão de acesso para o recurso solicitado.","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:03.007+00:00","message":"Voce nao tem permissao para acessar este recurso","details":"/api/v1/resource"}}}},"404":{"description":"Recurso não encontrado","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:03.007+00:00","message":"Registro de código '123' não encontrado","details":"/api/v1/resource"}}}},"500":{"description":"Erro inesperado, ocorreu algum erro interno no servidor","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:03.007+00:00","message":"Erro desconhecido","details":"/api/v1/resource"}}}}}}},"/api/v1/basicos/funcoes":{"get":{"tags":["Funções"],"summary":"Consulta de Funções","description":"Lista todas as funções cadastradas na instituição ou em uma organização específica.","operationId":"list_13","parameters":[{"name":"idFuncao","in":"query","description":"ID da Função","required":false,"schema":{"type":"integer","format":"int32"},"example":1},{"name":"status","in":"query","description":"Status da Função","required":false,"schema":{"type":"string","enum":["ATIVO","INATIVO"]},"example":"ATIVO"},{"name":"search","in":"query","description":"Realiza busca por: Nome da função","required":false,"schema":{"type":"string"},"example":"Foo Bar"},{"name":"pageSize","in":"query","description":"Total de registros que serão retornados a cada consulta (máximo de 500)","required":true,"schema":{"type":"integer","format":"int32"},"example":100},{"name":"currentPage","in":"query","description":"Página atual dos resultados","required":false,"schema":{"type":"integer","format":"int32"},"example":1}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginationFuncaoDtoResPage"}}}},"400":{"description":"Solicitação inválida, contém erros de tipos ou de formatação","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:03.013+00:00","message":"Um ou mais campos estão inválidos","details":"/api/v1/resource","errorCode":{"code":"VFLD01","desc":"Valor informado inválido"},"validationErrors":[{"field":"anoConsolidacao","rejectedValue":"202A","message":"Falha ao converter a propriedade 'anoConsolidacao'"}]}}}},"401":{"description":"Acesso negado, O usuário não está autenticado ou possui credenciais inválidas","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:03.013+00:00","message":"É necessário estar autenticado para acessar este recurso","details":"/api/v1/resource","errorCode":{"code":"EXPTK01","desc":"Token inválido ou expirado"}}}}},"403":{"description":"Proibido, o usuário autenticado não possui a permissão de acesso para o recurso solicitado.","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:03.013+00:00","message":"Voce nao tem permissao para acessar este recurso","details":"/api/v1/resource"}}}},"404":{"description":"Recurso não encontrado","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:03.013+00:00","message":"Registro de código '123' não encontrado","details":"/api/v1/resource"}}}},"500":{"description":"Erro inesperado, ocorreu algum erro interno no servidor","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:03.013+00:00","message":"Erro desconhecido","details":"/api/v1/resource"}}}}}}},"/api/v1/basicos/funcionarios":{"get":{"tags":["Funcionários"],"summary":"Consulta de Funcionários","description":"Lista todos os funcionários cadastrados na instituição ou em uma organização específica.","operationId":"list_14","parameters":[{"name":"idFuncionario","in":"query","description":"ID do Funcionário","required":false,"schema":{"type":"integer","format":"int32"},"example":1},{"name":"idSetor","in":"query","description":"ID do Setor","required":false,"schema":{"type":"integer","format":"int32"},"example":1},{"name":"idDepartamento","in":"query","description":"ID do Departamento","required":false,"schema":{"type":"integer","format":"int32"},"example":1},{"name":"idFuncao","in":"query","description":"ID da Função","required":false,"schema":{"type":"integer","format":"int32"},"example":1},{"name":"status","in":"query","description":"Status do Departamento","required":false,"schema":{"type":"string","enum":["ATIVO","INATIVO"]},"example":"ATIVO"},{"name":"search","in":"query","description":"Realiza busca por: Nome do Funcionário","required":false,"schema":{"type":"string"},"example":"Foo Bar"},{"name":"pageSize","in":"query","description":"Total de registros que serão retornados a cada consulta (máximo de 500)","required":true,"schema":{"type":"integer","format":"int32"},"example":100},{"name":"currentPage","in":"query","description":"Página atual dos resultados","required":false,"schema":{"type":"integer","format":"int32"},"example":1}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginationFuncionarioDtoResPage"}}}},"400":{"description":"Solicitação inválida, contém erros de tipos ou de formatação","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:03.022+00:00","message":"Um ou mais campos estão inválidos","details":"/api/v1/resource","errorCode":{"code":"VFLD01","desc":"Valor informado inválido"},"validationErrors":[{"field":"anoConsolidacao","rejectedValue":"202A","message":"Falha ao converter a propriedade 'anoConsolidacao'"}]}}}},"401":{"description":"Acesso negado, O usuário não está autenticado ou possui credenciais inválidas","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:03.022+00:00","message":"É necessário estar autenticado para acessar este recurso","details":"/api/v1/resource","errorCode":{"code":"EXPTK01","desc":"Token inválido ou expirado"}}}}},"403":{"description":"Proibido, o usuário autenticado não possui a permissão de acesso para o recurso solicitado.","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:03.022+00:00","message":"Voce nao tem permissao para acessar este recurso","details":"/api/v1/resource"}}}},"404":{"description":"Recurso não encontrado","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:03.022+00:00","message":"Registro de código '123' não encontrado","details":"/api/v1/resource"}}}},"500":{"description":"Erro inesperado, ocorreu algum erro interno no servidor","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:03.022+00:00","message":"Erro desconhecido","details":"/api/v1/resource"}}}}}}},"/api/v1/basicos/departamentos":{"get":{"tags":["Departamentos"],"summary":"Consulta de Departamentos","description":"Lista todos os departamentos cadastrados na instituição.","operationId":"list_15","parameters":[{"name":"idDepartamento","in":"query","description":"ID do Departamento","required":false,"schema":{"type":"integer","format":"int32"},"example":1},{"name":"status","in":"query","description":"Status do Departamento","required":false,"schema":{"$ref":"#/components/schemas/StatusDepartamento"},"example":"ATIVO"},{"name":"search","in":"query","description":"Realiza busca por: Nome do Departamento","required":false,"schema":{"type":"string"},"example":"Foo Bar"},{"name":"pageSize","in":"query","description":"Total de registros que serão retornados a cada consulta (máximo de 500)","required":true,"schema":{"type":"integer","format":"int32"},"example":100},{"name":"currentPage","in":"query","description":"Página atual dos resultados","required":false,"schema":{"type":"integer","format":"int32"},"example":1}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginationDepartamentoDtoResPage"}}}},"400":{"description":"Solicitação inválida, contém erros de tipos ou de formatação","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:03.028+00:00","message":"Um ou mais campos estão inválidos","details":"/api/v1/resource","errorCode":{"code":"VFLD01","desc":"Valor informado inválido"},"validationErrors":[{"field":"anoConsolidacao","rejectedValue":"202A","message":"Falha ao converter a propriedade 'anoConsolidacao'"}]}}}},"401":{"description":"Acesso negado, O usuário não está autenticado ou possui credenciais inválidas","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:03.028+00:00","message":"É necessário estar autenticado para acessar este recurso","details":"/api/v1/resource","errorCode":{"code":"EXPTK01","desc":"Token inválido ou expirado"}}}}},"403":{"description":"Proibido, o usuário autenticado não possui a permissão de acesso para o recurso solicitado.","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:03.028+00:00","message":"Voce nao tem permissao para acessar este recurso","details":"/api/v1/resource"}}}},"404":{"description":"Recurso não encontrado","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:03.028+00:00","message":"Registro de código '123' não encontrado","details":"/api/v1/resource"}}}},"500":{"description":"Erro inesperado, ocorreu algum erro interno no servidor","content":{"application/json":{"example":{"timestamp":"2026-04-03T22:34:03.028+00:00","message":"Erro desconhecido","details":"/api/v1/resource"}}}}}}}},"components":{"schemas":{"AtualizarPerfilContatoDtoReq":{"required":["contato","idPerfilContato","tipoContato"],"type":"object","properties":{"idPerfilContato":{"type":"integer","description":"ID Perfil Contato","format":"int32","example":1},"tipoContato":{"type":"string","description":"Tipo do Contato","example":"OUTROS","enum":["COMERCIAL","RESIDENCIAL","FIADOR","EDUCACIONAL_ALUNO","EDUCACIONAL_PROFESSOR","OUTROS"]},"contato":{"type":"string","description":"Nome do Contato","example":"Joana Forbes"},"celular":{"type":"string","description":"Celular do Contato","example":"99999999"},"telefone":{"type":"string","description":"Telefone do Contato","example":"99999999"},"fax":{"type":"string","description":"Fax do Contato","example":"99999999"},"email":{"type":"string","description":"Email","example":"example@example.com"}}},"PerfilContatoRest":{"type":"object","properties":{"idPerfilContato":{"type":"integer","format":"int32"},"idPerfil":{"type":"integer","format":"int32"},"nomePerfil":{"type":"string"},"contato":{"type":"string"},"orgAluno":{"type":"integer","format":"int32"},"tipoContato":{"type":"string"},"fone":{"type":"string"},"fax":{"type":"string"},"celular":{"type":"string"},"email":{"type":"string"},"ignorarLog":{"type":"boolean"}}},"PerfilResponsavelDtoReq":{"required":["idPerfil","idResponsavel","naoPodeAcessarPortalAluno","parentesco","rendaComprovada","reside","responsavelLegal","retirarAluno","transporteEscolar"],"type":"object","properties":{"idPerfil":{"type":"integer","description":"ID do perfil do aluno","format":"int32","example":1},"idResponsavel":{"type":"integer","description":"ID do perfil do responsável","format":"int32","example":1},"parentesco":{"type":"string","description":"Parentesco","example":"PAI","enum":["PAI","MAE","PADRASTO","MADRASTA","AVO","TIO","IRMAO","OUTROS"]},"reside":{"maximum":1,"minimum":0,"type":"integer","description":"Aluno reside com o responsável","format":"int32"},"responsavelLegal":{"maximum":1,"minimum":0,"type":"integer","description":"Responsável legal","format":"int32"},"naoPodeAcessarPortalAluno":{"maximum":1,"minimum":0,"type":"integer","description":"Caso 1, o responsável não pode acessar o portal do aluno","format":"int32"},"rendaComprovada":{"maximum":1,"minimum":0,"type":"integer","description":"Responsável possui renda comprovada","format":"int32"},"retirarAluno":{"maximum":1,"minimum":0,"type":"integer","description":"Responsável pode retirar o aluno","format":"int32"},"retirarAlunoObservacao":{"type":"string","description":"Observação ao retirar o aluno","example":"Motivo"},"transporteEscolar":{"maximum":1,"minimum":0,"type":"integer","description":"Aluno irá com transporte escolar","format":"int32"}}},"PerfilResponsavelRest":{"type":"object","properties":{"idPerfilResponsavel":{"type":"integer","format":"int32"},"idPerfil":{"type":"integer","format":"int32"},"parentesco":{"type":"string"},"reside":{"type":"string"},"responsavelLegal":{"type":"integer","format":"int32"},"naoPodeAcessarPortalAluno":{"type":"integer","format":"int32"},"idResponsavel":{"type":"integer","format":"int32"},"get_nome":{"type":"string"},"get_cpf":{"type":"string"},"get_rg":{"type":"string"},"get_fone":{"type":"string"},"get_celular":{"type":"string"},"rendaComprovada":{"type":"integer","format":"int32"},"retirarAluno":{"type":"integer","format":"int32"},"retirarAlunoObservacao":{"type":"string"},"transporteEscolar":{"type":"integer","format":"int32"},"get_bairroResponsavel":{"type":"string"},"get_logradouroResponsavel":{"type":"string"},"get_NumeroEnderecoResponsavel":{"type":"string"},"get_cepResponsavel":{"type":"string"},"get_cidadeResponsavel":{"type":"string"},"get_ufDescricaoResponsavel":{"type":"string"},"get_ufSiglaResponsavel":{"type":"string"},"get_rgResponsavel":{"type":"string"},"get_cpfResponsavel":{"type":"string"},"get_sexoResponsavel":{"type":"string"},"get_estadoCivilResponsavel":{"type":"string"},"get_dataNascimentoResponsavel":{"type":"string","format":"date-time"},"get_emailResponsavel":{"type":"string"},"get_numeroResponsavel":{"type":"string"},"get_nomeAluno":{"type":"string"},"ignorarLog":{"type":"boolean"}}},"EmailInstitucionalDtoReq":{"type":"object","properties":{"email":{"type":"string","description":"E-mail para ser salvo","example":"example@email.com"},"limparEmailInstitucional":{"type":"boolean","description":"Limpar o valor atual do E-mail","example":false}}},"PerfilBloqueioDtoRes":{"type":"object","properties":{"idPerfilBloqueio":{"type":"integer","format":"int32"},"idPerfil":{"type":"integer","format":"int32"},"mensagem":{"type":"string"},"recurso":{"type":"string","enum":["AVA","REMATRICULA","MATRICULA"]},"status":{"type":"string","enum":["ATIVO","INATIVO"]},"tipoReferencia":{"type":"string"},"idReferencia":{"type":"integer","format":"int32"},"id_org":{"type":"integer","format":"int32"},"id_usuario_criacao":{"type":"integer","format":"int32"},"id_usuario_alteracao":{"type":"integer","format":"int32"},"data_criacao":{"type":"string","format":"date-time"},"data_alteracao":{"type":"string","format":"date-time"},"get_nomePagador":{"type":"string"}}},"PerfilDtoReq":{"required":["dataNascimento","email","idOrg","nome","tipoPerfil"],"type":"object","properties":{"idCliente":{"type":"integer","description":"ID do Cliente","format":"int32","example":1},"idOrg":{"type":"integer","description":"ID da organização","format":"int32","example":1},"tipoPerfil":{"type":"string","description":"Tipo de pessoa do perfil","example":"FISICA","enum":["FISICA","JURIDICA"]},"nome":{"type":"string","description":"Nome do perfil","example":"Joaquim Lemos"},"nomeSocial":{"type":"string","description":"Nome pelo qual as pessoas reivindicam ser chamadas, em contraste com o nome anteriormente registrado","example":"Joaquina"},"estrangeiro":{"type":"boolean","description":"O perfil é de um estrangeiro?","example":false},"rne":{"type":"string","description":"Rne do perfil estrangeiro","example":"SDF534DS58"},"cpf":{"type":"string","description":"CPF do perfil","example":"123.123.123-00"},"cnpj":{"type":"string","description":"CNPJ do perfil","example":"12.123.123/0001-12"},"nomeImpressao":{"type":"string","description":"Nome de Impressão do perfil Juridico","example":"Empresa"},"inscricaoEstadual":{"type":"string","description":"Inscrição Estadual do Perfil Juridico","example":"Empresa LTDA"},"inscricaoMunicipal":{"type":"string","description":"Inscrição Municipal do Perfil Juridico","example":"S6DF465"},"representanteLegal":{"type":"string","description":"Representante Legal do Perfil Juridico","example":"João da Silva"},"nomeFantasia":{"type":"string","description":"Nome fantasia do Perfil Juridico","example":"Empresa de Tecnologia"},"desejaReceberInformacoes":{"type":"boolean","description":"Marque como 'true' para receber informações via email","example":true},"naoReceberMensagemSms":{"type":"boolean","description":"Marque como 'true' para evitar receber mensagens SMS","example":false},"email":{"type":"string","description":"Email","example":"example@example.com"},"emailOrg":{"type":"integer","description":"Vincula o perfil ao email Institucional da Organização","format":"int32","example":1},"estadoCivil":{"type":"string","description":"Estado civil do perfil","example":"NAO_INFORMADO","enum":["SOLTEIRO","CASADO","DIVORCIADO","VIUVO","UNIAO_ESTAVEL","DESQUITADO","NAO_INFORMADO"]},"sexo":{"type":"string","description":"Sexo do perfil","example":"MASCULINO","enum":["MASCULINO","FEMININO"]},"habilidadeMotora":{"type":"string","description":"Lateralidade do perfil","example":"DESTRO","enum":["CANHOTO","DESTRO"]},"rg":{"type":"string","description":"RG do perfil","example":"1355186"},"rgOrgaoExpedidor":{"type":"string","description":"Orgão Expedidor do RG","example":"SSP"},"ufOrgaoExpedidor":{"type":"string","description":"UF do Estado do Orgão Expedidor do RG","example":"PR"},"passaporte":{"type":"string","description":"Passaporte","example":"CS265436"},"rgDataEmissao":{"type":"string","description":"Data de Emissão do RG (YYYY-MM-DD)","format":"date","example":"2023-09-20"},"pai":{"type":"string","description":"Pai do perfil","example":"Marcos Lemos"},"cpfPai":{"type":"string","description":"CPF Pai","example":"123.123.123-00"},"mae":{"type":"string","description":"Mãe do perfil","example":"Joana da Silva"},"cpfMae":{"type":"string","description":"CPF Mãe","example":"123.123.123-00"},"dependentes":{"type":"integer","description":"Dependentes do perfil","format":"int32","example":1},"ddi":{"type":"integer","description":"DDI do perfil","format":"int32","example":1},"dataNascimento":{"type":"string","description":"Data de Nascimento do perfil (YYYY-MM-DD)","format":"date","example":"2023-09-20"},"idGenero":{"type":"integer","description":"ID do gênero","format":"int32","example":1},"idTipoTratamento":{"type":"integer","description":"ID Tipo de Tratamento do perfil","format":"int32","example":1},"idNacionalidade":{"type":"integer","description":"ID Nacionalidade do perfil","format":"int32","example":1},"idReligiao":{"type":"integer","description":"ID Religião do perfil","format":"int32","example":1},"idNecessidadeEspecial":{"type":"integer","description":"ID Necessidade Especial do perfil","format":"int32","example":1},"idCidadeNatural":{"type":"integer","description":"ID Cidade Natural do perfil","format":"int32","example":1},"idCor":{"type":"integer","description":"Código da Cor/Raça do perfil","format":"int32","example":1},"status":{"type":"string","description":"Status do perfil ()","example":"ATIVO","enum":["ATIVO","INATIVO"]},"idCidadeEndereco":{"type":"integer","description":"ID Cidade do endereço do perfil","format":"int32","example":1},"bairro":{"type":"string","description":"Bairro do endereço do perfil","example":"Bairro Vila Nogueira"},"logradouro":{"type":"string","description":"Logradouro do endereço do perfil","example":"Rua Alberto Nogs"},"cep":{"type":"string","description":"CEP do endereço do perfil","example":"00000-000"},"complemento":{"type":"string","description":"Complemento do endereço do perfil","example":"Ao lado do bar do Jão"},"localidade":{"type":"string","description":"Localiadde do endereço do perfil"},"numero":{"type":"string","description":"Numero do endereço do perfil","example":"1"},"celular":{"type":"string","description":"Celular do perfil","example":"9 999999999"},"fone":{"type":"string","description":"Telefone do perfil","example":"99999999"},"fax":{"type":"string","description":"fax do perfil"},"foneComercial":{"type":"string","description":"Telefone Comercial do perfil","example":"99999999"},"observacao":{"type":"string","description":"Obeservação"},"idProfissao":{"type":"integer","description":"ID da Profissão do perfil","format":"int32","example":1},"cargo":{"type":"string","description":"Descrição do cargo exercido do perfil","example":"Auxiliar administrativo"},"login":{"type":"string","description":"Login do perfil - Se informado deverá ser único na base de dados","example":"joaquim.lemos"},"senha":{"type":"string"}}},"PerfilDtoRes":{"type":"object","properties":{"idPerfil":{"type":"integer","format":"int32"},"nome":{"type":"string"},"nomeSocial":{"type":"string"},"nomeImpressao":{"type":"string"},"idCliente":{"type":"integer","format":"int32"},"tipoPessoa":{"type":"string"},"habilidadeMotora":{"type":"string"},"cpf":{"type":"string"},"rg":{"type":"string"},"ufOrgaoExpedidor":{"type":"string"},"rgOrgaoExpedidor":{"type":"string"},"rgDataEmissao":{"type":"string","format":"date-time"},"rne":{"type":"string"},"cnpj":{"type":"string"},"inscricaoEstadual":{"type":"string"},"inscricaoMunicipal":{"type":"string"},"representanteLegal":{"type":"string"},"pai":{"type":"string"},"mae":{"type":"string"},"cpfPai":{"type":"string"},"cpfMae":{"type":"string"},"dataNascimento":{"type":"string","format":"date-time"},"dependentes":{"type":"integer","format":"int32"},"estadoCivil":{"type":"string"},"sexo":{"type":"string"},"email":{"type":"string"},"emailStatus":{"type":"string"},"emailMotivoInvalido":{"type":"string"},"emailCodigoConfirmacao":{"type":"string"},"idNacionalidade":{"type":"integer","format":"int32"},"idReligiao":{"type":"integer","format":"int32"},"idIdiomaNativo":{"type":"integer","format":"int32"},"idNecessidadeEspecial":{"type":"integer","format":"int32"},"nacionalidade":{"type":"string"},"religiao":{"type":"string"},"idiomaNativo":{"type":"string"},"necessidadeEspecial":{"type":"string"},"idCidadeNatural":{"type":"integer","format":"int32"},"naturalDe":{"type":"string"},"idCor":{"type":"integer","format":"int32"},"status":{"type":"string"},"idCidadeEndereco":{"type":"integer","format":"int32"},"bairro":{"type":"string"},"logradouro":{"type":"string"},"cep":{"type":"string"},"complemento":{"type":"string"},"localidade":{"type":"string"},"numero":{"type":"string"},"celular":{"type":"string"},"fone":{"type":"string"},"fax":{"type":"string"},"foneComercial":{"type":"string"},"tituloNumero":{"type":"string"},"tituloZona":{"type":"string"},"tituloSecao":{"type":"string"},"tituloDataExpedicao":{"type":"string","format":"date-time"},"idMunicipioTitulo":{"type":"integer","format":"int32"},"descMunicipioTitulo":{"type":"string"},"certidaoNumero":{"type":"string"},"certidaoFolha":{"type":"string"},"certidaoLivro":{"type":"string"},"certidaoCartorio":{"type":"string"},"certidaoDataEmissao":{"type":"string","format":"date-time"},"certidaoUf":{"type":"string"},"certidaoMatricula":{"type":"string"},"carteiraNumero":{"type":"string"},"carteiraSerie":{"type":"string"},"carteiraDataExpedicao":{"type":"string","format":"date-time"},"carteiraUf":{"type":"string"},"numeroPis":{"type":"string"},"reservistaRa":{"type":"string"},"reservistaCategoria":{"type":"string"},"reservistaData":{"type":"string","format":"date-time"},"reservistaOrgaoExpedidor":{"type":"string"},"certidaoCasLivroDeRegistro":{"type":"string"},"certidaoCasNumeroRegistroCas":{"type":"string"},"certidaoCasDataCasamento":{"type":"string","format":"date-time"},"certidaoCasNomeConjuge":{"type":"string"},"certidaoCasNomeJuiz":{"type":"string"},"observacao":{"type":"string"},"idProfissao":{"type":"integer","format":"int32"},"idEmpresa":{"type":"integer","format":"int32"},"cargo":{"type":"string"},"renda":{"type":"number","format":"double"},"localDeTrabalho":{"type":"string"},"tipoDeProfissao":{"type":"string"},"idioma":{"type":"string"},"desejaReceberInformacoes":{"type":"integer","format":"int32"},"naoReceberMensagemSms":{"type":"integer","format":"int32"},"tipoLocalidade":{"type":"integer","format":"int32"},"dataCriacao":{"type":"string","format":"date-time"},"dataAlteracao":{"type":"string","format":"date-time"}}},"PerfilContatoDtoReq":{"required":["contato","tipoContato"],"type":"object","properties":{"tipoContato":{"type":"string","description":"Tipo do Contato","example":"OUTROS","enum":["COMERCIAL","RESIDENCIAL","FIADOR","EDUCACIONAL_ALUNO","EDUCACIONAL_PROFESSOR","OUTROS"]},"contato":{"type":"string","description":"Nome do Contato","example":"Joana Forbes"},"celular":{"type":"string","description":"Celular do Contato","example":"99999999"},"telefone":{"type":"string","description":"Telefone do Contato","example":"99999999"},"fax":{"type":"string","description":"Fax do Contato","example":"99999999"},"email":{"type":"string","description":"Email do Contato","example":"example@example.com"}}},"PerfilResponsavelDtoRes":{"type":"object","properties":{"idPerfilResponsavel":{"type":"integer","format":"int32"},"idPerfil":{"type":"integer","format":"int32"},"idResponsavel":{"type":"integer","format":"int32"},"parentesco":{"type":"string"},"reside":{"type":"string"},"responsavelLegal":{"type":"integer","format":"int32"},"naoPodeAcessarPortalAluno":{"type":"integer","format":"int32"},"get_nome":{"type":"string"},"get_cpf":{"type":"string"},"get_rg":{"type":"string"},"get_fone":{"type":"string"},"get_celular":{"type":"string"},"rendaComprovada":{"type":"integer","format":"int32"},"retirarAluno":{"type":"integer","format":"int32"},"retirarAlunoObservacao":{"type":"string"},"transporteEscolar":{"type":"integer","format":"int32"},"get_bairroResponsavel":{"type":"string"},"get_logradouroResponsavel":{"type":"string"},"get_NumeroEnderecoResponsavel":{"type":"string"},"get_cepResponsavel":{"type":"string"},"get_cidadeResponsavel":{"type":"string"},"get_ufDescricaoResponsavel":{"type":"string"},"get_ufSiglaResponsavel":{"type":"string"},"get_rgResponsavel":{"type":"string"},"get_cpfResponsavel":{"type":"string"},"get_sexoResponsavel":{"type":"string"},"get_estadoCivilResponsavel":{"type":"string"},"get_dataNascimentoResponsavel":{"type":"string","format":"date-time"},"get_emailResponsavel":{"type":"string"},"get_numeroResponsavel":{"type":"string"},"get_nomeAluno":{"type":"string"}}},"PaisDtoReq":{"required":["codigoInep","descricao","nacionalidade","sigla","tratamento"],"type":"object","properties":{"descricao":{"type":"string","description":"Descrição"},"nacionalidade":{"type":"string","description":"Nacionalidade"},"sigla":{"type":"string","description":"Sigla"},"codigoInep":{"type":"string","description":"Codigo INEP","example":"1"},"codigoPaisInep":{"type":"integer","description":"Codigo Pais INEP","format":"int32","example":1},"tratamento":{"type":"string","description":"Tratamento (da, do)"},"paisEstrangeiro":{"type":"boolean","description":"Pais estrangeiro"}}},"PaisRest":{"type":"object","properties":{"idPais":{"type":"integer","format":"int32"},"descricao":{"type":"string"},"nacionalidade":{"type":"string"},"codigoInep":{"type":"string"},"codigoPaisInep":{"type":"integer","format":"int32"},"paisEstrangeiro":{"type":"integer","format":"int32"},"tratamento":{"type":"string"},"sigla":{"type":"string"},"ignorarLog":{"type":"boolean"}}},"EstadoDtoReq":{"required":["descricao","idPais","sigla"],"type":"object","properties":{"descricao":{"maxLength":2147483647,"minLength":2,"type":"string","description":"Descrição","example":"PARANA"},"sigla":{"maxLength":2147483647,"minLength":2,"type":"string","description":"Sigla","example":"PR"},"idPais":{"type":"integer","description":"ID do país","format":"int32","example":1},"codigoInep":{"type":"integer","description":"Codigo INEP","format":"int32","example":1},"tratamento":{"type":"string","description":"Tratamento"}}},"EstadoRest":{"type":"object","properties":{"idEstado":{"type":"integer","format":"int32"},"descricao":{"type":"string"},"idPais":{"type":"integer","format":"int32"},"codigoInep":{"type":"integer","format":"int32"},"sigla":{"type":"string"},"tratamento":{"type":"string"},"nomePais":{"type":"string"},"dataCriacao":{"type":"string","format":"date-time"},"dataAlteracao":{"type":"string","format":"date-time"},"ignorarLog":{"type":"boolean"}}},"CidadeDtoReq":{"required":["descricao","idEstado"],"type":"object","properties":{"descricao":{"type":"string","description":"Descrição"},"idEstado":{"type":"integer","description":"ID do Estado","format":"int32","example":1},"codigoIbge":{"type":"string","description":"Codigo IBGE"},"codigoInep":{"type":"integer","description":"Codigo INEP","format":"int32","example":1}}},"CidadeRest":{"type":"object","properties":{"idCidade":{"type":"integer","format":"int32"},"descricao":{"type":"string"},"idEstado":{"type":"integer","format":"int32"},"codigoIbge":{"type":"string"},"codigoInep":{"type":"integer","format":"int32"},"uf":{"type":"string"},"estado":{"type":"string"},"idPais":{"type":"integer","format":"int32"},"dataCriacao":{"type":"string","format":"date-time"},"dataAlteracao":{"type":"string","format":"date-time"},"ignorarLog":{"type":"boolean"}}},"PerfilBloqueioDtoReq":{"type":"object","properties":{"idPerfil":{"type":"integer","format":"int32"},"id_org":{"type":"integer","format":"int32"},"mensagem":{"type":"string"},"recurso":{"type":"string","enum":["AVA","REMATRICULA","MATRICULA"]},"tipoReferencia":{"type":"string"},"idReferencia":{"type":"integer","format":"int32"}}},"GrantedAuthority":{"type":"object","properties":{"authority":{"type":"string"}}},"IUsuario":{"type":"object"},"Org":{"type":"object","properties":{"id_org":{"type":"integer","format":"int32"},"id_usuario_criacao":{"type":"integer","format":"int32"},"id_usuario_alteracao":{"type":"integer","format":"int32"},"data_criacao":{"type":"string","format":"date-time"},"data_alteracao":{"type":"string","format":"date-time"},"buscaIndexada":{"type":"boolean"},"idOrg":{"type":"integer","format":"int32"},"idCliente":{"type":"integer","format":"int32"},"descricao":{"type":"string"},"imagem":{"type":"string"},"nomeFantasia":{"type":"string"},"nomeComercial":{"type":"string"},"nomeComplementar":{"type":"string"},"nomePortalDiplomado":{"type":"string"},"nomeReduzido":{"type":"string"},"endereco":{"type":"string"},"cnpj":{"type":"string"},"inscricao":{"type":"string"},"enderecoFone":{"type":"string"},"pracaPagamento":{"type":"string"},"cep":{"type":"string"},"cidade":{"type":"string"},"inscricaoMunicipal":{"type":"string"},"diretorGeral":{"type":"string","deprecated":true},"cssPortais":{"type":"string"},"secretariaAcademica":{"type":"string","deprecated":true},"idPerfilDiretor":{"type":"integer","format":"int32"},"portariaDiretor":{"type":"string"},"get_nomeDiretor":{"type":"string"},"get_sexoDiretor":{"type":"string"},"idPerfilSecretariaAcademica":{"type":"integer","format":"int32"},"portariaSecretariaAcademica":{"type":"string"},"get_nomeSecretariaAcademica":{"type":"string"},"get_sexoSecretariaAcademica":{"type":"string"},"portariaCredenciamento":{"type":"string"},"website":{"type":"string"},"idCidadeNRE":{"type":"integer","format":"int32"},"idPerfilDiretorAcademico":{"type":"integer","format":"int32"},"get_nomeDiretorAcademico":{"type":"string"},"portariaDiretorAcademico":{"type":"string"},"email":{"type":"string"},"idPerfilResponsavelFinanceiro":{"type":"integer","format":"int32"},"get_nomeResponsavelFinanceiro":{"type":"string"},"get_sexoResponsavelFinanceiro":{"type":"string"},"numero":{"type":"string"},"logradouro":{"type":"string"},"bairro":{"type":"string"},"idPerfilViceDiretor":{"type":"integer","format":"int32"},"get_nomePerfilViceDiretor":{"type":"string"},"nomePortal":{"type":"string"},"idPerfilResposavelCertificacao":{"type":"integer","format":"int32"},"get_nomePerfilResposavelCertificacao":{"type":"string"},"portariaCertificacao":{"type":"string"},"status":{"type":"string"},"idEmpresa":{"type":"integer","format":"int32"},"codigoInep":{"type":"string"},"idPerfilRespLivroRegistro":{"type":"integer","format":"int32"},"get_nomePerfilRespLivroRegistro":{"type":"string"},"getiDouNumeroMatriculaRespLivReg":{"type":"string"},"modeloNegocio":{"type":"string"},"idPerfilSecretariaDiplomaDigital":{"type":"integer","format":"int32"},"portariaSecretariaDiplomaDigital":{"type":"string"},"idPerfilDiretorDiploma":{"type":"integer","format":"int32"},"portariaDiretorDiploma":{"type":"string"},"funcaoDiretorDiploma":{"type":"string"},"idPerfilSecretariaDiploma":{"type":"integer","format":"int32"},"portariaSecretariaDiploma":{"type":"string"},"funcaoSecretariaDiploma":{"type":"string"},"get_descricaoCliente":{"type":"string"},"newObjectInCache":{"type":"boolean"},"usuario":{"$ref":"#/components/schemas/IUsuario"},"ignorarLog":{"type":"boolean"}}},"TableEmailTag":{"type":"object","properties":{"tag":{"type":"string"},"descricao":{"type":"string"}}},"UserInfo":{"type":"object","properties":{"login":{"type":"string"},"token":{"type":"string"},"expiresIn":{"type":"integer","format":"int64"},"deviceDetails":{"type":"string"},"idUsuario":{"type":"integer","format":"int32"},"status":{"type":"string"},"idOrg":{"type":"integer","format":"int32"},"idCliente":{"type":"integer","format":"int32"},"idGrupoUsuario":{"type":"integer","format":"int32"},"moduloID":{"type":"string"},"tipoGrupoUsuario":{"type":"string"},"nomeComercial":{"type":"string"},"descOrg":{"type":"string"},"modeloNegocio":{"type":"string"},"grupoUsuario":{"type":"string"},"usuarioDirector":{"type":"string"},"modulos":{"type":"array","items":{"type":"string"}},"orgs":{"type":"array","items":{"$ref":"#/components/schemas/Org"}},"usuario":{"$ref":"#/components/schemas/UsuarioPortal"},"org":{"$ref":"#/components/schemas/Org"}}},"UsuarioPortal":{"type":"object","properties":{"id_org":{"type":"integer","format":"int32"},"id_usuario_criacao":{"type":"integer","format":"int32"},"id_usuario_alteracao":{"type":"integer","format":"int32"},"data_criacao":{"type":"string","format":"date-time"},"data_alteracao":{"type":"string","format":"date-time"},"buscaIndexada":{"type":"boolean"},"idUsuario":{"type":"integer","format":"int32"},"idGrupoUsuario":{"type":"integer","format":"int32"},"nome":{"type":"string"},"forcarAlterarSenha":{"type":"integer","format":"int32"},"senha":{"type":"string"},"descricao":{"type":"string"},"token":{"type":"string"},"status":{"type":"string"},"lookAndFeel":{"type":"string"},"skinBordas":{"type":"integer","format":"int32"},"flagAcessoTodasContas":{"type":"integer","format":"int32"},"usuarioWebService":{"type":"integer","format":"int32"},"idIntegracao":{"type":"integer","format":"int32"},"isUsuarioPolo":{"type":"integer","format":"int32"},"dataUltimaAlteracaoSenha":{"type":"string","format":"date-time"},"papelPolo":{"type":"string"},"get_nomeGrupoUsuario":{"type":"string"},"get_tipoGrupoUsuario":{"type":"string"},"idFuncionario":{"type":"integer","format":"int32"},"get_funcionario":{"type":"string"},"get_emailEmpresa":{"type":"string"},"get_senhaEmailEmpresa":{"type":"string"},"get_idSetor":{"type":"integer","format":"int32"},"get_idPerfil":{"type":"integer","format":"int32"},"get_nomePerfil":{"type":"string"},"get_idCliente":{"type":"integer","format":"int32"},"idUnidadeFisica":{"type":"integer","format":"int32","deprecated":true},"get_nomeUnidadeFisica":{"type":"string"},"desabilitarAcessoLogarComoNosPortais":{"type":"integer","format":"int32"},"usuarioGlobalConfiguracao":{"type":"integer","format":"int32"},"usuarioRemoto":{"$ref":"#/components/schemas/UsuarioSuporteBean"},"idCliente":{"type":"integer","format":"int32"},"email":{"type":"string"},"emailStatus":{"type":"string"},"emailMotivoInvalido":{"type":"string"},"emailCodigoConfirmacao":{"type":"string"},"celular":{"type":"string"},"orgs":{"type":"array","items":{"$ref":"#/components/schemas/Org"}},"permissoes":{"type":"array","items":{"$ref":"#/components/schemas/GrantedAuthority"}},"props":{"type":"object","additionalProperties":{"type":"object"}},"enabled":{"type":"boolean"},"firstName":{"type":"string"},"lastName":{"type":"string"},"accountNonExpired":{"type":"boolean"},"accountNonLocked":{"type":"boolean"},"credentialsNonExpired":{"type":"boolean"},"emailDestinatario":{"type":"string"},"emailIdPerfil":{"type":"integer","format":"int32"},"emailNomeDestinatario":{"type":"string"},"roles":{"type":"array","items":{"type":"string"}},"username":{"type":"string"},"password":{"type":"string"},"authorities":{"type":"array","items":{"$ref":"#/components/schemas/GrantedAuthority"}},"coreTagsPessoaFisica":{"type":"array","items":{"$ref":"#/components/schemas/TableEmailTag"}},"newObjectInCache":{"type":"boolean"},"usuario":{"$ref":"#/components/schemas/IUsuario"},"ignorarLog":{"type":"boolean"}}},"UsuarioSuporteBean":{"type":"object","properties":{"idUsuarioDirector":{"type":"integer","format":"int32"},"nome":{"type":"string"},"authToken":{"type":"string"},"dataLoginRemoto":{"type":"string","format":"date-time"}}},"PageCursor":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"idCursor":{"type":"integer","format":"int32"},"idCursorProximo":{"type":"integer","format":"int32"}}},"PaginationUnidadeFisicaDtoResPageCursor":{"type":"object","properties":{"page":{"$ref":"#/components/schemas/PageCursor"},"elements":{"type":"array","items":{"$ref":"#/components/schemas/UnidadeFisicaDtoRes"}}}},"UnidadeFisicaDtoRes":{"type":"object","properties":{"idUnidadeFisica":{"type":"integer","format":"int32"},"nome":{"type":"string"},"nomeImpressao":{"type":"string"},"sigla":{"type":"string"},"logradouro":{"type":"string"},"numero":{"type":"string"},"bairro":{"type":"string"},"cep":{"type":"string"},"email":{"type":"string"},"cnpj":{"type":"string"},"fones":{"type":"string"},"idCidade":{"type":"integer","format":"int32"},"idEstado":{"type":"integer","format":"int32"},"status":{"type":"string"},"dataAtivacao":{"type":"string","format":"date-time"},"dataInativacao":{"type":"string","format":"date-time"},"codigoInep":{"type":"integer","format":"int32"},"nomeCidade":{"type":"string"},"siglaEstado":{"type":"string"},"nomeEstado":{"type":"string"},"responsavelNome":{"type":"string"},"responsavelTelefone":{"type":"string"},"responsavelCelular":{"type":"string"},"responsavelEmail":{"type":"string"},"idPerfilResponsavel":{"type":"integer","format":"int32"},"supervisorNome":{"type":"string"},"idPerfilSupervisor":{"type":"integer","format":"int32"},"naoApresentarNoFormularioAtendimento":{"type":"integer","format":"int32"},"complemento":{"type":"string"},"tipoUnidade":{"type":"string"},"observacaoHorarioAtendimento":{"type":"string"}}},"PaginationPerfilDtoResPageCursor":{"type":"object","properties":{"page":{"$ref":"#/components/schemas/PageCursor"},"elements":{"type":"array","items":{"$ref":"#/components/schemas/PerfilDtoRes"}}}},"PerfilRest":{"type":"object","properties":{"idPerfil":{"type":"integer","format":"int32"},"nome":{"type":"string"},"nomeSocial":{"type":"string"},"nomeImpressao":{"type":"string"},"idCliente":{"type":"integer","format":"int32"},"tipoPessoa":{"type":"string"},"habilidadeMotora":{"type":"string"},"cpf":{"type":"string"},"rg":{"type":"string"},"rgOrgaoExpedidor":{"type":"string"},"ufOrgaoExpedidor":{"type":"string"},"rgDataEmissao":{"type":"string","format":"date-time"},"rne":{"type":"string"},"cnpj":{"type":"string"},"inscricaoEstadual":{"type":"string"},"inscricaoMunicipal":{"type":"string"},"representanteLegal":{"type":"string"},"pai":{"type":"string"},"mae":{"type":"string"},"cpfPai":{"type":"string"},"cpfMae":{"type":"string"},"dataNascimento":{"type":"string","format":"date-time"},"dependentes":{"type":"integer","format":"int32"},"estadoCivil":{"type":"string"},"sexo":{"type":"string"},"email":{"type":"string"},"emailStatus":{"type":"string"},"emailMotivoInvalido":{"type":"string"},"emailCodigoConfirmacao":{"type":"string"},"idNacionalidade":{"type":"integer","format":"int32"},"idReligiao":{"type":"integer","format":"int32"},"idIdiomaNativo":{"type":"integer","format":"int32"},"idNecessidadeEspecial":{"type":"integer","format":"int32"},"nacionalidade":{"type":"string"},"religiao":{"type":"string"},"idiomaNativo":{"type":"string"},"necessidadeEspecial":{"type":"string"},"idCidadeNatural":{"type":"integer","format":"int32"},"naturalDe":{"type":"string"},"idCor":{"type":"integer","format":"int32"},"status":{"type":"string"},"idCidadeEndereco":{"type":"integer","format":"int32"},"bairro":{"type":"string"},"logradouro":{"type":"string"},"cep":{"type":"string"},"complemento":{"type":"string"},"localidade":{"type":"string"},"numero":{"type":"string"},"celular":{"type":"string"},"fone":{"type":"string"},"fax":{"type":"string"},"foneComercial":{"type":"string"},"tituloNumero":{"type":"string"},"tituloZona":{"type":"string"},"tituloSecao":{"type":"string"},"tituloDataExpedicao":{"type":"string","format":"date-time"},"idMunicipioTitulo":{"type":"integer","format":"int32"},"descMunicipioTitulo":{"type":"string"},"certidaoNumero":{"type":"string"},"certidaoFolha":{"type":"string"},"certidaoLivro":{"type":"string"},"certidaoCartorio":{"type":"string"},"certidaoDataEmissao":{"type":"string","format":"date-time"},"certidaoUf":{"type":"string"},"certidaoMatricula":{"type":"string"},"carteiraNumero":{"type":"string"},"carteiraSerie":{"type":"string"},"carteiraDataExpedicao":{"type":"string","format":"date-time"},"carteiraUf":{"type":"string"},"numeroPis":{"type":"string"},"reservistaRa":{"type":"string"},"reservistaCategoria":{"type":"string"},"reservistaData":{"type":"string","format":"date-time"},"reservistaOrgaoExpedidor":{"type":"string"},"certidaoCasLivroDeRegistro":{"type":"string"},"certidaoCasNumeroRegistroCas":{"type":"string"},"certidaoCasDataCasamento":{"type":"string","format":"date-time"},"certidaoCasNomeConjuge":{"type":"string"},"certidaoCasNomeJuiz":{"type":"string"},"observacao":{"type":"string"},"idProfissao":{"type":"integer","format":"int32"},"idEmpresa":{"type":"integer","format":"int32"},"cargo":{"type":"string"},"renda":{"type":"number","format":"double"},"localDeTrabalho":{"type":"string"},"tipoDeProfissao":{"type":"string"},"idioma":{"type":"string"},"desejaReceberInformacoes":{"type":"integer","format":"int32"},"naoReceberMensagemSms":{"type":"integer","format":"int32"},"tipoLocalidade":{"type":"integer","format":"int32"},"dataCriacao":{"type":"string","format":"date-time"},"dataAlteracao":{"type":"string","format":"date-time"},"ignorarLog":{"type":"boolean"}}},"Page":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"currentPage":{"type":"integer","format":"int32"},"totalElements":{"type":"integer","format":"int32"},"totalPages":{"type":"integer","format":"int32"},"ignoreFetching":{"type":"boolean"}}},"PaginationUnidadeFisicaDtoResPage":{"type":"object","properties":{"page":{"$ref":"#/components/schemas/Page"},"elements":{"type":"array","items":{"$ref":"#/components/schemas/UnidadeFisicaDtoRes"}}}},"TipoSetor":{"type":"string","enum":["NAO_INFORMADO","DESENVOLVIMENTO","IMPLANTACAO","SUPORTE","ADMINISTRATIVO","DIRETORIA","COMERCIAL"]},"PaginationSetorDtoResPage":{"type":"object","properties":{"page":{"$ref":"#/components/schemas/Page"},"elements":{"type":"array","items":{"$ref":"#/components/schemas/SetorDtoRes"}}}},"SetorDtoRes":{"type":"object","properties":{"idSetor":{"type":"integer","format":"int32"},"descricao":{"type":"string"},"tipo":{"type":"string"},"idFuncionarioResponsavel":{"type":"integer","format":"int32"},"funcionarioResponsavel":{"type":"string"}}},"PaginationPerfilDtoResPage":{"type":"object","properties":{"page":{"$ref":"#/components/schemas/Page"},"elements":{"type":"array","items":{"$ref":"#/components/schemas/PerfilDtoRes"}}}},"PerfilDadosAcessoRest":{"type":"object","properties":{"idPerfil":{"type":"integer","format":"int32"},"senha":{"type":"string"},"login":{"type":"string"},"ignorarLog":{"type":"boolean"}}},"PaginationPerfilResponsavelDtoResPage":{"type":"object","properties":{"page":{"$ref":"#/components/schemas/Page"},"elements":{"type":"array","items":{"$ref":"#/components/schemas/PerfilResponsavelDtoRes"}}}},"OrganizacaoDtoRes":{"type":"object","properties":{"idOrganizacao":{"type":"integer","format":"int32"},"descricao":{"type":"string"},"nomeFantasia":{"type":"integer","format":"int32"},"cnpj":{"type":"string"},"status":{"type":"string"}}},"PaginationOrganizacaoDtoResPage":{"type":"object","properties":{"page":{"$ref":"#/components/schemas/Page"},"elements":{"type":"array","items":{"$ref":"#/components/schemas/OrganizacaoDtoRes"}}}},"PaginationPaisDtoResPage":{"type":"object","properties":{"page":{"$ref":"#/components/schemas/Page"},"elements":{"type":"array","items":{"$ref":"#/components/schemas/PaisDtoRes"}}}},"PaisDtoRes":{"type":"object","properties":{"idPais":{"type":"integer","format":"int32"},"sigla":{"type":"string"},"descricao":{"type":"string"},"nacionalidade":{"type":"string"},"codigoInep":{"type":"string"},"codigoPaisInep":{"type":"integer","format":"int32"},"paisEstrangeiro":{"type":"integer","format":"int32"},"tratamento":{"type":"string"}}},"NacionalidadeDtoRes":{"type":"object","properties":{"idNacionalidade":{"type":"integer","format":"int32"},"descricao":{"type":"string"},"codigoInep":{"type":"integer","format":"int32"},"codigoPaisInep":{"type":"integer","format":"int32"}}},"PaginationNacionalidadeDtoResPage":{"type":"object","properties":{"page":{"$ref":"#/components/schemas/Page"},"elements":{"type":"array","items":{"$ref":"#/components/schemas/NacionalidadeDtoRes"}}}},"EstadoDtoRes":{"type":"object","properties":{"idEstado":{"type":"integer","format":"int32"},"descricao":{"type":"string"},"idPais":{"type":"integer","format":"int32"},"codigoInep":{"type":"integer","format":"int32"},"sigla":{"type":"string"},"tratamento":{"type":"string"},"dataCriacao":{"type":"string","format":"date-time"},"dataAlteracao":{"type":"string","format":"date-time"}}},"PaginationEstadoDtoResPage":{"type":"object","properties":{"page":{"$ref":"#/components/schemas/Page"},"elements":{"type":"array","items":{"$ref":"#/components/schemas/EstadoDtoRes"}}}},"CidadeDtoRes":{"type":"object","properties":{"idCidade":{"type":"integer","format":"int32"},"descricao":{"type":"string"},"idEstado":{"type":"integer","format":"int32"},"codigoInep":{"type":"integer","format":"int32"},"uf":{"type":"string"},"estado":{"type":"string"},"codigoIbge":{"type":"string"},"idPais":{"type":"integer","format":"int32"},"dataCriacao":{"type":"string","format":"date-time"},"dataAlteracao":{"type":"string","format":"date-time"}}},"PaginationCidadeDtoResPage":{"type":"object","properties":{"page":{"$ref":"#/components/schemas/Page"},"elements":{"type":"array","items":{"$ref":"#/components/schemas/CidadeDtoRes"}}}},"InstituicaoDtoRes":{"type":"object","properties":{"idInstituicao":{"type":"integer","format":"int32"},"nome":{"type":"string"},"nomeImpressao":{"type":"string"},"cidadeInstituicao":{"type":"string"},"estadoInstituicao":{"type":"string"},"logradouro":{"type":"string"},"numero":{"type":"string"},"bairro":{"type":"string"},"cep":{"type":"string"},"fones":{"type":"string"},"idCidade":{"type":"integer","format":"int32"},"idEstado":{"type":"integer","format":"int32"},"isentarInscricaoVestibular":{"type":"integer","format":"int32"},"apresentarInscricaoVestibular":{"type":"integer","format":"int32"},"codigoMec":{"type":"string"},"apresentarDiplomasRegistradosNoPortal":{"type":"integer","format":"int32"}}},"PaginationInstituicaoDtoResPage":{"type":"object","properties":{"page":{"$ref":"#/components/schemas/Page"},"elements":{"type":"array","items":{"$ref":"#/components/schemas/InstituicaoDtoRes"}}}},"FuncaoDtoRes":{"type":"object","properties":{"idFuncao":{"type":"integer","format":"int32"},"descricao":{"type":"string"},"status":{"type":"string"}}},"PaginationFuncaoDtoResPage":{"type":"object","properties":{"page":{"$ref":"#/components/schemas/Page"},"elements":{"type":"array","items":{"$ref":"#/components/schemas/FuncaoDtoRes"}}}},"FuncionarioDtoRes":{"type":"object","properties":{"idFuncionario":{"type":"integer","format":"int32"},"idPerfil":{"type":"integer","format":"int32"},"idSetor":{"type":"integer","format":"int32"},"idFuncao":{"type":"integer","format":"int32"},"idDepartamento":{"type":"integer","format":"int32"},"emailEmpresa":{"type":"string"},"emailEmpresaSenha":{"type":"string"},"setorDescricao":{"type":"string"},"funcaoDescricao":{"type":"string"},"departamentoDescricao":{"type":"string"},"conjuge":{"type":"string"},"conjugeFone":{"type":"string"},"status":{"type":"string"},"dataAdmissao":{"type":"string","format":"date-time"},"dataDemissao":{"type":"string","format":"date-time"},"banco":{"type":"string"},"numeroBanco":{"type":"string"},"conta":{"type":"string"},"agencia":{"type":"string"},"dependentes":{"type":"integer","format":"int32"},"numeroFolha":{"type":"string"},"nome":{"type":"string"},"cpf":{"type":"string"},"rg":{"type":"string"},"login":{"type":"string"},"senha":{"type":"string"},"celular":{"type":"string"},"fone":{"type":"string"},"email":{"type":"string"},"logradouro":{"type":"string"},"bairro":{"type":"string"},"numero":{"type":"string"},"cep":{"type":"string"},"complemento":{"type":"string"}}},"PaginationFuncionarioDtoResPage":{"type":"object","properties":{"page":{"$ref":"#/components/schemas/Page"},"elements":{"type":"array","items":{"$ref":"#/components/schemas/FuncionarioDtoRes"}}}},"StatusDepartamento":{"type":"string","enum":["ATIVO","INATIVO"]},"DepartamentoDtoRes":{"type":"object","properties":{"idDepartamento":{"type":"integer","format":"int32"},"descricao":{"type":"string"},"tipoDepartamento":{"type":"string"},"status":{"type":"string"}}},"PaginationDepartamentoDtoResPage":{"type":"object","properties":{"page":{"$ref":"#/components/schemas/Page"},"elements":{"type":"array","items":{"$ref":"#/components/schemas/DepartamentoDtoRes"}}}},"PaginationPerfilBloqueioDtoResPage":{"type":"object","properties":{"page":{"$ref":"#/components/schemas/Page"},"elements":{"type":"array","items":{"$ref":"#/components/schemas/PerfilBloqueioDtoRes"}}}}},"securitySchemes":{"Access Token":{"type":"apiKey","name":"Authorization","in":"header"}}}}