Documentação Técnica Projeto Webservice Produção On-line

Transcrição

1 SENAC DEPARTAMENTO NACIONAL Documentação Técnica Projeto Webservice Produção On-line Documentação Técnica versão 3

2 Documentação Técnica Projeto Webservice Produção On-line Sumário 1. INTRODUÇÃO ENDEREÇOS DO SERVIÇO AUTENTICAÇÃO RETORNO APÓS EXECUÇÃO OPERAÇÕES... 3 CARGA DE CURSO... 3 DELETAR CURSO... 7 RELATÓRIO DE CURSOS E UNIDADE... 8 RELATÓRIO DE CURSOS POR EIXO CONTROLE DO DOCUMENTO

3 1. INTRODUÇÃO O objetivo deste documento é apresentar as formas de utilização do Webservice de Produção On-line para que qualquer Departamento Regional possa consumir seus métodos. Através deste webservice o Departamento Regional poderá atualizar diariamente as informações para que sejam disponibilizadas aos usuários da ferramenta terem os dados atualizadas no apoio à tomada de decisão. 2. ENDEREÇOS DOS SERVIÇOS Para acesso a carga e deleção de cursos: Para acesso aos relatórios do curso: 3. AUTENTICAÇÃO Para utilizar qualquer um dos métodos do Webservice é necessário incluir como parâmetro o Hash que será disponibilizado para todos os Departamentos Regionais, assim poderemos identificar qual regional está acessando o método e ao mesmo tempo autenticá-lo. Desta Forma será possível verificar quais tipos de erros estão acontecendo ao auditar as informações geradas pelo Webservice. 4. RETORNO APÓS EXECUÇÃO Após invocar o serviço, será retornado um xml indicando o sucesso ou insucesso da operação. O retorno pode ter duas estruturas. Em caso de erro serão retornados dois campos, ErroMessage e ErroCode, como pode ser visto na figura abaixo: No caso de sucesso na operação o WebService irá retornar as tags referentes aos campos de retorno do método utilizado. 2

4 5. OPERAÇÕES Carga de Curso Inserir um novo curso ou alterar o curso através da chave do curso e do Hash informado. Nome da operação: CargaDeCurso Campos para utilização da operação: Campo Tipo Descrição pcontaunidade_curso pcodigo_curso Campo de identificação único de acordo com a codificação da base de Rede Física. Código do título do curso ou da categoria relacionados no cadastro de curso. pdatainicio_curso (dd/mm/aaaa) Data do início do curso. pdatafinal_curso (dd/mm/aaaa) Data de término prevista do curso. 6 - Ensino Presencial; 7- Ensino a distância que utiliza correspondência como meio de comunicação; ptipoensino_curso 8 - Ensino a distância Educação online, que utiliza internet como meio de comunicação; pcodigounidaderemota_curso pcodigotituloequivalente_curso 9 - Ensino Presencial Escola aberta de informática; 10 Certificação Profissional. Código no cadastro de Unidades Móveis. Somente para cursos classificados por categoria ppossuitecnicorelacionado_curso Preencher 0 para não e 1 para sim pcursostecnicosrelacionados Deixar em branco ppossuicertificacaointermediaria_curso Preencher 0 pcertificacoesintermediarias_cursos Deixar em branco pmodalidade_curso 1 Formação Inicial e Continuada; 3

5 ptipooferta_curso 2-Educação Profissional Técnica de Nível Médio; 3 Educação Superior 1 Integrado; 2 Concomitante; 3 Subsequente. Somente para Certificação técnica e nível médio. pchtotal_curso Carga Horária total do Curso. pchsenacexercicio_curso pchempresaexercicio_curso pstatus_curso pcodigocursoregional_curso Total de carga horária executada no Senac. Total da carga horário Executada na Empresa, Acumulada até o mês e ano de referência. C Concluído; P Em Processo. Código utilizado pelo Regional para se referir ao curso. pmunicipiosatendidos_curso pportaria_curso pdataportaria_curso pobservaçãoportaria_curso (dd/mm/aaaa) Campo a ser preenchido somente quando o curso foi desenvolvido em unidades móveis. Caso Informe mais de um, separar dados por vírgula. Número do Ato que autorizou a realização do curso de habilitação ou Especialização Técnica. Data do Ato que autorizou a realização do curso de Habilitação ou especialização técnica. Digitar observações constantes no Ato Autorizativo, se houver. panoexercicio_curso Ano de realização do curso. pdatainclusao_curso pdataalteracao_curso (dd/mm/aaaa) (dd/mm/aaaa) Data de inserção dos dados do curso no sistema acadêmico do Departamento Regional. Preencher somente em caso de Alteração de dados. Data em que a alteração foi realizada no 4

