Layout de Integração Webservice Layout de Integração com SIP via Webservices Versão 1.4

Transcrição

1 FIORILLI S/C SOFTWARE Layout de Integração Webservice Layout de Integração com SIP via Webservices Versão 1.4 SIP Sistema Integrado de Pessoal 18/01/2016 Este layout destina-se a troca de dados entre o SIP e qualquer mecanismo que implemente o protocolo HTTP 1.1 devidamente autenticado

2 Orientações Gerais... 3 Arquitetura... 3 Autenticação e Autorização... 3 Recursos Disponíveis... 3 Versão... 3 Este Layout... 3 Cadastro de Entidades... 3 Cadastro de Vínculos... 3 Cadastro de Cargos... 3 Cadastro de Divisões (Organograma)... 3 Cadastro de Subdivisões (Organograma)... 4 Cadastro de Unidades Orçamentárias... 4 Cadastro de Servidores... 4 Listagem de Admitidos no Período... 4 Listagem de Desligados no Período... 4 Listagem de Ativos... 4 Listagem de Servidores por Matrícula, Nome ou CPF... 4 Dados Cadastrais do Servidor pela Matrícula e Contrato ou pelo Registro... 5 Frequência... 5 Ficha Financeira... 5 Listagem de Holerites... 6 Holerite Individual... 6 MediaType... 6 Ambiente de Testes... 6

3 Orientações Gerais Arquitetura O SIPWebservices é módulo do SIPWeb e é implementado no estilo arquitetural REST. Autenticação e Autorização Para interagir com o SIPWebservices é necessário usar as credenciais (login e senha) de um usuário cadastrado no SIP e associado a um perfil que esteja autorizado a acessar cada recurso REST disponibilizado pelo serviço. Por exemplo, para receber a resposta HTTP Status 200 ao acessar a URI é necessário enviar no cabeçalho da requisição HTTP o login e a senha de um usuário que esteja associado a um perfil que tenha a opção Listar Entidade a partir do SIPWebServices. Recursos Disponíveis Versão Este recurso retorna a versão do serviço no formato texto puro. Exemplo: Este Layout Este recurso retorna o PDF deste manual. Exemplo: Cadastro de Entidades Este recurso retorna a lista de entidades. Nenhum parâmetro é necessário. Exemplo: Cadastro de Vínculos Este recurso retorna a lista de vínculos empregatícios. O parâmetro entidade é obrigatório. Exemplo para listar os vínculos da entidade 001: Cadastro de Cargos Este recurso retorna a lista de cargos. O parâmetro entidade é obrigatório. Exemplo para listar os cargos da entidade 002: Cadastro de Divisões (Organograma) Este recurso retorna a lista de divisões. O parâmetro entidade é obrigatório. Exemplo para listar as divisões da entidade 001:

4 Cadastro de Subdivisões (Organograma) Este recurso retorna a lista de subdivisões. O parâmetro entidade é obrigatório. Exemplo para listar as subdivisões da entidade 003: Cadastro de Unidades Orçamentárias Este recurso retorna a lista de unidades de custeio do exercício atual. O parâmetro entidade é obrigatório. Exemplo para listar as unidades da entidade 001: Cadastro de Servidores Este recurso retorna a lista de servidores, aposentados e pensionistas. Listagem de Admitidos no Período Os parâmetros entidade, datainicial e datafinal são obrigatórios. Exemplos para listar os servidores da entidade 001 com data de admissão entre 01/12/2013 e 31/12/2013: trabalhadores/admitidos/entidade/001/datainicial/ /datafinal/ Listagem de Desligados no Período Os parâmetros entidade, datainicial e datafinal são obrigatórios. Exemplos para listar os servidores da entidade 001 com data de desligamento entre 01/12/2013 e 31/12/2013: trabalhadores/desligados/entidade/001/datainicial/ /datafinal/ Listagem de Servidores por Matrícula, Nome ou CPF Este recurso retorna a lista de servidores conforme o atributo/valor informado. Opções para atributo são: matrícula, nome ou CPF. Exemplo para listar os servidores ativos por matrícula: matricula/ Exemplo para listar os servidores ativos por CPF: cpf/ Exemplo para listar os servidores ativos do nome Maria da Silva : maria%20da%20silva Dados Cadastrais do Servidor pela Matrícula e Contrato ou pelo Registro Este recurso retorna o cadastro completo do servidor conforme a entidade, a matrícula e contrato informado.

5 Exemplo para obter os dados cadastrais do segundo contrato da matrícula 12345: contrato/2 Exemplo para obter os dados cadastrais do trabalhador com o registro : Frequência Este recurso retorna informações de ausências. Verificação da Ausência do Trabalhador na Data Atual Este recurso verifica através do CPF a ausência do trabalhador na data atual. São verificados férias, licença prêmio, falta abonada e afastamento. Caso o trabalhador esteja ausente será retornado true caso contrário false. Exemplo de verificação do trabalhador com CPF : lhador/cpf/ Listagem de Ausências por Período Este recurso retorna uma lista de ausências da entidade no período informado. Exemplo para listar as ausências da entidade 001 no período de 01/12/2013 à 31/12/2013: /dataFinal/ Listagem de Ausências por Trabalhador e Período Este recurso retorna uma lista de ausências por trabalhador e período informados. Exemplo para listar as ausências de um trabalhador no período de 01/12/2013 à 31/12/2013: datainicial/ /datafinal/ O campo tipo se refere a: 1-Férias; 2-Afastamento; 3-Falta Abonada; 4-Licença Prêmio. O campo subtipo é a especificação do afastamento segundo os códigos da RAIS. Ficha Financeira Este recurso retorna os holerites da entidade, no ano, no mês e do tipo de folha de pagamento informado. Os tipos de folha de pagamento podem ser os códigos de 1 a 9: 1-Folha Mensal; 2-Adto. Salário; 3-Folha Complementar;

6 4-Adiantamento 13º Salário; 5-Fechamento 13º Salário; 6-Férias; 7-Rescisão; 8-Complementar de Rescisão; 9-Folha Complementar c/ Encargos. Listagem de Holerites Este recurso retorna a listagem de todos os holerites, de forma paginada com no máximo 500 registros. Exemplo para listar os holerites da folha mensal da entidade 001, do mês de julho de 2015: /mes/06/tipo/1 Holerite Individual Este recurso retorna o holerite do servidor por matrícula e contrato. Exemplo para listar os holerites da folha mensal da entidade 001, do mês de julho de 2015: /mes/06/tipo/1/matricula/12345/contrato/2 MediaType Os MediaTypes disponíveis são: Nome text/plan application/json application/xml Formato do Retorno CSV JSON XML Ambiente de Testes Para realizar testes disponibilizamos a porta 5665 no IP , online de segundafeira 07:00 a sexta-feira 19:00. Alertamos que ele pode sofrer indisponibilidades sem prévio aviso. A credencial para testes é o login testews, senha