Parâmetros de Entrada POST: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. | content | request da api | Sim | body |
| Estrutura json com informações de cadastro do currículo: Propriedades Obrigatórias: Dados de preparação de ambiente: - companyId: Grupo de empresa
- branchId: Empresa+Unidade de negócio+Filial
Dados de controle de afastamentos: - employeeId: Informação pertinente ao funcionário.
- startDate: Data inicial do afastamento.
- endDate: Data final do afastamento.
- leaveOfAbsenceCode: Código do tipo de afastamento.
- internationalDiseaseClassification: Código internacional de doenças.
- classEntityRegistrationCode: Número do registro do profissional
- doctorName: Nome do profissional.
- classEntityState: Estado do profissional.
- classEntity: Tipo de registro do profissional.
|
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/leaveOfAbsenceControl 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 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 | R8_FILIAL | Informações de acesso ao sistema, campo compõe Empresa+Unidade de Negócio+ Filial | "D MG 01 " | employeeId | R8_MAT | Chave do Funcionário | "T1|D MG 01 |160001" | startDate | R8_DATAINI | Data inicial do afastamento | "20200101" | endDate | R8_DATAFIM | Data final do afastamento | "20200101" | leaveOfAbsenceCode | R8_TIPOAFA | Chave do tipo de afastamento | "T1|D MG |005" | internationalDiseaseClassification | R8_CID | Código internacional de doenças. | "A07.8" | classEntityRegistrationCode | R8_CRMMED | Número do registro do profissional | "123123" | doctorName | R8_NMMED | Nome do profissional. | "doctorName" | classEntityState | R8_UFCRM | Estado do profissional. | "MG" | classEntity | R8_IDEOC | Tipo de registro do profissional. | "2" |
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. | Registro incluído com sucesso. | {
"branchId": "D MG 01 ",
"startDate": "2020-06-05T10:10:10",
"endDate": "2020-06-05T19:10:10",
"employeeId": "T1|D MG 01 |160001",
"leaveOfAbsenceCode": "T1|D MG |005",
"classEntityState": "SP",
"companyId": "T1",
"classEntityRegistrationCode": "123123",
"doctorName": "doctorName Alves",
"id": "T1;D MG 01 ;T1|D MG 01 |160001;2020-06-05T10:10:10;00:00;2020-06-05T19:10:10;T1|D MG |005",
"classEntity": "2",
"internationalDiseaseClassification": "A07.8"
} |
| 400 | Erro na validação do recebimento da mensagem. | Verificar se as propriedades json companyId ou branchId estão preenchidas com conteúdo válido. | {
"code": 400,
"detailedMessage": "De-Para de Empresa/Filial não encontrado na base.\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. | {
"errorCode": 500,
"errorMessage": "Ocorreu uma falha no retorno da informação."
} |
|
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.
|
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. | leaveOfAbsenceId | T1;D MG 01 ;T1|D MG 01 |160001;2020-06-01T10:10:10;00:00;2020-06-02T19:10:10;T1|D MG |005 | Sim | request | "" | Composição da string a ser enviada, deve ser ser composta por "GRUPODEEMPRESA|R8_FILIAL|CHAVEFUNCIONARIO|DATAINICIAL|HORAINICIAL|DATAFINAL|CODIGOAFASTAMENTO". | content | layout json | sim | body | "" | Estrutura json com informações de cadastro do currículo: Propriedades Obrigatórias: Dados de preparação de ambiente: - companyId: Grupo de empresa
- branchId: Empresa+Unidade de negócio+Filial
Dados de controle de afastamentos: - employeeId: Informação pertinente ao funcionário.
- startDate: Data inicial do afastamento.
- endDate: Data final do afastamento.
- leaveOfAbsenceCode: Código do tipo de afastamento.
- internationalDiseaseClassification: Código internacional de doenças.
- classEntityRegistrationCode: Número do registro do profissional
- doctorName: Nome do profissional.
- classEntityState: Estado do profissional.
- classEntity: Tipo de registro do profissional.
|
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/leaveOfAbsenceControl 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 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 |
| employeeId | R8_MAT | Chave do Funcionário | "T1|D MG 01 |160001" | startDate | R8_DATAINI | Data inicial do afastamento | "20200101" | endDate | R8_DATAFIM | Data final do afastamento | "20200101" | leaveOfAbsenceCode | R8_TIPOAFA | Chave do tipo de afastamento | "T1|D MG |005" | internationalDiseaseClassification | R8_CID | Código internacional de doenças. | "A07.8" | classEntityRegistrationCode | R8_CRMMED | Número do registro do profissional | "123123" | doctorName | R8_NMMED | Nome do profissional. | "doctorName" | classEntityState | R8_UFCRM | Estado do profissional. | "MG" | classEntity | R8_IDEOC | Tipo de registro do profissional. | "2" |
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. | {
"branchId": "D MG 01 ",
"startDate": "2020-06-05T10:10:10",
"endDate": "2020-06-05T19:10:10",
"employeeId": "T1|D MG 01 |160001",
"leaveOfAbsenceCode": "T1|D MG |005",
"classEntityState": "SP",
"companyId": "T1",
"classEntityRegistrationCode": "123123",
"doctorName": "doctorName Alves",
"id": "T1;D MG 01 ;T1|D MG 01 |160001;2020-06-05T10:10:10;00:00;2020-06-05T19:10:10;T1|D MG |005",
"classEntity": "2",
"internationalDiseaseClassification": "A07.8"
} |
| 400 | Erro na validação do recebimento da mensagem. | Verificar se as propriedade json leaveOfAbsenceId 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,
| {
"code": 400,
"detailedMessage": "Informação leaveOfAbsenceId 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. | {
"errorCode": 500,
"errorMessage": "Ocorreu uma falha no retorno da informação."
} |
|
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. |
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. | leaveOfAbsenceId | T1;D MG 01 ;T1|D MG 01 |160001;2020-06-01T10:10:10;00:00;2020-06-02T19:10:10;T1|D MG |005 | Sim | query | "" | Composição da string a ser enviada, deve ser ser composta por "GRUPODEEMPRESA|R8_FILIAL|CHAVEFUNCIONARIO|DATAINICIAL|HORAINICIAL|DATAFINAL|CODIGOAFASTAMENTO" |
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/leaveOfAbsenceControl 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 | Registro foi deletado com sucesso. | Registro foi deletado com sucesso. | {
"code": "200",
"description": "Opera��o realizada com sucesso!"
} |
| 400 | Erro na validação do recebimento da mensagem. | Verificar se as propriedade json leaveOfAbsenceId 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,
- Formato da Hora de Inicio
- Codigo do Tipo de Afastamento.
| {
"code": 400,
"detailedMessage": "Informação leaveOfAbsenceId 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. | {
"errorCode": 500,
"errorMessage": "Ocorreu uma falha no retorno da informação."
} |
|
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. |
|