6 sistema acadêmico do Departamento Regional. pchave_curso Sequencial de cadastramento do Curso no sistema de origem. pnumerodiafunciona Número de dias de funcionamento do curso. pquantmaxima Quantidade máxima permitida de alunos, de acordo com o plano pedagógico do DR. pcheexecutadames Carga Horária Executada no mês de referência 1 Recurso PSG Programa Senac Gratuidade; 2 Recurso do Departamento Regional; 3 Recursos da empresa onde o aluno/participante trabalha; 4 Recursos do Aluno/Participante/Família; 5 Recursos Federais; 6 Recursos de outras entidades do Sistema S; 7 Recursos de ONGs; 8 Recursos Estaduais; 9 Recursos Municipais; pmodalidadepagamento_aluno 10 Recursos Privados; 11 PRONATEC Inclusão Produtiva MDS; 12 PRONATEC ProJovem MEC; 11 PRONATEC - Inclusão Produtiva MDS 12 PRONATEC ProJovem -MEC 13 PRONATEC - Secretaria Estadual de Educação - MEC 14 PRONATEC - Seguro Desemprego - MTE 15 PRONATEC - Soldado Cidadão MD 16 PRONATEC COPA - MTUR 17 PRONATEC - MINISTÉRIO DA 5

7 CULTURA 18 PRONATEC - MINISTÉRIO DA PREVIDÊNCIA SOCIAL 19 PRONATEC - MINISTÉRIO DA JUSTIÇA 20 PRONATEC - MINISTÉRIO DAS COMUNICAÇÕES 21 PRONATEC - MINISTÉRIO DO DESENVOLVIMENTO AGRÁRIO 22 - PRONATEC MARINHA E SECRETARIA DE PORTOS. 23 PRONATEC - MINISTÉRIO DO DESENVOLVIMENTO, INDÚSTRIA E COMÉRCIO EXTERIOR. 24 PRONATEC - SECRETARIA DE DIREITOS HUMANOS SOCIOEDUCATIVO PRONATEC - SECRETARIA DE DIREITOS HUMANOS - VIVER SEM LIMITE. 26 PRONATEC - INSCRIÇÃO ONLINE. 1 Em processo; 2 Aprovado; pstatusmatricula_aluno pquantidade phash 3 Reprovado; 4 Evadido; 5 Desistente; 6 Transferido; 7 Incompleto (Só poderá ser usado em curso técnico)* Quantidade de alunos no determinado status de matricula Chave de identificação do Departamento Regional no WebService. 6

8 Mensagem de Retorno Carga de Curso O sistema retornará um XML após inclusão ou alteração do registro contendo todos os registros inseridos e o seu ID, como no Exemplo abaixo: Deletar Curso Deleta o curso através da chave do curso. Nome da Operação: DeletaCurso Campos para utilização da operação: Campo Tipo Descrição pchave_curso Chave de identificação do curso. phash Chave de identificação do Departamento Regional. pmotivodelete Motivo da deleção do curso. 7

9 Mensagens de Retorno Deleção de curso O Sistema retornará um XML com os dados de do curso que foi deletado, segue o exemplo: Relatório de Cursos e Unidade Permitir a visualização de todos os cursos ativos de um determinado Departamento Regional. Nome da Operação: RelatorioCursoUnidade Campos para utilização da operação: Campo Tipo Descrição phash Chave de identificação do Departamento Regional no Webservice. 8

10 Mensagens de Retorno Relatório Unidade O Sistema retornará um XML com os dados de cada curso ativo existente na base de dados, segue o exemplo: 9

11 Relatório de Cursos por eixo Permitir a visualização de todos os cursos ativos de um determinado Departamento Regional. Nome da Operação: RelatorioCursoEixo Campos para utilização da operação: Campo Tipo Descrição Chave de identificação do phash Departamento Regional no Webservice. Mensagens de Retorno Relatório Eixo O Sistema retornará um XML com os dados de cada curso ativo existente na base de dados, segue o exemplo: 10

12 6. CONTROLE DO DOCUMENTO 6.1. Armazenamento do documento Título do documento: [Documentação Técnica] WebService Produção On-line. Localização do documento: Formato do documento: PDF Alterações Versão Descrição da mudança Modificado por Data 1 Versão inicial Carlos Mariath 17/4/ Inclusão do método de deleção Carlos Mariath 19/4/ Inclusão do método de relatório de cursos por eixo Carlos Mariath 22/4/