New API Schema

:::note[Future versions] Red sections are to be removed in future new versions of the API. :::

Create predictions request

{
  "parameters": [
    {
      "datasetId": "cc3fa933-80fe-4b18-a9c8-66fe0fbf85a2",
      "customerId": "87082b90-097b-4115-aec2-7330918fe6aa",
      "registrations": [
        {
          "registrationId": "1e24162a-3bad-4a58-865c-a1994c75942d",
          "date": "2024-08-26",
          "employeeId": "cf5ee029-0747-45c1-94e3-ea7a2ae3129c",
          "projectId": "high_rise_project",
          "departmentId": "construction",
          "workCategory": "roofing",
          "startTime": 6.5,
          "endTime": 16,
          "breakDuration": 0.5,
          "publicHoliday": false,
          "numericals": [
            {
              "name": "kilometersDriven",
              "value": 100
            }
          ],
          "categoricals": [
            {
              "name": "wageCode",
              "value": "Regular"
            }
          ]
        }
      ],
      "aggregateForEmployeeIds": ["cf5ee029-0747-45c1-94e3-ea7a2ae3129c"],
      "missingRegistrationDates": ["2021-01-01", "2021-01-02", "2021-01-03"],
      "plans": [
        {
          "planId": "plan_1",
          "date": "2025-03-17",
          "employeeId": "emp_1",
          "projectId": "pro_1",
          "departmentId": "dep_1",
          "workCategory": "wc_1",
          "workDuration": 8
        },
        {
          "planId": "plan_4",
          "date": "2025-03-20",
          "employeeId": "emp_1",
          "projectId": "pro_1",
          "departmentId": "dep_1",
          "workCategory": "wc_1",
          "startTime": 5,
          "endTime": 23
        }
      ],
      "rules": [
        {
          "ruleId": "rule_1",
          "ruleType": "max_hours_per_7_days",
          "value": 45
        },
        {
          "ruleId": "rule_2",
          "ruleType": "max_hours_per_day",
          "value": 12
        }
      ]
    }
  ],
  "webhook": {
    "webhookUrl": "https://yourwebhookurl.com/notification",
    "webhookApiKey": "587c5a03"
  }
}

Comments

• rules is a list of configurations for rules from a predefined set of rules (ruleTypes).

Create predictions response

{
  "jobId": "59c16c97a8f64ce89f68fdf804b27a35",
  "results": [
    {
      "datasetId": "730c3bea-0b2c-4813-ba1d-9713136f14b1",
      "severityThresholds": {
        "lowMid": 5,
        "midHigh": 20
      },
      "predictions": [
        {
          "predictionId": "1f29d051a-e766-43c1-9ff7-066624bfa148",
          "resultId": "1f29d051a-e766-43c1-9ff7-066624bfa148",
          "registrationId": "7818ddc9-2623-4407-a49e-630f5e5faf80",
          "date": "2024-08-27",
          "employeeId": "67f0bb7b-8975-4bea-a707-3e83bc97ebe0",
          "anomalyScore": 31,
          "anomalySeverity": "low",
          "significantFields": [
            {
              "field": "work_duration",
              "significance": 31,
              "direction": 1
            }
          ],
          "adheresToPlan": false,
          "aggregated": false,
          "missing": false,
          "relatedRegistrationIds": [],
          "subModelId": "58c72d26-4489-4100-928c-0aad8b4e82bb",
          "breaches": [
            {
              "ruleId": "rule_1",
              "relatedFields": ["work_duration"]
            }
          ]
        },
        {
          "predictionId": "af394051a-e766-43c1-9ff7-066624bfaf4s",
          "resultId": "af394051a-e766-43c1-9ff7-066624bfaf4s",
          "registrationId": "4ec5efb2-9194-4bbd-88e4-75e9bf2f5705",
          "date": "2025-03-20",
          "employeeId": "67f0bb7b-8975-4bea-a707-3e83bc97ebe0",
          "anomalyScore": 0,
          "anomalySeverity": "low",
          "significantFields": [],
          "adheresToPlan": true,
          "aggregated": false,
          "missing": false,
          "relatedRegistrationIds": [],
          "subModelId": "58c72d26-4489-4100-928c-0aad8b4e82bb",
          "breaches": []
        }
      ],
      "plans": [
        {
          "resultId": "63d84ec4-51e2-4008-896c-67a773bf4ddb",
          "planId": "8f7d3b2a-1c4e-4f6d-9b8a-5e2f1d3c4b5a",
          "date": "2025-03-17",
          "employeeId": "67f0bb7b-8975-4bea-a707-3e83bc97ebe0",
          "breaches": [
            {
              "ruleId": "max_hours_per_7_days",
              "relatedFeatures": ["work_duration"],
              "relatedIds": [
                "8f7d3b2a-1c4e-4f6d-9b8a-5e2f1d3c4b5a",
                "7e6d5c4b-3a2b-1c4e-4f6d-9b8a5e2f1d3c"
              ]
            }
          ]
        },
        {
          "resultId": "0cae3126-b49f-4045-91bc-f3305c7705be",
          "planId": "7e6d5c4b-3a2b-1c4e-4f6d-9b8a5e2f1d3c",
          "date": "2025-03-20",
          "employeeId": "67f0bb7b-8975-4bea-a707-3e83bc97ebe0",
          "breaches": [
            {
              "ruleId": "rule_1",
              "relatedFeatures": ["work_duration"],
              "relatedIds": [
                "8f7d3b2a-1c4e-4f6d-9b8a-5e2f1d3c4b5a",
                "7e6d5c4b-3a2b-1c4e-4f6d-9b8a5e2f1d3c"
              ]
            },
            {
              "ruleId": "rule_2",
              "relatedFeatures": ["work_duration"],
              "relatedIds": ["7e6d5c4b-3a2b-1c4e-4f6d-9b8a5e2f1d3c"]
            }
          ]
        }
      ]
    }
  ]
}

Comments

• breaches is a (empty in the case of none found) list of breaches of the work time regulation or other rules.
• adheresToPlan is a boolean value indicating if the registration adheres to the submitted plans.