developer portal

Config

Get resource groups

Returns a list of all resource groups.

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

Responses

200OK
[
  {
    "Id": "00000000-0000-0000-0000-000000000000",
    "Name": "Employees",
    "Type": 0,
    "Code": "012345"
  }
]
401Unauthorized
403Forbidden

Get resource groups by type

Returns a list of all resource groups of a certain resource type (Vehicle, User, TimeClock, ...).

Possible resource types are explained in Resource Types.

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

Query parameters

NameTypeRequiredExample
typenumberrequired0

Responses

200OK
[
  {
    "Id": "00000000-0000-0000-0000-000000000000",
    "Name": "Employees",
    "Type": 0,
    "Code": "012345"
  }
]
401Unauthorized
403Forbidden

Update resource group

Updates a resource group.

Request body

object

FieldTypeRequired
Idstringrequired
Namestringrequired
Code(default = null)stringoptional

Responses

200OK
FieldType
Idstring
Namestring
Type(default = 0)number
Code(default = null)string
_typeDescriptorstring
{
  "Id": "00000000-0000-0000-0000-000000000000",
  "Name": "Employees",
  "Type": 0,
  "Code": "012345"
}
400BadRequest
FieldType
Entityobject
ValidationResultarray
{
  "Entity": {
    "Id": "00000000-0000-0000-0000-000000000000",
    "Name": "Employees",
    "Type": 0,
    "Code": "012345"
  },
  "ValidationResult": [
    {
      "Message": "",
      "SourceMemberNames": []
    }
  ]
}
401Unauthorized
403Forbidden
417ExpectationFailed

Create resource group

Creates a new resource group.

Request body

object

FieldTypeRequired
Namestringrequired
Type(default = 0)numberrequired
Code(default = null)stringoptional

Responses

200OK
FieldType
Idstring
Namestring
Type(default = 0)number
Code(default = null)string
_typeDescriptorstring
{
  "Id": "00000000-0000-0000-0000-000000000000",
  "Name": "Employees",
  "Type": 0,
  "Code": "012345"
}
400BadRequest
FieldType
Entityobject
ValidationResultarray
{
  "Entity": {
    "Id": "00000000-0000-0000-0000-000000000000",
    "Name": "Employees",
    "Type": 0,
    "Code": "012345"
  },
  "ValidationResult": [
    {
      "Message": "",
      "SourceMemberNames": []
    }
  ]
}
401Unauthorized
403Forbidden
417ExpectationFailed

Delete resource group

Deletes a resource group.

Request body

object

FieldTypeRequired
Idstringrequired
Type(default = 0) numberrequired

Responses

200OK
FieldType
Idstring
Namestring
Type(default = 0)number
Code(default = null)string
_typeDescriptorstring
{
  "Id": "00000000-0000-0000-0000-000000000000",
  "Name": "Employees",
  "Type": 0,
  "Code": "012345"
}
400BadRequest
FieldType
Entityobject
ValidationResultarray
{
  "Entity": {
    "Id": "00000000-0000-0000-0000-000000000000",
    "Name": "Employees",
    "Type": 0,
    "Code": "012345"
  },
  "ValidationResult": [
    {
      "Message": "",
      "SourceMemberNames": []
    }
  ]
}
401Unauthorized
403Forbidden
417ExpectationFailed

Get resources of resource group

Returns a list of all resources of a resource group.

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

Path parameters

NameTypeRequiredExample
idstringrequired00000000-0000-0000-0000-000000000000

Responses

200OK
[
  {
    "Id": "00000000-0000-0000-0000-000000000000",
    "Name": "John Doe",
    "Code": "012345",
    "Type": 0
  }
]
401Unauthorized
403Forbidden

Add resources to resource group

Adds a list of resources of a certain resource type (Vehicle, User, TimeClock, ...) to a resource group.

In order to add all resources to a resource group, set AddAll to true. A search string can be used to filter the resources.

In order to add the listed resources to a resource group, set AddAll to false.

Possible resource types are explained in Resource Types.

Path parameters

NameTypeRequiredExample
idstringrequired00000000-0000-0000-0000-000000000000

Query parameters

NameTypeRequiredExample
typenumberrequired0

Request body

Responses

200OK
400BadRequest
FieldType
Entityobject
ValidationResultarray
{
  "Entity": {
    "Id": "00000000-0000-0000-0000-000000000000",
    "Name": "Employees",
    "Type": 0,
    "Code": "012345"
  },
  "ValidationResult": [
    {
      "Message": "",
      "SourceMemberNames": []
    }
  ]
}
401Unauthorized
403Forbidden
417ExpectationFailed

Remove resources from resource group

Removes a list of resources from a resource group.

In order to remove all resources from a resource group, set DeleteAll to true. A search string can be used to filter the resources.

In order to remove the listed resources from a resource group, set DeleteAll to false.

Path parameters

NameTypeRequiredExample
idstringrequired00000000-0000-0000-0000-000000000000

Request body

Responses

200OK
400BadRequest
FieldType
Entityobject
ValidationResultarray
{
  "Entity": {
    "Id": "00000000-0000-0000-0000-000000000000",
    "Name": "Employees",
    "Type": 0,
    "Code": "012345"
  },
  "ValidationResult": [
    {
      "Message": "",
      "SourceMemberNames": []
    }
  ]
}
401Unauthorized
403Forbidden
417ExpectationFailed

Get vehicles

Returns a list of all vehicles.

Privilege required: Api: Resource read or Manage vehicles and report

Responses

200OK
[
  {
    "Id": "00000000-0000-0000-0000-000000000000",
    "Name": "Vehicle 1",
    "IvrCode": null,
    "Code": "012345",
    "Category": 0,
    "FuelType": "1",
    "Co2Emission": 80,
    "RowOfSeatsCount": 2,
    "SeatsCount": 5,
    "LicensePlate": "1-ABC-123",
    "VinNumber": "ABCDE01234F567890",
    "HasTrackingData": false,
    "LastReportDate": "2019-03-19T11:45:47+01:00",
    "LastSyncDate": "2019-03-19T11:45:47+01:00",
    "UserNotes": null,
    "Weight": 600,
    "EmissionStandard": "300",
    "MaximumSpeed": 220,
    "NominalConsumption": 5.5,
    "CostCenter": {
      "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
          }
        ]
      }
    },
    "Groups": [
      {
        "Id": "00000000-0000-0000-0000-000000000000",
        "Name": "Employees",
        "Type": 0,
        "Code": "012345"
      }
    ]
  }
]
401Unauthorized
403Forbidden

Update vehicle

Updates an existing vehicle.

Request body

object

FieldTypeRequired
Idstringrequired
Namestringrequired
IvrCode(default = null) Code field that can be used for IVR based identification and app based filtering.stringoptional
Code(default = null)stringoptional
Category(default = 0) A vehicle category classifies a land vehicle for regulatory purposes.numberoptional
FuelType(default = 0)objectoptional
Co2Emission(default = null)numberoptional
RowOfSeatsCount(default = null) Number of seat rowsnumberoptional
SeatsCount(default = null) Number of seatsnumberoptional
LicensePlate(default = null)stringoptional
VinNumber(default = null) Vehicle Identification Numberstringoptional
HasTrackingData(default = false)booleanoptional
LastReportDate(default = null) Datetime of the most recent report.stringoptional
LastSyncDate(default = null) Datetime of the most recent server synchronization.stringoptional
UserNotes(default = null) User notesstringoptional
Weight(default = 0) Weight for viapass.numberoptional
EmissionStandard(default = 0) Emission standard for viapassobjectoptional
MaximumSpeed(default = null)numberoptional
NominalConsumption(default = 0.0) Normal consumption for Fleet Econumberoptional
CostCenter(default = null) Selected Cost Centerobjectoptional

Responses

200OK
FieldType
Idstring
Namestring
IvrCode(default = null) In case clockings are being created via IVR phone calls, the IVR code of a vehicle can be entered during the phone call to link your clocking to this particular vehicle.number
Code(default = null)string
Category(default = 0) The type of vehicle (see the overview of all options below). Only used in IntelliTracer V3.number
FuelType(default = 0)object
Co2Emission(default = null) Average C02 emission for this vehicle in grams per kilometer. Only used in IntelliTracer V3.number
RowOfSeatsCount(default = null) Amount of seat rows in the vehicle. Only used in IntelliTracer V3.number
SeatsCount(default = null) Amount of seats in the vehicle. Only used in IntelliTracer V3.number
LicensePlate(default = null)string
VinNumber(default = null) Vehicle identification number.string
HasTrackingData(default = false)boolean
LastReportDate(default = null) Date and time of the most recent tracking report we have received from this vehicle.string
LastSyncDate(default = null) Date and time of the most recent sync report we have received from this vehicle.string
UserNotes(default = null) Any additional information of your choice can be entered here.string
Weight(default = 0) Weight of this vehicle in kilograms.number
EmissionStandard(default = 0) European emission standard for this vehicle.object
MaximumSpeed(default = null)number
NominalConsumption(default = 0.0) Fuel consumption of this vehicle in liters per 100km.number
CostCenter(default = null) In case work in this vehicle should always be linked to a certain costcenter, that costcenter can be entered here.object
Groups(default = null) array
_typeDescriptorstring
{
  "Id": "00000000-0000-0000-0000-000000000000",
  "Name": "Vehicle 1",
  "IvrCode": null,
  "Code": "012345",
  "Category": 0,
  "FuelType": "1",
  "Co2Emission": 80,
  "RowOfSeatsCount": 2,
  "SeatsCount": 5,
  "LicensePlate": "1-ABC-123",
  "VinNumber": "ABCDE01234F567890",
  "HasTrackingData": false,
  "LastReportDate": "2019-03-19T11:45:47+01:00",
  "LastSyncDate": "2019-03-19T11:45:47+01:00",
  "UserNotes": null,
  "Weight": 600,
  "EmissionStandard": "300",
  "MaximumSpeed": 220,
  "NominalConsumption": 5.5,
  "CostCenter": {
    "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
        }
      ]
    }
  },
  "Groups": [
    {
      "Id": "00000000-0000-0000-0000-000000000000",
      "Name": "Employees",
      "Type": 0,
      "Code": "012345"
    }
  ]
}
400BadRequest
401Unauthorized
403Forbidden
417ExpectationFailed

