Web Service Plataforma Arouca
Web Service Plataforma Arouca
Documento de uso
1 Web Service Plataforma Arouca
Histórico de Revisões
Data
Seção Afetada
Histórico
01/11/13
recuperarCertificadoConcluinte()
recuperarHistoricoPorCpf()
recuperarPessoa()
1 - Exceção 2074 criada para não permitir recuperar
certificado de tipo desligamento <> 3.
2 - Incluído os atributos o tipo de item 10 e 11,
respectivamente C redenciamento com Operadora de Plano de
Saúde e Vínculo com Consultório(Atuação) devido à importação
dos dados da ANS no método recuperarHistoricoPorCpf().
3 – Incluído o atributo <Fonte> no CBO do método
recuperarPessoa().
22/05/13
cadastrarConcluintes()
recuperarHistoricoCPF()
cadastrarDesligamento()
cadastrarIngressante()
recuperarPessoa()
1-
Nova exceção foi adicionada para não permitir mais
cadastrar concluinte em curso onde o CPF tem ao menos
um registro de ingressante. (exceção 2066:
cadastrarConcluinte_Registro_Invalido )
2- O método cadastrarConcluite() agora está como
deprecated, em substituição ao novo método
cadastrarDesligamento()
3- Novo método criado: recuperarHistoricoCPF()
4- Incluído no método recuperarPessoa() o objeto
registroConselhoClasse[].
5- Controle de concorrência nos métodos de cadastros.
23/07/13
cadastrarDesligamento()
recuperarCertificadoConcluinte()
recuperarPessoa()
cadastarIngressante()
1- Removido obrigatoriedade atributo
<nomeConcluinteParaCertificado > e removido o
atributo <idCurso> do método cadastrarDesligamento().
2- Inclusão autorização de acesso através da DN do
certificado também em curso e oferta.
3- Criado nova exceção para não retornar certificados
revogados.
4- Retorno lista de Registro Conselho de Classe e CBOxxx
método recuperarPessoa()
5- Remoção da data de ingresso da Chave de duplicidade do
método cadastrarIngressante()
6- Envio automático de email de notificação de certificado
para o concluinte.
7- Não permitir cadastro de desligamento em curso de
<Nível> = “Pós-gradução” e <Modalidade> =
“Especialização em Residência Médica”
Inserido atributo <Data de Trancamento> no
cadastrarIngressante()
2 Web Service Plataforma Arouca
Sumário
Informações gerais sobre o serviço .............................................................................................................................. 5 Contexto...................................................................................................................................................................5
Objetivo ....................................................................................................................................................................5
Nome ........................................................................................................................................................................5
Endereço do arquivo WSDL .....................................................................................................................................5
Gestor do serviço ......................................................................................................................................................5
Responsável técnico .................................................................................................................................................5
Requisitos e orientações para acesso ........................................................................................................................5
Objetos de retorno ........................................................................................................................................................ 6 WSCbo .....................................................................................................................................................................6
WSCurso...................................................................................................................................................................6
WSOrgao ..................................................................................................................................................................6
WSPessoa .................................................................................................................................................................7
WSLocalOferta .........................................................................................................................................................7
WSOferta ..................................................................................................................................................................8
wsEquipe ..................................................................................................................................................................8
wsEspecialidadeResidenciaMedica ..........................................................................................................................8
wsFonte.....................................................................................................................................................................8
WSPrograma .............................................................................................................................................................8
WSExperienciaDocente ............................................................................................................................................8
wsItemHistorico........................................................................................................................................................9
wsRegistroConselhoClasse .....................................................................................................................................11
wsAtuacao ..............................................................................................................................................................11
wsCredenciamento..................................................................................................................................................11
Informações detalhadas do serviço ............................................................................................................................. 11 Nome do Serviço na interface.................................................................................................................................11
Tabela de classificação das Exceções do Web Service ..........................................................................................12
Exceções de Certificação Digital ............................................................................................................................13
Considerações gerais sobre parâmetros de entrada e/ou saída 19
Métodos do Web Service ........................................................................................................................................19
Verificar Pessoa.................................................................................................................................................19
Recuperar Pessoa ................................................................................................................................................20
Cadastrar Pessoa .................................................................................................................................................20
3 Web Service Plataforma Arouca
Recuperar Cursos ................................................................................................................................................21
Cadastrar Ingressante ..........................................................................................................................................23
Cadastrar Concluinte (Deprecated).....................................................................................................................24
Recuperar Certificado Concluinte ......................................................................................................................24
Recuperar Local de Oferta ..................................................................................................................................25
Recuperar Oferta.................................................................................................................................................26
Recuperar Historico por CPF..............................................................................................................................28
Cadastar Desligamento .......................................................................................................................................33
Referências ................................................................................................................................................................. 33 4 Web Service Plataforma Arouca
Informações gerais sobre o serviço
Contexto
O Web Service da Plataforma Arouca foi criado, inicialmente, para atender às demandas da
UNA-SUS de consulta e inserção de informações relacionadas a cursos.
Objetivo
Web Service para disponibilizar informações da Plataforma Arouca.
Permitir a inclusão de dados referente a cursos, ingressantes e concluintes.
Nome
AroucaWebService
Endereço do arquivo WSDL
Ambiente de Homologação:
https://aroucad.unasus.gov.br:8443/plataformaarouca/services/AroucaWebService?wsdl
Ambiente de Produção:
https://arouca.unasus.gov.br:8443/plataformaarouca/services/AroucaWebService?wsdl
Responsável técnico
Nome: Equipe Técnica Plataforma Arouca
Contato: http://sistemas.unasus.gov.br/suporte/
Telefone: 31-34095844
Requisitos e orientações para acesso
Todos os métodos do Web Service da Plataforma Arouca são cobertos por certificado digital.
Portanto, para ter acesso a este serviço é necessário que faça uma solicitação de assinatura de
certificado conforme orientações contidas no documento “Solicitação de Certificado Digital
Arouca usando OpenSSL” ou “Solicitação de Certificado Digital Arouca usando Java” . Entre
em contato com nosso suporte para tirar dúvidas técnicas ou de instalação através do canal:
https://sistemas.unasus.gov.br/suporte/
5 Web Service Plataforma Arouca
Objetos de retorno
WSCbo
Descrição:
Classe utilizada para retornar dados do CBO (Código Brasileiro de Ocupações). Caracteriza a
atividade desempenhada pela pessoa. O CBO é obtido pelo cadastro do CNES com informação de
código e nome da ocupação.
Ex: Código: 225120
Nome: Médico Cardiologista
Atributos:
Código ( String): Código do CBO
Fonte (String): Nome da Fonte
Nome (String): Nome do CBO
Status (Integer) : Situação do CBO // 0- Ativo 1 - Inativo
WSCurso
Descrição:
Classe utilizada para retornar dados do curso. Um curso é vinculado a um órgão ofertante.
Atributos:
Id (Long): Id do Curso no banco de dados da Plataforma Arouca.
Nome (String): Nome do Curso
WSOrgao
Descrição:
Classe utilizada para retornar dados do órgão.
Atributos:
Id (Long): Id do órgão
Nome (String): Nome do órgão
Município (String): Município do órgão
WSCurso []: Array de cursos vinculados ao órgão.
6 Web Service Plataforma Arouca
WSExperienciaDocente
Descrição:
Classe utilizada para retornar as experiências docentes da pessoa
Atributos:
Código (Long): Código
Descrição (String): Descrição da experiência docente
WSPessoa
Descrição:
Classe utilizada para retornar dados da pessoa. Ela pode conter uma lista de especialidades (obtidas
a partir dos programas de residência), lista de perfis (na Plataforma Arouca. ), CBOs (Código
Brasileiro de Ocupações) e experiências como docente.
Os perfis da Plataforma Arouca estão estruturados da seguinte forma:
 Profissional de Saúde: pode ver ofertas de vagas dos cursos disponíveis na Plataforma
