\r\n\tEstá aplicação permite a criação, assinatura e validação de diplomas digitais de acordo com o os requisitos publicados na portaria MEC nº 554/2019.\r\n\tA assinatura do diploma é gerenciada pelo módulo externo de assinaturas (Assinador).\r\n
\r\n\r\n\r\n\tTodas as chamadas de API exigem uma chave de acesso de API (API Key). Essa chave deve ser colocada no cabeçalho de todas requisições:\r\n
\r\n\r\nX-Api-Key: your-app|xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\r\n
\r\n\tToda chave de API está associada uma Organização previamente cadastrada. Sendo assim, o escopo dessa chave fica restrito àquela organização,\r\n\tisto é, aquela chave só permitirá acessar/criar diplomas naquela organização.\r\n
\r\n\r\n\r\n\tEntre em contato com o administrador para obter uma chave de API.\r\n
\r\n\r\n\r\n\tAs APIs para validação de diplomas são públicas e não exigem autenticação, isto é não necessitam de uma chave de API.\r\n
\r\n\r\nEsta seção descreve o fluxo para a IES que deseja fazer apenas a emissão de diplomas.
\r\n\r\nAo final do fluxo, será gerado também o histórico escolar final do aluno.
\r\n\r\nPara emitir um ou mais diplomas devem ser seguidos os passos abaixo:
\r\n\r\n\r\n\tEste passo deve ser feito no Painel de Configurações da aplicação.\r\n
\r\n\r\n\r\n\tEntre em contato com o administrador da instância do Assinador utilizada em conjunto com esta aplicação para obter uma chave de API do assinador que\r\n\tpermitirá o envio e assinatura dos arquivos XML de diploma no assinador.\r\n
\r\n\r\n\r\n\tOs modelos definem como será a representação visual de cada diploma digital (RVDD). Para emissões, ele não é obrigatório (nesse caso, o diploma, uma vez emitido, não possuirá RVDD).\r\n
\r\n\r\n\r\n\tUm modelo é um arquivo PDF Form com campos que serão preenchidos com os dados diploma. Todos os dados especificados na portaria MEC nº 554/2019 estarão\r\n\tdisponíveis para serem aplicados na representação visual. A tela de Criação de Modelo tem mais informações sobre como referenciar campos no modelo.\r\n
\r\n\r\n\r\n\tUm exemplo de modelo pode ser encontrado aqui.\r\n
\r\n\r\n\r\n\tPara criar um modelo utilize a API de criação de modelo.\r\n
\r\n\r\n\r\n\tOs modelos de histórico escolar definem como será a representação visual de cada histórico escolar (RVHE).\r\n
\r\n\r\n\r\n\tUm modelo de histórico escolar é um arquivo PDF com uma página e orientação em retrato com o cabeçalho contendo informações sobre a IES,\r\n\tcomo nome, endereço, informações sobre ato regulatório e a logo (opcional). A geração da representação visual do histórico escolar\r\n\tsegue o Artigo 17 da portaria MEC nº 1095/2018.\r\n
\r\n\r\n\r\n\tUm exemplo de modelo pode ser encontrado\r\n\t\taqui.\r\n
\r\n\r\n\r\n\tPara criar um modelo utilize a API de criação de modelo.\r\n
\r\n\r\n\r\n\tOs fluxos de assinatura definem os signatários do XML de documentação acadêmica de cada diploma e do XML do histórico escolar.\r\n
\r\n\r\nSeguem as especificações:
\r\n\r\n\r\n\tPara criar um fluxo, utilize a API de criação de fluxo especificando o type como Emission.\r\n
\r\n\r\n\r\n\tA criação de um fluxo não é obrigatória, é apenas uma facilidade para não ter que preencher todos os signatários no momento da criação de um lote de emissão.\r\n
\r\n\r\n\r\n\tPara criar um lote, será preciso um arquivo JSON com os dados das emissões. Cada entrada do arquivo corresponderá a um diploma e deve possuir todos os dados\r\n\tespecificados para a documentação acadêmica do Aluno na portaria MEC nº 554/2019.\r\n
\r\n\r\n\r\n\tUm exemplo do arquivo JSON pode ser encontrado aqui.\r\n
\r\n\r\n\r\n\tNa criação do lote deve ser especificado como será realizado o registro das emissões no campo emission.registrationType. As opções estão descritas abaixo:\r\n
\r\n\r\n\r\n\tUtilize a API de geração de ticket de documentação acadêmica para obter o arquivo XML assinado.\r\n
\r\n\r\n\r\n\tPara completar a emissão do diploma, na modalidade manual, utilize a API de envio de XML de dados públicos.\r\n
\r\n\r\nEsta seção descreve o fluxo para a IES que deseja fazer apenas o registro de diplomas.
\r\n\r\nPara criar uma requisição de registro devem ser seguidos os passos abaixo:
\r\n\r\n\r\n\tEste passo deve ser feito no Painel de Configurações da aplicação.\r\n
\r\n\r\n\r\n\tEntre em contato com o administrador da instância do Assinador utilizada em conjunto com esta aplicação para obter uma chave de API do assinador que\r\n\tpermitirá o envio e assinatura dos arquivos XML de diploma no assinador.\r\n
\r\n\r\n\r\n\tOs fluxos de assinatura definem os signatários do XML de dados públicos de cada diploma.\r\n
\r\n\r\n\r\n\tToda emissão deve ser assinada por um ou mais representantes da IES Registradora (com certificado e-CPF) e pela própria IES Registradora através de seu certificado\r\n\tdigital institucional (certificado e-CNPJ).\r\n
\r\n\r\n\r\n\tPara criar um fluxo, utilize a API de criação de fluxo especificando o type como Registration.\r\n
\r\n\r\n\r\n\tA criação de um fluxo não é obrigatória, é apenas uma facilidade para não ter que preencher todos os signatários no momento da criação de um lote de requisições de registro.\r\n
\r\n\r\n\r\n\tPara criar um lote, será preciso um conjunto de arquivos XML de documentação acadêmica assinados. Esses arquivos devem ser encaminhados pela IES Emissora e cada arquivo\r\n\tcorresponderá a um diploma.\r\n
\r\n\r\n\r\n\tUma vez criada a a requisição de registro, ela deve ser validada para verificar se os dados do aluno conferem com a documentação comprobatória.\r\n\tUtilize a API de informações da requisição de registro\r\n\tpara obter todas informações referentes a essa validação.\r\n
\r\n\r\n\r\n\tApós a validação das informações, utilize a API de aprovação ou a\r\n\tAPI de recusa para concluir o processo de revisão.\r\n
\r\n\r\n\r\n\tCaso a requisição seja aprovada, deve ser feito o registro informando os dados de registro na \r\n\tAPI de registro de requisição.\r\n
\r\n\r\n\r\n\tUma vez informados os dados de registro, o sistema gerará o XML de dados públicos. Ele será enviado ao Assinador para a coleta das assinaturas de registro.\r\n
\r\n\r\n\r\n\tUtilize a API de geração de ticket de dados públicos para obter o arquivo XML assinado.\r\n
\r\n\r\n\r\n\tEste arquivo deve ser enviado à IES Emissora para possibilitar a criação do diploma digital.\r\n
\r\n\r\n\r\n\tEsta seção descreve o fluxo para a IES que deseja fazer emissão e registro em paralelo. Assume-se que no início do fluxo todas as etapas de emissão e registro já\r\n\tforam realizadas internamente pela IES e ela deseja apenas formalizar o processo de acordo com a regulamentação do MEC.\r\n
\r\n\r\nSerá gerado também o histórico escolar final do aluno.
\r\n\r\nPara criar um ou mais diplomas devem ser seguidos os passos abaixo:
\r\n\r\n\r\n\tEste passo deve ser feito no Painel de Configurações da aplicação.\r\n
\r\n\r\n\r\n\tEntre em contato com o administrador da instância do Assinador utilizada em conjunto com esta aplicação para obter uma chave de API do assinador que\r\n\tpermitirá o envio e assinatura dos arquivos XML de diploma no assinador.\r\n
\r\n\r\n\r\n\tOs modelos definem como será a representação visual de cada diploma.\r\n
\r\n\r\n\r\n\tUm modelo é um arquivo PDF Form com campos que serão preenchidos com os dados diploma. Todos os dados especificados na portaria MEC nº 554/2019 estarão\r\n\tdisponíveis para serem aplicados na representação visual. A tela de Criação de Modelo tem mais informações sobre como referenciar campos no modelo.\r\n
\r\n\r\n\r\n\tUm exemplo de modelo pode ser encontrado aqui.\r\n
\r\n\r\n\r\n\tPara criar um modelo utilize a API de criação de modelo.\r\n
\r\n\r\n\r\n\tOs modelos de histórico escolar definem como será a representação visual de cada histórico escolar (RVHE).\r\n
\r\n\r\n\r\n\tUm modelo de histórico escolar é um arquivo PDF com uma página e orientação em retrato com o cabeçalho contendo informações sobre a IES, como nome, endereço, informações sobre ato regulatório e a logo (opcional). A geração da representação visual do histórico escolar segue o Artigo 17 da portaria MEC nº 1095/2018.\r\n
\r\n\r\n\r\n\tUm exemplo de modelo pode ser encontrado aqui.\r\n
\r\n\r\n\r\n\tPara criar um modelo utilize a API de criação de modelo.\r\n
\r\n\r\n\r\n\tOs fluxos de assinatura definem os signatários do XML de dados públicos de cada diploma.\r\n
\r\n\r\n\r\n\tTodo diploma passa por 3 estágios de assinatura: Emissão, Registro, Armazenamento e Histórico escolar. Deve ser especificado os signatários de cada um dos estágios.\r\n
\r\n\r\n\r\n\tPara criar um fluxo utilize a API de criação de fluxo.\r\n
\r\n\r\n\r\n\tA criação de um fluxo não é obrigatória, é apenas uma facilidade para não ter que preencher todos os signatários no momento da criação de um lote de diplomas.\r\n
\r\n\r\n\r\n\tAntes de criar um lote é preciso ter cadastrado previamente um modelo que será utilizado para gerar a representação visual dos diplomas.\r\n
\r\n\r\n\r\n\tPara criar um lote, será preciso um arquivo JSON ou CSV com os dados dos diplomas. Cada linha do arquivo CSV corresponderá a um diploma e ambos os tipos de arquivos devem possuir todos os dados\r\n\tespecificados na portaria MEC nº 554/2019.\r\n
\r\n\r\n\r\n\tOs passos abaixo são para os dois tipos de arquivo, JSON ou CSV.\r\n
\r\n\r\n\r\n\tUma alternativa à criação de lotes é a criação unitária de diplomas com a API de criação de diploma.\r\n
\r\n\r\n\r\n\tUtilize a API de atualização de status de diploma para cancelar o restaurar um diploma.\r\n
\r\n\r\n\r\n\tDiplomas cancelados antes da conclusão do processo de assinaturas não poderão ser restaurados.\r\n
\r\n\r\n\r\n\tUtilize a API de histórico de diploma para visualizar todas as alterações de status de um diploma.\r\n
\r\n\r\n\r\n\tEsta seção descreve o fluxo para a IES que deseja realizar a emissão de um histórico escolar.\r\n
\r\n\r\nPara emitir um ou mais históricos escolares devem ser seguidos os passos abaixo:
\r\n\r\n\r\n\tEste passo deve ser feito no Painel de Configurações da aplicação.\r\n
\r\n\r\n\r\n\tEntre em contato com o administrador da instância do Assinador utilizada em conjunto com esta aplicação para obter uma chave de API do assinador que permitirá o envio e assinatura dos arquivos XML de histórico escolar no assinador.\r\n
\r\n\r\n\r\n\tOs modelos definem como será a representação visual de cada histórico escolar (RVHE).\r\n
\r\n\r\n\r\n\tUm modelo é um arquivo PDF com uma página e orientação em retrato com o cabeçalho contendo informações sobre a IES,\r\n\tcomo nome, endereço, informações sobre ato regulatório e a logo (opcional). A geração da representação visual do histórico escolar\r\n\tsegue o Artigo 17 da portaria MEC nº 1095/2018.\r\n
\r\n\r\n\r\n\tUm exemplo de modelo pode ser encontrado aqui.\r\n
\r\n\r\n\r\n\tPara criar um modelo utilize a API de criação de modelo.\r\n
\r\n\r\n\r\n\tOs fluxos de assinatura definem os signatários do XML do histórico escolar.\r\n
\r\n\r\n\r\n\tTodo histórico deve ser assinado pela própria IES emissora através de seu certificado digital institucional (certificado e-CNPJ). É opcional o histórico escolar ser assinado por representante da IES emissora (com certificado e-CPF).\r\n
\r\n\r\n\r\n\tPara criar um fluxo, utilize a API de criação de fluxo especificando o type como AcademicTranscript.\r\n
\r\n\r\n\r\n\tA criação de um fluxo não é obrigatória, é apenas uma facilidade para não ter que preencher todos os signatários no momento da criação de um lote de emissão.\r\n
\r\n\r\n\r\n\tPara criar um lote, será preciso um arquivo JSON com os dados referentes ao histórico escolar. Cada entrada do arquivo corresponderá a um histórico escolar e deve possuir todos os dados\r\n\tespecificados para o histórico escolar do Aluno na portaria MEC nº 1095/2018.\r\n
\r\n\r\n\r\n\tUm exemplo do arquivo JSON pode ser encontrado aqui.\r\n
\r\n\r\n\r\n\tNa criação do lote deve ser especificado o tipo dos históricos escolares no campo academicTranscriptType. As opções estão descritas abaixo:\r\n
\r\n\r\n\r\n\tUma alternativa à criação de lotes é a criação unitária de histórico escolar com a
\r\n\tEsta seção descreve o fluxo para a IES que deseja realizar a emissão de um currículo escolar.\r\n
\r\n\r\nPara emitir um ou mais currículos escolares devem ser seguidos os passos abaixo:
\r\n\r\n\r\n\tEste passo deve ser feito no Painel de Configurações da aplicação.\r\n
\r\n\r\n\r\n\tEntre em contato com o administrador da instância do Assinador utilizada em conjunto com esta aplicação para obter uma chave de API do assinador que permitirá o envio e assinatura dos arquivos XML de currículo escolar no assinador.\r\n
\r\n\r\n\r\n\tOs modelos definem como será a representação visual de cada currículo escolar (RVCE).\r\n
\r\n\r\n\r\n\tUm exemplo de modelo pode ser encontrado aqui.\r\n
\r\n\r\n\r\n\tPara criar um modelo utilize a API de criação de modelo.\r\n
\r\n\r\n\r\n\tOs fluxos de assinatura definem os signatários do XML do currículo escolar.\r\n
\r\n\r\n\r\n\tTodo currículo deve ser assinado pela própria IES através de seu certificado digital institucional (certificado e-CNPJ). É opcional o currículo escolar ser assinado por coordenador do curso na IES (com certificado e-CPF).\r\n
\r\n\r\n\r\n\tPara criar um fluxo, utilize a API de criação de fluxo especificando o type como Curriculum.\r\n
\r\n\r\n\r\n\tA criação de um fluxo não é obrigatória, é apenas uma facilidade para não ter que preencher todos os signatários no momento da criação de um lote de emissão.\r\n
\r\n\r\n\r\n\tPara criar um lote, será preciso um arquivo JSON com os dados referentes ao currículo escolar. Cada entrada do arquivo corresponderá a um currículo escolar e deve possuir todos os dados\r\n\tespecificados para o currículo escolar de acordo com a Instrução Normativa SESU nº 2 e versões posteriores.\r\n
\r\n\r\n\r\n\tUm exemplo do arquivo JSON pode ser encontrado aqui.\r\n
\r\n\r\n\r\n\tUma alternativa à criação de lotes é a criação unitária de currículo escolar com a
\r\n\tAs APIs poderão retornar os seguintes códigos de status HTTP:\r\n
\r\n\r\n| Código | \r\n\t\t\tDescrição | \r\n\t\t
|---|---|
| 200 (OK) | \r\n\t\t\tRequisição processada com sucesso. A resposta é diferente para cada API, verifique a documentação específica de cada operação | \r\n\t\t
| 400 (Bad Request) | \r\n\t\t\tErro de sintaxe. Por exemplo, quando um campo obrigatório não for preenchido. O corpo da resposta indicará qual parâmetro está inválido ou não foi preenchido. | \r\n\t\t
| 401 (Unauthorized) | \r\n\t\t\tA chave de API não foi fornecida ou é inválida | \r\n\t\t
| 403 (Forbidden) | \r\n\t\t\tA chave de API é válida, mas tem privilégios insuficientes para completar a operação solicitada | \r\n\t\t
| 422 (Unprocessable Entity) | \r\n\t\t\tErro de lógica de négocio. A resposta conterá uma mensagem e um código de erro conforme defindo em ErrorModel | \r\n\t\t
Alguns dos códigos de erro retornados em uma resposta com status 422 podem ser encontrados abaixo*:
\r\n\r\n\r\n\t*Os códigos mostrados acima são os principais. No entanto esta não é uma lista exaustiva. Novos códigos de erro podem ser adicionados sem aviso prévio.\r\n
\r\n\r\n\r\n\r\n\r\n\tÉ recomendado escutar eventos de Webhook ao invés de realizar polling de APIs. Para isso, habilite e registre uma URL que receberá uma requisição POST\r\n\tsempre que um dos eventos descritos abaixo ocorrerem.\r\n
\r\n\r\n\tTodas requisições tem o formato descrito em Webhooks.WebhookModel.\r\n\tO campo data varia de acordo com o tipo de evento do Webhook:\r\n
\r\n\r\n\r\n| Tipo do Evento | \r\n\t\t\tDescrição | \r\n\t\t\tConteúdo | \r\n\t\t
|---|---|---|
| DegreeConcluded | \r\n\t\t\tDisparado quando um diploma é concluído (quando XML do diploma e da documentação acadêmica estiverem assinados). | \r\n\t\t\tWebhooks.DegreeConcludedModel | \r\n\t\t
| DegreeCanceledTemporarily | \r\n\t\t\tDisparado quando um diploma é anulado temporariamente. | \r\n\t\t\tWebhooks.DegreeUpdatedModel | \r\n\t\t
| DegreeCanceled | \r\n\t\t\tDisparado quando um diploma é anulado. | \r\n\t\t\tWebhooks.DegreeUpdatedModel | \r\n\t\t
| DegreeRestored | \r\n\t\t\tDisparado quando um diploma é restaurado. | \r\n\t\t\tWebhooks.DegreeUpdatedModel | \r\n\t\t
| EmissionSigned | \r\n\t\t\tDisparado quando uma emissão é assinada. | \r\n\t\t\tWebhooks.EmissionUpdatedModel | \r\n\t\t
| EmissionSentToRegistry | \r\n\t\t\tDisparado quando uma emissão é enviada para registradora. | \r\n\t\t\tWebhooks.EmissionUpdatedModel | \r\n\t\t
| EmissionRegistered | \r\n\t\t\tDisparado quando uma emissão é registrada. | \r\n\t\t\tWebhooks.EmissionUpdatedModel | \r\n\t\t
| EmissionCanceled | \r\n\t\t\tDisparado quando uma emissão é cancelada. | \r\n\t\t\tWebhooks.EmissionUpdatedModel | \r\n\t\t
| RegistrationCreated | \r\n\t\t\tDisparado quando uma requisição de registro é criada. | \r\n\t\t\tWebhooks.RegistrationUpdatedModel | \r\n\t\t
| RegistrationApproved | \r\n\t\t\tDisparado quando uma requisição de registro é aprovada. | \r\n\t\t\tWebhooks.RegistrationUpdatedModel | \r\n\t\t
| RegistrationRejected | \r\n\t\t\tDisparado quando uma requisição de registro é recusada. | \r\n\t\t\tWebhooks.RegistrationUpdatedModel | \r\n\t\t
| RegistrationRegistered | \r\n\t\t\tDisparado quando uma requisição de registro é registrada. | \r\n\t\t\tWebhooks.RegistrationUpdatedModel | \r\n\t\t
| RegistrationSigned | \r\n\t\t\tDisparado quando uma requisição de registro é assinada. | \r\n\t\t\tWebhooks.RegistrationUpdatedModel | \r\n\t\t
| RegistrationCanceled | \r\n\t\t\tDisparado quando uma requisição de registro é cancelada. | \r\n\t\t\tWebhooks.RegistrationUpdatedModel | \r\n\t\t
| RegistrationSentToIssuer | \r\n\t\t\tDisparado quando uma requisição de registro registrada é enviada à emissora. | \r\n\t\t\tWebhooks.RegistrationUpdatedModel | \r\n\t\t
| AcademicTranscriptCreated | \r\n\t\t\tDisparado quando uma emissão de histórico escolar é criada. | \r\n\t\t\tWebhooks.AcademicTranscriptUpdatedModel | \r\n\t\t
| AcademicTranscriptConcluded | \r\n\t\t\tDisparado quando uma emissão de histórico escolar é concluída. | \r\n\t\t\tWebhooks.AcademicTranscriptUpdatedModel | \r\n\t\t
| AcademicTranscriptCanceled | \r\n\t\t\tDisparado quando um histórico escolar é cancelado. | \r\n\t\t\tWebhooks.AcademicTranscriptUpdatedModel | \r\n\t\t
| AcademicTranscriptCanceledTemporarily | \r\n\t\t\tDisparado quando um histórico escolar é anulado temporariamente. | \r\n\t\t\tWebhooks.AcademicTranscriptUpdatedModel | \r\n\t\t
| CancellationListGenerated | \r\n\t\t\tDisparado quando uma lista de diplomas anulados é gerada. | \r\n\t\t\tCancellationList.CancellationListModel | \r\n\t\t
| InspectionFileStarted | \r\n\t\t\tDisparado quando a geração de um arquivo de fiscalização é iniciada. | \r\n\t\t\tWebhooks.InspectionFileUpdatedModel | \r\n\t\t
| InspectionFileGenerated | \r\n\t\t\tDisparado quando um arquivo de fiscalização é gerado. | \r\n\t\t\tWebhooks.InspectionFileUpdatedModel | \r\n\t\t
| InspectionFileGenerationError | \r\n\t\t\tDisparado quando ocorre um erro durante a geração do arquivo de fiscalização. | \r\n\t\t\tWebhooks.InspectionFileUpdatedModel | \r\n\t\t
| CurriculumCreated | \r\n\t\t\tDisparado quando uma emissão de currículo escolar é criada. | \r\n\t\t\tWebhooks.CurriculumUpdatedModel | \r\n\t\t
| CurriculumConcluded | \r\n\t\t\tDisparado quando uma emissão de currículo escolar é concluída. | \r\n\t\t\tWebhooks.CurriculumUpdatedModel | \r\n\t\t
| CurriculumCanceled | \r\n\t\t\tDisparado quando um currículo escolar é cancelado. | \r\n\t\t\tWebhooks.CurriculumUpdatedModel | \r\n\t\t
| EmissionRegistrationAccepted | \r\n\t\t\tDisparado quando uma emissão é aceita pela instituição registradora. | \r\n\t\t\tWebhooks.EmissionRegistrationUpdatedModel | \r\n\t\t
| EmissionRegistrationApproved | \r\n\t\t\tDisparado quando uma emissão é aprovada pela instituição registradora | \r\n\t\t\tWebhooks.EmissionRegistrationUpdatedModel | \r\n\t\t
| EmissionRegistrationRejected | \r\n\t\t\tDisparado quando uma emissão é rejeitada pela instituição registradora | \r\n\t\t\tWebhooks.EmissionRegistrationUpdatedModel | \r\n\t\t
| EmissionRegistrationCanceled | \r\n\t\t\tDisparado quando uma emissão é cancelada pela instituição registradora | \r\n\t\t\tWebhooks.EmissionRegistrationUpdatedModel | \r\n\t\t
| EmissionRegistrationRegistered | \r\n\t\t\tDisparado quando uma emissão é registrada pela instituição registradora | \r\n\t\t\tWebhooks.EmissionRegistrationUpdatedModel | \r\n\t\t
| RestampCreated | \r\n\t\t\tDisparado quando uma renotarização é criada. | \r\n\t\t\tWebhooks.RestampUpdatedModel | \r\n\t\t
| RestampUpdated | \r\n\t\t\tDisparado quando uma renotarização é atualizada. | \r\n\t\t\tWebhooks.RestampUpdatedModel | \r\n\t\t
| RestampApplied | \r\n\t\t\tDisparado quando a renotarização é aplicada a um documento. | \r\n\t\t\tWebhooks.RestampUpdatedModel | \r\n\t\t
| RestampApplyingError | \r\n\t\t\tDisparado quando ocorre um erro no processo de renotarização de um documento. | \r\n\t\t\tWebhooks.RestampUpdatedModel | \r\n\t\t
| RestampCreationError | \r\n\t\t\tDisparado quando ocorre um erro na criação de uma renotarização. | \r\n\t\t\tWebhooks.RestampUpdatedModel | \r\n\t\t
\r\n\tPara registrar a URL de sua aplicação e habilitar os Webhooks, acesse a página de configurações de sua organização.\r\n
\r\n", "version": "3.1.5" }, "paths": { "/api/academic-transcripts": { "post": { "tags": [ "AcademicTranscripts" ], "summary": "Cria um histórico escolar", "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/AcademicTranscripts.AcademicTranscriptCreateRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AcademicTranscripts.AcademicTranscriptCreateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AcademicTranscripts.AcademicTranscriptCreateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AcademicTranscripts.AcademicTranscriptCreateRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Degrees.DocumentCreateBaseResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Degrees.DocumentCreateBaseResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Degrees.DocumentCreateBaseResponse" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } }, "get": { "tags": [ "AcademicTranscripts" ], "summary": "Obtém todos históricos escolares cadastrados paginando a resposta", "parameters": [ { "name": "Status", "in": "query", "schema": { "$ref": "#/components/schemas/AcademicTranscriptStatus" } }, { "name": "BatchId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "StartDateUtc", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "EndDateUtc", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "IsSigned", "in": "query", "description": "Filtra os documentos assinados independente do status ser ativo ou cancelado", "schema": { "type": "boolean" } }, { "name": "Q", "in": "query", "description": "Query to filter items.", "schema": { "type": "string" } }, { "name": "Limit", "in": "query", "description": "Number of items to return.", "schema": { "type": "integer", "format": "int32" } }, { "name": "Offset", "in": "query", "description": "The offset of the searched page (starting with 0).", "schema": { "type": "integer", "format": "int32" } }, { "name": "Order", "in": "query", "schema": { "$ref": "#/components/schemas/PaginationOrders" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedSearchResponse`1[[AcademicTranscripts.AcademicTranscriptModel, Lacuna.Digiploma.Api, Version=3.1.0.0, Culture=neutral, PublicKeyToken=3835d68b69925328]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedSearchResponse`1[[AcademicTranscripts.AcademicTranscriptModel, Lacuna.Digiploma.Api, Version=3.1.0.0, Culture=neutral, PublicKeyToken=3835d68b69925328]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedSearchResponse`1[[AcademicTranscripts.AcademicTranscriptModel, Lacuna.Digiploma.Api, Version=3.1.0.0, Culture=neutral, PublicKeyToken=3835d68b69925328]]" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/academic-transcripts/{id}": { "get": { "tags": [ "AcademicTranscripts" ], "summary": "Obtém informações de um histórico escolar", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AcademicTranscripts.AcademicTranscriptDetailsModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AcademicTranscripts.AcademicTranscriptDetailsModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AcademicTranscripts.AcademicTranscriptDetailsModel" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/academic-transcripts/{id}/xml-ticket": { "get": { "tags": [ "AcademicTranscripts" ], "summary": "Obtém um ticket (URL) para download do histórico escolar em xml", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/TicketFileModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TicketFileModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TicketFileModel" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/academic-transcripts/{id}/xml": { "get": { "tags": [ "AcademicTranscripts" ], "summary": "Obtém o XML assinado do histórico escolar caso esteja válido", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/academic-transcripts/{id}/xml-b64": { "get": { "tags": [ "AcademicTranscripts" ], "summary": "Obtém o XML assinado do histórico escolar codificado no formato Base64", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Documents.DocumentContentModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Documents.DocumentContentModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Documents.DocumentContentModel" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/academic-transcripts/{id}/history": { "get": { "tags": [ "AcademicTranscripts" ], "summary": "Obtém histórico de atualizações do histórico escolar", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AcademicTranscripts.AcademicTranscriptStatusUpdateModel" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AcademicTranscripts.AcademicTranscriptStatusUpdateModel" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AcademicTranscripts.AcademicTranscriptStatusUpdateModel" } } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/academic-transcripts/{id}/cancellation": { "post": { "tags": [ "AcademicTranscripts" ], "summary": "Cancela uma emissão", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/AcademicTranscripts.AcademicTranscriptCancellationRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AcademicTranscripts.AcademicTranscriptCancellationRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AcademicTranscripts.AcademicTranscriptCancellationRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AcademicTranscripts.AcademicTranscriptCancellationRequest" } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/academic-transcripts/{id}/status": { "post": { "tags": [ "AcademicTranscripts" ], "summary": "Atualiza o status", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/AcademicTranscripts.AcademicTranscriptUpdateStatusRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AcademicTranscripts.AcademicTranscriptUpdateStatusRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AcademicTranscripts.AcademicTranscriptUpdateStatusRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AcademicTranscripts.AcademicTranscriptUpdateStatusRequest" } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/academic-transcripts/{id}/visual-representation-ticket": { "get": { "tags": [ "AcademicTranscripts" ], "summary": "Obtém um ticket (URL) para download da representação visual do histórico escolar", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/TicketFileModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TicketFileModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TicketFileModel" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/academic-transcripts/{id}/visual-representation-b64": { "get": { "tags": [ "AcademicTranscripts" ], "summary": "Obtém a representação visual do histórico escolar codificado no formato Base64", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Documents.DocumentContentModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Documents.DocumentContentModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Documents.DocumentContentModel" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/academic-transcripts/codes/{code}": { "get": { "tags": [ "AcademicTranscripts" ], "summary": "Valida um histórico escolar pelo seu código de validação", "description": "Requer autenticação", "parameters": [ { "name": "code", "in": "path", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AcademicTranscripts.AcademicTranscriptValidationModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AcademicTranscripts.AcademicTranscriptValidationModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AcademicTranscripts.AcademicTranscriptValidationModel" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/academic-transcripts/{code}/validation": { "get": { "tags": [ "AcademicTranscripts" ], "summary": "Valida um histórico escolar pelo seu código de validação", "parameters": [ { "name": "code", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "captcha", "in": "query", "description": "Token CAPTCHA caso habilitado", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AcademicTranscripts.AcademicTranscriptValidationModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AcademicTranscripts.AcademicTranscriptValidationModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AcademicTranscripts.AcademicTranscriptValidationModel" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/academic-transcripts/{code}/validation/visual-representation": { "get": { "tags": [ "AcademicTranscripts" ], "summary": "Obtém a representação visual de um histórico escolar caso esteja válido", "description": "Utilizar essa operação somente se o CAPTCHA estiver desabilitado", "parameters": [ { "name": "code", "in": "path", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/academic-transcripts/{code}/validation/xml": { "get": { "tags": [ "AcademicTranscripts" ], "summary": "Obtém o XML de dados públicos de um histórico escolar caso esteja válido", "description": "Utilizar essa operação somente se o CAPTCHA estiver desabilitado", "parameters": [ { "name": "code", "in": "path", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/academic-transcripts/{id}/visual-representation": { "post": { "tags": [ "AcademicTranscripts" ], "summary": "Altera a representação visual do histórico escolar", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Documents.UpdateDocumentVisualRepresentationRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Documents.UpdateDocumentVisualRepresentationRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Documents.UpdateDocumentVisualRepresentationRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Documents.UpdateDocumentVisualRepresentationRequest" } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/batches": { "get": { "tags": [ "Batches" ], "summary": "Obtém todos lotes cadastrados paginando a resposta", "parameters": [ { "name": "Q", "in": "query", "description": "Query to filter items.", "schema": { "type": "string" } }, { "name": "Limit", "in": "query", "description": "Number of items to return.", "schema": { "type": "integer", "format": "int32" } }, { "name": "Offset", "in": "query", "description": "The offset of the searched page (starting with 0).", "schema": { "type": "integer", "format": "int32" } }, { "name": "Order", "in": "query", "schema": { "$ref": "#/components/schemas/PaginationOrders" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedSearchResponse[Batches.BatchModel]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedSearchResponse[Batches.BatchModel]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedSearchResponse[Batches.BatchModel]" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } }, "post": { "tags": [ "Batches" ], "summary": "Cria um lote de diplomas", "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Batches.BatchCreateRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Batches.BatchCreateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Batches.BatchCreateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Batches.BatchCreateRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Batches.BatchCreateResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Batches.BatchCreateResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Batches.BatchCreateResponse" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/batches/{id}": { "get": { "tags": [ "Batches" ], "summary": "Obtém informações de um lote", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Batches.BatchModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Batches.BatchModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Batches.BatchModel" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/batches/{id}/log-ticket": { "get": { "tags": [ "Batches" ], "summary": "Obtém ticket (URL) para baixar arquivo de log do lote", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/TicketModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TicketModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TicketModel" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/batches/{id}/degrees": { "get": { "tags": [ "Batches" ], "summary": "Obtém todos diplomas cadastrados no lote paginando a resposta", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Q", "in": "query", "description": "Query to filter items.", "schema": { "type": "string" } }, { "name": "Limit", "in": "query", "description": "Number of items to return.", "schema": { "type": "integer", "format": "int32" } }, { "name": "Offset", "in": "query", "description": "The offset of the searched page (starting with 0).", "schema": { "type": "integer", "format": "int32" } }, { "name": "Order", "in": "query", "schema": { "$ref": "#/components/schemas/PaginationOrders" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedSearchResponse[Degrees.DegreeModel]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedSearchResponse[Degrees.DegreeModel]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedSearchResponse[Degrees.DegreeModel]" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/batches/{id}/emissions": { "get": { "tags": [ "Batches" ], "summary": "Obtém todas emissões cadastradas no lote paginando a resposta", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Q", "in": "query", "description": "Query to filter items.", "schema": { "type": "string" } }, { "name": "Limit", "in": "query", "description": "Number of items to return.", "schema": { "type": "integer", "format": "int32" } }, { "name": "Offset", "in": "query", "description": "The offset of the searched page (starting with 0).", "schema": { "type": "integer", "format": "int32" } }, { "name": "Order", "in": "query", "schema": { "$ref": "#/components/schemas/PaginationOrders" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedSearchResponse[Emissions.EmissionModel]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedSearchResponse[Emissions.EmissionModel]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedSearchResponse[Emissions.EmissionModel]" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/batches/{id}/registrations": { "get": { "tags": [ "Batches" ], "summary": "Obtém todas requisições de registro cadastradas no lote paginando a resposta", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Q", "in": "query", "description": "Query to filter items.", "schema": { "type": "string" } }, { "name": "Limit", "in": "query", "description": "Number of items to return.", "schema": { "type": "integer", "format": "int32" } }, { "name": "Offset", "in": "query", "description": "The offset of the searched page (starting with 0).", "schema": { "type": "integer", "format": "int32" } }, { "name": "Order", "in": "query", "schema": { "$ref": "#/components/schemas/PaginationOrders" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedSearchResponse[Registrations.RegistrationModel]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedSearchResponse[Registrations.RegistrationModel]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedSearchResponse[Registrations.RegistrationModel]" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/batches/{id}/academic-transcripts": { "get": { "tags": [ "Batches" ], "summary": "Obtém todos históricos escolares cadastrados no lote paginando a resposta", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Q", "in": "query", "description": "Query to filter items.", "schema": { "type": "string" } }, { "name": "Limit", "in": "query", "description": "Number of items to return.", "schema": { "type": "integer", "format": "int32" } }, { "name": "Offset", "in": "query", "description": "The offset of the searched page (starting with 0).", "schema": { "type": "integer", "format": "int32" } }, { "name": "Order", "in": "query", "schema": { "$ref": "#/components/schemas/PaginationOrders" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedSearchResponse`1[[AcademicTranscripts.AcademicTranscriptModel, Lacuna.Digiploma.Api, Version=3.1.0.0, Culture=neutral, PublicKeyToken=3835d68b69925328]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedSearchResponse`1[[AcademicTranscripts.AcademicTranscriptModel, Lacuna.Digiploma.Api, Version=3.1.0.0, Culture=neutral, PublicKeyToken=3835d68b69925328]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedSearchResponse`1[[AcademicTranscripts.AcademicTranscriptModel, Lacuna.Digiploma.Api, Version=3.1.0.0, Culture=neutral, PublicKeyToken=3835d68b69925328]]" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/batches/{id}/curriculums": { "get": { "tags": [ "Batches" ], "summary": "Obtém todos currículos escolares cadastrados no lote paginando a resposta", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Q", "in": "query", "description": "Query to filter items.", "schema": { "type": "string" } }, { "name": "Limit", "in": "query", "description": "Number of items to return.", "schema": { "type": "integer", "format": "int32" } }, { "name": "Offset", "in": "query", "description": "The offset of the searched page (starting with 0).", "schema": { "type": "integer", "format": "int32" } }, { "name": "Order", "in": "query", "schema": { "$ref": "#/components/schemas/PaginationOrders" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedSearchResponse`1[[Curriculums.CurriculumModel, Lacuna.Digiploma.Api, Version=3.1.0.0, Culture=neutral, PublicKeyToken=3835d68b69925328]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedSearchResponse`1[[Curriculums.CurriculumModel, Lacuna.Digiploma.Api, Version=3.1.0.0, Culture=neutral, PublicKeyToken=3835d68b69925328]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedSearchResponse`1[[Curriculums.CurriculumModel, Lacuna.Digiploma.Api, Version=3.1.0.0, Culture=neutral, PublicKeyToken=3835d68b69925328]]" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/batches/degrees-file": { "post": { "tags": [ "Batches" ], "summary": "Valida o arquivo (JSON ou CSV) de criação de lote de diplomas", "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Batches.ValidateBatchFileRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Batches.ValidateBatchFileRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Batches.ValidateBatchFileRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Batches.ValidateBatchFileRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidateDegreesFileResponse[Degrees.DegreeFullInformationModel]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidateDegreesFileResponse[Degrees.DegreeFullInformationModel]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidateDegreesFileResponse[Degrees.DegreeFullInformationModel]" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/batches/emissions-file": { "post": { "tags": [ "Batches" ], "summary": "Valida o arquivo de criação de lote de emissões", "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Batches.ValidateBatchFileRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Batches.ValidateBatchFileRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Batches.ValidateBatchFileRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Batches.ValidateBatchFileRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidateDegreesFileResponse[Degrees.DegreeEmissionRequestModel]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidateDegreesFileResponse[Degrees.DegreeEmissionRequestModel]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidateDegreesFileResponse[Degrees.DegreeEmissionRequestModel]" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/batches/academic-transcripts-file": { "post": { "tags": [ "Batches" ], "summary": "Valida o arquivo de criação de lote de históricos escolares", "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Batches.ValidateBatchFileRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Batches.ValidateBatchFileRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Batches.ValidateBatchFileRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Batches.ValidateBatchFileRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Batches.ValidateDegreesFileResponse`1[[AcademicTranscripts.AcademicTranscriptInformationModel, Lacuna.Digiploma.Api, Version=3.1.0.0, Culture=neutral, PublicKeyToken=3835d68b69925328]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Batches.ValidateDegreesFileResponse`1[[AcademicTranscripts.AcademicTranscriptInformationModel, Lacuna.Digiploma.Api, Version=3.1.0.0, Culture=neutral, PublicKeyToken=3835d68b69925328]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Batches.ValidateDegreesFileResponse`1[[AcademicTranscripts.AcademicTranscriptInformationModel, Lacuna.Digiploma.Api, Version=3.1.0.0, Culture=neutral, PublicKeyToken=3835d68b69925328]]" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/batches/curriculums-file": { "post": { "tags": [ "Batches" ], "summary": "Valida o arquivo de criação de lote de currículos escolares", "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Batches.ValidateBatchFileRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Batches.ValidateBatchFileRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Batches.ValidateBatchFileRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Batches.ValidateBatchFileRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Batches.ValidateDegreesFileResponse`1[[Curriculums.CurriculumInformationModel, Lacuna.Digiploma.Api, Version=3.1.0.0, Culture=neutral, PublicKeyToken=3835d68b69925328]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Batches.ValidateDegreesFileResponse`1[[Curriculums.CurriculumInformationModel, Lacuna.Digiploma.Api, Version=3.1.0.0, Culture=neutral, PublicKeyToken=3835d68b69925328]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Batches.ValidateDegreesFileResponse`1[[Curriculums.CurriculumInformationModel, Lacuna.Digiploma.Api, Version=3.1.0.0, Culture=neutral, PublicKeyToken=3835d68b69925328]]" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/cancellation-lists/ies-codes/{iesCode}": { "get": { "tags": [ "CancellationLists" ], "summary": "Obtém todas as listas de diplomas anulados geradas filtrando pelo código MEC da IES paginando a resposta", "parameters": [ { "name": "iesCode", "in": "path", "description": "", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Q", "in": "query", "description": "Query to filter items.", "schema": { "type": "string" } }, { "name": "Limit", "in": "query", "description": "Number of items to return.", "schema": { "type": "integer", "format": "int32" } }, { "name": "Offset", "in": "query", "description": "The offset of the searched page (starting with 0).", "schema": { "type": "integer", "format": "int32" } }, { "name": "Order", "in": "query", "schema": { "$ref": "#/components/schemas/PaginationOrders" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedSearchResponse`1[[CancellationList.CancellationListModel, Lacuna.Digiploma.Api, Version=3.1.0.0, Culture=neutral, PublicKeyToken=3835d68b69925328]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedSearchResponse`1[[CancellationList.CancellationListModel, Lacuna.Digiploma.Api, Version=3.1.0.0, Culture=neutral, PublicKeyToken=3835d68b69925328]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedSearchResponse`1[[CancellationList.CancellationListModel, Lacuna.Digiploma.Api, Version=3.1.0.0, Culture=neutral, PublicKeyToken=3835d68b69925328]]" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/cancellation-lists/institute/{instituteId}": { "get": { "tags": [ "CancellationLists" ], "summary": "Obtém as listas de diplomas anulados gerados da instituição paginando a resposta", "parameters": [ { "name": "instituteId", "in": "path", "description": "", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Q", "in": "query", "description": "Query to filter items.", "schema": { "type": "string" } }, { "name": "Limit", "in": "query", "description": "Number of items to return.", "schema": { "type": "integer", "format": "int32" } }, { "name": "Offset", "in": "query", "description": "The offset of the searched page (starting with 0).", "schema": { "type": "integer", "format": "int32" } }, { "name": "Order", "in": "query", "schema": { "$ref": "#/components/schemas/PaginationOrders" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedSearchResponse`1[[CancellationList.CancellationListModel, Lacuna.Digiploma.Api, Version=3.1.0.0, Culture=neutral, PublicKeyToken=3835d68b69925328]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedSearchResponse`1[[CancellationList.CancellationListModel, Lacuna.Digiploma.Api, Version=3.1.0.0, Culture=neutral, PublicKeyToken=3835d68b69925328]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedSearchResponse`1[[CancellationList.CancellationListModel, Lacuna.Digiploma.Api, Version=3.1.0.0, Culture=neutral, PublicKeyToken=3835d68b69925328]]" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/cancellation-lists/institute/{instituteId}/latest": { "get": { "tags": [ "CancellationLists" ], "summary": "Obtém informações da lista de diplomas anulados mais recente de uma instituição", "parameters": [ { "name": "instituteId", "in": "path", "description": "", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CancellationList.CancellationListModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CancellationList.CancellationListModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CancellationList.CancellationListModel" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/cancellation-lists/institute/{instituteId}/latest/xml": { "get": { "tags": [ "CancellationLists" ], "summary": "Obtém o XML assinado da lista de diplomas anulados mais recente de uma instituição", "parameters": [ { "name": "instituteId", "in": "path", "description": "", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/cancellation-lists/institute/{instituteId}/latest/xml-b64": { "get": { "tags": [ "CancellationLists" ], "summary": "Obtém o XML assinado da lista de diplomas anulados mais recente de uma instituição codificado no formato Base64", "parameters": [ { "name": "instituteId", "in": "path", "description": "", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Documents.DocumentContentModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Documents.DocumentContentModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Documents.DocumentContentModel" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/cancellation-lists/{id}/xml-ticket": { "get": { "tags": [ "CancellationLists" ], "summary": "Obtém um ticket (URL) para download da lista de diplomas anulados em xml", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/TicketFileModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TicketFileModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TicketFileModel" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/cancellation-lists/{id}": { "get": { "tags": [ "CancellationLists" ], "summary": "Obtém informações de uma lista de diplomas anulados", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CancellationList.CancellationListModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CancellationList.CancellationListModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CancellationList.CancellationListModel" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/cancellation-lists/{id}/xml": { "get": { "tags": [ "CancellationLists" ], "summary": "Obtém o XML assinado da lista de diplomas anulados", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/cancellation-lists/{id}/xml-b64": { "get": { "tags": [ "CancellationLists" ], "summary": "Obtém o XML assinado da lista de diplomas anulados codificado no formato Base64", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Documents.DocumentContentModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Documents.DocumentContentModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Documents.DocumentContentModel" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/curriculums": { "post": { "tags": [ "Curriculums" ], "summary": "Cria um currículo digital", "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Curriculums.CurriculumCreateRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Curriculums.CurriculumCreateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Curriculums.CurriculumCreateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Curriculums.CurriculumCreateRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Curriculums.CurriculumCreateResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Curriculums.CurriculumCreateResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Curriculums.CurriculumCreateResponse" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } }, "get": { "tags": [ "Curriculums" ], "summary": "Obtém todos currículos escolares cadastrados paginando a resposta", "parameters": [ { "name": "BatchId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "StartDateUtc", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "EndDateUtc", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "Status", "in": "query", "schema": { "$ref": "#/components/schemas/CurriculumStatus" } }, { "name": "Q", "in": "query", "description": "Query to filter items.", "schema": { "type": "string" } }, { "name": "Limit", "in": "query", "description": "Number of items to return.", "schema": { "type": "integer", "format": "int32" } }, { "name": "Offset", "in": "query", "description": "The offset of the searched page (starting with 0).", "schema": { "type": "integer", "format": "int32" } }, { "name": "Order", "in": "query", "schema": { "$ref": "#/components/schemas/PaginationOrders" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedSearchResponse`1[[Curriculums.CurriculumModel, Lacuna.Digiploma.Api, Version=3.1.0.0, Culture=neutral, PublicKeyToken=3835d68b69925328]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedSearchResponse`1[[Curriculums.CurriculumModel, Lacuna.Digiploma.Api, Version=3.1.0.0, Culture=neutral, PublicKeyToken=3835d68b69925328]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedSearchResponse`1[[Curriculums.CurriculumModel, Lacuna.Digiploma.Api, Version=3.1.0.0, Culture=neutral, PublicKeyToken=3835d68b69925328]]" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/curriculums/{id}": { "get": { "tags": [ "Curriculums" ], "summary": "Obtém informações de um currículo escolar", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Curriculums.CurriculumModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Curriculums.CurriculumModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Curriculums.CurriculumModel" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/curriculums/{id}/history": { "get": { "tags": [ "Curriculums" ], "summary": "Obtém currículo de atualizações do currículo escolar", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Curriculums.CurriculumStatusUpdateModel" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Curriculums.CurriculumStatusUpdateModel" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Curriculums.CurriculumStatusUpdateModel" } } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/curriculums/{id}/xml-ticket": { "get": { "tags": [ "Curriculums" ], "summary": "Obtém um ticket (URL) para download do currículo escolar em xml", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/TicketFileModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TicketFileModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TicketFileModel" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/curriculums/{id}/xml": { "get": { "tags": [ "Curriculums" ], "summary": "Obtém o XML assinado do currículo escolar caso esteja válido", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/curriculums/{id}/xml-b64": { "get": { "tags": [ "Curriculums" ], "summary": "Obtém o XML assinado do currículo escolar codificado no formato Base64", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Documents.DocumentContentModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Documents.DocumentContentModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Documents.DocumentContentModel" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/curriculums/codes/{code}": { "get": { "tags": [ "Curriculums" ], "summary": "Valida um currículo escolar pelo seu código de validação", "description": "Requer autenticação", "parameters": [ { "name": "code", "in": "path", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Curriculums.CurriculumValidationModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Curriculums.CurriculumValidationModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Curriculums.CurriculumValidationModel" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/curriculums/{code}/validation": { "get": { "tags": [ "Curriculums" ], "summary": "Valida um currículo escolar pelo seu código de validação", "parameters": [ { "name": "code", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "captcha", "in": "query", "description": "Token CAPTCHA caso habilitado", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Curriculums.CurriculumValidationModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Curriculums.CurriculumValidationModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Curriculums.CurriculumValidationModel" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/curriculums/{code}/validation/visual-representation": { "get": { "tags": [ "Curriculums" ], "summary": "Obtém a representação visual de um currículo escolar caso esteja válido", "description": "Utilizar essa operação somente se o CAPTCHA estiver desabilitado", "parameters": [ { "name": "code", "in": "path", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/curriculums/{code}/validation/xml": { "get": { "tags": [ "Curriculums" ], "summary": "Obtém o XML de dados públicos de um currículo escolar caso esteja válido", "description": "Utilizar essa operação somente se o CAPTCHA estiver desabilitado", "parameters": [ { "name": "code", "in": "path", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/curriculums/{id}/visual-representation-ticket": { "get": { "tags": [ "Curriculums" ], "summary": "Obtém um ticket (URL) para download da representação visual do currículo escolar", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/TicketFileModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TicketFileModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TicketFileModel" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/curriculums/{id}/visual-representation-b64": { "get": { "tags": [ "Curriculums" ], "summary": "Obtém a representação visual do currículo escolar codificado no formato Base64", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Documents.DocumentContentModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Documents.DocumentContentModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Documents.DocumentContentModel" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/curriculums/{id}/cancellation": { "post": { "tags": [ "Curriculums" ], "summary": "Cancela um currículo escolar", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/DocumentCancellationRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DocumentCancellationRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DocumentCancellationRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DocumentCancellationRequest" } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/curriculums/{id}/visual-representation": { "post": { "tags": [ "Curriculums" ], "summary": "Altera a representação visual do currículo escolar", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Documents.UpdateDocumentVisualRepresentationRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Documents.UpdateDocumentVisualRepresentationRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Documents.UpdateDocumentVisualRepresentationRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Documents.UpdateDocumentVisualRepresentationRequest" } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/degrees": { "post": { "tags": [ "Degrees" ], "summary": "Cria um diploma", "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Degrees.DegreeCreateRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Degrees.DegreeCreateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Degrees.DegreeCreateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Degrees.DegreeCreateRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Degrees.DegreeCreateResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Degrees.DegreeCreateResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Degrees.DegreeCreateResponse" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } }, "get": { "tags": [ "Degrees" ], "summary": "Obtém todos diplomas cadastrados paginando a resposta", "parameters": [ { "name": "Status", "in": "query", "schema": { "$ref": "#/components/schemas/DegreeStatus" } }, { "name": "BatchId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "StartDateUtc", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "EndDateUtc", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "IsSigned", "in": "query", "description": "Filtra os documentos assinados independente do status ser ativo ou cancelado", "schema": { "type": "boolean" } }, { "name": "Q", "in": "query", "description": "Query to filter items.", "schema": { "type": "string" } }, { "name": "Limit", "in": "query", "description": "Number of items to return.", "schema": { "type": "integer", "format": "int32" } }, { "name": "Offset", "in": "query", "description": "The offset of the searched page (starting with 0).", "schema": { "type": "integer", "format": "int32" } }, { "name": "Order", "in": "query", "schema": { "$ref": "#/components/schemas/PaginationOrders" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedSearchResponse[Degrees.DegreeModel]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedSearchResponse[Degrees.DegreeModel]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedSearchResponse[Degrees.DegreeModel]" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/degrees/{id}/academic-transcript": { "post": { "tags": [ "Degrees" ], "summary": "Gera um histórico escolar a partir de um diploma já concluídoo", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Degrees.DocumentCreateBaseRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Degrees.DocumentCreateBaseRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Degrees.DocumentCreateBaseRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Degrees.DocumentCreateBaseRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AcademicTranscripts.AcademicTranscriptModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AcademicTranscripts.AcademicTranscriptModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AcademicTranscripts.AcademicTranscriptModel" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/degrees/{id}": { "get": { "tags": [ "Degrees" ], "summary": "Obtém informações de um diploma", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Degrees.DegreeModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Degrees.DegreeModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Degrees.DegreeModel" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/degrees/{id}/information": { "get": { "tags": [ "Degrees" ], "summary": "Obtém informações detalhadas de um diploma", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Degrees.DegreeInformation" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Degrees.DegreeInformation" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Degrees.DegreeInformation" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/degrees/{id}/academic-documentation": { "get": { "tags": [ "Degrees" ], "summary": "Obtém os dados da documentação acadêmica", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Degrees.AcademicDocumentationInformation" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Degrees.AcademicDocumentationInformation" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Degrees.AcademicDocumentationInformation" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/degrees/{id}/academic-documentation-xml": { "get": { "tags": [ "Degrees" ], "summary": "Obtém o XML assinado da documentação acadêmica", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/degrees/{id}/xml": { "get": { "tags": [ "Degrees" ], "summary": "Obtém o XML assinado dos dados públicos de um diploma caso esteja válido", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/degrees/{id}/academic-documentation-xml-b64": { "get": { "tags": [ "Degrees" ], "summary": "Obtém o XML assinado da documentação acadêmica codificado no formato Base64", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Documents.DocumentContentModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Documents.DocumentContentModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Documents.DocumentContentModel" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/degrees/{id}/xml-b64": { "get": { "tags": [ "Degrees" ], "summary": "Obtém o XML assinado do diploma codificado no formato Base64", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Documents.DocumentContentModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Documents.DocumentContentModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Documents.DocumentContentModel" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/degrees/{id}/visual-representation-ticket": { "get": { "tags": [ "Degrees" ], "summary": "Obtém um ticket (URL) para download da representação visual do diploma", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/TicketFileModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TicketFileModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TicketFileModel" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/degrees/{id}/visual-representation-b64": { "get": { "tags": [ "Degrees" ], "summary": "Obtém a representação visual do diploma codificado no formato Base64", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Documents.DocumentContentModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Documents.DocumentContentModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Documents.DocumentContentModel" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/degrees/{id}/letterhead-visual-representation-ticket": { "get": { "tags": [ "Degrees" ], "summary": "Obtém um ticket (URL) para download da representação visual do modelo timbrado do diploma", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/TicketFileModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TicketFileModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TicketFileModel" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/degrees/{id}/xml-ticket": { "get": { "tags": [ "Degrees" ], "summary": "Obtém um ticket (URL) para download do diploma em xml", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/TicketFileModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TicketFileModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TicketFileModel" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/degrees/{id}/academic-documentation-ticket": { "get": { "tags": [ "Degrees" ], "summary": "Obtém um ticket (URL) para download da documentação acadêmica em xml", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/TicketFileModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TicketFileModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TicketFileModel" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/degrees/{id}/history": { "get": { "tags": [ "Degrees" ], "summary": "Obtém histórico de atualizações do diploma", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Degrees.StatusUpdateModel" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Degrees.StatusUpdateModel" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Degrees.StatusUpdateModel" } } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/degrees/{id}/status": { "post": { "tags": [ "Degrees" ], "summary": "Atualiza o status do diploma", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Degrees.DegreeUpdateStatusRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Degrees.DegreeUpdateStatusRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Degrees.DegreeUpdateStatusRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Degrees.DegreeUpdateStatusRequest" } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/degrees/codes/{code}": { "get": { "tags": [ "Degrees" ], "summary": "Valida um diploma pelo seu código de validação", "description": "Requer autenticação", "parameters": [ { "name": "code", "in": "path", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Degrees.DegreeValidationModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Degrees.DegreeValidationModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Degrees.DegreeValidationModel" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/degrees/{code}/validation": { "get": { "tags": [ "Degrees" ], "summary": "Valida um diploma pelo seu código de validação", "parameters": [ { "name": "code", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "captcha", "in": "query", "description": "Token CAPTCHA caso habilitado", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Degrees.DegreeValidationModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Degrees.DegreeValidationModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Degrees.DegreeValidationModel" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/degrees/{code}/validation/visual-representation": { "get": { "tags": [ "Degrees" ], "summary": "Obtém a representação visual de um diploma caso esteja válido", "description": "Utilizar essa operação somente se o CAPTCHA estiver desabilitado", "parameters": [ { "name": "code", "in": "path", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/degrees/{code}/validation/xml": { "get": { "tags": [ "Degrees" ], "summary": "Obtém o XML de dados públicos de um diploma caso esteja válido", "description": "Utilizar essa operação somente se o CAPTCHA estiver desabilitado", "parameters": [ { "name": "code", "in": "path", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/v2/degrees": { "get": { "tags": [ "Degrees" ], "summary": "Obtém todos diplomas cadastrados paginando a resposta. Versão otimizada para retornar grande volume de diplomas", "parameters": [ { "name": "Status", "in": "query", "schema": { "$ref": "#/components/schemas/DegreeStatus" } }, { "name": "BatchId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "StartDateUtc", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "EndDateUtc", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "IsSigned", "in": "query", "description": "Filtra os documentos assinados independente do status ser ativo ou cancelado", "schema": { "type": "boolean" } }, { "name": "Q", "in": "query", "description": "Query to filter items.", "schema": { "type": "string" } }, { "name": "Limit", "in": "query", "description": "Number of items to return.", "schema": { "type": "integer", "format": "int32" } }, { "name": "Offset", "in": "query", "description": "The offset of the searched page (starting with 0).", "schema": { "type": "integer", "format": "int32" } }, { "name": "Order", "in": "query", "schema": { "$ref": "#/components/schemas/PaginationOrders" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedSearchResponse`1[[Degrees.DegreeListModel, Lacuna.Digiploma.Api, Version=3.1.0.0, Culture=neutral, PublicKeyToken=3835d68b69925328]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedSearchResponse`1[[Degrees.DegreeListModel, Lacuna.Digiploma.Api, Version=3.1.0.0, Culture=neutral, PublicKeyToken=3835d68b69925328]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedSearchResponse`1[[Degrees.DegreeListModel, Lacuna.Digiploma.Api, Version=3.1.0.0, Culture=neutral, PublicKeyToken=3835d68b69925328]]" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/degrees/{id}/visual-representation": { "post": { "tags": [ "Degrees" ], "summary": "Altera a representação visual do diploma", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Documents.UpdateDocumentVisualRepresentationRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Documents.UpdateDocumentVisualRepresentationRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Documents.UpdateDocumentVisualRepresentationRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Documents.UpdateDocumentVisualRepresentationRequest" } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/emissions": { "post": { "tags": [ "Emissions" ], "summary": "Cria uma emissão", "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Emissions.EmissionCreateRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Emissions.EmissionCreateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Emissions.EmissionCreateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Emissions.EmissionCreateRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Emissions.EmissionCreateResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Emissions.EmissionCreateResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Emissions.EmissionCreateResponse" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } }, "get": { "tags": [ "Emissions" ], "summary": "Obtém todas emissões cadastradas paginando a resposta", "parameters": [ { "name": "Status", "in": "query", "schema": { "$ref": "#/components/schemas/EmissionStatus" } }, { "name": "BatchId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "StartDateUtc", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "EndDateUtc", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "IsSigned", "in": "query", "description": "Filtra os documentos assinados independente do status ser ativo ou cancelado", "schema": { "type": "boolean" } }, { "name": "Q", "in": "query", "description": "Query to filter items.", "schema": { "type": "string" } }, { "name": "Limit", "in": "query", "description": "Number of items to return.", "schema": { "type": "integer", "format": "int32" } }, { "name": "Offset", "in": "query", "description": "The offset of the searched page (starting with 0).", "schema": { "type": "integer", "format": "int32" } }, { "name": "Order", "in": "query", "schema": { "$ref": "#/components/schemas/PaginationOrders" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedSearchResponse[Emissions.EmissionModel]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedSearchResponse[Emissions.EmissionModel]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedSearchResponse[Emissions.EmissionModel]" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/emissions/{id}": { "get": { "tags": [ "Emissions" ], "summary": "Obtém informações de uma emissão", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Emissions.EmissionInfoModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Emissions.EmissionInfoModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Emissions.EmissionInfoModel" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/emissions/{id}/information": { "get": { "tags": [ "Emissions" ], "summary": "Obtém informações detalhadas de uma emissão", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Degrees.DadosDiploma" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Degrees.DadosDiploma" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Degrees.DadosDiploma" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/emissions/{id}/academic-documentation-ticket": { "get": { "tags": [ "Emissions" ], "summary": "Obtém um ticket (URL) para download da documentação acadêmica em xml", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/TicketFileModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TicketFileModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TicketFileModel" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/emissions/{id}/history": { "get": { "tags": [ "Emissions" ], "summary": "Obtém histórico de atualizações da emissão", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Emissions.EmissionStatusUpdateModel" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Emissions.EmissionStatusUpdateModel" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Emissions.EmissionStatusUpdateModel" } } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/emissions/{id}/degree-xml": { "post": { "tags": [ "Emissions" ], "summary": "Conclui a emissão enviando o XML de dados públicos", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Emissions.UploadDegreeXmlRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Emissions.UploadDegreeXmlRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Emissions.UploadDegreeXmlRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Emissions.UploadDegreeXmlRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Emissions.UploadDegreeXmlResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Emissions.UploadDegreeXmlResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Emissions.UploadDegreeXmlResponse" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/emissions/{id}/cancellation": { "post": { "tags": [ "Emissions" ], "summary": "Cancela uma emissão", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/DocumentCancellationRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DocumentCancellationRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DocumentCancellationRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DocumentCancellationRequest" } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/flows/{id}": { "get": { "tags": [ "Flows" ], "summary": "Obtém informações de um fluxo de assinatura", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DocumentFlows.DocumentFlowDataModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DocumentFlows.DocumentFlowDataModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DocumentFlows.DocumentFlowDataModel" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } }, "put": { "tags": [ "Flows" ], "summary": "Atualiza um fluxo de assinatura", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/DocumentFlows.DocumentFlowRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DocumentFlows.DocumentFlowRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DocumentFlows.DocumentFlowRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DocumentFlows.DocumentFlowRequest" } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } }, "delete": { "tags": [ "Flows" ], "summary": "Exclui um fluxo de assinatura", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/flows": { "get": { "tags": [ "Flows" ], "summary": "Obtém todos os fluxos cadastrados paginando a resposta", "parameters": [ { "name": "Q", "in": "query", "description": "Query to filter items.", "schema": { "type": "string" } }, { "name": "Limit", "in": "query", "description": "Number of items to return.", "schema": { "type": "integer", "format": "int32" } }, { "name": "Offset", "in": "query", "description": "The offset of the searched page (starting with 0).", "schema": { "type": "integer", "format": "int32" } }, { "name": "Order", "in": "query", "schema": { "$ref": "#/components/schemas/PaginationOrders" } }, { "name": "type", "in": "query", "schema": { "$ref": "#/components/schemas/DocumentFlowTypes" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedSearchResponse[DocumentFlows.DocumentFlowModel]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedSearchResponse[DocumentFlows.DocumentFlowModel]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedSearchResponse[DocumentFlows.DocumentFlowModel]" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } }, "post": { "tags": [ "Flows" ], "summary": "Cria um fluxo de assinatura", "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/DocumentFlows.DocumentFlowRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DocumentFlows.DocumentFlowRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DocumentFlows.DocumentFlowRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DocumentFlows.DocumentFlowRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DocumentFlows.DocumentFlowModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DocumentFlows.DocumentFlowModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DocumentFlows.DocumentFlowModel" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/flows/validate": { "post": { "tags": [ "Flows" ], "summary": "Valida um fluxo de assinatura", "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/DocumentFlows.DocumentFlowValidateRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DocumentFlows.DocumentFlowValidateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DocumentFlows.DocumentFlowValidateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DocumentFlows.DocumentFlowValidateRequest" } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/inspection-files": { "post": { "tags": [ "InspectionFiles" ], "summary": "Cria um arquivo de fiscalização", "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/InspectionFiles.InspectionFileCreateRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/InspectionFiles.InspectionFileCreateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/InspectionFiles.InspectionFileCreateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/InspectionFiles.InspectionFileCreateRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/InspectionFiles.InspectionFileModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/InspectionFiles.InspectionFileModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/InspectionFiles.InspectionFileModel" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } }, "get": { "tags": [ "InspectionFiles" ], "summary": "Obtém todas as listas de diplomas anulados geradas filtrando pelo código MEC da IES ou Id da instituição paginando a resposta", "parameters": [ { "name": "InstituteId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "IesCode", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Q", "in": "query", "description": "Query to filter items.", "schema": { "type": "string" } }, { "name": "Limit", "in": "query", "description": "Number of items to return.", "schema": { "type": "integer", "format": "int32" } }, { "name": "Offset", "in": "query", "description": "The offset of the searched page (starting with 0).", "schema": { "type": "integer", "format": "int32" } }, { "name": "Order", "in": "query", "schema": { "$ref": "#/components/schemas/PaginationOrders" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedSearchResponse`1[[InspectionFiles.InspectionFileModel, Lacuna.Digiploma.Api, Version=3.1.0.0, Culture=neutral, PublicKeyToken=3835d68b69925328]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedSearchResponse`1[[InspectionFiles.InspectionFileModel, Lacuna.Digiploma.Api, Version=3.1.0.0, Culture=neutral, PublicKeyToken=3835d68b69925328]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedSearchResponse`1[[InspectionFiles.InspectionFileModel, Lacuna.Digiploma.Api, Version=3.1.0.0, Culture=neutral, PublicKeyToken=3835d68b69925328]]" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/inspection-files/{id}": { "get": { "tags": [ "InspectionFiles" ], "summary": "Obtém informações de um arquivo de fiscalização", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/InspectionFiles.InspectionFileModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/InspectionFiles.InspectionFileModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/InspectionFiles.InspectionFileModel" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/inspection-files/{id}/xml-ticket": { "get": { "tags": [ "InspectionFiles" ], "summary": "Obtém um ticket (URL) para download do arquivo de fiscalização em xml", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/TicketFileModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TicketFileModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TicketFileModel" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/institutes": { "post": { "tags": [ "Institutes" ], "summary": "Cria uma instituição de ensino", "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Institutes.InstituteCreateRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Institutes.InstituteCreateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Institutes.InstituteCreateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Institutes.InstituteCreateRequest" } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } }, "get": { "tags": [ "Institutes" ], "summary": "Obtém todas as instituições cadastradas na organização paginando a resposta", "parameters": [ { "name": "Q", "in": "query", "description": "Query to filter items.", "schema": { "type": "string" } }, { "name": "Limit", "in": "query", "description": "Number of items to return.", "schema": { "type": "integer", "format": "int32" } }, { "name": "Offset", "in": "query", "description": "The offset of the searched page (starting with 0).", "schema": { "type": "integer", "format": "int32" } }, { "name": "Order", "in": "query", "schema": { "$ref": "#/components/schemas/PaginationOrders" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedSearchResponse`1[[Institutes.InstituteListModel, Lacuna.Digiploma.Api, Version=3.1.0.0, Culture=neutral, PublicKeyToken=3835d68b69925328]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedSearchResponse`1[[Institutes.InstituteListModel, Lacuna.Digiploma.Api, Version=3.1.0.0, Culture=neutral, PublicKeyToken=3835d68b69925328]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedSearchResponse`1[[Institutes.InstituteListModel, Lacuna.Digiploma.Api, Version=3.1.0.0, Culture=neutral, PublicKeyToken=3835d68b69925328]]" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/institutes/{id}": { "put": { "tags": [ "Institutes" ], "summary": "Edita uma instituição de ensino", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Institutes.InstituteUpdateModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Institutes.InstituteUpdateModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Institutes.InstituteUpdateModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Institutes.InstituteUpdateModel" } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } }, "get": { "tags": [ "Institutes" ], "summary": "Obtém informações de uma instituição", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Institutes.InstituteModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Institutes.InstituteModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Institutes.InstituteModel" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/institutes/{id}/integrations": { "post": { "tags": [ "Institutes" ], "summary": "Atualiza a configuração de webhook da instituição", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Institutes.InstituteIntegrationsModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Institutes.InstituteIntegrationsModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Institutes.InstituteIntegrationsModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Institutes.InstituteIntegrationsModel" } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/institutes/{id}/events": { "get": { "tags": [ "Institutes" ], "summary": "Obtém eventos da instituição", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Institutes.InstituteEventModel" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Institutes.InstituteEventModel" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Institutes.InstituteEventModel" } } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/registrations/{id}": { "get": { "tags": [ "Registrations" ], "summary": "Obtém as informações de uma requisição de registro", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Registrations.RegistrationModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Registrations.RegistrationModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Registrations.RegistrationModel" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/registrations/{id}/info": { "get": { "tags": [ "Registrations" ], "summary": "Obtém as informações de uma requisição de registro para fins de revisão", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Registrations.RegistrationInfoModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Registrations.RegistrationInfoModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Registrations.RegistrationInfoModel" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/registrations/{id}/xml-ticket": { "get": { "tags": [ "Registrations" ], "summary": "Obtém um ticket (URL) para download do diploma em XML", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/TicketFileModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TicketFileModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TicketFileModel" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/registrations/{id}/academic-documentation-ticket": { "get": { "tags": [ "Registrations" ], "summary": "Obtém um ticket (URL) para download da documentação acadêmica em xml", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/TicketFileModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TicketFileModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TicketFileModel" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/registrations": { "get": { "tags": [ "Registrations" ], "summary": "Obtém todas requisições de registro cadastradas paginando a resposta", "parameters": [ { "name": "Status", "in": "query", "schema": { "$ref": "#/components/schemas/RegistrationStatus" } }, { "name": "BatchId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "StartDateUtc", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "EndDateUtc", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "IsSigned", "in": "query", "description": "Filtra os documentos assinados independente do status ser ativo ou cancelado", "schema": { "type": "boolean" } }, { "name": "Q", "in": "query", "description": "Query to filter items.", "schema": { "type": "string" } }, { "name": "Limit", "in": "query", "description": "Number of items to return.", "schema": { "type": "integer", "format": "int32" } }, { "name": "Offset", "in": "query", "description": "The offset of the searched page (starting with 0).", "schema": { "type": "integer", "format": "int32" } }, { "name": "Order", "in": "query", "schema": { "$ref": "#/components/schemas/PaginationOrders" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedSearchResponse[Registrations.RegistrationModel]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedSearchResponse[Registrations.RegistrationModel]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedSearchResponse[Registrations.RegistrationModel]" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/registrations/{id}/history": { "get": { "tags": [ "Registrations" ], "summary": "Obtém histórico de atualizações da requisição de registro", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Registrations.RegistrationStatusUpdateModel" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Registrations.RegistrationStatusUpdateModel" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Registrations.RegistrationStatusUpdateModel" } } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/registrations/{id}/registration-data": { "post": { "tags": [ "Registrations" ], "summary": "Envia as informações de registro da requisição de registro", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Registrations.RegistrationRegisterRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Registrations.RegistrationRegisterRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Registrations.RegistrationRegisterRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Registrations.RegistrationRegisterRequest" } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/registrations/{id}/acceptance": { "post": { "tags": [ "Registrations" ], "summary": "Aceita uma requisição de registro", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Registrations.RegistrationApprovalRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Registrations.RegistrationApprovalRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Registrations.RegistrationApprovalRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Registrations.RegistrationApprovalRequest" } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/registrations/{id}/approval": { "post": { "tags": [ "Registrations" ], "summary": "Aprova uma requisição de registro", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Registrations.RegistrationApprovalRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Registrations.RegistrationApprovalRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Registrations.RegistrationApprovalRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Registrations.RegistrationApprovalRequest" } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/registrations/{id}/rejection": { "post": { "tags": [ "Registrations" ], "summary": "Recusa uma requisição de registro", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Registrations.RegistrationUpdateRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Registrations.RegistrationUpdateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Registrations.RegistrationUpdateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Registrations.RegistrationUpdateRequest" } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/registrations/{id}/cancellation": { "post": { "tags": [ "Registrations" ], "summary": "Cancela uma requisição de registro", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Registrations.RegistrationUpdateRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Registrations.RegistrationUpdateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Registrations.RegistrationUpdateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Registrations.RegistrationUpdateRequest" } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/registrations/{id}/responsibility-term-ticket": { "get": { "tags": [ "Registrations" ], "summary": "Obtém um ticket (URL) para download do termo de responsabilidade", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/TicketModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TicketModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TicketModel" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/restamps": { "get": { "tags": [ "Restamps" ], "summary": "Obtém todas as recarimbações realizadas ou a serem realizadas paginando a resposta", "parameters": [ { "name": "DocumentTypes", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DocumentTypes" } } }, { "name": "Status", "in": "query", "schema": { "$ref": "#/components/schemas/RestampStatus" } }, { "name": "RestampFilterField", "in": "query", "schema": { "$ref": "#/components/schemas/RestampFilterFields" } }, { "name": "StartDateUtc", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "EndDateUtc", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "Q", "in": "query", "description": "Query to filter items.", "schema": { "type": "string" } }, { "name": "Limit", "in": "query", "description": "Number of items to return.", "schema": { "type": "integer", "format": "int32" } }, { "name": "Offset", "in": "query", "description": "The offset of the searched page (starting with 0).", "schema": { "type": "integer", "format": "int32" } }, { "name": "Order", "in": "query", "schema": { "$ref": "#/components/schemas/PaginationOrders" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedSearchResponse`1[[Restamps.RestampModel, Lacuna.Digiploma.Api, Version=3.1.0.0, Culture=neutral, PublicKeyToken=3835d68b69925328]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedSearchResponse`1[[Restamps.RestampModel, Lacuna.Digiploma.Api, Version=3.1.0.0, Culture=neutral, PublicKeyToken=3835d68b69925328]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedSearchResponse`1[[Restamps.RestampModel, Lacuna.Digiploma.Api, Version=3.1.0.0, Culture=neutral, PublicKeyToken=3835d68b69925328]]" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/templates/{id}": { "get": { "tags": [ "Templates" ], "summary": "Obtém informações de um modelo", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Templates.TemplateModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Templates.TemplateModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Templates.TemplateModel" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } }, "put": { "tags": [ "Templates" ], "summary": "Atualiza um modelo", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Templates.UpdateTemplateRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Templates.UpdateTemplateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Templates.UpdateTemplateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Templates.UpdateTemplateRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Templates.TemplateModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Templates.TemplateModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Templates.TemplateModel" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } }, "delete": { "tags": [ "Templates" ], "summary": "Exclui um modelo", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/templates": { "get": { "tags": [ "Templates" ], "summary": "Obtém todos os modelos cadastrados paginando a resposta", "parameters": [ { "name": "Type", "in": "query", "schema": { "$ref": "#/components/schemas/TemplateTypes" } }, { "name": "Q", "in": "query", "description": "Query to filter items.", "schema": { "type": "string" } }, { "name": "Limit", "in": "query", "description": "Number of items to return.", "schema": { "type": "integer", "format": "int32" } }, { "name": "Offset", "in": "query", "description": "The offset of the searched page (starting with 0).", "schema": { "type": "integer", "format": "int32" } }, { "name": "Order", "in": "query", "schema": { "$ref": "#/components/schemas/PaginationOrders" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaginatedSearchResponse[Templates.TemplateModel]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedSearchResponse[Templates.TemplateModel]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaginatedSearchResponse[Templates.TemplateModel]" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } }, "post": { "tags": [ "Templates" ], "summary": "Cria um modelo", "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Templates.TemplateData" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Templates.TemplateData" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Templates.TemplateData" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Templates.TemplateData" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Templates.TemplateModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Templates.TemplateModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Templates.TemplateModel" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/templates/preview-ticket": { "post": { "tags": [ "Templates" ], "summary": "Obtém ticket (URL) para baixar arquivo de prévia do modelo utilizando dados de demonstração", "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Templates.TemplatePreviewTicketRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Templates.TemplatePreviewTicketRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Templates.TemplatePreviewTicketRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Templates.TemplatePreviewTicketRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/TicketModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TicketModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TicketModel" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/uploads/bytes": { "post": { "tags": [ "Upload" ], "summary": "Envia um arquivo por meio de uma requisição JSON com os bytes em formato Base 64.", "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Uploads.UploadBytesRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Uploads.UploadBytesRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Uploads.UploadBytesRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Uploads.UploadBytesRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Uploads.UploadBytesModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Uploads.UploadBytesModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Uploads.UploadBytesModel" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } }, "/api/uploads": { "post": { "tags": [ "Upload" ], "summary": "Envia um arquivo por meio de uma requisição multipart/form-data", "description": "O id retornado por esta API deve ser utilizado como parâmetro de outras APIs.", "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "file": { "type": "file", "description": "Arquivo a ser enviado", "format": "form" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileModel" } } } }, "400": { "description": "Syntax error, for instance when a required field is not specified" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Semantic error, for instance when a given entity ID is not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModel" } } } } } } } }, "components": { "schemas": { "AcademicTranscriptStatus": { "enum": [ "Created", "Active", "Canceled", "CanceledTemporarily" ], "type": "string" }, "AcademicTranscriptTypes": { "enum": [ "Partial", "Final", "Copy" ], "type": "string" }, "AcademicTranscripts.AcademicTranscriptCancellationRequest": { "required": [ "reason" ], "type": "object", "properties": { "reason": { "maxLength": 500, "minLength": 1, "type": "string", "description": "O motivo da alteração do status.\r\nTamanho máximo de 500 caracteres" } }, "additionalProperties": false }, "AcademicTranscripts.AcademicTranscriptCreateRequest": { "required": [ "academicTranscript", "academicTranscriptTemplateId", "type" ], "type": "object", "properties": { "academicTranscript": { "$ref": "#/components/schemas/AcademicTranscripts.AcademicTranscriptInformationModel" }, "type": { "$ref": "#/components/schemas/AcademicTranscriptTypes" }, "academicTranscriptTemplateId": { "type": "string", "description": "Id do template a ser utilizado para gerar a representação visual do histórico escolar", "format": "uuid" }, "documentFlow": { "$ref": "#/components/schemas/DocumentFlows.DocumentFlowData" }, "documentFlowId": { "type": "string", "description": "Id de um fluxo de assinatura previamente cadastrado", "format": "uuid", "nullable": true }, "signerFolderId": { "type": "string", "description": "Define a pasta do Assinador, na qual serão colocados os arquivos XML do documento.", "format": "uuid", "nullable": true }, "newFolderName": { "maxLength": 200, "type": "string", "description": "Caso informado irá criar uma nova pasta no Assinador com o nome informado.", "nullable": true } }, "additionalProperties": false }, "AcademicTranscripts.AcademicTranscriptDetailsModel": { "type": "object", "properties": { "degreeId": { "type": "string", "format": "uuid", "nullable": true }, "isAcademicTranscriptSigned": { "type": "boolean", "description": "Indica se o histórico escolar foi assinado" }, "signerDocumentId": { "type": "string", "description": "Id do histórico escolar (XML) no Assinador", "format": "uuid" }, "signerDocumentUrl": { "type": "string", "description": "URL do histórico escolar (XML) no Assinador", "nullable": true }, "hasVisualRepresentation": { "type": "boolean" }, "id": { "type": "string", "description": "ID do histórico escolar", "format": "uuid" }, "studentName": { "type": "string", "description": "Nome do diplomado", "nullable": true }, "studentSocialName": { "type": "string", "description": "Nome social do diplomado", "nullable": true }, "studentCpf": { "type": "string", "description": "CPF do diplomado", "nullable": true }, "course": { "type": "string", "description": "Nome do Curso", "nullable": true }, "issuingIes": { "type": "string", "description": "Nome da IES Emissora", "nullable": true }, "creationDate": { "type": "string", "description": "Data de criação do histórico escolar", "format": "date-time" }, "updateDate": { "type": "string", "description": "Data da última atualização do histórico escolar", "format": "date-time" }, "type": { "$ref": "#/components/schemas/AcademicTranscriptTypes" }, "status": { "$ref": "#/components/schemas/AcademicTranscriptStatus" }, "version": { "$ref": "#/components/schemas/DegreeVersions" }, "verificationCode": { "type": "string", "description": "Código de validação do histórico escolar", "nullable": true } }, "additionalProperties": false }, "AcademicTranscripts.AcademicTranscriptInformationModel": { "type": "object", "properties": { "isNsf": { "type": "boolean" }, "aluno": { "$ref": "#/components/schemas/Degrees.DadosDiplomado" }, "dadosCurso": { "$ref": "#/components/schemas/Degrees.DadosMinimosCurso" }, "iesEmissora": { "$ref": "#/components/schemas/Degrees.DadosIesEmissora" }, "historicoEscolar": { "$ref": "#/components/schemas/Degrees.HistoricoEscolar" }, "informacoesAdicionais": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AcademicTranscripts.AcademicTranscriptModel": { "type": "object", "properties": { "isAcademicTranscriptSigned": { "type": "boolean", "description": "Indica se o histórico escolar foi assinado" }, "signerDocumentId": { "type": "string", "description": "Id do histórico escolar (XML) no Assinador", "format": "uuid" }, "signerDocumentUrl": { "type": "string", "description": "URL do histórico escolar (XML) no Assinador", "nullable": true }, "hasVisualRepresentation": { "type": "boolean" }, "id": { "type": "string", "description": "ID do histórico escolar", "format": "uuid" }, "studentName": { "type": "string", "description": "Nome do diplomado", "nullable": true }, "studentSocialName": { "type": "string", "description": "Nome social do diplomado", "nullable": true }, "studentCpf": { "type": "string", "description": "CPF do diplomado", "nullable": true }, "course": { "type": "string", "description": "Nome do Curso", "nullable": true }, "issuingIes": { "type": "string", "description": "Nome da IES Emissora", "nullable": true }, "creationDate": { "type": "string", "description": "Data de criação do histórico escolar", "format": "date-time" }, "updateDate": { "type": "string", "description": "Data da última atualização do histórico escolar", "format": "date-time" }, "type": { "$ref": "#/components/schemas/AcademicTranscriptTypes" }, "status": { "$ref": "#/components/schemas/AcademicTranscriptStatus" }, "version": { "$ref": "#/components/schemas/DegreeVersions" }, "verificationCode": { "type": "string", "description": "Código de validação do histórico escolar", "nullable": true } }, "additionalProperties": false }, "AcademicTranscripts.AcademicTranscriptStatusUpdateModel": { "type": "object", "properties": { "status": { "$ref": "#/components/schemas/AcademicTranscriptStatus" }, "reason": { "type": "string", "nullable": true }, "date": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "AcademicTranscripts.AcademicTranscriptUpdateStatusRequest": { "required": [ "reason" ], "type": "object", "properties": { "status": { "$ref": "#/components/schemas/AcademicTranscriptStatus" }, "reason": { "maxLength": 500, "minLength": 1, "type": "string", "description": "O motivo da alteração do status.\r\nTamanho máximo de 500 caracteres" } }, "additionalProperties": false }, "AcademicTranscripts.AcademicTranscriptValidationInformationModel": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/AcademicTranscriptTypes" }, "aluno": { "$ref": "#/components/schemas/Degrees.DadosDiplomado" }, "dadosCurso": { "$ref": "#/components/schemas/Degrees.DadosMinimosCurso" }, "iesEmissora": { "$ref": "#/components/schemas/Degrees.DadosIesEmissora" }, "ingresso": { "$ref": "#/components/schemas/Degrees.IngressoCurso" }, "dataEmissaoHistorico": { "type": "string", "format": "date-time", "nullable": true }, "horaEmissaoHistorico": { "type": "string", "nullable": true }, "situacaoAtualDiscente": { "$ref": "#/components/schemas/Degrees.SituacaoAtualDiscente" }, "informacoesAdicionais": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AcademicTranscripts.AcademicTranscriptValidationModel": { "type": "object", "properties": { "history": { "type": "array", "items": { "$ref": "#/components/schemas/AcademicTranscripts.AcademicTranscriptStatusUpdateModel" }, "nullable": true }, "information": { "$ref": "#/components/schemas/AcademicTranscripts.AcademicTranscriptValidationInformationModel" }, "isValid": { "type": "boolean" }, "isCancelled": { "type": "boolean" }, "hasVisualRepresentation": { "type": "boolean" }, "visualRepresentationTicket": { "$ref": "#/components/schemas/TicketFileModel" }, "xmlTicket": { "$ref": "#/components/schemas/TicketFileModel" }, "id": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false }, "AgentTypes": { "enum": [ "User", "Application" ], "type": "string" }, "Agents.AgentModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "$ref": "#/components/schemas/AgentTypes" }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BatchFileTypes": { "enum": [ "Json", "Csv" ], "type": "string" }, "BatchStatus": { "enum": [ "Created", "Started", "Completed", "Canceled" ], "type": "string" }, "BatchTypes": { "enum": [ "EmissionRegistration", "Emission", "Registration", "AcademicTranscript", "Curriculum" ], "type": "string" }, "Batches.BatchCreateRequest": { "required": [ "fileType" ], "type": "object", "properties": { "templateId": { "type": "string", "description": "Id do template a ser utilizado para gerar a representação visual", "format": "uuid", "nullable": true }, "academicTranscriptTemplateId": { "type": "string", "description": "Id do template a ser utilizado para gerar a representação visual do histórico escolar", "format": "uuid", "nullable": true }, "curriculumTemplateId": { "type": "string", "description": "Id do template a ser utilizado para gerar a representação visual do currículo escolar", "format": "uuid", "nullable": true }, "degreesFile": { "$ref": "#/components/schemas/UploadModel" }, "batchFile": { "$ref": "#/components/schemas/UploadModel" }, "documentFlowId": { "type": "string", "description": "Id de um fluxo de assinatura previamente cadastrado", "format": "uuid", "nullable": true }, "documentFlow": { "$ref": "#/components/schemas/DocumentFlows.DocumentFlowData" }, "signerFolderId": { "type": "string", "description": "Id da pasta no Assinador", "format": "uuid", "nullable": true }, "newFolderName": { "maxLength": 200, "type": "string", "description": "Nome da pasta a ser criada no Assinador", "nullable": true }, "fileType": { "$ref": "#/components/schemas/BatchFileTypes" }, "type": { "$ref": "#/components/schemas/BatchTypes" }, "academicTranscriptType": { "$ref": "#/components/schemas/AcademicTranscriptTypes" }, "emission": { "$ref": "#/components/schemas/Batches.EmissionData" }, "registration": { "$ref": "#/components/schemas/Batches.RegistrationCreateData" }, "degreeVersion": { "$ref": "#/components/schemas/DegreeVersions" } }, "additionalProperties": false }, "Batches.BatchCreateResponse": { "type": "object", "properties": { "id": { "type": "string", "description": "Id do lote criado", "format": "uuid" } }, "additionalProperties": false }, "Batches.BatchModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "totalDegrees": { "type": "integer", "description": "Total de diplomas do lote", "format": "int32" }, "totalDegreesCreated": { "type": "integer", "description": "Total de diplomas criados", "format": "int32" }, "totalDegreesWithError": { "type": "integer", "description": "Total de diplomas com erro", "format": "int32" }, "status": { "$ref": "#/components/schemas/BatchStatus" }, "creationDate": { "type": "string", "description": "Data de criação do lote", "format": "date-time" }, "updateDate": { "type": "string", "description": "Data de atualização do lote", "format": "date-time" }, "createdBy": { "$ref": "#/components/schemas/Agents.AgentModel" }, "type": { "$ref": "#/components/schemas/BatchTypes" } }, "additionalProperties": false }, "Batches.DocumentacaoComprobatoriaUploadModel": { "required": [ "tipo" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "nullable": true }, "name": { "type": "string", "nullable": true }, "contentType": { "type": "string", "nullable": true }, "tipo": { "$ref": "#/components/schemas/Degrees.TipoDocumentacao" }, "observacoes": { "maxLength": 255, "type": "string", "nullable": true } }, "additionalProperties": false }, "Batches.EmissionData": { "type": "object", "properties": { "registrationType": { "$ref": "#/components/schemas/RegistrationTypes" }, "registryId": { "type": "string", "format": "uuid", "nullable": true }, "files": { "type": "array", "items": { "$ref": "#/components/schemas/Batches.EmissionRequestFilesModel" }, "nullable": true } }, "additionalProperties": false }, "Batches.EmissionRequestFilesModel": { "required": [ "degreeType" ], "type": "object", "properties": { "index": { "type": "integer", "format": "int32" }, "degreeType": { "$ref": "#/components/schemas/DegreeTypes" }, "documentacaoComprobatoria": { "type": "array", "items": { "$ref": "#/components/schemas/Batches.DocumentacaoComprobatoriaUploadModel" }, "nullable": true }, "atoDesignacao": { "$ref": "#/components/schemas/UploadModel" } }, "additionalProperties": false }, "Batches.RegistrationCreateData": { "type": "object", "properties": { "skipSignatureValidation": { "type": "boolean" }, "academicDocumentationFiles": { "type": "array", "items": { "$ref": "#/components/schemas/UploadModel" }, "nullable": true } }, "additionalProperties": false }, "Batches.ValidateBatchFileRequest": { "required": [ "contentType" ], "type": "object", "properties": { "fileType": { "$ref": "#/components/schemas/BatchFileTypes" }, "academicTranscriptType": { "$ref": "#/components/schemas/AcademicTranscriptTypes" }, "degreeVersion": { "$ref": "#/components/schemas/DegreeVersions" }, "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "contentType": { "minLength": 1, "type": "string" } }, "additionalProperties": false }, "Batches.ValidateDegreesFileResponse`1[[AcademicTranscripts.AcademicTranscriptInformationModel, Lacuna.Digiploma.Api, Version=3.1.0.0, Culture=neutral, PublicKeyToken=3835d68b69925328]]": { "type": "object", "properties": { "isValid": { "type": "boolean" }, "totalErrors": { "type": "integer", "format": "int32" }, "generalError": { "$ref": "#/components/schemas/ErrorModel" }, "result": { "type": "array", "items": { "$ref": "#/components/schemas/Degrees.DegreeInformationValidation`1[[AcademicTranscripts.AcademicTranscriptInformationModel, Lacuna.Digiploma.Api, Version=3.1.0.0, Culture=neutral, PublicKeyToken=3835d68b69925328]]" }, "nullable": true } }, "additionalProperties": false }, "Batches.ValidateDegreesFileResponse`1[[Curriculums.CurriculumInformationModel, Lacuna.Digiploma.Api, Version=3.1.0.0, Culture=neutral, PublicKeyToken=3835d68b69925328]]": { "type": "object", "properties": { "isValid": { "type": "boolean" }, "totalErrors": { "type": "integer", "format": "int32" }, "generalError": { "$ref": "#/components/schemas/ErrorModel" }, "result": { "type": "array", "items": { "$ref": "#/components/schemas/Degrees.DegreeInformationValidation`1[[Curriculums.CurriculumInformationModel, Lacuna.Digiploma.Api, Version=3.1.0.0, Culture=neutral, PublicKeyToken=3835d68b69925328]]" }, "nullable": true } }, "additionalProperties": false }, "CancellationList.CancellationListModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "iesCode": { "type": "integer", "format": "int32" }, "iesName": { "type": "string", "nullable": true }, "sequenceNumber": { "type": "integer", "format": "int32" }, "status": { "$ref": "#/components/schemas/CancellationListStatus" }, "signerDocumentId": { "type": "string", "format": "uuid", "nullable": true }, "signerDocumentUrl": { "type": "string", "nullable": true }, "version": { "$ref": "#/components/schemas/DegreeVersions" }, "creationDate": { "type": "string", "format": "date-time" }, "maximumNextUpdateDate": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "CancellationListStatus": { "enum": [ "Created", "Signed" ], "type": "string" }, "CurriculumStatus": { "enum": [ "Created", "Active", "Canceled" ], "type": "string" }, "Curriculums.AtividadeComplementarCurriculo": { "type": "object", "properties": { "codigo": { "type": "string", "description": "Obrigatório.\r\nEspecifica um código que identifica unicamente a Atividade dentro do currículo. \r\nSerá usado para associar os elementos históricos do tipo Atividade Complementar com a Atividade Complementar do Currículo.", "nullable": true }, "nome": { "type": "string", "description": "Obrigatório.\r\nEspecifica um Nome descritivo para a Atividade Complementar, a ser usada no RVCE.", "nullable": true }, "descricao": { "type": "string", "description": "Opcional.\r\nEspecifica um campo aberto descritivo para detalhar o que consiste a Atividade Complementar.", "nullable": true }, "limiteCargaHorariaEmHoraRelogio": { "type": "number", "description": "Obrigatório.\r\nEspecifica a carga horária máxima desta atividade complementar para fins de integralização curricular.", "format": "double", "nullable": true } }, "additionalProperties": false }, "Curriculums.CategoriaAtividadeComplementar": { "type": "object", "properties": { "codigo": { "type": "string", "description": "Obrigatório.\r\nCódigo para referencia esta categoria de Atividades Complementares", "nullable": true }, "nome": { "type": "string", "description": "Obrigatório.\r\nNome descritivo para referenciar esta categoria de Atividades Complementares no RVCE.", "nullable": true }, "limiteCargaHorariaEmHoraRelogio": { "type": "number", "description": "Opcional.\r\nQuando informado impõe um limite de horas que as atividades associadas a esta categoria para fins de integralização curricular.", "format": "double", "nullable": true }, "atividades": { "type": "array", "items": { "$ref": "#/components/schemas/Curriculums.AtividadeComplementarCurriculo" }, "description": "Obrigatório.\r\nDefine a lista de atividades associadas a esta categoria.", "nullable": true } }, "additionalProperties": false }, "Curriculums.CriterioIntegralizacao": { "type": "object", "properties": { "tipo": { "$ref": "#/components/schemas/Curriculums.TipoCriterioIntegralizacao" }, "rotulos": { "$ref": "#/components/schemas/Curriculums.RotulosIntegralizacao" }, "expressao": { "$ref": "#/components/schemas/Curriculums.ExpressaoIntegralizacao" } }, "additionalProperties": false }, "Curriculums.CurriculumCreateRequest": { "required": [ "curriculum", "templateId" ], "type": "object", "properties": { "templateId": { "type": "string", "description": "Id do template a ser utilizado para gerar a representação visual do currículo escolar", "format": "uuid" }, "documentFlow": { "$ref": "#/components/schemas/DocumentFlows.DocumentFlowData" }, "documentFlowId": { "type": "string", "description": "Id de um fluxo de assinatura previamente cadastrado", "format": "uuid", "nullable": true }, "signerFolderId": { "type": "string", "description": "Define a pasta do Assinador, na qual serão colocados o arquivo XML do documento.", "format": "uuid", "nullable": true }, "newFolderName": { "maxLength": 200, "type": "string", "description": "Caso informado irá criar uma nova pasta no Assinador com o nome informado.", "nullable": true }, "curriculum": { "$ref": "#/components/schemas/Curriculums.CurriculumInformationModel" } }, "additionalProperties": false }, "Curriculums.CurriculumCreateResponse": { "type": "object", "properties": { "success": { "type": "boolean", "description": "Indica se o currículo escolar foi criado com sucesso", "readOnly": true }, "id": { "type": "string", "description": "Id do currículo escolar criado", "format": "uuid", "nullable": true }, "errors": { "type": "string", "description": "Texto com os erros que ocorreram durante a criação do currículo escolar", "nullable": true } }, "additionalProperties": false }, "Curriculums.CurriculumInformationModel": { "type": "object", "properties": { "codigo": { "type": "string", "description": "Código único usado pela IES para referenciar o currículo escolar internamente. Será utilizado para associar um Currículo Escolar a um Histórico Escolar.\r\nQuaisquer alterações exigem a criação de um novo Currículo Escolar, com um novo CodigoCurriculo único, a ser publicado pela IES, exceto a inclusção de novas Equivalências em Unidades Curriculares.", "nullable": true }, "dataCurriculo": { "type": "string", "description": "Data em que o currículo escolar foi aprovado e passou a ser aplicado ao curso.\r\nA data será definida no momento da emissão de forma automática. Caso seja informada uma data, sobrescreverá a data gerada automaticamente.", "format": "date-time", "nullable": true }, "minutosRelogioDaHoraAula": { "type": "integer", "description": "Indica quantos Minutos-Relógio tem uma Hora Aula neste currículo", "format": "int32", "nullable": true }, "nomeParaAreas": { "type": "string", "description": "Opcional.\r\nDeve conter o nome usado pelo Curso para se referir às Áreas de Concentração, Competências, Linhas de Formação, ou equivalentes. Caso omitido, assume-se que o termo ‘Áreas de Concentração’", "nullable": true }, "dadosCurso": { "$ref": "#/components/schemas/Degrees.DadosMinimosCurso" }, "iesEmissora": { "$ref": "#/components/schemas/Degrees.DadosIesEmissora" }, "etiquetas": { "type": "array", "items": { "$ref": "#/components/schemas/Curriculums.DadosEtiqueta" }, "description": "Utilizada para classificação das Unidades Curriculares.\r\nTodo currículo escolar possui um conjunto mínimo de Etiquetas, são elas:\r\n\t- Obrigatória (código ob): caracterizam as Unidades Curriculares que devem obrigatoriamente serem cursadas pelos alunos para integralizar o currículo;\r\n\t- Extensao (código ext): caracteriza Unidades Curriculares cuja carga horária, total ou parcialmentet, deve ser usada para cômputo da carga de extensão para curricularização.", "nullable": true }, "areas": { "type": "array", "items": { "$ref": "#/components/schemas/Curriculums.DadosArea" }, "description": "Conjunto de Áreas usadas para classificação das Unidades Curriculares que compõe uma Áreas de Concentração, Competências, Linhas de Formação, ou equivalentes.\r\nCaso o Projeto Pedagógico do Curso não preveja Áreas, enviar esta lista vazia", "nullable": true }, "estruturaCurricular": { "$ref": "#/components/schemas/Curriculums.EstruturaCurricular" }, "estruturaAtividadeComplementar": { "$ref": "#/components/schemas/Curriculums.EstruturaAtividadeComplementar" }, "criteriosIntegralizacao": { "type": "array", "items": { "$ref": "#/components/schemas/Curriculums.CriterioIntegralizacao" }, "description": "Obrigatório.\r\nLista os Critérios de Integralização Curricular, conforme definidos no PPC do Curso", "nullable": true }, "informacoesAdicionais": { "type": "string", "nullable": true }, "isNsf": { "type": "boolean" } }, "additionalProperties": false }, "Curriculums.CurriculumModel": { "type": "object", "properties": { "isSigned": { "type": "boolean", "description": "Indica se o currículo escolar foi assinado" }, "signerDocumentId": { "type": "string", "description": "Id do currículo escolar (XML) no Assinador", "format": "uuid" }, "signerDocumentUrl": { "type": "string", "description": "URL do currículo escolar (XML) no Assinador", "nullable": true }, "hasVisualRepresentation": { "type": "boolean" }, "id": { "type": "string", "description": "ID do currículo escolar", "format": "uuid" }, "code": { "type": "string", "description": "Código do currículo escolar", "nullable": true }, "course": { "type": "string", "description": "Nome do Curso", "nullable": true }, "iesName": { "type": "string", "description": "Nome da IES Emissora", "nullable": true }, "creationDate": { "type": "string", "description": "Data de criação do currículo escolar", "format": "date-time" }, "updateDate": { "type": "string", "description": "Data da última atualização do currículo escolar", "format": "date-time" }, "status": { "$ref": "#/components/schemas/CurriculumStatus" }, "version": { "$ref": "#/components/schemas/DegreeVersions" }, "validationCode": { "type": "string", "description": "Código de validação do currículo escolar", "nullable": true } }, "additionalProperties": false }, "Curriculums.CurriculumStatusUpdateModel": { "type": "object", "properties": { "status": { "$ref": "#/components/schemas/CurriculumStatus" }, "reason": { "type": "string", "nullable": true }, "date": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "Curriculums.CurriculumValidationInformationModel": { "type": "object", "properties": { "codigo": { "type": "string", "nullable": true }, "dataCurriculo": { "type": "string", "format": "date-time" }, "dadosCurso": { "$ref": "#/components/schemas/Degrees.DadosMinimosCurso" }, "iesEmissora": { "$ref": "#/components/schemas/Degrees.DadosIesEmissora" }, "informacoesAdicionais": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Curriculums.CurriculumValidationModel": { "type": "object", "properties": { "history": { "type": "array", "items": { "$ref": "#/components/schemas/Curriculums.CurriculumStatusUpdateModel" }, "nullable": true }, "information": { "$ref": "#/components/schemas/Curriculums.CurriculumValidationInformationModel" }, "isValid": { "type": "boolean" }, "isCancelled": { "type": "boolean" }, "hasVisualRepresentation": { "type": "boolean" }, "visualRepresentationTicket": { "$ref": "#/components/schemas/TicketFileModel" }, "xmlTicket": { "$ref": "#/components/schemas/TicketFileModel" }, "id": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false }, "Curriculums.DadosArea": { "type": "object", "properties": { "codigo": { "type": "string", "description": "Código a ser usado para referenciar esta área", "nullable": true }, "nome": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Curriculums.DadosEtiqueta": { "type": "object", "properties": { "codigo": { "type": "string", "description": "Código a ser usado para referenciar esta etiqueta", "nullable": true }, "nome": { "type": "string", "description": "Indica nome descritivo associado a uma etiqueta a ser usado no RVCE", "nullable": true }, "aplicadoAutomaticamenteUnidadesNaoPertencentesAoCurriculo": { "type": "boolean", "description": "Elemento opcional e deve ser usado para identificar qual etiqueta deve ser aplicada a Unidades Curriculares constantes no Histórico Escolar de um aluno que não fazem parte do presente currículo, ou seja, disciplinas extracurriculares.\r\nApenas uma etiqueta pode possuir este atributo com valor True.\r\nEnviar com valor nulo caso não queira informar nenhuma informação para este campo.", "nullable": true } }, "additionalProperties": false }, "Curriculums.Ementa": { "type": "object", "properties": { "itens": { "type": "array", "items": { "$ref": "#/components/schemas/Curriculums.ItemEmenta" }, "nullable": true } }, "additionalProperties": false }, "Curriculums.EstruturaAtividadeComplementar": { "type": "object", "properties": { "categorias": { "type": "array", "items": { "$ref": "#/components/schemas/Curriculums.CategoriaAtividadeComplementar" }, "nullable": true } }, "additionalProperties": false }, "Curriculums.EstruturaCurricular": { "type": "object", "properties": { "unidadesCurriculares": { "type": "array", "items": { "$ref": "#/components/schemas/Curriculums.UnidadeCurricular" }, "nullable": true } }, "additionalProperties": false }, "Curriculums.Etiqueta": { "type": "object", "properties": { "codigo": { "type": "string", "description": "Código da Etiqueta que qualifica a Unidade Curricular para fins de cômputo da integralização curricular", "nullable": true }, "cargaHorariaEmHoraAula": { "type": "integer", "description": "Opcional.\r\nCaso esteja presente, este número de horas será utilizado para fins de contabilização de carga horária. Caso não, será usado a carga horária da Unidade Curricular.", "format": "int32", "nullable": true }, "cargaHorariaEmHoraRelogio": { "type": "number", "description": "Obrigatório caso HoraAula seja informado\r\nCaso esteja presente, este número de horas será utilizado para fins de contabilização de carga horária. Caso não, será usado a carga horária da Unidade Curricular.", "format": "double", "nullable": true } }, "additionalProperties": false }, "Curriculums.ExpressaoIntegralizacao": { "type": "object", "properties": { "somatorioCodigos": { "type": "array", "items": { "type": "string" }, "description": "Obrigatório.\r\nDefine a fórmula matemática para computar um somatório de cargas horárias associada a este critério.", "nullable": true }, "codigo": { "type": "string", "description": "Obrigatório.\r\nIdentifica o critério unicamente dentro do Currículo Escolar", "nullable": true }, "limitesCargaHoraria": { "$ref": "#/components/schemas/Curriculums.LimitesCargaHoraria" } }, "additionalProperties": false }, "Curriculums.ItemEmenta": { "type": "object", "properties": { "descricao": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Curriculums.LimitesCargaHoraria": { "type": "object", "properties": { "cargaHorariaMinima": { "type": "number", "description": "Obrigatório.\r\nDefine o mínimo de horas que o aluno deve cursar, considerando as Unidades Curriculares que atendam ao Critério, para que o critério seja atendido.", "format": "double", "nullable": true }, "cargaHorariaMaxima": { "type": "number", "description": "Obrigatório.\r\nDefine o máximo de horas que o aluno deve cursar, considerando as Unidades Curriculares que atendam ao Critério, para fins de integralização curricular.\r\nCaso um histórico possua elementos de histórico com mais horas do que associadas ao Critério, será considerada a Carga Horária Máxima.", "format": "double", "nullable": true }, "cargaHorariaParaTotal": { "type": "number", "description": "Opcional.\r\nDeve ser usado para indicar que quanto de carga horária deste Critério contribui para o Total da Carga Horária do Curso.\r\nCaso seja omitida, considera-se que este critério é utilizado exclusivamente para definir critérios de integralização e não contribui com a carga horária total do curso.", "format": "double", "nullable": true } }, "additionalProperties": false }, "Curriculums.RotulosIntegralizacao": { "type": "object", "properties": { "tipoUnidadeCurricular": { "$ref": "#/components/schemas/Curriculums.TipoUnidadeCurricular" }, "etiquetas": { "type": "array", "items": { "type": "string" }, "description": "Opcional.\r\nDefine as etiquetas que a Unidade Curricular devem atender para que este Critério se aplique.", "nullable": true }, "codigo": { "type": "string", "description": "Obrigatório.\r\nIdentifica o critério unicamente dentro do Currículo Escolar", "nullable": true }, "limitesCargaHoraria": { "$ref": "#/components/schemas/Curriculums.LimitesCargaHoraria" } }, "additionalProperties": false }, "Curriculums.TipoCriterioIntegralizacao": { "enum": [ "Rotulos", "Expressao" ], "type": "string" }, "Curriculums.TipoUnidadeCurricular": { "enum": [ "Disciplina", "Módulo", "Atividade", "Estágio", "Trabalho de Conclusão de Curso", "Monografia", "Artigo", "Projeto", "Produto", "Atividade Complementar", "Atividade de Extensão" ], "type": "string" }, "Curriculums.UnidadeCurricular": { "type": "object", "properties": { "tipo": { "$ref": "#/components/schemas/Curriculums.TipoUnidadeCurricular" }, "codigo": { "type": "string", "description": "Obrigatório.\r\nEste código deve ser usado no histórico de forma a ssociar um Elemento do Histórico a uma Unidade Curricular", "nullable": true }, "nome": { "type": "string", "description": "Obrigatório.\r\nNome descritivo ser usado no RVCE para referenciar esta unidade curricular.", "nullable": true }, "cargaHorariaEmHoraAula": { "type": "integer", "description": "Opcional.\r\nAssocia a esta unidade curricular uma carga horária expressa em Hora-Aula para fins de cômputo da integralização curricular.", "format": "int32", "nullable": true }, "cargaHorariaEmHoraRelogio": { "type": "number", "description": "Obrigatório.\r\nAssocia a esta unidade curricular uma carga horária expressa em Hora-Aula para fins de cômputo da integralização curricular.", "format": "double", "nullable": true }, "ementa": { "$ref": "#/components/schemas/Curriculums.Ementa" }, "fase": { "type": "string", "description": "Opcional.\r\nEspecifica a fase do curso recomendada para cursar a Unidade Curricular.", "nullable": true }, "equivalencias": { "type": "array", "items": { "$ref": "#/components/schemas/Curriculums.UnidadeCurricularEquivalente" }, "description": "Deve ser usado para identificar Unidades Curriculares, ou conjuntos de Unidades Curriculares, que quando cursadas pela aluno implicam na integralização desta Unidade Curricular.", "nullable": true }, "preRequisitos": { "type": "array", "items": { "type": "string" }, "description": "Deve ser usado para identificar Unidades Curriculares, ou conjuntos de Unidades Curriculares, que quando cursadas pela aluno implicam na integralização desta Unidade Curricular.\r\nDeve ser informado o código da unidade curricular dependente.", "nullable": true }, "etiquetas": { "type": "array", "items": { "$ref": "#/components/schemas/Curriculums.Etiqueta" }, "description": "Opcional.\r\nDeve ser usado para declarar a lista de etiquetas associadas a esta Unidade Curricular.", "nullable": true }, "areas": { "type": "array", "items": { "type": "string" }, "description": "Opcional.\r\nUsado para declara a lista de áreas associadas a esta Unidade Curricular.", "nullable": true } }, "additionalProperties": false }, "Curriculums.UnidadeCurricularEquivalente": { "type": "object", "properties": { "codigosUnidadesEquivalentes": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "DegreeCancellationReasons": { "enum": [ "ErroDeFato", "ErroDeDireito", "DecisaoJudicial", "ReemissaoParaComplementoDeInformacao", "ReemissaoParaInclusaoDeHabilitacao", "ReemissaoParaAnotacaoDeRegistro" ], "type": "string" }, "DegreeInformationValidation[Degrees.DegreeEmissionRequestModel]": { "type": "object", "properties": { "entryNumber": { "type": "integer", "format": "int32" }, "isValid": { "type": "boolean" }, "errors": { "type": "array", "items": { "type": "string" }, "nullable": true }, "structureErrors": { "type": "array", "items": { "type": "string" }, "nullable": true }, "signatureErrors": { "type": "array", "items": { "type": "string" }, "nullable": true }, "information": { "$ref": "#/components/schemas/Degrees.DegreeEmissionRequestModel" } }, "additionalProperties": false }, "DegreeInformationValidation[Degrees.DegreeFullInformationModel]": { "type": "object", "properties": { "entryNumber": { "type": "integer", "format": "int32" }, "isValid": { "type": "boolean" }, "errors": { "type": "array", "items": { "type": "string" }, "nullable": true }, "structureErrors": { "type": "array", "items": { "type": "string" }, "nullable": true }, "signatureErrors": { "type": "array", "items": { "type": "string" }, "nullable": true }, "information": { "$ref": "#/components/schemas/Degrees.DegreeFullInformationModel" } }, "additionalProperties": false }, "DegreeStatus": { "enum": [ "Created", "Active", "Canceled", "CanceledTemporarily" ], "type": "string" }, "DegreeTypes": { "enum": [ "Default", "Nsf", "JudicialDecision" ], "type": "string" }, "DegreeVersions": { "enum": [ "V100", "V101", "V102", "V103", "V1041", "V105" ], "type": "string" }, "Degrees.AcademicDocumentationInformation": { "type": "object", "properties": { "registro": { "$ref": "#/components/schemas/Degrees.RegistrationInformation" } }, "additionalProperties": false }, "Degrees.AprovacaoDisciplina": { "type": "object", "properties": { "formaIntegralizacao": { "$ref": "#/components/schemas/Degrees.FormaIntegralizacao" }, "outraFormaIntegralizacao": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Degrees.AreaComNome": { "type": "object", "properties": { "codigo": { "type": "string", "description": "O elemento Codigo deve remeter ao código especificado no curriculo", "nullable": true }, "nome": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Degrees.AtividadeComplementar": { "type": "object", "properties": { "dataRegistro": { "type": "string", "format": "date-time", "nullable": true }, "tipo": { "type": "string", "nullable": true }, "codigo": { "type": "string", "nullable": true }, "dataInicio": { "type": "string", "format": "date-time", "nullable": true }, "dataFim": { "type": "string", "format": "date-time", "nullable": true }, "descricao": { "type": "string", "nullable": true }, "cargaHorariaEmHoraRelogioComEtiqueta": { "type": "array", "items": { "$ref": "#/components/schemas/Degrees.HoraRelogioComEtiqueta" }, "description": "Pode ser associada a uma etiqueta definida no Currículo Escolar permitindo identificar a natureza da carga horária dentro do Currículo do Curso", "nullable": true }, "docentes": { "type": "array", "items": { "$ref": "#/components/schemas/Degrees.Docente" }, "nullable": true }, "cargaHorariaEmHoraRelogio": { "type": "number", "description": "OBSOLETO. Utilizar