developer portal

Clocking

Get clockings

Returns a list of all clockings within a date/time range.

Query parameters

NameTypeRequiredExample
fromDatestringrequired2019-01-25T08:00:00
toDatestringrequired2019-01-25T17:00:00
includeClockingsWithoutUserbooleanoptionalfalse

Responses

200OK
[
  {
    "Id": "00000000-0000-0000-0000-000000000000",
    "DateTimeUtc": "2019-01-25T07:29:37",
    "DateTimeLocal": "2019-01-25T08:29:37",
    "User": {
      "Id": "00000000-0000-0000-0000-000000000000",
      "Code": "012345",
      "EmployerCode": "012345",
      "Name": "John Doe",
      "Badge": {
        "Id": "00000000-0000-0000-0000-000000000000",
        "InternalNumber": "00AA11BB",
        "ExternalNumber": "12345678"
      },
      "DayProgramId": "00000000-0000-0000-0000-000000000000"
    },
    "Vehicle": {
      "Id": "00000000-0000-0000-0000-000000000000",
      "Code": "012345",
      "Name": "Vehicle 1",
      "VehicleTypeId": "00000000-0000-0000-0000-000000000000",
      "LastSyncDateUtc": "2019-01-25T07:29:37",
      "LastPosition": {
        "AnalogExportList": [
          {
            "Number": 0,
            "Name": null,
            "StatusName": null,
            "AnalogInputType": 0
          }
        ],
        "InputExportList": [
          {
            "Number": 0,
            "Name": null,
            "Status": null,
            "StatusName": null
          }
        ],
        "IsPrivate": false,
        "BadgeUser": "John Doe",
        "BadgeNr": "00AA11BB",
        "TypeText": "Position",
        "Type": "1",
        "VehicleId": "00000000-0000-0000-0000-000000000000",
        "InputAcc": false,
        "Heading": 10,
        "Speed": 50,
        "Altitude": 0,
        "Latitude": 50.812939,
        "Longitude": 3.245304,
        "AddressExport": {
          "Street": "Dumolinlaan",
          "HouseNumber": "9",
          "PostalCode": "8500",
          "City": "Kortrijk",
          "Submunicipality": "Kortrijk",
          "Country": 0
        },
        "ReportDateLocal": "2019-01-25T08:29:37",
        "ReportDateUtc": "2019-01-25T07:29:37",
        "GpsDateUtc": "2019-01-25T07:29:37",
        "OutputExportList": [
          {
            "Number": 0,
            "Name": null,
            "Status": null,
            "StatusName": null
          }
        ],
        "Pois": [
          "00000000-0000-0000-0000-000000000000",
          "00000000-0000-0000-0000-000000000000"
        ]
      }
    },
    "Type": 0,
    "Location": {
      "Address": {
        "Street": "Dumolinlaan",
        "HouseNumber": "9",
        "PostalCode": "8500",
        "City": "Kortrijk",
        "Submunicipality": "Kortrijk",
        "Country": 0
      },
      "Longitude": 3.245304,
      "Latitude": 50.812939
    },
    "Pois": [
      "00000000-0000-0000-0000-000000000000",
      "00000000-0000-0000-0000-000000000000"
    ],
    "IsManual": false,
    "Description": null,
    "AbsenceCode": null,
    "JobNumber": "1575-7577-4",
    "Note": "clocking note"
  }
]
401Unauthorized
403Forbidden

Create clocking

Creates a new clocking.

The allowed clocking types are: Start work, Start activity, Start external & Stop external.

Request body

object

FieldTypeRequired
ClockingType(default = 1)objectrequired
Description(default = null)stringoptional
JobNumber(default = null)stringoptional
ExternalType(default = 0)numberoptional
ExternalCode(default = null)stringoptional
DateTimeUtc(default = null)stringoptional
UserCodestringrequired
VehicleCodestringoptional

Responses

200OK
FieldType
Data(default = null)object
{
  "Data": {
    "Id": "00000000-0000-0000-0000-000000000000",
    "DateTimeUtc": "2021-11-25T07:00:00",
    "DateTimeLocal": "2021-11-25T08:00:00",
    "ClockingType": 0,
    "Description": null,
    "JobNumber": "1575-7577-4",
    "ExternalType": 0,
    "ExternalCode": null,
    "IsManual": false,
    "User": {
      "Id": "00000000-0000-0000-0000-000000000000",
      "Code": "012345",
      "Name": "John Doe",
      "Type": 0
    },
    "Vehicle": {
      "Id": "00000000-0000-0000-0000-000000000000",
      "Code": "012345",
      "Name": "John Doe",
      "Type": 0
    },
    "Location": {
      "Address": {
        "CountryName": "Belgium",
        "AddressLine": "Dumolinlaan 9, 8500 Kortrijk, BE",
        "PoiList": [
          "00000000-0000-0000-0000-000000000000",
          "00000000-0000-0000-0000-000000000000"
        ],
        "City": "Kortrijk",
        "CityLine": "8500 Kortrijk, BE",
        "CountryCode": 0,
        "HouseNumber": "9",
        "Latitude": 50.812939,
        "Longitude": 3.245304,
        "PostalCode": "8500",
        "ShortAddressLine": "Dumolinlaan 9, Kortrijk, BE",
        "Street": "Dumolinlaan",
        "StreetLine": "Dumolinlaan 9",
        "Submunicipality": "Kortrijk"
      },
      "Pois": [
        {
          "Id": "00000000-0000-0000-0000-000000000000",
          "Name": "Work",
          "Code": "012345"
        }
      ],
      "Latitude": 50.812939,
      "Longitude": 3.245304
    },
    "AbsenceType": {
      "Name": "Sickness",
      "AbsenceCode": "100",
      "Paid": false,
      "TemporaryUnemployment": false,
      "Color": "#000000",
      "IncludeInExport": true
    }
  }
}
400BadRequest
FieldType
Entityobject
ValidationResultarray
{
  "Entity": {
    "Id": "00000000-0000-0000-0000-000000000000",
    "DateTimeUtc": "2021-11-25T07:00:00",
    "DateTimeLocal": "2021-11-25T08:00:00",
    "ClockingType": 0,
    "Description": null,
    "JobNumber": "1575-7577-4",
    "ExternalType": 0,
    "ExternalCode": null,
    "IsManual": false,
    "User": {
      "Id": "00000000-0000-0000-0000-000000000000",
      "Code": "012345",
      "Name": "John Doe",
      "Type": 0
    },
    "Vehicle": {
      "Id": "00000000-0000-0000-0000-000000000000",
      "Code": "012345",
      "Name": "John Doe",
      "Type": 0
    },
    "Location": {
      "Address": {
        "CountryName": "Belgium",
        "AddressLine": "Dumolinlaan 9, 8500 Kortrijk, BE",
        "PoiList": [
          "00000000-0000-0000-0000-000000000000",
          "00000000-0000-0000-0000-000000000000"
        ],
        "City": "Kortrijk",
        "CityLine": "8500 Kortrijk, BE",
        "CountryCode": 0,
        "HouseNumber": "9",
        "Latitude": 50.812939,
        "Longitude": 3.245304,
        "PostalCode": "8500",
        "ShortAddressLine": "Dumolinlaan 9, Kortrijk, BE",
        "Street": "Dumolinlaan",
        "StreetLine": "Dumolinlaan 9",
        "Submunicipality": "Kortrijk"
      },
      "Pois": [
        {
          "Id": "00000000-0000-0000-0000-000000000000",
          "Name": "Work",
          "Code": "012345"
        }
      ],
      "Latitude": 50.812939,
      "Longitude": 3.245304
    },
    "AbsenceType": {
      "Name": "Sickness",
      "AbsenceCode": "100",
      "Paid": false,
      "TemporaryUnemployment": false,
      "Color": "#000000",
      "IncludeInExport": true
    }
  },
  "ValidationResult": [
    {
      "Message": "",
      "SourceMemberNames": []
    }
  ]
}
401Unauthorized
403Forbidden
417ExpectationFailed

Create clocking (all types)

Creates a new clocking.

This endpoint requires the 'Clocking API: all types' option to be enabled by software support. Contact softwaresupport@geodynamics.be for assistance.

Request body

object

FieldTypeRequired
DateTimeUtc(default = null)stringoptional
ClockingTypestringrequired
UserCodestringrequired
VehicleCode(default = null)stringoptional
Description(default = null)stringoptional
JobNumber(default = null)stringoptional
ExternalTypestringoptional
ExternalCode(default = null)stringoptional
AbsenceTypeId(default = null)stringoptional

Responses

200OK
FieldType
Dataobject
{
  "Data": {
    "Id": "00000000-0000-0000-0000-000000000000",
    "DateTimeUtc": "2021-11-25T07:00:00",
    "DateTimeLocal": "2021-11-25T08:00:00",
    "ClockingType": "",
    "IsManual": true,
    "User": {
      "Id": "00000000-0000-0000-0000-000000000000",
      "Code": "012345",
      "Name": "John Doe",
      "Type": ""
    },
    "Vehicle": {
      "Id": "00000000-0000-0000-0000-000000000000",
      "Code": "012345",
      "Name": "John Doe",
      "Type": ""
    },
    "Location": {
      "Address": {
        "Street": "Dumolinlaan",
        "HouseNumber": "9",
        "City": "Kortrijk",
        "Submunicipality": "Kortrijk",
        "PostalCode": "8500",
        "Country": "",
        "Latitude": 50.81293,
        "Longitude": 3.2453
      },
      "Pois": [
        {
          "Id": "00000000-0000-0000-0000-000000000000",
          "Name": "Work",
          "Code": "012345"
        }
      ],
      "Longitude": 3.2453,
      "Latitude": 50.81293
    },
    "AbsenceType": {
      "Id": "00000000-0000-0000-0000-000000000000",
      "Name": "Sick leave",
      "Code": "SICKNESS",
      "Paid": true,
      "TemporaryUnemployed": false,
      "Color": "#FF0000",
      "IncludeInExport": true
    },
    "Description": null,
    "JobNumber": null,
    "ExternalType": "",
    "ExternalCode": null
  }
}
400BadRequest
FieldType
Entityobject
ValidationResultarray
{
  "Entity": {
    "Id": "00000000-0000-0000-0000-000000000000",
    "DateTimeUtc": "2021-11-25T07:00:00",
    "DateTimeLocal": "2021-11-25T08:00:00",
    "ClockingType": "",
    "IsManual": true,
    "User": {
      "Id": "00000000-0000-0000-0000-000000000000",
      "Code": "012345",
      "Name": "John Doe",
      "Type": ""
    },
    "Vehicle": {
      "Id": "00000000-0000-0000-0000-000000000000",
      "Code": "012345",
      "Name": "John Doe",
      "Type": ""
    },
    "Location": {
      "Address": {
        "Street": "Dumolinlaan",
        "HouseNumber": "9",
        "City": "Kortrijk",
        "Submunicipality": "Kortrijk",
        "PostalCode": "8500",
        "Country": "",
        "Latitude": 50.81293,
        "Longitude": 3.2453
      },
      "Pois": [
        {
          "Id": "00000000-0000-0000-0000-000000000000",
          "Name": "Work",
          "Code": "012345"
        }
      ],
      "Longitude": 3.2453,
      "Latitude": 50.81293
    },
    "AbsenceType": {
      "Id": "00000000-0000-0000-0000-000000000000",
      "Name": "Sick leave",
      "Code": "SICKNESS",
      "Paid": true,
      "TemporaryUnemployed": false,
      "Color": "#FF0000",
      "IncludeInExport": true
    },
    "Description": null,
    "JobNumber": null,
    "ExternalType": "",
    "ExternalCode": null
  },
  "ValidationResult": [
    {
      "Message": "",
      "SourceMemberNames": []
    }
  ]
}
401Unauthorized
403Forbidden
417ExpectationFailed
503ServiceUnavailable

Get clockings by user

Returns a list of all clockings for a user within a date/time range.

Query parameters

NameTypeRequiredExample
userIdstringrequired00000000-0000-0000-0000-000000000000
fromDatestringrequired2019-01-25T08:00:00
toDatestringrequired2019-01-25T17:00:00

Responses

200OK
[
  {
    "Id": "00000000-0000-0000-0000-000000000000",
    "DateTimeUtc": "2019-01-25T07:29:37",
    "DateTimeLocal": "2019-01-25T08:29:37",
    "User": {
      "Id": "00000000-0000-0000-0000-000000000000",
      "Code": "012345",
      "EmployerCode": "012345",
      "Name": "John Doe",
      "Badge": {
        "Id": "00000000-0000-0000-0000-000000000000",
        "InternalNumber": "00AA11BB",
        "ExternalNumber": "12345678"
      },
      "DayProgramId": "00000000-0000-0000-0000-000000000000"
    },
    "Vehicle": {
      "Id": "00000000-0000-0000-0000-000000000000",
      "Code": "012345",
      "Name": "Vehicle 1",
      "VehicleTypeId": "00000000-0000-0000-0000-000000000000",
      "LastSyncDateUtc": "2019-01-25T07:29:37",
      "LastPosition": {
        "AnalogExportList": [
          {
            "Number": 0,
            "Name": null,
            "StatusName": null,
            "AnalogInputType": 0
          }
        ],
        "InputExportList": [
          {
            "Number": 0,
            "Name": null,
            "Status": null,
            "StatusName": null
          }
        ],
        "IsPrivate": false,
        "BadgeUser": "John Doe",
        "BadgeNr": "00AA11BB",
        "TypeText": "Position",
        "Type": "1",
        "VehicleId": "00000000-0000-0000-0000-000000000000",
        "InputAcc": false,
        "Heading": 10,
        "Speed": 50,
        "Altitude": 0,
        "Latitude": 50.812939,
        "Longitude": 3.245304,
        "AddressExport": {
          "Street": "Dumolinlaan",
          "HouseNumber": "9",
          "PostalCode": "8500",
          "City": "Kortrijk",
          "Submunicipality": "Kortrijk",
          "Country": 0
        },
        "ReportDateLocal": "2019-01-25T08:29:37",
        "ReportDateUtc": "2019-01-25T07:29:37",
        "GpsDateUtc": "2019-01-25T07:29:37",
        "OutputExportList": [
          {
            "Number": 0,
            "Name": null,
            "Status": null,
            "StatusName": null
          }
        ],
        "Pois": [
          "00000000-0000-0000-0000-000000000000",
          "00000000-0000-0000-0000-000000000000"
        ]
      }
    },
    "Type": 0,
    "Location": {
      "Address": {
        "Street": "Dumolinlaan",
        "HouseNumber": "9",
        "PostalCode": "8500",
        "City": "Kortrijk",
        "Submunicipality": "Kortrijk",
        "Country": 0
      },
      "Longitude": 3.245304,
      "Latitude": 50.812939
    },
    "Pois": [
      "00000000-0000-0000-0000-000000000000",
      "00000000-0000-0000-0000-000000000000"
    ],
    "IsManual": false,
    "Description": null,
    "AbsenceCode": null,
    "JobNumber": "1575-7577-4",
    "Note": "clocking note"
  }
]
401Unauthorized
403Forbidden

Get clockings by users

Returns a list of all clockings for one or more users within a date/time range.

Query parameters

NameTypeRequiredExample
fromDatestringrequired2019-01-25T08:00:00
toDatestringrequired2019-01-25T17:00:00

Request body

Responses

200OK
[
  {
    "Id": "00000000-0000-0000-0000-000000000000",
    "DateTimeUtc": "2019-01-25T07:29:37",
    "DateTimeLocal": "2019-01-25T08:29:37",
    "User": {
      "Id": "00000000-0000-0000-0000-000000000000",
      "Code": "012345",
      "EmployerCode": "012345",
      "Name": "John Doe",
      "Badge": {
        "Id": "00000000-0000-0000-0000-000000000000",
        "InternalNumber": "00AA11BB",
        "ExternalNumber": "12345678"
      },
      "DayProgramId": "00000000-0000-0000-0000-000000000000"
    },
    "Vehicle": {
      "Id": "00000000-0000-0000-0000-000000000000",
      "Code": "012345",
      "Name": "Vehicle 1",
      "VehicleTypeId": "00000000-0000-0000-0000-000000000000",
      "LastSyncDateUtc": "2019-01-25T07:29:37",
      "LastPosition": {
        "AnalogExportList": [
          {
            "Number": 0,
            "Name": null,
            "StatusName": null,
            "AnalogInputType": 0
          }
        ],
        "InputExportList": [
          {
            "Number": 0,
            "Name": null,
            "Status": null,
            "StatusName": null
          }
        ],
        "IsPrivate": false,
        "BadgeUser": "John Doe",
        "BadgeNr": "00AA11BB",
        "TypeText": "Position",
        "Type": "1",
        "VehicleId": "00000000-0000-0000-0000-000000000000",
        "InputAcc": false,
        "Heading": 10,
        "Speed": 50,
        "Altitude": 0,
        "Latitude": 50.812939,
        "Longitude": 3.245304,
        "AddressExport": {
          "Street": "Dumolinlaan",
          "HouseNumber": "9",
          "PostalCode": "8500",
          "City": "Kortrijk",
          "Submunicipality": "Kortrijk",
          "Country": 0
        },
        "ReportDateLocal": "2019-01-25T08:29:37",
        "ReportDateUtc": "2019-01-25T07:29:37",
        "GpsDateUtc": "2019-01-25T07:29:37",
        "OutputExportList": [
          {
            "Number": 0,
            "Name": null,
            "Status": null,
            "StatusName": null
          }
        ],
        "Pois": [
          "00000000-0000-0000-0000-000000000000",
          "00000000-0000-0000-0000-000000000000"
        ]
      }
    },
    "Type": 0,
    "Location": {
      "Address": {
        "Street": "Dumolinlaan",
        "HouseNumber": "9",
        "PostalCode": "8500",
        "City": "Kortrijk",
        "Submunicipality": "Kortrijk",
        "Country": 0
      },
      "Longitude": 3.245304,
      "Latitude": 50.812939
    },
    "Pois": [
      "00000000-0000-0000-0000-000000000000",
      "00000000-0000-0000-0000-000000000000"
    ],
    "IsManual": false,
    "Description": null,
    "AbsenceCode": null,
    "JobNumber": "1575-7577-4",
    "Note": "clocking note"
  }
]
401Unauthorized
403Forbidden

Get manual clockings by user

Returns a list of all manual clockings for a user within a date/time range.

Query parameters

NameTypeRequiredExample
userIdstringrequired00000000-0000-0000-0000-000000000000
fromDatestringrequired2019-01-25T08:00:00
toDatestringrequired2019-01-25T17:00:00

Responses

200OK
[
  {
    "Id": "00000000-0000-0000-0000-000000000000",
    "DateTimeUtc": "2019-01-25T07:29:37",
    "DateTimeLocal": "2019-01-25T08:29:37",
    "User": {
      "Id": "00000000-0000-0000-0000-000000000000",
      "Code": "012345",
      "EmployerCode": "012345",
      "Name": "John Doe",
      "Badge": {
        "Id": "00000000-0000-0000-0000-000000000000",
        "InternalNumber": "00AA11BB",
        "ExternalNumber": "12345678"
      },
      "DayProgramId": "00000000-0000-0000-0000-000000000000"
    },
    "Vehicle": {
      "Id": "00000000-0000-0000-0000-000000000000",
      "Code": "012345",
      "Name": "Vehicle 1",
      "VehicleTypeId": "00000000-0000-0000-0000-000000000000",
      "LastSyncDateUtc": "2019-01-25T07:29:37",
      "LastPosition": {
        "AnalogExportList": [
          {
            "Number": 0,
            "Name": null,
            "StatusName": null,
            "AnalogInputType": 0
          }
        ],
        "InputExportList": [
          {
            "Number": 0,
            "Name": null,
            "Status": null,
            "StatusName": null
          }
        ],
        "IsPrivate": false,
        "BadgeUser": "John Doe",
        "BadgeNr": "00AA11BB",
        "TypeText": "Position",
        "Type": "1",
        "VehicleId": "00000000-0000-0000-0000-000000000000",
        "InputAcc": false,
        "Heading": 10,
        "Speed": 50,
        "Altitude": 0,
        "Latitude": 50.812939,
        "Longitude": 3.245304,
        "AddressExport": {
          "Street": "Dumolinlaan",
          "HouseNumber": "9",
          "PostalCode": "8500",
          "City": "Kortrijk",
          "Submunicipality": "Kortrijk",
          "Country": 0
        },
        "ReportDateLocal": "2019-01-25T08:29:37",
        "ReportDateUtc": "2019-01-25T07:29:37",
        "GpsDateUtc": "2019-01-25T07:29:37",
        "OutputExportList": [
          {
            "Number": 0,
            "Name": null,
            "Status": null,
            "StatusName": null
          }
        ],
        "Pois": [
          "00000000-0000-0000-0000-000000000000",
          "00000000-0000-0000-0000-000000000000"
        ]
      }
    },
    "Type": 0,
    "Location": {
      "Address": {
        "Street": "Dumolinlaan",
        "HouseNumber": "9",
        "PostalCode": "8500",
        "City": "Kortrijk",
        "Submunicipality": "Kortrijk",
        "Country": 0
      },
      "Longitude": 3.245304,
      "Latitude": 50.812939
    },
    "Pois": [
      "00000000-0000-0000-0000-000000000000",
      "00000000-0000-0000-0000-000000000000"
    ],
    "IsManual": false,
    "Description": null,
    "AbsenceCode": null,
    "JobNumber": "1575-7577-4",
    "Note": "clocking note"
  }
]
401Unauthorized
403Forbidden

Edit jobnumber by Clocking ID

Updates the jobnumber of a clocking by its clocking ID.

Path parameters

NameTypeRequiredExample
clockingIdstringrequired00000000-0000-0000-0000-000000000000

Request body

object

FieldTypeRequired
JobNumber(default = null)stringoptional

Responses

200OK
[
  {
    "Id": "00000000-0000-0000-0000-000000000000",
    "DateTimeUtc": "2021-11-25T07:00:00",
    "DateTimeLocal": "2021-11-25T08:00:00",
    "ClockingType": 0,
    "Description": null,
    "JobNumber": "1575-7577-4",
    "ExternalType": 0,
    "ExternalCode": null,
    "IsManual": false,
    "User": {
      "Id": "00000000-0000-0000-0000-000000000000",
      "Code": "012345",
      "Name": "John Doe",
      "Type": 0
    },
    "Vehicle": {
      "Id": "00000000-0000-0000-0000-000000000000",
      "Code": "012345",
      "Name": "John Doe",
      "Type": 0
    },
    "Location": {
      "Address": {
        "CountryName": "Belgium",
        "AddressLine": "Dumolinlaan 9, 8500 Kortrijk, BE",
        "PoiList": [
          "00000000-0000-0000-0000-000000000000",
          "00000000-0000-0000-0000-000000000000"
        ],
        "City": "Kortrijk",
        "CityLine": "8500 Kortrijk, BE",
        "CountryCode": 0,
        "HouseNumber": "9",
        "Latitude": 50.812939,
        "Longitude": 3.245304,
        "PostalCode": "8500",
        "ShortAddressLine": "Dumolinlaan 9, Kortrijk, BE",
        "Street": "Dumolinlaan",
        "StreetLine": "Dumolinlaan 9",
        "Submunicipality": "Kortrijk"
      },
      "Pois": [
        {
          "Id": "00000000-0000-0000-0000-000000000000",
          "Name": "Work",
          "Code": "012345"
        }
      ],
      "Latitude": 50.812939,
      "Longitude": 3.245304
    },
    "AbsenceType": {
      "Name": "Sickness",
      "AbsenceCode": "100",
      "Paid": false,
      "TemporaryUnemployment": false,
      "Color": "#000000",
      "IncludeInExport": true
    }
  }
]
401Unauthorized
403Forbidden