Arouca, registrar interesse em cursos/ofertas, visualizar e adicionar itens a seu histórico
 Gestores de órgãos ofertantes de cursos: Podem cadastrar cursos, ofertas e registrar
ingressantes, concluintes e matriculados em seus cursos/ofertas
 Gestores de órgãos integralizadores: Podem conceder títulos baseados em objetivos de
aprendizado na Plataforma Arouca.
 Gestores de órgãos de saúde: Podem ser gestores estaduais ou municipais de saúde, gestores
de estabelecimentos de saúde (como hospitais). Podem registrar demandas de treinamento
ou aperfeiçoamento de seu pessoal ou usar a plataforma para selecionar profissionais de
saúde para trabalho através de seus históricos educacional e profissional.
Atributos:
Id (Long): Id da pessoa no banco de dados.
Nome (String): Nome da pessoa
wsEspecialidadeResidenciaMedica[] : Especialidades da pessoa Ex: Obstetrícia e Ginecologia
Perfis (String[]) : Perfil da pessoa ( Atributo exibido apenas se o usuário fez ao menos uma
autenticação na Plataforma Arouca ).
wsCBO[] : Lista das ocupações da pessoa. Ex: Enfermeiro, agente de saúde pública.
wsExperienciaDocente[] : Lista das experiências como docente da pessoa . Ex: Professor de
Enfermagem.
wsConselhoRegistroClasse[]: Lista de registro do conselho de classe do profissional da saúde.
WSLocalOferta
Descrição:
Classe utilizada para retornar dados do local da oferta de um curso. Um órgão ofertante pode
7 Web Service Plataforma Arouca
oferecer cursos em pólos de educação à distância ou em outras unidades com endereço diferente
de sua sede. O local da oferta é onde o curso será realizado.
Atributos:
Id (Long): Id do Local da Oferta no banco de dados.
Nome (String): Nome do local da oferta que ofereceu o curso.
WSOrgao : Informações do órgão que ofertou o curso. Ex: UFMG
Logradouro (String): Logradouro do local de oferta do curso
Numero(String): Número do endereço
Complemento (String): Dados complementares do endereço
Bairro (String): Bairro do local da oferta
CEP (String): CEP do local da oferta
Município (String): Município do local da oferta
UF (String): UF do local da oferta
WSOferta
Descrição:
Classe utilizada para retornar dados da oferta de um curso oferecido por um órgão cadastrado.
Atributos:
ID(Long): Id da oferta no banco de dados
WSCurso: Informação do curso ofertado
WSLocalOferta: Informação do local de oferta
NumeroVagas(Long): Número de vagas oferecidas na oferta do curso
DataInicioInscricao (String): Data de início da inscrição da oferta
DataTerminoInscricao (String): Data de término da inscrição da oferta
DataInicioSelecao (String): Data de início do processo de seleção
DataTerminoSelecao (String): Data de término do processo de seleção
DataInicioMatricula (String): Data de início da matrícula no curso
DataTerminoMatricula (String): Data de termino da matrícula no curso
DataInicioRealizacao (String): Data de início da realização do curso
DataTerminoRealizacao (String): Data de término da realização do curso
wsEquipe
Descrição:
Informações sobre equipe de saúde.
Atributos:
id (long) - Id da equipe de saúde no banco de dados.
nome (string) – Nome da equipe de saúde.
8 Web Service Plataforma Arouca
wsEspecialidadeResidenciaMedica
Descrição:
Informações da especialidade de residência médica.
Atributos:
id (long)- Id cadastrado no banco de dados da especialidade de residência médica
nome (string)- Nome da especialidade.
wsFonte
Descrição:
Os dados do Arouca são de diversas fontes.
Se o item do histórico unificado foi cadastrado pelo próprio usuário então o sistema define o
padrão id =0 e Nome= “USUÁRIO”, se foi por uma fonte oficial de dados do Arouca, o sistema
envia consecutivamente o ID e nome da fonte.
Atributos:
id (long) – Id da fonte do dados do Arouca.
nome (string) – Nome da fonte.
wsPrograma
Descrição:
Programas de governo que financiam cursos.
Atributos:
id (long) - Id do programa cadastrado no banco de dados.
nome (string) - Nome do programa .
wsItemHistorico
Descrição:
Item do histórico unificado do profissional de saúde.
Atributos:
cpf (string): CPF do profissional de saúde.
nome (string): Nome do Profissional de saúde.
tipoItem (int): 1 = Conclusão de curso ou Curso em andamento, 2 = Conclusão de módulo
educacional ou Módulo em andamento, 3 = Participação em outras Atividades Educacionais, 4 =
Publicações de trabalhos, 5 = Certificado/Título concedido por orgão integralizador, 6 =
Residência medica, 7 = Vínculo com estabelecimento de saúde, 8 = Experiência docente, 9 =
9 Web Service Plataforma Arouca
Vínculo com equipes de saúde.
orgao (WSOrgao): Informações do órgão referente.
codIBGEMuncipio (string): Código IBGE do município referente.
uf (string): UF referente
fonte (wsFonte): Origem da fonte de dados do item do histórico.
dataFim (string): Texto no formato dd/mm/yyyy
dataInicio (string): Texto no formato dd/mm/yyyy
Curso (wsCurso): Informações do curso.
nível (string): Nível do curso referente.
modalidade (string): Modalidade do curso referente.
situacaoCurso (string): C = Concluído ou A = Em Andamento
modulo (string): Um módulo educacional ou módulo de ensino. E uma unidade de ensino e de
avaliação somativa.
situacaoModulo (string): C = Concluído ou A = Em Andamento
programa (wsPrograma): Programa de governo.
temas (string): Id e nomes dos temas separados por “;”. Ex (<id>-Saúde da Família; <id>Medicina
preventiva e social; etc)
numeroPublicacoes (string): Número de publicações de trabalhos na área de saúde.
urlLattes (string): url Lates
tipoAtividadeEducacional (string): P-Palestras e Eventos, G-Grupos de Estudo, A-Apoio
Educacional, V-Visitas de Supervisão, T-Apoio por telessaúde, H-Treinamento de habilidades, OOutra
tipoExperienciaDocente (string): 1- Professor, 2- Orientador, 3- Tutor a distância, 4- Tutor
presencial, 5- Preceptor, 6- Monitor, 7- Outro, 8 - Formadores, 9- Teleconsultores, 10Matriciadores, 11- Apoiadores
especialidadeResidenciaMedica (wsEspecialidadeResidenciaMedica):
situacaoResidencia (string): C = Concluído ou A = Em Andamento
nomeCertificado (string): Nome do certificado emitido por órgão integralizador.
dataCertificado ( string): Data certificado emitido por órgão integralizador.
cbo ( wsCbo): As ocupações obtidas a partir dos vínculos profissionais cadastrados. Vínculos
ativos e inativos.
cargaHoraria (int): Carga horária referente informado.
naturezaOrgaoContratante (string): 0=Não definido - 1=Administração Direta da Saúde 2=Administração Direta de Outros Órgãos - 3=Administração Indireta (Autarquias) 4=Administração Indireta (Fundação) - 5=Administração Indireta (Empresa Pública) 6=Administração Indireta
(Organização Social) - 7=Empresa - 8=Fundação Privada 9=Cooperativa - 10=Serviço Social Autônomo- 11=Entidade Beneficente sem fins lucrativos 12=Economia Mista - 13=Sindicato
existePlanoCarreira (string): S-Sim, N-Não, I-Não sei
progressaoPorAntiguidade (string): S-Sim, N-Não , I-Não sei
progressaoPorDesempenho (string): S-Sim, N-Não , I-Não sei
progressaoPorFormacao (string): S-Sim, N-Não , I-Não sei
incentivoPorDesempenho (string): - S-Sim, N-Não , I-Não sei
mecanismoIngresso ( string): S-Sim, N-Não , I-Não sei
equipe (wsEquipe): Informações de equipe de saúde
atuação (wsAtuacao): Vínculo com consultório (ANS)
credenciamento (wsCredenciamento): Credenciamento com Operadora de Plano de Saúde
10 Web Service Plataforma Arouca
wsRegistroConselhoClasse
Descrição:
Registro do conselho de classe do profissional da saúde.
Atributos:
numeroRegistro (string): Número registro
siglaConselhoProfissional (string): Sigla do conselho profissional
UF (string): UF do conselho
wsAtuacao
Descrição:
Vínculo com Consultório.
Atributos:
id (long) - Id da Atuação cadastrado no banco de dados.
nome (string) - Nome da Atuação
wsCredenciamento
Descrição:
Credenciamento com Operadora de Planos de Saúde
Atributos:
id (long) - Id do credenciamento cadastrado no banco de dados.
nome (string) - Nome do credenciamento.
Informações detalhadas do serviço
Nome do Serviço na interface
AroucaWebService
Tabela de classificação das Exceções do Web Service
Código 1050 Descrição da Exceção
EXC_CADASTRAR_INGRESSANTE_PESSOA_NAO_ENCONTRADA: O Cliente do serviço
aciona o método cadastroIngressante() do webservice e informa um CPF de uma pessoa não
cadastrada no banco de dados:
Mensagem retorno: “Pessoa não encontrada.”
1060 EXC_CADASTRARCONCLUINTE_PESSOA_NAO_ENCONTRADA: O Cliente do serviço aciona o
método cadastroConcluinte() ou cadastroDesligamento() do webservice e informa um CPF de uma
11 Web Service Plataforma Arouca
pessoa não cadastrada no banco de dados:
Mensagem retorno: “Pessoa não encontrada.”
1070 EXC_RECUPERARCERTIFICADOCONCLUITE_CONCLUINTE_NAO_ENCONTRADO: O
Cliente do serviço aciona o método recuperarCertificadoConcluinte() do webservice e informa um
CPF de uma pessoa não cadastrado como concluinte no banco de dados:
Mensagem retorno: “Concluinte não cadastrado.”
1071 EXC_RECUPERARCERTIFICADOCONCLUITE_MODELO_CERTIFICADO_NAO_ENCON
TRADO: Cliente do serviço aciona método recuperarCertificadoConcluinte() do webservice e tenta
obter o certificado de uma pessoa, no entanto, o curso não tem um modelo de certificado vinculado.
Mensagem retorno: “Não há modelo de certificado associado ao curso informado.”
1072
EXC_RECUPERARCERTIFICADOCONCLUINTE_PESSOA_NAO_ENCONTRADO: O Cliente do
serviço aciona o método recuperarCertificadoPessoa() do webservice e informa um CPF de uma
pessoa não cadastrada no banco de dados:
Mensagem retorno: “Pessoa não encontrada.”
1073 EXC_RECUPERARCERTIFICADOCONCLUITE_MODELO_CERTIFICADO_NAO_ENCON
TRADO_OFERTA: Cliente do serviço aciona método recuperarCertificadoConcluinte() do webservice
e tenta obter o certificado de uma pessoa, no entanto, o curso não tem um modelo de certificado
vinculado.
Mensagem retorno: “Não há modelo de certificado associado na oferta informado.”
2010 EXC_VERIFICAR_PESSOA_CPF_INVALIDO: O Cliente do serviço aciona o método
verificarPessoa() do webservice e informa um CPF inválido.
Mensagem retorno: “O CPF informado é inválido.”
2020 EXC_RECUPERARPESSOA_CPF_INVALIDO: O Cliente do serviço aciona o método
recuperarPessoa() do webservice e informa um CPF inválido. Mensagem retorno: “O CPF informado é inválido.”
2030 EXC_RECUPERARCURSO_UF_INVALIDO: O Cliente do serviço aciona o método
recuperarCurso() do webservice e informa uma UF inválida.
Mensagem retorno: “O Estado informado é inválido.”
2040 EXC_ CADASTRARPESSOA_ATRIBUTOS_INVALIDOS: O Cliente do serviço aciona o método
cadastrarPessoa() do webservice e informa algum atributo fora do padrão.
Mensagem retorno: Atributos fora do padrão: [CPF], [data de nascimento],[Email],[Sexo]
12 Web Service Plataforma Arouca
2041 EXC_ CADASTRARPESSOA_MUNICIPIO_INVALIDO: O Cliente do serviço aciona o método
cadastrarPessoa() do webservice e informa código do município do IBGE não válido. EX: 4546546 Mensagem retorno: “Município informado inválido.”
2050 EXC_CADASTRARINGRESSANTE_ATRIBUTOS_INVALIDOS: O Cliente do serviço aciona o
método cadastrarIngressante() do webservice e informa algum atributo fora do padrão para o cadastro.
Mensagem retorno: Atributos fora do padrão: [CPF], [DataIngresso] [DataTrancamento]
2051 EXC_ CADASTRARINGRESSANTE _OFERTA_INVALIDO: O Cliente do serviço aciona o
método cadastrarIngressante() do webservice e informa um ID de oferta inválido, ou seja, não
cadastrado no banco de dados.
Mensagem retorno: “Id de oferta inválido.”
2052
EXC_ CADASTRARINGRESSANTE_OFERTA_EXIGE_ASSINATURA: O Cliente do serviço
aciona o método cadastrarIngressante() do webservice e informa um ID de oferta que exige assinatura
digital.
Mensagem retorno: “Este cadastro não pode ser realizado, pois a oferta selecionada exige assinatura
digital”
2053
EXC_ CADASTRARINGRESSANTE_CURSO_ESPECIALIZACAO_RESIDENCIA: O Cliente do
serviço aciona o método cadastrarIngressante() do webservice e informa um ID de oferta onde o curso
é especialização de residência médica.
Mensagem retorno: “Não é permitido cadastrar ingressante em curso de especialização em residência
médica.”
2060 EXC_ CADASTRARCONCLUINTE _ATRIBUTOS_INVALIDOS: O Cliente do serviço aciona o
método cadastrarConcluinte() ou cadastrarDesligamento() do webservice e informa algum atributo
fora do padrão para o cadastro.
Mensagem retorno: “Atributos fora do padrão: [CPF], [DataConclusao]”
2061 EXC_ CADASTRARCONCLUINTE_CURSO_ INVALIDO: O Cliente do serviço aciona o método
cadastrarConcluinte() ou cadastrarDesligamento() do webservice e informa um ID do Curso inválido,
ou seja, não cadastrado no banco de dados.
Mensagem retorno: “Id do curso inválido”
2064
CADASTRARCONCLUINTE_OFERTA_EXIGE_ASSINATURA: O Cliente do serviço aciona o
método cadastrarConcluinte() ou cadastrarDesligamento() do webservice e informa um ID de oferta
que exige assinatura digital.
Mensagem retorno: “Este cadastro não pode ser realizado, pois a oferta selecionada exige assinatura
digital”.
2065
CADASTRARCONCLUINTE_CURSO_ESPECIALIZACAO_RESIDENCIA: O Cliente do serviço
aciona o método cadastrarConcluinte() ou cadastrarDesligamento() do webservice e informa um ID de
curso que é de especialização de residência médica.
Mensagem retorno: “Não é permitido desligamento em curso de especialização em residência
13 Web Service Plataforma Arouca
médica.”
2066
CADASTRARCONCLUINTE_REGISTRO_INVALIDO: O Cliente do serviço aciona o método
cadastrarConcluinte() ou cadastrarDesligamento() do webservice e informa um ID de curso e CPF que
já tem registro de ingressante.
Mensagem retorno: “Este desligamento não pode ser cadastrado com Referência = Curso, pois
existem registros de ingressante para este profissional para ofertas do curso indicado. Para cadastrar
este desligamento, mude a referência para Oferta e escolha uma oferta específica do curso em
questão..”
2070 EXC_RECUPERARCERTIFICADOCONCLUITE_ATRIBUTOS_INVALIDOS: O Cliente do
serviço aciona o método recuperarCertificadoConcluinte() do webservice e informa algum atributo
fora do padrão para a pesquisa. Mensagem retorno: “Atributos fora do padrão: [CPF], [DataConclusao].”
2071 EXC_ RECUPERARCERTIFICADOCONCLUITE_CURSO_OFERTA_INVÁLIDO: O Cliente do
serviço aciona o método recuperarCertificadoConcluinte() do webservice e informa um ID de curso
ou ID de oferta inválido para a pesquisa, ou seja, um ID não cadastrado no banco de dados.
Mensagem retorno: “Id curso/oferta inválido.”
2072
EXC_ RECUPERARCERTIFICADOCONCLUITE_REVOGADO: O Cliente do serviço aciona o
método recuperarCertificadoConcluinte() do webservice e pesquisa por um desligamento revogado no
banco de dados.
Mensagem retorno: “O certificado de conclusão foi revogado no dia <data_revogacao>.”
2074
EXC_ RECUPERARCERTIFICADOCONCLUITE_TIPONAOCONCLUINTE: O Cliente do serviço
aciona o método recuperarCertificadoConcluinte() do webservice e pesquisa por um desligamento
com tipo de desligamento <> 3.
Mensagem retorno: “Tipo de desligamento diferente de 3 (Conclusão de curso).”
20840 EXC_ RECUPERARLOCALOFERTA_LOCAL_OFERTA_INVALIDO: O Cliente do serviço
aciona o método recuperarLocalOferta() do webservice e informa um ID de oferta inválido para a
pesquisa, ou seja, um ID de Oferta não cadastrado no banco de dados.
Mensagem retorno: “Id do Local de oferta inválido”
2081 EXC_ RECUPERARLOCALOFERTA_MUNICIPIO_INVALIDO: O Cliente do serviço aciona o
método recuperarLocalOferta() do webservice e informa código do município do IBGE não válido
para a pesquisa.
Mensagem retorno: “Município informado inválido.”
2082 EXC_ RECUPERARLOCALOFERTA_UF_INVALIDO: O Cliente do serviço aciona o método
recuperarLocalOferta() do webservice e informa uma UF inexistente.
Mensagem retorno: “O Estado informado é inválido.”
14 Web Service Plataforma Arouca
2083
EXC_ RECUPERARLOCALOFERTA_ORGAO_INVALIDO: O Cliente do serviço aciona o método
recuperarLocalOferta() do webservice e informa código do órgão não válido para a pesquisa.
Mensagem retorno: “Id órgão inválido.”
2090 EXC_ RECUPERAROFERTA_CURSO_INVALIDO: O Cliente do serviço aciona o método
recuperarOferta() do webservice e informa um ID de curso inválido para a pesquisa, ou seja, um ID
de curso não cadastrado no banco de dados.
Mensagem retorno: “Id do curso inválido”
2091 EXC_RECUPERAROFERTA_OFERTA_INVALIDO: O Cliente do serviço aciona o método
recuperarOferta() do webservice e informa um ID de oferta inválido para a pesquisa, ou seja, um ID
de oferta não cadastrado no banco de dados.
Mensagem retorno: “Id da oferta inválido”.
2092
EXC_RECUPERAROFERTA_LOCAL_OFERTA_INVALIDO: O Cliente do serviço aciona o
método recuperarOferta() do webservice e informa um id local oferta inválido para a pesquisa, ou
seja, um id local oferta não cadastrado no banco de dados.
Mensagem retorno: “Id do local de oferta inválido”
20100
EXC_RECUPERARHISTORICOPORCPF_CPF_INVALIDO: O Cliente do serviço aciona o método
recuperarHistoricoPorCpf() do webservice e informa um CPF inválido.
Mensagem retorno: “O CPF informado é inválido.”
20101
EXC_RECUPERARHISTORICOPORCPF_ATRIBUTOS_INVALIDO: O Cliente do serviço aciona
o método recuperarHistoricoPorCpf() do webservice e informa um CPF inválido.
Mensagem retorno: “Atributos fora do padrão: dataUltimoPedido”
3010 EXC_VERIFICAR_PESSOA_DADOS_OBRIGATORIOS: O Cliente do serviço aciona o método
verificarPessoa() do webservice sem informar o CPF para a consulta.
Mensagem retorno: “Atributos obrigatórios não informados: cpf.”
3020
EXC_RECUPERAR_PESSOA_DADOS_OBRIGATORIOS: O Cliente do serviço aciona o método
recuperarPessoa() do WebService sem informar o CPF para a consulta.
Mensagem retorno: “Atributos obrigatórios não informados: cpf.”
3040 EXC_ CADASTRARPESSOA_DADOS_OBRIGATORIOS: O Cliente do serviço aciona o método
cadastrarPessoa() do WebService não informando os atributos obrigatórios. Mensagem retorno: Atributos obrigatórios não informados: [CPF], [Nome], [Nome da mãe] ,
[Email],[Código do Município]
3050 EXC_ CADASTRARINGRESSANTE _DADOS_OBRIGATORIOS: O Cliente do serviço aciona o
método cadastrarIngressante() do WebService não informando os atributos obrigatórios.
Mensagem retorno: Atributos obrigatórios não informados: CPF, idOferta, dataIngresso.
15 Web Service Plataforma Arouca
3060 EXC_CADASTRARCONCLUINTE_CAMPO_OBRIGATORIO_NAO_INFORMADO: O Cliente
do serviço aciona o método cadastrarConcluinte() ou cadastarDesligamento() do WebService não
informando os atributos obrigatórios. Mensagem retorno: Atributos obrigatórios não informados: CPF, idOferta, DataConclusão
3070 EXC_ RECUPERARCERTIFICADOCONCLUITE_DADOS_OBRIGATORIOS: O Cliente do
serviço aciona o método recuperarCertificadoConcluinte() do WebService não informando os
atributos obrigatórios. Mensagem retorno: “Atributos obrigatórios não informados: cpf, id do Curso, Data de Conclusão”
30100
EXC_RECUPERARHISTORICOPORCPF_DADOS_OBRIGATORIOS: O Cliente do serviço
aciona o método recuperarHistoricoPorCpf () do WebService não informando os atributos
obrigatórios.
Mensagem retorno: Atributos obrigatórios não informados: CPF..
4040 EXC_CADASTRARPESSOA_PESSOA_DUPLICADA: O Cliente do serviço aciona o método
cadastrarPessoa() do WebService e tenta cadastrar uma pessoa com CPF já cadastrado no banco de
dados. Mensagem retorno: Pessoa já cadastrada
4050 EXC_CADASTRARINGRESSANTE_INGRESSO_DUPLICADO: O Cliente do serviço aciona o
método cadastrarIngressante() do WebService e tenta cadastrar um ingressante já cadastrado no banco
de dados. Um ingressante é considerado duplicado quando há um registro com o mesmo CPF e
IdOferta. Mensagem retorno: “Ingressante já cadastrado”
4060 EXC_CADASTRARCONCLUINTE_DUPLICADO: O Cliente do serviço aciona o método
cadastrarConcluinte() ou cadastrarDesligamento() do WebService e tenta cadastrar um desligamento
já cadastrado no banco de dados. Um concluinte é considerado duplicado quando há um registro com
o mesmo CPF, DataConcluinte , IdOferta e TipoDesligamento. Mensagem retorno: “Concluinte já cadastrado”
5080 EXC_RECUPERARLOCALOFERTA_ARGUMENTO_NAO_INFORMADO: O Cliente do serviço
aciona o método recuperarLocalOferta() do WebService e tenta recuperar um local de oferta sem
informar nenhum argumento. Mensagem retorno: “Argumentos não informado”
5090 EXC_ RECUPERAROFERTA_ARGUMENTO_NAO_INFORMADO: O Cliente do serviço aciona
o método recuperarOferta() do WebService e tenta recuperar uma oferta sem informar nenhum
argumento. Mensagem retorno: “Argumentos não informado”
16 Web Service Plataforma Arouca
Exceções de Certificação Digital
Atualmente há três exceções que estão relacionadas ao certificado digital:

Certificado não encontrado: Ocorre quando não há um certificado instalado no servidor de
aplicação da Plataforma Arouca.

Certificado Inválido: Ocorre quando o certificado instalado no servidor de aplicação da
Plataforma Arouca está expirado ou inválido.

Acesso não Autorizado: Ocorre quando se tenta recuperar ou cadastrar dados de um órgão via
Web Service. Para dar autorização de acesso ao método, é necessário que o administrador da
Plataforma Arouca cadastre manualmente as informações da DN (Distinct Name) do
certificado digital no sistema. A DN de Autorizados poderá estar associada a um órgão,
curso, ou oferta. O cliente que possuir a DN no cadastro de um órgão terá permissão sobre
todos os cursos e ofertas do órgão. Em um curso terá permissão sobre o curso e todas as suas
ofertas. E em uma oferta terá permissão apenas sobre a oferta.
Código
9031 Descrição
RECUPERARCURSOS_ERRO_CERTIFICADO: O Cliente do serviço aciona o método
recuperarCursos() do WebService, no entanto, ocorre algum problema relacionado ao certificado digital
do cliente do serviço. Mensagem retorno: Erro Certificado.
9041 CADASTRARPESSOA_ERRO_CERTIFICADO: O Cliente do serviço aciona o método
cadastrarPessoa() do WebService, no entanto, ocorre algum problema relacionado ao certificado
digital do cliente do serviço. Mensagem retorno: Erro Certificado.
9040
CADASTRARPESSOA_USUARIO_NAO_AUTORIZADO: O Cliente do serviço aciona o método
cadastrarPessoa() do WebService e tenta cadastrar uma pessoa em um órgão, curso ou oferta a qual
não tenha permissão de acesso. Mensagem retorno: Acesso não autorizado
9050 CADASTRARINGRESSANTE_USUARIO_NAO_AUTORIZADO: O Cliente do serviço aciona o
método cadastrarIngressante() do WebService e tenta cadastrar um ingressante em um órgão a qual
não tenha permissão de acesso. Mensagem retorno: Acesso não autorizado
9051 CADASTRARINGRESSANTE_ERRO_CERTIFICADO: O Cliente do serviço aciona o método
cadastrarIngressante() do WebService, no entanto, ocorre algum problema relacionado ao certificado
digital do cliente do serviço. Mensagem retorno: Erro Certificado.
17 Web Service Plataforma Arouca
9060 CADASTRARCONCLUINTE_USUARIO_NAO_AUTORIZADO O Cliente do serviço aciona o
método cadastrarConcluinte() ou cadastrarDesligamento() do WebService e tenta cadastrar um
concluinte em um órgão a qual não tenha permissão de acesso. Mensagem retorno: Acesso não autorizado
9061 CADASTRARCONCLUINTE_ERRO_CERTIFICADO: O Cliente do serviço aciona o método
cadastrarConcluinte() ou cadastrarDesligamento() do WebService ocorre algum problema relacionado
ao certificado digital do cliente do serviço. Mensagem retorno: Erro Certificado.
9071 RECUPERARCERTIFICADOCONCLUINTE_ERRO_CERTIFICADO: O Cliente do serviço aciona
o método recuperarCertificadoConcluinte() do WebService ocorre algum problema relacionado ao
certificado digital do cliente do serviço. Mensagem retorno: Erro Certificado.
9070
RECUPERARCERTIFICADOCONCLUINTE_USUARIO_NAO_AUTORIZADO: O Cliente do
serviço aciona o método recuperarCertificadoConcluinte() do WebService e tenta recuperar
certificado de um usuário vinculado a um órgão a qual ele não tenha permissão de acesso. Mensagem retorno: Acesso não autorizado
9080 RECUPERARLOCALOFERTA_USUARIO_NAO_AUTORIZADO: O Cliente do serviço aciona o
método recuperarLocalOferta() do WebService pelo IdOrgão ou pelo IDLocalOferta e tenta recuperar
dados de um local de oferta de curso a qual não tem permissão de acesso. Mensagem retorno: Acesso não autorizado
9081 RECUPERARLOCALOFERTA_ERRO_CERTIFICADO: O Cliente do serviço aciona o método
recuperarLocalOferta() do WebService ocorre algum problema relacionado ao certificado digital do
cliente do serviço. Mensagem retorno: Erro Certificado.
9090 RECUPERAROFERTA_USUARIO_NAO_AUTORIZADO: O Cliente do serviço aciona o método
recuperarlOferta() do WebService e tenta recuperar dados de uma oferta de curso a qual não tem
permissão de acesso. Mensagem retorno: Acesso não autorizado
9091 RECUPERAROFERTA_ERRO_CERTIFICADO: O Cliente do serviço aciona o método
recuperarLocalOferta() do WebService ocorre algum problema relacionado ao certificado digital do
cliente do serviço. Mensagem retorno: Erro Certificado.
99011 VERIFICARPESSOA_ERRO_INESPERADO: O Cliente do serviço aciona o método
verificarPessoa() do WebService e ocorre algum erro inesperado. Mensagem retorno: Erro inesperado. Contate o suporte técnico.
99021 RECUPERARPESSOA_ERRO_INESPERADO: O Cliente do serviço aciona o método
18 Web Service Plataforma Arouca
recuperarPessoa() do WebService e ocorre algum erro inesperado.
Mensagem retorno: Erro inesperado. Contate o suporte técnico.
99031 RECUPERARCURSOS_ERRO_INESPERADO: O Cliente do serviço aciona o método
recuperarCursos() do WebService e ocorre algum erro inesperado. Mensagem retorno: Erro inesperado. Contate o suporte técnico.
99041 CADASTRARPESSOA_ERRO_INESPERADO: O Cliente do serviço aciona o método
cadastrarPessoa() do WebService e ocorre algum erro inesperado. Mensagem retorno: Erro inesperado. Contate o suporte técnico.
99051 CADASTRARINGRESSANTE_ERRO_INESPERADO: O Cliente do serviço aciona o método
cadastrarIngressante() do WebService e ocorre algum erro inesperado. Mensagem retorno: Erro inesperado. Contate o suporte técnico.
99061 CADASTRARCONCLUINTE_ERRO_INESPERADO: O Cliente do serviço aciona o método
cadastrarConcluinte() ou cadastrarDesligamento() do WebService e ocorre algum erro inesperado. Mensagem retorno: Erro inesperado. Contate o suporte técnico.
99071 RECUPERARCERTIFICADOCONCLUINTE_ERRO_INESPERADO: O Cliente do serviço aciona
o método recuperarCertificadoConcluinte() do WebService e ocorre algum erro inesperado. Mensagem retorno: Erro inesperado. Contate o suporte técnico.
99081 RECUPERARLOCALOFERTA_ERRO_INESPERADO: O Cliente do serviço aciona o método
recuperarLocalOferta() do WebService e ocorre algum erro inesperado. Mensagem retorno: Erro inesperado. Contate o suporte técnico.
99091 RECUPERAROFERTA_ERRO_INESPERADO: O Cliente do serviço aciona o método
recuperarOferta() do WebService e ocorre algum erro inesperado. Mensagem retorno: Erro inesperado. Contate o suporte técnico.
99101 RECUPERARHISTORICOUNIFICADO_ERRO_INESPERADO: O Cliente do serviço aciona o
método recuperarHistoricoporCPF() do WebService e ocorre algum erro inesperado. Mensagem retorno: Erro inesperado. Contate o suporte técnico.
Considerações gerais sobre parâmetros de entrada e/ou saída
Os retornos dos métodos de recuperar dados do Web Service estão em formato de array[] de uma
classe ou um único item de uma classe. Caso uma pesquisa não encontre informação, o sistema
retorna o array ou o item como vazio.
19 Web Service Plataforma Arouca
Métodos do Web Service
1 Verificar Pessoa
Descrição:
Verifica se uma pessoa está cadastrada na Plataforma Arouca através de um CPF.
Método:
boolean verificarPessoa( String CPF )
Parâmetro de entrada:
Parâmetro
CPF
Tipo
String
Observações
CPF da pessoa (campo obrigatório) ex: 52553472137
Parâmetro de saída:
Parâmetro
Return
Tipo
Boolean
Observações
Se não existir, Web Service retorna “false” (Não cadastrado)
Se existir, Web Service retorna “true” (Cadastrado)
2 - Recuperar Pessoa
Descrição:
Recupera uma pessoa cadastrada na Plataforma Arouca com sua lista de especialidades, perfis,
CBOs e registro conselho de classe, caso possua. Os CBOs exibidos estão relacionados a todos
os estabelecimentos de saúde onde o profissional obteve alguma experiência profissional.
Inclusive estabelecimentos de saúde onde já trabalhou. Um CBO é considerado como ativo
quando não há uma data de Término definido no histórico unificado da pessoa.
Método:
WSPessoa recuperarPessoa( String cpf)
Parâmetro de entrada:
Parâmetro
CPF
Tipo
String
Observações
CPF da pessoa (campo obrigatório) ex: 52553472137
Parâmetro de saída:
Parâmetro
Tipo
Observações
20 Web Service Plataforma Arouca
WSPessoa
Objeto
Retorna tipo WSPessoa (Ver objetos de retorno)
< WSPessoa> // Objeto de retorno WSPessoa
<Long Id>1</ Long Id > // ID da Pessoa
<String Nome> Maria de Paula</ String Nome > // Nome Pessoa
< wsEspecialidadeResidenciaMedica[]>
<string>Medicina Geral </string> // Nome Especialidade
<string>Pediatria </string>
</ wsEspecialidadeResidenciaMedica[] >
< String[] Perfis>
<string> Profissional de Saúde</string> //Perfis da Pessoa
</ String[] Perfis >
< WSCBO[]>
<String codigo>25</String codigo>
<fonte>CFM</fonte>
<String Nome> Médico Pediatra</String Nome> //CBO
<String status> 0</String status > //0 – Ativo 1 - Inativo
</ WSCBOS[]>
< wsExperienciaDocente []>
<String codigo>25</String codigo>
<String Descrição> Orientador curso tal </String Descrição>
</ wsExperienciaDocente []>
< wsRegistroConselhoClasse []>
<numeroRegistro>608714</numeroRegistro>
<siglaConselhoProfissional>CRM</siglaConselhoProfissional>
<uf>RJ</uf>
</ wsRegistroConselhoClasse []>
</ WSPessoa >
3 - Recuperar Cursos
Descrição:
Recupera os cursos vinculados aos órgãos cadastrados.
Se o cliente do serviço não informar os parâmetros de entrada, o Web Service retorna todos os
21 Web Service Plataforma Arouca
cursos dos órgãos aos quais o cliente tem permissão para acesso.
Se não houver nenhum curso cadastrado para os órgãos autorizados, o sistema retorna o array
do órgão com array de cursos vazio.
Se as informações do certificado digital do cliente não estiverem associadas a um determinado
órgão pesquisado por ele, o Web Service também retorna array de cursos vazios. Este
procedimento serve como requisito de segurança, já que não expõe informações indevidas a
quem não tem acesso.
Método:
WSOrgao[] recuperarCursos( String nomeOrgao, String sigla, String uf)
Parâmetro(s) de Entrada:
Parâmetro
nomeOrgao
Tipo
String
Observações
Nome do órgão (campo opcional)
Sigla
String
Sigla do órgão (campo opcional)
UF
String
UF do órgão (campo opcional) Ex: MG
Uma pesquisa feita somente com este parâmetro, retorna uma lista
vazia caso não haja órgão com autorização para acesso vinculado.
Também ocorre caso a UF não tenha um órgão cadastrado.
Parâmetro de Saída:
Parâmetro
WSOrgão
Tipo
Objeto[ ]
Observações
Retorna tipo WSOrgão (Ver objetos de retorno)
<Array WSOrgao> // Lista de órgãos
<Array WSCursos> //Lista de cursos
<long_id>1</int_id> //ID do curso
<string_nome> Médico urologista</string_nome> //Nome curso
</Array WSCursos>
<long_id>1</long_id> //Id do órgão
<string_municipio> Cuiaba-MT</string_municipio> //Município
<string_nome> Univ. Fed. Cuiabá</string_nome> //Nome do Órgão
</Array_WSOrgão>
22 Web Service Plataforma Arouca
4 - Cadastrar Pessoa
Descrição:
Cadastra uma pessoa na Plataforma Arouca.
Método:
void cadastrarPessoa( String cpf, String nome,String nomePai, String nomeMae,
String sexo, String dataNasc, String email, String municipio)
Parâmetro(s) de Entrada:
Parâmetro
CPF
Tipo
String
Observações
CPF da pessoa (campo obrigatório) ex: 52553472137
Nome
String
Nome da pessoa (campo obrigatório)
nomePai
String
Nome do pai da pessoa (campo opcional)
nomeMae
String
Nome da mãe da pessoa (campo obrigatório)
Sexo
String
dataNascimento
String
Sexo da Pessoa ( “F”,”M”) - (campo opcional)
“F” – Feminino
“M” – Masculino
Data de nascimento da pessoa (campo opcional)
Informada no padrão: dd/mm/yyyy
Email
String
E-mail da pessoa. Sistema pode usá-lo para notificação de
certificados - (campo obrigatório) ex: [email protected]
codMunicipio
String
Código IBGE do Município (campo obrigatório) ex: 3106200
5 - Cadastrar Ingressante
Descrição:
Cadastra uma pessoa como ingressante de um curso.
Método:
void cadastrarIngressante( String cpf, Long idOferta, String dataIngresso , String
dataTrancamento )
23 Web Service Plataforma Arouca
Parâmetro(s) de Entrada:
Parâmetro
CPF
Tipo
String
Observações
CPF da pessoa (campo obrigatório). ex: 52553472137
idOferta
Long
ID da Oferta (campo obrigatório).
dataIngresso
String
Data ingresso na oferta (campo obrigatório). Formato dd/mm/aaaa
dataTrancamento
String
Data trancamento no curso (campo obrigatório). Formato
dd/mm/aaaa
6 - Cadastrar Concluinte (Deprecated)
Descrição:
Este método realiza uma chamada ao método Cadastrar Desligamento passando o tipo de
desligamento igual a "Conclusão dos requisitos acadêmicos ou titulação".
Após inserir um registro o sistema envia email automático para o usuário notificando que o
certificado dele já pode ser emitido na Plataforma Arouca. Isto quando o curso ou oferta
estiver associado a um modelo de certificado e o mesmo for configurado, na respectiva tela de
cadastro da Plataforma Arouca, para notificar ao usuário.
Método:
void cadastrarConcluinte(String cpf, Long idOferta, String dataConclusao, String
nomeConcluinteParaCertificado)
Parâmetros de Entrada:
Parâmetro
CPF
Tipo
String
Observações
CPF da pessoa (campo obrigatório). ex: 52553472137
idOferta
Long
ID da Oferta (campo obrigatório ).
dataConclusao
String
Data de conclusão no curso (campo obrigatório). Formato dd/mm/aaaa
nomeConcluinte
ParaCertificado
String
Nome do Concluinte Para Certificado
Esse é o nome que irá aparecer no certificado impresso. Se esse nome não
for informado, o sistema usará o nome contido no cadastro de pessoa.
24 Web Service Plataforma Arouca
7 - Recuperar Certificado Concluinte
Descrição:
Recupera URL para download do certificado no formato PDF de um concluinte de um curso.
Método:
String recuperarCertificadoConcluinte ( String cpf, Long idCurso, Long idOferta, String
dataConclusao )
Parâmetros de Entrada:
Parâmetro
cpf
Tipo
String
Observações
CPF da pessoa (campo obrigatório). ex: 52553472137
idCurso
Long
ID do curso (campo obrigatório).
idOferta
Long
ID do Oferta (campo obrigatório).
dataConclusao
String
Data da conclusão no curso (campo obrigatório).
Formato dd/mm/aaaa
Parâmetro de Saída:
Parâmetro
return
Tipo
String
Observações
URL para download do certificado do curso de uma pessoa.
Ex:” http://<servidor>/plataformaarouca/certificado/RecuperaCertificado?
hash=WJDKTURA-DSLVBAAA”
8 - Recuperar Local de Oferta
Descrição:
Recupera lista de locais de oferta de um órgão.
A exceção “acesso não autorizado” é disparada somente através dos argumentos idLocalOferta e
idOrgao. Se o cliente for recuperar local de oferta informando apenas os argumentos: Nome ,UF
ou Município, caso ele não tenha permissão de acesso, o retorno é uma array vazio.
Este procedimento serve como requisito de segurança, já que não expõe informações indevidas a
quem não tem acesso.
25 Web Service Plataforma Arouca
Método:
WSLocalOferta[] recuperarLocalOferta ( Long idLocalOferta, Long idOrgao , String
nome,String municipio, String uf )
Parâmetro(s) de Entrada:
Parâmetro
idLocalOferta
Tipo
Long
Observações
Id do local da Oferta (campo opcional).
idOrgão
Long
ID do órgão (campo opcional).
nome
String
Nome do local da oferta (campo opcional)
codMunicipio
String
Código IBGE do Município (campo opcional) ex: 305124
Uma pesquisa feita somente com este parâmetro, retorna uma lista
vazia caso não haja órgão com autorização de acesso vinculado ao
município. Também ocorre caso o município não tenha órgão
cadastrado.
UF
String
UF do local da oferta (campo opcional) ex: MG
Uma pesquisa feita somente com este parâmetro, retorna uma lista
vazia caso não haja órgão com autorização para acesso vinculado.
Também ocorre caso a UF não tenha um órgão cadastrado.
Parâmetro(s) de Saída:
Parâmetro
WSLocalOferta
Tipo
Objeto[ ]
Observações
Retorna tipo WSLocalOferta (Ver objetos de retorno)
<Array WSLocalOferta>
<string_bairro>Jardinopolis</string_bairro>
<string_cep>35201230</string_cep>
<long_id>1</long_id>
<string_logradouro> Rua 7</string_logradouro>
<string_municipio>Belo Horizonte</string_municipio>
<string_nome> Faculdade de Medicina</string_nome>
<string_numero>150</string_numero>
< WSOrgao>
<long_id>1</long_id>
<string_nome> Apec - Potiguar </string_nome>
</ WSOrgao>
<string_complemento> Bl02</string_complemento>
<string_uf>MG</string_uf>
26 Web Service Plataforma Arouca
</Array_ WSLocalOferta >
9 - Recuperar Oferta
Descrição:
Recupera ofertas de cursos cadastrados por um órgão na Plataforma Arouca.
Método:
WSOferta[] recuperarOferta ( Long idOferta, Long idCurso, Long idLocalOferta)
Parâmetro(s) de Entrada:
Parâmetro
idOferta
Tipo
Long
Observações
Id da Oferta (campo opcional)
idLocalOferta
Long
Id do Local da Oferta (campo opcional).
idCurso
Long
ID do curso (campo opcional).
Parâmetro de Saída:
Parâmetro
Tipo
WSOferta Objeto[ ]
Observações
Retorna tipo WSOferta (Ver objetos de retorno)
<Array WSOferta>
<WSCurso>
<long_id>2031</long_id>
<string_nome>Curso Online</string_nome>
</WSCurso>
<string_dataInicioIncricao>05/10/2011</string_dataInicioIncricao>
<string_dataInicioSelecao>05/10/2011</string_dataInicioSelecao>
<string_dataInicioMatricula>05/10/2011</string_dataInicioMatricula>
<string_dataInicioRealizacao>05/10/2011</string_dataInicioRealizacao>
<string_dataTerminoInscricao>05/10/2011</string_taTerminoInscricao>
<string_dataTerminoSelecao>05/10/2011</string_dataTerminoSelecao>
<string_dataTerminoMatricula>05/10/2011</string_taTerminoMatricula>
<string_dataTerminoRealizacao>05/10/2011</string_TerminoRealizacao>
<long_id>2009</long_id>
<WSLocalOferta>
<long_id>2004</long_id>
27 Web Service Plataforma Arouca
<string_nome>Local do Curso Online</string_nome>
</WSLocalOferta>
<long_numeroVagas>50</long_numeroVagas>
</Array WSOferta >
9 - Recuperar Histórico por CPF
Descrição:
Recupera histórico unificado cadastrados por um órgão na Plataforma Arouca.
Método:
WSOferta[]recuperarHistoricoPorCpf ( String CPF, String dataUltimoPedido)
Parâmetro(s) de Entrada:
Parâmetro
CPF
Tipo
String
Observações
CPF do profissional de saude (campo obrigatório)
dataUltimoPedido
String
Data da ultima atualização (campo opcional).
Parâmetro de Saída:
Parâmetro
wsItemHistorico
Tipo
Objeto[ ]
Observações
Retorna tipo wsItemHistorico (Ver objetos de retorno)
Tipo Item Histórico = 1
<ItemHistoricoList>
<codIBGEMuncipio>xxxxx</codIBGEMuncipio>
<cpf>xxxxxxxx</cpf>
<curso>
<id>xxx</id>
<nome>Curso tal</nome>
</curso>
<dataFim>dd/mm/aaaa</dataFim>
<dataInicio> dd/mm/aaaa </dataInicio>
<fonte>
<id>881</id>
<nome>Fonte tal</nome>
</fonte>
<modalidade>xxxx</modalidade>
28 Web Service Plataforma Arouca
<nivel>x</nivel>
<nome>Pessoa tal</nome>
<orgao>
<id>xxxx</id>
<nome>Orgao tal</nome>
</orgao>
<situacaoCurso>x</situacaoCurso>
<tipoItem>1</tipoItem>
<uf>xx</uf>
</ItemHistoricoList>
Tipo Item Histórico = 2
<ItemHistoricoList>
<codIBGEMuncipio>xxxxx</codIBGEMuncipio>
<cpf>xxxxxxxxxx</cpf>
<curso>
<id>xxx</id>
<nome>Curso tal</nome>
</curso>
<fonte>
<id>xxx</id>
<nome>Fonte tal</nome>
</fonte>
<modalidade>xxx</modalidade>
<nivel>x</nivel>
<nome>Pessoa tal </nome>
<orgao>
<id>xxxx</id>
<nome>Orgao tal</nome>
</orgao>
<situacaoCurso>C</situacaoCurso>
<temas>2 Alimentação e Nutrição;3 Atenção Primária /
Saúde da Família;</temas>
<tipoItem>1</tipoItem>
<uf>xx</uf>
</ItemHistoricoList>
Tipo Item Histórico = 3
<ItemHistoricoList>
<cargaHoraria>xx</cargaHoraria>
<codIBGEMuncipio>xxxxx</codIBGEMuncipio>
<cpf>xxxxxxxx</cpf>
<dataFim> dd/mm/aaaa </dataFim>
<dataInicio> dd/mm/aaaa </dataInicio>
<fonte>
<id>0</id>
<nome>USUARIO</nome>
29 Web Service Plataforma Arouca
</fonte>
<nome>Pessoa tal</nome>
<orgao>
<id>xxx</id>
<nome>Orgao tal </nome>
</orgao>
<temas>1 Acidentes e Violência;2 Alimentação e
Nutrição;3 </temas>
<tipoAtividadeEducacional>x</tipoAtividadeEducacional>
<tipoItem>3</tipoItem>
<uf>xx</uf>
</ItemHistoricoList>
Tipo Item Histórico = 4
<ItemHistoricoList>
<cpf>xxxxxxxxxx</cpf>
<dataFim> dd/mm/aaaa </dataFim>
<dataInicio> dd/mm/aaaa </dataInicio>
<fonte>
<id>0</id>
<nome>USUARIO</nome>
</fonte>
<nome>Pessoa tal</nome>
<numeroPublicacoes>xx</numeroPublicacoes>
<temas>1 Acidentes e Violência</temas>
<tipoItem>4</tipoItem>
<urlLattes>urllattes.com.br</urlLattes>
</ItemHistoricoList>
Tipo Item Histórico = 5
<ItemHistoricoList>
<codIBGEMuncipio>xxxx</codIBGEMuncipio>
<cpf>xxxxxxxxxxx</cpf>
<dataCertificado> dd/mm/aaaa </dataCertificado>
<fonte>
<id>0</id>
<nome>USUARIO</nome>
</fonte>
<nome>Pessoa tal</nome>
<nomeCertificado>Minha
Integralização</nomeCertificado>
<orgao>
<id>505021</id>
<nome>Órgao tal</nome>
</orgao>
30 Web Service Plataforma Arouca
<tipoItem>5</tipoItem>
<uf>xx</uf>
</ItemHistoricoList>
Tipo Item Histórico = 6
<ItemHistoricoList>
<codIBGEMuncipio>xxxxx</codIBGEMuncipio>
<cpf>xxxxxxxx</cpf>
<dataFim> dd/mm/aaaa </dataFim>
<dataInicio> dd/mm/aaaa </dataInicio>
<especialidadeResidenciaMedica>
<id>xx</id>
<nome>Cirurgia tal</nome>
</especialidadeResidenciaMedica>
<fonte>
<id>x</id>
<nome>Fonte tal </nome>
</fonte>
<nome>Pessoa tal </nome>
<orgao>
<id>xxx</id>
<nome>Orgao tal </nome>
</orgao>
<programa>
<id>xx</id>
<nome>Programa tal</nome>
</programa>
<situacaoResidencia>x</situacaoResidencia>
<tipoItem>6</tipoItem>
<uf>xx</uf>
</ItemHistoricoList>
Tipo Item Histórico = 7
<ItemHistoricoList>
<cargaHoraria>44</cargaHoraria>
<cbo>
<codigo>322205</codigo>
<nome>Técnico de enfermagem</nome>
</cbo>
<codIBGEMuncipio>420430</codIBGEMuncipio>
<cpf>03286206962</cpf>
<dataFim> dd/mm/aaaa </dataFim>
<dataInicio> dd/mm/aaaa </dataInicio>
<fonte>
<id>1</id>
<nome>Cadastro Nacional de Estabelecimentos de
Saúde</nome>
31 Web Service Plataforma Arouca
</fonte>
<naturezaOrgaoContratante>11</naturezaOrgaoContratante>
<nome>Julcelei Chiapetti Vargas</nome>
<orgao>
<id>137549</id>
<nome>BENEFICENCIA CAMILIANA DO SUL HOSPITAL SAO FRANCISCO (CNES: 2303892)</nome>
</orgao>
<tipoItem>7</tipoItem>
<uf>SC</uf>
</ItemHistoricoList>
item = 8
<ItemHistoricoList>
<codIBGEMuncipio>420540</codIBGEMuncipio>
<cpf>37065386287</cpf>
<fonte>
<id>7</id>
<nome>Universidade Federal de Santa
Catarina</nome>
</fonte>
<naturezaOrgaoContratante>10</naturezaOrgaoContratante>
<nome>Hassan Tajeddini</nome>
<orgao>
<id>5</id>
<nome>Universidade Federal de Santa
Catarina</nome>
</orgao>
<tipoExperienciaDocente>1</tipoExperienciaDocente>
<tipoItem>8</tipoItem>
<uf>SC</uf>
</ItemHistoricoList>
item= 9
<ItemHistoricoList>
<cbo>
<codigo>223116</codigo>
<nome>Médico de família e comunidade</nome>
</cbo>
<codIBGEMuncipio>250490</codIBGEMuncipio>
<cpf>79807887453</cpf>
<dataFim> dd/mm/aaaa </dataFim>
<dataInicio> dd/mm/aaaa </dataInicio>
<equipe>
<id>23091</id>
<nome>MASSANGANA III</nome>
</equipe>
32 Web Service Plataforma Arouca
<fonte>
<id>1</id>
<nome>Cadastro Nacional de Estabelecimentos de
Saúde</nome>
</fonte>
<naturezaOrgaoContratante>01</naturezaOrgaoContratante>
<nome>Michelyne de Carvalho Correia
Moreira</nome>
<orgao>
<id>87005</id>
<nome>PREFEITURA MUNICIPAL DE CRUZ DO
ESPIRITO SANTO - UNIDADE DE SAUDE DA FAMILIA
DE MASSANGANA III (CNES: 2592614)</nome>
</orgao>
<tipoItem>9</tipoItem>
<uf>PB</uf>
</ItemHistoricoList>
Item = 10
<ItemHistoricoList>
<cpf>xxxxxxxxxxx</cpf>
<credenciamento>
<id>xx</id>
<nome>Citopatologia</nome>
</credenciamento>
<dataInicio>23/06/2005</dataInicio>
<fonte>
<id>2484</id>
<nome>Agência Nacional de Saúde</nome>
</fonte>
<nome>xxxxxxxxxxxxxxx </nome>
<orgao>
<id>xxxxx</id>
<nome>Equipe ESF: PSF02 CS SANTO ANTONIO</nome>
</orgao>
<tipoItem>10</tipoItem>
</ItemHistoricoList>
Item = 11
<ItemHistoricoList>
<atuacao>
<id>XX</id>
<nome>Ginecologia e Obstetricia</nome>
</atuacao>
<cpf>xxxxxxxxxxxx</cpf>
<dataInicio>23/06/2005</dataInicio>
33 Web Service Plataforma Arouca
<fonte>
<id>xxxx</id>
< nome>Agência Nacional de Saúde</nome>
</fonte>
<nome>Therezinha de Jesus Motta Figueira</nome>
<orgao>
<id>xxxxx</id>
<nome>xxxxxxxxxxxx</nome>
</orgao>
<tipoItem>11</tipoItem>
</ItemHistoricoList>
10 - Cadastrar Desligamento
Descrição:
Cadastra o desligamento de uma pessoa do curso ou oferta do curso.
Após inserir um registro o sistema envia email automático para o usuário notificando que o
certificado dele já pode ser emitido na Plataforma Arouca. Isto acontece quando o curso ou
oferta estiver associado a um modelo de certificado, o tipo for "Conclusão dos requisitos
acadêmicos ou titulação" e o mesmo for configurado, na respectiva tela de cadastro da
Plataforma Arouca, para notificar ao usuário.
Método:
void cadastrarDesligamento(String cpf, Long idOferta , String dataConclusao, String
nomeConcluinte, String tipoDesligamento)
Parâmetros de Entrada:
CPF
Parâmetro
Tipo
String
Observações
CPF da pessoa (campo obrigatório). ex: 52553472137
idOferta
Long
Id Oferta (campo obrigatório )
dataConclusao
String
Data de conclusão no curso (campo obrigatório). Formato
dd/mm/aaaa
nomeConcluintePar
aCertificado
String
tipoDesligamento
String
Nome do Concluinte para certificado
Esse é o nome que irá aparecer no certificado impresso. Se esse
nome não for informado, o sistema usará o nome contido no cadastro
de pessoa.
Valores aceitos.
1. Abandono do curso
34 Web Service Plataforma Arouca
2. Cancelamento geral do curso
3. Conclusão dos requisitos acadêmicos ou titulação
4. Falecimento do discente
5. Mudança de nível com titulação (pós-graduação)
6. Mudança de nível sem titulação (pós-graduação)
7. Processo administrativo
Referências
http://cxf.apache.org/
35