| 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 |
| Bloco de código |
|---|
| language | cpp |
|---|
| theme | Confluence |
|---|
| title | Retorno status 'S' |
|---|
| {
"response": [
{
"resultados": [
{
"matricula": "0000010101000001",
"rubrica": "114",
"status": "S",
"mensagem": "Operação realizada com sucesso!"
}
]
}
]
} |
| Bloco de código |
|---|
| language | cpp |
|---|
| theme | Confluence |
|---|
| title | Retorno status 'E' |
|---|
| {
"response": [
{
"resultados": [
{
"matricula": "0000010101000001",
"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 | | Bloco de código |
|---|
| language | cpp |
|---|
| theme | Confluence |
|---|
| title | Retorno funcionário não encontrada na base de dados |
|---|
| {
"response": [
{
"filial": "D MG 01 ",
"matricula": "XXXXX",
"message
"resultados": [
{
"matricula": "0101XXXXXX",
"rubrica": "001",
"status": "E",
"mensagem": "Funcionário não localizado na base de dados."
},
{
"matricula": "0101XXXXXX",
"rubrica": "002",
"status": "E",
"mensagem": "Funcionário não localizado na base de dados."
},
]
}
]
} |
| Bloco de código |
|---|
| language | cpp |
|---|
| theme | Confluence |
|---|
| title | Retorno de usuário sem permissão de acesso |
|---|
| {
"empresa": "T2",
"filial": "D MG 01 ",
"user": "ahgora",
"message "response": [
{
"resultados": [
{
"matricula": "0101000001",
"rubrica": "Z52",
"status": "E",
"mensagem": "Usuário sem permissão de acesso na Empresa/Filial."
},
{
"matricula": "0101000001",
"rubrica": "Z53",
"status": "E",
"mensagem": "Usuário sem permissão de acesso na Empresa/Filial."
}
]
}
]
} |
| Bloco de código |
|---|
| language | cpp |
|---|
| theme | Confluence |
|---|
| title | Retorno de empresa/filial inexistente na base de dados |
|---|
| {
"empresa{
"response": [
{
"resultados": [
{
"matricula": "Z10101000001",
"filialrubrica": "D MG 01 ",
"message"Z52",
"status": "E",
"mensagem": "Empresa/Filial não encontradas na base de dados."
}
]
}
]
} |
| Bloco de código |
|---|
| language | cpp |
|---|
| theme | Confluence |
|---|
| title | Retorno de usuário sem acesso a filial processadaperíodo do processamento não encontrado ou fechado |
|---|
| {
"empresaresponse": [
{
"T1",resultados": [
{
"filial "matricula": "D MG 02 "0101000001",
"rubrica": "202",
"user "status": "ahgoraE",
"message "mensagem": "Usuário sem permissãoPeríodo/Semana não encontrados na base de acesso na filial."
} | | Bloco de código |
|---|
| language | cpp |
|---|
| theme | Confluence |
|---|
| title | Retorno de período do processamento não encontrado ou fechado |
|---|
| {
"periodo": "202403",
"semana": "01",
"processo": "02117",
"roteiro": "FOL",
"messagedados ou o período está fechado. Necessário verificar o cadastro de períodos!"
},
{
"matricula": "0101000002",
"rubrica": "203",
"status": "E",
"mensagem": "Período/Semana não encontrados na base de dados ou o período está fechado. Necessário verificar o cadastro de períodos!"
}
]
}
]
} |
| Card |
|---|
| id | 400bas |
|---|
| label | 400 - Solicitação inválida |
|---|
| title | Body |
|---|
| {
"code": 400,
"message": "Não foi enviado nenhum registro na requisição para ser gravado."
} |
|
