Histórico da Página

...

Deck of Cards

startHidden	false
id	body

Card

default	true
id	body1
label	Definição das propriedades
title	Definição das propriedades

Campos Protheus	Propriedades API	Descrição
RGB_MAT	matricula	Matrícula do funcionário
RGB_PERIOD	anocom	Ano do período do resultado
RGB_PERIOD	mescom	Mês do período do resultado
RGB_SEMANA	semana	Semana do período
	codfuncionario	Código do funcionário separado por pipe contendo Empresa + Filial + Matrícula
RGB_PD	rubrica	Código da verba do funcionário
RGB_HORAS	referencia	Referência em horas ou dia da verba
RGB_DTREF	datafalta	Data da falta

Informações

title	Importante

Envio do atributo 'datafalta' vazio, será assumido o primeiro dia do período que está sendo processado, todas as verbas serão gravadas com referência.

Card

id	body2
label	Body
title	Body

Bloco de código

language	cpp
theme	Confluence
title	Propriedade Product vazia

{

"items": [


      "matricula": "000001",


      "anocom": "2024",


      "mescom": "08",


      "semana": "1",


      "codfuncionario": "01|01|000001",


      "resultados": [


          "rubrica": "114",


          "referencia": "1,30",


          "datafalta": ""

Retorno

Deck of Cards

startHidden	false
id	retorno

Card

default	true
id	200ok
label	200 - OK
title	Sucesso

Propriedades API	Descrição
matricula	Matrícula do funcionário
rubrica	Verba processada
status	Status 'S'(Sucesso) ou 'E'(Erro)
mensagem	Detalhe da mensagem

Retorno status 'S'

Bloco de código

language	cpp
theme	Confluence
title	Propriedade Product vazia

{
  "response": [
    {
      "resultados": [
        {
          "matricula": "000001",
          "rubrica": "114",
          "status": "S",
          "mensagem": "Operação realizada com sucesso!"
        }
      ]
    }
  ]
}

Retorno status 'E'

Bloco de código

language	cpp
theme	Confluence
title	Propriedade Product vazia

{
  "response": [
    {
      "resultados": [
        {
          "matricula": "000001",
          "rubrica": "ASD",
          "status": "E",
          "mensagem": "Verba não encontrada na base de dados."
        }
      ]
    }
  ]
}

Card

id	400bas
label	400 - Solicitação inválida
title	Body

Propriedades API	Descrição
empresa	Código da empresa
filial	Filial do funcionário
user	Usuário do sistema
matricula	Matrícula do funcionário
periodo	Ano/Mês do Período
semana	Semana do período
processo	Código do processo do período
roteiro	Roteiro de cálculo do período
mensagem	Detalhe da mensagem

Retorno funcionário não encontrada na base de dados

Bloco de código

language	cpp
theme	Confluence
title	Propriedade Product vazia

{
  "filial": "D MG 01 ",
  "matricula": "XXXXX",
  "message": "Funcionário não localizado na base de dados."
}

Retorno de usuário sem permissão de acesso

Bloco de código

language	cpp
theme	Confluence
title	Propriedade Product vazia

{
  "empresa": "T2",
  "filial": "D MG 01 ",
  "user": "ahgora",
  "message": "Usuário sem permissão de acesso na Empresa/Filial."
}

Retorno de empresa/filial inexistente na base de dados

Bloco de código

language	cpp
theme	Confluence
title	Propriedade Product vazia

{
  "empresa": "Z1",
  "filial": "D MG 01 ",
  "message": "Empresa/Filial não encontradas na base de dados."
}

Retorno de usuário sem acesso a filial processada

Bloco de código

language	cpp
theme	Confluence
title	Propriedade Product vazia

{
  "empresa": "T1",
  "filial": "D MG 02 ",
  "user": "ahgora",
  "message": "Usuário sem permissão de acesso na filial."
}

Retorno de período do processamento não encontrado ou fechado

Bloco de código

language	cpp
theme	Confluence
title	Propriedade Product vazia

{
  "periodo": "202403",
  "semana": "01",
  "processo": "02117",
  "roteiro": "FOL",
  "message": "Período/Semana não encontrados na base de dados ou o período está fechado. Necessário verificar o cadastro de períodos!"
}

...

Árvore de páginas

Versões comparadas

Versão antiga 4

Nova versão 5

Chave