Critical Software S.A. Especificação da Mensagem FSA FSA

Transcrição

1 Critical Software S.A. Especificação da Mensagem FSA FSA 2010 Copyright Critical Software S.A. Todos Os Direitos Reservados. REFERÊNCIA CONTRATO: N/A Código Projecto: SEGFSA Referência Doc.: Data: Páginas: 26 Estado: Acesso: Confidencial Versão: 10 SALVAGUARDA - Documento sob contrato com Associação Portuguesa de Seguradores. O trabalho descrito no presente documento foi desenvolvido sob contrato com Associação Portuguesa de Seguradores. A responsabilidade pelo seu conteúdo é do autor ou organização que o preparou. Parceiros:

2 Aprovação: Versão Revisão Nome Funções Assinatura Data Pedro Martins Gestor Técnico Autores e Contribuintes: Nome Contacto Descrição Data Pedro Martins plmartins@criticalsoftware.com Autor Roberto Cortez ra-cortez@criticalsoftware.com Revisor David Carvalho dm-carvalho@criticalsoftware.com Contribuinte Lista de Acesso Acesso Interno Equipa de Projecto Acesso Externo APS O conteúdo do presente documento é copyright da Critical Software S.A. Este documento é distribuído sob condição de não ser copiado no seu todo ou em parte, ou reproduzido de qualquer outra forma (seja por meio fotográfico ou qualquer outro meio) e o seu conteúdo não deverá ser em caso algum divulgado a qualquer pessoa ou entidade não referida nas listas de acesso interna e externa sem prévio consentimento por escrito das entidades envolvidas. Histórico de Revisões Versão Revisão Data Descrição Autor Criação Pedro Martins Versão 01 Roberto Cortez Correções à tabela da Mensagem FSA Pedro Martins Removidas mensagens de erro que não são geradas (validação por xsd): 7006, 7015,7019, Adicionadas mensagens de erro: 7039, 7040, Alteração do elemento Cobertura para permitir vários tipos de danos por cobertura (criação de elementos Danos e Dano) - Adicionada mensagem de erro Remoção do xsd da obrigatoriedade dos campos CodigoConcelho e IndemnizacaoPaga uma vez que essa obrigatoriedade é controlada por configuração na BD Atualização das configurações de input / output de ficheiros. Pedro Martins Pedro Martins Pedro Martins Pedro Martins Versão 02 Roberto Cortez 2/26

3 Alteração do elemento Caracterizacao para permitir várias não conformidades. - Adicionadas mensagens de erro 7043 e Adicionados novos elementos de localização ao Registo.xsd: - Morada - Localidade - LocalidadePostal - Latitude - Longitude Pedro Martins Pedro Martins Adicionado elemento Anexos Pedro Martins Versão 03 Pedro Martins Alteração ao tamanho do campo concelho. - Atualização de notas relativas ao campo CodigoPostal Pedro Martins Versão Remoção da percentagem de responsabilidade de terceiros envolvidos. - Criação de xsd específico para coberturas. - Adição de coberturas aos terceiros envolvidos. - Alteração de tamanho do campo Matricula - Adição de novo campo NumeroApolice - Adição de novo campo CodigoPais - Adição de IdentificadorSinistro na resposta - Atualização de tabela de mensagens de erro. Pedro Martins Versão Inclusão de operações por batch para além do processamento de mensagens. Inclusão das operações de Web Services. Pedro Martins Versão Actualização da estrutura de Mensagens do FSA David Carvalho Atualização das operações de Web Services: - Adição do método obtemanexos Pedro Martins Versão Complemento de informação do capítulo Pesquisa de Sinistros Versão Complemento de informação do capítulo Pesquisa de Sinistros (campos disponíveis no relatório) Pedro Martins Pedro Martins Versão Adição de campo para a integração com o NSA no âmbito do FNMv2 Pedro Martins Versão Atualização da lista de códigos e descrição dos erros de validação da mensagem. David Carvalho 3/26

4 Índice 1 Introdução Objectivo Audiência Acrónimos Documentos aplicáveis Estrutura Comum da Mensagem Mensagem FSA Mensagem de resposta FSA Ficheiros Processamento de mensagens Envio de Ficheiro XML Mensagem de resposta FSA Registos potencialmente duplicados Pesquisa de Sinistros Web Services Autenticação de Utilizadores Autenticação Nível Exemplo de header SOAP Autenticação Nível Exemplo de autenticação Nível Falha de autenticação Operações disponíveis Processar Registos Mensagem FSA Mensagem de resposta FSA Repetição de operações por timeout Pesquisar Sinistros Pesquisar Id Sinistros Detalhe Sinistros Obter Registos Potencialmente Duplicados Obter Registos Potencialmente Duplicados para um dia Obter Anexos Anexo A FSA.xsd Anexo B Registo.xsd Anexo C CodigoPostal.xsd Anexo D Coberturas.xsd Anexo E ErroSchema.xsd Anexo F Ficheiro XML de exemplo Anexo G Ficheiro XML de exemplo (Resposta a companhia com erro de validação de negócio) Anexo H Lista de Códigos e Descrição dos erros de validação da Mensagem Anexo I Configurações de input / output de ficheiros Anexo J FSAWebService.wsdl /26

5 1 Introdução 1.1 OBJECTIVO O presente documento apresenta a especificação da mensagem XML a ser utilizada como objecto da comunicação entre as companhias e o sistema central SEGURNET, no âmbito do módulo FSA. 1.2 AUDIÊNCIA Constitui-se como audiência deste documento todos os responsáveis pela plataforma SEGURNET, quer do lado da Critical Software, SA como da Associação Portuguesa de Seguradores. 1.3 ACRÓNIMOS Acrónimo CSW TBC APS TBD XML XSD Descrição Critical Software, SA A confirmar Associação Portuguesa de Seguradores A definir Extensible Markup Language XML Schema Definition 1.4 DOCUMENTOS APLICÁVEIS Tabela 1: Acrónimos A tabela 2 apresenta a lista de documentos aplicáveis ao presente documento. Documento aplicável Número do documento [AD-1] Especificação de Requisitos de Software Ficheiro de Sinistros Automóvel CSW-SEGFSA-2010-SRS Tabela 2: Documentos aplicáveis 5/26

6 2 Estrutura Comum da Mensagem 2.1 MENSAGEM FSA Apresenta-se de seguida um quadro resumo para facilitar a interpretação dos elementos XML que compõem as mensagens trocadas entre as companhias e a APS no âmbito do FSA. A coluna Nível indica qual o nível a que o elemento se encontra na árvore XML. O elemento raiz está no nível 0. Os elementos no nível 1 são filhos do elemento raiz e assim sucessivamente. Os atributos de cada elemento estão marcados com e seguem o mesmo esquema de numeração na coluna nível. As linhas com fundo preenchido (cor vermelha) são elementos agregadores que apenas existem uma vez por elemento pai a não ser que seja indicado o contrário. Nível Nome do Campo Descrição Tipo Tam Obg Observações 1 Registo Serve para suporte à troca de mensagens. Este elemento pode existir mais do que uma vez no elemento pai Identificador da mensagem xs:string 100 Sim 2 Cabecalho Campos chave para a Identificação do Registo 3 NumeroProcesso Número do processo de sinistro na xs:string 1-30 Sim companhia seguradora 3 Matricula Matrícula do veículo interveniente no acidente da companhia em causa. A matrícula deverá vir sempre formatada utilizando o carácter separador existente (hífen - ) onde este ocorra. Nos casos em que não existe matrícula, deve ser preechido com o número de chassis. xs:string 1-30 Sim 3 DataSinistro Data em que ocorreu o sinistro xs:date Sim YYYY-MM-DD 3 Acao Codigo da Ação pretendida xs:string 1-30 Sim 3 Motivo Codigo do Motivo pretendido xs:string 1-30 Sim 2 Caracterização Restante informação sobre o Registo 3 NumeroCartaConducao Nº da carta de condução do condutor xs:string 1-15 Sim do veículo na altura do sinistro. Caso a companhia não tenha este valor poderá utilizar um valor defeito: X NumeroSegurnet Número Segurnet Automóvel (NSA) xs:string 1-12 Sim O NSA deverá ser válido para a companhia e matrícula (chassis) indicadas, não sendo validadas datas. 3 NumeroApolice Número de apólice de seguro. xs:string 1-30 Sim 3 PercentagemResponsabilidad e Campo opcional que passa a obrigatório em situação de encerrado (quando preenchido o campo Data de Encerramento) xs:int Não Morada Local de ocorrência do Sinistro (Rua, xs:string Não estrada ) 3 Localidade Localidade de ocorrência do Sinistro xs:string Não 6/26

7 Nível Nome do Campo Descrição Tipo Tam Obg Observações 3 CodigoPostal Codigo Postal. Não é validado na tabela de códigos postais. Não é obrigatório para a validação do xsd mas o seu não preenchimento originará o retorno do erro Não existindo informação na companhia, deve ser utilizado o código Para sinistros no estrangeiro deve ser utilizado o código Codigo Número principal do Código Postal xs:string 4 Sim 4 Extensao Extensão do Código Postal xs:string 3 Sim 3 LocalidadePostal Localidade de Acordo com o Código xs:string Não Postal 3 CodigoPais Código do país de ocorrência do xs:string 1-5 Não Sinistro. Caso não esteja preenchido é assumido como sendo Portugal. 3 CodigoConcelho Código do Concelho onde ocorreu o sinistro, de acordo com tabela de concelhos do ISP. xs:string 4 Não 3 Latitude Coordenadas da latitude do sinistro xs:decimal Não a 90.0 em graus decimais 3 Longitude Coordenadas da longitude do sinistro xs:decimal Não a em graus decimais 3 NumeroTotalIntervenientes Número total de intervenientes no xs:int 1-2 Sim 1-99 acidente. Este número indica o total de intervenientes no sinistro. 3 NaoConformidades Não conformidades no sinistro 4 NaoConformidade Este elemento pode existir mais do que uma vez no elemento pai 5 CodigoNaoConformidade Código de não conformidade segundo a tabela de referência. 3 DataRecuperacao Data de recuperação de veículo roubado (Sinistro com cobertura afectada: Furto ou Roubo) 3 IndemnizacaoPaga Indicação de Indemnização paga ao segurado pela companhia seguradora. 3 DataEncerramento Data de encerramento do sinistro (a mesma data indicada ao ISP) 2 Coberturas Coberturas Afectadas no sinistro xs:string 1-2 Sim xs:date Não YYYY-MM-DD xs:string 1 Não S, N Xs:date Não YYYY-MM-DD 3 Cobertura Este elemento pode existir mais do que uma vez no elemento pai 4 CodigoCobertura Código de Cobertura afectada no sinistro, conforme tabela de referência. 4 PercentagemResponsabilidad e Percentagem de Responsabilidade por cobertura. Campo opcional que passa a obrigatório em situação de encerrado (quando preenchido o campo Data de Encerramento) 4 Danos Danos ocorridos no sinistro xs:string 1-2 Sim xs:int Não Dano Este elemento pode existir mais do que uma vez no elemento pai 6 CodigoTipoDano Código do Tipo de Dano, conforme tabela de referência de tipos de dano. 2 TerceirosEnvolvidos Terceiros envolvidos no sinistro xs: string 1-2 Sim 3 Terceiro Este elemento pode existir mais do que uma vez no elemento pai 7/26

8 Nível Nome do Campo Descrição Tipo Tam Obg Observações 4 Matricula Matricula do terceiro envolvido. Nos casos em que não existe matrícula, deve ser preechido com o número de chassis. xs:string 1-30 Sim 4 Coberturas Coberturas Afectadas no sinistro para o terceiro indicado 5 Cobertura Este elemento pode existir mais do que uma vez no elemento pai 6 CodigoCobertura Código de Cobertura afectada no sinistro, conforme tabela de referência. 6 PercentagemResponsabilidad Percentagem de Responsabilidade por e cobertura. Campo opcional. 6 Danos Danos ocorridos no sinistro xs:string 1-2 Sim xs:int Não Dano Este elemento pode existir mais do que uma vez no elemento pai 8 CodigoTipoDano Código do Tipo de Dano, conforme tabela de referência de tipos de dano. 2 Anexos Lista de anexos xs: string 1-2 Sim 3 Anexo Anexo Enviado. Este elemento pode existir mais do que uma vez no elemento pai 4 Nome Nome do ficheiro em anexo xs:string Sim 4 Descricao Breve descrição sobre o ficheiro em anexo 4 Conteudo Ficheiro em formato binário codificado em base64 que constitui um anexo xs:string Não xs: base64binary Sim 2.2 MENSAGEM DE RESPOSTA FSA Todas as mensagens FSA provenientes das companhias dão origem a uma resposta com sucesso ou insucesso. Numa mensagem de insucesso, será apresentado o código de erro e a descrição que deu origem a esta mensagem. Quando a mensagem de resposta for de sucesso, será sempre apresentado o texto Acknowledge. Os dados constantes num mensagem resposta são os mesmos da mensagem que lhe deu origem, acrescidos dos seguintes elementos Nível Nome do Campo Descrição Tipo Tam Obg Observações 2 Erros Lista de erros gerados 3 Erro Erro gerado. Este elemento pode existir mais do que uma vez no elemento pai 4 CodigoErro Código identificativo do erro xs:int Sim informado, de acordo com a tabela de Erros 4 DescricaoErro Breve descrição do erro informado xs:string Não 4 IdentificadorSinistro Identificador do Sinistro. xs:int Não 8/26

9 3 Ficheiros 3.1 PROCESSAMENTO DE MENSAGENS ENVIO DE FICHEIRO XML As companhias enviam num ficheiro XML para a APS, que são validadas pelo schema FSA.xsd. O ficheiro de resposta da APS também é validado pelo mesmo schema. Uma mensagem FSA ( <FSA> ) pode conter vários elementos do tipo <Registo> permitindo assim o envio de várias mensagem apenas num ficheiro. Estas mensagens serão processadas pela ordem em que aparecem no ficheiro XML. Nível Nome do Campo Descrição Tipo Tam Obg Observações 0 FSA Elemento raiz das mensagens do FSA 1 Cabecalho Cabecalho do ficheiro. Contém dados comuns a todas as mensagens Protocolo xs:string 3 Sim FSA Nome e extensão do ficheiro xs:string Sim Código da companhia que envia o xs:int 4 Sim ficheiro Código da companhia que recebe o xs:int 4 Sim 1000 ficheiro Data de envio do ficheiro xs:date Sim YYYY-MM-DD Numero sequencial do ficheiro xs:int Sim 1 Registo Elemento definido no capítulo Rodape Rodapé do Ficheiro Número de Registos xs:int Sim MENSAGEM DE RESPOSTA FSA Caso ocorra um erro de validação do schema do ficheiro XML recebido não haverá lugar a qualquer processamento, sendo produzida uma resposta que apenas menciona a descrição desse erro: Nível Nome do Campo Descrição Tipo Tam Obg Observações 0 FSA Elemento raiz das mensagens do FSA 1 ErroSchema Erro de schema 2 Erro Descrição do Erro de schema ocorrido xs:string Sim 2 Ficheiro Ficheiro que originou o erro de schema xs:string Sim Se o ficheiro tiver um schema válido, será produzida a respetiva resposta de acordo com o capítulo Mensagem de resposta FSA. 3.2 REGISTOS POTENCIALMENTE DUPLICADOS Diarimente será gerada uma lista de registos potencialmente duplicados para cada seguradora e será enviada via SFT para as companhias. 9/26

10 3.3 PESQUISA DE SINISTROS Será possível enviar uma listagem de matrículas, via SFT para o sistema central, que depois, com uma periodicidade diária, irá verificar a existência de listagens pendentes e efetuar uma pesquisa sobre todas as matrículas presentes na listagem, devolvendo também os resultados via SFT. Para efetuar uma pesquisa, deve ser colocado na diretoria de input do batch um ficheiro CSV com uma matrícula por linha, sendo que a primeira linha é ignorada. A convenção a usar para a nomenclatura dos ficheiros é a seguinte: FSAPS[CCCC][1000][AAAAMMDD][SSSS].csv Onde: CCCC Código ISP da seguradora que envie o ficheiro AAAAMMDD Data no formato ano, mês, dia SSSS Número sequencial Após o processamento, o sistema colocará na diretoria de output do batch um ficheiro CSV (com o mesmo nome do ficheiro original) com todos os registos encontrados para cada matrícula. Estes registos contém a seguinte informação: - Identificador - Matrícula - Data Sinistro - Seguradora - Nº Processo - Outros Intervenientes [Matrículas separadas por virgula] - Coberturas [separadas por virgula] - Conformidades [separadas por virgula] 10/26

11 4 Web Services 4.1 AUTENTICAÇÃO DE UTILIZADORES Para um utilizador ter acesso ao Web Service da Segurnet necessita de passar por uma camada de autenticação, esta feita em 2 níveis distintos: Nível 1: No header SOAP dos métodos. Nível 2: No input dos métodos disponíveis. A autenticação só é bem-sucedida se o utilizador se autenticar com sucesso nos 2 níveis de autenticação apresentados anteriormente. Os Níveis de Autenticação encontram-se descritos de seguida AUTENTICAÇÃO NÍVEL 1 Uma vez que o Web Service e todos os serviços nele implementado se encontram disponíveis a qualquer Sistema presente na Internet, é necessário garantir que estes só podem ser acedidos por utilizadores/sistemas previamente autorizados pela APS. Para isso foi implementado um Sistema de autenticação que tem por base a especificação standard Ws-Security (WSS). Nesta especificação é definido um conjunto de parâmetros a incluir no cabeçalho das mensagens SOAP enviadas ao Web Service de forma a fornecer as credenciais de acesso (username, Companhia e password) para que este possa proceder à sua correta validação e consequente autorização ou rejeição. Desta forma foi escolhida a especificação UsernameToken como forma de passagem de credenciais. De referir é o facto da especificação standard apenas definir a passagem de duas credenciais (username e password) e no caso especifico deste Web Service a autenticação é feita com base em três (username, Companhia e password). Assim, foi necessário definir uma convenção não standard para a passagem destes parâmetros que assenta na concatenação do username e do identificador da Companhia através de um carácter (código ASCII 124). Este novo campo concatenado deve então ser passado como username no campo especificado para o efeito pela especificação <wsse:username> (ver exemplo na secção B.1.1). Com o intuito de simplificar ao máximo a implementação de um cliente, não foi usado qualquer tipo de segurança adicional presente na especificação ws-security (ex. Encriptação parcial, digests de mensagens, etc.). Esta abordagem poderia comprometer a segurança do Sistema uma vez que as credenciais de autenticação circulam na internet em plain-text podendo ser intercetadas e observadas por algum utilizador mal-intencionado. No entanto, esta situação não se revela um problema uma vez que é garantida a encriptação ao nível da camada de transporte HTTP utilizando o protocolo SSL, que, só por si, já encripta todo o conteúdo do pacote e consequentemente a mensagem SOAP nele contida onde constam as credenciais Exemplo de header SOAP De forma mais prática, todas as mensagens SOAP enviadas ao servidor (independentemente do serviço a ser invocado) devem conter no seu header os parâmetros especificados pela ws-security segundo o exemplo apresentado em seguida: <soapenv:header> <wsse:security soapenv:mustunderstand="1" xmlns:wsse=" <wsse:usernametoken wsu:id="usernametoken " xmlns:wsu=" <wsse:username>username COMPANY_ID</wsse:Username> 11/26

12 <wsse:password Type=" <wsse:nonce>nonce Digest</wsse:Nonce> <wsu:created>creationtimestamp</wsu:created> </wsse:usernametoken> </wsse:security> </soapenv:header> Neste exemplo é apresentado o conteúdo de um cabeçalho de uma mensagem SOAP genérica de onde constam as credenciais de autenticação. De salientar que ao utilizar qualquer framework para clientes Web Service que seja complacente com a especificação WSSE, todo este cabeçalho é gerado de forma automática e apenas será necessário especificar os campos a negrito. É de especial importância ter em atenção que ao especificar o campo username, o programador tenha o cuidado de fornecer um campo concatenado no formato especificado (username idcompanhia). É ainda de salientar que apenas utilizadores do tipo Sistema (dessa forma configurados no módulo de gestão de utilizadores da aplicação online) poderão aceder ao nível 1 de autenticação do Web Service. Qualquer outro utilizador comum, independentemente dos perfis que possuir não poderá utilizar as suas credenciais para aceder ao Web Service neste nível AUTENTICAÇÃO NÍVEL 2 Este segundo nível de autenticação serve sobretudo para validar, ao nível do utilizador e não do Sistema, o acesso a dados confidenciais que são disponibilizados neste serviço. Deste modo é obtido o mesmo nível de auditoria que é efetuado no acesso normal via portal Segurnet.pt. Após uma autenticação efetuada com sucesso no nível 1 descrito no parágrafo anterior, é necessário que o utilizador especifique no parâmetro de input username do Web Service, um login de um utilizador. Este utilizador terá que obedecer às seguintes regras: Encontra-se em estado Ativo; Pertence à Companhia utilizada na autenticação de nível 1; Tem acesso ao protocolo BDNS na mesma Companhia ou perfil APS; Caso todas as regras sejam efetivamente cumpridas, o utilizador terá então acesso ao Web Service, caso contrário originará uma falha de autenticação, especificada no capítulo B.3. Para o método de processamento de mensagens (Error! Reference source not found. Error! Reference source not found.) a autenticação de nível 2 é executada sobre um utilizador genérico definido para a companhia, não sendo indicado o parâmetro username Exemplo de autenticação Nível 2 Apresenta-se de seguida um exemplo de invocação de um Web Service, com header de autenticação nível 1 válido e correspondente autenticação nível 2: <soapenv:envelope> <!-- Authentication Level 1 --> <soapenv:header> <wsse:security soapenv:mustunderstand="1" xmlns:wsse=" <wsse:usernametoken wsu:id="usernametoken " xmlns:wsu=" <wsse:username>username COMPANY_ID</wsse:Username> <wsse:password Type=" <wsse:nonce>nonce Digest</wsse:Nonce> <wsu:created>creationtimestamp</wsu:created> </wsse:usernametoken> 12/26

13 </wsse:security> </soapenv:header> <soapenv:body> <ws:consultadetalhesinistro > <!-- Authentication Level 2 --> <Utilizador>UserSegurnet</Utilizador> <Identificador>AB12CD34E5</Identificador> </ws:consultadetalhesinistro > </soapenv:body> </soapenv:envelope> FALHA DE AUTENTICAÇÃO No caso das credenciais fornecidas não serem válidas para aceder ao Sistema ou caso o utilizador tente aceder a um serviço que necessite de um perfil específico que ele não possui, o serviço irá retornar uma mensagem SOAP contendo uma SOAP Fault do tipo NoPermissionException. No caso das credenciais apresentadas serem válidas para o serviço invocado, este será executado, e o valor retornado na mensagem SOAP dependerá do serviço em questão. 4.2 OPERAÇÕES DISPONÍVEIS PROCESSAR REGISTOS As companhias podem enviar mensagens de criação, modificação ou eliminação de sinistros através de web services. A estrutura das mensagens é igual à definida para os carregamentos por ficheiro, com a diferença que há uma limitação de 10 mensagens por pedido. Para executar o pedido é necessário indicar a lista de mensagens a processar. A resposta é obtida imediatamente, sendo composta pela lista de mensagens enviada, cada uma acrescida da informação do resultado da mensagem (sucesso ou erro) e, no caso da criação, do identificador no sinistro na Segurnet Mensagem FSA Cada mensagem enviada por webservice é validada pelo xsd Registo.xsd (ver Mensagem FSA). A resposta da APS também é validada pelo mesmo schema. Estas mensagens serão processadas pela ordem em que aparecem no web service. Nível Nome do Campo Descrição Tipo Tam Obg Observações 0 processamensagem Método do Web Service a invocar 1 username Utilizador da companhia xs:string 1-60 Sim 1 Registo Elemento definido no capítulo Mensagem de resposta FSA Todas as mensagens serão alvo de resposta de acordo com o definido no capítulo Mensagem de resposta FSA Repetição de operações por timeout Por vezes poderão ocorrer timeouts do lado das seguradoras, tendo no entanto o processo sido corretamente inserido do lado do sistema central. Por forma a contornar essas situações, será adicionado um elemento Repeticao ao cabeçalho dos registos. Caso esse elemento esteja a true, não será efetuado processamento mas será devolvido o resultado da última execução que corresponda à matrícula, número de processo e data de sinistro em causa. 13/26

