Escolar Documentos
Profissional Documentos
Cultura Documentos
(PERFIL DO SERVIÇO)
Designação de Magistrado
DesignaçãoMagistradoService
Entidade
Versão 0.1
10/09/2015
1 INTRODUÇÃO..............................................................................................................................................6
1.1 OBJETIVO...............................................................................................................................................6
1.2 ESCOPO DO DOCUMENTO.....................................................................................................................6
1.3 REFERÊNCIAS........................................................................................................................................6
2 DESIGNACAOMAGISTRADOSERVICE V1R0......................................................................................7
2.1 IDENTIFICAÇÃO DO SERVIÇO.................................................................................................................7
2.2 ESPECIFICAÇÃO TÉCNICA.....................................................................................................................7
2.2.1 Contexto Funcional........................................................................................................................7
2.2.2 Capacidades do Serviço...............................................................................................................9
2.2.3 Tipologia..........................................................................................................................................9
2.2.4 Contrato...........................................................................................................................................9
2.2.5 Descrição da Lógica (opcional)...................................................................................................9
2.2.6 Estruturas de Dados....................................................................................................................10
2.2.7 Regras de Negócio (opcional)...................................................................................................10
2.2.8 Segurança.....................................................................................................................................10
2.2.9 Políticas de Uso...........................................................................................................................10
2.2.10 SLA............................................................................................................................................10
2.2.11 Especificações Adicionais (Não Funcionais) (opcional)...................................................11
2.2.12 Arquitetura do Serviço............................................................................................................11
2.2.13 Configuração do Serviço (Implantação)..............................................................................11
2.2.14 Dependências..........................................................................................................................11
2.2.15 Tecnologias de Implementação............................................................................................11
2.3 GOVERNANÇA......................................................................................................................................11
2.3.1 Guardião........................................................................................................................................11
2.3.2 Desenvolvedores.........................................................................................................................11
2.3.3 Contratos Concorrentes..............................................................................................................11
2.3.4 Histórico de Versões...................................................................................................................11
2.3.5 Consumidores Conhecidos........................................................................................................11
3 CAPACIDADES..........................................................................................................................................12
3.1 CONSULTAR..........................................................................................................................................12
3.1.1 Identificação...................................................................................................................................12
3.1.2 Entrada...........................................................................................................................................12
3.1.3 Tipo de Retorno..............................................................................................................................12
3.1.4 Saída...............................................................................................................................................12
3.1.5 Descrição da Lógica (opcional).....................................................................................................12
3.1.6 Versão (opcional)...........................................................................................................................12
3.2 PESQUISAR...........................................................................................................................................13
3.2.1 Identificação...................................................................................................................................13
3.2.2 Entrada...........................................................................................................................................13
3.2.3 Tipo de Retorno..............................................................................................................................13
3.2.4 Saída...............................................................................................................................................13
3.2.5 Descrição da Lógica (opcional).....................................................................................................13
3.2.6 Versão (opcional)...........................................................................................................................14
3.3 INSERIR.................................................................................................................................................15
3.3.1 Identificação...................................................................................................................................15
3.3.2 Entrada...........................................................................................................................................15
3.3.3 Tipo de Retorno..............................................................................................................................15
3.3.4 Saída...............................................................................................................................................15
3.3.5 Descrição da Lógica (opcional).....................................................................................................15
3.3.6 Versão (opcional)...........................................................................................................................15
3.4 ALTERARSTATUS..................................................................................................................................16
3.4.1 Identificação...................................................................................................................................16
3.4.2 Entrada...........................................................................................................................................16
3.4.3 Tipo de Retorno..............................................................................................................................16
3.4.4 Saída...............................................................................................................................................16
3.4.5 Descrição da Lógica (opcional).....................................................................................................16
3.4.6 Versão (opcional)...........................................................................................................................16
3.5 INSERIRPUBLICACAO...........................................................................................................................17
3.5.1 Identificação...................................................................................................................................17
3.5.2 Entrada...........................................................................................................................................17
3.5.3 Tipo de Retorno..............................................................................................................................17
3.5.4 Saída...............................................................................................................................................17
3.5.5 Descrição da Lógica (opcional).....................................................................................................17
3.5.6 Versão (opcional)...........................................................................................................................17
3.6 ALTERARINSTITUTO..............................................................................................................................18
3.6.1 Identificação...................................................................................................................................18
3.6.2 Entrada...........................................................................................................................................18
3.6.3 Tipo de Retorno..............................................................................................................................18
3.6.4 Saída...............................................................................................................................................18
3.6.5 Descrição da Lógica (opcional).....................................................................................................18
3.6.6 Versão (opcional)...........................................................................................................................18
3.7 ALTERARPERIODO................................................................................................................................19
3.7.1 Identificação...................................................................................................................................19
3.7.2 Entrada...........................................................................................................................................19
3.7.3 Tipo de Retorno..............................................................................................................................19
3.7.4 Saída...............................................................................................................................................19
3.7.5 Descrição da Lógica (opcional).....................................................................................................19
3.7.6 Versão (opcional)...........................................................................................................................19
3.8 ALTERAROBSERVACOES......................................................................................................................20
3.8.1 Identificação...................................................................................................................................20
3.8.2 Entrada...........................................................................................................................................20
3.8.3 Tipo de Retorno..............................................................................................................................20
3.8.4 Saída...............................................................................................................................................20
3.8.5 Descrição da Lógica (opcional).....................................................................................................20
3.8.6 Versão (opcional)...........................................................................................................................20
3.9 ALTERAR...............................................................................................................................................21
3.9.1 Identificação...................................................................................................................................21
3.9.2 Entrada...........................................................................................................................................21
3.9.3 Tipo de Retorno..............................................................................................................................21
3.9.4 Saída...............................................................................................................................................21
3.9.5 Descrição da Lógica (opcional).....................................................................................................21
3.9.6 Versão (opcional)...........................................................................................................................21
3.10 CANCELAR............................................................................................................................................22
3.10.1 Identificação..............................................................................................................................22
3.10.2 Entrada......................................................................................................................................22
3.10.3 Tipo de Retorno..........................................................................................................................22
3.10.4 Saída..........................................................................................................................................22
3.10.5 Descrição da Lógica (opcional)................................................................................................22
3.10.6 Versão (opcional).......................................................................................................................22
3.11 INTERROMPER......................................................................................................................................23
3.11.1 Identificação..............................................................................................................................23
3.11.2 Entrada......................................................................................................................................23
3.11.3 Tipo de Retorno..........................................................................................................................23
3.11.4 Saída..........................................................................................................................................23
3.11.5 Descrição da Lógica (opcional)................................................................................................23
3.11.6 Versão (opcional).......................................................................................................................24
4 ANEXOS......................................................................................................................................................25
1 Introdução
1.1 Objetivo
Descrever o serviço de entidade DesignaçãoMagistradoService. Este serviço
controla as informações acerca de designações de magistrados, realizadas em
Processo de Substituição de Magistrado.
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/DesignaçãoMagistradoService_v1r0.wsdl
Afastamento de Magistrado:
AfastamentoMagistradoType, xsd/comagis/AfastamentoMagsitrado_v1r0.xsd
ProtocoloType, xsd/comagis/AfastamentoMagistrado_v1r0.xsd
Magistrado:
MatriculaType, xsd/comagis/Magistrado_v1r0.xsd
Status do Processamento:
StatusProcessamentoType, xsd/messages/StatusProcessamento_v1r0
2.2.8 Segurança
TBD
2.2.10 SLA
TBD
2.2.11 Especificações Adicionais (Não Funcionais) (opcional)
TBD
2.2.14 Dependências
TBD
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
ProtocoloType (Designação de Magistrado)
3.1.4 Saída
DesignaçãoMagistradoType
3.2.2 Entrada
“Matricula” MatriculaType (Magistrado),
“DataInicio” date,
“DataFim” date,
“Status” StatusType,
“StatusPublicacao” StatusPublicacaoType,
“Instituto” InstitutoType
3.2.4 Saída
Lista de DesignaçãoMagistradoType
Pode retornar a lista vazia, caso nenhuma instância seja encontrada satisfazendo os
parâmetros da pesquisa (não gera exceção neste caso).
A pesquisa considera tanto o período indicado por “data inicial” e “data final”, quanto
por “data inicial efetiva” e “data final efetiva”.
3.3.2 Entrada
DesignaçãoMagistradoType (o elemento protocolo deverá estar ausente)
3.3.4 Saída
ProtocoloType (número de protocolo gerado para a designação inserida)
3.4.2 Entrada
“Protocolo” ProtocoloType (Designação de Magistrado),
“novoStatus” StatusType
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 (designação não encontrada)
3.5.2 Entrada
“Protocolo” ProtocoloType (Designação de Magistrado),
“Portaria” CodigoType (Portaria)
3.5.4 Saída
StatusProcessamentoType
Código: 200, Descrição: OK (alteração com sucesso)
ou
Código: 404, Descrição: Não Encontrado (designação não encontrada)
3.6.2 Entrada
“Protocolo” ProtocoloType,
“novoInstituto” InstitutoType
3.6.4 Saída
StatusProcessamentoType
Código: 200, Descrição: OK (alteração com sucesso)
ou
Código: 404, Descrição: Não Encontrado (designação não encontrada)
3.7.2 Entrada
“Protocolo” ProtocoloType,
“novoDataInicial” date,
“novoDataFinal” date
3.7.4 Saída
StatusProcessamentoType
Código: 200, Descrição: OK (alteração com sucesso)
ou
Código: 402, Descrição: Proibido
Detalhe: alteração não permitida (motivo, conforme regras abaixo)
ou
Código: 404, Descrição: Não Encontrado (designação não encontrada)
3.8.2 Entrada
“Protocolo” ProtocoloType,
“novoObservacoes” string
3.8.4 Saída
StatusProcessamentoType
Código: 200, Descrição: OK (alteração com sucesso)
ou
Código: 404, Descrição: Não Encontrado (designação não encontrada)
3.9.2 Entrada
DesignaçãoMagistradoType
3.9.4 Saída
StatusProcessamentoType
Código: 200, Descrição: OK (alteração com sucesso)
ou
Código: 402, Descrição: Proibido
Detalhe: alteração não permitida (motivo, conforme regras abaixo)
ou
Código: 404, Descrição: Não Encontrado (designação não encontrada)
3.10.2 Entrada
ProtocoloType
3.10.4 Saída
StatusProcessamentoType
Código: 200, Descrição: OK (alteração com sucesso)
ou
Código: 402, Descrição: Proibido
Detalhe: cancelamento não permitido (DataInicialEfetiva <= data atual)
ou
Código: 404, Descrição: Não Encontrado (designação não encontrada)
3.11.2 Entrada
“Protocolo” ProtocoloType (Designação de Magistrado),
“DataInicial” date,
“DataFinal” date,
“Instituto” InstitutoType (opcional, deve ser especificado se for necessário indicar o
tipo de interrupção)
3.11.4 Saída
StatusProcessamentoType
Código: 200, Descrição: OK (alteração com sucesso)
ou
Código: 402, Descrição: Proibido (quando houver conflito na interrupção)
Detalhes: (conforme regras abaixo)
ou
Código: 404, Descrição: Não Encontrado (designação não encontrada)