API - Histórico de Regra

Objetivo

Descrever métodos de acesso à API de Histórico de Regra ( RuleHistory).

Listar Histórico

Lista o histórico cadastrado para o colaborador especificado.

Endpoint

GET https://api1.tradingworks.net/v1/rulehistory/{MATRÍCULA}/{CÓDIGO DO EMPREGADOR}

Parâmetros

MATRÍCULA - Matrícula do colaborador
CÓDIGO DO EMPREGADOR - Código de importação do empregador. Opcional caso a matrícula seja única para o ambiente todo. Se não informado e existirem matrículas duplicadas, o primeiro colaborador com a matrícula encontrada será utilizado.
FromDate - Opcional, período específico de início dos dados
ToDate - Opcional, período de término dos dados.

Headers

AUTH-TOKEN = Sua Chave privada

Exemplo

GET https://api1.tradingworks.net/v1/rulehistory/5555/8888
[
    {
        "RuleCode": "451",
        "Title": "08:00 - 17:00",
        "BaseDate": "2022-10-04T00:00:00"
    },
    {
        "RuleCode": "455",
        "Title": "07:00 - 16:00",
        "BaseDate": "2022-10-03T00:00:00"
    },
    {
        "RuleCode": "",
        "Title": "Flex 8h",
        "BaseDate": "2013-09-10T00:00:00"
    }
]

Inclusão de histórico

Inclui uma regra no histórico do colaborador.

Condições:

• Se a regra já existir para a mesma data, registro não é duplicado.
• Se já existir regra para a mesma data, a regra será substituída pela nova.

Endpoint

POST https://api1.tradingworks.net/v1/rulehistory

Headers

AUTH-TOKEN = Sua Chave privada
Content-Type = application/json

Dados

Exemplo

{
	"EmployeeNumber": "1234675",
	"EmployerImportRef": "1004",
	"RuleCode": "455",
	"BaseDate": "2022-10-04",
	"AuditEmployeeID": "5"
}

Exclusão de histórico

Remove uma regra do histórico do colaborador.

Condições:

• Se não existir nenhuma regra previamente cadastrada, nenhuma ação é realizada, retornando código 200.

Endpoint

DELETE https://api1.tradingworks.net/v1/rulehistory

Headers

AUTH-TOKEN = Sua Chave privada
Content-Type = application/json

Dados

Exemplo

{
	"EmployeeNumber": "1234675",
	"EmployerImportRef": "1004",
	"BaseDate": "2022-10-04",
	"AuditEmployeeID": "5"
}