MOAPI - API MOAVI para acesso rápido aos dados recentes de indicadores como desvios e IQE.
\nAntes de começar a utilizar estes endpoints:
\nContate-nos que para seu usuário seja criado e configurado.
\nVocê receberá um e-mail com sua senha temporária, e deve fixar outra permanente.
\nEsta será então utilizada no endpoint '/usr-pwd-authenticate' para obter tokens...
\n....que habilitarão acesso aos dados de sua companhia!
\nRECOMENDAÇÃO IMPORTANTE:
\nSugerimos um intervalo de 30 segundos para obter a segunda página (se for o caso) após a primeira request em um mesmo endpoint. Em particular, para endpoints de saldos de horas por colaborador (\"/plan-banco-*-*-colaborador\"), sugerimos 1 minuto e meio (1min 30s) de intervalo mínimo. Isso acontece porque:
\nO banco de dados pode levar mais tempo para processar resultados numerosos.
\nTambém, como nosso timeout é de 29s, você, o consumidor, pode implementar um mecanismo simples de retry para não se esquecer de pegar a página 1 - que, no pior caso, já estará em cache nesta nova requisição!
\nDesenvolvedor responsável:
Rafael Costa
Tel/WhatsApp: (11) 4113-9240
\n\nEste endpoint é usado para autenticar um usuário com senha. O objetivo é a obtenção de um IdToken (com vida útil de 1h) e do RefreshToken (30 dias) associado para renovar o IdToken de maneira segura em '/usr-refresh-authenticate'
\nMétodo: POST
username (string, obrigatório): O nome de usuário.
password (string, obrigatório): A senha do usuário.
statusCode (number): O código de status HTTP da resposta.
message (string): Uma mensagem relacionada à resposta.
AccessToken (string): Token de acesso do usuário Cognito.
IdToken (string): O token de identificação. Este deve ser fornecido no header 'moapi-token' para acessar os endpoints de indicadores!
RefreshToken (string): O token de atualização. Este deverá utilizado em '/usr-refresh-get-token' para obter novos IdToken's de maneira mais segura, evitando o tráfego do user password.
ExpiresIn (number): O tempo de expiração em segundos para o IdToken. Padronizado para 3600 (1h).
headers (object): O cabeçalho da resposta, definindo o tipo de conteúdo. Omitido dos exemplos por simplicidade.
Este endpoint é utilizado para atualizar e autenticar o token de acesso do usuário.
\nusername (string): O nome de usuário para autenticação.
refresh_token (string): O token de atualização para renovar o acesso. Este deve ser obtido após uma requisição bem-sucedida em '/usr-pwd-authenticate', em cuja resposta virá no campo \"RefreshToken\".
A resposta, se bem-sucedida, terá um status code 200 e um corpo no formato JSON com os seguintes campos:
\nstatusCode (number): Código de status da resposta.
message (string): Mensagem de resposta.
IdToken (string): Token de identificação. Este deve ser fornecido no header 'moapi-token' para obter os indicadores!
AccessToken (string): Token de acesso.
Em caso de erro, o status 401 será devolvido e o JSON somente virá com os campos \"statusCode\" e \"message\".
\n","urlObject":{"protocol":"https","path":["usr-refresh-authenticate"],"host":["moapi","escalamoavi","com","br"],"query":[],"variable":[]}},"response":[{"id":"09cfbf92-0d89-4499-aa35-072b28229724","name":"200-sucesso","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"username\": \"/absenteismo-dia-clusterFornece taxas de absenteísmo agregadas por dia e por cluster.
\nRetornar a taxa de absenteísmo diária de cada cluster em determinado intervalo.
\n\n\nIMPORTANTE:
\n
• Limite de 372 dias por consulta (≈ 12 × 31).
• Valores devolvidos como fração (ex.:0.123→ 12,3 %).
URL: https://moapi.escalamoavi.com.br/absenteismo-dia-cluster
Método: POST
Cabeçalho: obrigatório moapi-token.
{\n \"data_ini\": \"2024-01-01\",\n \"data_fim\": \"2024-03-31\",\n \"lista_nomes_clusters\": [\"cluster_A\", \"cluster_B\"],\n \"pag\": 1\n}\n200 OK{\n \"statusCode\": 200,\n \"mensagem\": \"Dados obtidos com sucesso.\",\n \"erro\": null,\n \"ultimaPag\": 1,\n \"resultados\": [\n [\"nome_cluster\", \"data\", \"absenteismo\"],\n [\"cluster_A\", \"2024-01-01\", \"0.0450\"],\n [\"cluster_A\", \"2024-01-02\", \"0.0512\"],\n [\"cluster_B\", \"2024-01-01\", \"0.0398\"]\n ]\n}\n400 – Excesso de Dias{\n \"statusCode\": 400,\n \"mensagem\": \"Requisicao mal-formada.\",\n \"erro\": \"O periodo inserido contempla 373 dias, excedendo assim o limite deste endpoint (Doze meses cheios (372 dias))!\",\n \"ultimaPag\": null,\n \"resultados\": null\n}\n400 – Erro de Schema{\n \"statusCode\": 400,\n \"mensagem\": \"Invalid request body\",\n \"erro\": \"[detalhes da validação]\",\n \"ultimaPag\": null,\n \"resultados\": null\n}\n401 – Token Expirado{\n \"message\": \"The incoming token has expired\"\n}\n500 – Erro Interno{\n \"statusCode\": 500,\n \"mensagem\": \"Erro ao processar a requisicao.\",\n \"erro\": \"[detalhes internos]\",\n \"ultimaPag\": null,\n \"resultados\": null\n}\n/absenteismo-dia-colaboradorRetorna o status de absenteísmo (ex: 'Presente', 'Falta Injustificada') por dia e por colaborador.
\nObter o status de absenteísmo diário para cada matrícula solicitada.
\n\n\nIMPORTANTE:
\n
• Limite de 10 dias corridos.
• Lista[\"*\"]devolve todos os colaboradores.
URL: https://moapi.escalamoavi.com.br/absenteismo-dia-colaborador
Método: POST
Cabeçalho: moapi-token obrigatório.
{\n \"data_ini\": \"2024-03-10\",\n \"data_fim\": \"2024-03-15\",\n \"lista_matriculas_colaboradores\": [\"matr456\", \"matrABC\"]\n}\n200 OK{\n \"statusCode\": 200,\n \"mensagem\": \"Dados obtidos com sucesso.\",\n \"erro\": null,\n \"ultimaPag\": 1,\n \"resultados\": [\n [\"matricula\", \"data\", \"absenteismo\"],\n [\"matr456\", \"2024-03-10\", \"Presente\"],\n [\"matr456\", \"2024-03-11\", \"Falta Injustificada\"],\n [\"matrABC\", \"2024-03-10\", \"Presente\"]\n ]\n}\n400 – Excesso de DiasSe o intervalo entre data_ini e data_fim exceder o limite de 10 dias.
{\n \"statusCode\": 400,\n \"mensagem\": \"Requisicao mal-formada.\",\n \"erro\": \"O periodo inserido contempla 12 dias, excedendo assim o limite deste endpoint (Dez dias corridos (10 dias))!\",\n \"ultimaPag\": null,\n \"resultados\": null\n}\n400 – Erro de SchemaAlgum campo fora do esperado (formato de data inválido, lista vazia, item numérico em vez de string etc.).
\n{\n \"statusCode\": 400,\n \"mensagem\": \"Invalid request body\",\n \"erro\": \"[instance.lista_matriculas_colaboradores is not of a type(s) array]\",\n \"ultimaPag\": null,\n \"resultados\": null\n}\n401 – Token Expirado ou Inválido{ \"message\": \"The incoming token has expired\" }\n500 – Erro InternoFalha inesperada no servidor.
\n{\n \"statusCode\": 500,\n \"mensagem\": \"Erro ao processar a requisicao.\",\n \"erro\": \"[detalhes internos]\",\n \"ultimaPag\": null,\n \"resultados\": null\n}\n/absenteismo-dia-filialFornece taxa de absenteísmo por dia e filial.
\nRetornar a taxa de absenteísmo diária por filial dentro de um período.
\n\n\nIMPORTANTE: limite de 62 dias por consulta.
\n
URL: https://moapi.escalamoavi.com.br/absenteismo-dia-filial
Método: POST
Cabeçalho: moapi-token obrigatório.
{\n \"data_ini\": \"2024-06-01\",\n \"data_fim\": \"2024-06-30\",\n \"lista_cods_filiais\": [\"0001\", \"0015\"]\n}\n200 OK{\n \"statusCode\": 200,\n \"mensagem\": \"Dados obtidos com sucesso.\",\n \"erro\": null,\n \"ultimaPag\": 1,\n \"resultados\": [\n [\"filial_cod\", \"data\", \"absenteismo\"],\n [\"0001\", \"2024-06-10\", \"0.055\"],\n [\"0015\", \"2024-06-10\", \"0.021\"]\n ]\n}\n400 – Excesso de DiasQuando o intervalo entre data_ini e data_fim ultrapassa 62 dias.
{\n \"statusCode\": 400,\n \"mensagem\": \"Requisicao mal-formada.\",\n \"erro\": \"O periodo inserido contempla 70 dias, excedendo assim o limite deste endpoint (Dois meses cheios (62 dias))!\",\n \"ultimaPag\": null,\n \"resultados\": null\n}\n400 – Erro de SchemaQualquer violação de formato ou regra de validação (data inválida, lista vazia, etc.).
\n{\n \"statusCode\": 400,\n \"mensagem\": \"Invalid request body\",\n \"erro\": \"[{\\\"validation\\\":\\\"minItems\\\",\\\"code\\\":\\\"array_too_small\\\",\\\"message\\\":\\\"Array must contain at least 1 element(s)\\\",\\\"path\\\":[\\\"lista_cods_filiais\\\"]}]\",\n \"ultimaPag\": null,\n \"resultados\": null\n}\n401 – Token Expirado ou Inválido{\n \"message\": \"The incoming token has expired\"\n}\n500 – Erro InternoFalha inesperada no servidor.
\n{\n \"statusCode\": 500,\n \"mensagem\": \"Erro ao processar a requisicao.\",\n \"erro\": \"Falha na conexao com o banco de dados.\",\n \"ultimaPag\": null,\n \"resultados\": null\n}\n/absenteismo-mes-clusterDevolve o absenteísmo por mês e cluster.
\nRetornar o absenteísmo mensal por cluster.
\n\n\nIMPORTANTE: intervalo máximo de dois anos cheios (730 dias).
\n
URL: https://moapi.escalamoavi.com.br/absenteismo-mes-cluster
Método: POST
Cabeçalho: moapi-token obrigatório.
{\n \"mes_ini\": \"01\",\n \"ano_ini\": 2023,\n \"mes_fim\": 12,\n \"ano_fim\": 2023,\n \"lista_nomes_clusters\": [\"cluster_alfa\", \"cluster_beta\"]\n}\n200 OK{\n \"statusCode\": 200,\n \"mensagem\": \"Dados obtidos com sucesso.\",\n \"erro\": null,\n \"ultimaPag\": 1,\n \"resultados\": [\n [\"nome_cluster\", \"ano\", \"mes\", \"absenteismo\"],\n [\"cluster_alfa\", \"2023\", \"1\", \"0.0455\"],\n [\"cluster_alfa\", \"2023\", \"2\", \"0.0480\"],\n [\"cluster_beta\", \"2023\", \"1\", \"0.0510\"],\n [\"cluster_beta\", \"2023\", \"2\", \"0.0523\"]\n ]\n}\n400 – Excesso de DiasQuando o intervalo entre (mes_ini, ano_ini) e (mes_fim, ano_fim) excede 730 dias.
{\n \"statusCode\": 400,\n \"mensagem\": \"Requisicao mal-formada.\",\n \"erro\": \"O periodo inserido contempla 762 dias, excedendo assim o limite deste endpoint (Dois anos cheios (730 dias))!\",\n \"ultimaPag\": null,\n \"resultados\": null\n}\n400 – Erro de SchemaViolação de formato, valor fora de faixa (mês > 12, ano < 2017), lista vazia, item duplicado, etc.
\n{\n \"statusCode\": 400,\n \"mensagem\": \"Invalid request body\",\n \"erro\": \"[{\\\"validation\\\":\\\"regex\\\",\\\"code\\\":\\\"invalid_string\\\",\\\"message\\\":\\\"String does not match pattern: ^(201[7-9]|20[2-9][0-9]|21[01][0-7])$\\\",\\\"path\\\":[\\\"ano_ini\\\"]}]\",\n \"ultimaPag\": null,\n \"resultados\": null\n}\n401 – Token Expirado ou Inválido{ \"message\": \"The incoming token has expired\" }\n500 – Erro InternoFalha inesperada no servidor.
\n{\n \"statusCode\": 500,\n \"mensagem\": \"Erro ao processar a requisicao.\",\n \"erro\": \"Ocorreu um erro interno ao consultar os dados de absenteísmo.\",\n \"ultimaPag\": null,\n \"resultados\": null\n}\n/absenteismo-mes-colaboradorRetorna absenteísmo por mês e colaborador.
\nConsultar a quantidade de absenteísmo mensal por matrícula.
\n\n\nIMPORTANTE: limite: Um mês cheio (31 dias).
\n
URL: https://moapi.escalamoavi.com.br/absenteismo-mes-colaborador
Método: POST
Cabeçalho: moapi-token obrigatório.
{\n \"mes_ini\": 1,\n \"ano_ini\": 2024,\n \"mes_fim\": 1,\n \"ano_fim\": 2024,\n \"lista_matriculas_colaboradores\": [\"matr456\", \"matr789\"]\n}\n200 OK{\n \"statusCode\": 200,\n \"mensagem\": \"Dados obtidos com sucesso.\",\n \"erro\": null,\n \"ultimaPag\": 1,\n \"resultados\": [\n [\"matricula\", \"ano\", \"mes\", \"absenteismo\"],\n [\"matr456\", \"2024\", \"1\", \"2\"],\n [\"matr789\", \"2024\", \"1\", \"0\"]\n ]\n}\n400 – Excesso de DiasQuando o intervalo entre (mes_ini, ano_ini) e (mes_fim, ano_fim) resulta em mais de 31 dias equivalentes.
{\n \"statusCode\": 400,\n \"mensagem\": \"Requisicao mal-formada.\",\n \"erro\": \"O periodo inserido contempla 62 dias, excedendo assim o limite desta requisicao (Um mês cheio (31 dias))!\",\n \"ultimaPag\": null,\n \"resultados\": null\n}\n\n\nA mensagem acima é apenas ilustrativa; o número de dias retornados varia conforme o período solicitado.
\n
400 – Erro de SchemaCampo fora do padrão, valor fora da faixa permitida (mês > 12, ano < 2017, lista vazia, item não-string, duplicado etc.).
{\n \"statusCode\": 400,\n \"mensagem\": \"Invalid request body\",\n \"erro\": \"[detalhes do erro de validacao]\",\n \"ultimaPag\": null,\n \"resultados\": null\n}\n401 – Token Expirado ou Inválido{ \"message\": \"The incoming token has expired\" }\n500 – Erro InternoFalha inesperada no servidor.
\n{\n \"statusCode\": 500,\n \"mensagem\": \"Erro ao processar a requisicao.\",\n \"erro\": \"[detalhes internos]\",\n \"ultimaPag\": null,\n \"resultados\": null\n}\n/absenteismo-mes-filialRetorna taxas de absenteísmo por mês e filial.
\nObter a taxa de absenteísmo mensal por filial.
\n\n\nIMPORTANTE: intervalo máximo de 12 meses (≈ 372 dias).
\n
URL: https://moapi.escalamoavi.com.br/absenteismo-mes-filial
Método: POST
Cabeçalho: moapi-token obrigatório.
{\n \"mes_ini\": \"01\",\n \"ano_ini\": 2023,\n \"mes_fim\": 12,\n \"ano_fim\": 2023,\n \"lista_cods_filiais\": [\"0002\", \"0025\"]\n}\n200 OK{\n \"statusCode\": 200,\n \"mensagem\": \"Dados obtidos com sucesso.\",\n \"erro\": null,\n \"ultimaPag\": 1,\n \"resultados\": [\n [\"filial_cod\", \"ano\", \"mes\", \"absenteismo\"],\n [\"0002\", \"2023\", \"1\", \"0.0512\"],\n [\"0025\", \"2023\", \"1\", \"0.0489\"]\n ]\n}\n400 – Excesso de DiasQuando o intervalo entre (mes_ini, ano_ini) e (mes_fim, ano_fim) ultrapassar 12 meses (≈ 372 dias).
{\n \"statusCode\": 400,\n \"mensagem\": \"Requisicao mal-formada.\",\n \"erro\": \"O periodo inserido contempla 398 dias, excedendo assim o limite deste endpoint (Doze meses cheios (372 dias))!\",\n \"ultimaPag\": null,\n \"resultados\": null\n}\n\n\nO número de dias exibido na mensagem varia conforme a requisição; o exemplo acima é ilustrativo.
\n
400 – Erro de SchemaQualquer campo fora do esperado (mês > 12, ano < 2017, lista vazia ou contendo valores de tipo errado, etc.).
\n{\n \"mes_ini\": 1,\n \"ano_ini\": 2015,\n \"mes_fim\": 1,\n \"ano_fim\": 2016,\n \"lista_cods_filiais\": [\"0001\"]\n}\n{\n \"statusCode\": 400,\n \"mensagem\": \"Invalid request body\",\n \"erro\": \"[detalhes do erro de validacao]\",\n \"ultimaPag\": null,\n \"resultados\": null\n}\n401 – Token Expirado ou Inválido{ \"message\": \"The incoming token has expired\" }\n500 – Erro InternoFalha inesperada no servidor.
\n{\n \"statusCode\": 500,\n \"mensagem\": \"Erro ao processar a requisicao.\",\n \"erro\": \"[detalhes internos]\",\n \"ultimaPag\": null,\n \"resultados\": null\n}\n/carga-trab-dia-clusterFornece a carga de trabalho agregada por dia e por cluster.
\nRetornar a carga de trabalho diária de cada cluster em determinado intervalo.
\n\n\nIMPORTANTE:
\n
• Limite de 372 dias por consulta (≈ 12 × 31).
URL: https://moapi.escalamoavi.com.br/carga-trab-dia-cluster
Método: POST
Cabeçalho: obrigatório moapi-token.
{\n \"data_ini\": \"2024-01-01\",\n \"data_fim\": \"2024-03-31\",\n \"lista_nomes_clusters\": [\"cluster_A\", \"cluster_B\"],\n \"pag\": 1\n}\n200 OK{\n \"statusCode\": 200,\n \"mensagem\": \"Dados obtidos com sucesso.\",\n \"erro\": null,\n \"ultimaPag\": 1,\n \"resultados\": [\n [\"nome_cluster\", \"data\", \"carga_trabalho\"],\n [\"cluster_A\", \"2024-01-01\", \"1543.21\"],\n [\"cluster_A\", \"2024-01-02\", \"1601.50\"],\n [\"cluster_B\", \"2024-01-01\", \"987.65\"]\n ]\n}\n400 – Excesso de Dias{\n \"statusCode\": 400,\n \"mensagem\": \"Requisicao mal-formada.\",\n \"erro\": \"O periodo inserido contempla 373 dias, excedendo assim o limite deste endpoint (Doze meses cheios (372 dias))!\",\n \"ultimaPag\": null,\n \"resultados\": null\n}\n400 – Erro de Schema{\n \"statusCode\": 400,\n \"mensagem\": \"Invalid request body\",\n \"erro\": \"[detalhes da validação]\",\n \"ultimaPag\": null,\n \"resultados\": null\n}\n401 – Token Expirado{ \"message\": \"The incoming token has expired\" }\n500 – Erro Interno{\n \"statusCode\": 500,\n \"mensagem\": \"Erro ao processar a requisicao.\",\n \"erro\": \"[detalhes internos]\",\n \"ultimaPag\": null,\n \"resultados\": null\n}\n/carga-trab-dia-filialFornece a carga de trabalho por dia e filial.
\nRetornar a carga de trabalho diária por filial dentro de um período.
\n\n\nIMPORTANTE: limite de 62 dias por consulta.
\n
URL: https://moapi.escalamoavi.com.br/carga-trab-dia-filial
Método: POST
Cabeçalho: moapi-token obrigatório.
{\n \"data_ini\": \"2024-05-01\",\n \"data_fim\": \"2024-05-31\",\n \"lista_cods_filiais\": [\"0001\", \"0002\"]\n}\n200 OK{\n \"statusCode\": 200,\n \"mensagem\": \"Dados obtidos com sucesso.\",\n \"erro\": null,\n \"ultimaPag\": 1,\n \"resultados\": [\n [\"filial_cod\", \"data\", \"carga_trabalho\"],\n [\"0001\", \"2024-05-15\", \"8.5\"],\n [\"0002\", \"2024-05-15\", \"12.0\"]\n ]\n}\n400 – Excesso de DiasQuando o intervalo entre data_ini e data_fim ultrapassa 62 dias.
{\n \"statusCode\": 400,\n \"mensagem\": \"Requisicao mal-formada.\",\n \"erro\": \"O periodo inserido contempla 92 dias, excedendo assim o limite deste endpoint (Dois meses cheios (62 dias))!\",\n \"ultimaPag\": null,\n \"resultados\": null\n}\n400 – Erro de SchemaQualquer violação de formato ou regra de validação (data inválida, lista vazia, item numérico onde devia ser string etc.).
\n{\n \"statusCode\": 400,\n \"mensagem\": \"Invalid request body\",\n \"erro\": \"[detalhes do erro de validacao]\",\n \"ultimaPag\": null,\n \"resultados\": null\n}\n401 – Token Expirado ou Inválido{\n \"message\": \"The incoming token has expired\"\n}\n500 – Erro InternoFalha inesperada no servidor.
\n{\n \"statusCode\": 500,\n \"mensagem\": \"Erro ao processar a requisicao.\",\n \"erro\": \"[detalhes internos]\",\n \"ultimaPag\": null,\n \"resultados\": null\n}\n/carga-trab-mes-clusterDevolve carga de trabalho por mês e cluster.
\nRetornar a carga de trabalho mensal por cluster.
\n\n\nIMPORTANTE: intervalo máximo de dois anos cheios (730 dias).
\n
URL: https://moapi.escalamoavi.com.br/carga-trab-mes-cluster
Método: POST
Cabeçalho: moapi-token obrigatório.
{\n \"mes_ini\": \"01\",\n \"ano_ini\": 2023,\n \"mes_fim\": 12,\n \"ano_fim\": 2023,\n \"lista_nomes_clusters\": [\"cluster_A\", \"cluster_B\"]\n}\n200 OK{\n \"statusCode\": 200,\n \"mensagem\": \"Dados obtidos com sucesso.\",\n \"erro\": null,\n \"ultimaPag\": 1,\n \"resultados\": [\n [\"nome_cluster\", \"ano\", \"mes\", \"carga_trabalho\"],\n [\"cluster_A\", \"2023\", \"1\", \"150.75\"],\n [\"cluster_A\", \"2023\", \"2\", \"165.20\"]\n ]\n}\n400 – Excesso de DiasQuando o intervalo entre (mes_ini, ano_ini) e (mes_fim, ano_fim) excede 730 dias.
{\n \"statusCode\": 400,\n \"mensagem\": \"Requisicao mal-formada.\",\n \"erro\": \"O periodo inserido contempla 762 dias, excedendo assim o limite deste endpoint (Dois anos cheios (730 dias))!\",\n \"ultimaPag\": null,\n \"resultados\": null\n}\n400 – Erro de SchemaViolação de formato, valor fora de faixa (mês > 12, ano < 2017), lista vazia, item duplicado, etc.
\n{\n \"statusCode\": 400,\n \"mensagem\": \"Invalid request body\",\n \"erro\": \"[{\\\"validation\\\":\\\"regex\\\",\\\"code\\\":\\\"invalid_string\\\",\\\"message\\\":\\\"String does not match pattern: ^(201[7-9]|20[2-9][0-9]|21[01][0-7])$\\\",\\\"path\\\":[\\\"ano_ini\\\"]}]\",\n \"ultimaPag\": null,\n \"resultados\": null\n}\n401 – Token Expirado ou Inválido{\n \"message\": \"The incoming token has expired\"\n}\n500 – Erro InternoFalha inesperada no servidor.
\n{\n \"statusCode\": 500,\n \"mensagem\": \"Erro ao processar a requisicao.\",\n \"erro\": \"Ocorreu uma falha interna no servidor.\",\n \"ultimaPag\": null,\n \"resultados\": null\n}\n/carga-trab-mes-filialRetorna carga de trabalho por mês e filial.
\nObter a carga de trabalho mensal por filial.
\n\n\nIMPORTANTE: intervalo máximo de 12 meses (≈ 372 dias).
\n
URL: https://moapi.escalamoavi.com.br/carga-trab-mes-filial
Método: POST
Cabeçalho: moapi-token obrigatório.
{\n \"mes_ini\": \"01\",\n \"ano_ini\": 2023,\n \"mes_fim\": 3,\n \"ano_fim\": 2023,\n \"lista_cods_filiais\": [\"0001\", \"0005\"]\n}\n200 OK{\n \"statusCode\": 200,\n \"mensagem\": \"Dados obtidos com sucesso.\",\n \"erro\": null,\n \"ultimaPag\": 1,\n \"resultados\": [\n [\"filial_cod\", \"ano\", \"mes\", \"carga_trabalho\"],\n [\"0001\", \"2023\", \"1\", \"1540.50\"],\n [\"0005\", \"2023\", \"1\", \"1890.00\"],\n [\"0001\", \"2023\", \"2\", \"1495.25\"],\n [\"0005\", \"2023\", \"2\", \"1910.75\"],\n [\"0001\", \"2023\", \"3\", \"1610.00\"],\n [\"0005\", \"2023\", \"3\", \"1855.50\"]\n ]\n}\n400 – Excesso de DiasQuando o intervalo entre (mes_ini, ano_ini) e (mes_fim, ano_fim) ultrapassar 12 meses (≈ 372 dias).
{\n \"mes_ini\": \"01\",\n \"ano_ini\": 2022,\n \"mes_fim\": 1,\n \"ano_fim\": 2023,\n \"lista_cods_filiais\": [\"0001\"]\n}\n{\n \"statusCode\": 400,\n \"mensagem\": \"Requisicao mal-formada.\",\n \"erro\": \"O periodo inserido contempla 396 dias, excedendo assim o limite deste endpoint (Doze meses cheios (372 dias))!\",\n \"ultimaPag\": null,\n \"resultados\": null\n}\n\n\nO número de dias exibido na mensagem varia conforme a requisição; o exemplo acima é ilustrativo.
\n
400 – Erro de SchemaQualquer campo fora do esperado (mês > 12, ano < 2017, lista vazia ou contendo valores de tipo errado, etc.).
\n{\n \"mes_ini\": \"13\",\n \"ano_ini\": 2023,\n \"mes_fim\": 12,\n \"ano_fim\": 2023,\n \"lista_cods_filiais\": [\"0001\"]\n}\n{\n \"statusCode\": 400,\n \"mensagem\": \"Invalid request body\",\n \"erro\": \"[{\\\"instancePath\\\":\\\"/mes_ini\\\",\\\"schemaPath\\\":\\\"#/properties/mes_ini/anyOf/0/pattern\\\",\\\"keyword\\\":\\\"pattern\\\",\\\"params\\\":{\\\"pattern\\\":\\\"^(0[1-9]|1[0-2])$\\\"},\\\"message\\\":\\\"must match pattern \\\\\\\"^(0[1-9]|1[0-2])$\\\\\\\"\\\"},{\\\"instancePath\\\":\\\"/mes_ini\\\",\\\"schemaPath\\\":\\\"#/properties/mes_ini/anyOf/1/maximum\\\",\\\"keyword\\\":\\\"maximum\\\",\\\"params\\\":{\\\"comparison\\\":\\\"<=\\\",\\\"limit\\\":12},\\\"message\\\":\\\"must be <= 12\\\"},{\\\"instancePath\\\":\\\"/mes_ini\\\",\\\"schemaPath\\\":\\\"#/properties/mes_ini/anyOf\\\",\\\"keyword\\\":\\\"anyOf\\\",\\\"params\\\":{},\\\"message\\\":\\\"must match a schema in anyOf\\\"}]\",\n \"ultimaPag\": null,\n \"resultados\": null\n}\n401 – Token Expirado ou Inválido{ \"message\": \"The incoming token has expired\" }\n500 – Erro InternoFalha inesperada no servidor.
\n{\n \"statusCode\": 500,\n \"mensagem\": \"Erro ao processar a requisicao.\",\n \"erro\": \"Falha na conexao com o banco de dados.\",\n \"ultimaPag\": null,\n \"resultados\": null\n}\nJanela máxima: 62 dias. Síncrono. Vagas de contratação da escala que VALIDAMENTE rege cada data, separadas por status; colunas mutuamente exclusivas por data.
\nJanela toda anterior à primeira escala Ativa vem VAZIA (por desenho).
\nColunas: filial_cod, data, contratacoes_escala_ativa, contratacoes_escala_agendada.
\n","urlObject":{"protocol":"https","path":["contratacoes-dia-filial"],"host":["moapi","escalamoavi","com","br"],"query":[],"variable":[]}},"response":[{"id":"f2a14c95-9f84-4af5-97f5-603a8618be77","name":"200-sucesso","originalRequest":{"method":"POST","header":[{"key":"moapi-token","value":"Janela máxima: 372 dias. Síncrono. Conta VAGAS distintas no mes, não vaga-dia. Colunas: filial_cod, ano, mes, contratacoes_escala_ativa, contratacoes_escala_agendada.
\n","urlObject":{"protocol":"https","path":["contratacoes-mes-filial"],"host":["moapi","escalamoavi","com","br"],"query":[],"variable":[]}},"response":[{"id":"940907a5-c50a-484f-b8a3-0d6d70cfc5cc","name":"200-sucesso","originalRequest":{"method":"POST","header":[{"key":"moapi-token","value":"Fornece desvios percentuais agregados por dia e discriminados por cluster.
\nO usuário deve fornecer datas inicial (\"data_ini\") e final (\"data_fim\") em formato \"AAAA-MM-DD\".
\nO número total de dias correspondentes (\"daterange\") não pode exceder 12 meses cheios (12*31 dias).
\nEm \"lista_nomes_clusters\" espera-se uma lista contendo strings que correspondam a nomes de clusters cadastrados na MOAVI. Para que dados de todos clusters sejam retornados, o input deve ser \"lista_nomes_clusters\": [\"*\"]
\nSe houver necessidade de paginação, em requisições posteriores o usuário deve incluir no body a chave \"pag\" com um inteiro positivo.
\n\"mensagem\" conterá uma string que informa brevemente sobre sucesso ou fracasso da request. Algumas requisições podem resultar em avisos neste campo.
\n\"erro\", se aplicável, trará string detalhando o motivo de fracasso da requisição. Se não, retorna como null
\n\"ultimaPag\", fornece a página (integer) do último lote de resultados. Em casos de erro, por exemplo, retorna como null.
\n\"statusCode\" informa o código HTTP da resposta, um integer.
\n\"resultados\", se não null, trata-se de uma lista de listas. As listas internas sempre tem 3 elementos, cada, todos string.
\nA primeira lista aninhada é sempre [\"nome_cluster\", \"data\", \"desvio\"].
\nAs demais conterão strings com valores respectivos, ex: [\"cluster1\", \"2024-06-11\", \"0.123\"] significaria que no dia 11 de junho de 2024, o cluster \"cluster1\" performou com \"0.123\" (12,3%) de desvios.
\nFornece desvios absolutos (isto é, número de ocorrências) agregados por dia e discriminados por colaborador através da matrícula deste.
\nO usuário deve fornecer datas inicial (\"data_ini\") e final (\"data_fim\") em formato \"AAAA-MM-DD\".
\nO número total de dias correspondentes (\"daterange\") deve ser, atualmente, no máximo 1500/n_colabs em que n_colabs é o número de colaboradores solicitados.
\nEm \"lista_matriculas_colaboradores\" espera-se uma lista contendo strings que correspondam a matrículas de colaboradors cadastrados na MOAVI. Para que dados de todos colaboradores sejam retornados, o input deve ser \"lista_matriculas_colaboradores\": [\"*\"]
\nSe houver necessidade de paginação, em requisições posteriores o usuário deve incluir no body a chave \"pag\" com um inteiro positivo.
\n\"mensagem\" conterá uma string que informa brevemente sobre sucesso ou fracasso da request. Algumas requisições podem resultar em avisos neste campo.
\n\"erro\", se aplicável, trará string detalhando o motivo de fracasso da requisição. Se não, retorna como null
\n\"ultimaPag\", fornece a página (integer) do último lote de resultados. Em casos de erro, por exemplo, retorna como null.
\n\"statusCode\" informa o código HTTP da resposta, um integer.
\n\"resultados\", se não null, trata-se de uma lista de listas. As listas internas sempre tem 3 elementos, cada, todos string.
\nA primeira lista aninhada é sempre [\"matricula\", \"data\", \"n_desvios\"].
\nAs demais conterão strings com valores respectivos, ex: [\"1234\", \"2024-06-11\", \"2\"] significaria que no dia 11 de junho de 2024, houve 2 desvios nas batidas do colaborador com matrícula \"1234\".
\nFornece desvios por dia e por filial.
\nO usuário deve fornecer datas inicial (\"data_ini\") e final (\"data_fim\") em formato \"AAAA-MM-DD\".
\nO número total de dias correspondentes (\"daterange\") não pode exceder 62 dias - dois meses cheios.
\nEm \"lista_cods_filiais\" espera-se uma lista contendo strings ou inteiros que correspondam a códigos de filiais cadastradas na MOAVI. Para que dados de todas filiais sejam retornados, o input deve ser \"lista_cods_filiais\": [\"*\"]
\nSe houver necessidade de paginação, em requisições posteriores o usuário deve incluir no body a chave \"pag\" com um inteiro positivo.
\n\"mensagem\" conterá uma string que informa brevemente sobre sucesso ou fracasso da request. Algumas requisições podem resultar em avisos neste campo.
\"erro\", se aplicável, trará string detalhando o motivo de fracasso da requisição. Se não, retorna como null
\n\"ultimaPag\", fornece a página (integer) do último lote de resultados. Em casos de erro, por exemplo, retorna como null.
\n\"statusCode\" informa o código HTTP da resposta, um integer.
\n\"resultados\", se não null, trata-se de uma lista de listas. As listas internas sempre tem 3 elementos, cada, todos string.
\nA primeira lista aninhada é sempre [\"filial_cod\", \"data\", \"desvio\"].
\nAs demais conterão strings com valores respectivos, ex: [\"0001\", \"2024-06-11\", \"0.123\"] significaria que no dia 11 de junho de 2024, a filial \"0001\" performou com \"0.123\" (12,3%) de desvios.
\nFornece desvios percentuais agregados por mês e discriminados por cluster.
\nCorpo da Requisição
\nmes_ini (string ou integer): O mês inicial deve ser uma string no formato \"MM\" ou um número inteiro entre 1-12.
\nano_ini (string ou integer): O ano inicial deve ser uma string no formato \"AAAA\" ou um número inteiro entre 2017 e 2100.
\nmes_fim (string ou integer): O mês final deve ser uma string no formato \"MM\" ou um número inteiro entre 1-12 após o mês inicial.
\nano_fim (string ou integer): O ano final deve ser uma string no formato \"AAAA\" ou um número inteiro entre 2017 e 2100.
\nlista_nomes_clusters: array de strings, ou informe \"lista_nomes_clusters\": [\"*\"] para solicitar dados de todos clusters.
\nOPCIONAL pag (integer): O número da página dos resultados. Só tem utilidade se consultas paginadas forem necessárias.
\nResposta
\nstatusCode (integer): O código de status da resposta.
\nmensagem (string): Qualquer mensagem relevante.
\nerro (null): Informações de erro, se houver.
\nultimaPag (integer): O número da última página com dados referentes à consulta em questão. Se consultas subsequentes forem necessárias para buscar todos os dados, ultimaPag>1.
\nresultados (array de arrays): Os dados resultantes.
\nA primeira lista aninhada é sempre [\"nome_cluster\", \"ano\", \"mes\", \"desvios\"].
\nAs demais conterão strings com valores respectivos, ex: [\"cluster14\", \"2024\", \"3\", \"0.01\"] significaria que no mês de março do ano 2024, \"cluster14\" apresentou desvios em 1% na média.
\nFornece valores absolutos dos desvios, agregados por mês e discriminados por matrícula de colaboradores.
\nCorpo da Requisição
\nmes_ini (string ou integer): O mês inicial deve ser uma string no formato \"MM\" ou um número inteiro entre 1-12.
\nano_ini (string ou integer): O ano inicial deve ser uma string no formato \"AAAA\" ou um número inteiro entre 2017 e 2100.
\nmes_fim (string ou integer): O mês final deve ser uma string no formato \"MM\" ou um número inteiro entre 1-12 após o mês inicial.
\nano_fim (string ou integer): O ano final deve ser uma string no formato \"AAAA\" ou um número inteiro entre 2017 e 2100.
\nlista_matriculas_colaboradores: array de strings, ou informe \"lista_matriculas_colaboradores\": [\"*\"] para solicitar dados de todos colaboradores.
\nOPCIONAL pag (integer): O número da página dos resultados. Só tem utilidade se consultas paginadas forem necessárias.
\nResposta
\nstatusCode (integer): O código de status da resposta.
\nmensagem (string): Qualquer mensagem relevante.
\nerro (null): Informações de erro, se houver.
\nultimaPag (integer): O número da última página com dados referentes à consulta em questão. Se consultas subsequentes forem necessárias para buscar todos os dados, ultimaPag>1.
\nresultados (array de arrays): Os dados resultantes.
\nA primeira lista aninhada é sempre [\"matricula\", \"ano\", \"mes\", \"n_desvios\"].
\nAs demais conterão strings com valores respectivos, ex: [\"matricula23\", \"2022\", \"4\", \"5\"] significaria que no mês de abril de 2022, o colaborador de matrícula \"matricula23\" acumulou 5 desvios.
\nEste endpoint é usado para recuperar desvios médios percentuais com base em parâmetros específicos relacionados a meses e anos para uma determinada filial.
\nCorpo da Requisição
\nmes_ini (string ou integer): O mês inicial deve ser uma string no formato \"MM\" ou um número inteiro entre 1-12.
\nano_ini (string ou integer): O ano inicial deve ser uma string no formato \"AAAA\" ou um número inteiro entre 2017 e 2100.
\nmes_fim (string ou integer): O mês final deve ser uma string no formato \"MM\" ou um número inteiro entre 1-12 após o mês inicial.
\nano_fim (string ou integer): O ano final deve ser uma string no formato \"AAAA\" ou um número inteiro entre 2017 e 2100.
\nlista_cods_filiais: array de strings, inteiros ou informe \"lista_cods_filiais\": [\"*\"] para solicitar dados de todas filiais.
\nOPCIONAL pag (integer): O número da página dos resultados. Só tem utilidade se consultas paginadas forem necessárias.
\nResposta
\nstatusCode (integer): O código de status da resposta.
\nmensagem (string): Qualquer mensagem relevante.
\nerro (null): Informações de erro, se houver.
\nultimaPag (integer): O número da última página com dados referentes à consulta em questão. Se consultas subsequentes forem necessárias para buscar todos os dados, ultimaPag>1.
\nresultados (array de arrays): Os dados resultantes.
\nA primeira lista aninhada é sempre [\"filial_cod\", \"ano\", \"mes\", \"desvio\"].
\nAs demais conterão strings com valores respectivos, ex: [\"1184\", \"2024\", \"4\", \"0.1111\"] significaria que no mês de abril de 2024, a filial \"1184\" acumulou desvios com uma média de 11,11%.
\nJanela máxima: 62 dias. Síncrono. Responde: \"montou a escala do PROXIMO ciclo, e foi pessoa ou sistema?\"
\nJanela recomendada: o mês seguinte inteiro (define o dia-1 e a primeira segunda-feira avaliados).
\nFilial sem ciclo do seu regime na janela é OMITIDA (nao e' 'nao_criou').
\nColunas: filial_cod, regime, ciclo_ini, status_criacao.
\n","urlObject":{"protocol":"https","path":["escalas-criadas-ciclo-filial"],"host":["moapi","escalamoavi","com","br"],"query":[],"variable":[]}},"response":[{"id":"db294140-f5f4-4e4f-ad60-97ea94a209ba","name":"200-sucesso","originalRequest":{"method":"POST","header":[{"key":"moapi-token","value":"/esquecimentos-dia-clusterFornece esquecimentos agregados por dia e por cluster.
\nRetornar a contagem de esquecimentos diários de cada cluster em determinado intervalo.
\n\n\nIMPORTANTE:
\n
• Limite de 372 dias por consulta (≈ 12 × 31).
URL: https://moapi.escalamoavi.com.br/esquecimentos-dia-cluster
Método: POST
Cabeçalho: obrigatório moapi-token.
{\n \"data_ini\": \"2024-01-01\",\n \"data_fim\": \"2024-03-31\",\n \"lista_nomes_clusters\": [\"cluster_alpha\", \"cluster_beta\"],\n \"pag\": 1\n}\n200 OK{\n \"statusCode\": 200,\n \"mensagem\": \"Dados obtidos com sucesso.\",\n \"erro\": null,\n \"ultimaPag\": 1,\n \"resultados\": [\n [\"nome_cluster\", \"data\", \"esquecimentos\"],\n [\"cluster_alpha\", \"2024-01-01\", \"5\"],\n [\"cluster_alpha\", \"2024-01-02\", \"8\"],\n [\"cluster_beta\", \"2024-01-01\", \"12\"]\n ]\n}\n400 – Excesso de Dias{\n \"statusCode\": 400,\n \"mensagem\": \"Requisicao mal-formada.\",\n \"erro\": \"O periodo inserido contempla 373 dias, excedendo assim o limite deste endpoint (Doze meses cheios (372 dias))!\",\n \"ultimaPag\": null,\n \"resultados\": null\n}\n400 – Erro de Schema{\n \"statusCode\": 400,\n \"mensagem\": \"Invalid request body\",\n \"erro\": \"[{\\\"validation\\\":\\\"minItems\\\",\\\"code\\\":\\\"min_items\\\",\\\"message\\\":\\\"Array must have at least 1 item\\\",\\\"path\\\":[\\\"lista_nomes_clusters\\\"]}]\",\n \"ultimaPag\": null,\n \"resultados\": null\n}\n401 – Token Expirado{ \"message\": \"The incoming token has expired\" }\n500 – Erro Interno{\n \"statusCode\": 500,\n \"mensagem\": \"Erro ao processar a requisicao.\",\n \"erro\": \"An internal server error occurred.\",\n \"ultimaPag\": null,\n \"resultados\": null\n}\n/esquecimentos-dia-colaboradorRetorna esquecimentos absolutos (quantidade) por dia e por colaborador.
\nObter o número de esquecimentos diários para cada matrícula solicitada.
\n\n\nIMPORTANTE:
\n
• Limite: 10 dias corridos.
• Lista[\"*\"]devolve todos os colaboradores.
URL: https://moapi.escalamoavi.com.br/esquecimentos-dia-colaborador
Método: POST
Cabeçalho: moapi-token obrigatório.
{\n \"data_ini\": \"2024-03-01\",\n \"data_fim\": \"2024-03-05\",\n \"lista_matriculas_colaboradores\": [\"matr456\", \"matrABC\"]\n}\n200 OK{\n \"statusCode\": 200,\n \"mensagem\": \"Dados obtidos com sucesso.\",\n \"erro\": null,\n \"ultimaPag\": 1,\n \"resultados\": [\n [\"matricula\", \"data\", \"esquecimentos\"],\n [\"matr456\", \"2024-03-01\", \"1\"],\n [\"matr456\", \"2024-03-02\", \"0\"]\n ]\n}\n400 – Excesso de DiasSe o intervalo entre data_ini e data_fim exceder o limite de 10 dias.
{\n \"statusCode\": 400,\n \"mensagem\": \"Requisicao mal-formada.\",\n \"erro\": \"O periodo inserido contempla 12 dias, excedendo assim o limite deste endpoint (Dez dias corridos (10 dias))!\",\n \"ultimaPag\": null,\n \"resultados\": null\n}\n400 – Erro de SchemaAlgum campo fora do esperado (formato de data inválido, lista vazia, item numérico em vez de string etc.).
\n{\n \"statusCode\": 400,\n \"mensagem\": \"Invalid request body\",\n \"erro\": \"[instance type (integer) does not match any allowed primitive type (allowed: [\\\"string\\\"])]\",\n \"ultimaPag\": null,\n \"resultados\": null\n}\n401 – Token Expirado ou Inválido{\n \"message\": \"The incoming token has expired\"\n}\n500 – Erro InternoFalha inesperada no servidor.
\n{\n \"statusCode\": 500,\n \"mensagem\": \"Erro ao processar a requisicao.\",\n \"erro\": \"[detalhes internos]\",\n \"ultimaPag\": null,\n \"resultados\": null\n}\n/esquecimentos-dia-filialFornece a contagem de esquecimentos por dia e filial.
\nRetornar a contagem de esquecimentos diários por filial dentro de um período.
\n\n\nIMPORTANTE: limite de 62 dias por consulta.
\n
URL: https://moapi.escalamoavi.com.br/esquecimentos-dia-filial
Método: POST
Cabeçalho: moapi-token obrigatório.
{\n \"data_ini\": \"2024-06-01\",\n \"data_fim\": \"2024-06-30\",\n \"lista_cods_filiais\": [\"0010\", \"0055\"]\n}\n200 OK{\n \"statusCode\": 200,\n \"mensagem\": \"Dados obtidos com sucesso.\",\n \"erro\": null,\n \"ultimaPag\": 1,\n \"resultados\": [\n [\"filial_cod\", \"data\", \"esquecimentos\"],\n [\"0010\", \"2024-06-15\", \"8\"],\n [\"0055\", \"2024-06-15\", \"3\"]\n ]\n}\n400 – Excesso de DiasQuando o intervalo entre data_ini e data_fim ultrapassa 62 dias.
{\n \"statusCode\": 400,\n \"mensagem\": \"Requisicao mal-formada.\",\n \"erro\": \"O periodo inserido contempla 70 dias, excedendo assim o limite deste endpoint (Dois meses cheios (62 dias))!\",\n \"ultimaPag\": null,\n \"resultados\": null\n}\n400 – Erro de SchemaQualquer violação de formato ou regra de validação (data inválida, lista vazia, item numérico onde devia ser string etc.).
\n{\n \"statusCode\": 400,\n \"mensagem\": \"Invalid request body\",\n \"erro\": \"[detalhes do erro de validacao]\",\n \"ultimaPag\": null,\n \"resultados\": null\n}\n401 – Token Expirado ou Inválido{ \"message\": \"The incoming token has expired\" }\n500 – Erro InternoFalha inesperada no servidor.
\n{\n \"statusCode\": 500,\n \"mensagem\": \"Erro ao processar a requisicao.\",\n \"erro\": \"[detalhes internos]\",\n \"ultimaPag\": null,\n \"resultados\": null\n}\n/esquecimentos-mes-clusterDevolve esquecimentos por mês e cluster.
\nRetornar a contagem de esquecimentos mensal por cluster.
\n\n\nIMPORTANTE: intervalo máximo de dois anos cheios (730 dias).
\n
URL: https://moapi.escalamoavi.com.br/esquecimentos-mes-cluster
Método: POST
Cabeçalho: moapi-token obrigatório.
{\n \"mes_ini\": \"01\",\n \"ano_ini\": 2023,\n \"mes_fim\": 12,\n \"ano_fim\": 2023,\n \"lista_nomes_clusters\": [\"cluster_A\", \"cluster_B\"]\n}\n200 OK{\n \"statusCode\": 200,\n \"mensagem\": \"Dados obtidos com sucesso.\",\n \"erro\": null,\n \"ultimaPag\": 1,\n \"resultados\": [\n [\"nome_cluster\", \"ano\", \"mes\", \"esquecimentos\"],\n [\"cluster_A\", \"2023\", \"1\", \"15\"],\n [\"cluster_A\", \"2023\", \"2\", \"22\"],\n [\"cluster_B\", \"2023\", \"1\", \"8\"]\n ]\n}\n400 – Excesso de DiasQuando o intervalo entre (mes_ini, ano_ini) e (mes_fim, ano_fim) excede 730 dias.
{\n \"statusCode\": 400,\n \"mensagem\": \"Requisicao mal-formada.\",\n \"erro\": \"O periodo inserido contempla 762 dias, excedendo assim o limite deste endpoint (Dois anos cheios (730 dias))!\",\n \"ultimaPag\": null,\n \"resultados\": null\n}\n400 – Erro de SchemaViolação de formato, valor fora de faixa (mês > 12, ano < 2017), lista vazia, item duplicado, etc.
\n{\n \"statusCode\": 400,\n \"mensagem\": \"Invalid request body\",\n \"erro\": \"[detalhes do erro de validacao]\",\n \"ultimaPag\": null,\n \"resultados\": null\n}\n401 – Token Expirado ou Inválido{\n \"message\": \"The incoming token has expired\"\n}\n500 – Erro InternoFalha inesperada no servidor.
\n{\n \"statusCode\": 500,\n \"mensagem\": \"Erro ao processar a requisicao.\",\n \"erro\": \"[detalhes internos]\",\n \"ultimaPag\": null,\n \"resultados\": null\n}\n/esquecimentos-mes-colaboradorRetorna a quantidade de esquecimentos por mês e colaborador.
\nConsultar a quantidade de esquecimentos mensais por matrícula.
\n\n\nIMPORTANTE: limite: Um mês cheio (31 dias).
\n
URL: https://moapi.escalamoavi.com.br/esquecimentos-mes-colaborador
Método: POST
Cabeçalho: moapi-token obrigatório.
{\n \"mes_ini\": 5,\n \"ano_ini\": 2024,\n \"mes_fim\": 5,\n \"ano_fim\": 2024,\n \"lista_matriculas_colaboradores\": [\"matr456\"]\n}\n200 OK{\n \"statusCode\": 200,\n \"mensagem\": \"Dados obtidos com sucesso.\",\n \"erro\": null,\n \"ultimaPag\": 1,\n \"resultados\": [\n [\"matricula\", \"ano\", \"mes\", \"esquecimentos\"],\n [\"matr456\", \"2024\", \"5\", \"2\"]\n ]\n}\n400 – Excesso de DiasQuando o intervalo entre (mes_ini, ano_ini) e (mes_fim, ano_fim) resulta em mais de 31 dias equivalentes.
{\n \"mes_ini\": 1,\n \"ano_ini\": 2024,\n \"mes_fim\": 3,\n \"ano_fim\": 2024,\n \"lista_matriculas_colaboradores\": [\"matr456\"]\n}\n{\n \"statusCode\": 400,\n \"mensagem\": \"Requisicao mal-formada.\",\n \"erro\": \"O periodo inserido contempla 91 dias, excedendo assim o limite desta requisicao (Um mês cheio (31 dias))!\",\n \"ultimaPag\": null,\n \"resultados\": null\n}\n400 – Erro de SchemaCampo fora do padrão, valor fora da faixa permitida (mês > 12, ano < 2017, lista vazia, item não-string, duplicado etc.).
{\n \"mes_ini\": 1,\n \"ano_ini\": 2024,\n \"mes_fim\": 1,\n \"ano_fim\": 2024,\n \"lista_matriculas_colaboradores\": []\n}\n{\n \"statusCode\": 400,\n \"mensagem\": \"Invalid request body\",\n \"erro\": \"[detalhes do erro de validacao]\",\n \"ultimaPag\": null,\n \"resultados\": null\n}\n401 – Token Expirado ou Inválido{ \"message\": \"The incoming token has expired\" }\n500 – Erro InternoFalha inesperada no servidor.
\n{\n \"mes_ini\": 5,\n \"ano_ini\": 2024,\n \"mes_fim\": 5,\n \"ano_fim\": 2024,\n \"lista_matriculas_colaboradores\": [\"matr456\"]\n}\n{\n \"statusCode\": 500,\n \"mensagem\": \"Erro ao processar a requisicao.\",\n \"erro\": \"[detalhes internos]\",\n \"ultimaPag\": null,\n \"resultados\": null\n}\n/esquecimentos-mes-filialRetorna esquecimentos por mês e filial.
\nObter os esquecimentos mensais por filial.
\n\n\nIMPORTANTE: intervalo máximo de 12 meses (≈ 372 dias).
\n
URL: https://moapi.escalamoavi.com.br/esquecimentos-mes-filial
Método: POST
Cabeçalho: moapi-token obrigatório.
{\n \"mes_ini\": \"01\",\n \"ano_ini\": 2023,\n \"mes_fim\": 12,\n \"ano_fim\": 2023,\n \"lista_cods_filiais\": [\"0001\", \"0005\"]\n}\n200 OK{\n \"statusCode\": 200,\n \"mensagem\": \"Dados obtidos com sucesso.\",\n \"erro\": null,\n \"ultimaPag\": 1,\n \"resultados\": [\n [\"filial_cod\", \"ano\", \"mes\", \"esquecimentos\"],\n [\"0001\", \"2023\", \"1\", \"15\"],\n [\"0005\", \"2023\", \"1\", \"8\"]\n ]\n}\n400 – Excesso de DiasQuando o intervalo entre (mes_ini, ano_ini) e (mes_fim, ano_fim) ultrapassar 12 meses (≈ 372 dias).
{\n \"statusCode\": 400,\n \"mensagem\": \"Requisicao mal-formada.\",\n \"erro\": \"O periodo inserido contempla 398 dias, excedendo assim o limite deste endpoint (Doze meses cheios (372 dias))!\",\n \"ultimaPag\": null,\n \"resultados\": null\n}\n\n\nO número de dias exibido na mensagem varia conforme a requisição; o exemplo acima é ilustrativo.
\n
400 – Erro de SchemaQualquer campo fora do esperado (mês > 12, ano < 2017, lista vazia ou contendo valores de tipo errado, etc.).
\n{\n \"statusCode\": 400,\n \"mensagem\": \"Invalid request body\",\n \"erro\": \"[detalhes do erro de validacao]\",\n \"ultimaPag\": null,\n \"resultados\": null\n}\n401 – Token Expirado ou Inválido{ \"message\": \"The incoming token has expired\" }\n500 – Erro InternoFalha inesperada no servidor.
\n{\n \"statusCode\": 500,\n \"mensagem\": \"Erro ao processar a requisicao.\",\n \"erro\": \"[detalhes internos]\",\n \"ultimaPag\": null,\n \"resultados\": null\n}\n/infracoes-dia-clusterFornece contagens de infrações agregadas por dia e por cluster.
\nRetornar a contagem diária de cada tipo de infração por cluster em determinado intervalo.
\n\n\nIMPORTANTE:
\n
• Limite de 372 dias por consulta (≈ 12 × 31).
URL: https://moapi.escalamoavi.com.br/infracoes-dia-cluster
Método: POST
Cabeçalho: obrigatório moapi-token.
{\n \"data_ini\": \"2024-02-01\",\n \"data_fim\": \"2024-02-15\",\n \"lista_nomes_clusters\": [\"cluster_A\", \"cluster_B\"],\n \"pag\": 1\n}\n200 OK{\n \"statusCode\": 200,\n \"mensagem\": \"Dados obtidos com sucesso.\",\n \"erro\": null,\n \"ultimaPag\": 1,\n \"resultados\": [\n [\"nome_cluster\", \"data\", \"interjornada\", \"estouro_6x1\", \"estouro_dom\", \"hora_extra_2h\", \"turno_acima_6h\", \"intervalo_abaixo_1h\"],\n [\"cluster_A\", \"2024-02-01\", \"5\", \"2\", \"0\", \"10\", \"1\", \"3\"],\n [\"cluster_A\", \"2024-02-02\", \"3\", \"1\", \"0\", \"8\", \"0\", \"1\"],\n [\"cluster_B\", \"2024-02-01\", \"0\", \"0\", \"1\", \"4\", \"2\", \"5\"]\n ]\n}\n400 – Excesso de Dias{\n \"data_ini\": \"2023-01-01\",\n \"data_fim\": \"2024-01-08\",\n \"lista_nomes_clusters\": [\"*\"]\n}\n{\n \"statusCode\": 400,\n \"mensagem\": \"Requisicao mal-formada.\",\n \"erro\": \"O periodo inserido contempla 373 dias, excedendo assim o limite deste endpoint (Doze meses cheios (372 dias))!\",\n \"ultimaPag\": null,\n \"resultados\": null\n}\n400 – Erro de Schema{\n \"data_ini\": \"2024-01-01\",\n \"data_fim\": \"2024-01-31\",\n \"lista_nomes_clusters\": []\n}\n{\n \"statusCode\": 400,\n \"mensagem\": \"Invalid request body\",\n \"erro\": \"[detalhes da validação]\",\n \"ultimaPag\": null,\n \"resultados\": null\n}\n401 – Token Expirado{ \"message\": \"The incoming token has expired\" }\n500 – Erro Interno{\n \"statusCode\": 500,\n \"mensagem\": \"Erro ao processar a requisicao.\",\n \"erro\": \"[detalhes internos]\",\n \"ultimaPag\": null,\n \"resultados\": null\n}\n/infracoes-dia-colaboradorRetorna infrações (quantidade) por dia e por colaborador.
\nObter o número de infrações diárias para cada matrícula solicitada.
\n\n\nIMPORTANTE:
\n
• Limite fixo: 10 dias corridos.
• Lista[\"*\"]devolve todos os colaboradores.
URL: https://moapi.escalamoavi.com.br/infracoes-dia-colaborador
Método: POST
Cabeçalho: moapi-token obrigatório.
{\n \"data_ini\": \"2024-02-01\",\n \"data_fim\": \"2024-02-09\",\n \"lista_matriculas_colaboradores\": [\"matr456\", \"matrABC\"]\n}\n200 OK{\n \"statusCode\": 200,\n \"mensagem\": \"Dados obtidos com sucesso.\",\n \"erro\": null,\n \"ultimaPag\": 1,\n \"resultados\": [\n [\"matricula\", \"data\", \"interjornada\", \"estouro_6x1\", \"estouro_dom\", \"hora_extra_2h\", \"turno_acima_6h\", \"intervalo_abaixo_1h\"],\n [\"matr456\", \"2024-02-01\", \"0\", \"1\", \"0\", \"0\", \"0\", \"0\"],\n [\"matr456\", \"2024-02-02\", \"1\", \"0\", \"0\", \"0\", \"0\", \"0\"],\n [\"matrABC\", \"2024-02-01\", \"0\", \"0\", \"0\", \"0\", \"0\", \"0\"]\n ]\n}\n400 – Excesso de DiasSe o intervalo entre data_ini e data_fim exceder o limite de 10 dias corridos.
{\n \"statusCode\": 400,\n \"mensagem\": \"Requisicao mal-formada.\",\n \"erro\": \"O periodo inserido contempla 15 dias, excedendo assim o limite deste endpoint (Dez dias corridos (10 dias))!\",\n \"ultimaPag\": null,\n \"resultados\": null\n}\n400 – Erro de SchemaAlgum campo fora do esperado (formato de data inválido, lista vazia, item numérico em vez de string etc.).
\n{\n \"statusCode\": 400,\n \"mensagem\": \"Invalid request body\",\n \"erro\": \"[instance type (integer) does not match any allowed primitive type (allowed: [\\\"string\\\"])]\",\n \"ultimaPag\": null,\n \"resultados\": null\n}\n401 – Token Expirado ou Inválido{ \"message\": \"The incoming token has expired\" }\n500 – Erro InternoFalha inesperada no servidor.
\n{\n \"statusCode\": 500,\n \"mensagem\": \"Erro ao processar a requisicao.\",\n \"erro\": \"[detalhes internos]\",\n \"ultimaPag\": null,\n \"resultados\": null\n}\n/infracoes-dia-filialFornece contagem de infrações por dia e filial.
\nRetornar a contagem de diversas infrações trabalhistas, por dia e filial, dentro de um período.
\n\n\nIMPORTANTE: limite de 62 dias por consulta.
\n
URL: https://moapi.escalamoavi.com.br/infracoes-dia-filial
Método: POST
Cabeçalho: moapi-token obrigatório.
{\n \"data_ini\": \"2024-04-01\",\n \"data_fim\": \"2024-04-30\",\n \"lista_cods_filiais\": [\"0001\", \"0005\"]\n}\n200 OK{\n \"statusCode\": 200,\n \"mensagem\": \"Dados obtidos com sucesso.\",\n \"erro\": null,\n \"ultimaPag\": 1,\n \"resultados\": [\n [\"filial_cod\", \"data\", \"interjornada\", \"estouro_6x1\", \"estouro_dom\", \"hora_extra_2h\", \"turno_acima_6h\", \"intervalo_abaixo_1h\"],\n [\"0001\", \"2024-04-10\", \"1\", \"0\", \"0\", \"2\", \"1\", \"0\"],\n [\"0005\", \"2024-04-12\", \"0\", \"1\", \"0\", \"0\", \"0\", \"1\"]\n ]\n}\n400 – Excesso de DiasQuando o intervalo entre data_ini e data_fim ultrapassa 62 dias.
{\n \"data_ini\": \"2024-01-01\",\n \"data_fim\": \"2024-04-01\",\n \"lista_cods_filiais\": [\"0001\"]\n}\n{\n \"statusCode\": 400,\n \"mensagem\": \"Requisicao mal-formada.\",\n \"erro\": \"O periodo inserido contempla 91 dias, excedendo assim o limite deste endpoint (Dois meses cheios (62 dias))!\",\n \"ultimaPag\": null,\n \"resultados\": null\n}\n400 – Erro de SchemaQualquer violação de formato ou regra de validação (data inválida, lista vazia, etc.).
\n{\n \"data_ini\": \"2024-03-01\",\n \"data_fim\": \"2024-03-31\",\n \"lista_cods_filiais\": []\n}\n{\n \"statusCode\": 400,\n \"mensagem\": \"Invalid request body\",\n \"erro\": \"[detalhes do erro de validacao]\",\n \"ultimaPag\": null,\n \"resultados\": null\n}\n401 – Token Expirado ou Inválido{ \"message\": \"The incoming token has expired\" }\n500 – Erro InternoFalha inesperada no servidor.
\n{\n \"statusCode\": 500,\n \"mensagem\": \"Erro ao processar a requisicao.\",\n \"erro\": \"[detalhes internos]\",\n \"ultimaPag\": null,\n \"resultados\": null\n}\n/infracoes-mes-clusterDevolve contagem de infrações por mês e cluster.
\nRetornar a contagem de infrações mensais por cluster.
\n\n\nIMPORTANTE: intervalo máximo de dois anos cheios (730 dias).
\n
URL: https://moapi.escalamoavi.com.br/infracoes-mes-cluster
Método: POST
Cabeçalho: moapi-token obrigatório.
{\n \"mes_ini\": \"01\",\n \"ano_ini\": 2024,\n \"mes_fim\": \"03\",\n \"ano_fim\": 2024,\n \"lista_nomes_clusters\": [\"cluster_A\", \"cluster_B\"]\n}\n200 OK{\n \"statusCode\": 200,\n \"mensagem\": \"Dados obtidos com sucesso.\",\n \"erro\": null,\n \"ultimaPag\": 1,\n \"resultados\": [\n [\"nome_cluster\", \"ano\", \"mes\", \"interjornada\", \"estouro_6x1\", \"estouro_dom\", \"hora_extra_2h\", \"turno_acima_6h\", \"intervalo_abaixo_1h\"],\n [\"cluster_A\", \"2024\", \"1\", \"5\", \"2\", \"0\", \"10\", \"8\", \"3\"],\n [\"cluster_A\", \"2024\", \"2\", \"4\", \"1\", \"1\", \"12\", \"7\", \"4\"],\n [\"cluster_B\", \"2024\", \"1\", \"10\", \"8\", \"1\", \"15\", \"11\", \"9\"]\n ]\n}\n400 – Excesso de DiasQuando o intervalo entre (mes_ini, ano_ini) e (mes_fim, ano_fim) excede 730 dias.
{\n \"statusCode\": 400,\n \"mensagem\": \"Requisicao mal-formada.\",\n \"erro\": \"O periodo inserido contempla 762 dias, excedendo assim o limite deste endpoint (Dois anos cheios (730 dias))!\",\n \"ultimaPag\": null,\n \"resultados\": null\n}\n400 – Erro de SchemaViolação de formato, valor fora de faixa (mês > 12, ano < 2017), lista vazia, item duplicado, etc.
\n{\n \"statusCode\": 400,\n \"mensagem\": \"Invalid request body\",\n \"erro\": \"[detalhes do erro de validacao]\",\n \"ultimaPag\": null,\n \"resultados\": null\n}\n401 – Token Expirado ou Inválido{ \"message\": \"The incoming token has expired\" }\n500 – Erro InternoFalha inesperada no servidor.
\n{\n \"statusCode\": 500,\n \"mensagem\": \"Erro ao processar a requisicao.\",\n \"erro\": \"[detalhes internos]\",\n \"ultimaPag\": null,\n \"resultados\": null\n}\n/infracoes-mes-colaboradorRetorna infrações por mês e colaborador.
\nConsultar a quantidade de infrações mensais por matrícula.
\n\n\nIMPORTANTE: limite: Um mês cheio (31 dias).
\n
URL: https://moapi.escalamoavi.com.br/infracoes-mes-colaborador
Método: POST
Cabeçalho: moapi-token obrigatório.
{\n \"mes_ini\": 1,\n \"ano_ini\": 2024,\n \"mes_fim\": 1,\n \"ano_fim\": 2024,\n \"lista_matriculas_colaboradores\": [\"matr456\"]\n}\n200 OK{\n \"statusCode\": 200,\n \"mensagem\": \"Dados obtidos com sucesso.\",\n \"erro\": null,\n \"ultimaPag\": 1,\n \"resultados\": [\n [\n \"matricula\",\n \"ano\",\n \"mes\",\n \"interjornada\",\n \"estouro_6x1\",\n \"estouro_dom\",\n \"hora_extra_2h\",\n \"turno_acima_6h\",\n \"intervalo_abaixo_1h\"\n ],\n [\n \"matr456\",\n \"2024\",\n \"1\",\n \"2\",\n \"0\",\n \"1\",\n \"5\",\n \"0\",\n \"3\"\n ]\n ]\n}\n400 – Excesso de DiasQuando o intervalo entre (mes_ini, ano_ini) e (mes_fim, ano_fim) resulta em mais de 31 dias equivalentes.
{\n \"mes_ini\": 1,\n \"ano_ini\": 2024,\n \"mes_fim\": 3,\n \"ano_fim\": 2024,\n \"lista_matriculas_colaboradores\": [\"matr456\"]\n}\n{\n \"statusCode\": 400,\n \"mensagem\": \"Requisicao mal-formada.\",\n \"erro\": \"O periodo inserido excede o limite desta requisicao (Um mês cheio (31 dias)).\",\n \"ultimaPag\": null,\n \"resultados\": null\n}\n400 – Erro de SchemaCampo fora do padrão, valor fora da faixa permitida (mês > 12, ano < 2017, lista vazia, item não-string, duplicado etc.).
{\n \"mes_ini\": 1,\n \"ano_ini\": 2024,\n \"mes_fim\": 1,\n \"ano_fim\": 2024,\n \"lista_matriculas_colaboradores\": []\n}\n{\n \"statusCode\": 400,\n \"mensagem\": \"Invalid request body\",\n \"erro\": \"[{\\\"instancePath\\\":\\\"/lista_matriculas_colaboradores\\\",\\\"schemaPath\\\":\\\"#/properties/lista_matriculas_colaboradores/minItems\\\",\\\"keyword\\\":\\\"minItems\\\",\\\"params\\\":{\\\"limit\\\":1},\\\"message\\\":\\\"must NOT have fewer than 1 items\\\"}]\",\n \"ultimaPag\": null,\n \"resultados\": null\n}\n401 – Token Expirado ou Inválido{\n \"mes_ini\": 1,\n \"ano_ini\": 2024,\n \"mes_fim\": 1,\n \"ano_fim\": 2024,\n \"lista_matriculas_colaboradores\": [\"matr456\"]\n}\n{ \"message\": \"The incoming token has expired\" }\n500 – Erro InternoFalha inesperada no servidor.
\n{\n \"mes_ini\": 1,\n \"ano_ini\": 2024,\n \"mes_fim\": 1,\n \"ano_fim\": 2024,\n \"lista_matriculas_colaboradores\": [\"matr456\"]\n}\n{\n \"statusCode\": 500,\n \"mensagem\": \"Erro ao processar a requisicao.\",\n \"erro\": \"Erro interno do servidor.\",\n \"ultimaPag\": null,\n \"resultados\": null\n}\n/infracoes-mes-filialRetorna contagem de infrações por mês e filial.
\nObter a contagem de infrações mensais por filial.
\n\n\nIMPORTANTE: intervalo máximo de 12 meses (≈ 372 dias).
\n
URL: https://moapi.escalamoavi.com.br/infracoes-mes-filial
Método: POST
Cabeçalho: moapi-token obrigatório.
{\n \"mes_ini\": \"01\",\n \"ano_ini\": 2023,\n \"mes_fim\": 2,\n \"ano_fim\": 2023,\n \"lista_cods_filiais\": [\"0001\", \"0005\"]\n}\n200 OK{\n \"statusCode\": 200,\n \"mensagem\": \"Dados obtidos com sucesso.\",\n \"erro\": null,\n \"ultimaPag\": 1,\n \"resultados\": [\n [\"filial_cod\", \"ano\", \"mes\", \"interjornada\", \"estouro_6x1\", \"estouro_dom\", \"hora_extra_2h\", \"turno_acima_6h\", \"intervalo_abaixo_1h\"],\n [\"0001\", \"2023\", \"1\", \"5\", \"2\", \"0\", \"10\", \"1\", \"3\"],\n [\"0005\", \"2023\", \"1\", \"3\", \"1\", \"1\", \"8\", \"0\", \"5\"],\n [\"0001\", \"2023\", \"2\", \"8\", \"0\", \"0\", \"12\", \"3\", \"2\"],\n [\"0005\", \"2023\", \"2\", \"2\", \"2\", \"0\", \"7\", \"1\", \"1\"]\n ]\n}\n400 – Excesso de DiasQuando o intervalo entre (mes_ini, ano_ini) e (mes_fim, ano_fim) ultrapassar 12 meses (≈ 372 dias).
{\n \"mes_ini\": \"01\",\n \"ano_ini\": 2022,\n \"mes_fim\": \"02\",\n \"ano_fim\": 2023,\n \"lista_cods_filiais\": [\"0001\"]\n}\n{\n \"statusCode\": 400,\n \"mensagem\": \"Requisicao mal-formada.\",\n \"erro\": \"O periodo inserido contempla 398 dias, excedendo assim o limite deste endpoint (Doze meses cheios (372 dias))!\",\n \"ultimaPag\": null,\n \"resultados\": null\n}\n\n\nO número de dias exibido na mensagem varia conforme a requisição; o exemplo acima é ilustrativo.
\n
400 – Erro de SchemaQualquer campo fora do esperado (mês > 12, ano < 2017, lista vazia ou contendo valores de tipo errado, etc.).
\n{\n \"statusCode\": 400,\n \"mensagem\": \"Invalid request body\",\n \"erro\": \"[detalhes do erro de validacao]\",\n \"ultimaPag\": null,\n \"resultados\": null\n}\n401 – Token Expirado ou Inválido{ \"message\": \"The incoming token has expired\" }\n500 – Erro InternoFalha inesperada no servidor.
\n{\n \"mes_ini\": \"01\",\n \"ano_ini\": 2023,\n \"mes_fim\": 2,\n \"ano_fim\": 2023,\n \"lista_cods_filiais\": [\"0001\", \"0005\"]\n}\n{\n \"statusCode\": 500,\n \"mensagem\": \"Erro ao processar a requisicao.\",\n \"erro\": \"[detalhes internos]\",\n \"ultimaPag\": null,\n \"resultados\": null\n}\nJanela máxima: 62 dias. ASSINCRONO (resultados=null na primeira chamada; re-buscar).
\n3 métricas planejadas (não as 6 do realizado acima).
\nFilial sem escala montada é OMITIDA; com escala e sem infracao = 0.
\nColunas: filial_cod, data, interjornada, estouro_6x1, estouro_dom.
\n","urlObject":{"protocol":"https","path":["infracoes-plan-dia-filial"],"host":["moapi","escalamoavi","com","br"],"query":[],"variable":[]}},"response":[{"id":"1876f2ae-8d2c-4732-abf8-877cd71ef02f","name":"200-sucesso","originalRequest":{"method":"POST","header":[{"key":"moapi-token","value":"Janela máxima: 372 dias. ASSINCRONO (resultados=null na primeira chamada; re-buscar).
\n3 métricas planejadas.
\nOmissao = sem escala montada.
\nColunas: filial_cod, ano, mes, interjornada, estouro_6x1, estouro_dom.
\n","urlObject":{"protocol":"https","path":["infracoes-plan-mes-filial"],"host":["moapi","escalamoavi","com","br"],"query":[],"variable":[]}},"response":[{"id":"377c524e-fc90-4f22-981e-034bcc77857e","name":"200-sucesso","originalRequest":{"method":"POST","header":[{"key":"moapi-token","value":"Fornece IQEs agregados por dia e discriminados por cluster.
\nO usuário deve fornecer datas inicial (\"data_ini\") e final (\"data_fim\") em formato \"AAAA-MM-DD\".
\nO número total de dias correspondentes (\"daterange\") não pode exceder 12 meses cheios (12*31 dias).
\nEm \"lista_nomes_clusters\" espera-se uma lista contendo strings que correspondam a nomes de clusters cadastrados na MOAVI. Para que dados de todos clusters sejam retornados, o input deve ser \"lista_nomes_clusters\": [\"*\"]
\nSe houver necessidade de paginação, em requisições posteriores o usuário deve incluir no body a chave \"pag\" com um inteiro positivo.
\n\"mensagem\" conterá uma string que informa brevemente sobre sucesso ou fracasso da request. Algumas requisições podem resultar em avisos neste campo.
\n\"erro\", se aplicável, trará string detalhando o motivo de fracasso da requisição. Se não, retorna como null
\n\"ultimaPag\", fornece a página (integer) do último lote de resultados. Em casos de erro, por exemplo, retorna como null.
\n\"statusCode\" informa o código HTTP da resposta, um integer.
\n\"resultados\", se não null, trata-se de uma lista de listas. As listas internas sempre tem 3 elementos, cada, todos string.
\nA primeira lista aninhada é sempre [\"nome_cluster\", \"data\", \"iqe\"].
\nAs demais conterão strings com valores respectivos, ex: [\"cluster1\", \"2024-06-11\", \"0.83\"] significaria que no dia 11 de junho de 2024, o cluster \"cluster1\" performou com \"0.813\" (81,3%) de IQE.
\nFornece os IQES por dia e por filial.
\nO usuário deve fornecer datas inicial (\"data_ini\") e final (\"data_fim\") em formato \"AAAA-MM-DD\".
\nO número total de dias correspondentes (\"daterange\") não pode exceder 62 dias - dois meses cheios.
\nEm \"lista_cods_filiais\" espera-se uma lista contendo strings ou inteiros que correspondam a códigos de filiais cadastradas na MOAVI. Para que dados de todas filiais sejam retornados, o input deve ser \"lista_cods_filiais\": [\"*\"]
\nSe houver necessidade de paginação, em requisições posteriores o usuário deve incluir no body a chave \"pag\" com um inteiro positivo.
\n\"mensagem\" conterá uma string que informa brevemente sobre sucesso ou fracasso da request. Algumas requisições podem resultar em avisos neste campo.
\"erro\", se aplicável, trará string detalhando o motivo de fracasso da requisição. Se não, retorna como null
\n\"ultimaPag\", fornece a página (integer) do último lote de resultados. Em casos de erro, por exemplo, retorna como null.
\n\"statusCode\" informa o código HTTP da resposta, um integer.
\n\"resultados\", se não null, trata-se de uma lista de listas. As listas internas sempre tem 3 elementos, cada, todos string.
\nA primeira lista aninhada é sempre [\"filial_cod\", \"data\", \"iqe\"].
\nAs demais conterão strings com valores respectivos, ex: [\"0001\", \"2024-06-11\", \"0.976\"] significaria que no dia 11 de junho de 2024, a filial \"0001\" performou com \"0.976\" (97,6%) de IQE médio.
\nEste endpoint é usado para recuperar dados de IQE com base em parâmetros específicos relacionados a meses e anos para um determinado cluster.
\nCorpo da Requisição
\nmes_ini (string ou integer): O mês inicial deve ser uma string no formato \"MM\" ou um número inteiro entre 1-12.
\nano_ini (string ou integer): O ano inicial deve ser uma string no formato \"AAAA\" ou um número inteiro entre 2017 e 2100.
\nmes_fim (string ou integer): O mês final deve ser uma string no formato \"MM\" ou um número inteiro entre 1-12 após o mês inicial.
\nano_fim (string ou integer): O ano final deve ser uma string no formato \"AAAA\" ou um número inteiro entre 2017 e 2100.
\nlista_nomes_clusters: array de strings, ou informe \"lista_nomes_clusters\": [\"*\"] para solicitar dados de todos clusters.
\nOPCIONAL pag (integer): O número da página dos resultados. Só tem utilidade se consultas paginadas forem necessárias.
\nResposta
\nstatusCode (integer): O código de status da resposta.
\nmensagem (string): Qualquer mensagem relevante.
\nerro (null): Informações de erro, se houver.
\nultimaPag (integer): O número da última página com dados referentes à consulta em questão. Se consultas subsequentes forem necessárias para buscar todos os dados, ultimaPag>1.
\nresultados (array de arrays): Os dados resultantes.
\nA primeira lista aninhada é sempre [\"nome_cluster\", \"ano\", \"mes\", \"iqe\"].
\nAs demais conterão strings com valores respectivos, ex: [\"cluster7\", \"2023\", \"10\", \"0.2112\"] significaria que no mês de outubro de 2023, o cluster \"cluster7\" performou com um valor médio de 21,12% em seu IQE.
\nEste endpoint é usado para recuperar dados de IQE com base em parâmetros específicos relacionados a meses e anos para uma determinada filial.
\nCorpo da Requisição
\nmes_ini (string ou integer): O mês inicial deve ser uma string no formato \"MM\" ou um número inteiro entre 1-12.
\nano_ini (string ou integer): O ano inicial deve ser uma string no formato \"AAAA\" ou um número inteiro entre 2017 e 2100.
\nmes_fim (string ou integer): O mês final deve ser uma string no formato \"MM\" ou um número inteiro entre 1-12 após o mês inicial.
\nano_fim (string ou integer): O ano final deve ser uma string no formato \"AAAA\" ou um número inteiro entre 2017 e 2100.
\nlista_cods_filiais: array de strings, inteiros, ou \"*\" para solicitar dados de todas filiais.
\nOPCIONAL pag (integer): O número da página dos resultados. Só tem utilidade se consultas paginadas forem necessárias.
\nResposta
\nstatusCode (integer): O código de status da resposta.
\nmensagem (string): Qualquer mensagem relevante.
\nerro (null): Informações de erro, se houver.
\nultimaPag (integer): O número da última página com dados referentes à consulta em questão. Se consultas subsequentes forem necessárias para buscar todos os dados, ultimaPag>1.
\nresultados (array de arrays): Os dados resultantes.
\nA primeira lista aninhada é sempre [\"filial_cod\", \"ano\", \"mes\", \"iqe\"].
\nAs demais conterão strings com valores respectivos, ex: [\"1916\", \"2024\", \"6\", \"0.6942\"] significaria que no mês de junho de 2024, a filial \"1916\" performou com um valor médio de 69,42% em seu IQE.
\n/justificativas-dia-clusterFornece justificativas agregadas por dia e por cluster.
\nRetornar as justificativas diárias de cada cluster em determinado intervalo.
\n\n\nIMPORTANTE:
\n
• Limite de 372 dias por consulta (≈ 12 × 31).
URL: https://moapi.escalamoavi.com.br/justificativas-dia-cluster
Método: POST
Cabeçalho: obrigatório moapi-token.
{\n \"data_ini\": \"2024-01-01\",\n \"data_fim\": \"2024-03-31\",\n \"lista_nomes_clusters\": [\"cluster_A\", \"cluster_B\"],\n \"pag\": 1\n}\n200 OK{\n \"statusCode\": 200,\n \"mensagem\": \"Dados obtidos com sucesso.\",\n \"erro\": null,\n \"ultimaPag\": 1,\n \"resultados\": [\n [\"nome_cluster\", \"data\", \"justificativas\"],\n [\"cluster_A\", \"2024-01-15\", \"Manutencao programada na regiao.\"],\n [\"cluster_A\", \"2024-01-16\", \"Interrupcao de fornecimento pela concessionaria.\"],\n [\"cluster_B\", \"2024-02-10\", \"Feriado local.\"]\n ]\n}\n400 – Excesso de Dias{\n \"statusCode\": 400,\n \"mensagem\": \"Requisicao mal-formada.\",\n \"erro\": \"O periodo inserido contempla 373 dias, excedendo assim o limite deste endpoint (Doze meses cheios (372 dias))!\",\n \"ultimaPag\": null,\n \"resultados\": null\n}\n400 – Erro de Schema{\n \"statusCode\": 400,\n \"mensagem\": \"Invalid request body\",\n \"erro\": \"[detalhes da validação]\",\n \"ultimaPag\": null,\n \"resultados\": null\n}\n401 – Token Expirado{ \"message\": \"The incoming token has expired\" }\n500 – Erro Interno{\n \"statusCode\": 500,\n \"mensagem\": \"Erro ao processar a requisicao.\",\n \"erro\": \"[detalhes internos]\",\n \"ultimaPag\": null,\n \"resultados\": null\n}\n/justificativas-dia-colaboradorRetorna justificativas (quantidade) por dia e por colaborador.
\nObter o número de justificativas diárias para cada matrícula solicitada.
\n\n\nIMPORTANTE:
\n
• Limite: 10 dias corridos.
• Lista[\"*\"]devolve todos os colaboradores.
URL: https://moapi.escalamoavi.com.br/justificativas-dia-colaborador
Método: POST
Cabeçalho: moapi-token obrigatório.
{\n \"data_ini\": \"2024-03-01\",\n \"data_fim\": \"2024-03-08\",\n \"lista_matriculas_colaboradores\": [\"matr456\", \"matrABC\"]\n}\n200 OK{\n \"statusCode\": 200,\n \"mensagem\": \"Dados obtidos com sucesso.\",\n \"erro\": null,\n \"ultimaPag\": 1,\n \"resultados\": [\n [\"matricula\", \"data\", \"justificativas\"],\n [\"matr456\", \"2024-03-01\", \"1\"],\n [\"matr456\", \"2024-03-02\", \"0\"],\n [\"matrABC\", \"2024-03-01\", \"1\"]\n ]\n}\n400 – Excesso de DiasSe o intervalo entre data_ini e data_fim exceder o limite de 10 dias corridos.
{\n \"statusCode\": 400,\n \"mensagem\": \"Requisicao mal-formada.\",\n \"erro\": \"O periodo inserido contempla 15 dias, excedendo assim o limite deste endpoint (Dez dias corridos (10 dias))!\",\n \"ultimaPag\": null,\n \"resultados\": null\n}\n400 – Erro de SchemaAlgum campo fora do esperado (formato de data inválido, lista vazia, item numérico em vez de string etc.).
\n{\n \"statusCode\": 400,\n \"mensagem\": \"Invalid request body\",\n \"erro\": \"[instance.lista_matriculas_colaboradores[0] is not of a type(s) string]\",\n \"ultimaPag\": null,\n \"resultados\": null\n}\n401 – Token Expirado ou Inválido{ \"message\": \"The incoming token has expired\" }\n500 – Erro InternoFalha inesperada no servidor.
\n{\n \"statusCode\": 500,\n \"mensagem\": \"Erro ao processar a requisicao.\",\n \"erro\": \"[detalhes internos]\",\n \"ultimaPag\": null,\n \"resultados\": null\n}\n/justificativas-dia-filialFornece justificativas textuais por dia e filial.
\nRetornar as justificativas textuais diárias por filial dentro de um período.
\n\n\nIMPORTANTE: limite de 62 dias por consulta.
\n
URL: https://moapi.escalamoavi.com.br/justificativas-dia-filial
Método: POST
Cabeçalho: moapi-token obrigatório.
{\n \"data_ini\": \"2024-04-01\",\n \"data_fim\": \"2024-04-30\",\n \"lista_cods_filiais\": [\"0001\", \"0005\"],\n \"pag\": 1\n}\n200 OK{\n \"statusCode\": 200,\n \"mensagem\": \"Dados obtidos com sucesso.\",\n \"erro\": null,\n \"ultimaPag\": 1,\n \"resultados\": [\n [\"filial_cod\", \"data\", \"justificativas\"],\n [\"0001\", \"2024-04-10\", \"Feriado municipal e sistema fora do ar.\"],\n [\"0005\", \"2024-04-15\", \"Equipe em treinamento externo.\"]\n ]\n}\n400 – Excesso de DiasQuando o intervalo entre data_ini e data_fim ultrapassa 62 dias.
{\n \"statusCode\": 400,\n \"mensagem\": \"Requisicao mal-formada.\",\n \"erro\": \"O periodo inserido contempla 70 dias, excedendo assim o limite deste endpoint (Dois meses cheios (62 dias))!\",\n \"ultimaPag\": null,\n \"resultados\": null\n}\n400 – Erro de SchemaQualquer violação de formato ou regra de validação (data inválida, lista vazia, tipo de dado incorreto etc.).
\n{\n \"statusCode\": 400,\n \"mensagem\": \"Invalid request body\",\n \"erro\": \"[{\\\"validation\\\":\\\"minItems\\\",\\\"code\\\":\\\"too_small\\\",\\\"message\\\":\\\"Array must contain at least 1 element(s)\\\",\\\"path\\\":[\\\"lista_cods_filiais\\\"]}]\",\n \"ultimaPag\": null,\n \"resultados\": null\n}\n401 – Token Expirado ou Inválido{\n \"message\": \"The incoming token has expired\"\n}\n500 – Erro InternoFalha inesperada no servidor.
\n{\n \"statusCode\": 500,\n \"mensagem\": \"Erro ao processar a requisicao.\",\n \"erro\": \"Falha na conexao com o banco de dados.\",\n \"ultimaPag\": null,\n \"resultados\": null\n}\n/justificativas-mes-clusterDevolve justificativas por mês e cluster.
\nRetornar as justificativas mensais por cluster.
\n\n\nIMPORTANTE: intervalo máximo de dois anos cheios (730 dias).
\n
URL: https://moapi.escalamoavi.com.br/justificativas-mes-cluster
Método: POST
Cabeçalho: moapi-token obrigatório.
{\n \"mes_ini\": \"01\",\n \"ano_ini\": 2022,\n \"mes_fim\": 12,\n \"ano_fim\": 2022,\n \"lista_nomes_clusters\": [\"cluster_A\", \"cluster_B\"]\n}\n200 OK{\n \"statusCode\": 200,\n \"mensagem\": \"Dados obtidos com sucesso.\",\n \"erro\": null,\n \"ultimaPag\": 1,\n \"resultados\": [\n [\"nome_cluster\", \"ano\", \"mes\", \"justificativas\"],\n [\"cluster_A\", \"2022\", \"4\", \"Manutencao programada na regiao\"],\n [\"cluster_A\", \"2022\", \"5\", \"Feriado prolongado impactou a leitura\"]\n ]\n}\n400 – Excesso de DiasQuando o intervalo entre (mes_ini, ano_ini) e (mes_fim, ano_fim) excede 730 dias.
{\n \"mes_ini\": \"01\",\n \"ano_ini\": 2020,\n \"mes_fim\": \"02\",\n \"ano_fim\": 2022,\n \"lista_nomes_clusters\": [\"cluster_A\"]\n}\n{\n \"statusCode\": 400,\n \"mensagem\": \"Requisicao mal-formada.\",\n \"erro\": \"O periodo inserido contempla 762 dias, excedendo assim o limite deste endpoint (Dois anos cheios (730 dias))!\",\n \"ultimaPag\": null,\n \"resultados\": null\n}\n400 – Erro de SchemaViolação de formato, valor fora de faixa (mês > 12, ano < 2017), lista vazia, item duplicado, etc.
\n{\n \"mes_ini\": \"1\",\n \"ano_ini\": 2023,\n \"mes_fim\": \"13\",\n \"ano_fim\": 2023,\n \"lista_nomes_clusters\": [\"cluster_A\", \"cluster_A\"]\n}\n{\n \"statusCode\": 400,\n \"mensagem\": \"Invalid request body\",\n \"erro\": \"[{\\\"validation\\\":\\\"pattern\\\",\\\"code\\\":\\\"invalid_string\\\",\\\"message\\\":\\\"Invalid string value. Expected a value matching the pattern /^(0[1-9]|1[0-2])$/\\\",\\\"path\\\":[\\\"mes_fim\\\"]},{\\\"validation\\\":\\\"uniqueItems\\\",\\\"code\\\":\\\"not_unique\\\",\\\"message\\\":\\\"Array must not contain duplicate elements\\\",\\\"path\\\":[\\\"lista_nomes_clusters\\\"]}]\",\n \"ultimaPag\": null,\n \"resultados\": null\n}\n401 – Token Expirado ou Inválido{\n \"mes_ini\": \"01\",\n \"ano_ini\": 2023,\n \"mes_fim\": \"01\",\n \"ano_fim\": 2023,\n \"lista_nomes_clusters\": [\"cluster_C\"]\n}\n{\n \"message\": \"The incoming token has expired\"\n}\n500 – Erro InternoFalha inesperada no servidor.
\n{\n \"mes_ini\": \"01\",\n \"ano_ini\": 2023,\n \"mes_fim\": \"03\",\n \"ano_fim\": 2023,\n \"lista_nomes_clusters\": [\"*\"]\n}\n{\n \"statusCode\": 500,\n \"mensagem\": \"Erro ao processar a requisicao.\",\n \"erro\": \"Falha na conexao com o banco de dados.\",\n \"ultimaPag\": null,\n \"resultados\": null\n}\n/justificativas-mes-colaboradorRetorna justificativas totais por mês e colaborador.
\nConsultar a quantidade de justificativas mensais por matrícula.
\n\n\nIMPORTANTE: limite: Um mês cheio (31 dias).
\n
URL: https://moapi.escalamoavi.com.br/justificativas-mes-colaborador
Método: POST
Cabeçalho: moapi-token obrigatório.
{\n \"mes_ini\": 1,\n \"ano_ini\": 2024,\n \"mes_fim\": 1,\n \"ano_fim\": 2024,\n \"lista_matriculas_colaboradores\": [\"matr456\"]\n}\n200 OK{\n \"statusCode\": 200,\n \"mensagem\": \"Dados obtidos com sucesso.\",\n \"erro\": null,\n \"ultimaPag\": 1,\n \"resultados\": [\n [\"matricula\", \"ano\", \"mes\", \"justificativas\"],\n [\"matr456\", \"2024\", \"1\", \"8\"]\n ]\n}\n400 – Excesso de DiasQuando o intervalo entre (mes_ini, ano_ini) e (mes_fim, ano_fim) resulta em mais de 31 dias equivalentes.
{\n \"mes_ini\": 1,\n \"ano_ini\": 2024,\n \"mes_fim\": 3,\n \"ano_fim\": 2024,\n \"lista_matriculas_colaboradores\": [\"matr456\"]\n}\n{\n \"statusCode\": 400,\n \"mensagem\": \"Requisicao mal-formada.\",\n \"erro\": \"O periodo inserido contempla 60 dias, excedendo assim o limite desta requisicao (Um mês cheio (31 dias))!\",\n \"ultimaPag\": null,\n \"resultados\": null\n}\n400 – Erro de SchemaCampo fora do padrão, valor fora da faixa permitida (mês > 12, ano < 2017, lista vazia, item não-string, duplicado etc.).
{\n \"mes_ini\": 1,\n \"ano_ini\": 2024,\n \"mes_fim\": 1,\n \"ano_fim\": 2024,\n \"lista_matriculas_colaboradores\": []\n}\n{\n \"statusCode\": 400,\n \"mensagem\": \"Invalid request body\",\n \"erro\": \"[{\\\"instancePath\\\":\\\"/lista_matriculas_colaboradores\\\",\\\"schemaPath\\\":\\\"#/properties/lista_matriculas_colaboradores/minItems\\\",\\\"keyword\\\":\\\"minItems\\\",\\\"params\\\":{\\\"limit\\\":1},\\\"message\\\":\\\"must NOT have fewer than 1 items\\\"}]\",\n \"ultimaPag\": null,\n \"resultados\": null\n}\n401 – Token Expirado ou Inválido{\n \"message\": \"The incoming token has expired\"\n}\n500 – Erro InternoFalha inesperada no servidor.
\n{\n \"statusCode\": 500,\n \"mensagem\": \"Erro ao processar a requisicao.\",\n \"erro\": \"Internal Server Error\",\n \"ultimaPag\": null,\n \"resultados\": null\n}\n/justificativas-mes-filialRetorna justificativas por mês e filial.
\nObter as justificativas mensais por filial.
\n\n\nIMPORTANTE: intervalo máximo de 12 meses (≈ 372 dias).
\n
URL: https://moapi.escalamoavi.com.br/justificativas-mes-filial
Método: POST
Cabeçalho: moapi-token obrigatório.
{\n \"mes_ini\": \"03\",\n \"ano_ini\": 2023,\n \"mes_fim\": 10,\n \"ano_fim\": 2023,\n \"lista_cods_filiais\": [\"0010\", \"0015\"]\n}\n200 OK{\n \"statusCode\": 200,\n \"mensagem\": \"Dados obtidos com sucesso.\",\n \"erro\": null,\n \"ultimaPag\": 1,\n \"resultados\": [\n [\"filial_cod\", \"ano\", \"mes\", \"justificativas\"],\n [\"0010\", \"2023\", \"3\", \"Aumento de demanda sazonal.\"],\n [\"0015\", \"2023\", \"3\", \"Obras na regiao impactaram o fluxo de clientes.\"]\n ]\n}\n400 – Excesso de DiasQuando o intervalo entre (mes_ini, ano_ini) e (mes_fim, ano_fim) ultrapassar 12 meses (≈ 372 dias).
{\n \"statusCode\": 400,\n \"mensagem\": \"Requisicao mal-formada.\",\n \"erro\": \"O periodo inserido contempla 425 dias, excedendo assim o limite deste endpoint (Doze meses cheios (372 dias))!\",\n \"ultimaPag\": null,\n \"resultados\": null\n}\n\n\nO número de dias exibido na mensagem varia conforme a requisição; o exemplo acima é ilustrativo.
\n
400 – Erro de SchemaQualquer campo fora do esperado (mês > 12, ano < 2017, lista vazia ou contendo valores de tipo errado, etc.).
\n{\n \"statusCode\": 400,\n \"mensagem\": \"Invalid request body\",\n \"erro\": \"[{\\\"validation\\\":\\\"minItems\\\",\\\"code\\\":\\\"too_small\\\",\\\"message\\\":\\\"Array must contain at least 1 element(s)\\\",\\\"path\\\":[\\\"lista_cods_filiais\\\"]}]\",\n \"ultimaPag\": null,\n \"resultados\": null\n}\n401 – Token Expirado ou Inválido{ \"message\": \"The incoming token has expired\" }\n500 – Erro InternoFalha inesperada no servidor.
\n{\n \"statusCode\": 500,\n \"mensagem\": \"Erro ao processar a requisicao.\",\n \"erro\": \"Internal Server Error\",\n \"ultimaPag\": null,\n \"resultados\": null\n}\n/plan-banco-mais-dia-colaboradorFornece horas a mais planejadas por dia e colaborador.
\nRetornar as horas a mais planejadas, agregadas por dia e discriminadas por colaborador.
\n\n\nIMPORTANTE:
\n
- assim como nos outros endpoints \"/plan-banco*\" os valores de saldo estão em minutos!
- existe um limite de 10 dias corridos para obtenção dos lotes de dados.
URL: https://moapi.escalamoavi.com.br/plan-banco-mais-dia-colaborador
Método: POST
Cabeçalho: É obrigatório usar moapi-token com token válido.
{\n \"pag\": 1,\n \"data_ini\": \"2024-01-01\",\n \"data_fim\": \"2024-01-07\",\n \"lista_matriculas_colaboradores\": [\"matricula123\", \"matriculaXYZ\"]\n}\n\n200:{\n \"statusCode\": 200,\n \"mensagem\": \"Dados obtidos com sucesso.\",\n \"erro\": null,\n \"ultimaPag\": 1,\n \"resultados\": [\n [\"matricula\", \"data\", \"horas_mais\"],\n [\"matricula123\", \"2024-01-01\", \"360\"],\n [\"matricula123\", \"2024-01-02\", \"420\"],\n [\"matriculaXYZ\", \"2024-01-01\", \"300\"],\n [\"matriculaXYZ\", \"2024-01-02\", \"480\"]\n ]\n}\n\n400 - Excesso de Dias{\n \"statusCode\": 400,\n \"mensagem\": \"Requisicao mal-formada.\",\n \"erro\": \"O periodo inserido contempla X dias, excedendo assim o limite deste endpoint!\",\n \"ultimaPag\": null,\n \"resultados\": null\n}\n\n400 - Erro de Schema{\n \"statusCode\": 400,\n \"mensagem\": \"Invalid request body\",\n \"erro\": \"[detalhes do erro de validacao]\",\n \"ultimaPag\": null,\n \"resultados\": null\n}\n\n401 - Token Expirado ou Invalido{\n \"message\": \"The incoming token has expired\"\n}\n\n500 - Erro Interno{\n \"statusCode\": 500,\n \"mensagem\": \"Erro ao processar a requisicao.\",\n \"erro\": \"[detalhes do erro interno]\",\n \"ultimaPag\": null,\n \"resultados\": null\n}\n\nEste endpoint retorna as horas \"a mais\" planejadas por dia e filial, baseadas no banco de horas.
\n\n\nIMPORTANTE:
\n
- assim como nos outros endpoints \"/plan-banco*\" os valores de saldo estão em minutos!
- existe um limite de 10 dias corridos para obtenção dos lotes de dados.
Método: POST
Cabeçalho da Requisição:
\nmoapi-token: <seu-IdToken>\n\nParâmetros da Requisição:
\npag: (Integer, opcional) Número da página para paginação. Usado para grandes conjuntos de resultados. Valor padrão: 1.
data_ini: (String, obrigatório) Data inicial no formato \"AAAA-MM-DD\". Anos aceitos de 2017 a 2100.
data_fim: (String, obrigatório) Data final no formato \"AAAA-MM-DD\". Anos aceitos de 2017 a 2100.
lista_cods_filiais: (Array de Strings, obrigatório) Lista de códigos de filial. Para todas as filiais, use [\"*\"]
Observações:
\nOs códigos de filial na lista_cods_filiais devem ser strings.
O endpoint utiliza paginação para grandes conjuntos de dados. Use o parâmetro pag para acessar as demais páginas.
Assegure-se de que o moapi-token fornecido no cabeçalho seja válido e não esteja expirado.
/plan-banco-mais-mes-colaboradorFornece as horas a mais planejadas, agregadas por mês e colaborador.
\nRetornar a soma das horas a mais planejadas para cada colaborador, mês a mês, com base no banco de horas.
\n\n\nIMPORTANTE: assim como nos outros endpoints /plan-banco*, os valores de saldo aqui também estão em minutos.
\n
URL:
\nhttps://moapi.escalamoavi.com.br/plan-banco-mais-mes-colaborador\n\nMétodo:
\nPOST\n\nCabeçalho:
\nmoapi-token: <seu-IdToken>\n\n{\n \"pag\": 1,\n \"mes_ini\": \"01\",\n \"ano_ini\": 2024,\n \"mes_fim\": 12,\n \"ano_fim\": \"2024\",\n \"lista_matriculas_colaboradores\": [\"123\", \"456\"]\n}\n\n200 - Sucesso{\n \"statusCode\": 200,\n \"mensagem\": \"Dados obtidos com sucesso.\",\n \"erro\": null,\n \"ultimaPag\": 1,\n \"resultados\": [\n [\"matricula\", \"ano\", \"mes\", \"horas_mais\"],\n [\"colab1\", \"2024\", \"1\", \"480\"],\n [\"colab1\", \"2024\", \"2\", \"420\"],\n [\"colab2\", \"2024\", \"1\", \"360\"],\n [\"colab2\", \"2024\", \"2\", \"300\"]\n ]\n}\n\n400 - Excesso de DiasSe o período entre (mes_ini, ano_ini) e (mes_fim, ano_fim) extrapolar o limite suportado.
{\n \"statusCode\": 400,\n \"mensagem\": \"Requisicao mal-formada.\",\n \"erro\": \"O periodo inserido contempla X dias, excedendo assim o limite deste endpoint!\",\n \"ultimaPag\": null,\n \"resultados\": null\n}\n\n400 - Erro de SchemaSe algum campo estiver fora do formato esperado (ex. mes_fim = 13 ou ano_fim = 1900).
{\n \"statusCode\": 400,\n \"mensagem\": \"Invalid request body\",\n \"erro\": \"[detalhes do erro de validacao]\",\n \"ultimaPag\": null,\n \"resultados\": null\n}\n\n401 - Token Expirado ou Inválido{\n \"message\": \"The incoming token has expired\"\n}\n\n500 - Erro InternoProblema interno no servidor ao processar a requisição.
\n{\n \"statusCode\": 500,\n \"mensagem\": \"Erro ao processar a requisicao.\",\n \"erro\": \"[detalhes do erro interno]\",\n \"ultimaPag\": null,\n \"resultados\": null\n}\n\nEste endpoint retorna as horas \"a mais\" planejadas, agregadas por mês e filial, com base nos dados do banco de horas.
\n\n\nIMPORTANTE:
\n
- assim como nos outros endpoints \"/plan-banco*\" os valores de saldo estão em minutos!
Método: POST
Cabeçalho da Requisição:
\nmoapi-token: <seu-IdToken>\n\nParâmetros da Requisição:
\npag: (Integer, opcional) Número da página para paginação. Usado para grandes conjuntos de resultados. Valor padrão: 1.
mes_ini: (String, obrigatório) Mês inicial no formato \"MM\".
ano_ini: (Integer, obrigatório) Ano inicial (AAAA).
mes_fim: (String, obrigatório) Mês final no formato \"MM\".
ano_fim: (Integer, obrigatório) Ano final (AAAA).
lista_cods_filiais: (Array de Strings, obrigatório) Lista de códigos de filial. Para todas as filiais, use [\"*\"].
Observações:
\nOs códigos de filial na lista_cods_filiais devem ser strings.
O endpoint utiliza paginação para grandes conjuntos de dados. Use o parâmetro pag para acessar as demais páginas.
Assegure-se de que o moapi-token fornecido no cabeçalho seja válido e não esteja expirado.
/plan-banco-menos-dia-colaboradorFornece horas a menos planejadas por dia e colaborador.
\nRetornar o saldo de horas a menos planejadas, agregadas por dia e discriminadas por colaborador.
\n\n\nIMPORTANTE:
\n
- assim como nos outros endpoints \"/plan-banco*\" os valores de saldo estão em minutos!
- existe um limite de 10 dias corridos para obtenção dos lotes de dados.
URL: https://moapi.escalamoavi.com.br/plan-banco-menos-dia-colaborador
Método: POST
Cabeçalho: É obrigatório usar moapi-token com token válido.
{\n \"pag\": 1,\n \"data_ini\": \"2024-01-01\",\n \"data_fim\": \"2024-01-07\",\n \"lista_matriculas_colaboradores\": [\"matricula123\", \"matriculaXYZ\"]\n}\n\n200:{\n \"statusCode\": 200,\n \"mensagem\": \"Dados obtidos com sucesso.\",\n \"erro\": null,\n \"ultimaPag\": 1,\n \"resultados\": [\n [\"matricula\", \"data\", \"horas_menos\"],\n [\"matricula123\", \"2024-01-01\", \"-60\"],\n [\"matricula123\", \"2024-01-02\", \"-120\"],\n [\"matriculaXYZ\", \"2024-01-01\", \"-30\"],\n [\"matriculaXYZ\", \"2024-01-02\", \"-90\"]\n ]\n}\n\n400 - Excesso de Dias{\n \"statusCode\": 400,\n \"mensagem\": \"Requisicao mal-formada.\",\n \"erro\": \"O periodo inserido contempla X dias, excedendo assim o limite deste endpoint!\",\n \"ultimaPag\": null,\n \"resultados\": null\n}\n\n400 - Erro de Schema{\n \"statusCode\": 400,\n \"mensagem\": \"Invalid request body\",\n \"erro\": \"[detalhes do erro de validacao]\",\n \"ultimaPag\": null,\n \"resultados\": null\n}\n\n401 - Token Expirado ou Invalido{\n \"message\": \"The incoming token has expired\"\n}\n\n500 - Erro Interno{\n \"statusCode\": 500,\n \"mensagem\": \"Erro ao processar a requisicao.\",\n \"erro\": \"[detalhes do erro interno]\",\n \"ultimaPag\": null,\n \"resultados\": null\n}\n\nEste endpoint retorna as horas \"a menos\" planejadas por dia e filial, baseadas no banco de horas.
\n\n\nIMPORTANTE:
\n
- assim como nos outros endpoints \"/plan-banco*\" os valores de saldo estão em minutos!
- existe um limite de 10 dias corridos para obtenção dos lotes de dados.
Método: POST
Cabeçalho da Requisição:
\nmoapi-token: <seu-IdToken>\n\nParâmetros da Requisição:
\npag: (Integer, opcional) Número da página para paginação. Usado para grandes conjuntos de resultados. Valor padrão: 1.
data_ini: (String, obrigatório) Data inicial no formato \"AAAA-MM-DD\". Anos aceitos de 2017 a 2100.
data_fim: (String, obrigatório) Data final no formato \"AAAA-MM-DD\". Anos aceitos de 2017 a 2100.
lista_cods_filiais: (Array de Strings, obrigatório) Lista de códigos de filial. Para todas as filiais, use [\"*\"].
Observações:
\nOs códigos de filial na lista_cods_filiais devem ser strings.
O endpoint utiliza paginação para grandes conjuntos de dados. Use o parâmetro pag para acessar as demais páginas.
Assegure-se de que o moapi-token fornecido no cabeçalho seja válido e não esteja expirado.
/plan-banco-menos-mes-colaboradorFornece as horas a menos planejadas, agregadas por mês e colaborador.
\nRetornar a soma das horas a menos planejadas para cada colaborador, mês a mês, com base no banco de horas.
\n\n\nIMPORTANTE: assim como nos outros endpoints /plan-banco*, os valores de saldo aqui também estão em minutos.
\n
URL:
\nhttps://moapi.escalamoavi.com.br/plan-banco-menos-mes-colaborador\n\nMétodo:
\nPOST\n\nCabeçalho:
\nmoapi-token: <seu-IdToken>\n\n{\n \"pag\": 1,\n \"mes_ini\": \"01\",\n \"ano_ini\": 2024,\n \"mes_fim\": 12,\n \"ano_fim\": \"2024\",\n \"lista_matriculas_colaboradores\": [\"999\", \"1234\"]\n}\n\n200 - Sucesso{\n \"statusCode\": 200,\n \"mensagem\": \"Dados obtidos com sucesso.\",\n \"erro\": null,\n \"ultimaPag\": 1,\n \"resultados\": [\n [\"matricula\", \"ano\", \"mes\", \"horas_menos\"],\n [\"colab1\", \"2024\", \"1\", \"-480\"],\n [\"colab1\", \"2024\", \"2\", \"-420\"],\n [\"colab2\", \"2024\", \"1\", \"-360\"],\n [\"colab2\", \"2024\", \"2\", \"-300\"]\n ]\n}\n\n400 - Excesso de DiasSe o período entre (mes_ini, ano_ini) e (mes_fim, ano_fim) extrapolar o limite suportado.
{\n \"statusCode\": 400,\n \"mensagem\": \"Requisicao mal-formada.\",\n \"erro\": \"O periodo inserido contempla X dias, excedendo assim o limite deste endpoint!\",\n \"ultimaPag\": null,\n \"resultados\": null\n}\n\n400 - Erro de SchemaSe algum campo estiver fora do formato esperado (ex. mes_fim = 13 ou ano_fim = 1900).
{\n \"statusCode\": 400,\n \"mensagem\": \"Invalid request body\",\n \"erro\": \"[detalhes do erro de validacao]\",\n \"ultimaPag\": null,\n \"resultados\": null\n}\n\n401 - Token Expirado ou Inválido{\n \"message\": \"The incoming token has expired\"\n}\n\n500 - Erro InternoProblema interno no servidor ao processar a requisição.
\n{\n \"statusCode\": 500,\n \"mensagem\": \"Erro ao processar a requisicao.\",\n \"erro\": \"[detalhes do erro interno]\",\n \"ultimaPag\": null,\n \"resultados\": null\n}\n\nEste endpoint retorna as horas \"a menos\" planejadas, agregadas por mês e filial, com base nos dados do banco de horas.
\n\n\nIMPORTANTE:
\n
- assim como nos outros endpoints \"/plan-banco*\" os valores de saldo estão em minutos!
Método: POST
Cabeçalho da Requisição:
\nmoapi-token: <seu-IdToken>\n\nParâmetros da Requisição:
\npag: (Integer, opcional) Número da página para paginação. Usado para grandes conjuntos de resultados. Valor padrão: 1.
mes_ini: (String ou Integer, obrigatório) Mês inicial no formato \"MM\" ou um número inteiro representando o mês.
ano_ini: (String ou Integer, obrigatório) Ano inicial no formato \"AAAA\" ou um número inteiro representando o ano.
mes_fim: (String ou Integer, obrigatório) Mês final no formato \"MM\" ou um número inteiro representando o mês.
ano_fim: (String ou Integer, obrigatório) Ano final no formato \"AAAA\" ou um número inteiro representando o ano.
lista_cods_filiais: (Array de Strings, obrigatório) Lista de códigos de filial. Para todas as filiais, use [\"*\"].
Observações:
\nOs códigos de filial na lista_cods_filiais devem ser strings.
O endpoint utiliza paginação para grandes conjuntos de dados. Use o parâmetro pag para acessar as demais páginas.
Assegure-se de que o moapi-token fornecido no cabeçalho seja válido e não esteja expirado.
/plan-banco-saldo-dia-colaboradorFornece o saldo planejado (do banco de horas) por dia e colaborador.
\nRetornar o saldo diário planejado do banco de horas, organizado por dia e discriminado por colaborador.
\n\n\nIMPORTANTE:
\n
- assim como nos outros endpoints \"/plan-banco*\" os valores de saldo estão em minutos!
- existe um limite de 10 dias corridos para obtenção dos lotes de dados.
URL: https://moapi.escalamoavi.com.br/plan-banco-saldo-dia-colaborador
Método: POST
Cabeçalho: É obrigatório usar moapi-token com token válido.
{\n \"pag\": 1,\n \"data_ini\": \"2024-01-01\",\n \"data_fim\": \"2024-01-07\",\n \"lista_matriculas_colaboradores\": [\"matricula123\", \"matriculaXYZ\"]\n}\n\n200:{\n \"statusCode\": 200,\n \"mensagem\": \"Dados obtidos com sucesso.\",\n \"erro\": null,\n \"ultimaPag\": 1,\n \"resultados\": [\n [\"matricula\", \"data\", \"saldo_horas\"],\n [\"matricula123\", \"2024-01-01\", \"300\"],\n [\"matricula123\", \"2024-01-02\", \"420\"],\n [\"matriculaXYZ\", \"2024-01-01\", \"-60\"],\n [\"matriculaXYZ\", \"2024-01-02\", \"-10\"]\n ]\n}\n\n\n\nObservação: o campo
\nsaldo_horaspode vir em forma de valor positivo ou negativo, representando o saldo para cada dia.
400 - Excesso de Dias{\n \"statusCode\": 400,\n \"mensagem\": \"Requisicao mal-formada.\",\n \"erro\": \"O periodo inserido contempla X dias, excedendo assim o limite deste endpoint!\",\n \"ultimaPag\": null,\n \"resultados\": null\n}\n\n400 - Erro de Schema{\n \"statusCode\": 400,\n \"mensagem\": \"Invalid request body\",\n \"erro\": \"[detalhes do erro de validacao]\",\n \"ultimaPag\": null,\n \"resultados\": null\n}\n\n401 - Token Expirado ou Invalido{\n \"message\": \"The incoming token has expired\"\n}\n\n500 - Erro Interno{\n \"statusCode\": 500,\n \"mensagem\": \"Erro ao processar a requisicao.\",\n \"erro\": \"[detalhes do erro interno]\",\n \"ultimaPag\": null,\n \"resultados\": null\n}\n\nEste endpoint retorna o saldo planejado do banco de horas por dia e filial.
\n\n\nIMPORTANTE:
\n
- assim como nos outros endpoints \"/plan-banco*\" os valores de saldo estão em minutos!
- existe um limite de 10 dias corridos para obtenção dos lotes de dados.
Método: POST
Cabeçalho da Requisição:
\nmoapi-token: <seu-IdToken>\n\nParâmetros da Requisição:
\npag: (Integer, opcional) Número da página para paginação. Usado para grandes conjuntos de resultados. Valor padrão: 1.
data_ini: (String, obrigatório) Data inicial no formato \"AAAA-MM-DD\".
data_fim: (String, obrigatório) Data final no formato \"AAAA-MM-DD\".
lista_cods_filiais: (Array de Strings, obrigatório) Lista de códigos de filial. Para todas as filiais, use [\"*\"].
Observações:
\nOs códigos de filial na lista_cods_filiais devem ser strings.
O endpoint utiliza paginação para grandes conjuntos de dados. Use o parâmetro pag para acessar as demais páginas.
Assegure-se de que o moapi-token fornecido no cabeçalho seja válido e não esteja expirado.
/plan-banco-saldo-mes-colaboradorFornece o saldo planejado (positivo ou negativo) do banco de horas, agregado por mês e colaborador.
\nRetornar o saldo planejado do banco de horas, agrupado por mês para cada colaborador.
\n\n\nIMPORTANTE:
\n
- assim como nos outros endpoints /plan-banco*, os valores são retornados em minutos.
URL: https://moapi.escalamoavi.com.br/plan-banco-saldo-mes-colaborador
Método: POST
Cabeçalho: É obrigatório usar moapi-token com token válido.
{\n \"pag\": 1,\n \"mes_ini\": \"01\",\n \"ano_ini\": 2024,\n \"mes_fim\": 12,\n \"ano_fim\": \"2024\",\n \"lista_matriculas_colaboradores\": [\"matriculaX\", \"matriculaY\"]\n}\n\n200 - Sucesso{\n \"statusCode\": 200,\n \"mensagem\": \"Dados obtidos com sucesso.\",\n \"erro\": null,\n \"ultimaPag\": 1,\n \"resultados\": [\n [\"matricula\", \"ano\", \"mes\", \"saldo_horas\"],\n [\"matr123\", \"2024\", \"1\", \"180\"],\n [\"matr123\", \"2024\", \"2\", \"60\"],\n [\"matr123\", \"2024\", \"3\", \"-30\"],\n [\"matrXYZ\", \"2024\", \"1\", \"0\"],\n [\"matrXYZ\", \"2024\", \"2\", \"-150\"],\n [\"matrXYZ\", \"2024\", \"3\", \"-120\"]\n ]\n}\n\n400 - Excesso de DiasSe o intervalo entre (mes_ini, ano_ini) e (mes_fim, ano_fim) exceder o limite.
{\n \"statusCode\": 400,\n \"mensagem\": \"Requisicao mal-formada.\",\n \"erro\": \"O periodo inserido contempla X dias, excedendo assim o limite deste endpoint!\",\n \"ultimaPag\": null,\n \"resultados\": null\n}\n\n400 - Erro de SchemaCaso algum campo esteja fora do esperado, como mes_fim = 13, ano_ini < 2017, etc.
{\n \"statusCode\": 400,\n \"mensagem\": \"Invalid request body\",\n \"erro\": \"[detalhes do erro de validacao]\",\n \"ultimaPag\": null,\n \"resultados\": null\n}\n\n401 - Token Expirado ou Inválido{\n \"message\": \"The incoming token has expired\"\n}\n\n500 - Erro InternoErro interno do servidor ao processar a requisição.
\n{\n \"statusCode\": 500,\n \"mensagem\": \"Erro ao processar a requisicao.\",\n \"erro\": \"[detalhes do erro interno]\",\n \"ultimaPag\": null,\n \"resultados\": null\n}\n\nEste endpoint retorna o saldo planejado do banco de horas, agregado por mês e filial.
\nIMPORTANTE: assim como nos outros endpoints \"/plan-banco*\" os valores de saldo estão em minutos!
\nMétodo: POST
Cabeçalho da Requisição:
\nmoapi-token: <seu-IdToken>\n\nParâmetros da Requisição:
\npag: (Integer, opcional) Número da página para paginação. Usado para grandes conjuntos de resultados. Valor padrão: 1.
mes_ini: (String ou Integer, obrigatório) Mês inicial no formato \"MM\" ou um número inteiro representando o mês.
ano_ini: (String ou Integer, obrigatório) Ano inicial no formato \"AAAA\" ou um número inteiro representando o ano.
mes_fim: (String ou Integer, obrigatório) Mês final no formato \"MM\" ou um número inteiro representando o mês.
ano_fim: (String ou Integer, obrigatório) Ano final no formato \"AAAA\" ou um número inteiro representando o ano.
lista_cods_filiais: (Array de Strings, obrigatório) Lista de códigos de filial. Para todas as filiais, use [\"*\"].
Observações:
\nOs códigos de filial na lista_cods_filiais devem ser strings.
O endpoint utiliza paginação para grandes conjuntos de dados. Use o parâmetro pag para acessar as demais páginas.
Assegure-se de que o moapi-token fornecido no cabeçalho seja válido e não esteja expirado.
Janela máxima: 62 dias. ASSINCRONO. Headcount da escala vigente: conta PESSOAS (funcionário), separando regulares de vagas de contratação.
\nColunas: filial_cod, data, colaboradores_regulares, colaboradores_contratacao.
\n","urlObject":{"protocol":"https","path":["ql-escala-dia-filial"],"host":["moapi","escalamoavi","com","br"],"query":[],"variable":[]}},"response":[{"id":"4d2bc1c8-d72f-44a9-a9d4-f3660b39c337","name":"200-sucesso","originalRequest":{"method":"POST","header":[{"key":"moapi-token","value":"Janela máxima: 372 dias. ASSINCRONO. Conta PESSOAS distintas no mes.
\nColunas: filial_cod, ano, mes, colaboradores_regulares, colaboradores_contratacao.
\n","urlObject":{"protocol":"https","path":["ql-escala-mes-filial"],"host":["moapi","escalamoavi","com","br"],"query":[],"variable":[]}},"response":[{"id":"c6b701bc-5687-45ec-b59f-ac2d5fe5610a","name":"200-sucesso","originalRequest":{"method":"POST","header":[{"key":"moapi-token","value":"Fornece um resumo consolidado de indicadores operacionais por filial para um período. Ideal para diagnósticos rápidos de saúde operacional sem precisar cruzar múltiplos endpoints.
\n\n\nIMPORTANTE:\nEste é um endpoint de invocação assíncrona. O processamento pode levar mais de 29s para filiais numerosas. Sugerimos 1 minuto e meio (1min 30s) de intervalo mínimo entre a primeira e a segunda requisição (com a mesma payload). No pior caso, a página 1 já estará em cache nesta nova requisição!
\n
O usuário deve fornecer datas inicial (\"data_ini\") e final (\"data_fim\") em formato \"AAAA-MM-DD\".
\nO número total de dias correspondentes (\"daterange\") não pode exceder 62 dias.
\nEm \"lista_cods_filiais\" espera-se uma lista contendo strings que correspondam a códigos de filiais cadastradas na MOAVI. Para que dados de todas as filiais sejam retornados, o input deve ser \"lista_cods_filiais\": [\"*\"]
\nSe houver necessidade de paginação, em requisições posteriores o usuário deve incluir no body a chave \"pag\" com um inteiro positivo.
\n\"mensagem\" conterá uma string que informa brevemente sobre sucesso ou fracasso da request. Algumas requisições podem resultar em avisos neste campo.
\n\"erro\", se aplicável, trará string detalhando o motivo de fracasso da requisição. Se não, retorna como null
\n\"ultimaPag\", fornece a página (integer) do último lote de resultados. Em casos de erro, por exemplo, retorna como null.
\n\"statusCode\" informa o código HTTP da resposta, um integer.
\n\"resultados\", se não null, trata-se de uma lista de listas. As listas internas sempre têm 5 elementos cada, todos string.
\nA primeira lista aninhada é sempre [\"filial_cod\", \"qtd_acessos_30_dias\", \"ultimo_acesso\", \"diagnostico\", \"carga_trabalho\"].
\nAs demais conterão strings com valores respectivos. Por exemplo: [\"001\", \"120\", \"2024-01-31\", \"Normal\", \"44.0\"] significaria que a filial \"001\" teve 120 acessos nos últimos 30 dias, com último acesso em 31/01/2024, diagnóstico \"Normal\" e 44 horas de carga de trabalho no período consultado.
\n\"Normal\": operação dentro dos parâmetros esperados.
\n\"Alerta\": indicadores em nível de atenção — recomenda-se verificação.
\n\"Critico\": indicadores fora do aceitável — requer ação imediata.
\n