DOCUMENTO DE APOIO À UTILIZAÇÃO DE WSDL (Fundos de Compensação do Trabalho)

Transcrição

1 DOCUMENTO DE APOIO À UTILIZAÇÃO DE WSDL (Funds de Cmpensaçã d Trabalh) Versã de julh de

2 Índice Índice... 2 INTRODUÇÃO... 3 OBJETIVO... 4 SEGURANÇA... 5 DESCRIÇÃO DOS WEB SERVICE... 6 Serviç Admitir Trabalhadr... 6 Elements técnics... 9 Serviç Cessar Cntrat Elements Técnics Cm Aceder

3 INTRODUÇÃO Este dcument insere-se n âmbit da Implementaçã ds Web Services (WSDL) para prmver interperabilidade entre s Sftwares de Gestã ds empregadres e Sistema de Infrmaçã ds Funds de Cmpensaçã. Está relacinad cm a dispnibilizaçã de meis que permitam a cmunicaçã as Funds de Cmpensaçã da admissã de trabalhadres ( Admitir Trabalhadr ) e a cmunicaçã de Cessaçã de Cntrat ( Cessar Cntrat ) em frmat XML, via Web. Este dcument irá send enriquecid cm nvs serviçs à medida que frem send cncluíds. 3

4 OBJETIVO Especificar as características técnicas para a adaptaçã da aplicaçã integrand s serviçs dispnibilizads. 4

5 SEGURANÇA Os serviçs serã dispnibilizads via HTTPS (One-way SSL(*)) utilizand HTTP Basic Auth na autenticaçã. A credencial de acess (Utilizadr e Passwrd) é a mesma que a utilizada para acess à platafrma nline (*)One-way SSL T establish an SSL cnnectin, the server must present a certificate t the client, but the client is nt required t present a certificate t the server. T successfully negtiate an SSL cnnectin, the client must authenticate the server, but the server accepts any client int the cnnectin. One-way SSL is cmmn n the Internet where custmers want t create secure cnnectins befre sharing persnal data. Often, clients use SSL t lg n s that the server can authenticate them. 5

6 DESCRIÇÃO DOS WEB SERVICE Serviç Admitir Trabalhadr Para prceder à cmunicaçã de nva admissã de trabalhadr as Funds de Cmpensaçã d Trabalh, serviç irá facultar a seguinte peraçã: 1. admitirtrabalhadr regista a admissã de um nv trabalhadr as funds de cmpensaçã e garantia n trabalh, utilizand para tal s seguintes parâmetrs de entrada e devlvend a seguinte infrmaçã de retrn. Parâmetrs: Niss Trabalhadr Mdalidade Cntrat [Lista pré-definida de valres ver quadr abaix] Data Iníci Cntrat Data Fim Cntrat Retribuiçã Base (Mensal) Diuturnidades (Mensal) Retrn : Sucess/Insucess Identificadr cntrat Códig Err Mensagem Err (cas se verifique insucess) Dad relevante para interpretaçã d err (se aplicável) Retrn em err (impeditiv de avançar) quand: Códig err Descriçã Err Dad relevante para interpretaçã d err 001 A data de iníci de cntrat é superir u igual a um an face à data atual 6

7 (n nline esta mensagem surge cm avis, que empregadr pde aceitar e ainda assim avançar. Através d WSDL é impeditiva de avançar) 002 A duraçã d períd cntratual é superir u igual a dis ans. (n nline esta mensagem surge cm avis, que empregadr pde aceitar e ainda assim avançar. Através d WSDL é impeditiva de avançar) 003 É necessári indicar um valr válid para a retribuiçã 004 É necessári indicar uma das seguintes mdalidades de cntrat vál idas: A - SEM TERMO, TEMPO COMPLETO B - SEM TERMO, TEMPO PARCIAL C- TRABALHO INTERMITENTE, TEMPO COMPLETO D - TRABALHO INTERMITENTE, TEMPO PARCIAL E - A TERMO CERTO, TEMPO COMPLETO F - A TERMO CERTO, TEMPO PARCIAL G - A TERMO INCERTO, TEMPO COMPLETO H - A TERMO INCERTO, TEMPO PARCIAL J - CONTRATO DE TELETRABALHO, A TEMPO COMPLETO K - CONTRATO DE TELETRABALHO, A TEMPO PARCIAL L - COMISSÃO DE SERVIÇO, A TEMPO COMPLETO M - COMISSÃO DE SERVIÇO, A TEMPO PARCIAL N - CONTRATO DE TRABALHO A TERMO CERTO PARA PRESTAÇÃO DE TRABALHO TEMPORÁRIO, A TEMPO PARCIAL 7