14 4.2.2 PESQUISAR SINISTROS Para efetuar uma pesquisa de sinistros através de web service poderão ser indicados os mesmos parâmetros presentes na pesquisa online. Nível Nome do Campo Descrição Tipo Tam Obg Observações 0 pesquisasinistro Método do Web Service a invocar 1 username Utilizador da companhia xs:string 1-60 Sim 1 matricula Matrícula a pesquisar xs:string 0-30 Não 1 cartaconducao Número de carta de Condução a xs:string 0-15 Não pesquisar 1 codigocobertura Código de Cobertura a pesquisar xs:string 0-4 Não 1 sinistrodesde Pesquisar sinistros ocorridos apenas após esta data (inclusive) 1 sinistroate Pesquisar sinistros ocorridos apenas até esta data (inclusive) xs:date xs:date Não Não PESQUISAR ID SINISTROS Para efetuar uma pesquisa de identificadores de sinistros através de web service poderão ser indicados os mesmos parâmetros presentes na pesquisa normal de sinistros. Nível Nome do Campo Descrição Tipo Tam Obg Observações 0 pesquisaidssinistro Método do Web Service a invocar 1 username Utilizador da companhia xs:string 1-60 Sim 1 matricula Matrícula a pesquisar xs:string 0-30 Não 1 cartaconducao Número de carta de Condução a xs:string 0-15 Não pesquisar 1 codigocobertura Código de Cobertura a pesquisar xs:string 0-4 Não 1 sinistrodesde Pesquisar sinistros ocorridos apenas após esta data (inclusive) 1 sinistroate Pesquisar sinistros ocorridos apenas até esta data (inclusive) xs:date xs:date Não Não DETALHE SINISTROS Para consultar o detalhe de um sinistro deve ser indicado o seu identificador: Nível Nome do Campo Descrição Tipo Tam Obg Observações 0 detalhesinistro Método do Web Service a invocar 1 username Utilizador da companhia xs:string 1-60 Sim 1 identificador Identificador do sinistro xs:int Sim OBTER REGISTOS POTENCIALMENTE DUPLICADOS Para obter a listagem de registos potencialmente duplicados, não é necessária a indicação de nenhum parâmetro, para além do utilizador: Nível Nome do Campo Descrição Tipo Tam Obg Observações 0 obtempotencduplicados Método do Web Service a invocar 1 username Utilizador da companhia xs:string 1-60 Sim 14/26

15 4.2.6 OBTER REGISTOS POTENCIALMENTE DUPLICADOS PARA UM DIA Para obter a listagem de registos potencialmente duplicados para um determinado dia, é necessária a indicação da data a pesquisar: Nível Nome do Campo Descrição Tipo Tam Obg Observações 0 obtempotencduplicadosdia Método do Web Service a invocar 1 username Utilizador da companhia xs:string 1-60 Sim 1 data Data a pesquisar xs:date Sim OBTER ANEXOS Para obter a listagem de anexos de um sinistro é necessário indicar o identificador do Sinistro. Adicionalmente, pode ser indicada uma matrícula e/ou uma companhia para obter os anexos de um interveniente específico. Nível Nome do Campo Descrição Tipo Tam Obg Observações 0 obtemanexos Método do Web Service a invocar 1 username Utilizador da companhia xs:string 1-60 Sim 1 identificador Identificador do sinistro xs:int Sim 1 matricula Matrícula do interveniente xs:string 1-30 Não 1 companhia Companhia do interveniente xs:int Não 15/26

16 Anexo A Anexo A FSA.xsd Ficheiro em anexo 16/26

17 Anexo B Anexo B Registo.xsd Ficheiro em anexo 17/26

18 Anexo C Anexo C CodigoPostal.xsd Ficheiro em anexo 18/26

19 Anexo D Anexo D Coberturas.xsd Ficheiro em anexo 19/26

20 Anexo E Anexo E ErroSchema.xsd Ficheiro em anexo 20/26

21 F Anexo F Ficheiro XML de exemplo Ficheiro em anexo 21/26

22 Anexo G Anexo G Ficheiro XML de exemplo (Resposta a companhia com erro de validação de negócio) Ficheiro em anexo 22/26

23 Anexo H Anexo H Lista de Códigos e Descrição dos erros de validação da Mensagem. Código Erro Descrição 0001 Não tem permissões para aceder a esta funcionalidade Erro de processamento: dados inválidos Erro de sistema, por favor tente novamente e se o erro persistir, contacte o administrador Esta mensagem não é válida no contexto do processo Processo inválido Erro de sistema, por favor tente novamente e se o erro persistir, contacte o administrador Registo não encontrado no sistema 7001 Número do Processo é um campo obrigatório Número do Processo excede o tamanho máximo Matrícula é um campo obrigatório Matrícula excede o tamanho máximo Matrícula do segurado duplicada nos intervenientes Data do sinistro não pode ser posterior à data atual Carta de Condução é um campo obrigatório Carta de condução excede o tamanho máximo Percentagem de responsabilidade inválida A Percentagem de Responsabilidade é um campo obrigatório 7012 Código Postal excede o tamanho máximo Código do Concelho é um campo obrigatório O Código do Concelho é inválido O número total de intervenientes é inválido O Código de Não Conformidade é um campo obrigatório O Código de Não Conformidade é inválido É obrigatória a indicação de pelo menos uma cobertura O código da Cobertura é um campo obrigatório O código da Cobertura é inválido O código do Tipo de Dano é um campo obrigatório O código do Tipo de Dano é inválido Percentagem de responsabilidade da cobertura inválida A Percentagem de Responsabilidade da cobertura é um campo obrigatório A matrícula do terceiro é um campo obrigatório Percentagem de responsabilidade do terceiro inválida A Percentagem de Responsabilidade dao terceiro é um campo obrigatório. 23/26

24 O número de total de intervenientes não está de acordo com as matrículas de terceiros 7031 indicadas A data de recuperação não pode ser posterior à data atual Não existe nenhuma cobertura associada à data de recuperação A data de recuperação não pode ser anterior à data do sinistro A data de encerramento não pode ser posterior à data atual A data de encerramento não pode ser anterior à data do sinistro Duplicação de matrículas nos intervenientes A matrícula do terceiro excede o tamanho máximo O registo já existe no sistema Ocorreu um erro inesperado ao validar o registo Não pode repetir códigos de Cobertura Não pode repetir códigos de Tipo de Dano para uma mesma Cobertura O Código Postal é um campo obrigatório Não pode repetir códigos de não conformidade para o mesmo sinistro Erro de Sistema Edição simultânea do sinistro. Por favor tente mais tarde A matrícula do terceiro é inválida A matrícula é inválida 7049 A Latitude excede o máximo permitido 7050 Ocorreu um erro ao copiar os anexos A longitude excede o máximo permitido Número de Carta de Condução inválido O valor de Indemnização Paga não é válido. Deve ser S/N O Número de Apólice é um campo obrigatório O Número de Apólice excede o tamanho máximo O Código do País é inválido Número da Apólice excede o tamanho máximo [Intervenientes] Não pode repetir códigos de Cobertura [Intervenientes] Não pode repetir códigos de Tipo de Dano para uma mesma Cobertura [Intervenientes] O código do Tipo de Dano é inválido [Intervenientes] O código da Cobertura é inválido [Intervenientes] O código do Tipo de Dano é um campo obrigatório [Intervenientes] O código da Cobertura é um campo obrigatório O tipo de enquadramento indicado só se aplica a sinistros encerrados O tipo de enquadramento indicado não se aplica a sinistros encerrados A Matrícula contem caracteres inválidos O Número Segurnet é um campo obrigatório Os campos Matrícula e Companhia inseridos não constam no NSA. 24/26

25 Anexo I Anexo I Configurações de input / output de ficheiros Existem vários batches de processamento de ficheiros que executam em background. Para garantir o bom funcionamento desses serviços, é necessário cumprir o seguinte esquema de directorias. Nota: Texto entre ## como ##PATH##, significa que nos estamos a referir a uma variável. Existem duas componentes variáveis: a Path que deve ser decidida aquando do deployment da aplicação no ambiente de produção, e o Company_ID que, tal como o nome indica, varia consoante a companhia que está a aceder ao sistema. Batch de processamento de apólices Path ##PATH##/FSA/##COMPANY_ID##/FI ##PATH##/FSA/##COMPANY_ID##/FE ##PATH##/FSA/##COMPANY_ID##/FP Descrição Directoria onde se deverão colocar os ficheiros para serem carregados da respectiva companhia. Directoria onde serão colocados os ficheiros de erros, sendo que esse ficheiro será sempre gerado independentemente dos registos lá contidos terem ou não erros. Directoria onde estarão os ficheiros processados. Os ficheiros de erros também estarão nesta directoria. Batch de envio de registos potencialmente duplicados Path ##PATH##/FSA/##COMPANY_ID##/PD Descrição Directoria onde serão colocados os relatórios gerados com registos potencialmente duplicados Batch de geração de estatísticas Path ##PATH##/FSA/##COMPANY_ID##/ST Descrição Directoria onde serão colocados os relatórios de estatísticas gerados. NOTA: Este relatório apenas é enviado para a APS, pelo que esta directoria apenas existirá para COMPANY_ID=1000. Batch de pesquisa de sinistros Path ##PATH##/FSA/##COMPANY_ID##/SI ##PATH##/FSA/##COMPANY_ID##/SO Descrição Directoria onde deverão ser colocados os ficheiros com a indicação das matriculas a pesquisar. Directoria onde serão colocadas as listagens de sinistros geradas. 25/26

26 Anexo J Anexo J FSAWebService.wsdl Ficheiro em anexo 26/26