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

(1)

SENAC – DEPARTAMENTO NACIONAL

Documentação Técnica – Projeto

Webservice Produção On-line

(2)

1

Docu m en ta ção T écn ica – Pro jeto W eb se rv ice P ro d u ção O n -line

Documentação Técnica – Projeto Webservice

Produção On-line

Sumário

1. INTRODUÇÃO ... 2

2. ENDEREÇOS DO SERVIÇO ... 2

3. AUTENTICAÇÃO ... 2

4. RETORNO APÓS EXECUÇÃ O ... 2

5. OPERAÇÕES ... 3

CARGA DE CURSO ... 3

DELETAR CURSO ... 7

RELATÓRIO DE CURSOS E UNIDADE ... 8

RELATÓRIO DE CURSOS POR EIXO ...10

(3)

2

Docu m en ta ção Té cn ica – Pro jeto W eb se rv ice P ro d u ção O n -line 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:

http://www.producaogp.dn.senac.br/webservices/producao/WsCursos.asmx

Para acesso aos relatórios do curso:

http://www.producaogp.dn.senac.br/webservices/producao/WsRelCursos.asmx

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:

(4)

3

Docu m en ta ção T écn ica – Pro jeto W eb se rv ice P ro d u ção O n -line 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 Inteiro

Campo de identificação único de acordo com a codificação da base de Rede Física.

pCodigo_Curso Inteiro

Código do título do curso ou da categoria relacionados no cadastro de curso.

pDataInicio_Curso Texto(dd/mm/aaaa) Data do início do curso.

pDataFinal_Curso Texto(dd/mm/aaaa) Data de término prevista do curso.

pTipoEnsino_Curso Inteiro

6 - Ensino Presencial;

7- Ensino a distância que utiliza correspondência como meio de comunicação;

8 - Ensino a distância – Educação online, que utiliza internet como meio de comunicação;

9 - Ensino Presencial – Escola aberta de informática;

10 – Certificação Profissional.

pCodigoUnidadeRemota_Curso Inteiro Código no cadastro de Unidades Móveis.

pCodigoTituloEquivalente_Curso Inteiro Somente para cursos classificados por categoria

pPossuiTecnicoRelacionado_Curso Inteiro Preencher 0 para “não” e 1 para “sim”

pCursosTecnicosRelacionados Texto Deixar em branco

pPossuiCertificacaoIntermediaria_Curso Inteiro Preencher 0

pCertificacoesIntermediarias_Cursos Texto Deixar em branco

(5)

4

Docu m en ta ção Té cn ica – Pro jeto W eb se rv ice P ro d u ção O n -line

2-Educação Profissional Técnica de Nível Médio; 3 – Educação Superior pTipoOferta_Curso Inteiro 1 – Integrado; 2 – Concomitante; 3 – Subsequente.

Somente para Certificação técnica e nível médio.

pCHTotal_Curso Inteiro Carga Horária total do Curso.

pCHSenacExercicio_Curso Inteiro Total de carga horária executada no Senac.

pCHEmpresaExercicio_Curso Inteiro

Total da carga horário Executada na Empresa,

Acumulada até o mês e ano de referência.

pStatus_Curso Texto C – Concluído; P – Em Processo.

pCodigoCursoRegional_Curso Texto Código utilizado pelo Regional para se referir ao curso.

pMunicipiosAtendidos_Curso Texto

Campo a ser preenchido somente quando o curso foi desenvolvido em unidades móveis.

Caso Informe mais de um, separar dados por vírgula.

pPortaria_Curso Texto

Número do Ato que autorizou a realização do curso de habilitação ou Especialização Técnica.

pDataPortaria_Curso Texto(dd/mm/aaaa)

Data do Ato que autorizou a realização do curso de Habilitação ou

especialização técnica.

pObservaçãoPortaria_Curso Texto Digitar observações constantes no Ato Autorizativo, se houver.

pAnoExercicio_Curso Inteiro Ano de realização do curso.

pDataInclusao_Curso Texto(dd/mm/aaaa)

Data de inserção dos dados do curso no sistema acadêmico do Departamento Regional.

pDataAlteracao_Curso Texto(dd/mm/aaaa)

Preencher somente em caso de Alteração de dados.

(6)

5

sistema acadêmico do Departamento Regional.

pChave_Curso Inteiro Sequencial de cadastramento do Curso no sistema de origem.

pNumeroDiaFunciona Inteiro Número de dias de funcionamento do curso.

pQuantMaxima Inteiro

Quantidade máxima permitida de alunos, de acordo com o plano pedagógico do DR.

pCHEExecutadaMes Inteiro Carga Horária Executada no mês de referência

pModalidadePagamento_aluno Inteiro

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; 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

(7)

6

Docu m en ta ção Té cn ica – Pro jeto W eb se rv ice P ro d u ção O n -line 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. 25 - PRONATEC - SECRETARIA DE DIREITOS HUMANOS - VIVER SEM LIMITE.

26 – PRONATEC - INSCRIÇÃO ONLINE.

pStatusMatricula_aluno Inteiro 1 – Em processo; 2 – Aprovado; 3 – Reprovado; 4 – Evadido; 5 – Desistente; 6 – Transferido;

7 – Incompleto (Só poderá ser usado em curso técnico)*

pQuantidade Inteiro Quantidade de alunos no determinado status de matricula

pHash Texto Chave de identificação do

(8)

7 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:

pChave_Curso Texto Chave de identificação do curso.

pHash Texto Chave de identificação do

Departamento Regional.

(9)

8 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:

pHash Texto

(10)

9 Mensagens de Retorno Relatório Unidade

O Sistema retornará um XML com os dados de cada curso ativo existente na base de dados,

(11)

10 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:

pHash Texto

Chave de identificação do Departamento Regional no Webservice.

Mensagens de Retorno Relatório Eixo

(12)

11

Docu m en ta ção T écn ica – Pro jeto W eb se rv ice P ro d u ção O n -line 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.

6.2. Alterações

Versão Descrição da mudança Modificado por Data

1 Versão inicial Carlos Mariath 17/4/2013

2 Inclusão do método de deleção Carlos Mariath 19/4/2013

3 Inclusão do método de relatório de cursos por