Escolar Documentos
Profissional Documentos
Cultura Documentos
(PERFIL DO SERVIÇO)
Portaria
PortariaService
Entidade
Versão 0.1
10/09/2015
1 INTRODUÇÃO..............................................................................................................................................5
1.1 OBJETIVO...............................................................................................................................................5
1.2 ESCOPO DO DOCUMENTO.....................................................................................................................5
1.3 REFERÊNCIAS........................................................................................................................................5
2 PORTARIASERVICE V1R0........................................................................................................................6
2.1 IDENTIFICAÇÃO DO SERVIÇO.................................................................................................................6
2.2 ESPECIFICAÇÃO TÉCNICA.....................................................................................................................6
2.2.1 Contexto Funcional........................................................................................................................6
2.2.2 Capacidades do Serviço...............................................................................................................6
2.2.3 Tipologia..........................................................................................................................................6
2.2.4 Contrato...........................................................................................................................................7
2.2.5 Descrição da Lógica (opcional)...................................................................................................7
2.2.6 Estruturas de Dados......................................................................................................................7
2.2.7 Regras de Negócio (opcional).....................................................................................................7
2.2.8 Segurança.......................................................................................................................................7
2.2.9 Políticas de Uso.............................................................................................................................7
2.2.10 SLA..............................................................................................................................................7
2.2.11 Especificações Adicionais (Não Funcionais) (opcional).....................................................7
2.2.12 Arquitetura do Serviço..............................................................................................................8
2.2.13 Configuração do Serviço (Implantação)................................................................................8
2.2.14 Dependências............................................................................................................................8
2.2.15 Tecnologias de Implementação..............................................................................................8
2.3 GOVERNANÇA........................................................................................................................................8
2.3.1 Guardião..........................................................................................................................................8
2.3.2 Desenvolvedores...........................................................................................................................8
2.3.3 Contratos Concorrentes................................................................................................................8
2.3.4 Histórico de Versões.....................................................................................................................8
2.3.5 Consumidores Conhecidos..........................................................................................................8
3 CAPACIDADES............................................................................................................................................9
3.1 CONSULTAR............................................................................................................................................9
3.1.1 Identificação.....................................................................................................................................9
3.1.2 Entrada.............................................................................................................................................9
3.1.3 Tipo de Retorno................................................................................................................................9
3.1.4 Saída.................................................................................................................................................9
3.1.5 Descrição da Lógica (opcional).......................................................................................................9
3.1.6 Versão (opcional).............................................................................................................................9
3.2 PESQUISAR...........................................................................................................................................10
3.2.1 Identificação...................................................................................................................................10
3.2.2 Entrada...........................................................................................................................................10
3.2.3 Tipo de Retorno..............................................................................................................................10
3.2.4 Saída...............................................................................................................................................10
3.2.5 Descrição da Lógica (opcional).....................................................................................................10
3.2.6 Versão (opcional)...........................................................................................................................10
3.3 INSERIR.................................................................................................................................................11
3.3.1 Identificação...................................................................................................................................11
3.3.2 Entrada...........................................................................................................................................11
3.3.3 Tipo de Retorno..............................................................................................................................11
3.3.4 Saída...............................................................................................................................................11
3.3.5 Descrição da Lógica (opcional).....................................................................................................11
3.3.6 Versão (opcional)...........................................................................................................................11
3.4 ALTERARDATAPUBLICACAO.................................................................................................................12
3.4.1 Identificação...................................................................................................................................12
3.4.2 Entrada...........................................................................................................................................12
3.4.3 Tipo de Retorno..............................................................................................................................12
3.4.4 Saída...............................................................................................................................................12
3.4.5 Descrição da Lógica (opcional).....................................................................................................12
3.4.6 Versão (opcional)...........................................................................................................................12
3.5 ALTERARPORTARIA..............................................................................................................................13
3.5.1 Identificação...................................................................................................................................13
3.5.2 Entrada...........................................................................................................................................13
3.5.3 Tipo de Retorno..............................................................................................................................13
3.5.4 Saída...............................................................................................................................................13
3.5.5 Descrição da Lógica (opcional).....................................................................................................13
3.5.6 Versão (opcional)...........................................................................................................................13
4 ANEXOS......................................................................................................................................................14
1 Introdução
1.1 Objetivo
Descrever o serviço de entidade PortariaService. Este serviço controla as
informações de Portarias elaboradas e publicadas.
1.3 Referências
- Modelo de Processo de Negócio e Modelo de Informação, Projeto COMAGIS, v2.0
de 19/08/2015.
2.2.3 Tipologia
Web Service (SOAP)
2.2.4 Contrato
wsdl/PortariaService_v1r0.wsdl
Status do Processamento:
StatusProcessamentoType, xsd/messages/StatusProcessamento_v1r0
2.2.8 Segurança
TBD
2.2.10 SLA
TBD
2.2.14 Dependências
Legado: SHF e Serviços (rotinas) de replicação SHF/Caché <-> Oracle (Schemas
core e srh).
2.3 Governança
2.3.1 Guardião
Rafael Guimarães (proprietário).
2.3.2 Desenvolvedores
[Detalha como contatar desenvolvedores do serviço, assim como outros que
contribuíram com essa documentação].
3.1 consultar
3.1.1 Identificação
3.1.2 Entrada
CodigoType
3.1.4 Saída
PortariaType
3.2.2 Entrada
“Prefixo” string,
“Ano” gYear
3.2.4 Saída
Lista de PortariaType
3.3.2 Entrada
PortariaType (o elemento número do código da portaria deverá estar ausente)
3.3.4 Saída
CodigoType (preenchido com o número gerado)
3.4.2 Entrada
“Codigo” CodigoType,
“novoDataPublicacao” date
3.4.4 Saída
StatusProcessamentoType
Código: 200, Descrição: OK (alteração com sucesso)
ou
Código: 404, Descrição: Não Encontrado (afastamento não encontrado)
3.5.2 Entrada
“PortariasAlteradas” Lista CodigoType,
“PortariaAlteracao” PortariaType (o elemento número do código da portaria deverá
estar ausente)
3.5.4 Saída
CodigoType