developer portal

Time

Get cost center

Returns a cost center by id.

Privilege required: Api: Resource read or Api: Resource management

Path parameters

NameTypeRequiredExample
idstringrequired00000000-0000-0000-0000-000000000000

Responses

200OK
FieldType
Data(default = null)object
{
  "Data": {
    "Id": "00000000-0000-0000-0000-000000000000",
    "Name": "Workplace 1",
    "Code": "012345",
    "ExpirationDate": "2022-08-24T17:00:00+01:00",
    "Poi": {
      "Id": "00000000-0000-0000-0000-000000000000",
      "Name": "Home",
      "Code": "012345"
    },
    "AutoCreate": false,
    "CreationDate": "2021-08-24T17:00:00+01:00"
  }
}
401Unauthorized
403Forbidden

Create/Update cost center

Creates a new cost center if no cost center exists with the given code.

Updates the cost center if a cost center exists with the given code.

If no expiration date is provided, the cost center will expire within one year.

Request body

object

FieldTypeRequired
Namestringrequired
Code(default = null)stringrequired
ExpirationDate(default = null)stringoptional
PoiId(default = null)stringoptional
ValidatorIds(default = [])arrayoptional

Responses

200OK
FieldType
Data(default = null)object
{
  "Data": {
    "Id": "00000000-0000-0000-0000-000000000000",
    "Name": "Workplace 1",
    "Code": "012345",
    "ExpirationDate": "2022-08-24T17:00:00+01:00",
    "Poi": {
      "Id": "00000000-0000-0000-0000-000000000000",
      "Name": "Home",
      "Code": "012345"
    },
    "AutoCreate": false,
    "CreationDate": "2021-08-24T17:00:00+01:00"
  }
}
400BadRequest
FieldType
Entityobject
ValidationResultarray
{
  "Entity": {
    "Name": "Workplace 1",
    "Code": "012345",
    "ExpirationDate": "2021-08-24T17:00:00+01:00",
    "PoiId": "00000000-0000-0000-0000-000000000000",
    "ValidatorIds": [
      "00000000-0000-0000-0000-000000000000",
      "00000000-0000-0000-0000-000000000000"
    ]
  },
  "ValidationResult": [
    {
      "Message": "",
      "SourceMemberNames": []
    }
  ]
}
401Unauthorized
403Forbidden
417ExpectationFailed

Delete cost center

Deletes a cost center.

Request body

Responses

200OK
FieldType
Idstring
Namestring
Code(default = null)string
Poi(default = null)object
_typeDescriptorstring
{
  "Id": "00000000-0000-0000-0000-000000000000",
  "Name": "Workplace 1",
  "Code": "012345",
  "Poi": {
    "Id": "00000000-0000-0000-0000-000000000000",
    "Name": "Work",
    "Code": "012345",
    "PoiType": {
      "Id": "00000000-0000-0000-0000-000000000000",
      "Name": "Work place",
      "Color": "#00FF2F"
    },
    "IsAssetLocation": false,
    "Street": "Dumolinlaan",
    "HouseNumber": "9",
    "City": "Kortrijk",
    "Submunicipality": "Kortrijk",
    "PostalCode": "8500",
    "Country": 0,
    "Priority": "0",
    "Description": "Work",
    "GeographyWkt": "POLYGON ((3.145219 50.81309, 3.244998 50.81309, 3.244998 50.91806, 3.145219 50.91806, 3.145219 50.81309))",
    "LonMin": 3.145219,
    "LonMax": 3.244998,
    "LatMin": 50.81309,
    "LatMax": 50.91806,
    "MarkerLon": 3.145219,
    "MarkerLat": 50.81309,
    "IsLambert72": false,
    "Radius": 0.03,
    "ReverseGeocoding": false,
    "Groups": [
      {
        "Id": "00000000-0000-0000-0000-000000000000",
        "Name": "Work places",
        "Pois": [
          {}
        ],
        "NumberOfPois": 1
      }
    ]
  }
}
400BadRequest
FieldType
Entityobject
ValidationResultarray
{
  "Entity": {
    "Id": "00000000-0000-0000-0000-000000000000",
    "Name": "Workplace 1",
    "Code": "012345",
    "Poi": {
      "Id": "00000000-0000-0000-0000-000000000000",
      "Name": "Work",
      "Code": "012345",
      "PoiType": {
        "Id": "00000000-0000-0000-0000-000000000000",
        "Name": "Work place",
        "Color": "#00FF2F"
      },
      "IsAssetLocation": false,
      "Street": "Dumolinlaan",
      "HouseNumber": "9",
      "City": "Kortrijk",
      "Submunicipality": "Kortrijk",
      "PostalCode": "8500",
      "Country": 0,
      "Priority": "0",
      "Description": "Work",
      "GeographyWkt": "POLYGON ((3.145219 50.81309, 3.244998 50.81309, 3.244998 50.91806, 3.145219 50.91806, 3.145219 50.81309))",
      "LonMin": 3.145219,
      "LonMax": 3.244998,
      "LatMin": 50.81309,
      "LatMax": 50.91806,
      "MarkerLon": 3.145219,
      "MarkerLat": 50.81309,
      "IsLambert72": false,
      "Radius": 0.03,
      "ReverseGeocoding": false,
      "Groups": [
        {
          "Id": "00000000-0000-0000-0000-000000000000",
          "Name": "Work places",
          "Pois": [
            {}
          ],
          "NumberOfPois": 1
        }
      ]
    }
  },
  "ValidationResult": [
    {
      "Message": "",
      "SourceMemberNames": []
    }
  ]
}
401Unauthorized
403Forbidden
417ExpectationFailed

Link validators to cost center

Links one or more validators to a cost center.

Path parameters

NameTypeRequiredExample
idstringrequired00000000-0000-0000-0000-000000000000

Request body

Responses

200OK
FieldType
Data(default = null)array
{
  "Data": [
    {
      "Id": "00000000-0000-0000-0000-000000000000",
      "Name": "Workplace 1",
      "Code": "012345"
    }
  ]
}
400BadRequest
FieldType
Entityobject
ValidationResultarray
{
  "Entity": {
    "ValidatorIds": [
      "00000000-0000-0000-0000-000000000000",
      "00000000-0000-0000-0000-000000000000"
    ]
  },
  "ValidationResult": [
    {
      "Message": "",
      "SourceMemberNames": []
    }
  ]
}
401Unauthorized
403Forbidden
417ExpectationFailed

Unlink validators from cost center

Unlinks one or more validators from a cost center.

Path parameters

NameTypeRequiredExample
idstringrequired00000000-0000-0000-0000-000000000000

Request body

Responses

200OK
FieldType
Data(default = null)array
{
  "Data": [
    {
      "Id": "00000000-0000-0000-0000-000000000000",
      "Name": "Workplace 1",
      "Code": "012345"
    }
  ]
}
400BadRequest
FieldType
Entityobject
ValidationResultarray
{
  "Entity": {
    "ValidatorIds": [
      "00000000-0000-0000-0000-000000000000",
      "00000000-0000-0000-0000-000000000000"
    ]
  },
  "ValidationResult": [
    {
      "Message": "",
      "SourceMemberNames": []
    }
  ]
}
401Unauthorized
403Forbidden
417ExpectationFailed

Get day programs

Returns a list of all day programs in detail.

Privilege required: Api: Timesheet read or Api: Timesheet management

Responses

200OK
[
  {
    "Id": "00000000-0000-0000-0000-000000000000",
    "Name": "Default",
    "Code": "012345",
    "DayStartBoundary": "00:00:00",
    "DayDuration": "24:00:00",
    "Break1StartRelativeToDayBoundary": "00:00:00",
    "Break1StopRelativeToDayBoundary": "00:00:00",
    "Break2StartRelativeToDayBoundary": "00:00:00",
    "Break2StopRelativeToDayBoundary": "00:00:00",
    "Break3StartRelativeToDayBoundary": "00:00:00",
    "Break3StopRelativeToDayBoundary": "00:00:00",
    "MondayWorkingStartRelativeToDayBoundary": "00:00:00",
    "MondayWorkingStopRelativeToDayBoundary": "00:00:00",
    "TuesdayWorkingStartRelativeToDayBoundary": "00:00:00",
    "TuesdayWorkingStopRelativeToDayBoundary": "00:00:00",
    "WednesdayWorkingStartRelativeToDayBoundary": "00:00:00",
    "WednesdayWorkingStopRelativeToDayBoundary": "00:00:00",
    "ThursdayWorkingStartRelativeToDayBoundary": "00:00:00",
    "ThursdayWorkingStopRelativeToDayBoundary": "00:00:00",
    "FridayWorkingStartRelativeToDayBoundary": "00:00:00",
    "FridayWorkingStopRelativeToDayBoundary": "00:00:00",
    "SaturdayWorkingStartRelativeToDayBoundary": "00:00:00",
    "SaturdayWorkingStopRelativeToDayBoundary": "00:00:00",
    "SundayWorkingStartRelativeToDayBoundary": "00:00:00",
    "SundayWorkingStopRelativeToDayBoundary": "00:00:00",
    "Users": [
      {
        "Id": "00000000-0000-0000-0000-000000000000",
        "Name": "John Doe"
      }
    ]
  }
]
401Unauthorized
403Forbidden

Get plannings

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

Privilege required: Api: Planning read or Api: Planning management

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",
    "User": {
      "Id": "00000000-0000-0000-0000-000000000000",
      "Name": "John Doe",
      "Code": "012345",
      "EmployerCode": "012345",
      "Email": "john.doe@doe.com",
      "Gsm": "+32477665544",
      "FreeField1": null,
      "FreeField2": null,
      "FreeField3": null,
      "FreeField4": null,
      "FreeField5": null,
      "FreeField6": null,
      "Notes": null,
      "Street": "Dumolinlaan",
      "HouseNumber": "9",
      "City": "Kortrijk",
      "PostalCode": "8500",
      "Submunicipality": "Kortrijk",
      "Country": 0,
      "Longitude": 3.245304,
      "Latitude": 50.812939,
      "DefaultDayProgram": {
        "Id": "00000000-0000-0000-0000-000000000000",
        "Name": "Default"
      },
      "Groups": [
        {
          "Id": "00000000-0000-0000-0000-000000000000",
          "Name": "Employees",
          "Type": 0,
          "Code": "012345"
        }
      ]
    },
    "Resource": {
      "Id": "00000000-0000-0000-0000-000000000000",
      "Name": "John Doe",
      "Code": "012345",
      "Type": 0
    },
    "FromDate": "2019-01-24T08:00:00",
    "ToDate": "2019-01-24T17:00:00",
    "BreakTime": "01:00:00",
    "Description": "012345",
    "ActivityNumber": "012345",
    "Poi": {
      "Id": "00000000-0000-0000-0000-000000000000",
      "Name": "Work",
      "Code": "012345"
    }
  }
]
401Unauthorized
403Forbidden

Delete plannings

Deletes all plannings 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
401Unauthorized
403Forbidden

Edit planning

Edit a planning with given id.

Request body

object

FieldTypeRequired
Idstringrequired
UserIdstringrequired
ResourceId(default = null)stringoptional
FromDateUtcstringrequired
ToDateUtcstringrequired
BreakTime(default = null)stringoptional
Description(default = null)stringoptional
ActivityNumber(default = null)stringoptional
PoiId(default = null)stringoptional

Responses

200OK
FieldType
Data(default = null)object
{
  "Data": {
    "Id": "00000000-0000-0000-0000-000000000000",
    "User": {
      "Id": "00000000-0000-0000-0000-000000000000",
      "Code": "012345",
      "Name": "John Doe",
      "Type": 0
    },
    "Resource": {
      "Id": "00000000-0000-0000-0000-000000000000",
      "Code": "012345",
      "Name": "John Doe",
      "Type": 0
    },
    "FromDateUtc": "2019-01-25T08:00:00",
    "ToDateUtc": "2019-01-25T08:00:00",
    "BreakTime": "01:00:00",
    "Description": "012345",
    "ActivityNumber": "2023/0017",
    "Poi": {
      "Id": "00000000-0000-0000-0000-000000000000",
      "Name": "Work",
      "Code": "012345"
    }
  }
}
400BadRequest
FieldType
Entityobject
ValidationResultarray
{
  "Entity": {
    "Id": "00000000-0000-0000-0000-000000000000",
    "User": {
      "Id": "00000000-0000-0000-0000-000000000000",
      "Code": "012345",
      "Name": "John Doe",
      "Type": 0
    },
    "Resource": {
      "Id": "00000000-0000-0000-0000-000000000000",
      "Code": "012345",
      "Name": "John Doe",
      "Type": 0
    },
    "FromDateLocal": "2019-01-25T10:00:00",
    "FromDateUtc": "2019-01-25T08:00:00",
    "ToDateLocal": "2019-01-25T10:00:00",
    "ToDateUtc": "2019-01-25T08:00:00",
    "BreakTime": "01:00:00",
    "Description": "012345",
    "Poi": {
      "Id": "00000000-0000-0000-0000-000000000000",
      "Name": "Work",
      "Code": "012345"
    }
  },
  "ValidationResult": [
    {
      "Message": "",
      "SourceMemberNames": []
    }
  ]
}
401Unauthorized
403Forbidden
417ExpectationFailed

Create planning

Creates a new planning for the given resource.

Request body

object

FieldTypeRequired
Idstringoptional
UserIdstringrequired
ResourceId(default = null)stringoptional
FromDateUtcstringrequired
ToDateUtcstringrequired
BreakTime(default = null)stringoptional
Description(default = null)stringoptional
ActivityNumber(default = null)stringoptional
PoiId(default = null)stringoptional

Responses

200OK
FieldType
Data(default = null)object
{
  "Data": {
    "Id": "00000000-0000-0000-0000-000000000000",
    "User": {
      "Id": "00000000-0000-0000-0000-000000000000",
      "Code": "012345",
      "Name": "John Doe",
      "Type": 0
    },
    "Resource": {
      "Id": "00000000-0000-0000-0000-000000000000",
      "Code": "012345",
      "Name": "John Doe",
      "Type": 0
    },
    "FromDateUtc": "2019-01-25T08:00:00",
    "ToDateUtc": "2019-01-25T08:00:00",
    "BreakTime": "01:00:00",
    "Description": "012345",
    "ActivityNumber": "2023/0017",
    "Poi": {
      "Id": "00000000-0000-0000-0000-000000000000",
      "Name": "Work",
      "Code": "012345"
    }
  }
}
400BadRequest
FieldType
Entityobject
ValidationResultarray
{
  "Entity": {
    "Id": "00000000-0000-0000-0000-000000000000",
    "User": {
      "Id": "00000000-0000-0000-0000-000000000000",
      "Code": "012345",
      "Name": "John Doe",
      "Type": 0
    },
    "Resource": {
      "Id": "00000000-0000-0000-0000-000000000000",
      "Code": "012345",
      "Name": "John Doe",
      "Type": 0
    },
    "FromDateLocal": "2019-01-25T10:00:00",
    "FromDateUtc": "2019-01-25T08:00:00",
    "ToDateLocal": "2019-01-25T10:00:00",
    "ToDateUtc": "2019-01-25T08:00:00",
    "BreakTime": "01:00:00",
    "Description": "012345",
    "Poi": {
      "Id": "00000000-0000-0000-0000-000000000000",
      "Name": "Work",
      "Code": "012345"
    }
  },
  "ValidationResult": [
    {
      "Message": "",
      "SourceMemberNames": []
    }
  ]
}
401Unauthorized
403Forbidden
417ExpectationFailed

Delete planning

Deletes a planning by id.

Request body

Responses

200OK
FieldType
Data(default = null)object
{
  "Data": {
    "Id": "00000000-0000-0000-0000-000000000000",
    "User": {
      "Id": "00000000-0000-0000-0000-000000000000",
      "Code": "012345",
      "Name": "John Doe",
      "Type": 0
    },
    "Resource": {
      "Id": "00000000-0000-0000-0000-000000000000",
      "Code": "012345",
      "Name": "John Doe",
      "Type": 0
    },
    "FromDateLocal": "2019-01-25T10:00:00",
    "FromDateUtc": "2019-01-25T08:00:00",
    "ToDateLocal": "2019-01-25T10:00:00",
    "ToDateUtc": "2019-01-25T08:00:00",
    "BreakTime": "01:00:00",
    "Description": "012345",
    "Poi": {
      "Id": "00000000-0000-0000-0000-000000000000",
      "Name": "Work",
      "Code": "012345"
    }
  }
}
400BadRequest
FieldType
Entityobject
ValidationResultarray
{
  "Entity": {
    "Id": "00000000-0000-0000-0000-000000000000",
    "User": {
      "Id": "00000000-0000-0000-0000-000000000000",
      "Code": "012345",
      "Name": "John Doe",
      "Type": 0
    },
    "Resource": {
      "Id": "00000000-0000-0000-0000-000000000000",
      "Code": "012345",
      "Name": "John Doe",
      "Type": 0
    },
    "FromDateLocal": "2019-01-25T10:00:00",
    "FromDateUtc": "2019-01-25T08:00:00",
    "ToDateLocal": "2019-01-25T10:00:00",
    "ToDateUtc": "2019-01-25T08:00:00",
    "BreakTime": "01:00:00",
    "Description": "012345",
    "Poi": {
      "Id": "00000000-0000-0000-0000-000000000000",
      "Name": "Work",
      "Code": "012345"
    }
  },
  "ValidationResult": [
    {
      "Message": "",
      "SourceMemberNames": []
    }
  ]
}
401Unauthorized
403Forbidden
417ExpectationFailed

Get planning anomalies

Returns a list of all planning anomalies for a user on a single day.

Privilege required: Api: Planning read or Api: Planning management

Query parameters

NameTypeRequiredExample
userIdstringrequired00000000-0000-0000-0000-000000000000
yearnumberrequired2019
monthnumberrequired1
daynumberrequired25

Responses

200OK
FieldType
AnomalyTypes(default = null)array
WorkedHours(default = null)string
PlannedHours(default = null)string
WorkedFrom(default = null)string
WorkedTo(default = null)string
_typeDescriptorstring
{
  "AnomalyTypes": [
    {},
    {}
  ],
  "WorkedHours": "01:00:00",
  "PlannedHours": "08:00:00",
  "WorkedFrom": "2019-01-24T08:00:00+01:00",
  "WorkedTo": "2019-01-24T09:00:00+01:00"
}
401Unauthorized
403Forbidden