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", "startDate": "2020-06-02T10:10:10", "stabilityCode": "T1|D MG |S01" } | Sim | body |
| Estrutura json com informações do período de estabilidade do funcionário: Dados de preparação de ambiente: - companyId: Grupo de empresa
- branchId: Empresa+Unidade de negócio+Filial
Dados de Período de Estabilidade: - employeeId: Informação pertinente ao funcionário.
- startDate: Data do Início do Período de Estabilidade.
- endDate: Data do Final do Período de Estabilidade.
- stabilityCode: Tipo de Estabilidade 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}/api/rh/v1/stabilityControl
Dados utilizados da API Por ser uma estrutura única para todos os produtos, há dados que existem em um produto (RM) e não existe no Protheus, desta forma cada produto 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 |
| branchId | RFX_FILIAL | Informações de acesso ao sistema, campo compõe Empresa+Unidade de Negócio+ Filial | "D MG 01 " | employeeId | RFX_MAT | Matrícula Chave do Funcionário | "T1|D MG 01 |000001" | startDate | RFX_DATAI | Data de Início do Período | "2020-01-01T18:25:43" | endDate | RFX_DATAF | Data de término do Período | "2020-01-01T18:25:43" | stabilityCode | RFX_TPESTB | Chave do Tipo de Estabilidade | "T1|D MG |S01" |
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 | Registro criado. |
| Bloco de código |
---|
theme | Eclipse |
---|
linenumbers | true |
---|
collapse | true |
---|
| {
"companyId": "T1",
"branchId": "D MG 01 ",
"startDate": "2020-01-01T18:25:43",
"employeeId": "T1|D MG 01 |000001",
"stabilityCode": "T1|D MG |S01",
"id": "T1 |
| |||| | 400 | Erro na validação do recebimento da mensagem. | Verificar se as propriedades | json companyId ou branchId estão preenchidas com conteúdo válidojson obrigatórias (companyID , branchId , employeeId, startDate, stabilityCode) estão preenchidas. | Bloco de código |
---|
theme | Eclipse |
---|
linenumbers | true |
---|
collapse | true |
---|
| {
"code": 400,
"detailedMessage": " |
| De-Para de Empresa/Filial não encontrado na base.Verifique o conteúdo da TAG (employeeId) pois ela é obrigatória para a manipulação deste processo.\r\n\r\n",
"helpUrl": "https://tdn.totvs.com/x/ZYNvI",
"message": "Erro na validação do recebimento da mensagem."
} |
|
400 | Erro na validação do recebimento da mensagem. | Verificar se a propriedade json employeeId possui informações válidas500 | Ocorreu uma falha no retorno da informação. | É necessário avaliar se o servidor está funcionando corretamente. | Bloco de código |
---|
theme | Eclipse |
---|
linenumbers | true |
---|
collapse | true |
---|
| {
"code": |
| 400500,
"detailedMessage": " |
| VerifiqueoconteúdodaTAG (employeeId) pois não foi possível encontrar esta informação no Protheus'\r\nretorno da informação.",
"helpUrl": "https://tdn.totvs.com/x/ZYNvI",
"message": |
| "Erro na validaçãorecebimento da mensagem"400 | Erro na validação do recebimento da mensagem. | Verificar se a propriedade json startDate está no formato correto. | Bloco de código |
---|
theme | Eclipse |
---|
linenumbers | true |
---|
collapse | true |
---|
| {
"code": 400,
"detailedMessage": "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."
} |
| 400 | Erro na validação do recebimento da mensagem. | Verificar se a propriedade json stabilityCode está com conteúdo existente na tabela S053 - Tipos de Estabilidade do Protheus. | Bloco de código |
---|
theme | Eclipse |
---|
linenumbers | true |
---|
collapse | true |
---|
| {
"code": 400,
"detailedMessage": "Verifique o conteúdo da TAG (stabilityCode) pois não foi possível encontrar esta informação no Protheus.\r\n",
"helpUrl": "https://tdn.totvs.com/x/ZYNvI",
"message": "Erro na validação do recebimento da mensagem."
} |
| 400 | Erro na validação do recebimento da mensagem. | Verificar se as propriedades json obrigatórias (companyID , branchId , employeeId, startDate, stabilityCode) estão preenchidas. | Bloco de código |
---|
theme | Eclipse |
---|
linenumbers | true |
---|
collapse | true |
---|
| {
"code": 400,
"detailedMessage": "Verifique o conteúdo da TAG (employeeId) pois ela é obrigatória para a manipulação deste processo.\r\n\r\n",
"helpUrl": "https://tdn.totvs.com/x/ZYNvI",
"message": "Erro na validação do recebimento da mensagem."
} |
| 500 | Ocorreu uma falha no retorno da informação. | É 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. 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 é requerida para o funcionamento correto da API em casos de ambientes com autenticação Http Basic. | stabilityId | T1;D MG 01 ;T1|D MG 01 |160001;2020-06-18T10:10:10;T1|D MG |S01 | Sim | request |
| Composição da string a ser enviada, deve ser ser composta por "GRUPO DE EMPRESA;FILIAL;CHAVEFUNCIONARIO;DATA DE INÍCIO; CHAVE TIPODEESTABILIDADE". | content | { "companyId":"T1", "branchId": "D MG 01 ", "employeeId":"T1|D MG 01 |160001", "startDate": "2020-06-02T10:10:10", "endDate": "2020-06-02T10:10:10", "stabilityCode": "T1|D MG |S01" } | sim | body |
| Estrutura json com informações do perído de estababilidade: Dados de preparação de ambiente: - companyId: Grupo de empresa
- branchId: Empresa+Unidade de negócio+Filial
Dados de Período de Estabilidade: - employeeId: Informação pertinente ao funcionário.
- startDate: Data do Início do Período de Estabilidade.
- stabilityCode: Tipo de Estabilidade 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}/api/rh/v1/stabilityControl{stabilityId} Image Added Image Added
| 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 é requerida para o funcionamento correto da API em casos de ambientes com autenticação Http Basic. | stabilityId | T1;D MG 01 ;T1|D MG 01 |160001;2020-06-18T10:10:10;T1|D MG |S01 | Sim | request | Composição da string a ser enviada, deve ser ser composta por "GRUPO DE EMPRESA;FILIAL;CHAVEFUNCIONARIO;DATA DE INÍCIO; CHAVE TIPODEESTABILIDADE". | content | { "companyId":"T1", "branchId": "D MG 01 ", "employeeId":"T1|D MG 01 |160001", "startDate": "2020-06-02T10:10:10", "endDate": "2020-06-02T10:10:10", "stabilityCode": "T1|D MG |S01" } | sim | body | Estrutura json com informações do perído de estababilidade: Dados de preparação de ambiente: - companyId: Grupo de empresa
- branchId: Empresa+Unidade de negócio+Filial
Dados de Período de Estabilidade: - employeeId: Informação pertinente ao funcionário.
- startDate: Data do Início do Período de Estabilidade.
- stabilityCode: Tipo de Estabilidade 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}/api/rh/v1/stabilityControl{stabilityId} Image Removed Image Removed Request da API: Bloco de código |
---|
language | bash |
---|
theme | Eclipse |
---|
title | Exemplo de Request da API |
---|
linenumbers | true |
---|
| {
"companyId": "T1",
"branchId": "D MG 01 ",
"employeeId": "T1|D MG 01 |000001",
"startDate": "2020-01-03T18:25:43",
"endDate": "2020-01-15T18:30:43",
"stabilityCode": "T1|D MG |S02"
} |
Dados utilizados da API Por ser uma estrutura única para todos os produtos, há dados que existem em um produto (RM) e não existe no Protheus, desta forma cada produto 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 |
| branchId | RFX_FILIAL | Informações de acesso ao sistema, campo compõe Empresa+Unidade de Negócio+ Filial | "D MG 01" | employeeId | RFX_MAT | Matrícula Chave do Funcionário. | "T1|D MG 01 |000001" | startDate | RFX_DATAI | Data do Início do Período | "2020-01-01T18:25:43" | startDate | RFX_DATAF | Data do final do Período | "2020-01-01T18:25:43" | stabilityCode | RFX_TPESTB | Descrição Chave do resumo Tipo de qualificaçõesEstabilidade | "T1|D MG |S01" |
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 | Operação realizada com sucesso. | Registro foi alterado com sucesso. | Bloco de código |
---|
theme | Eclipse |
---|
linenumbers | true |
---|
collapse | true |
---|
| {
"code": "200",
"description": "Operação realizada com sucesso!"
} |
| RESPONSE | 200 | Atualizado com sucesso. | Registro alterado com sucesso | 400 | Erro na validação do recebimento da mensagem. | Verificar se as tags companyID , branchId , employeeI possuem conteúdo igual ao parâmetro stabilityId. | Bloco de código |
---|
theme | Eclipse |
---|
linenumbers | true |
---|
collapse | true |
---|
| {
"companyId":"T1",
"branchId": "D MG 01 ",
"employeeId":"T1|D MG 01 |160001" |
| code": 400 | | detailedMessage | Informação do pacote difere do parâmetro stabilityId, favor verificar e reenviar.",
"helpUrl2020-06-02T10:10:10",
"endDate": " |
| https://tdn.totvs.com/x/ZYNvI2020-06-03T10:10:10",
"stabilityCode": "T1|D MG |
| "message | Erro | na | validação do recebimento da mensagem.01 ;2020-06-02T10:10:10;10:10;T1|D MG 01 |160001"
} |
| 400 | Erro na validação do recebimento da mensagem. | Verificar se as propriedade json stabilityId está preenchida e com dados válidos no pacote enviado. - Dados de Empresa e Filial,
- Dados de Filial e Matrícula,
- Formato da Data de Início,
- Tipo de Estabilidade.
| Bloco de código |
---|
theme | Eclipse |
---|
linenumbers | true |
---|
collapse | true |
---|
| {
"code": 400,
"detailedMessage": "Informação stabilityId ausente ou inválida.",
"helpUrl": "https://tdn.totvs.com/x/ZYNvI",
"message": "Erro na validação do recebimento da mensagem."
} |
| 500 | Ocorreu uma falha no retorno da informação. | É 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 |
---|
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. | stabilityId | T1;D MG 01 ;T1|D MG 01 |160001;2020-06-18T10:10:10;T1|D MG |S01 | Sim | query"" |
| Composição da string a ser enviada, deve ser ser composta por "GRUPODEEMPRESA;FILIAL;CHAVEFUNCIONARIO;DATAINICIO;CHAVETIPODEESTABILIDADE". |
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}/api/rh/v1/stabilityControl{stabilityId}
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 | Operação realizada com sucesso. | Registro foi deletado com sucesso. | Bloco de código |
---|
theme | Eclipse |
---|
linenumbers | true |
---|
collapse | true |
---|
| {
"code": "200",
"description": "Operação realizada com sucesso!"
} |
| 400 | Erro na validação do recebimento da mensagem. | Verificar se as propriedade json stabilityId está preenchida e com dados válidos no pacote enviado. - Dados de Empresa e Filial,
- Dados de Filial e Matrícula,
- Formato da Data de Início,
- Tipo de Estabilidade.
| Bloco de código |
---|
theme | Eclipse |
---|
linenumbers | true |
---|
collapse | true |
---|
| {
"code": 400,
"detailedMessage": "Informação stabilityId ausente ou inválida.",
"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. |
|