Create vehicle

Creates a new vehicle.

Request body

object

FieldTypeRequired
Namestringrequired
IvrCode(default = null) Code field that can be used for IVR based identification and app based filtering.stringoptional
Code(default = null)stringoptional
Category(default = 0) A vehicle category classifies a land vehicle for regulatory purposes.numberoptional
FuelType(default = 0)objectoptional
Co2Emission(default = null)numberoptional
RowOfSeatsCount(default = null) Number of seat rowsnumberoptional
SeatsCount(default = null) Number of seatsnumberoptional
LicensePlate(default = null)stringoptional
VinNumber(default = null) Vehicle Identification Numberstringoptional
HasTrackingData(default = false)booleanoptional
LastReportDate(default = null) Datetime of the most recent report.stringoptional
LastSyncDate(default = null) Datetime of the most recent server synchronization.stringoptional
UserNotes(default = null) User notesstringoptional
Weight(default = 0) Weight for viapass.numberoptional
EmissionStandard(default = 0) Emission standard for viapassobjectoptional
MaximumSpeed(default = null)numberoptional
NominalConsumption(default = 0.0) Normal consumption for Fleet Econumberoptional
CostCenter(default = null) Selected Cost Centerobjectoptional

Responses

200OK
FieldType
Idstring
Namestring
IvrCode(default = null) In case clockings are being created via IVR phone calls, the IVR code of a vehicle can be entered during the phone call to link your clocking to this particular vehicle.number
Code(default = null)string
Category(default = 0) The type of vehicle (see the overview of all options below). Only used in IntelliTracer V3.number
FuelType(default = 0)object
Co2Emission(default = null) Average C02 emission for this vehicle in grams per kilometer. Only used in IntelliTracer V3.number
RowOfSeatsCount(default = null) Amount of seat rows in the vehicle. Only used in IntelliTracer V3.number
SeatsCount(default = null) Amount of seats in the vehicle. Only used in IntelliTracer V3.number
LicensePlate(default = null)string
VinNumber(default = null) Vehicle identification number.string
HasTrackingData(default = false)boolean
LastReportDate(default = null) Date and time of the most recent tracking report we have received from this vehicle.string
LastSyncDate(default = null) Date and time of the most recent sync report we have received from this vehicle.string
UserNotes(default = null) Any additional information of your choice can be entered here.string
Weight(default = 0) Weight of this vehicle in kilograms.number
EmissionStandard(default = 0) European emission standard for this vehicle.object
MaximumSpeed(default = null)number
NominalConsumption(default = 0.0) Fuel consumption of this vehicle in liters per 100km.number
CostCenter(default = null) In case work in this vehicle should always be linked to a certain costcenter, that costcenter can be entered here.object
Groups(default = null) array
_typeDescriptorstring
{
  "Id": "00000000-0000-0000-0000-000000000000",
  "Name": "Vehicle 1",
  "IvrCode": null,
  "Code": "012345",
  "Category": 0,
  "FuelType": "1",
  "Co2Emission": 80,
  "RowOfSeatsCount": 2,
  "SeatsCount": 5,
  "LicensePlate": "1-ABC-123",
  "VinNumber": "ABCDE01234F567890",
  "HasTrackingData": false,
  "LastReportDate": "2019-03-19T11:45:47+01:00",
  "LastSyncDate": "2019-03-19T11:45:47+01:00",
  "UserNotes": null,
  "Weight": 600,
  "EmissionStandard": "300",
  "MaximumSpeed": 220,
  "NominalConsumption": 5.5,
  "CostCenter": {
    "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
        }
      ]
    }
  },
  "Groups": [
    {
      "Id": "00000000-0000-0000-0000-000000000000",
      "Name": "Employees",
      "Type": 0,
      "Code": "012345"
    }
  ]
}
400BadRequest
401Unauthorized
403Forbidden
417ExpectationFailed

Get vehicle

Returns a vehicle by id.

Privilege required: Api: Resource read or Manage vehicles and report

Path parameters

NameTypeRequiredExample
idstringrequired00000000-0000-0000-0000-000000000000

Responses

200OK
FieldType
Idstring
Namestring
IvrCode(default = null) In case clockings are being created via IVR phone calls, the IVR code of a vehicle can be entered during the phone call to link your clocking to this particular vehicle.number
Code(default = null)string
Category(default = 0) The type of vehicle (see the overview of all options below). Only used in IntelliTracer V3.number
FuelType(default = 0)object
Co2Emission(default = null) Average C02 emission for this vehicle in grams per kilometer. Only used in IntelliTracer V3.number
RowOfSeatsCount(default = null) Amount of seat rows in the vehicle. Only used in IntelliTracer V3.number
SeatsCount(default = null) Amount of seats in the vehicle. Only used in IntelliTracer V3.number
LicensePlate(default = null)string
VinNumber(default = null) Vehicle identification number.string
HasTrackingData(default = false)boolean
LastReportDate(default = null) Date and time of the most recent tracking report we have received from this vehicle.string
LastSyncDate(default = null) Date and time of the most recent sync report we have received from this vehicle.string
UserNotes(default = null) Any additional information of your choice can be entered here.string
Weight(default = 0) Weight of this vehicle in kilograms.number
EmissionStandard(default = 0) European emission standard for this vehicle.object
MaximumSpeed(default = null)number
NominalConsumption(default = 0.0) Fuel consumption of this vehicle in liters per 100km.number
CostCenter(default = null) In case work in this vehicle should always be linked to a certain costcenter, that costcenter can be entered here.object
Groups(default = null) array
_typeDescriptorstring
{
  "Id": "00000000-0000-0000-0000-000000000000",
  "Name": "Vehicle 1",
  "IvrCode": null,
  "Code": "012345",
  "Category": 0,
  "FuelType": "1",
  "Co2Emission": 80,
  "RowOfSeatsCount": 2,
  "SeatsCount": 5,
  "LicensePlate": "1-ABC-123",
  "VinNumber": "ABCDE01234F567890",
  "HasTrackingData": false,
  "LastReportDate": "2019-03-19T11:45:47+01:00",
  "LastSyncDate": "2019-03-19T11:45:47+01:00",
  "UserNotes": null,
  "Weight": 600,
  "EmissionStandard": "300",
  "MaximumSpeed": 220,
  "NominalConsumption": 5.5,
  "CostCenter": {
    "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
        }
      ]
    }
  },
  "Groups": [
    {
      "Id": "00000000-0000-0000-0000-000000000000",
      "Name": "Employees",
      "Type": 0,
      "Code": "012345"
    }
  ]
}
401Unauthorized
403Forbidden

Get timeclock

Returns a timeclock 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": "Work",
    "Code": "012345",
    "UnitId": 123456,
    "SerialNumber": "012345",
    "ReaderType": "0",
    "TimeClockType": "0",
    "FirmwareVersion": "0",
    "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"
    },
    "Latitude": 50.812939,
    "Longitude": 3.245304,
    "CostCenter": {
      "Id": "00000000-0000-0000-0000-000000000000",
      "Code": "012345",
      "Name": "John Doe",
      "Type": 0
    },
    "LastReadDateLocal": "2019-01-25T08:29:37",
    "LastReadDateUtc": "2019-01-25T07:29:37",
    "LastWriteDateLocal": "2019-01-25T08:29:37",
    "LastWriteDateUtc": "2019-01-25T07:29:37"
  }
}
401Unauthorized
403Forbidden

Get verified days

Returns a list of all verified days based on given parameters.

Query parameters

NameTypeRequiredExample
fromDateUtcstringrequired2020-01-01
verifiedSinceUtcstringrequired2020-01-01

Responses

200OK
FieldType
Data(default = null)array
{
  "Data": [
    {
      "DateUtc": "2019-01-25T07:00:00",
      "DateLocal": "2019-01-25T08:00:00",
      "UserIds": [
        "00000000-0000-0000-0000-000000000000",
        "00000000-0000-0000-0000-000000000000"
      ]
    }
  ]
}
401Unauthorized
403Forbidden

Get point of interest

Returns a point of interest by id.

Privilege required: Api: Poi's read or Api: Poi's edit

Path parameters

NameTypeRequiredExample
idstringrequired00000000-0000-0000-0000-000000000000

Responses

200OK
FieldType
Data(default = null)object
{
  "Data": {
    "Id": "00000000-0000-0000-0000-000000000000",
    "Code": "012345",
    "Name": "Work",
    "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,
    "IsAssetLocation": false,
    "Type": {
      "Id": "00000000-0000-0000-0000-000000000000",
      "Name": "Work place",
      "Level": 0,
      "Color": "#00FF2F"
    },
    "Groups": [
      {
        "Id": "00000000-0000-0000-0000-000000000000",
        "Name": "Work places"
      }
    ]
  }
}
401Unauthorized
403Forbidden

Update point of interest (with location change)

Updates a point of interest.

In order to determine location by position (MarkerLon and MarkerLat), set ReverseGeocoding to true. Optional fields are IsLambert72.

In order to determine location by address (Street, HouseNumber, PostalCode and City), set ReverseGeocoding to false. Optional fields are Submunicipality, PostalCode and Country.

Request body

object

FieldTypeRequired
Namemax length = 50stringrequired
Codedefault = null max length = 500stringoptional
PoiType(default = null)objectrequired
IsAssetLocation(default = false)booleanoptional
Streetdefault = null max length = 70stringoptional
HouseNumberdefault = null max length = 10stringoptional
Citydefault = null max length = 70stringoptional
Submunicipalitydefault = null max length = 70stringoptional
PostalCodedefault = null max length = 10stringoptional
Country(default = 0 or Belgium)numberoptional
Priority(default = -) Determines which POI will be displayed on top in GeoDynamics (in case of overlapping POIs).stringrequired
Description(default = null)stringoptional
MarkerLon(default = null) Longitude coordinatenumberoptional
MarkerLat(default = null) Latitude coordinatenumberoptional
IsLambert72(default = false) Different geological projection system often used by Belgian governmental institutes.booleanoptional
Radius(default = 0.025) The radius determines the size of the POI. A radius of 0.1 will resullt in a POI of 200m by 200m (radius of 100m around the marker).numberoptional
ReverseGeocoding(default = false) Indicates whether location will be determined by position or address.booleanoptional
Idstringrequired

Responses

200OK
FieldType
Idstring
Namestring
Code(default = null)string
PoiType(default = null)object
IsAssetLocation(default = false)boolean
Street(default = null)string
HouseNumber(default = null)string
City(default = null)string
Submunicipality(default = null)string
PostalCode(default = null)string
Country(default = 0)number
Priority(default = null) Determines which POI will be displayed on top in GeoDynamics (in case of overlapping POIs).string
Description(default = null)string
GeographyWkt(default = null) The coordinates of all points that define the shape of the POI.string
LonMin(default = 0.0) Lowest longitude coordinate of the shape of the POI.number
LonMax(default = 0.0) Highest longitude coordinate of the shape of the POI.number
LatMin(default = 0.0) Lowest latitude coordinate of the shape of the POI.number
LatMax(default = 0.0) Highest latitude coordinate of the shape of the POI.number
MarkerLon(default = null) Longitude coordinate of the marker.number
MarkerLat(default = null) Latitude coordinate of the marker.number
IsLambert72(default = false) Different geological projection system often used by Belgian governmental institutes.boolean
Radius(default = null) The radius determines the size of the POI. A radius of 0.1 will resullt in a POI of 200m by 200m (radius of 100m around the marker).number
ReverseGeocoding(default = false) Indicates whether location will be determined by position or address.boolean
Groups(default = null)array
_typeDescriptorstring
{
  "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
401Unauthorized
403Forbidden
417ExpectationFailed

Create point of interest

Creates a new point of interest.

In order to determine location by position (MarkerLon and MarkerLat), set ReverseGeocoding to true. Optional fields are IsLambert72.

In order to determine location by address (Street, HouseNumber, PostalCode and City), set ReverseGeocoding to false. Optional fields are Submunicipality, PostalCode and Country.

Request body

object

FieldTypeRequired
Namemax length = 50stringrequired
Codedefault = null max length = 500stringoptional
PoiType(default = null)objectrequired
IsAssetLocation(default = false)booleanoptional
Streetdefault = null max length = 70stringoptional
HouseNumberdefault = null max length = 10stringoptional
Citydefault = null max length = 70stringoptional
Submunicipalitydefault = null max length = 70stringoptional
PostalCodedefault = null max length = 10stringoptional
Country(default = 0 or Belgium)numberoptional
Priority(default = -) Determines which POI will be displayed on top in GeoDynamics (in case of overlapping POIs).stringrequired
Description(default = null)stringoptional
MarkerLon(default = null) Longitude coordinatenumberoptional
MarkerLat(default = null) Latitude coordinatenumberoptional
IsLambert72(default = false) Different geological projection system often used by Belgian governmental institutes.booleanoptional
Radius(default = 0.025) The radius determines the size of the POI. A radius of 0.1 will resullt in a POI of 200m by 200m (radius of 100m around the marker).numberoptional
ReverseGeocoding(default = false) Indicates whether location will be determined by position or address.booleanoptional

Responses

200OK
FieldType
Idstring
Namestring
Code(default = null)string
PoiType(default = null)object
IsAssetLocation(default = false)boolean
Street(default = null)string
HouseNumber(default = null)string
City(default = null)string
Submunicipality(default = null)string
PostalCode(default = null)string
Country(default = 0)number
Priority(default = null) Determines which POI will be displayed on top in GeoDynamics (in case of overlapping POIs).string
Description(default = null)string
GeographyWkt(default = null) The coordinates of all points that define the shape of the POI.string
LonMin(default = 0.0) Lowest longitude coordinate of the shape of the POI.number
LonMax(default = 0.0) Highest longitude coordinate of the shape of the POI.number
LatMin(default = 0.0) Lowest latitude coordinate of the shape of the POI.number
LatMax(default = 0.0) Highest latitude coordinate of the shape of the POI.number
MarkerLon(default = null) Longitude coordinate of the marker.number
MarkerLat(default = null) Latitude coordinate of the marker.number
IsLambert72(default = false) Different geological projection system often used by Belgian governmental institutes.boolean
Radius(default = null) The radius determines the size of the POI. A radius of 0.1 will resullt in a POI of 200m by 200m (radius of 100m around the marker).number
ReverseGeocoding(default = false) Indicates whether location will be determined by position or address.boolean
Groups(default = null)array
_typeDescriptorstring
{
  "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
401Unauthorized
403Forbidden
417ExpectationFailed

Update point of interest (without location change)

Updates a point of interest, while retaining its current address and the coordinates of the polygon that defines its location.

Request body

object

FieldTypeRequired
Idstringrequired
Namestringrequired
Code(default = null)stringoptional
PoiTypeIdstringrequired
IsAssetLocation(default = false)booleanoptional
Priority(default = -)stringrequired
Description(default = null)stringoptional

Responses

200OK
FieldType
Data(default = null)object
{
  "Data": {
    "Id": "00000000-0000-0000-0000-000000000000",
    "Code": "012345",
    "Name": "Work",
    "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,
    "IsAssetLocation": false,
    "Type": {
      "Id": "00000000-0000-0000-0000-000000000000",
      "Name": "Work place",
      "Level": 0,
      "Color": "#00FF2F"
    },
    "Groups": [
      {
        "Id": "00000000-0000-0000-0000-000000000000",
        "Name": "Work places"
      }
    ]
  }
}
400BadRequest
401Unauthorized
403Forbidden
417ExpectationFailed

Activate point of interest

Re-activates a point of interest.

Request body

Responses

200OK
FieldType
Dataarray
{
  "Data": [
    {
      "Id": "00000000-0000-0000-0000-000000000000",
      "Code": "012345",
      "Name": "Work",
      "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,
      "IsAssetLocation": false,
      "Type": {
        "Id": "00000000-0000-0000-0000-000000000000",
        "Name": "Work place",
        "Level": 0,
        "Color": "#00FF2F"
      },
      "Groups": [
        {
          "Id": "00000000-0000-0000-0000-000000000000",
          "Name": "Work places"
        }
      ]
    }
  ]
}
400BadRequest
401Unauthorized
403Forbidden
417ExpectationFailed

Deactivate point of interest

Deactivates a point of interest.

Request body

Responses

200OK
FieldType
Dataarray
{
  "Data": [
    {
      "Id": "00000000-0000-0000-0000-000000000000",
      "Code": "012345",
      "Name": "Work",
      "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,
      "IsAssetLocation": false,
      "Type": {
        "Id": "00000000-0000-0000-0000-000000000000",
        "Name": "Work place",
        "Level": 0,
        "Color": "#00FF2F"
      },
      "Groups": [
        {
          "Id": "00000000-0000-0000-0000-000000000000",
          "Name": "Work places"
        }
      ]
    }
  ]
}
400BadRequest
401Unauthorized
403Forbidden
417ExpectationFailed

Get point of interest groups

Returns a list of all point of interest groups.

Privilege required: Api: Poi's read or Api: Poi's edit

Responses

200OK
[
  {
    "Id": "00000000-0000-0000-0000-000000000000",
    "Name": "Work places",
    "Pois": [
      {
        "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": [
          {}
        ]
      }
    ],
    "NumberOfPois": 1
  }
]
401Unauthorized
403Forbidden

Update point of interest group

Updates a point of interest group.

Request body

object

FieldTypeRequired
Namestringrequired
Idstringrequired

Responses

200OK
FieldType
Idstring
Namestring
Pois(default = [])array
NumberOfPois(default = 0)number
_typeDescriptorstring
{
  "Id": "00000000-0000-0000-0000-000000000000",
  "Name": "Work places",
  "Pois": [
    {
      "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": [
        {}
      ]
    }
  ],
  "NumberOfPois": 1
}
400BadRequest
FieldType
Entityobject
ValidationResultarray
{
  "Entity": {
    "Id": "00000000-0000-0000-0000-000000000000",
    "Name": "Work places",
    "Pois": [
      {
        "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": [
          {}
        ]
      }
    ],
    "NumberOfPois": 1
  },
  "ValidationResult": [
    {
      "Message": "",
      "SourceMemberNames": []
    }
  ]
}
401Unauthorized
403Forbidden
417ExpectationFailed

Create point of interest group

Creates a new point of interest group.

Request body

object

FieldTypeRequired
Namestringrequired

Responses

200OK
FieldType
Idstring
Namestring
Pois(default = [])array
NumberOfPois(default = 0)number
_typeDescriptorstring
{
  "Id": "00000000-0000-0000-0000-000000000000",
  "Name": "Work places",
  "Pois": [
    {
      "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": [
        {}
      ]
    }
  ],
  "NumberOfPois": 1
}
400BadRequest
FieldType
Entityobject
ValidationResultarray
{
  "Entity": {
    "Id": "00000000-0000-0000-0000-000000000000",
    "Name": "Work places",
    "Pois": [
      {
        "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": [
          {}
        ]
      }
    ],
    "NumberOfPois": 1
  },
  "ValidationResult": [
    {
      "Message": "",
      "SourceMemberNames": []
    }
  ]
}
401Unauthorized
403Forbidden
417ExpectationFailed

Delete point of interest group

Deletes a point of interest group.

Request body

Responses

200OK
400BadRequest
FieldType
Entityobject
ValidationResultarray
{
  "Entity": {
    "Id": "00000000-0000-0000-0000-000000000000",
    "Name": "Work places",
    "Pois": [
      {
        "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": [
          {}
        ]
      }
    ],
    "NumberOfPois": 1
  },
  "ValidationResult": [
    {
      "Message": "",
      "SourceMemberNames": []
    }
  ]
}
401Unauthorized
403Forbidden
417ExpectationFailed

Get point of interest group

Returns a point of interest group by id.

Privilege required: Api: Poi's read or Api: Poi's edit

Path parameters

NameTypeRequiredExample
idstringrequired00000000-0000-0000-0000-000000000000

Responses

200OK
FieldType
Idstring
Namestring
Pois(default = [])array
NumberOfPois(default = 0)number
_typeDescriptorstring
{
  "Id": "00000000-0000-0000-0000-000000000000",
  "Name": "Work places",
  "Pois": [
    {
      "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": [
        {}
      ]
    }
  ],
  "NumberOfPois": 1
}
401Unauthorized
403Forbidden

Get pois of poi group

Returns a list of all point of interests of a point of interest group.

Privilege required: Api: Poi's read or Api: Poi's edit

Path parameters

NameTypeRequiredExample
idstringrequired00000000-0000-0000-0000-000000000000

Responses

200OK
[
  {
    "Id": "00000000-0000-0000-0000-000000000000",
    "Name": "Work"
  }
]
401Unauthorized
403Forbidden

Add pois to poi group

Adds a list of point of interests to a point of interest group.

In order to add all point of interests to a point of interest group, set AddAll to true. A search string can be used to filter the point of interests.

In order to add the listed point of interests to a point of interest group, set AddAll to false.

Path parameters

NameTypeRequiredExample
idstringrequired00000000-0000-0000-0000-000000000000

Request body

Responses

200OK
400BadRequest
FieldType
Entityobject
ValidationResultarray
{
  "Entity": {
    "Id": "00000000-0000-0000-0000-000000000000",
    "Name": "Work places",
    "Pois": [
      {
        "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": [
          {}
        ]
      }
    ],
    "NumberOfPois": 1
  },
  "ValidationResult": [
    {
      "Message": "",
      "SourceMemberNames": []
    }
  ]
}
401Unauthorized
403Forbidden
417ExpectationFailed

Remove pois from poi group

Removes a list of point of interests from a point of interest group.

In order to remove all point of interests from a point of interest group, set DeleteAll to true. A search string can be used to filter the point of interests.

In order to remove the listed point of interests from a point of interest group, set DeleteAll to false.

Path parameters

NameTypeRequiredExample
idstringrequired00000000-0000-0000-0000-000000000000

Request body

Responses

200OK
400BadRequest
FieldType
Entityobject
ValidationResultarray
{
  "Entity": {
    "Id": "00000000-0000-0000-0000-000000000000",
    "Name": "Work places",
    "Pois": [
      {
        "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": [
          {}
        ]
      }
    ],
    "NumberOfPois": 1
  },
  "ValidationResult": [
    {
      "Message": "",
      "SourceMemberNames": []
    }
  ]
}
401Unauthorized
403Forbidden
417ExpectationFailed

Get point of interest types

Returns a list of all point of interest types.

Privilege required: Api: Poi's read or Api: Poi's edit

Responses

200OK
[
  {
    "Id": "00000000-0000-0000-0000-000000000000",
    "Name": "Work place",
    "Color": "#00FF2F"
  }
]
401Unauthorized
403Forbidden

Update point of interest type

Updates a point of interest type.

Request body

object

FieldTypeRequired
Namestringrequired
Color(default = null) Color to be used for POIs of this type in GeoDynamics.stringoptional
Idstringrequired

Responses

200OK
FieldType
Idstring
Namestring
Color(default = null) Color to be used for POIs of this type in GeoDynamics.string
_typeDescriptorstring
{
  "Id": "00000000-0000-0000-0000-000000000000",
  "Name": "Work place",
  "Color": "#00FF2F"
}
400BadRequest
FieldType
Entityobject
ValidationResultarray
{
  "Entity": {
    "Id": "00000000-0000-0000-0000-000000000000",
    "Name": "Work place",
    "Color": "#00FF2F"
  },
  "ValidationResult": [
    {
      "Message": "",
      "SourceMemberNames": []
    }
  ]
}
401Unauthorized
403Forbidden
417ExpectationFailed

Create point of interest type

Creates a new point of interest type.

Request body

object

FieldTypeRequired
Namestringrequired
Color(default = null) Color to be used for POIs of this type in GeoDynamics.stringoptional

Responses

200OK
FieldType
Idstring
Namestring
Color(default = null) Color to be used for POIs of this type in GeoDynamics.string
_typeDescriptorstring
{
  "Id": "00000000-0000-0000-0000-000000000000",
  "Name": "Work place",
  "Color": "#00FF2F"
}
400BadRequest
FieldType
Entityobject
ValidationResultarray
{
  "Entity": {
    "Id": "00000000-0000-0000-0000-000000000000",
    "Name": "Work place",
    "Color": "#00FF2F"
  },
  "ValidationResult": [
    {
      "Message": "",
      "SourceMemberNames": []
    }
  ]
}
401Unauthorized
403Forbidden
417ExpectationFailed

Delete point of interest type

Deletes a point of interest type.

Request body

Responses

200OK
400BadRequest
FieldType
Entityobject
ValidationResultarray
{
  "Entity": {
    "Id": "00000000-0000-0000-0000-000000000000",
    "Name": "Work place",
    "Color": "#00FF2F"
  },
  "ValidationResult": [
    {
      "Message": "",
      "SourceMemberNames": []
    }
  ]
}
401Unauthorized
403Forbidden
417ExpectationFailed

Get point of interest type

Returns a point of interest type by id.

Privilege required: Api: Poi's read or Api: Poi's edit

Path parameters

NameTypeRequiredExample
idstringrequired00000000-0000-0000-0000-000000000000

Responses

200OK
FieldType
Idstring
Namestring
Color(default = null) Color to be used for POIs of this type in GeoDynamics.string
_typeDescriptorstring
{
  "Id": "00000000-0000-0000-0000-000000000000",
  "Name": "Work place",
  "Color": "#00FF2F"
}
401Unauthorized
403Forbidden

Get RFID tag

Returns an RFID tag by id.

Path parameters

NameTypeRequiredExample
idstringrequired00000000-0000-0000-0000-000000000000

Responses

200OK
FieldType
Dataobject
{
  "Data": {
    "Id": "00000000-0000-0000-0000-000000000000",
    "InternalNumber": "00AA11BB",
    "ExternalNumber": "12345678",
    "Type": 0,
    "BeaconRateSeconds": "15.0",
    "SiteCode": "1234",
    "PassiveTagNumber": "123456789",
    "MacAddress": "AABBCCDDEEFF",
    "User": {
      "Id": "00000000-0000-0000-0000-000000000000",
      "Code": "012345",
      "Name": "John Doe",
      "Type": 0
    }
  }
}
401Unauthorized
403Forbidden

Delete RFID tag

Deletes an RFID tag.

Path parameters

NameTypeRequiredExample
idstringrequired00000000-0000-0000-0000-000000000000

Responses

200OK
FieldType
Dataobject
{
  "Data": {
    "Id": "00000000-0000-0000-0000-000000000000",
    "InternalNumber": "00AA11BB",
    "ExternalNumber": "12345678",
    "Type": 0,
    "BeaconRateSeconds": "15.0",
    "SiteCode": "1234",
    "PassiveTagNumber": "123456789",
    "MacAddress": "AABBCCDDEEFF",
    "User": {
      "Id": "00000000-0000-0000-0000-000000000000",
      "Code": "012345",
      "Name": "John Doe",
      "Type": 0
    }
  }
}
400BadRequest
FieldType
Entityobject
ValidationResultarray
{
  "Entity": {
    "Id": "00000000-0000-0000-0000-000000000000",
    "InternalNumber": "00AA11BB",
    "ExternalNumber": "12345678",
    "Type": 0,
    "BeaconRateSeconds": "15.0",
    "SiteCode": "1234",
    "PassiveTagNumber": "123456789",
    "MacAddress": "AABBCCDDEEFF"
  },
  "ValidationResult": [
    {
      "Message": "",
      "SourceMemberNames": []
    }
  ]
}
401Unauthorized
403Forbidden
417ExpectationFailed

Update RFID tag

Updates an RFID tag.

Request body

object

FieldTypeRequired
Idstringrequired
InternalNumberstringrequired
ExternalNumber(default = null)stringoptional
Typenumberrequired
BeaconRateSeconds(default = null)stringoptional
SiteCode(default = null) This field is required for types 'Active Tag Ingecom', 'Active RFID Tag Wavetrend', 'Active/Passive Wavetrend', 'BLE', 'BLE IET10' and 'BLE ELA'.stringoptional
PassiveTagNumber(default = null) This field is required for type 'Active/Passive Wavetrend'.stringoptional
MacAddress(default = null) This field is required for type 'BLE IET10' and 'BLE ELA'.stringoptional

Responses

200OK
FieldType
Dataobject
{
  "Data": {
    "Id": "00000000-0000-0000-0000-000000000000",
    "InternalNumber": "00AA11BB",
    "ExternalNumber": "12345678",
    "Type": 0,
    "BeaconRateSeconds": "15.0",
    "SiteCode": "1234",
    "PassiveTagNumber": "123456789",
    "MacAddress": "AABBCCDDEEFF",
    "User": {
      "Id": "00000000-0000-0000-0000-000000000000",
      "Code": "012345",
      "Name": "John Doe",
      "Type": 0
    }
  }
}
400BadRequest
FieldType
Entityobject
ValidationResultarray
{
  "Entity": {
    "Id": "00000000-0000-0000-0000-000000000000",
    "InternalNumber": "00AA11BB",
    "ExternalNumber": "12345678",
    "Type": 0,
    "BeaconRateSeconds": "15.0",
    "SiteCode": "1234",
    "PassiveTagNumber": "123456789",
    "MacAddress": "AABBCCDDEEFF"
  },
  "ValidationResult": [
    {
      "Message": "",
      "SourceMemberNames": []
    }
  ]
}
401Unauthorized
403Forbidden
417ExpectationFailed

Create RFID tag

Creates a new RFID tag.

Request body

object

FieldTypeRequired
Idstringoptional
InternalNumberstringrequired
ExternalNumber(default = null)stringoptional
Typenumberrequired
BeaconRateSeconds(default = null)stringoptional
SiteCode(default = null) This field is required for types 'Active Tag Ingecom', 'Active RFID Tag Wavetrend', 'Active/Passive Wavetrend', 'BLE', 'BLE IET10' and 'BLE ELA'.stringoptional
PassiveTagNumber(default = null) This field is required for type 'Active/Passive Wavetrend'.stringoptional
MacAddress(default = null) This field is required for type 'BLE IET10' and 'BLE ELA'.stringoptional

Responses

200OK
FieldType
Dataobject
{
  "Data": {
    "Id": "00000000-0000-0000-0000-000000000000",
    "InternalNumber": "00AA11BB",
    "ExternalNumber": "12345678",
    "Type": 0,
    "BeaconRateSeconds": "15.0",
    "SiteCode": "1234",
    "PassiveTagNumber": "123456789",
    "MacAddress": "AABBCCDDEEFF",
    "User": {
      "Id": "00000000-0000-0000-0000-000000000000",
      "Code": "012345",
      "Name": "John Doe",
      "Type": 0
    }
  }
}
400BadRequest
FieldType
Entityobject
ValidationResultarray
{
  "Entity": {
    "Id": "00000000-0000-0000-0000-000000000000",
    "InternalNumber": "00AA11BB",
    "ExternalNumber": "12345678",
    "Type": 0,
    "BeaconRateSeconds": "15.0",
    "SiteCode": "1234",
    "PassiveTagNumber": "123456789",
    "MacAddress": "AABBCCDDEEFF"
  },
  "ValidationResult": [
    {
      "Message": "",
      "SourceMemberNames": []
    }
  ]
}
401Unauthorized
403Forbidden
417ExpectationFailed

Get RFID tags by user

Returns a list of all RFID tags linked to a user.

Path parameters

NameTypeRequiredExample
userIdstringrequired00000000-0000-0000-0000-000000000000

Responses

200OK
FieldType
Dataarray
{
  "Data": [
    {
      "Id": "00000000-0000-0000-0000-000000000000",
      "InternalNumber": "00AA11BB",
      "ExternalNumber": "12345678",
      "Type": 0,
      "BeaconRateSeconds": "15.0",
      "SiteCode": "1234",
      "PassiveTagNumber": "123456789",
      "MacAddress": "AABBCCDDEEFF",
      "User": {
        "Id": "00000000-0000-0000-0000-000000000000",
        "Code": "012345",
        "Name": "John Doe",
        "Type": 0
      }
    }
  ]
}
401Unauthorized
403Forbidden

Link RFID tag to user

Links an RFID tag to a user by id or internal number.

When OverrideExistingUser is false, you can only link RFID tags that exist and are not yet linked to any other users. If the tag is already linked to another user, no action will be taken.

When OverrideExistingUser is true, RFID tags need to exist but can already be linked to another user. In that case we will remove the tag from the previous user and link it to the new one instead.

Path parameters

NameTypeRequiredExample
userIdstringrequired00000000-0000-0000-0000-000000000000

Request body

object

FieldTypeRequired
BadgeIdstringoptional
InternalNumberstringoptional
OverrideExistingUserbooleanrequired

Responses

200OK
FieldType
Dataobject
{
  "Data": {
    "Id": "00000000-0000-0000-0000-000000000000",
    "InternalNumber": "00AA11BB",
    "ExternalNumber": "12345678",
    "Type": 0,
    "BeaconRateSeconds": "15.0",
    "SiteCode": "1234",
    "PassiveTagNumber": "123456789",
    "MacAddress": "AABBCCDDEEFF",
    "User": {
      "Id": "00000000-0000-0000-0000-000000000000",
      "Code": "012345",
      "Name": "John Doe",
      "Type": 0
    }
  }
}
400BadRequest
FieldType
Entityobject
ValidationResultarray
{
  "Entity": {
    "Id": "00000000-0000-0000-0000-000000000000",
    "InternalNumber": "00AA11BB",
    "ExternalNumber": "12345678",
    "Type": 0,
    "BeaconRateSeconds": "15.0",
    "SiteCode": "1234",
    "PassiveTagNumber": "123456789",
    "MacAddress": "AABBCCDDEEFF"
  },
  "ValidationResult": [
    {
      "Message": "",
      "SourceMemberNames": []
    }
  ]
}
401Unauthorized
403Forbidden
417ExpectationFailed

Unlink RFID tag from user

Unlinks an RFID tag from a user by id or internal number.

Path parameters

NameTypeRequiredExample
userIdstringrequired00000000-0000-0000-0000-000000000000

Request body

object

FieldTypeRequired
BadgeIdstringoptional
InternalNumberstringoptional

Responses

200OK
FieldType
Dataobject
{
  "Data": {
    "Id": "00000000-0000-0000-0000-000000000000",
    "InternalNumber": "00AA11BB",
    "ExternalNumber": "12345678",
    "Type": 0,
    "BeaconRateSeconds": "15.0",
    "SiteCode": "1234",
    "PassiveTagNumber": "123456789",
    "MacAddress": "AABBCCDDEEFF",
    "User": {
      "Id": "00000000-0000-0000-0000-000000000000",
      "Code": "012345",
      "Name": "John Doe",
      "Type": 0
    }
  }
}
400BadRequest
FieldType
Entityobject
ValidationResultarray
{
  "Entity": {
    "Id": "00000000-0000-0000-0000-000000000000",
    "InternalNumber": "00AA11BB",
    "ExternalNumber": "12345678",
    "Type": 0,
    "BeaconRateSeconds": "15.0",
    "SiteCode": "1234",
    "PassiveTagNumber": "123456789",
    "MacAddress": "AABBCCDDEEFF"
  },
  "ValidationResult": [
    {
      "Message": "",
      "SourceMemberNames": []
    }
  ]
}
401Unauthorized
403Forbidden
417ExpectationFailed

Get mobile RFID scanner by Id

Gets a mobile RFID scanners by Id.

Path parameters

NameTypeRequiredExample
idstringrequired00000000-0000-0000-0000-000000000000

Responses

200OK
FieldType
Idstring
UnitIdstring
Userobject
CostCenterobject
{
  "Id": "00000000-0000-0000-0000-000000000000",
  "UnitId": "0000000000",
  "User": {
    "Id": "00000000-0000-0000-0000-000000000000",
    "Name": "John Doe",
    "Code": "012345"
  },
  "CostCenter": {
    "Id": "00000000-0000-0000-0000-000000000000",
    "Name": "Workplace 1",
    "Code": "012345"
  }
}
401Unauthorized
403Forbidden

Update mobile RFID scanner

Updates a mobile RFID scanner.

Request body

object

FieldTypeRequired
Idstringrequired
CurrentUserIdstringoptional
CostCenterIdstringoptional

Responses

200OK
[
  {
    "Id": "00000000-0000-0000-0000-000000000000",
    "UnitId": "0000000000",
    "User": {
      "Id": "00000000-0000-0000-0000-000000000000",
      "Name": "John Doe",
      "Code": "012345"
    },
    "CostCenter": {
      "Id": "00000000-0000-0000-0000-000000000000",
      "Name": "Workplace 1",
      "Code": "012345"
    }
  }
]
400BadRequest
FieldType
Entityobject
ValidationResultarray
{
  "Entity": {
    "Id": "00000000-0000-0000-0000-000000000000",
    "Name_Nl": null,
    "Name_Fr": null,
    "Name_En": null,
    "Name_Pl": null,
    "Type": 0,
    "FilterText": null,
    "Prefix": null,
    "JobNumber": "1575-7577-4",
    "Regex": null,
    "InputFilter": 0,
    "InputType": 0,
    "ClockingType": 0,
    "Children": [
      {
        "Id": "00000000-0000-0000-0000-000000000000",
        "Name_Nl": null,
        "Name_Fr": null,
        "Name_En": null,
        "Name_Pl": null,
        "Type": 0,
        "FilterText": null,
        "Prefix": null,
        "JobNumber": "1575-7577-4",
        "Regex": null,
        "InputFilter": 0,
        "InputType": 0,
        "ClockingType": 0,
        "Children": [
          {}
        ],
        "PoiGroupId": "00000000-0000-0000-0000-000000000000",
        "CostCenterGroupId": "00000000-0000-0000-0000-000000000000",
        "ExternalCode": null,
        "ExternalType": 0
      }
    ],
    "PoiGroupId": "00000000-0000-0000-0000-000000000000",
    "CostCenterGroupId": "00000000-0000-0000-0000-000000000000",
    "ExternalCode": null,
    "ExternalType": 0
  },
  "ValidationResult": [
    {
      "Message": "",
      "SourceMemberNames": []
    }
  ]
}
401Unauthorized
403Forbidden
417ExpectationFailed

Get smartphone

Returns a smartphone clocking device by id.

Path parameters

NameTypeRequiredExample
idstringrequired00000000-0000-0000-0000-000000000000

Responses

200OK
FieldType
Idstring
Namestring
UIdstring
Active(default = true)boolean
Type(default = 0)number
Orientation(default = 0)number
FilterMenusByUserFilter(default = false)boolean
UserIdentification(default = 0)number
UserIdentificationConfig(default = null)object
ResourceDetection(default = 0)number
ResourceDetectionConfig(default = null)object
Positioning(default = 0)number
PositioningConfig(default = null)object
Team(default = 0)number
TeamConfig(default = null)object
TimeRegistration(default = 0)number
TimeRegistrationConfig(default = null)object
CostCenterobject
{
  "Id": "00000000-0000-0000-0000-000000000000",
  "Name": "Samsung S8",
  "UId": "000000000",
  "Active": true,
  "Type": 0,
  "Orientation": 0,
  "FilterMenusByUserFilter": false,
  "UserIdentification": 0,
  "UserIdentificationConfig": {
    "ByBadge": false,
    "ByUserCode": false,
    "ByCiawCode": false,
    "FixedUser": {
      "Id": "00000000-0000-0000-0000-000000000000",
      "Code": "012345",
      "Name": "John Doe",
      "Type": 0
    },
    "CiawWorkplace": {
      "Id": "00000000-0000-0000-0000-000000000000",
      "DUC": "",
      "Code": "012345",
      "Name": "GeoDynamics"
    }
  },
  "ResourceDetection": 0,
  "ResourceDetectionConfig": {
    "FixedVehicle": {
      "Id": "00000000-0000-0000-0000-000000000000",
      "Code": "012345",
      "Name": "John Doe",
      "Type": 0
    },
    "Vehicles": [
      {
        "Id": "00000000-0000-0000-0000-000000000000",
        "Code": "012345",
        "Name": "John Doe",
        "Type": 0
      }
    ]
  },
  "Positioning": 0,
  "PositioningConfig": {
    "FixedPoi": {
      "Id": "00000000-0000-0000-0000-000000000000",
      "Name": "Home",
      "Code": "012345"
    }
  },
  "Team": 0,
  "TeamConfig": {
    "GroupUsersByVehicle": false
  },
  "TimeRegistration": 0,
  "TimeRegistrationConfig": {
    "Menu": {
      "Id": "00000000-0000-0000-0000-000000000000",
      "Name": ""
    }
  },
  "CostCenter": {
    "Id": "00000000-0000-0000-0000-000000000000",
    "Code": "012345",
    "Name": "John Doe",
    "Type": 0
  }
}
401Unauthorized
403Forbidden

Delete smartphone

Deletes a smartphone clocking device.

Path parameters

NameTypeRequiredExample
idstringrequired00000000-0000-0000-0000-000000000000

Responses

200OK
FieldType
Idstring
Namestring
UIdstring
Active(default = true)boolean
Type(default = 0)number
Orientation(default = 0)number
FilterMenusByUserFilter(default = false)boolean
UserIdentification(default = 0)number
UserIdentificationConfig(default = null)object
ResourceDetection(default = 0)number
ResourceDetectionConfig(default = null)object
Positioning(default = 0)number
PositioningConfig(default = null)object
Team(default = 0)number
TeamConfig(default = null)object
TimeRegistration(default = 0)number
TimeRegistrationConfig(default = null)object
CostCenterobject
{
  "Id": "00000000-0000-0000-0000-000000000000",
  "Name": "Samsung S8",
  "UId": "000000000",
  "Active": true,
  "Type": 0,
  "Orientation": 0,
  "FilterMenusByUserFilter": false,
  "UserIdentification": 0,
  "UserIdentificationConfig": {
    "ByBadge": false,
    "ByUserCode": false,
    "ByCiawCode": false,
    "FixedUser": {
      "Id": "00000000-0000-0000-0000-000000000000",
      "Code": "012345",
      "Name": "John Doe",
      "Type": 0
    },
    "CiawWorkplace": {
      "Id": "00000000-0000-0000-0000-000000000000",
      "DUC": "",
      "Code": "012345",
      "Name": "GeoDynamics"
    }
  },
  "ResourceDetection": 0,
  "ResourceDetectionConfig": {
    "FixedVehicle": {
      "Id": "00000000-0000-0000-0000-000000000000",
      "Code": "012345",
      "Name": "John Doe",
      "Type": 0
    },
    "Vehicles": [
      {
        "Id": "00000000-0000-0000-0000-000000000000",
        "Code": "012345",
        "Name": "John Doe",
        "Type": 0
      }
    ]
  },
  "Positioning": 0,
  "PositioningConfig": {
    "FixedPoi": {
      "Id": "00000000-0000-0000-0000-000000000000",
      "Name": "Home",
      "Code": "012345"
    }
  },
  "Team": 0,
  "TeamConfig": {
    "GroupUsersByVehicle": false
  },
  "TimeRegistration": 0,
  "TimeRegistrationConfig": {
    "Menu": {
      "Id": "00000000-0000-0000-0000-000000000000",
      "Name": ""
    }
  },
  "CostCenter": {
    "Id": "00000000-0000-0000-0000-000000000000",
    "Code": "012345",
    "Name": "John Doe",
    "Type": 0
  }
}
400BadRequest
FieldType
Entityobject
ValidationResultarray
{
  "Entity": {
    "Id": "00000000-0000-0000-0000-000000000000",
    "Name": "Samsung S8",
    "UId": "000000000",
    "Active": true,
    "Type": 0,
    "Orientation": 0,
    "FilterMenusByUserFilter": false,
    "UserIdentification": 0,
    "UserIdentificationConfig": {
      "ByBadge": false,
      "ByUserCode": false,
      "ByCiawCode": false,
      "FixedUserId": "00000000-0000-0000-0000-000000000000",
      "CiawWorkplaceId": "00000000-0000-0000-0000-000000000000"
    },
    "ResourceDetection": 0,
    "ResourceDetectionConfig": {
      "FixedVehicleId": "00000000-0000-0000-0000-000000000000",
      "VehicleIds": [
        "00000000-0000-0000-0000-000000000000",
        "00000000-0000-0000-0000-000000000000"
      ]
    },
    "Positioning": 0,
    "PositioningConfig": {
      "FixedPoiId": "00000000-0000-0000-0000-000000000000"
    },
    "Team": 0,
    "TeamConfig": {
      "GroupUsersByVehicle": false
    },
    "TimeRegistration": 0,
    "TimeRegistrationConfig": {
      "MenuId": "00000000-0000-0000-0000-000000000000"
    },
    "CostCenterId": "00000000-0000-0000-0000-000000000000"
  },
  "ValidationResult": [
    {
      "Message": "",
      "SourceMemberNames": []
    }
  ]
}
401Unauthorized
403Forbidden
417ExpectationFailed

Update smartphone

Updates a smartphone clocking device.

Settings that are not provided will be set to the default settings, which can be configured in GeoDynamics (Config > Devices > Smartphone clocking devices > Smartphone clocking default settings).

Request body

object

FieldTypeRequired
Idstringrequired
Namestringrequired
UIdstringrequired
Active(default = true)booleanoptional
Type(default = 0)numberoptional
Orientation(default = 0)numberoptional
FilterMenusByUserFilter(default = false)booleanoptional
UserIdentification(default = 0)numberoptional
UserIdentificationConfig(default = null)objectoptional
ResourceDetection(default = 0)numberoptional
ResourceDetectionConfig(default = null)objectoptional
Positioning(default = 0)numberoptional
PositioningConfig(default = null)objectoptional
Team(default = 0)numberoptional
TeamConfig(default = null)objectoptional
TimeRegistration(default = 0)numberoptional
TimeRegistrationConfig(default = null)objectoptional
CostCenterIdstringoptional

Responses

200OK
FieldType
Idstring
Namestring
UIdstring
Active(default = true)boolean
Type(default = 0)number
Orientation(default = 0)number
FilterMenusByUserFilter(default = false)boolean
UserIdentification(default = 0)number
UserIdentificationConfig(default = null)object
ResourceDetection(default = 0)number
ResourceDetectionConfig(default = null)object
Positioning(default = 0)number
PositioningConfig(default = null)object
Team(default = 0)number
TeamConfig(default = null)object
TimeRegistration(default = 0)number
TimeRegistrationConfig(default = null)object
CostCenterobject
{
  "Id": "00000000-0000-0000-0000-000000000000",
  "Name": "Samsung S8",
  "UId": "000000000",
  "Active": true,
  "Type": 0,
  "Orientation": 0,
  "FilterMenusByUserFilter": false,
  "UserIdentification": 0,
  "UserIdentificationConfig": {
    "ByBadge": false,
    "ByUserCode": false,
    "ByCiawCode": false,
    "FixedUser": {
      "Id": "00000000-0000-0000-0000-000000000000",
      "Code": "012345",
      "Name": "John Doe",
      "Type": 0
    },
    "CiawWorkplace": {
      "Id": "00000000-0000-0000-0000-000000000000",
      "DUC": "",
      "Code": "012345",
      "Name": "GeoDynamics"
    }
  },
  "ResourceDetection": 0,
  "ResourceDetectionConfig": {
    "FixedVehicle": {
      "Id": "00000000-0000-0000-0000-000000000000",
      "Code": "012345",
      "Name": "John Doe",
      "Type": 0
    },
    "Vehicles": [
      {
        "Id": "00000000-0000-0000-0000-000000000000",
        "Code": "012345",
        "Name": "John Doe",
        "Type": 0
      }
    ]
  },
  "Positioning": 0,
  "PositioningConfig": {
    "FixedPoi": {
      "Id": "00000000-0000-0000-0000-000000000000",
      "Name": "Home",
      "Code": "012345"
    }
  },
  "Team": 0,
  "TeamConfig": {
    "GroupUsersByVehicle": false
  },
  "TimeRegistration": 0,
  "TimeRegistrationConfig": {
    "Menu": {
      "Id": "00000000-0000-0000-0000-000000000000",
      "Name": ""
    }
  },
  "CostCenter": {
    "Id": "00000000-0000-0000-0000-000000000000",
    "Code": "012345",
    "Name": "John Doe",
    "Type": 0
  }
}
400BadRequest
FieldType
Entityobject
ValidationResultarray
{
  "Entity": {
    "Id": "00000000-0000-0000-0000-000000000000",
    "Name": "Samsung S8",
    "UId": "000000000",
    "Active": true,
    "Type": 0,
    "Orientation": 0,
    "FilterMenusByUserFilter": false,
    "UserIdentification": 0,
    "UserIdentificationConfig": {
      "ByBadge": false,
      "ByUserCode": false,
      "ByCiawCode": false,
      "FixedUserId": "00000000-0000-0000-0000-000000000000",
      "CiawWorkplaceId": "00000000-0000-0000-0000-000000000000"
    },
    "ResourceDetection": 0,
    "ResourceDetectionConfig": {
      "FixedVehicleId": "00000000-0000-0000-0000-000000000000",
      "VehicleIds": [
        "00000000-0000-0000-0000-000000000000",
        "00000000-0000-0000-0000-000000000000"
      ]
    },
    "Positioning": 0,
    "PositioningConfig": {
      "FixedPoiId": "00000000-0000-0000-0000-000000000000"
    },
    "Team": 0,
    "TeamConfig": {
      "GroupUsersByVehicle": false
    },
    "TimeRegistration": 0,
    "TimeRegistrationConfig": {
      "MenuId": "00000000-0000-0000-0000-000000000000"
    },
    "CostCenterId": "00000000-0000-0000-0000-000000000000"
  },
  "ValidationResult": [
    {
      "Message": "",
      "SourceMemberNames": []
    }
  ]
}
401Unauthorized
403Forbidden
417ExpectationFailed

Create smartphone

Creates a new smartphone clocking device.

Settings that are not provided will be set to the default settings, which can be configured in GeoDynamics (Config > Devices > Smartphone clocking devices > Smartphone clocking default settings).

Request body

object

FieldTypeRequired
Idstringoptional
Namestringrequired
UIdstringrequired
Active(default = true)booleanoptional
Type(default = 0)numberoptional
Orientation(default = 0)numberoptional
FilterMenusByUserFilter(default = false)booleanoptional
UserIdentification(default = 0)numberoptional
UserIdentificationConfig(default = null)objectoptional
ResourceDetection(default = 0)numberoptional
ResourceDetectionConfig(default = null)objectoptional
Positioning(default = 0)numberoptional
PositioningConfig(default = null)objectoptional
Team(default = 0)numberoptional
TeamConfig(default = null)objectoptional
TimeRegistration(default = 0)numberoptional
TimeRegistrationConfig(default = null)objectoptional
CostCenterIdstringoptional

Responses

200OK
FieldType
Idstring
Namestring
UIdstring
Active(default = true)boolean
Type(default = 0)number
Orientation(default = 0)number
FilterMenusByUserFilter(default = false)boolean
UserIdentification(default = 0)number
UserIdentificationConfig(default = null)object
ResourceDetection(default = 0)number
ResourceDetectionConfig(default = null)object
Positioning(default = 0)number
PositioningConfig(default = null)object
Team(default = 0)number
TeamConfig(default = null)object
TimeRegistration(default = 0)number
TimeRegistrationConfig(default = null)object
CostCenterobject
{
  "Id": "00000000-0000-0000-0000-000000000000",
  "Name": "Samsung S8",
  "UId": "000000000",
  "Active": true,
  "Type": 0,
  "Orientation": 0,
  "FilterMenusByUserFilter": false,
  "UserIdentification": 0,
  "UserIdentificationConfig": {
    "ByBadge": false,
    "ByUserCode": false,
    "ByCiawCode": false,
    "FixedUser": {
      "Id": "00000000-0000-0000-0000-000000000000",
      "Code": "012345",
      "Name": "John Doe",
      "Type": 0
    },
    "CiawWorkplace": {
      "Id": "00000000-0000-0000-0000-000000000000",
      "DUC": "",
      "Code": "012345",
      "Name": "GeoDynamics"
    }
  },
  "ResourceDetection": 0,
  "ResourceDetectionConfig": {
    "FixedVehicle": {
      "Id": "00000000-0000-0000-0000-000000000000",
      "Code": "012345",
      "Name": "John Doe",
      "Type": 0
    },
    "Vehicles": [
      {
        "Id": "00000000-0000-0000-0000-000000000000",
        "Code": "012345",
        "Name": "John Doe",
        "Type": 0
      }
    ]
  },
  "Positioning": 0,
  "PositioningConfig": {
    "FixedPoi": {
      "Id": "00000000-0000-0000-0000-000000000000",
      "Name": "Home",
      "Code": "012345"
    }
  },
  "Team": 0,
  "TeamConfig": {
    "GroupUsersByVehicle": false
  },
  "TimeRegistration": 0,
  "TimeRegistrationConfig": {
    "Menu": {
      "Id": "00000000-0000-0000-0000-000000000000",
      "Name": ""
    }
  },
  "CostCenter": {
    "Id": "00000000-0000-0000-0000-000000000000",
    "Code": "012345",
    "Name": "John Doe",
    "Type": 0
  }
}
400BadRequest
FieldType
Entityobject
ValidationResultarray
{
  "Entity": {
    "Id": "00000000-0000-0000-0000-000000000000",
    "Name": "Samsung S8",
    "UId": "000000000",
    "Active": true,
    "Type": 0,
    "Orientation": 0,
    "FilterMenusByUserFilter": false,
    "UserIdentification": 0,
    "UserIdentificationConfig": {
      "ByBadge": false,
      "ByUserCode": false,
      "ByCiawCode": false,
      "FixedUserId": "00000000-0000-0000-0000-000000000000",
      "CiawWorkplaceId": "00000000-0000-0000-0000-000000000000"
    },
    "ResourceDetection": 0,
    "ResourceDetectionConfig": {
      "FixedVehicleId": "00000000-0000-0000-0000-000000000000",
      "VehicleIds": [
        "00000000-0000-0000-0000-000000000000",
        "00000000-0000-0000-0000-000000000000"
      ]
    },
    "Positioning": 0,
    "PositioningConfig": {
      "FixedPoiId": "00000000-0000-0000-0000-000000000000"
    },
    "Team": 0,
    "TeamConfig": {
      "GroupUsersByVehicle": false
    },
    "TimeRegistration": 0,
    "TimeRegistrationConfig": {
      "MenuId": "00000000-0000-0000-0000-000000000000"
    },
    "CostCenterId": "00000000-0000-0000-0000-000000000000"
  },
  "ValidationResult": [
    {
      "Message": "",
      "SourceMemberNames": []
    }
  ]
}
401Unauthorized
403Forbidden
417ExpectationFailed

Get user

Returns a user 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": "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": ""
    },
    "MobilityRule": 0,
    "OvertimeConfig": {
      "Id": "00000000-0000-0000-0000-000000000000",
      "Name": "",
      "FirstHourCode": "001",
      "ExtraHoursCode": "002",
      "SaturdayHoursCode": "SA01",
      "SaturdayOvertimeCode": "SA02",
      "SundayHoursCode": "SU01",
      "SundayOvertimeCode": "SU02",
      "HoursType": "01:00:00"
    },
    "Groups": [
      {
        "Id": "00000000-0000-0000-0000-000000000000",
        "Code": "012345",
        "Name": "",
        "Type": 0
      }
    ],
    "FilterIvrCode": "0123456789"
  }
}
401Unauthorized
403Forbidden

Update user

Updates a user.

Request body

object

FieldTypeRequired
Idstringrequired
Namestringrequired
Code(default = null)stringoptional
EmployerCode(default = null)stringoptional
Email(default = null)stringoptional
Gsm(default = null)stringoptional
FreeField1(default = null)stringoptional
FreeField2(default = null)stringoptional
FreeField3(default = null)stringoptional
FreeField4(default = null)stringoptional
FreeField5(default = null)stringoptional
FreeField6(default = null) stringoptional
Notes(default = null)stringoptional
Street(default = null)stringoptional
HouseNumber(default = null)stringoptional
City(default = null)stringoptional
PostalCode(default = null)stringoptional
Submunicipality(default = null)stringoptional
Country(default = 0)numberoptional
Longitude(default = null) Geographic coordinate that specifies the east–west position of a point on the Earth's surface.numberoptional
Latitude(default = null) Geographic coordinate that specifies the north–south position of a point on the Earth's surface.numberoptional
MobilityRule(default = 0)numberoptional
FilterIvrCode(default = null)stringoptional
DefaultDayProgramId(default = null)stringoptional
OvertimeConfigId(default = null)stringoptional

Responses

200OK
FieldType
Data(default = null)object
{
  "Data": {
    "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,
    "MobilityRule": 0,
    "FilterIvrCode": "0123456789",
    "DefaultDayProgram": {
      "Id": "00000000-0000-0000-0000-000000000000",
      "Name": ""
    },
    "OvertimeConfig": {
      "Id": "00000000-0000-0000-0000-000000000000",
      "Name": "",
      "FirstHourCode": "001",
      "ExtraHoursCode": "002",
      "SaturdayHoursCode": "SA01",
      "SaturdayOvertimeCode": "SA02",
      "SundayHoursCode": "SU01",
      "SundayOvertimeCode": "SU02",
      "HoursType": "01:00:00"
    },
    "Groups": [
      {
        "Id": "00000000-0000-0000-0000-000000000000",
        "Code": "012345",
        "Name": "",
        "Type": 0
      }
    ]
  }
}
400BadRequest
FieldType
Entityobject
ValidationResultarray
{
  "Entity": {
    "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,
    "MobilityRule": 0,
    "FilterIvrCode": "0123456789"
  },
  "ValidationResult": [
    {
      "Message": "",
      "SourceMemberNames": []
    }
  ]
}
401Unauthorized
403Forbidden
417ExpectationFailed

Create user

Creates a new user.

Request body

object

FieldTypeRequired
Idstringoptional
Namestringrequired
Code(default = null)stringoptional
EmployerCode(default = null)stringoptional
Email(default = null)stringoptional
Gsm(default = null)stringoptional
FreeField1(default = null)stringoptional
FreeField2(default = null)stringoptional
FreeField3(default = null)stringoptional
FreeField4(default = null)stringoptional
FreeField5(default = null)stringoptional
FreeField6(default = null) stringoptional
Notes(default = null)stringoptional
Street(default = null)stringoptional
HouseNumber(default = null)stringoptional
City(default = null)stringoptional
PostalCode(default = null)stringoptional
Submunicipality(default = null)stringoptional
Country(default = 0)numberoptional
Longitude(default = null) Geographic coordinate that specifies the east–west position of a point on the Earth's surface.numberoptional
Latitude(default = null) Geographic coordinate that specifies the north–south position of a point on the Earth's surface.numberoptional
MobilityRule(default = 0)numberoptional
FilterIvrCode(default = null)stringoptional
DefaultDayProgramId(default = null)stringoptional
OvertimeConfigId(default = null)stringoptional

Responses

200OK
FieldType
Data(default = null)object
{
  "Data": {
    "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,
    "MobilityRule": 0,
    "FilterIvrCode": "0123456789",
    "DefaultDayProgram": {
      "Id": "00000000-0000-0000-0000-000000000000",
      "Name": ""
    },
    "OvertimeConfig": {
      "Id": "00000000-0000-0000-0000-000000000000",
      "Name": "",
      "FirstHourCode": "001",
      "ExtraHoursCode": "002",
      "SaturdayHoursCode": "SA01",
      "SaturdayOvertimeCode": "SA02",
      "SundayHoursCode": "SU01",
      "SundayOvertimeCode": "SU02",
      "HoursType": "01:00:00"
    },
    "Groups": [
      {
        "Id": "00000000-0000-0000-0000-000000000000",
        "Code": "012345",
        "Name": "",
        "Type": 0
      }
    ]
  }
}
400BadRequest
FieldType
Entityobject
ValidationResultarray
{
  "Entity": {
    "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,
    "MobilityRule": 0,
    "FilterIvrCode": "0123456789"
  },
  "ValidationResult": [
    {
      "Message": "",
      "SourceMemberNames": []
    }
  ]
}
401Unauthorized
403Forbidden
417ExpectationFailed

Delete user

Deletes a user.

Request body

Responses

200OK
FieldType
Idstring
Namestring
Code(default = null)string
EmployerCode(default = null)string
Email(default = null)string
Gsm(default = null)string
FreeField1(default = null)string
FreeField2(default = null)string
FreeField3(default = null)string
FreeField4(default = null)string
FreeField5(default = null)string
FreeField6(default = null) string
Notes(default = null)string
Street(default = null)string
HouseNumber(default = null)string
City(default = null)string
PostalCode(default = null)string
Submunicipality(default = null)string
Country(default = 0)number
Longitude(default = null) Geographic coordinate that specifies the east–west position of a point on the Earth's surface.number
Latitude(default = null) Geographic coordinate that specifies the north–south position of a point on the Earth's surface.number
DefaultDayProgram(default = null)object
Groups(default = null)array
_typeDescriptorstring
{
  "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"
    }
  ]
}
400BadRequest
FieldType
Entityobject
ValidationResultarray
{
  "Entity": {
    "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"
      }
    ]
  },
  "ValidationResult": [
    {
      "Message": "",
      "SourceMemberNames": []
    }
  ]
}
401Unauthorized
403Forbidden
417ExpectationFailed

Add permitted resource groups to user

Adds a list of permitted resource groups to a user.

Path parameters

NameTypeRequiredExample
idstringrequired00000000-0000-0000-0000-000000000000

Request body

object

FieldTypeRequired
GroupIdsarrayrequired
Typestringrequired

Responses

200OK
400Bad Request
401Unauthorized
403Forbidden
417ExpectationFailed

Remove permitted resource groups from user

Removes a list of permitted resource groups from a user.

Path parameters

NameTypeRequiredExample
idstringrequired00000000-0000-0000-0000-000000000000

Request body

Responses

200OK
400Bad Request
401Unauthorized
403Forbidden
417ExpectationFailed

Get user day programs

Returns a list of all day programs of a user within a date range.

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

Path parameters

NameTypeRequiredExample
idstringrequired00000000-0000-0000-0000-000000000000
fromDatestringrequired2019-01-25
toDatestringrequired2019-01-27

Responses

200OK
[
  {
    "User": {
      "Id": "00000000-0000-0000-0000-000000000000",
      "Name": "John Doe"
    },
    "DayProgram": {
      "Id": "00000000-0000-0000-0000-000000000000",
      "Name": "Default"
    },
    "DateLocal": "2019-01-25",
    "IsDefault": false
  }
]
400Bad Request
401Unauthorized
403Forbidden
417ExpectationFailed

Update user day programs

Updates the day programs of a user within a date range.

Path parameters

NameTypeRequiredExample
idstringrequired00000000-0000-0000-0000-000000000000

Request body

object

FieldTypeRequired
DayProgramIdstringrequired
FromDatestringrequired
ToDatestringrequired

Responses

200OK
400Bad Request
401Unauthorized
403Forbidden
417ExpectationFailed

Get overtime configuration

Returns an overtime configuration by id.

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

Path parameters

NameTypeRequiredExample
idstringrequired00000000-0000-0000-0000-000000000000

Responses

200OK
FieldType
Data(default = null)object
{
  "Data": {
    "Id": "00000000-0000-0000-0000-000000000000",
    "Name": "",
    "FirstHourCode": "001",
    "ExtraHoursCode": "002",
    "SaturdayHoursCode": "SA01",
    "SaturdayOvertimeCode": "SA02",
    "SundayHoursCode": "SU01",
    "SundayOvertimeCode": "SU02",
    "HoursType": "01:00:00"
  }
}
401Unauthorized
403Forbidden