Running a Labor Model in Deputy

It is possible using the Deputy API to remotely execute the start of a labor model calculation. To do this you will need to know the location you want to execute the labor model for. Once you have that follow the below guide.

URL

curl --POST 'https://{install}.{geo}.deputy.com/api/v2/labor-model/location/{locationid}/run

Within the body of the request, you need to include two unix time stamps. This will define the period you want the labor model to be run for.

{
    "start": 12345678,
    "end": 12345678
}

Once you execute the API request, the labor model will begin to run. This can take a significant amount of time and it is not an async API so please keep that in mind with your infrastructure requirements. When the model has complete, you will get a JSON summary of what it has produced.

{
    "success": true,
    "data": {
        "hours": 15,
        "minutes": 20,
        "start": "1630245600",
        "end": "1630850400",
        "staffByDay": [
            {
                "date": "2021-08-30T00:00:00Z",
                "staffByArea": [
                    {
                        "area": 1,
                        "hours": 15,
                        "minutes": 20
                    }
                ]
            }
        ]
    }
}