Totvs custom tabs box items |
---|
| Parâmetros de Entrada POST:Parâmetro | Valor de Exemplo | Obrigatório | Tipo | Valor Default | Descrição | authorization | usuario:senha | Sim | header |
| autenticação é requerida para o funcionamento correto da API em casos de ambientes com autenticação Http Basic. | content | { "companyId":"T1", "branchId": "D MG 01 ", "employeeId":"T1|D MG 01 |160001", "code": "T1|D MG |114", "startDate": "2020-06-02T10:10:10", "endDate": "2020-06-10T10:10:10", "startTime": "10:10", "endTime": "19:10" } | sim | body |
| Estrutura json com informações do abono de marcações do funcionário: Dados de preparação de ambiente: - companyId: Grupo de empresa
- branchId: Empresa+Unidade de negócio+Filial
Dados de Abono: - employeeId: Informação pertinente ao funcionário.
- startDate: Data do Início do abono.
- endDate: Data do Final do abono.
- startTime: Hora do Início do abono.
- endTime: Hora do Final do abono.
- code: Tipo de Abono registrado.
|
Parâmetros e Chamada do Método: Para a realização de testes foi utilizado a ferramenta POSTMAN e após a configuração do server protheus a API Rest, a requisição deverá ser semelhante a imagem abaixo: {protocolo}://{host}/{api}/rh/v1/allowanceControl
Dados utilizados da API Por ser uma estrutura única para todas as linhas, cada linha utilizará os campos pertinentes aos seus ambientes. Propriedade API REST | CAMPO PROTHEUS | DESCRIÇÃO | Formato |
---|
companyId |
| Informações de acesso ao sistema, campo contém informação do grupo de empresa | "T1" | branchId | RF0_FILIAL | Informações de acesso ao sistema, campo compõe Empresa+Unidade de Negócio+ Filial | "D MG 01 " | employeeId | RF0_MAT | chave do Funcionário | "T1|D MG 01 |000001"" | startDate | RF0_DTPREI | Data inicial do abono | "2020-01-01T18:25:43" | endDate | RF0_DTPREF | Data final do abono | "2020-01-01T18:25:43" | startTime | RF0_HORINI | hora inicial do abono | "10:00" | endTime | RF0_HORFIM | hora final do abono | "15:00" | code | P6_CODIGO | chave do tipo de abono | "T1| D MG | 107" |
Situações TratadasO envio de dados inesperados nos parâmetros de entrada da API REST pode ocasionar alguns erros. Desta forma, foram criados alguns tratamentos de erros, listados abaixo, cada um com sua respectiva mensagem e solução.
Mensagens Validação Erro | Mensagem | Solução | API RESPONSE | 201 | Created. | Registro incluído com sucesso. | { | Bloco de código |
---|
theme | Eclipse |
---|
linenumbers | true |
---|
collapse | true |
---|
| "companyId":"T1", |
| "D MG 01 D MG 01 D MG |107 03T130000.000Z 03T110000.000Z },
"id": "T1;D MG 01 ;T1|D MG 01 |160001;2020-06-03T13:00:00.000Z;10:10;T1|D MG|107"
|
| 400 | Erro no momento da listagem do registro. | Verificar se as propriedade json startDate está preenchida e com dados válidos no pacote enviado |
400 | Erro no momento da listagem do registro. | Verificar se as propriedade json id está preenchida e com dados válidos no pacote enviado . | Bloco de código |
---|
theme | Eclipse |
---|
linenumbers | true |
---|
collapse | true |
---|
| {
"errorCode": 400,
"errorMessage": "ERRO NO MOMENTO DA LISTAGEM DO REGISTRO."
} |
| 500 | Erro no acesso ao Endpoint. | É necessário avaliar se o servidor está funcionando corretamente . | Bloco de código |
---|
theme | Eclipse |
---|
linenumbers | true |
---|
collapse | true |
---|
| {
" |
| errorCode500errorMessageERRO NO ACESSO AO ENDPOINT"
}OBS: Estas mensagens de validações serão retornadas sempre que algum campo passado que seja obrigatório ou que algum campo enviado tenha sua origem de dados em outra tabela e não seja localizado na mesma, vale lembrar que são apenas exemplos de mensagens de erros e podendo variar o nome da propriedade enviada. Verifique o conteúdo da TAG (startDate) pois a data não está no formato correto: 'YYYY-MM-DDTHH:MM:SS'\r\n",
"helpUrl": "https://tdn.totvs.com/x/ZYNvI",
"message": "Erro na validação do recebimento da mensagem."
} |
| 500 | Erro no acesso ao Endpoint. | É necessário avaliar se o servidor está funcionando corretamente. | Bloco de código |
---|
theme | Eclipse |
---|
linenumbers | true |
---|
collapse | true |
---|
| {
"code": 500,
"detailedMessage": "Ocorreu uma falha no retorno da informação.",
"helpUrl": "https://tdn.totvs.com/x/ZYNvI",
"message": Descrição do erro.
} |
|
OBS: Estas mensagens de validações serão retornadas sempre que algum campo passado que seja obrigatório ou que algum campo enviado tenha sua origem de dados em outra tabela e não seja localizado na mesma, vale lembrar que são apenas exemplos de mensagens de erros e podendo variar o nome da propriedade enviada.
|
Totvs custom tabs box items |
---|
| Parâmetros de Entrada PUT:Parâmetro | Valor de Exemplo | Obrigatório | Tipo | Valor Default | Descrição | authorization | usuario:senha | Sim | header |
| autenticação é importante para o funcionamento correto da API em casos de ambientes com autenticação Http Basic. | allowanceId | T1;D MG 01 ;T1|D MG 01 |160001;2020-06-03T13:00:00.000Z;10:10;T1|D MG|107 | Sim | request |
| Composição da string a ser enviada, deve ser ser composta por "GRUPO DE EMPRESA;FILIAL;CHAVEFUNCIONARIO;DATADEINÍCIO;HORADEINICIO;CHAVE TIPODEABONO". | content | layout json | sim | body |
| Estrutura json com informações do abono de marcação de ponto: Dados de preparação de ambiente: - companyId: Grupo de empresa
- branchId: Empresa+Unidade de negócio+Filial
Dados de solicitação de abono: - employeeId: Informação pertinente ao funcionário.
- startDate: Data inicial do abono.
- endDate: Data final do abono.
- startTime: Horário do Início do abono.
- endTime: Horário do final do abono.
- code: Tipo de abono registrado.
|
Parâmetros e Chamada do Método: Para a realização de testes foi utilizado a ferramenta POSTMAN e após a configuração do server protheus a API Rest, a requisição deverá ser semelhante a imagem abaixo: {protocolo}://{host}/{api}/rh/v1/allowanceControl{allowanceId} Image Added
Dados utilizados da API Por ser uma estrutura única para todas as linhas, cada linha utilizará os campos pertinentes aos seus ambientes. Propriedade API REST | CAMPO PROTHEUS | DESCRIÇÃO | Formato |
---|
companyId |
| Informações de acesso ao sistema, campo contém informação do grupo de empresa | "T1" | branchId |
| Informações de acesso ao sistema, campo compõe Empresa+Unidade de Negócio+ Filial | " D MG 01 " | employeeId | RF0_MAT | chave do Funcionário. | "T1|D MG 01 |000001" | startDate | RF0_DTPREI | Data de Início do abono | "2020-01-01T18:25:43" | endDate | RF0_DTPREF | Data do Final do abono | "2020-01-01T18:25:43" | startTime | RF0_HORINI | Hora inicial do abono | "10:00" | endTime | RF0_HORFIM | Hora final do abono | "15:00" | code | P6_CODIGO | chave do tipo de abono | "T1|D MG |107" |
Situações TratadasO envio de dados inesperados nos parâmetros de entrada da API REST pode ocasionar alguns erros. Desta forma, foram criados alguns tratamentos de erros, listados abaixo, cada um com sua respectiva mensagem e solução.
Mensagens Validação Erro | Mensagem | Solução | API RESPONSE | 200 | Atualizado com sucesso. | Registro alterado com sucesso. | Bloco de código |
---|
theme | Eclipse |
---|
linenumbers | true |
---|
collapse | true |
---|
| "companyId":"T1",
"branchId": "D MG 01 ",
"employeeId":"T1|D MG 01 |160001",
"code": "T1|D MG |114",
"startDate": "2020-06-02T10:10:10",
"endDate": "2020-06-10T10:10:10",
"startTime": "10:10",
"endTime": "19:10",
"id": "T1;D MG 01 ;T1|D MG 01 |160001;2020-06-03T13:00:00.000Z;10:10;T1|D MG|107" |
|
| Totvs custom tabs box items |
---|
| Parâmetros de Entrada PUT: | Parâmetro | Valor de Exemplo | Obrigatório | Tipo | Valor Default | Descrição | authorization | usuario:senha | Sim | header | autenticação é importante para o funcionamento correto da API em casos de ambientes com autenticação Http Basic. | allowanceId | T1;D MG 01 ;T1|D MG 01 |160001;2020-06-03T13:00:00.000Z;10:10;T1|D MG|107 | Sim | request | Composição da string a ser enviada, deve ser ser composta por "GRUPO DE EMPRESA;FILIAL;CHAVEFUNCIONARIO;DATADEINÍCIO;HORADEINICIO;CHAVE TIPODEABONO". | content | layout json | sim | body | Estrutura json com informações do abono de marcação de ponto: Dados de preparação de ambiente: - companyId: Grupo de empresa
- branchId: Empresa+Unidade de negócio+Filial
Dados de solicitação de abono: - employeeId: Informação pertinente ao funcionário.
- startDate: Data inicial do abono.
- endDate: Data final do abono.
- startTime: Horário do Início do abono.
- endTime: Horário do final do abono.
- code: Tipo de abono registrado.
| Parâmetros e Chamada do Método: Para a realização de testes foi utilizado a ferramenta POSTMAN e após a configuração do server protheus a API Rest, a requisição deverá ser semelhante a imagem abaixo: {protocolo}://{host}/{api}/rh/v1/allowanceControl{allowanceId} Image Removed Dados utilizados da API Por ser uma estrutura única para todas as linhas, cada linha utilizará os campos pertinentes aos seus ambientes. Propriedade API REST | CAMPO PROTHEUS | DESCRIÇÃO | Formato |
---|
companyId | Informações de acesso ao sistema, campo contém informação do grupo de empresa | "T1" | branchId | Informações de acesso ao sistema, campo compõe Empresa+Unidade de Negócio+ Filial | " D MG 01 " | employeeId | RF0_MAT | chave do Funcionário. | "T1|D MG 01 |000001" | startDate | RF0_DTPREI | Data de Início do abono | "2020-01-01T18:25:43" | endDate | RF0_DTPREF | Data do Final do abono | "2020-01-01T18:25:43" | startTime | RF0_HORINI | Hora inicial do abono | "10:00" | endTime | RF0_HORFIM | Hora final do abono | "15:00" | code | P6_CODIGO | chave do tipo de abono | "T1|D MG |107" | Situações TratadasO envio de dados inesperados nos parâmetros de entrada da API REST pode ocasionar alguns erros. Desta forma, foram criados alguns tratamentos de erros, listados abaixo, cada um com sua respectiva mensagem e solução. Mensagens Validação Erro | Mensagem | Solução | API RESPONSE | 200 | Atualizado com sucesso. | Registro alterado com sucesso. | Bloco de código |
---|
theme | Eclipse |
---|
linenumbers | true |
---|
collapse | true |
---|
| {
"code": "200",
"description": "ATUALIZADO COM SUCESSO."
} |
| 400 | Erro no momento da listagem do registro. | Verificar se as propriedade json allowanceId está preenchida e com dados válidos no pacote enviado . | Bloco de código |
---|
theme | Eclipse |
---|
linenumbers | true |
---|
collapse | true |
---|
| collapse | true |
---|
| {
"code": 400,
"detailedMessage": "Informação allowanceId ausente ou inválida.",{
"errorCodehelpUrl": 400"https://tdn.totvs.com/x/ZYNvI",
"errorMessagemessage": "ERROErro NOna MOMENTOvalidação DAdo LISTAGEMrecebimento DOda REGISTROmensagem."
} |
| 500 | Erro no acesso ao Endpoint. | É necessário avaliar se o servidor está funcionando corretamente. | Bloco de código |
---|
theme | Eclipse |
---|
linenumbers | true |
---|
collapse | true |
---|
| {
"code": 500,
"errorCodedetailedMessage": 500 "Ocorreu uma falha no retorno da informação.",
"errorMessagehelpUrl": "ERRO NO ACESSO AO ENDPOINT""https://tdn.totvs.com/x/ZYNvI",
"message": Descrição do erro.
} |
|
OBS: Estas mensagens de validações serão retornadas sempre que algum campo passado que seja obrigatório ou que algum campo enviado tenha sua origem de dados em outra tabela e não seja localizado na mesma, vale lembrar que são apenas exemplos de mensagens de erros e podendo variar o nome da propriedade enviada.
Totvs custom tabs box items |
---|
default | no |
---|
referencia | DELETE |
---|
| Parâmetros de Entrada DELETE:Parâmetro | Valor de Exemplo | Obrigatório | Tipo | Valor Default | Descrição | authorization | usuario:senha | Sim | header |
| autenticação é importante para o funcionamento correto da API em casos de ambientes com autenticação Http Basic. | allowanceId | "T1;D MG 01 ;T1|D MG 01 |160001;2020-06-03T13:00:00.000Z;10:10;T1|D MG|107" | Sim | query |
| Composição da string a ser enviada, deve ser ser composta por "GRUPO DE EMPRESA;FILIAL;CHAVEFUNCIONARIO;DATADEINÍCIO;HORADEINICIO;CHAVE TIPODEABONO". |
Parâmetros e Chamada do Método: Para a realização de testes foi utilizado a ferramenta POSTMAN e após a configuração do server protheus a API Rest, a requisição deverá ser semelhante a imagem abaixo: {protocolo}://{host}/{api}/rh/v1/allowanceControl{allowanceId}
Situações TratadasO envio de dados inesperados nos parâmetros de entrada da API REST pode ocasionar alguns erros. Desta forma, foram criados alguns tratamentos de erros, listados abaixo, cada um com sua respectiva mensagem e solução.
Mensagens Validação Erro | Mensagem | Solução | API RESPONSE | 204200 | Atualizado com sucesso. | Registro foi deletado com sucesso. | Bloco de código |
---|
theme | Eclipse |
---|
linenumbers | true |
---|
collapse | true |
---|
| {
"code": "204200",
"description": "ATUALIZADOOpera��o realizada COMcom SUCESSO.sucesso!"
} |
| 400 | Erro no momento da listagem do registro. | Verificar se a propriedade json allowanceId está preenchida e com dados válidos no pacote enviado . | Bloco de código |
---|
theme | Eclipse |
---|
linenumbers | true |
---|
collapse | true |
---|
| collapse | true |
---|
| {
"code": 400,
"detailedMessage": "Informação allowanceId ausente ou inválida.",{
"errorCodehelpUrl": 400"https://tdn.totvs.com/x/ZYNvI",
"errorMessagemessage": "ERROErro NOna MOMENTOvalidação DAdo LISTAGEMrecebimento DOda REGISTROmensagem."
} |
| 500 | Erro no acesso ao Endpoint. | É necessário avaliar se o servidor está funcionando corretamente. | Bloco de código |
---|
theme | Eclipse |
---|
linenumbers | true |
---|
collapse | true | | true |
---|
| {
"code": 500,
{
"errorCodedetailedMessage": 500 "Ocorreu uma falha no retorno da informação.",
"errorMessagehelpUrl": "ERRO NO ACESSO AO ENDPOINT.""https://tdn.totvs.com/x/ZYNvI",
"message": Descrição do erro.
} |
|
OBS: Estas mensagens de validações serão retornadas sempre que algum campo passado que seja obrigatório ou que algum campo enviado tenha sua origem de dados em outra tabela e não seja localizado na mesma, vale lembrar que são apenas exemplos de mensagens de erros e podendo variar o nome da propriedade enviada. |
|