8 O - CONTRATO DE TRABALHO A TERMO CERTO PARA PRESTAÇÃO D E TRABALHO TEMPORÁRIO, A TEMPO COMPLETO P - CONTRATO DE TRABALHO A TERMO INCERTO PARA PRESTAÇÃO DE TRABALHO TEMPORÁRIO, A TEMPO PARCIAL Q - CONTRATO DE TRABALHO A TERMO INCERTO PARA PRESTAÇÃO DE TRABALHO TEMPORÁRIO, A TEMPO COMPLETO R - CONTRATO DE TRABALHO POR TEMPO INDETERMINADO, PARA P RESTAÇÃO DE TRABALHO TEMPORÁRIO, A TEMPO PARCIAL S - CONTRATO DE TRABALHO POR TEMPO INDETERMINADO, PARA P RESTAÇÃO DE TRABALHO TEMPORÁRIO, A TEMPO COMPLETO 005 O NISS d trabalhadr é brigatóri 006 A data de iníci d cntrat é brigatória 008 Mdalidade cntrat indicada nã pde ter data fim NISS 009 NISS inválid. Deverá ter 11 dígits 010 O Trabalhadr inserid encntra-se falecid 011 O NISS intrduzid deve crrespnder a um Trabalhadr 012 O NISS inserid encntra-se inativ. O NISS ativ crrespndente é Niss crrespndent e 013 NISS inactiv 014 NISS inexistente 8

9 015 A data de iníci de cntrat deve ser mair u igual que Trabalhadr já admitid 018 Empregadr ainda nã é Aderente as Funds de Cmpensaçã 019 A Data de Fim de Cntrat deve ser psterir u igual à Data de Iníci de Cntrat 020 O valr Retribuiçã Base (Mensal) nã pde ser zer 021 O valr Retribuiçã Base (Mensal) nã pde ser negativ 022 O valr Diuturnidades (Mensal) nã pde ser negativ 023 O períd cntratual nã pde ser cincidente cm um períd cntratual já existente 024 Nã é pssível adicinar própri empregadr cm trabalhadr Elements técnics Os parâmetrs de entrada e retrn d serviç sã implementads via data Object. De seguida sã apresentads s parâmetrs de entrada, tip de dads e requisits que s mesms devem satisfazer. Dads d acess nissempregadr lgin) (d NUMBER (11) Obrigatóri NISS cm 11 dígits e válid na Seg. Scial Dads d serviç: Parâmetr entrada Tip dads Requisits 9

10 trabalhadr NUMBER (11) Obrigatóri NISS cm 11 dígits e válid na Seg. Scial mdalidadecntrattrabalh STRING (2) Obrigatóri datainicicntrat DATE Obrigatóri Valr dentr da lista acima referida (Apenas códig A a S) Mair e menr data sistema + 1 an datafimcntrat DATE Mair que a data iníci retribuica NUMBER (10,2) Obrigatóri Obrigatóri apenas para as mdalidades que referem cntrats a term Mair que zer e menr que (nline permite registar cntrats cm retribuições mais elevadas) diuturnidades NUMBER (10,2) Tem que ser mair u igual que zer Parâmetr saída Tip dads Requisits IdentificadrCntrat NUMBER(15) 10

11 Serviç Cessar Cntrat Para prceder à cmunicaçã de data de cessaçã de um cntrat previamente cmunicad as funds de cmpensaçã d trabalh, será dispnibilizad seguinte serviç: cessarcntrat regista a data e mtiv de cessaçã de um determinad cntrat, utilizand s seguintes parâmetrs de entrada e devlvend a seguinte infrmaçã em retrn. Parâmetrs: Identificadr Cntrat Data Cessaçã Cntrat Mtiv [Lista pré-definida de valres ver tabela abaix linha 5] Retrn : Sucess/Insucess Códig Err Mensagem Err (cas se verifique insucess) Dad relevante para interpretaçã d err (se aplicável) Retrn em err (impeditiv de avançar) quand: Códig err Descriçã Err Dad relevante para interpretaçã d err 001 O identificadr d cntrat é brigatóri u nã está cm frmat válid 002 A data fim de cntrat é brigatória. "Camp brigatóri" (quand nã é preenchida a Data Cessaçã Cntrat e/u Mtiv Cessaçã para um cntrat ativ) 11

12 003 O praz máxim para a cmunicaçã da cessaçã de cntrat sã x ans x ans Quand se cessa um cntrat cm dada cessaçã superir a x ans face à data atual (à data valr de x = 2) 004 A data de cessaçã deve ser psterir u igual à data de iníci de cntrat Quand a data de cessaçã indicada, é anterir à data iníci de vigência d cntrat que se pretende cessar. 005 "É necessári indicar um mtiv de cessaçã válid. (apenas códig até 4 dígits): Lista de códigs aceite: DCDI DSDI RV DESPEDIMENTO COM DIREITO A COMPENSAÇÃO DESPEDIMENTO SEM DIREITO A COMPENSAÇÃO RESCISÃO VOLUNTÁRIA CDCI DSSI RV 006 O períd cntratual a alterar nã pde ser cincidente cm um períd cntratual já existente Quand a data de cessaçã indicada se sbrepõe (tempralmente) cm a vigência de um utr cntrat para mesm trabalhadr/empregadr 007 O cntrat indicad é inválid Quand identificadr de cntrat nã é válid. Quand cntrat nã pertence a empregadr que invca serviç. 12

13 008 Limite excedid para alteraçã de dads cntratuais Quand excede limite máxim tempral definid para permitir alterar dads d cntrat. Valr d limite tempral para alterações cntratuais 009 O cntrat indicad nã está ativ Quand é inserid um identificadr de um cntrat que está anulad. 010 O Cntrat já se encntra cessad. Cas pretenda reverter a cessaçã de cntrat deve clcar a data de fim a vazi. O estad d cntrat será alterad para ativ 011 O cntrat nã permite a cessaçã, pis tem períd (s) de Suspensã em vigr 012 O pedid de reembls já fi efetuad, pel que nã é pssível alterar s dads de cessaçã de cntrat 013 O pedid de cmpensaçã já fi efetuad, pel que nã é pssível alterar s dads de cessaçã de cntrat 018 Empregadr ainda nã é Aderente as Funds de Cmpensaçã Observações: Na invcaçã d serviç deve ser garantida, pr parte de quem invca, que a data da cessaçã é uma data válida, cas cntrári será entendida cm uma reversã da cessaçã ié, cas cntrat se encntre cessad, após a invcaçã deste serviç cm uma data inválida, mesm ficará cm a data fim sem valr preenchid. Alertas (mstrads na platafrma nline) que NÃO surgirã a quand da cmunicaçã pr WSDL 13

14 1. A cessaçã de cntrat quand realizada na platafrma nline alerta utilizadr para as seguintes situações: Pdend utilizadr ptar pr nã prsseguir cm cessaçã d cntrat e alterar a data de cessaçã indicada. Através da invcaçã deste serviç (WSDL), esta mensagem interativa nã irá surgir, assumind sistema nesta situaçã que a respsta é afirmativa, prcedend serviç a recálcul das entregas e à cessaçã d cntrat. 2. Quand se prcede à retificaçã de uma data de cessaçã de um cntrat na platafrma nline alerta utilizadr é infrmad que cntrat já se encntra cessad através da seguinte mensagem: O Cntrat já se encntra cessad Na cmunicaçã pr WSDL este alerta nã surge. 3. Para reverter a cessaçã de um cntrat (devid a uma cmunicaçã de cessaçã realizada pr engan), deve invcar-se este serviç indicand a Data Cessaçã sem valr, n entant alerta mstrad na platafrma nline, que permite a utilizadr nã avançar cm a açã, nã será mencinada neste serviç, prcedend mesm à reversã da cessaçã d cntrat. Elements Técnics Os parâmetrs de entrada e retrn d serviç sã implementads via data Object. De seguida sã apresentads s parâmetrs de entrada, tip de dads e requisits que s mesms devem satisfazer. Dads d acess nissempregadr (d lgin) NUMBER (11) Obrigatóri NISS cm 11 dígits e 14

15 válid na Seg. Scial Dads d serviç: Parâmetr entrada Tip dads Requisits IdentificadrCntrat NUMBER(15) mtivcessacacntrat STRING (4) Obrigatóri quand cntrat está ativ. datafimcntrat DATE Obrigatóri quand cntrat está ativ. Mair que a data iníci 15

16 Cm Aceder A dispnibilizaçã destes web services pderá estar sujeita a indispnibilidades prgramadas a que Institut de Infrmática se reserva direit de fazer, tend em cnta as necessidades nrmais de manutençã d Sistema de Infrmaçã. Endereçs de acess: Ambiente real Admitir Trabalhadr: Cessar Cntrat: Ambiente para testes Admitir Trabalhadr: Cessar Cntrat: Linha de api: