Aluno Digital

Para realizar uma requisição nessa rota da API é necessário alguns requisitos!

Cadastro de IP na Aplicação (Só São aceitos Acessos de IPs Cadastrados) ou pode cadastrar um * para liberar qualquer IP para o cliente
Envio da Chave do Cliente(Campo que faz parte do Json de envio) A Chave do cliente será fornecida após o cadastro do cliente no sistema
Cadastro de Usuário e Senha para Autenticação

A API usa a autenticação tipo Basic
Authorization: Basic {credenciais em base 64 no formato usuário:senha}

Authorization: Basic usuário:senha

O Base 64 é um esquema de codificação. O uso do Base 64 se deve ao padrão MIME.

Observações:

Os campos "Cliente", "CPF", "Nome" e "Email" são obrigatórios para que a requisição seja bem sucedida.

Json de exemplo entrada:

{
    "Cliente": "Hash Fornecido ao Cliente",
    "CPF": "Nr do CPF do Aluno",
    "Nome": "Nome do Aluno",
    "Email": "Email do Aluno",
    "Telefone": "Telefone do Aluno"
}

Json de exemplo saida:

{
    "Resultado": "OK",
    "Mensagem": "Aluno Criado com sucesso!",
}

Json de exemplo erro aluno já cadastrado:

{
    "ERRO": "Aluno já cadastrado na base!",
}

Json de exemplo erro IP:

{
    "ERRO": "ACESSO NÃO AUTORIZADO PARA O IP: "IP"!",
}

Observações:

Os campos "Cliente", "Origem", "TipoFolder" e "Indice01" são obrigatórios para que a requisição seja bem sucedida.
Caso a requisição tenha um documento, os campos "Extensao" e "Classificacao" são obrigatórios.

Json de exemplo entrada:

{
    "Cliente": "Hash Fornecido ao Cliente",
    "Origem": "Nr do departamento",
    "TipoFolder": "Nr do tipo de pasta",
    "Indice01": "Indice relacionado ao TipoFolder",
    "Indice02": "Indice relacionado ao TipoFolder",
    "Indice03": "Indice relacionado ao TipoFolder",
    "Indice04": "Indice relacionado ao TipoFolder",
    "Indice05": "Indice relacionado ao TipoFolder",
    "Indice06": "Indice relacionado ao TipoFolder",
    "Indice07": "Indice relacionado ao TipoFolder",
    "Indice08": "Indice relacionado ao TipoFolder",
    "Indice09": "Indice relacionado ao TipoFolder",
    "Indice10": "Indice relacionado ao TipoFolder",
    "Observacao": "Observações sobre a pasta",
    "Documento": "Binário do Documento",
    "Extensao": "extensão do documento (png, pdf, jpg)",
    "Complemento": "Complemento sobre o documento",
    "Classificacao": "Tipo de documento",
    "CertificadoCNPJ": "CNPJ",
    "AssinarDocumento": "Para assinar o documento"
}

Json de exemplo saida:

{
    "Resultado": "OK",
    "Protocolo": ""Protocolo"",
}

Json de exemplo erro IP:

{
    "ERRO": "ACESSO NÃO AUTORIZADO PARA O IP: "IP"!",
}

Observações:

Os campos "Cliente", "Origem", "TipoFolder" são obrigatórios para que a requisição seja bem sucedida.
É necessário o prenchimento de um dos campos "Protocolo" ou "Indice01" para que a requisição seja bem sucedida.

Json de exemplo entrada:

{
    "Cliente": "Hash Fornecido ao Cliente",
    "Origem": "Nr do departamento",
    "TipoFolder": "Nr do tipo de pasta",
    "Protocolo": "Nr do protocolo",
    "Indice01": "Indice relacionado ao TipoFolder",
    "Indice02": "Indice relacionado ao TipoFolder",
    "Indice03": "Indice relacionado ao TipoFolder",
    "Indice04": "Indice relacionado ao TipoFolder",
    "Indice05": "Indice relacionado ao TipoFolder",
    "Indice06": "Indice relacionado ao TipoFolder",
    "Indice07": "Indice relacionado ao TipoFolder",
    "Indice08": "Indice relacionado ao TipoFolder",
    "Indice09": "Indice relacionado ao TipoFolder",
    "Indice10": "Indice relacionado ao TipoFolder",
    "DataIni": "Data inicial",
    "DataFim": "Data final"
}

Json de exemplo saida:

{
    "Protocolo": "Nr do protocolo",
    "Origem": "Nr do departamento",
    "TipoFolder": "Nr do tipo de pasta",
    "DataCriacao": "Data de criação",
    "UsuarioCriacao": "Usuário",
    "EtapaAtual": "Etapa atual",
    "NomeIndice01": "Indice relacionado ao TipoFolder",
    "Indice01": "Indice relacionado ao TipoFolder",
    "NomeIndice02": "Indice relacionado ao TipoFolder",
    "Indice02": "Indice relacionado ao TipoFolder",
    "NomeIndice03": "Indice relacionado ao TipoFolder",
    "Indice03": "Indice relacionado ao TipoFolder",
    "NomeIndice04": "Indice relacionado ao TipoFolder",
    "Indice04": "Indice relacionado ao TipoFolder",
    "NomeIndice05": "Indice relacionado ao TipoFolder",
    "Indice05": "Indice relacionado ao TipoFolder",
    "NomeIndice06": "Indice relacionado ao TipoFolder",
    "Indice06": "Indice relacionado ao TipoFolder",
    "NomeIndice07": "Indice relacionado ao TipoFolder",
    "Indice07": "Indice relacionado ao TipoFolder",
    "NomeIndice08": "Indice relacionado ao TipoFolder",
    "Indice08": "Indice relacionado ao TipoFolder",
    "NomeIndice09": "Indice relacionado ao TipoFolder",
    "Indice09": "Indice relacionado ao TipoFolder",
    "NomeIndice10": "Indice relacionado ao TipoFolder",
    "Indice10": "Indice relacionado ao TipoFolder",
    "Documentos": [{
        "Documento": [{
            "ClassificacaoDocumento": "Classificação do documento",
            "URLDocumento": "URL do documento",
            "TamanhoDocumento": "Tamanho do documento",
            "DataCadastroDocumento": "Data de cadastro do documento"
        }]
    }]
}

Json de exemplo erro IP:

{
    "ERRO": "ACESSO NÃO AUTORIZADO PARA O IP: "IP"!",
    "Mensagem": "Aluno Criado com sucesso!",
}

Observações:

Os campos "Cliente", "Origem", "TipoFolder" são obrigatórios para que a requisição seja bem sucedida.
É necessário o prenchimento de um dos campos "Protocolo" ou "Indice01" e "Indice02" para que a requisição seja bem sucedida.
Apenas o campo "complemento" é opcional para que a requisição seja bem sucedida.

Json de exemplo entrada:

{
    "Cliente": "Hash Fornecido ao Cliente",
    "TipoFolder": "Nr do tipo de pasta",
    "Protocolo": "Nr do protocolo",
    "Indice01": "Indice relacionado ao TipoFolder",
    "Indice02": "Indice relacionado ao TipoFolder",
    "Documento": "Binário do Documento",
    "Extensao": "extensão do documento (png, pdf, jpg)",
    "Complemento": "Complemento sobre o documento",
    "Classificacao": "Tipo de documento",
}

Json de exemplo saida:

{
    "Resultado": "OK",
}

Json de exemplo erro IP:

{
    "ERRO": "ACESSO NÃO AUTORIZADO PARA O IP: "IP"!",
}

Observações:

Os campos "Cliente", "Protocolo", "Decisao" são obrigatórios para que a requisição seja bem sucedida.
O campo "Decisao" deve ser escritos como "S" ou "N".
Ou pode passa o ID da Etapa de Destino "EtapaEnvio".

Json de exemplo entrada:

{
  "Cliente": "Hash Fornecido ao Cliente",
  "Protocolo": "Nr do protocolo",
  "Decisao": "Decisão da etapa do processo 'S' para Sim, 'N' para Não",
  "Observacao": "Observação da etapa do documento"
  "EtapaEnvio": Id da Etapa de Destino do Procolo"
}

Json de exemplo saida:

{
    "Resultado": "PROCESSO ENVIADO COM SUCESSO",
}

Json de exemplo erro IP:

{
    "ERRO": "ACESSO NÃO AUTORIZADO PARA O IP: "IP"!",
}

Observações:

Os campos "Cliente", "nome", "email", "senha", "situacao", "departamento" e "perfilAcesso" são obrigatórios para que a requisição seja bem sucedida.
Os campos "filtrarEtapas", "consultarResponsavel", "bloqueioHorarioIP", "assinaDocs", "ignoraOrigemFila", "situacao" devem ser escritos como true ou false.

Json de exemplo entrada:

{
  "Cliente": "Hash Fornecido ao Cliente",
  "Nome": "Nome do usuário",
  "Email": "email do usuário",
  "CPF": "CPF do usuário",
  "Telefone": "Telefone do usuário",
  "Senha": "Senha do usuário",
  "FiltrarEtapas": "Filtrar etapas",
  "ConsultarResponsavel": "Consultar Responsável",
  "BloqueioHorarioIP": "Bloqueio Horário/IP",
  "AssinaDocs": "Assinar Documentos",
  "IgnoraOrigemFila": "Ignorar origem na fila de trabalho",
  "Ocupacao": "Ocupação",
  "CodigoExterno": "Código Externo",
  "Situacao": "Situação do usuário",
  "Departamento": "Departamento",
  "PerfilAcesso": "Perfil de acesso",
  "DepartamentosAcesso": [ "Array com os departamentos de acesso", "" ]
}

Json de exemplo saida:

{
    "Resultado": ""ID usuário"",
    "Aviso": ["Array com avisos sobre o processo", ""]
}

Json de exemplo erro IP:

{
    "ERRO": "ACESSO NÃO AUTORIZADO PARA O IP: "IP"!",
}

Observações:

Os campos "Cliente" e "CodValidacao" são obrigatórios para que a requisição seja bem sucedida.

Json de exemplo entrada:

{
  "Cliente": "Hash Fornecido ao Cliente",
  "CodValidacao": "Código de validação",
  "MotivoCancelamento": "Motivo do cancelamento"
}

Json de exemplo saida:

{
    "RA": "RA",
    "Nome": "Nome",
    "CodValidacao": "Código de validação",
    "FluxoAssinatura": "Estado do fluxo da assinatura",
    "Situacao": "Situação do diploma"
}

Json de exemplo erro:

{
    "Resultado": "ERRO",
    "RA": "RA",
    "NOME": "Nome do aluno",
    "ERROS":
    [{
        "CAMPO": "CAMPO DO ERRO",
        "MENSAGEM": "MENSAGEM DE RETORNO"
    }]
}

Observações:

Os campos "Cliente" e "CodValidacao" ou "Cliente", "aluNome", "aluCPF" e "aluRA" são obrigatórios para que a requisição seja bem sucedida.

Json de exemplo entrada:

{
  "Cliente": "Hash Fornecido ao Cliente",
  "CodValidacao": "Código de validação",
  "aluNome": "Nome do aluno",
  "aluCPF": "CPF do aluno",
  "aluRA": "RA"
}

Json de exemplo saida:

{
    "Resultado": "Estado do processo",
    "RA": "RA",
    "Nome": "Nome do aluno",
    "CodValidacao": "Código de validação",
    "FluxoAssinatura": "Estado do fluxo da assinatura",
    "Situacao": "Situação do diploma",
    "UrlRVDD": "URL RVDD",
    "UrlXMLDiploma": "URL do XML do diploma",
    "UrlXMLDocumentacaoAcademica": "URL do XML da documentação acadêmica",
    "Observacao": "Observação do diploma"
}

Json de exemplo erro:

{
    "Resultado": "ERRO",
    "RA": "RA",
    "NOME": "Nome do aluno",
    "ERROS":
    [{
        "CAMPO": "CAMPO DO ERRO",
        "MENSAGEM": "MENSAGEM DE RETORNO"
    }]
}

Observações:

Os campos "Cliente" são obrigatórios para que a requisição seja bem sucedida.

Json de exemplo entrada:

{
    "Cliente" : "Hash Fornecido ao Cliente",
    "aluRa" : "Matrícula do Aluno",
    "aluNome" : "Nome do Aluno",
    "aluNomeSocial" : "Nome Social do Aluno",
    "aluSexo" : "Sexo do Aluno",
    "aluNacionalidade" : "Nacionalidade do Aluno",
    "aluNatCodMunicipio" : "Código da Naturalidade do Aluno",
    "aluNatNomeMunicipio" : "Nome do município Naturalidade do Aluno",
    "aluNatUF" : "UF",
    "aluNatEstrangeiro" : "Nome do município Naturalidade do Aluno",
    "aluCPF" : "CPF",
    "aluRgNumero" : "Registro/RG",
    "aluRgOrgaoExpeditor" : "Órgão expeditor do RG do aluno",
    "aluRgUF" : "UF do RG",
    "aluSubsRgTipo" : "Tipo de documento que substitui o Rg do aluno",
    "aluSubsRgId" : "Identificador do documento que substitui o Rg do aluno",
    "aluDataConclusao" : "Data de conclusão do curso",
    "aluDataNasc" : "Data de nascimento",
    "curNomeCurso" : "Nome do curso",
    "curCodCurso" : "Código do curso EMEC",
    "curNomeHabilitacao" : "Nome da habilitação do curso",
    "curModalidade" : "Modalidade do curso",
    "curTituloConferido" : "Título conferido do curso",
    "curOutroTituloConferido" : "Substitui o título conferido se não estiver no enumarte",
    "curGrauConferido" : "Grau Conferido do curso",
    "curEndLogradouro" : "Logradouro do curso",
    "curEndNumero" : "Número da Casa/Apto",
    "curEndComplemento" : "Endereço completo do curso",
    "curEndBairro" : "Bairro do curso",
    "curEndCodMunicipio" : "Código do município do curso",
    "curEndNomeMunicipio" : "Nome do município do curso",
    "curEndUF" : "UF do curso",
    "curEndEstrangeiro" : "Nome do município estrangeiro",
    "curEndCEP" : "CEP do curso",
    "curPoloNome" : "Nome do polo de curso",
    "curPoloEndLogradouro" : "Logradouro do endereço do polo do curso",
    "curPoloEndNumero" : "Número do Endereço polo do curso",
    "curPoloEndComplemento" : "Complemento do endereço do polo do curso",
    "curPoloEndBairro" : "Bairro do endereço do polo do curso",
    "curPoloEndCodMunicipio" : "Código do município do polo do curso",
    "curPoloEndNomeMunicipio" : "Nome do município do polo do curso",
    "curPoloEndUF" : "UF do polo do curso",
    "curPoloEndEstrangeiro" : "Nome do município estrangeiro",
    "curPoloEndCEP" : "CEP do Polo",
    "curPoloCodMec" : "Código MEC do polo",
    "curAutTipo" : "Tipo da autorização do curso",
    "curAutNumero" : "Tipo da autorização do curso",
    "curAutData" : "Data da autorização do curso",
    "curAutVeiculoPublicacao" : "Veículo da publicação da autorização do curso",
    "curAutDataPublicacao" : "Data da publicação da autorização do curso",
    "curAutSecaoPublicacao" : "Seção da publicação da autorização do curso",
    "curAutPaginaPublicacao" : "Página da publicação da autorização curso",
    "curAutNumeroDou" : "Número DOU da autorização do curso",
    "curRecTipo" : "Tipo de reconhecimento do curso",
    "curRecNumero" : "Número de reconhecimento do curso",
    "curRecData" : "Data de reconhecimento do curso",
    "curRecVeiculoPublicacao" : "Veiculo de publicação do Reconhecimento do curso",
    "curRecDataPublicacao" : "Data de publicação do reconhecimento do curso",
    "curRecSecaoPublicacao" : "Seção de publicação do reconhecimento do curso",
    "curRecPaginaPublicacao" : "Página de publicação do reconhecimento do curso",
    "curRecNumeroDou" : "Número DOU do reconhecimento do curso",
    "curRenRecTipo" : "Tipo de renovação de reconhecimento do curso",
    "curRenRecNumero" : "Número de renovação de reconhecimento do curso",
    "curRenRecData" : "Data de renovação de reconhecimento do curso",
    "curRenRecVeiculoPublicacao" : "Veículo de publicação da renovação de reconhecimento do curso",
    "curRenRecDataPublicacao" : "Data da publicação do renovação de reconhecimento do curso",
    "curRenRecSecaoPublicacao" : "Seção da publicação da renovação de reconhecimento do curso",
    "curRenRecPaginaPublicacao" : "Página de publicação da renovação de reconhecimento do curso",
    "curRenRecNumeroDou" : "Número DOU da renovação de reconhecimento do curso",
    "iesEmiNome" : "Nome da instituição emissora",
    "iesEmiCodigoMEC" : "Código da instituição emissora",
    "iesEmiCNPJ" : "CNPJ da instituição emissora",
    "iesEmiEndLogradouro" : "Logradouro da instituição emissora",
    "iesEmiEndNumero" : "Número do endereço da instituição emissora",
    "iesEmiEndComplemento" : "Código Complemento da emissora",
    "iesEmiEndBairro" : "Bairro da instituição emissora",
    "iesEmiEndCodMunicipio" : "Código Município da emissora",
    "iesEmiEndNomeMunicipio" : "Nome Município da emissora",
    "iesEmiEndUF" : "UF da emissora",
    "iesEmiEndEstrangeiro" : "Município estrangeiro da Emissora",
    "iesEmiEndCEP" : "CEP da emissora",
    "iesEmiCredTipo" : "Tipo de credenciamento",
    "iesEmiCredNumero" : "Número do credenciamento",
    "iesEmiCredData" : "Data do credenciamento",
    "iesEmiCredVeiculoPublicacao" : "Veículo de publicação do credenciamento",
    "iesEmiCredDataPublicacao" : "Data de publicação do credenciamento",
    "iesEmiCredSecaoPublicacao" : "Seção de publicação do credenciamento",
    "iesEmiCredPaginaPublicacao" : "Página de publicação do credenciamento",
    "iesEmiCredNumeroDou" : "Número DOU do credenciamento",
    "iesEmiRecTipo" : "Tipo de recredenciamento",
    "iesEmiRecNumero" : "Número de recredenciamento",
    "iesEmiRecData" : "Data de recredenciamento",
    "iesEmiRecVeiculoPublicacao" : "Veículo de publicação do recredenciamento.",
    "iesEmiRecDataPublicacao" : "Data da publicação do recredenciamento",
    "iesEmiRecSecaoPublicacao" : "Seção de publicação do recredenciamento",
    "iesEmiRecPaginaPublicacao" : "Página de publicação do recredenciamento",
    "iesEmiRecNumeroDou" : "Número DOU do recredenciamento",
    "iesEmiRenRecTipo" : "Tipo de renovação de recredenciamento",
    "iesEmiRenRecNumero" : "Número de renovação de recredenciamento",
    "iesEmiRenRecData" : "Data de renovação de recredenciamento",
    "iesEmiRenRecVeiculoPublicacao" : "Veículo de publicação da renovação de recredenciamento",
    "iesEmiRenRecDataPublicacao" : "Data da publicação da renovação de recredenciamento",
    "iesEmiRenRecSecaoPublicacao" : "Seção de publicação da renovação de recredenciamento",
    "iesEmiRenRecPaginaPublicacao" : "Página de publicação da renovação de recredenciamento",
    "iesEmiRenRecNumeroDou" : "Número DOU da renovação de recredenciamento",
    "iesEmiManRazaoSocial" : "Razão social da mantenedora",
    "iesEmiManCNPJ" : "CNPJ da mantenedora",
    "iesEmiManEndLogradouro" : "Logradouro da mantenedora",
    "iesEmiManEndNumero" : "Número da mantenedora",
    "iesEmiManEndComplemento" : "Complemento da mantenedora",
    "iesEmiManEndBairro" : "Bairro da mantenedora",
    "iesEmiManEndCodMunicipio" : "Código do município da mantenedora",
    "iesEmiManEndNomeMunicipio" : "Nome do município da mantenedora",
    "iesEmiManEndUF" : "UF da mantenedora",
    "iesEmiManEndEstrangeiro" : "Município estrangeiro da mantenedora",
    "iesEmiManEndCEP" : "CEP da mantenedora",
    "iesRegNome" : "Nome da registradora",
    "iesRegCodigoMEC" : "Código MEC da registradora",
    "iesRegCNPJ" : "CNPJ da registradora",
    "iesRegEndLogradouro" : "Endereço - Logradouro da registradora",
    "iesRegEndNumero" : "Endereço - Número da registradora",
    "iesRegEndComplemento" : "Endereço - Complemento da registradora",
    "iesRegEndBairro" : "Endereço - Bairro da registradora",
    "iesRegEndCodMunicipio" : "Endereço – Código do município da registradora",
    "iesRegEndNomeMunicipio" : "Endereço – Nome do município da registradora",
    "iesRegEndUF" : "Endereço – UF da registradora",
    "iesRegEndEstrangeiro" : "Município estrangeiro da registradora",
    "iesRegEndCEP" : "Endereço – CEP da registradora",
    "iesRegCredTipo" : "Tipo de credenciamento",
    "iesRegCredNumero" : "Número de credenciamento",
    "iesRegCredData" : "Data do credenciamento",
    "iesRegCredVeiculoPublicacao" : "Veículo de publicação do credenciamento",
    "iesRegCredDataPublicacao" : "Data de publicação do credenciamento",
    "iesRegCredSecaoPublicacao" : "Seção de publicação do credenciamento",
    "iesRegCredPaginaPublicacao" : "Página de publicação do credenciamento",
    "iesRegCredNumeroDou" : "Número DOU do credenciamento",
    "iesRegRecTipo" : "Tipo de recredenciamento",
    "iesRegRecNumero" : "Número de recredenciamento",
    "iesRegRecData" : "Data de recredenciamento",
    "iesRegRecVeiculoPublicacao" : "Veículo de publicação do recredenciamento",
    "iesRegRecDataPublicacao" : "Data de publicação do recredenciamento",
    "iesRegRecSecaoPublicacao" : "Seção de publicação do recredenciamento",
    "iesRegRecPaginaPublicacao" : "Página de publicação do recredenciamento",
    "iesRegRecNumeroDou" : "Número DOU do recredenciamento",
    "iesRegRenRecTipo" : "Tipo de renovação do recredenciamento",
    "iesRegRenRecNumero" : "Número de renovação do recredenciamento",
    "iesRegRenRecData" : "Data de renovação do recredenciamento",
    "iesRegRenRecVeiculoPublicacao" : "Veículo de publicação da renovação do recredenciamento",
    "iesRegRenRecDataPublicacao" : "Data de publicação da renovação do recredenciamento",
    "iesRegRenRecSecaoPublicacao" : "Seção de publicação da renovação do recredenciamento",
    "iesRegRenRecPaginaPublicacao" : "Página de publicação da renovação do recredenciamento",
    "iesRegRenRecNumeroDou" : "Número DOU da renovação do recredenciamento",
    "iesRegManRazaoSocial" : "Razão social da mantenedora",
    "iesRegManCNPJ" : "CNPJ da mantenedora",
    "iesRegManEndLogradouro" : "Endereço – Logradouro da mantenedora",
    "iesRegManEndNumero" : "Endereço – Número da mantenedora",
    "iesRegManEndComplemento" : "Endereço – Complemento da mantenedora",
    "iesRegManEndBairro" : "Endereço – Bairro da mantenedora",
    "iesRegManEndCodMunicipio" : "Endereço – Código do município da mantenedora",
    "iesRegManEndNomeMunicipio" : "Endereço – Nome do município da mantenedora",
    "iesRegManEndUF" : "Endereço – UF da mantenedor",
    "esRegManEndEstrangeiro" : "Município estrangeiro do mantenedor",
    "iesRegManEndCEP" : "Endereço – CEP da mantenedora",
    "dipLivroRegistro" : "Registro do livro",
    "dipDiplomaNumeroRegistro" : "Número do Registro do livro",
    "dipflsDiploma" : "Número da folha do diploma",
    "dipNrDiploma" : "Número da sequência do diploma",
    "dipNrProcessoSolitacao" : "Número do processo do diploma",
    "dipDataColacaoGrau" : "Data da colação de grau",
    "dipDataEmissaoDiploma" : "Data da expedição do diploma",
    "dipDataRegistroDiploma" : "Data de registro do diploma",
    "dipRespRegistroNome" : "Nome do responsável pelo registro",
    "dipRespRegistroCPF" : "CPF do responsável pelo registro",
    "dipRespRegistroMatricula" : "Matrícula do responsável pelo registro",
    "aluGenitorNome1" : "Nome do genitor",
    "aluGenitorNomeSocial1" : "Nome social do genitor",
    "aluGenitorSexo1" : "Sexo do genitor",
    "aluGenitorNome2" : "Nome do genitor",
    "aluGenitorNomeSocial2" : "Nome social do genitor",
    "aluGenitorSexo2" : "Sexo do genitor",
    "hisDataEmissao" : "Data de emissão do histórico",
    "aluSituacaoAluno" : "Situação do aluno",
    "aluSituacaoENADE" : "Situação no ENADE",
    "aluSituacaoENADEOutro" : "Situação no ENADE substituta se não estiver no enumerate",
    "aluSituacaoDataProvaENADE" : "Data da prova ENADE do aluno",
    "curCargaHorCurIntegralizada" : "Carga horária do curso integralizada",
    "curCargaHorCurso" : "Carga horária do curso",
    "curIngData" : "Data de ingresso no curso",
    "curFormaAcesso" : "Forma de acesso",
    "curDataConclusao" : "Data de conclusão",
    "terNome" : "Nome da pessoa que assinou o termo de responsabilidade",
    "terCPF" : "CPF da pessoa que assinou o termo de responsabilidade",
    "terCargo" : "Cargo da pessoa que assinou o termo de responsabilidade",
    "terAtoDesignacao" : "Ato de designação do termo de responsabilidade",
    "aluEmail" : "Email do aluno",
    "docComproTipo" : "Tipo do Comprovante",
    "docComproObservacoes" : "Observações sobre o comprovante",
    "disciplinasCursadas" :  [{
        "hisDisciplina" : "Nome da disciplina",
        "hisPeriodo" : "Período da disciplina",
        "hisNota" : "Nota da disciplina",
        "hisSituacao" : "Situação da disciplina",
        "hisConceito" : "Conceito da disciplina",
        "docentes" :  [{
            "docDocenteNome" : "Nome do docente",
            "docDocenteTitulacao" : "Titulação do docente"
        }]
    }]
}

Json de exemplo saida:

{
    "Resultado": "Estado do processo",
    "RA": "RA",
    "Nome": "Nome do aluno",
    "CodValidacao": "Código de validação",
}

Json de exemplo erro:

{
    "Resultado": "ERRO",
    "RA": "RA",
    "NOME": "Nome do aluno",
    "ERROS":
    [{
        "CAMPO": "CAMPO DO ERRO",
        "MENSAGEM": "MENSAGEM DE RETORNO"
    }]
}

Observações:

Os campos "Cliente", "CodValidacao", "Classificacao" e "Documento" são obrigatórios para que a requisição seja bem sucedida.

Json de exemplo entrada:

{
  "Cliente": "Hash Fornecido ao Cliente",
  "CodValidacao": "Código de validação",
  "Classificacao": "Classificação do documento",
  "Observacao": "Observação do documento",
  "Documento": "Documento"
}

Json de exemplo saida:

{
    "Resultado": "Estado do processo",
    "RA": "RA",
    "Nome": "Nome do aluno",
    "CodValidacao": "Código de validação",
    "Documento": "Documento"
}

Json de exemplo erro:

{
    "Resultado": "ERRO",
    "RA": "RA",
    "NOME": "Nome do aluno",
    "ERROS":
    [{
        "CAMPO": "CAMPO DO ERRO",
        "MENSAGEM": "MENSAGEM DE RETORNO"
    }]
}

Observações:

Os campos "Cliente", "Origem", "TipoFolder", "Indice01", "Assinantes" e "Documentos" são obrigatórios para que a requisição seja bem sucedida.
Sobre o campo "Assinantes", os campos "CPF", "Nome" são obrigatórios para que a requisição seja bem sucedida. Caso não seja enviado o campo "Senha" será gerado uma senha aleatória.
Sobre o campo "Documentos", os campos "Documento", "Classificacao", "Extensao" e "SolicitarAssinatura" são obrigatórios para que a requisição seja bem sucedida.
O campo "SolicitarAssinatura" em "Documentos" deve conter um "S" para que seja solicitado. exemplo: { "SolicitarAssinatura": "S" }.

Json de exemplo entrada:

{
	"Cliente": "Hash Fornecido ao Cliente",
	"Origem": "Nr do departamento",
	"TipoFolder": "Nr do tipo de pasta",
	"Indice01": "Indice relacionado ao TipoFolder",
	"Indice02": "Indice relacionado ao TipoFolder",
	"Indice03": "Indice relacionado ao TipoFolder",
	"Indice04": "Indice relacionado ao TipoFolder",
	"Indice05": "Indice relacionado ao TipoFolder",
	"Indice06": "Indice relacionado ao TipoFolder",
	"Indice07": "Indice relacionado ao TipoFolder",
	"Indice08": "Indice relacionado ao TipoFolder",
	"Indice09": "Indice relacionado ao TipoFolder",
	"Indice10": "Indice relacionado ao TipoFolder",
	"Observacao": "Observações sobre a pasta",
	"Assinantes": [{
	 	"Tipo": "Tipo",
	 	"CPF": "CPF do Assinante",
	 	"Nome": "Nome do Assinante",
	 	"Senha": "Senha do Assinante",
	 	"Email": "Email do Assinante",
	 	"Telefone": "Telefone do Assinante"
	 }],
	 "Documentos": [{
	 	"Classificacao": "Tipo de documento",
	 	"Complemento": "Complemento sobre o documento",
	 	"Extensao": "extensão do documento (.pdf)",
	 	"SolicitarAssinatura": "Solicitar a assinatura",
	 	"Documento": "Binário do Documento"
	 }]
}

Json de exemplo saida:

{
    "Resultado": "Estado do processo",
    "Protocolo": "Protocolo"
}

Json de exemplo erro:

{
    "Resultado": "ERRO",
    "ERROS":
    [{
        "CAMPO": "CAMPO DO ERRO",
        "MENSAGEM": "MENSAGEM DE RETORNO"
    }]
}

Observações:

Os campos "Cliente", "Origem", "idTemplate" e "aluMatricula" são obrigatórios para que a requisição seja bem sucedida.

Json de exemplo entrada:

{
	"Cliente": "Hash Fornecido ao Cliente",
	"Origem": "Nr do departamento",
	"idTemplate": "ID do template",
	"aluRa": "Matricula do Aluno",
	"aluCPF": "CPF do Aluno",
	"aluNome": "Nome do Aluno",
	"curNomeCurso": "Curso do Aluno",
        ...
        Campos relacionados ao template
        ...
	"disciplinasCursadas": [{
            ...
            Campos relacionados ao template
            ...
	 }]
}

Json de exemplo saida:

{
    "Resultado": "Estado do processo",
    "Protocolo": "Protocolo"
}

Json de exemplo erro:

{
    "Resultado": "ERRO",
    "ERROS":
    [{
        "CAMPO": "CAMPO DO ERRO",
        "MENSAGEM": "MENSAGEM DE RETORNO"
    }]
}

Observações:

Os campos "Cliente", "TipoFolder" e "docConteudo" são obrigatórios para que a requisição seja bem sucedida.

Json de exemplo entrada:

{
    "Cliente": "Hash Fornecido ao Cliente",
    "TipoFolder": "Nr do tipo de pasta",
    "docConteudo": "Nr do documento",
    "Protocolo": "Nr do protocolo"
}

Json de exemplo saida:

{
    "Protocolo": "Nr do Protocolo",
    "Origem": "Nr da Origem",
    "TipoFolder": "Nr do tipo de pasta",
    "DataCriacao": "Data de criação",
    "EtapaAtual": "Etapa do Processo",
    "NomeIndice01": "Nome do Índice relacionado ao tipo Folder",
    "Indice01": "Valor do Índice relacionado ao tipo Folder",
    "NomeIndice02": "Nome do Índice relacionado ao tipo Folder",
    "Indice02": "Valor do Índice relacionado ao tipo Folder",
    "NomeIndice03": "Nome do Índice relacionado ao tipo Folder",
    "Indice03": "Valor do Índice relacionado ao tipo Folder",
    "NomeIndice04": "Nome do Índice relacionado ao tipo Folder",
    "Indice04": "Valor do Índice relacionado ao tipo Folder",
    "NomeIndice05": "Nome do Índice relacionado ao tipo Folder",
    "Indice05": "Valor do Índice relacionado ao tipo Folder",
    "NomeIndice06": "Nome do Índice relacionado ao tipo Folder",
    "Indice06": "Valor do Índice relacionado ao tipo Folder",
    "NomeIndice07": "Nome do Índice relacionado ao tipo Folder",
    "Indice07": "Valor do Índice relacionado ao tipo Folder",
    "NomeIndice08": "Nome do Índice relacionado ao tipo Folder",
    "Indice08": "Valor do Índice relacionado ao tipo Folder",
    "NomeIndice09": "Nome do Índice relacionado ao tipo Folder",
    "Indice09": "Valor do Índice relacionado ao tipo Folder",
    "NomeIndice10": "Nome do Índice relacionado ao tipo Folder",
    "Indice10": "Valor do Índice relacionado ao tipo Folder",
    "Documentos": [{
        "ClassificacaoDocumento": "Classificação do Documento",
        "URLDocumento": "URL do Documento",
        "TamanhoDocumento": "Tamanho em bytes do documento",
        "DocumentoAssinado":"Estatus da assinatura",
        "AssinadoPor":"Nome de quem assinou e data da assinatura",
        "DataCadastroDocumento": "Data de Cadastro do Documento"
      }]
}

Json de exemplo erro:

{
	"ERROS": “Mensagem de Erro”,
}

Observações:

Os campos "Cliente", "Indice01" e "Indice02" são obrigatórios para que a requisição seja bem sucedida.

Json de exemplo entrada:

{
	"Cliente": "Hash Fornecido ao Cliente",
	"Indice01": "RA do Aluno",
    "Indice02": "CPF do Aluno",
    "Indice03": "Nome do Aluno",
    "Observacao": "Observação sobre a solicitação"
}

Json de exemplo saida:

{
    "Resultado": "Estado do processo"
}

Json de exemplo erro:

{
    "Resultado": "ERRO",
    "ERROS":
    [{
        "CAMPO": "CAMPO DO ERRO",
        "MENSAGEM": "MENSAGEM DE RETORNO"
    }]
}

API - Documentação Básica

Autenticação da API

Criar o Aluno https://sistema.alunodigital.com.br/API_103/AlunoDigital/CriarAluno

Observações:

Json de exemplo entrada:

Json de exemplo saida:

Json de exemplo erro aluno já cadastrado:

Json de exemplo erro IP:

Criar Pasta do Aluno https://sistema.alunodigital.com.br/API_103/AlunoDigital/CriarPasta

Observações:

Json de exemplo entrada:

Json de exemplo saida:

Json de exemplo erro IP:

Consultar Pasta do Aluno https://sistema.alunodigital.com.br/API_103/AlunoDigital/ConsultarPasta

Observações:

Json de exemplo entrada:

Json de exemplo saida:

Json de exemplo erro IP:

Adicionar Documento https://sistema.alunodigital.com.br/API_103/AdicionarDocumento

Observações:

Json de exemplo entrada:

Json de exemplo saida:

Json de exemplo erro IP:

Enviar Processo Etapa https://sistema.alunodigital.com.br/API_103/AlunoDigital/EnviaProcessoEtapa

Observações:

Json de exemplo entrada:

Json de exemplo saida:

Json de exemplo erro IP:

Criar Usuário https://sistema.alunodigital.com.br/API_103/CriarUsuario

Observações:

Json de exemplo entrada:

Json de exemplo saida:

Json de exemplo erro IP:

Cancelar Diploma https://sistema.alunodigital.com.br/API_103/AlunoDigital/CancelarDiploma

Observações:

Json de exemplo entrada:

Json de exemplo saida:

Json de exemplo erro:

Consultar Diploma https://sistema.alunodigital.com.br/API_103/AlunoDigital/ConsultarDiploma

Observações:

Json de exemplo entrada:

Json de exemplo saida:

Json de exemplo erro:

Gravar Diploma Digital https://sistema.alunodigital.com.br/API_103/AlunoDigital/GravarDiplomaDigital

Observações:

Json de exemplo entrada:

Json de exemplo saida:

Json de exemplo erro:

Gravar Documentação Acadêmica https://sistema.alunodigital.com.br/API_103/AlunoDigital/GravarDocAcademica

Observações:

Json de exemplo entrada:

Json de exemplo saida:

Json de exemplo erro:

Criar folder assinatura https://sistema.alunodigital.com.br/API_103/AlunoDigital/CriarFolderAssinatura

Observações:

Json de exemplo entrada:

Json de exemplo saida:

Json de exemplo erro:

Gerar Certificado de Pós Graduação https://sistema.alunodigital.com.br/API_103/AlunoDigital/GerarCertificadoPosGraduacao

Observações:

Json de exemplo entrada:

Json de exemplo saida:

Json de exemplo erro:

Consultar Documento https://sistema.alunodigital.com.br/API_103/ConsultarDocumento

Observações:

Json de exemplo entrada:

Json de exemplo saida:

Json de exemplo erro:

Solicitar Documento https://sistema.alunodigital.com.br/API_103/AlunoDigital/SolicitarDocumento

Observações:

Json de exemplo entrada:

Json de exemplo saida:

Json de exemplo erro: