Total de Funcionários- api/rh/v1/DashbHrTotalEmployees API responsável por retornar apenas os funcionários que utilizam o ponto eletrônico, que não foram demitidos antes do período selecionado ou os funcionários demitidos dentro do período selecionado. Ativação/Desativação da APIPor padrão esta API estará no sistema, porém será necessário realizar a devida configuração do serviço REST. Controle de AmbienteExige que os seguintes pontos sejam revisados: - Protheus com sua arquitetura devidamente estruturada.
Controle de VersãoO grupo TOTVS, representado por suas marcas, irá administrar as demandas de evolução dos layouts e demais ajustes, acordando junto aos solicitantes o prazo de liberação de release. Todas as evoluções programadas deverão ser discutidas e aprovadas pelas marcas antes do início do desenvolvimento e somente serão desenvolvidas em caso de concordância da linha Protheus. SuporteO suporte aos recursos da API será de responsabilidade da linha Protheus onde será analisada pela equipe de suporte da Totvs. Esta API traz a funcionalidade exclusivamente para trazer o total de funcionários que utilizam o ponto eletrônico, que não foram demitidos antes do período selecionado ou os funcionários demitidos dentro do período selecionado. CadastroEsta API contempla apenas a consulta do cadastro de funcionários. ProcessosO Dashboard RH realizará o consumo da API para buscar e exibir a quantidade total de funcionários que utilizam o ponto eletrônico. Como realizar a chamada da API REST- Preenchimento do EndPoint da API PONAPIDSB;
- Utilizar a chamada do método Get e do Serviço api/rh/v1/DashbHrTotalEmployees;
- Preenchimento dos parâmetros obrigatórios da API;
Internamente o Protheus identifica automaticamente o endereço do servidor REST, porém para que isso aconteça será necessário habilitar a porta multiprotocolo do Appserver. Para mais informações sobre a porta multiprotocolo acesse o link abaixo: https://tdn.totvs.com/x/jIUoI As Entradas de dados tipo data(Date) acompanham o formato padrão YYYY-MM-DD
Parâmetros de Entrada: Parâmetro | Valor de Exemplo | Obrigatório | Tipo | Parâmetro | Descrição |
---|
startDate | 2022-06-01 | Sim | Date | Query | Data inicial do período | endDate | 2022-06-30 | Sim | Date | Query | Data final do período | filial | D MG 01 ou todas | Sim | String | Query | Filtro da filial | accept | application/json | Sim | String | Header |
| content-type | application/json | Sim | String | Header |
|
Parâmetros e Chamada do Método: Para a realização de testes foi utilizado a ferramenta Postman e após a configuração do server protheus a API Rest, a requisição deverá ser semelhante a imagem abaixo: {protocolo}://{host}:{porta}/{endereço Rest}/api/rh/v1/HrBranches Response da API:
Situações de Erros TratadosO envio de dados inesperados nos parâmetros de entrada da API REST pode ocasionar alguns erros. Desta forma, foram criados alguns tratamentos de erros listados abaixo, cada um com sua respectiva mensagem e solução. Mensagens de Pré-ValidaçãoCódigo | Erro | Detalhe |
---|
400 | "Parâmetros inválidos: Verifique se os parâmetros startDate, endDate e filial foram enviados." |
|
|