developer portal

Config

Resource groups

GEThttps://api.geodynamics.dev/intellitracer/v1/resourcegroupsApi: Resource read or Api: Resource management

Get resource groups

Returns a list of all resource groups.

Responses

200OK
FieldType
Idstring
Namestring
Type

0 User 1 Vehicle 2 Timeclock 3 Asset 4 Ivr phone number 5 Cost center 6 Work place 7 Mobile clocking

ResourceType
Code(default = null)string
_typeDescriptorstring
[
  {
    "Id": "00000000-0000-0000-0000-000000000000",
    "Name": "Employees",
    "Type": 0,
    "Code": "012345"
  }
]
401Unauthorized
403Forbidden
429Too Many Requests
GEThttps://api.geodynamics.dev/intellitracer/v1/resourcegroupApi: Resource read or Api: Resource management

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.

Query parameters

NameTypeRequiredExample
type

0 User 1 Vehicle 2 Timeclock 3 Asset 4 Ivr phone number 5 Cost center 6 Work place 7 Mobile clocking

numberrequired0

Responses

200OK
FieldType
Idstring
Namestring
Type

0 User 1 Vehicle 2 Timeclock 3 Asset 4 Ivr phone number 5 Cost center 6 Work place 7 Mobile clocking

ResourceType
Code(default = null)string
_typeDescriptorstring
[
  {
    "Id": "00000000-0000-0000-0000-000000000000",
    "Name": "Employees",
    "Type": 0,
    "Code": "012345"
  }
]
401Unauthorized
403Forbidden
429Too Many Requests

Update resource group

Updates a resource group.

Request body

object

FieldTypeRequired
Idstringrequired
Namestringrequired
Code(default = null)stringoptional
{
  "Id": "00000000-0000-0000-0000-000000000000",
  "Name": "Employees",
  "Code": "012345"
}

Responses

200OK
FieldType
Idstring
Namestring
Type(default = 0)

0 User 1 Vehicle 2 Timeclock 3 Asset 4 Ivr phone number 5 Cost center 6 Work place 7 Mobile clocking

number
Code(default = null)string
_typeDescriptorstring
{
  "Id": "00000000-0000-0000-0000-000000000000",
  "Name": "Employees",
  "Type": 0,
  "Code": "012345"
}
400BadRequest
FieldType
Entityobject
ValidationResultarray
Allowed values in nested fields
Entity.Type

0 User 1 Vehicle 2 Timeclock 3 Asset 4 Ivr phone number 5 Cost center 6 Work place 7 Mobile clocking

{
  "Entity": {
    "Id": "00000000-0000-0000-0000-000000000000",
    "Name": "Employees",
    "Type": 0,
    "Code": "012345"
  },
  "ValidationResult": [
    {
      "Message": "",
      "SourceMemberNames": []
    }
  ]
}
401Unauthorized
403Forbidden
417ExpectationFailed
429Too Many Requests

Create resource group

Creates a new resource group.

Request body

object

FieldTypeRequired
Namestringrequired
Type(default = 0)

0 User 1 Vehicle 2 Timeclock 3 Asset 4 Ivr phone number 5 Cost center 6 Work place 7 Mobile clocking

numberrequired
Code(default = null)stringoptional
{
  "Name": "Employees",
  "Type": 0,
  "Code": "012345"
}

Responses

200OK
FieldType
Idstring
Namestring
Type(default = 0)

0 User 1 Vehicle 2 Timeclock 3 Asset 4 Ivr phone number 5 Cost center 6 Work place 7 Mobile clocking

number
Code(default = null)string
_typeDescriptorstring
{
  "Id": "00000000-0000-0000-0000-000000000000",
  "Name": "Employees",
  "Type": 0,
  "Code": "012345"
}
400BadRequest
FieldType
Entityobject
ValidationResultarray
Allowed values in nested fields
Entity.Type

0 User 1 Vehicle 2 Timeclock 3 Asset 4 Ivr phone number 5 Cost center 6 Work place 7 Mobile clocking

{
  "Entity": {
    "Id": "00000000-0000-0000-0000-000000000000",
    "Name": "Employees",
    "Type": 0,
    "Code": "012345"
  },
  "ValidationResult": [
    {
      "Message": "",
      "SourceMemberNames": []
    }
  ]
}
401Unauthorized
403Forbidden
417ExpectationFailed
429Too Many Requests

Delete resource group

Deletes a resource group.

Request body

object

FieldTypeRequired
Idstringrequired
Type(default = 0)

0 User 1 Vehicle 2 Timeclock 3 Asset 4 Ivr phone number 5 Cost center 6 Work place 7 Mobile clocking

numberrequired
{
  "Id": "00000000-0000-0000-0000-000000000000",
  "Type": 0
}

Responses

200OK
FieldType
Idstring
Namestring
Type(default = 0)

0 User 1 Vehicle 2 Timeclock 3 Asset 4 Ivr phone number 5 Cost center 6 Work place 7 Mobile clocking

number
Code(default = null)string
_typeDescriptorstring
{
  "Id": "00000000-0000-0000-0000-000000000000",
  "Name": "Employees",
  "Type": 0,
  "Code": "012345"
}
400BadRequest
FieldType
Entityobject
ValidationResultarray
Allowed values in nested fields
Entity.Type

0 User 1 Vehicle 2 Timeclock 3 Asset 4 Ivr phone number 5 Cost center 6 Work place 7 Mobile clocking

{
  "Entity": {
    "Id": "00000000-0000-0000-0000-000000000000",
    "Name": "Employees",
    "Type": 0,
    "Code": "012345"
  },
  "ValidationResult": [
    {
      "Message": "",
      "SourceMemberNames": []
    }
  ]
}
401Unauthorized
403Forbidden
417ExpectationFailed
429Too Many Requests

Resource group - Resources

GEThttps://api.geodynamics.dev/intellitracer/v1/resourcegroup/{id}/resourcesApi: Resource read or Api: Resource management

Get resources of resource group

Returns a list of all resources of a resource group.

Path parameters

NameTypeRequiredExample
idstringrequired00000000-0000-0000-0000-000000000000

Responses

200OK
FieldType
Idstring
Namestring
Code(default = null)string
Type

0 User 1 Vehicle 2 Timeclock 3 Asset 4 Ivr phone number 5 Cost center 6 Work place 7 Mobile clocking

ResourceType
[
  {
    "Id": "00000000-0000-0000-0000-000000000000",
    "Name": "John Doe",
    "Code": "012345",
    "Type": 0
  }
]
401Unauthorized
403Forbidden
429Too Many Requests

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
type

0 User 1 Vehicle 2 Timeclock 3 Asset 4 Ivr phone number 5 Cost center 6 Work place 7 Mobile clocking

numberrequired0

Request body

object

FieldTypeRequired
Items(default = [])arrayoptional
AddAll(default = false)booleanoptional
SearchString(default = null)stringoptional
{
  "Items": [
    "00000000-0000-0000-0000-000000000000",
    "00000000-0000-0000-0000-000000000000"
  ],
  "AddAll": false,
  "SearchString": null
}

Responses

200OK
400BadRequest
FieldType
Entityobject
ValidationResultarray
Allowed values in nested fields
Entity.Type

0 User 1 Vehicle 2 Timeclock 3 Asset 4 Ivr phone number 5 Cost center 6 Work place 7 Mobile clocking

{
  "Entity": {
    "Id": "00000000-0000-0000-0000-000000000000",
    "Name": "Employees",
    "Type": 0,
    "Code": "012345"
  },
  "ValidationResult": [
    {
      "Message": "",
      "SourceMemberNames": []
    }
  ]
}
401Unauthorized
403Forbidden
417ExpectationFailed
429Too Many Requests

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

object

FieldTypeRequired
Items(default = [])arrayoptional
DeleteAll(default = false)booleanoptional
SearchString(default = null)stringoptional
{
  "Items": [
    "00000000-0000-0000-0000-000000000000",
    "00000000-0000-0000-0000-000000000000"
  ],
  "DeleteAll": false,
  "SearchString": null
}

Responses

200OK
400BadRequest
FieldType
Entityobject
ValidationResultarray
Allowed values in nested fields
Entity.Type

0 User 1 Vehicle 2 Timeclock 3 Asset 4 Ivr phone number 5 Cost center 6 Work place 7 Mobile clocking

{
  "Entity": {
    "Id": "00000000-0000-0000-0000-000000000000",
    "Name": "Employees",
    "Type": 0,
    "Code": "012345"
  },
  "ValidationResult": [
    {
      "Message": "",
      "SourceMemberNames": []
    }
  ]
}
401Unauthorized
403Forbidden
417ExpectationFailed
429Too Many Requests

Vehicles

GEThttps://api.geodynamics.dev/intellitracer/v1/vehicleApi: Resource read or Api: Resource management

Get vehicles

Returns a list of all vehicles.

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

0 Other 1 M1 Vehicles used for carriage of passengers, comprising not more than eight seats in addition to the driver's seat. 2 M2 Vehicles used for the carriage of passengers, comprising more than eight seats in addition to the driver's seat, and having a maximum mass not exceeding 5 tonnes. (Bus) 3 M3 Vehicles used for the carriage of passengers, comprising more than eight seats in addition to the driver's seat, and having a maximum mass exceeding 5 tonnes. (Bus) 4 N1 Vehicles used for the carriage of goods and having a maximum mass not exceeding 3.5 tonnes. (Pick-up Truck, Van) 5 N2 Vehicles used for the carriage of goods and having a maximum mass exceeding 3.5 tonnes but not exceeding 12 tonnes. (Commercial Truck) 6 N3 Vehicles used for the carriage of goods and having a maximum mass exceeding 12 tonnes. (Commercial Truck)

VehicleCategory
FuelType(default = 0)

0 Gasoline 1 Diesel 2 LPG 3 Electricity 4 Red Diesel 5 Ppo 6 Cng 7 Hybrid 8 Plug-in hybrid

VehicleFuelType
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.

0 Unknown 100 Euro1 200 Euro2 300 Euro3 400 Euro4 500 Euro5 600 Euro6

VehicleEuropeanEmissionStandard
MaximumSpeed(default = null)number
NominalConsumption(default = 0.0) Fuel consumption of this vehicle in liters per 100km.number
CostCenterCostCenter
Groups(default = null) ResourceGroup[]
_typeDescriptorstring
Allowed values in nested fields
CostCenter.Poi.Country
151 allowed values
  • 0 Belgium
  • 1 France
  • 2 Netherlands
  • 3 Luxembourg
  • 4 Italy
  • 5 Norway
  • 6 Denmark
  • 7 Sweden
  • 8 San Marino
  • 9 Andorra
  • 10 Germany
  • 11 United Kingdom
  • 12 Spain
  • 13 Portugal
  • 14 Switzerland
  • 15 Austria
  • 20 Hungary
  • 21 Czechia
  • 22 Greece
  • 23 Poland
  • 24 Slovakia
  • 25 Turkey
  • 26 Albania
  • 27 Bulgaria
  • 28 Bosnia Herzegovina
  • 29 Belarus
  • 30 Moldova
  • 31 Macedonia
  • 32 Montenegro
  • 33 Romania
  • 34 Serbia
  • 35 Ukraine
  • 36 Finland
  • 37 Ireland
  • 38 Malta
  • 39 Estonia
  • 40 Croatia
  • 41 Lithuania
  • 42 Latvia
  • 43 Slovenia
  • 44 Armenia
  • 45 Azerbaijan
  • 46 Cyprus
  • 47 Faroe Islands
  • 48 Georgia
  • 49 Gibraltar
  • 50 Iceland
  • 51 Monaco
  • 52 Russia
  • 53 Vatican
  • 54 Kosovo
  • 55 United Arab Emirates
  • 56 Afghanistan
  • 57 Argentina
  • 58 Australia
  • 59 Bangladesh
  • 60 Bahrain
  • 61 Brunei
  • 62 Bolivia
  • 63 Brazil
  • 64 Bhutan
  • 65 Botswana
  • 66 Belize
  • 67 Canada
  • 68 Congo
  • 69 Cote d'Ivoire
  • 70 Chile
  • 71 Cameroon
  • 72 China
  • 73 Colombia
  • 74 Costa Rica
  • 75 Cuba
  • 76 Dominican Republic
  • 77 Algeria
  • 78 Ecuador
  • 79 Egypt
  • 80 Eritrea
  • 81 Ethiopia
  • 82 Greenland
  • 83 Guatemala
  • 84 Honduras
  • 85 Haiti
  • 86 Indonesia
  • 87 Israel
  • 88 India
  • 89 Iraq
  • 90 Iran
  • 91 Jamaica
  • 92 Jordan
  • 93 Japan
  • 94 Kenya
  • 95 Kyrgyzstan
  • 96 Cambodia
  • 97 Korea
  • 98 Kuwait
  • 99 Kazakhstan
  • 100 Laos
  • 101 Lebanon
  • 102 Liechtenstein
  • 103 Sri Lanka
  • 104 Libya
  • 105 Morocco
  • 106 Mali
  • 107 Myanmar
  • 108 Mongolia
  • 109 Macao SAR
  • 110 Maldives
  • 111 Mexico
  • 112 Malaysia
  • 113 Nigeria
  • 114 Nicaragua
  • 115 Nepal
  • 116 New Zealand
  • 117 Oman
  • 118 Panama
  • 119 Peru
  • 120 Philippines
  • 121 Pakistan
  • 122 Puerto Rico
  • 123 Paraguay
  • 124 Qatar
  • 125 Reunion
  • 126 Rwanda
  • 127 Saudi Arabia
  • 128 Singapore
  • 129 Senegal
  • 130 Somalia
  • 131 El Salvador
  • 132 Syria
  • 133 Thailand
  • 134 Tajikistan
  • 135 Turkmenistan
  • 136 Tunisia
  • 137 Trinidad and Tobago
  • 138 Taiwan
  • 139 United States
  • 140 Uruguay
  • 141 Uzbekistan
  • 142 Venezuela
  • 143 Vietnam
  • 144 Yemen
  • 145 South Africa
  • 146 Zimbabwe
  • 147 Guinea-Bissau
  • 148 Angola
  • 149 Cabo Verde
  • 150 Sao Tome and Principe
  • 151 Mozambique
  • 152 Guinea
  • 153 Mauritania
  • 9999 Unknown
CostCenter.Poi.Priority

- No Priority 0 Priority 0 (lowest) 1 Priority 1 2 Priority 2 3 Priority 3 4 Priority 4 5 Priority 5 6 Priority 6 7 Priority 7 8 Priority 8 9 Priority 9 (highest)

Groups[].Type

0 User 1 Vehicle 2 Timeclock 3 Asset 4 Ivr phone number 5 Cost center 6 Work place 7 Mobile clocking

[
  {
    "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
429Too Many Requests

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.

0 Other 1 M1 Vehicles used for carriage of passengers, comprising not more than eight seats in addition to the driver's seat. 2 M2 Vehicles used for the carriage of passengers, comprising more than eight seats in addition to the driver's seat, and having a maximum mass not exceeding 5 tonnes. (Bus) 3 M3 Vehicles used for the carriage of passengers, comprising more than eight seats in addition to the driver's seat, and having a maximum mass exceeding 5 tonnes. (Bus) 4 N1 Vehicles used for the carriage of goods and having a maximum mass not exceeding 3.5 tonnes. (Pick-up Truck, Van) 5 N2 Vehicles used for the carriage of goods and having a maximum mass exceeding 3.5 tonnes but not exceeding 12 tonnes. (Commercial Truck) 6 N3 Vehicles used for the carriage of goods and having a maximum mass exceeding 12 tonnes. (Commercial Truck)

numberoptional
FuelType(default = 0)

0 Gasoline 1 Diesel 2 LPG 3 Electricity 4 Red Diesel 5 Ppo 6 Cng 7 Hybrid 8 Plug-in hybrid

numberoptional
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 viapass

0 Unknown 100 Euro1 200 Euro2 300 Euro3 400 Euro4 500 Euro5 600 Euro6

numberoptional
MaximumSpeed(default = null)numberoptional
NominalConsumption(default = 0.0) Normal consumption for Fleet Econumberoptional
CostCenter(default = null) Selected Cost Centerobjectoptional
{
  "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"
  }
}

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.

0 Other 1 M1 Vehicles used for carriage of passengers, comprising not more than eight seats in addition to the driver's seat. 2 M2 Vehicles used for the carriage of passengers, comprising more than eight seats in addition to the driver's seat, and having a maximum mass not exceeding 5 tonnes. (Bus) 3 M3 Vehicles used for the carriage of passengers, comprising more than eight seats in addition to the driver's seat, and having a maximum mass exceeding 5 tonnes. (Bus) 4 N1 Vehicles used for the carriage of goods and having a maximum mass not exceeding 3.5 tonnes. (Pick-up Truck, Van) 5 N2 Vehicles used for the carriage of goods and having a maximum mass exceeding 3.5 tonnes but not exceeding 12 tonnes. (Commercial Truck) 6 N3 Vehicles used for the carriage of goods and having a maximum mass exceeding 12 tonnes. (Commercial Truck)

number
FuelType(default = 0)

0 Gasoline 1 Diesel 2 LPG 3 Electricity 4 Red Diesel 5 Ppo 6 Cng 7 Hybrid 8 Plug-in hybrid

number
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.

0 Unknown 100 Euro1 200 Euro2 300 Euro3 400 Euro4 500 Euro5 600 Euro6

number
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
Allowed values in nested fields
CostCenter.Poi.Country
151 allowed values
  • 0 Belgium
  • 1 France
  • 2 Netherlands
  • 3 Luxembourg
  • 4 Italy
  • 5 Norway
  • 6 Denmark
  • 7 Sweden
  • 8 San Marino
  • 9 Andorra
  • 10 Germany
  • 11 United Kingdom
  • 12 Spain
  • 13 Portugal
  • 14 Switzerland
  • 15 Austria
  • 20 Hungary
  • 21 Czechia
  • 22 Greece
  • 23 Poland
  • 24 Slovakia
  • 25 Turkey
  • 26 Albania
  • 27 Bulgaria
  • 28 Bosnia Herzegovina
  • 29 Belarus
  • 30 Moldova
  • 31 Macedonia
  • 32 Montenegro
  • 33 Romania
  • 34 Serbia
  • 35 Ukraine
  • 36 Finland
  • 37 Ireland
  • 38 Malta
  • 39 Estonia
  • 40 Croatia
  • 41 Lithuania
  • 42 Latvia
  • 43 Slovenia
  • 44 Armenia
  • 45 Azerbaijan
  • 46 Cyprus
  • 47 Faroe Islands
  • 48 Georgia
  • 49 Gibraltar
  • 50 Iceland
  • 51 Monaco
  • 52 Russia
  • 53 Vatican
  • 54 Kosovo
  • 55 United Arab Emirates
  • 56 Afghanistan
  • 57 Argentina
  • 58 Australia
  • 59 Bangladesh
  • 60 Bahrain
  • 61 Brunei
  • 62 Bolivia
  • 63 Brazil
  • 64 Bhutan
  • 65 Botswana
  • 66 Belize
  • 67 Canada
  • 68 Congo
  • 69 Cote d'Ivoire
  • 70 Chile
  • 71 Cameroon
  • 72 China
  • 73 Colombia
  • 74 Costa Rica
  • 75 Cuba
  • 76 Dominican Republic
  • 77 Algeria
  • 78 Ecuador
  • 79 Egypt
  • 80 Eritrea
  • 81 Ethiopia
  • 82 Greenland
  • 83 Guatemala
  • 84 Honduras
  • 85 Haiti
  • 86 Indonesia
  • 87 Israel
  • 88 India
  • 89 Iraq
  • 90 Iran
  • 91 Jamaica
  • 92 Jordan
  • 93 Japan
  • 94 Kenya
  • 95 Kyrgyzstan
  • 96 Cambodia
  • 97 Korea
  • 98 Kuwait
  • 99 Kazakhstan
  • 100 Laos
  • 101 Lebanon
  • 102 Liechtenstein
  • 103 Sri Lanka
  • 104 Libya
  • 105 Morocco
  • 106 Mali
  • 107 Myanmar
  • 108 Mongolia
  • 109 Macao SAR
  • 110 Maldives
  • 111 Mexico
  • 112 Malaysia
  • 113 Nigeria
  • 114 Nicaragua
  • 115 Nepal
  • 116 New Zealand
  • 117 Oman
  • 118 Panama
  • 119 Peru
  • 120 Philippines
  • 121 Pakistan
  • 122 Puerto Rico
  • 123 Paraguay
  • 124 Qatar
  • 125 Reunion
  • 126 Rwanda
  • 127 Saudi Arabia
  • 128 Singapore
  • 129 Senegal
  • 130 Somalia
  • 131 El Salvador
  • 132 Syria
  • 133 Thailand
  • 134 Tajikistan
  • 135 Turkmenistan
  • 136 Tunisia
  • 137 Trinidad and Tobago
  • 138 Taiwan
  • 139 United States
  • 140 Uruguay
  • 141 Uzbekistan
  • 142 Venezuela
  • 143 Vietnam
  • 144 Yemen
  • 145 South Africa
  • 146 Zimbabwe
  • 147 Guinea-Bissau
  • 148 Angola
  • 149 Cabo Verde
  • 150 Sao Tome and Principe
  • 151 Mozambique
  • 152 Guinea
  • 153 Mauritania
  • 9999 Unknown
CostCenter.Poi.Priority

- No Priority 0 Priority 0 (lowest) 1 Priority 1 2 Priority 2 3 Priority 3 4 Priority 4 5 Priority 5 6 Priority 6 7 Priority 7 8 Priority 8 9 Priority 9 (highest)

{
  "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
FieldType
EntityVehicle
ValidationResultarray
Allowed values in nested fields
Entity.Category

0 Other 1 M1 Vehicles used for carriage of passengers, comprising not more than eight seats in addition to the driver's seat. 2 M2 Vehicles used for the carriage of passengers, comprising more than eight seats in addition to the driver's seat, and having a maximum mass not exceeding 5 tonnes. (Bus) 3 M3 Vehicles used for the carriage of passengers, comprising more than eight seats in addition to the driver's seat, and having a maximum mass exceeding 5 tonnes. (Bus) 4 N1 Vehicles used for the carriage of goods and having a maximum mass not exceeding 3.5 tonnes. (Pick-up Truck, Van) 5 N2 Vehicles used for the carriage of goods and having a maximum mass exceeding 3.5 tonnes but not exceeding 12 tonnes. (Commercial Truck) 6 N3 Vehicles used for the carriage of goods and having a maximum mass exceeding 12 tonnes. (Commercial Truck)

Entity.FuelType

0 Gasoline 1 Diesel 2 LPG 3 Electricity 4 Red Diesel 5 Ppo 6 Cng 7 Hybrid 8 Plug-in hybrid

Entity.EmissionStandard

0 Unknown 100 Euro1 200 Euro2 300 Euro3 400 Euro4 500 Euro5 600 Euro6

Entity.CostCenter.Poi.Country
151 allowed values
  • 0 Belgium
  • 1 France
  • 2 Netherlands
  • 3 Luxembourg
  • 4 Italy
  • 5 Norway
  • 6 Denmark
  • 7 Sweden
  • 8 San Marino
  • 9 Andorra
  • 10 Germany
  • 11 United Kingdom
  • 12 Spain
  • 13 Portugal
  • 14 Switzerland
  • 15 Austria
  • 20 Hungary
  • 21 Czechia
  • 22 Greece
  • 23 Poland
  • 24 Slovakia
  • 25 Turkey
  • 26 Albania
  • 27 Bulgaria
  • 28 Bosnia Herzegovina
  • 29 Belarus
  • 30 Moldova
  • 31 Macedonia
  • 32 Montenegro
  • 33 Romania
  • 34 Serbia
  • 35 Ukraine
  • 36 Finland
  • 37 Ireland
  • 38 Malta
  • 39 Estonia
  • 40 Croatia
  • 41 Lithuania
  • 42 Latvia
  • 43 Slovenia
  • 44 Armenia
  • 45 Azerbaijan
  • 46 Cyprus
  • 47 Faroe Islands
  • 48 Georgia
  • 49 Gibraltar
  • 50 Iceland
  • 51 Monaco
  • 52 Russia
  • 53 Vatican
  • 54 Kosovo
  • 55 United Arab Emirates
  • 56 Afghanistan
  • 57 Argentina
  • 58 Australia
  • 59 Bangladesh
  • 60 Bahrain
  • 61 Brunei
  • 62 Bolivia
  • 63 Brazil
  • 64 Bhutan
  • 65 Botswana
  • 66 Belize
  • 67 Canada
  • 68 Congo
  • 69 Cote d'Ivoire
  • 70 Chile
  • 71 Cameroon
  • 72 China
  • 73 Colombia
  • 74 Costa Rica
  • 75 Cuba
  • 76 Dominican Republic
  • 77 Algeria
  • 78 Ecuador
  • 79 Egypt
  • 80 Eritrea
  • 81 Ethiopia
  • 82 Greenland
  • 83 Guatemala
  • 84 Honduras
  • 85 Haiti
  • 86 Indonesia
  • 87 Israel
  • 88 India
  • 89 Iraq
  • 90 Iran
  • 91 Jamaica
  • 92 Jordan
  • 93 Japan
  • 94 Kenya
  • 95 Kyrgyzstan
  • 96 Cambodia
  • 97 Korea
  • 98 Kuwait
  • 99 Kazakhstan
  • 100 Laos
  • 101 Lebanon
  • 102 Liechtenstein
  • 103 Sri Lanka
  • 104 Libya
  • 105 Morocco
  • 106 Mali
  • 107 Myanmar
  • 108 Mongolia
  • 109 Macao SAR
  • 110 Maldives
  • 111 Mexico
  • 112 Malaysia
  • 113 Nigeria
  • 114 Nicaragua
  • 115 Nepal
  • 116 New Zealand
  • 117 Oman
  • 118 Panama
  • 119 Peru
  • 120 Philippines
  • 121 Pakistan
  • 122 Puerto Rico
  • 123 Paraguay
  • 124 Qatar
  • 125 Reunion
  • 126 Rwanda
  • 127 Saudi Arabia
  • 128 Singapore
  • 129 Senegal
  • 130 Somalia
  • 131 El Salvador
  • 132 Syria
  • 133 Thailand
  • 134 Tajikistan
  • 135 Turkmenistan
  • 136 Tunisia
  • 137 Trinidad and Tobago
  • 138 Taiwan
  • 139 United States
  • 140 Uruguay
  • 141 Uzbekistan
  • 142 Venezuela
  • 143 Vietnam
  • 144 Yemen
  • 145 South Africa
  • 146 Zimbabwe
  • 147 Guinea-Bissau
  • 148 Angola
  • 149 Cabo Verde
  • 150 Sao Tome and Principe
  • 151 Mozambique
  • 152 Guinea
  • 153 Mauritania
  • 9999 Unknown
Entity.CostCenter.Poi.Priority

- No Priority 0 Priority 0 (lowest) 1 Priority 1 2 Priority 2 3 Priority 3 4 Priority 4 5 Priority 5 6 Priority 6 7 Priority 7 8 Priority 8 9 Priority 9 (highest)

Entity.Groups[].Type

0 User 1 Vehicle 2 Timeclock 3 Asset 4 Ivr phone number 5 Cost center 6 Work place 7 Mobile clocking

401Unauthorized
403Forbidden
417ExpectationFailed
429Too Many Requests

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.

0 Other 1 M1 Vehicles used for carriage of passengers, comprising not more than eight seats in addition to the driver's seat. 2 M2 Vehicles used for the carriage of passengers, comprising more than eight seats in addition to the driver's seat, and having a maximum mass not exceeding 5 tonnes. (Bus) 3 M3 Vehicles used for the carriage of passengers, comprising more than eight seats in addition to the driver's seat, and having a maximum mass exceeding 5 tonnes. (Bus) 4 N1 Vehicles used for the carriage of goods and having a maximum mass not exceeding 3.5 tonnes. (Pick-up Truck, Van) 5 N2 Vehicles used for the carriage of goods and having a maximum mass exceeding 3.5 tonnes but not exceeding 12 tonnes. (Commercial Truck) 6 N3 Vehicles used for the carriage of goods and having a maximum mass exceeding 12 tonnes. (Commercial Truck)

numberoptional
FuelType(default = 0)

0 Gasoline 1 Diesel 2 LPG 3 Electricity 4 Red Diesel 5 Ppo 6 Cng 7 Hybrid 8 Plug-in hybrid

numberoptional
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 viapass

0 Unknown 100 Euro1 200 Euro2 300 Euro3 400 Euro4 500 Euro5 600 Euro6

numberoptional
MaximumSpeed(default = null)numberoptional
NominalConsumption(default = 0.0) Normal consumption for Fleet Econumberoptional
CostCenter(default = null) Selected Cost Centerobjectoptional
{
  "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"
  }
}

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.

0 Other 1 M1 Vehicles used for carriage of passengers, comprising not more than eight seats in addition to the driver's seat. 2 M2 Vehicles used for the carriage of passengers, comprising more than eight seats in addition to the driver's seat, and having a maximum mass not exceeding 5 tonnes. (Bus) 3 M3 Vehicles used for the carriage of passengers, comprising more than eight seats in addition to the driver's seat, and having a maximum mass exceeding 5 tonnes. (Bus) 4 N1 Vehicles used for the carriage of goods and having a maximum mass not exceeding 3.5 tonnes. (Pick-up Truck, Van) 5 N2 Vehicles used for the carriage of goods and having a maximum mass exceeding 3.5 tonnes but not exceeding 12 tonnes. (Commercial Truck) 6 N3 Vehicles used for the carriage of goods and having a maximum mass exceeding 12 tonnes. (Commercial Truck)

number
FuelType(default = 0)

0 Gasoline 1 Diesel 2 LPG 3 Electricity 4 Red Diesel 5 Ppo 6 Cng 7 Hybrid 8 Plug-in hybrid

number
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.

0 Unknown 100 Euro1 200 Euro2 300 Euro3 400 Euro4 500 Euro5 600 Euro6

number
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
Allowed values in nested fields
CostCenter.Poi.Country
151 allowed values
  • 0 Belgium
  • 1 France
  • 2 Netherlands
  • 3 Luxembourg
  • 4 Italy
  • 5 Norway
  • 6 Denmark
  • 7 Sweden
  • 8 San Marino
  • 9 Andorra
  • 10 Germany
  • 11 United Kingdom
  • 12 Spain
  • 13 Portugal
  • 14 Switzerland
  • 15 Austria
  • 20 Hungary
  • 21 Czechia
  • 22 Greece
  • 23 Poland
  • 24 Slovakia
  • 25 Turkey
  • 26 Albania
  • 27 Bulgaria
  • 28 Bosnia Herzegovina
  • 29 Belarus
  • 30 Moldova
  • 31 Macedonia
  • 32 Montenegro
  • 33 Romania
  • 34 Serbia
  • 35 Ukraine
  • 36 Finland
  • 37 Ireland
  • 38 Malta
  • 39 Estonia
  • 40 Croatia
  • 41 Lithuania
  • 42 Latvia
  • 43 Slovenia
  • 44 Armenia
  • 45 Azerbaijan
  • 46 Cyprus
  • 47 Faroe Islands
  • 48 Georgia
  • 49 Gibraltar
  • 50 Iceland
  • 51 Monaco
  • 52 Russia
  • 53 Vatican
  • 54 Kosovo
  • 55 United Arab Emirates
  • 56 Afghanistan
  • 57 Argentina
  • 58 Australia
  • 59 Bangladesh
  • 60 Bahrain
  • 61 Brunei
  • 62 Bolivia
  • 63 Brazil
  • 64 Bhutan
  • 65 Botswana
  • 66 Belize
  • 67 Canada
  • 68 Congo
  • 69 Cote d'Ivoire
  • 70 Chile
  • 71 Cameroon
  • 72 China
  • 73 Colombia
  • 74 Costa Rica
  • 75 Cuba
  • 76 Dominican Republic
  • 77 Algeria
  • 78 Ecuador
  • 79 Egypt
  • 80 Eritrea
  • 81 Ethiopia
  • 82 Greenland
  • 83 Guatemala
  • 84 Honduras
  • 85 Haiti
  • 86 Indonesia
  • 87 Israel
  • 88 India
  • 89 Iraq
  • 90 Iran
  • 91 Jamaica
  • 92 Jordan
  • 93 Japan
  • 94 Kenya
  • 95 Kyrgyzstan
  • 96 Cambodia
  • 97 Korea
  • 98 Kuwait
  • 99 Kazakhstan
  • 100 Laos
  • 101 Lebanon
  • 102 Liechtenstein
  • 103 Sri Lanka
  • 104 Libya
  • 105 Morocco
  • 106 Mali
  • 107 Myanmar
  • 108 Mongolia
  • 109 Macao SAR
  • 110 Maldives
  • 111 Mexico
  • 112 Malaysia
  • 113 Nigeria
  • 114 Nicaragua
  • 115 Nepal
  • 116 New Zealand
  • 117 Oman
  • 118 Panama
  • 119 Peru
  • 120 Philippines
  • 121 Pakistan
  • 122 Puerto Rico
  • 123 Paraguay
  • 124 Qatar
  • 125 Reunion
  • 126 Rwanda
  • 127 Saudi Arabia
  • 128 Singapore
  • 129 Senegal
  • 130 Somalia
  • 131 El Salvador
  • 132 Syria
  • 133 Thailand
  • 134 Tajikistan
  • 135 Turkmenistan
  • 136 Tunisia
  • 137 Trinidad and Tobago
  • 138 Taiwan
  • 139 United States
  • 140 Uruguay
  • 141 Uzbekistan
  • 142 Venezuela
  • 143 Vietnam
  • 144 Yemen
  • 145 South Africa
  • 146 Zimbabwe
  • 147 Guinea-Bissau
  • 148 Angola
  • 149 Cabo Verde
  • 150 Sao Tome and Principe
  • 151 Mozambique
  • 152 Guinea
  • 153 Mauritania
  • 9999 Unknown
CostCenter.Poi.Priority

- No Priority 0 Priority 0 (lowest) 1 Priority 1 2 Priority 2 3 Priority 3 4 Priority 4 5 Priority 5 6 Priority 6 7 Priority 7 8 Priority 8 9 Priority 9 (highest)

{
  "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
FieldType
EntityVehicle
ValidationResultarray
Allowed values in nested fields
Entity.Category

0 Other 1 M1 Vehicles used for carriage of passengers, comprising not more than eight seats in addition to the driver's seat. 2 M2 Vehicles used for the carriage of passengers, comprising more than eight seats in addition to the driver's seat, and having a maximum mass not exceeding 5 tonnes. (Bus) 3 M3 Vehicles used for the carriage of passengers, comprising more than eight seats in addition to the driver's seat, and having a maximum mass exceeding 5 tonnes. (Bus) 4 N1 Vehicles used for the carriage of goods and having a maximum mass not exceeding 3.5 tonnes. (Pick-up Truck, Van) 5 N2 Vehicles used for the carriage of goods and having a maximum mass exceeding 3.5 tonnes but not exceeding 12 tonnes. (Commercial Truck) 6 N3 Vehicles used for the carriage of goods and having a maximum mass exceeding 12 tonnes. (Commercial Truck)

Entity.FuelType

0 Gasoline 1 Diesel 2 LPG 3 Electricity 4 Red Diesel 5 Ppo 6 Cng 7 Hybrid 8 Plug-in hybrid

Entity.EmissionStandard

0 Unknown 100 Euro1 200 Euro2 300 Euro3 400 Euro4 500 Euro5 600 Euro6

Entity.CostCenter.Poi.Country
151 allowed values
  • 0 Belgium
  • 1 France
  • 2 Netherlands
  • 3 Luxembourg
  • 4 Italy
  • 5 Norway
  • 6 Denmark
  • 7 Sweden
  • 8 San Marino
  • 9 Andorra
  • 10 Germany
  • 11 United Kingdom
  • 12 Spain
  • 13 Portugal
  • 14 Switzerland
  • 15 Austria
  • 20 Hungary
  • 21 Czechia
  • 22 Greece
  • 23 Poland
  • 24 Slovakia
  • 25 Turkey
  • 26 Albania
  • 27 Bulgaria
  • 28 Bosnia Herzegovina
  • 29 Belarus
  • 30 Moldova
  • 31 Macedonia
  • 32 Montenegro
  • 33 Romania
  • 34 Serbia
  • 35 Ukraine
  • 36 Finland
  • 37 Ireland
  • 38 Malta
  • 39 Estonia
  • 40 Croatia
  • 41 Lithuania
  • 42 Latvia
  • 43 Slovenia
  • 44 Armenia
  • 45 Azerbaijan
  • 46 Cyprus
  • 47 Faroe Islands
  • 48 Georgia
  • 49 Gibraltar
  • 50 Iceland
  • 51 Monaco
  • 52 Russia
  • 53 Vatican
  • 54 Kosovo
  • 55 United Arab Emirates
  • 56 Afghanistan
  • 57 Argentina
  • 58 Australia
  • 59 Bangladesh
  • 60 Bahrain
  • 61 Brunei
  • 62 Bolivia
  • 63 Brazil
  • 64 Bhutan
  • 65 Botswana
  • 66 Belize
  • 67 Canada
  • 68 Congo
  • 69 Cote d'Ivoire
  • 70 Chile
  • 71 Cameroon
  • 72 China
  • 73 Colombia
  • 74 Costa Rica
  • 75 Cuba
  • 76 Dominican Republic
  • 77 Algeria
  • 78 Ecuador
  • 79 Egypt
  • 80 Eritrea
  • 81 Ethiopia
  • 82 Greenland
  • 83 Guatemala
  • 84 Honduras
  • 85 Haiti
  • 86 Indonesia
  • 87 Israel
  • 88 India
  • 89 Iraq
  • 90 Iran
  • 91 Jamaica
  • 92 Jordan
  • 93 Japan
  • 94 Kenya
  • 95 Kyrgyzstan
  • 96 Cambodia
  • 97 Korea
  • 98 Kuwait
  • 99 Kazakhstan
  • 100 Laos
  • 101 Lebanon
  • 102 Liechtenstein
  • 103 Sri Lanka
  • 104 Libya
  • 105 Morocco
  • 106 Mali
  • 107 Myanmar
  • 108 Mongolia
  • 109 Macao SAR
  • 110 Maldives
  • 111 Mexico
  • 112 Malaysia
  • 113 Nigeria
  • 114 Nicaragua
  • 115 Nepal
  • 116 New Zealand
  • 117 Oman
  • 118 Panama
  • 119 Peru
  • 120 Philippines
  • 121 Pakistan
  • 122 Puerto Rico
  • 123 Paraguay
  • 124 Qatar
  • 125 Reunion
  • 126 Rwanda
  • 127 Saudi Arabia
  • 128 Singapore
  • 129 Senegal
  • 130 Somalia
  • 131 El Salvador
  • 132 Syria
  • 133 Thailand
  • 134 Tajikistan
  • 135 Turkmenistan
  • 136 Tunisia
  • 137 Trinidad and Tobago
  • 138 Taiwan
  • 139 United States
  • 140 Uruguay
  • 141 Uzbekistan
  • 142 Venezuela
  • 143 Vietnam
  • 144 Yemen
  • 145 South Africa
  • 146 Zimbabwe
  • 147 Guinea-Bissau
  • 148 Angola
  • 149 Cabo Verde
  • 150 Sao Tome and Principe
  • 151 Mozambique
  • 152 Guinea
  • 153 Mauritania
  • 9999 Unknown
Entity.CostCenter.Poi.Priority

- No Priority 0 Priority 0 (lowest) 1 Priority 1 2 Priority 2 3 Priority 3 4 Priority 4 5 Priority 5 6 Priority 6 7 Priority 7 8 Priority 8 9 Priority 9 (highest)

Entity.Groups[].Type

0 User 1 Vehicle 2 Timeclock 3 Asset 4 Ivr phone number 5 Cost center 6 Work place 7 Mobile clocking

401Unauthorized
403Forbidden
417ExpectationFailed
429Too Many Requests
GEThttps://api.geodynamics.dev/intellitracer/v1/vehicle/{id}Api: Resource read or Api: Resource management

Get vehicle

Returns a vehicle by id.

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.

0 Other 1 M1 Vehicles used for carriage of passengers, comprising not more than eight seats in addition to the driver's seat. 2 M2 Vehicles used for the carriage of passengers, comprising more than eight seats in addition to the driver's seat, and having a maximum mass not exceeding 5 tonnes. (Bus) 3 M3 Vehicles used for the carriage of passengers, comprising more than eight seats in addition to the driver's seat, and having a maximum mass exceeding 5 tonnes. (Bus) 4 N1 Vehicles used for the carriage of goods and having a maximum mass not exceeding 3.5 tonnes. (Pick-up Truck, Van) 5 N2 Vehicles used for the carriage of goods and having a maximum mass exceeding 3.5 tonnes but not exceeding 12 tonnes. (Commercial Truck) 6 N3 Vehicles used for the carriage of goods and having a maximum mass exceeding 12 tonnes. (Commercial Truck)

number
FuelType(default = 0)

0 Gasoline 1 Diesel 2 LPG 3 Electricity 4 Red Diesel 5 Ppo 6 Cng 7 Hybrid 8 Plug-in hybrid

number
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.

0 Unknown 100 Euro1 200 Euro2 300 Euro3 400 Euro4 500 Euro5 600 Euro6

number
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
Allowed values in nested fields
CostCenter.Poi.Country
151 allowed values
  • 0 Belgium
  • 1 France
  • 2 Netherlands
  • 3 Luxembourg
  • 4 Italy
  • 5 Norway
  • 6 Denmark
  • 7 Sweden
  • 8 San Marino
  • 9 Andorra
  • 10 Germany
  • 11 United Kingdom
  • 12 Spain
  • 13 Portugal
  • 14 Switzerland
  • 15 Austria
  • 20 Hungary
  • 21 Czechia
  • 22 Greece
  • 23 Poland
  • 24 Slovakia
  • 25 Turkey
  • 26 Albania
  • 27 Bulgaria
  • 28 Bosnia Herzegovina
  • 29 Belarus
  • 30 Moldova
  • 31 Macedonia
  • 32 Montenegro
  • 33 Romania
  • 34 Serbia
  • 35 Ukraine
  • 36 Finland
  • 37 Ireland
  • 38 Malta
  • 39 Estonia
  • 40 Croatia
  • 41 Lithuania
  • 42 Latvia
  • 43 Slovenia
  • 44 Armenia
  • 45 Azerbaijan
  • 46 Cyprus
  • 47 Faroe Islands
  • 48 Georgia
  • 49 Gibraltar
  • 50 Iceland
  • 51 Monaco
  • 52 Russia
  • 53 Vatican
  • 54 Kosovo
  • 55 United Arab Emirates
  • 56 Afghanistan
  • 57 Argentina
  • 58 Australia
  • 59 Bangladesh
  • 60 Bahrain
  • 61 Brunei
  • 62 Bolivia
  • 63 Brazil
  • 64 Bhutan
  • 65 Botswana
  • 66 Belize
  • 67 Canada
  • 68 Congo
  • 69 Cote d'Ivoire
  • 70 Chile
  • 71 Cameroon
  • 72 China
  • 73 Colombia
  • 74 Costa Rica
  • 75 Cuba
  • 76 Dominican Republic
  • 77 Algeria
  • 78 Ecuador
  • 79 Egypt
  • 80 Eritrea
  • 81 Ethiopia
  • 82 Greenland
  • 83 Guatemala
  • 84 Honduras
  • 85 Haiti
  • 86 Indonesia
  • 87 Israel
  • 88 India
  • 89 Iraq
  • 90 Iran
  • 91 Jamaica
  • 92 Jordan
  • 93 Japan
  • 94 Kenya
  • 95 Kyrgyzstan
  • 96 Cambodia
  • 97 Korea
  • 98 Kuwait
  • 99 Kazakhstan
  • 100 Laos
  • 101 Lebanon
  • 102 Liechtenstein
  • 103 Sri Lanka
  • 104 Libya
  • 105 Morocco
  • 106 Mali
  • 107 Myanmar
  • 108 Mongolia
  • 109 Macao SAR
  • 110 Maldives
  • 111 Mexico
  • 112 Malaysia
  • 113 Nigeria
  • 114 Nicaragua
  • 115 Nepal
  • 116 New Zealand
  • 117 Oman
  • 118 Panama
  • 119 Peru
  • 120 Philippines
  • 121 Pakistan
  • 122 Puerto Rico
  • 123 Paraguay
  • 124 Qatar
  • 125 Reunion
  • 126 Rwanda
  • 127 Saudi Arabia
  • 128 Singapore
  • 129 Senegal
  • 130 Somalia
  • 131 El Salvador
  • 132 Syria
  • 133 Thailand
  • 134 Tajikistan
  • 135 Turkmenistan
  • 136 Tunisia
  • 137 Trinidad and Tobago
  • 138 Taiwan
  • 139 United States
  • 140 Uruguay
  • 141 Uzbekistan
  • 142 Venezuela
  • 143 Vietnam
  • 144 Yemen
  • 145 South Africa
  • 146 Zimbabwe
  • 147 Guinea-Bissau
  • 148 Angola
  • 149 Cabo Verde
  • 150 Sao Tome and Principe
  • 151 Mozambique
  • 152 Guinea
  • 153 Mauritania
  • 9999 Unknown
CostCenter.Poi.Priority

- No Priority 0 Priority 0 (lowest) 1 Priority 1 2 Priority 2 3 Priority 3 4 Priority 4 5 Priority 5 6 Priority 6 7 Priority 7 8 Priority 8 9 Priority 9 (highest)

{
  "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
429Too Many Requests

Timeclocks

GEThttps://api.geodynamics.dev/intellitracer/v2/timeclock/{id}Api: Resource read or Api: Resource management

Get timeclock

Returns a timeclock by id.

Path parameters

NameTypeRequiredExample
idstringrequired00000000-0000-0000-0000-000000000000

Responses

200OK
FieldType
Data(default = null)object
Allowed values in nested fields
Data.ReaderType

0 MF7 1 GP20 2 MF7 Construbadge 3 RF4 5

Data.TimeClockType

0 Vicking 2 Datafox - Evoline 2.8 3 Datafox - Evoline 4.3 4 Datafox - Evoline 3.5 5 Datafox ZKBox 6 Datafox PZE Master 7 Axess TMC

Data.FirmwareVersion

0 v1_2 1 v1_3 2 v2_1

Data.Address.CountryCode
151 allowed values
  • 0 Belgium
  • 1 France
  • 2 Netherlands
  • 3 Luxembourg
  • 4 Italy
  • 5 Norway
  • 6 Denmark
  • 7 Sweden
  • 8 San Marino
  • 9 Andorra
  • 10 Germany
  • 11 United Kingdom
  • 12 Spain
  • 13 Portugal
  • 14 Switzerland
  • 15 Austria
  • 20 Hungary
  • 21 Czechia
  • 22 Greece
  • 23 Poland
  • 24 Slovakia
  • 25 Turkey
  • 26 Albania
  • 27 Bulgaria
  • 28 Bosnia Herzegovina
  • 29 Belarus
  • 30 Moldova
  • 31 Macedonia
  • 32 Montenegro
  • 33 Romania
  • 34 Serbia
  • 35 Ukraine
  • 36 Finland
  • 37 Ireland
  • 38 Malta
  • 39 Estonia
  • 40 Croatia
  • 41 Lithuania
  • 42 Latvia
  • 43 Slovenia
  • 44 Armenia
  • 45 Azerbaijan
  • 46 Cyprus
  • 47 Faroe Islands
  • 48 Georgia
  • 49 Gibraltar
  • 50 Iceland
  • 51 Monaco
  • 52 Russia
  • 53 Vatican
  • 54 Kosovo
  • 55 United Arab Emirates
  • 56 Afghanistan
  • 57 Argentina
  • 58 Australia
  • 59 Bangladesh
  • 60 Bahrain
  • 61 Brunei
  • 62 Bolivia
  • 63 Brazil
  • 64 Bhutan
  • 65 Botswana
  • 66 Belize
  • 67 Canada
  • 68 Congo
  • 69 Cote d'Ivoire
  • 70 Chile
  • 71 Cameroon
  • 72 China
  • 73 Colombia
  • 74 Costa Rica
  • 75 Cuba
  • 76 Dominican Republic
  • 77 Algeria
  • 78 Ecuador
  • 79 Egypt
  • 80 Eritrea
  • 81 Ethiopia
  • 82 Greenland
  • 83 Guatemala
  • 84 Honduras
  • 85 Haiti
  • 86 Indonesia
  • 87 Israel
  • 88 India
  • 89 Iraq
  • 90 Iran
  • 91 Jamaica
  • 92 Jordan
  • 93 Japan
  • 94 Kenya
  • 95 Kyrgyzstan
  • 96 Cambodia
  • 97 Korea
  • 98 Kuwait
  • 99 Kazakhstan
  • 100 Laos
  • 101 Lebanon
  • 102 Liechtenstein
  • 103 Sri Lanka
  • 104 Libya
  • 105 Morocco
  • 106 Mali
  • 107 Myanmar
  • 108 Mongolia
  • 109 Macao SAR
  • 110 Maldives
  • 111 Mexico
  • 112 Malaysia
  • 113 Nigeria
  • 114 Nicaragua
  • 115 Nepal
  • 116 New Zealand
  • 117 Oman
  • 118 Panama
  • 119 Peru
  • 120 Philippines
  • 121 Pakistan
  • 122 Puerto Rico
  • 123 Paraguay
  • 124 Qatar
  • 125 Reunion
  • 126 Rwanda
  • 127 Saudi Arabia
  • 128 Singapore
  • 129 Senegal
  • 130 Somalia
  • 131 El Salvador
  • 132 Syria
  • 133 Thailand
  • 134 Tajikistan
  • 135 Turkmenistan
  • 136 Tunisia
  • 137 Trinidad and Tobago
  • 138 Taiwan
  • 139 United States
  • 140 Uruguay
  • 141 Uzbekistan
  • 142 Venezuela
  • 143 Vietnam
  • 144 Yemen
  • 145 South Africa
  • 146 Zimbabwe
  • 147 Guinea-Bissau
  • 148 Angola
  • 149 Cabo Verde
  • 150 Sao Tome and Principe
  • 151 Mozambique
  • 152 Guinea
  • 153 Mauritania
  • 9999 Unknown
Data.CostCenter.Type

0 User 1 Vehicle 2 Timeclock 3 Asset 4 Ivr phone number 5 Cost center 6 Work place 7 Mobile clocking

{
  "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
404NotFound
429Too Many Requests

Time Validation

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
429Too Many Requests

Pois

GEThttps://api.geodynamics.dev/intellitracer/v2/poi/{id}Api: Poi's read or Api: Poi's edit

Get point of interest

Returns a point of interest by id.

Path parameters

NameTypeRequiredExample
idstringrequired00000000-0000-0000-0000-000000000000

Responses

200OK
FieldType
Data(default = null)object
Allowed values in nested fields
Data.Country
151 allowed values
  • 0 Belgium
  • 1 France
  • 2 Netherlands
  • 3 Luxembourg
  • 4 Italy
  • 5 Norway
  • 6 Denmark
  • 7 Sweden
  • 8 San Marino
  • 9 Andorra
  • 10 Germany
  • 11 United Kingdom
  • 12 Spain
  • 13 Portugal
  • 14 Switzerland
  • 15 Austria
  • 20 Hungary
  • 21 Czechia
  • 22 Greece
  • 23 Poland
  • 24 Slovakia
  • 25 Turkey
  • 26 Albania
  • 27 Bulgaria
  • 28 Bosnia Herzegovina
  • 29 Belarus
  • 30 Moldova
  • 31 Macedonia
  • 32 Montenegro
  • 33 Romania
  • 34 Serbia
  • 35 Ukraine
  • 36 Finland
  • 37 Ireland
  • 38 Malta
  • 39 Estonia
  • 40 Croatia
  • 41 Lithuania
  • 42 Latvia
  • 43 Slovenia
  • 44 Armenia
  • 45 Azerbaijan
  • 46 Cyprus
  • 47 Faroe Islands
  • 48 Georgia
  • 49 Gibraltar
  • 50 Iceland
  • 51 Monaco
  • 52 Russia
  • 53 Vatican
  • 54 Kosovo
  • 55 United Arab Emirates
  • 56 Afghanistan
  • 57 Argentina
  • 58 Australia
  • 59 Bangladesh
  • 60 Bahrain
  • 61 Brunei
  • 62 Bolivia
  • 63 Brazil
  • 64 Bhutan
  • 65 Botswana
  • 66 Belize
  • 67 Canada
  • 68 Congo
  • 69 Cote d'Ivoire
  • 70 Chile
  • 71 Cameroon
  • 72 China
  • 73 Colombia
  • 74 Costa Rica
  • 75 Cuba
  • 76 Dominican Republic
  • 77 Algeria
  • 78 Ecuador
  • 79 Egypt
  • 80 Eritrea
  • 81 Ethiopia
  • 82 Greenland
  • 83 Guatemala
  • 84 Honduras
  • 85 Haiti
  • 86 Indonesia
  • 87 Israel
  • 88 India
  • 89 Iraq
  • 90 Iran
  • 91 Jamaica
  • 92 Jordan
  • 93 Japan
  • 94 Kenya
  • 95 Kyrgyzstan
  • 96 Cambodia
  • 97 Korea
  • 98 Kuwait
  • 99 Kazakhstan
  • 100 Laos
  • 101 Lebanon
  • 102 Liechtenstein
  • 103 Sri Lanka
  • 104 Libya
  • 105 Morocco
  • 106 Mali
  • 107 Myanmar
  • 108 Mongolia
  • 109 Macao SAR
  • 110 Maldives
  • 111 Mexico
  • 112 Malaysia
  • 113 Nigeria
  • 114 Nicaragua
  • 115 Nepal
  • 116 New Zealand
  • 117 Oman
  • 118 Panama
  • 119 Peru
  • 120 Philippines
  • 121 Pakistan
  • 122 Puerto Rico
  • 123 Paraguay
  • 124 Qatar
  • 125 Reunion
  • 126 Rwanda
  • 127 Saudi Arabia
  • 128 Singapore
  • 129 Senegal
  • 130 Somalia
  • 131 El Salvador
  • 132 Syria
  • 133 Thailand
  • 134 Tajikistan
  • 135 Turkmenistan
  • 136 Tunisia
  • 137 Trinidad and Tobago
  • 138 Taiwan
  • 139 United States
  • 140 Uruguay
  • 141 Uzbekistan
  • 142 Venezuela
  • 143 Vietnam
  • 144 Yemen
  • 145 South Africa
  • 146 Zimbabwe
  • 147 Guinea-Bissau
  • 148 Angola
  • 149 Cabo Verde
  • 150 Sao Tome and Principe
  • 151 Mozambique
  • 152 Guinea
  • 153 Mauritania
  • 9999 Unknown
Data.Priority

- No Priority 0 Priority 0 (lowest) 1 Priority 1 2 Priority 2 3 Priority 3 4 Priority 4 5 Priority 5 6 Priority 6 7 Priority 7 8 Priority 8 9 Priority 9 (highest)

Data.Type.Level

0 Street 1 Suburb 2 City 3 District 4 Province 5 Region 6 Country 7 Continent

{
  "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
404NotFound
429Too Many Requests

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)
151 allowed values
  • 0 Belgium
  • 1 France
  • 2 Netherlands
  • 3 Luxembourg
  • 4 Italy
  • 5 Norway
  • 6 Denmark
  • 7 Sweden
  • 8 San Marino
  • 9 Andorra
  • 10 Germany
  • 11 United Kingdom
  • 12 Spain
  • 13 Portugal
  • 14 Switzerland
  • 15 Austria
  • 20 Hungary
  • 21 Czechia
  • 22 Greece
  • 23 Poland
  • 24 Slovakia
  • 25 Turkey
  • 26 Albania
  • 27 Bulgaria
  • 28 Bosnia Herzegovina
  • 29 Belarus
  • 30 Moldova
  • 31 Macedonia
  • 32 Montenegro
  • 33 Romania
  • 34 Serbia
  • 35 Ukraine
  • 36 Finland
  • 37 Ireland
  • 38 Malta
  • 39 Estonia
  • 40 Croatia
  • 41 Lithuania
  • 42 Latvia
  • 43 Slovenia
  • 44 Armenia
  • 45 Azerbaijan
  • 46 Cyprus
  • 47 Faroe Islands
  • 48 Georgia
  • 49 Gibraltar
  • 50 Iceland
  • 51 Monaco
  • 52 Russia
  • 53 Vatican
  • 54 Kosovo
  • 55 United Arab Emirates
  • 56 Afghanistan
  • 57 Argentina
  • 58 Australia
  • 59 Bangladesh
  • 60 Bahrain
  • 61 Brunei
  • 62 Bolivia
  • 63 Brazil
  • 64 Bhutan
  • 65 Botswana
  • 66 Belize
  • 67 Canada
  • 68 Congo
  • 69 Cote d'Ivoire
  • 70 Chile
  • 71 Cameroon
  • 72 China
  • 73 Colombia
  • 74 Costa Rica
  • 75 Cuba
  • 76 Dominican Republic
  • 77 Algeria
  • 78 Ecuador
  • 79 Egypt
  • 80 Eritrea
  • 81 Ethiopia
  • 82 Greenland
  • 83 Guatemala
  • 84 Honduras
  • 85 Haiti
  • 86 Indonesia
  • 87 Israel
  • 88 India
  • 89 Iraq
  • 90 Iran
  • 91 Jamaica
  • 92 Jordan
  • 93 Japan
  • 94 Kenya
  • 95 Kyrgyzstan
  • 96 Cambodia
  • 97 Korea
  • 98 Kuwait
  • 99 Kazakhstan
  • 100 Laos
  • 101 Lebanon
  • 102 Liechtenstein
  • 103 Sri Lanka
  • 104 Libya
  • 105 Morocco
  • 106 Mali
  • 107 Myanmar
  • 108 Mongolia
  • 109 Macao SAR
  • 110 Maldives
  • 111 Mexico
  • 112 Malaysia
  • 113 Nigeria
  • 114 Nicaragua
  • 115 Nepal
  • 116 New Zealand
  • 117 Oman
  • 118 Panama
  • 119 Peru
  • 120 Philippines
  • 121 Pakistan
  • 122 Puerto Rico
  • 123 Paraguay
  • 124 Qatar
  • 125 Reunion
  • 126 Rwanda
  • 127 Saudi Arabia
  • 128 Singapore
  • 129 Senegal
  • 130 Somalia
  • 131 El Salvador
  • 132 Syria
  • 133 Thailand
  • 134 Tajikistan
  • 135 Turkmenistan
  • 136 Tunisia
  • 137 Trinidad and Tobago
  • 138 Taiwan
  • 139 United States
  • 140 Uruguay
  • 141 Uzbekistan
  • 142 Venezuela
  • 143 Vietnam
  • 144 Yemen
  • 145 South Africa
  • 146 Zimbabwe
  • 147 Guinea-Bissau
  • 148 Angola
  • 149 Cabo Verde
  • 150 Sao Tome and Principe
  • 151 Mozambique
  • 152 Guinea
  • 153 Mauritania
  • 9999 Unknown
numberoptional
Priority(default = -) Determines which POI will be displayed on top in GeoDynamics (in case of overlapping POIs).

- No Priority 0 Priority 0 (lowest) 1 Priority 1 2 Priority 2 3 Priority 3 4 Priority 4 5 Priority 5 6 Priority 6 7 Priority 7 8 Priority 8 9 Priority 9 (highest)

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
{
  "Name": "Work",
  "Code": "012345",
  "PoiType": {
    "Id": "00000000-0000-0000-0000-000000000000"
  },
  "IsAssetLocation": false,
  "Street": "Dumolinlaan",
  "HouseNumber": "9",
  "City": "Kortrijk",
  "Submunicipality": "Kortrijk",
  "PostalCode": "8500",
  "Country": 0,
  "Priority": "0",
  "Description": "Work",
  "MarkerLon": 3.145219,
  "MarkerLat": 50.81309,
  "IsLambert72": false,
  "Radius": 0.03,
  "ReverseGeocoding": false,
  "Id": "00000000-0000-0000-0000-000000000000"
}

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)
151 allowed values
  • 0 Belgium
  • 1 France
  • 2 Netherlands
  • 3 Luxembourg
  • 4 Italy
  • 5 Norway
  • 6 Denmark
  • 7 Sweden
  • 8 San Marino
  • 9 Andorra
  • 10 Germany
  • 11 United Kingdom
  • 12 Spain
  • 13 Portugal
  • 14 Switzerland
  • 15 Austria
  • 20 Hungary
  • 21 Czechia
  • 22 Greece
  • 23 Poland
  • 24 Slovakia
  • 25 Turkey
  • 26 Albania
  • 27 Bulgaria
  • 28 Bosnia Herzegovina
  • 29 Belarus
  • 30 Moldova
  • 31 Macedonia
  • 32 Montenegro
  • 33 Romania
  • 34 Serbia
  • 35 Ukraine
  • 36 Finland
  • 37 Ireland
  • 38 Malta
  • 39 Estonia
  • 40 Croatia
  • 41 Lithuania
  • 42 Latvia
  • 43 Slovenia
  • 44 Armenia
  • 45 Azerbaijan
  • 46 Cyprus
  • 47 Faroe Islands
  • 48 Georgia
  • 49 Gibraltar
  • 50 Iceland
  • 51 Monaco
  • 52 Russia
  • 53 Vatican
  • 54 Kosovo
  • 55 United Arab Emirates
  • 56 Afghanistan
  • 57 Argentina
  • 58 Australia
  • 59 Bangladesh
  • 60 Bahrain
  • 61 Brunei
  • 62 Bolivia
  • 63 Brazil
  • 64 Bhutan
  • 65 Botswana
  • 66 Belize
  • 67 Canada
  • 68 Congo
  • 69 Cote d'Ivoire
  • 70 Chile
  • 71 Cameroon
  • 72 China
  • 73 Colombia
  • 74 Costa Rica
  • 75 Cuba
  • 76 Dominican Republic
  • 77 Algeria
  • 78 Ecuador
  • 79 Egypt
  • 80 Eritrea
  • 81 Ethiopia
  • 82 Greenland
  • 83 Guatemala
  • 84 Honduras
  • 85 Haiti
  • 86 Indonesia
  • 87 Israel
  • 88 India
  • 89 Iraq
  • 90 Iran
  • 91 Jamaica
  • 92 Jordan
  • 93 Japan
  • 94 Kenya
  • 95 Kyrgyzstan
  • 96 Cambodia
  • 97 Korea
  • 98 Kuwait
  • 99 Kazakhstan
  • 100 Laos
  • 101 Lebanon
  • 102 Liechtenstein
  • 103 Sri Lanka
  • 104 Libya
  • 105 Morocco
  • 106 Mali
  • 107 Myanmar
  • 108 Mongolia
  • 109 Macao SAR
  • 110 Maldives
  • 111 Mexico
  • 112 Malaysia
  • 113 Nigeria
  • 114 Nicaragua
  • 115 Nepal
  • 116 New Zealand
  • 117 Oman
  • 118 Panama
  • 119 Peru
  • 120 Philippines
  • 121 Pakistan
  • 122 Puerto Rico
  • 123 Paraguay
  • 124 Qatar
  • 125 Reunion
  • 126 Rwanda
  • 127 Saudi Arabia
  • 128 Singapore
  • 129 Senegal
  • 130 Somalia
  • 131 El Salvador
  • 132 Syria
  • 133 Thailand
  • 134 Tajikistan
  • 135 Turkmenistan
  • 136 Tunisia
  • 137 Trinidad and Tobago
  • 138 Taiwan
  • 139 United States
  • 140 Uruguay
  • 141 Uzbekistan
  • 142 Venezuela
  • 143 Vietnam
  • 144 Yemen
  • 145 South Africa
  • 146 Zimbabwe
  • 147 Guinea-Bissau
  • 148 Angola
  • 149 Cabo Verde
  • 150 Sao Tome and Principe
  • 151 Mozambique
  • 152 Guinea
  • 153 Mauritania
  • 9999 Unknown
number
Priority(default = null) Determines which POI will be displayed on top in GeoDynamics (in case of overlapping POIs).

- No Priority 0 Priority 0 (lowest) 1 Priority 1 2 Priority 2 3 Priority 3 4 Priority 4 5 Priority 5 6 Priority 6 7 Priority 7 8 Priority 8 9 Priority 9 (highest)

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
FieldType
EntityPoi
ValidationResultarray
Allowed values in nested fields
Entity.Country
151 allowed values
  • 0 Belgium
  • 1 France
  • 2 Netherlands
  • 3 Luxembourg
  • 4 Italy
  • 5 Norway
  • 6 Denmark
  • 7 Sweden
  • 8 San Marino
  • 9 Andorra
  • 10 Germany
  • 11 United Kingdom
  • 12 Spain
  • 13 Portugal
  • 14 Switzerland
  • 15 Austria
  • 20 Hungary
  • 21 Czechia
  • 22 Greece
  • 23 Poland
  • 24 Slovakia
  • 25 Turkey
  • 26 Albania
  • 27 Bulgaria
  • 28 Bosnia Herzegovina
  • 29 Belarus
  • 30 Moldova
  • 31 Macedonia
  • 32 Montenegro
  • 33 Romania
  • 34 Serbia
  • 35 Ukraine
  • 36 Finland
  • 37 Ireland
  • 38 Malta
  • 39 Estonia
  • 40 Croatia
  • 41 Lithuania
  • 42 Latvia
  • 43 Slovenia
  • 44 Armenia
  • 45 Azerbaijan
  • 46 Cyprus
  • 47 Faroe Islands
  • 48 Georgia
  • 49 Gibraltar
  • 50 Iceland
  • 51 Monaco
  • 52 Russia
  • 53 Vatican
  • 54 Kosovo
  • 55 United Arab Emirates
  • 56 Afghanistan
  • 57 Argentina
  • 58 Australia
  • 59 Bangladesh
  • 60 Bahrain
  • 61 Brunei
  • 62 Bolivia
  • 63 Brazil
  • 64 Bhutan
  • 65 Botswana
  • 66 Belize
  • 67 Canada
  • 68 Congo
  • 69 Cote d'Ivoire
  • 70 Chile
  • 71 Cameroon
  • 72 China
  • 73 Colombia
  • 74 Costa Rica
  • 75 Cuba
  • 76 Dominican Republic
  • 77 Algeria
  • 78 Ecuador
  • 79 Egypt
  • 80 Eritrea
  • 81 Ethiopia
  • 82 Greenland
  • 83 Guatemala
  • 84 Honduras
  • 85 Haiti
  • 86 Indonesia
  • 87 Israel
  • 88 India
  • 89 Iraq
  • 90 Iran
  • 91 Jamaica
  • 92 Jordan
  • 93 Japan
  • 94 Kenya
  • 95 Kyrgyzstan
  • 96 Cambodia
  • 97 Korea
  • 98 Kuwait
  • 99 Kazakhstan
  • 100 Laos
  • 101 Lebanon
  • 102 Liechtenstein
  • 103 Sri Lanka
  • 104 Libya
  • 105 Morocco
  • 106 Mali
  • 107 Myanmar
  • 108 Mongolia
  • 109 Macao SAR
  • 110 Maldives
  • 111 Mexico
  • 112 Malaysia
  • 113 Nigeria
  • 114 Nicaragua
  • 115 Nepal
  • 116 New Zealand
  • 117 Oman
  • 118 Panama
  • 119 Peru
  • 120 Philippines
  • 121 Pakistan
  • 122 Puerto Rico
  • 123 Paraguay
  • 124 Qatar
  • 125 Reunion
  • 126 Rwanda
  • 127 Saudi Arabia
  • 128 Singapore
  • 129 Senegal
  • 130 Somalia
  • 131 El Salvador
  • 132 Syria
  • 133 Thailand
  • 134 Tajikistan
  • 135 Turkmenistan
  • 136 Tunisia
  • 137 Trinidad and Tobago
  • 138 Taiwan
  • 139 United States
  • 140 Uruguay
  • 141 Uzbekistan
  • 142 Venezuela
  • 143 Vietnam
  • 144 Yemen
  • 145 South Africa
  • 146 Zimbabwe
  • 147 Guinea-Bissau
  • 148 Angola
  • 149 Cabo Verde
  • 150 Sao Tome and Principe
  • 151 Mozambique
  • 152 Guinea
  • 153 Mauritania
  • 9999 Unknown
Entity.Priority

- No Priority 0 Priority 0 (lowest) 1 Priority 1 2 Priority 2 3 Priority 3 4 Priority 4 5 Priority 5 6 Priority 6 7 Priority 7 8 Priority 8 9 Priority 9 (highest)

401Unauthorized
403Forbidden
417ExpectationFailed
429Too Many Requests

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)
151 allowed values
  • 0 Belgium
  • 1 France
  • 2 Netherlands
  • 3 Luxembourg
  • 4 Italy
  • 5 Norway
  • 6 Denmark
  • 7 Sweden
  • 8 San Marino
  • 9 Andorra
  • 10 Germany
  • 11 United Kingdom
  • 12 Spain
  • 13 Portugal
  • 14 Switzerland
  • 15 Austria
  • 20 Hungary
  • 21 Czechia
  • 22 Greece
  • 23 Poland
  • 24 Slovakia
  • 25 Turkey
  • 26 Albania
  • 27 Bulgaria
  • 28 Bosnia Herzegovina
  • 29 Belarus
  • 30 Moldova
  • 31 Macedonia
  • 32 Montenegro
  • 33 Romania
  • 34 Serbia
  • 35 Ukraine
  • 36 Finland
  • 37 Ireland
  • 38 Malta
  • 39 Estonia
  • 40 Croatia
  • 41 Lithuania
  • 42 Latvia
  • 43 Slovenia
  • 44 Armenia
  • 45 Azerbaijan
  • 46 Cyprus
  • 47 Faroe Islands
  • 48 Georgia
  • 49 Gibraltar
  • 50 Iceland
  • 51 Monaco
  • 52 Russia
  • 53 Vatican
  • 54 Kosovo
  • 55 United Arab Emirates
  • 56 Afghanistan
  • 57 Argentina
  • 58 Australia
  • 59 Bangladesh
  • 60 Bahrain
  • 61 Brunei
  • 62 Bolivia
  • 63 Brazil
  • 64 Bhutan
  • 65 Botswana
  • 66 Belize
  • 67 Canada
  • 68 Congo
  • 69 Cote d'Ivoire
  • 70 Chile
  • 71 Cameroon
  • 72 China
  • 73 Colombia
  • 74 Costa Rica
  • 75 Cuba
  • 76 Dominican Republic
  • 77 Algeria
  • 78 Ecuador
  • 79 Egypt
  • 80 Eritrea
  • 81 Ethiopia
  • 82 Greenland
  • 83 Guatemala
  • 84 Honduras
  • 85 Haiti
  • 86 Indonesia
  • 87 Israel
  • 88 India
  • 89 Iraq
  • 90 Iran
  • 91 Jamaica
  • 92 Jordan
  • 93 Japan
  • 94 Kenya
  • 95 Kyrgyzstan
  • 96 Cambodia
  • 97 Korea
  • 98 Kuwait
  • 99 Kazakhstan
  • 100 Laos
  • 101 Lebanon
  • 102 Liechtenstein
  • 103 Sri Lanka
  • 104 Libya
  • 105 Morocco
  • 106 Mali
  • 107 Myanmar
  • 108 Mongolia
  • 109 Macao SAR
  • 110 Maldives
  • 111 Mexico
  • 112 Malaysia
  • 113 Nigeria
  • 114 Nicaragua
  • 115 Nepal
  • 116 New Zealand
  • 117 Oman
  • 118 Panama
  • 119 Peru
  • 120 Philippines
  • 121 Pakistan
  • 122 Puerto Rico
  • 123 Paraguay
  • 124 Qatar
  • 125 Reunion
  • 126 Rwanda
  • 127 Saudi Arabia
  • 128 Singapore
  • 129 Senegal
  • 130 Somalia
  • 131 El Salvador
  • 132 Syria
  • 133 Thailand
  • 134 Tajikistan
  • 135 Turkmenistan
  • 136 Tunisia
  • 137 Trinidad and Tobago
  • 138 Taiwan
  • 139 United States
  • 140 Uruguay
  • 141 Uzbekistan
  • 142 Venezuela
  • 143 Vietnam
  • 144 Yemen
  • 145 South Africa
  • 146 Zimbabwe
  • 147 Guinea-Bissau
  • 148 Angola
  • 149 Cabo Verde
  • 150 Sao Tome and Principe
  • 151 Mozambique
  • 152 Guinea
  • 153 Mauritania
  • 9999 Unknown
numberoptional
Priority(default = -) Determines which POI will be displayed on top in GeoDynamics (in case of overlapping POIs).

- No Priority 0 Priority 0 (lowest) 1 Priority 1 2 Priority 2 3 Priority 3 4 Priority 4 5 Priority 5 6 Priority 6 7 Priority 7 8 Priority 8 9 Priority 9 (highest)

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
{
  "Name": "Work",
  "Code": "012345",
  "PoiType": {
    "Id": "00000000-0000-0000-0000-000000000000"
  },
  "IsAssetLocation": false,
  "Street": "Dumolinlaan",
  "HouseNumber": "9",
  "City": "Kortrijk",
  "Submunicipality": "Kortrijk",
  "PostalCode": "8500",
  "Country": 0,
  "Priority": "0",
  "Description": "Work",
  "MarkerLon": 3.145219,
  "MarkerLat": 50.81309,
  "IsLambert72": false,
  "Radius": 0.03,
  "ReverseGeocoding": false
}

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)
151 allowed values
  • 0 Belgium
  • 1 France
  • 2 Netherlands
  • 3 Luxembourg
  • 4 Italy
  • 5 Norway
  • 6 Denmark
  • 7 Sweden
  • 8 San Marino
  • 9 Andorra
  • 10 Germany
  • 11 United Kingdom
  • 12 Spain
  • 13 Portugal
  • 14 Switzerland
  • 15 Austria
  • 20 Hungary
  • 21 Czechia
  • 22 Greece
  • 23 Poland
  • 24 Slovakia
  • 25 Turkey
  • 26 Albania
  • 27 Bulgaria
  • 28 Bosnia Herzegovina
  • 29 Belarus
  • 30 Moldova
  • 31 Macedonia
  • 32 Montenegro
  • 33 Romania
  • 34 Serbia
  • 35 Ukraine
  • 36 Finland
  • 37 Ireland
  • 38 Malta
  • 39 Estonia
  • 40 Croatia
  • 41 Lithuania
  • 42 Latvia
  • 43 Slovenia
  • 44 Armenia
  • 45 Azerbaijan
  • 46 Cyprus
  • 47 Faroe Islands
  • 48 Georgia
  • 49 Gibraltar
  • 50 Iceland
  • 51 Monaco
  • 52 Russia
  • 53 Vatican
  • 54 Kosovo
  • 55 United Arab Emirates
  • 56 Afghanistan
  • 57 Argentina
  • 58 Australia
  • 59 Bangladesh
  • 60 Bahrain
  • 61 Brunei
  • 62 Bolivia
  • 63 Brazil
  • 64 Bhutan
  • 65 Botswana
  • 66 Belize
  • 67 Canada
  • 68 Congo
  • 69 Cote d'Ivoire
  • 70 Chile
  • 71 Cameroon
  • 72 China
  • 73 Colombia
  • 74 Costa Rica
  • 75 Cuba
  • 76 Dominican Republic
  • 77 Algeria
  • 78 Ecuador
  • 79 Egypt
  • 80 Eritrea
  • 81 Ethiopia
  • 82 Greenland
  • 83 Guatemala
  • 84 Honduras
  • 85 Haiti
  • 86 Indonesia
  • 87 Israel
  • 88 India
  • 89 Iraq
  • 90 Iran
  • 91 Jamaica
  • 92 Jordan
  • 93 Japan
  • 94 Kenya
  • 95 Kyrgyzstan
  • 96 Cambodia
  • 97 Korea
  • 98 Kuwait
  • 99 Kazakhstan
  • 100 Laos
  • 101 Lebanon
  • 102 Liechtenstein
  • 103 Sri Lanka
  • 104 Libya
  • 105 Morocco
  • 106 Mali
  • 107 Myanmar
  • 108 Mongolia
  • 109 Macao SAR
  • 110 Maldives
  • 111 Mexico
  • 112 Malaysia
  • 113 Nigeria
  • 114 Nicaragua
  • 115 Nepal
  • 116 New Zealand
  • 117 Oman
  • 118 Panama
  • 119 Peru
  • 120 Philippines
  • 121 Pakistan
  • 122 Puerto Rico
  • 123 Paraguay
  • 124 Qatar
  • 125 Reunion
  • 126 Rwanda
  • 127 Saudi Arabia
  • 128 Singapore
  • 129 Senegal
  • 130 Somalia
  • 131 El Salvador
  • 132 Syria
  • 133 Thailand
  • 134 Tajikistan
  • 135 Turkmenistan
  • 136 Tunisia
  • 137 Trinidad and Tobago
  • 138 Taiwan
  • 139 United States
  • 140 Uruguay
  • 141 Uzbekistan
  • 142 Venezuela
  • 143 Vietnam
  • 144 Yemen
  • 145 South Africa
  • 146 Zimbabwe
  • 147 Guinea-Bissau
  • 148 Angola
  • 149 Cabo Verde
  • 150 Sao Tome and Principe
  • 151 Mozambique
  • 152 Guinea
  • 153 Mauritania
  • 9999 Unknown
number
Priority(default = null) Determines which POI will be displayed on top in GeoDynamics (in case of overlapping POIs).

- No Priority 0 Priority 0 (lowest) 1 Priority 1 2 Priority 2 3 Priority 3 4 Priority 4 5 Priority 5 6 Priority 6 7 Priority 7 8 Priority 8 9 Priority 9 (highest)

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
FieldType
EntityPoi
ValidationResultarray
Allowed values in nested fields
Entity.Country
151 allowed values
  • 0 Belgium
  • 1 France
  • 2 Netherlands
  • 3 Luxembourg
  • 4 Italy
  • 5 Norway
  • 6 Denmark
  • 7 Sweden
  • 8 San Marino
  • 9 Andorra
  • 10 Germany
  • 11 United Kingdom
  • 12 Spain
  • 13 Portugal
  • 14 Switzerland
  • 15 Austria
  • 20 Hungary
  • 21 Czechia
  • 22 Greece
  • 23 Poland
  • 24 Slovakia
  • 25 Turkey
  • 26 Albania
  • 27 Bulgaria
  • 28 Bosnia Herzegovina
  • 29 Belarus
  • 30 Moldova
  • 31 Macedonia
  • 32 Montenegro
  • 33 Romania
  • 34 Serbia
  • 35 Ukraine
  • 36 Finland
  • 37 Ireland
  • 38 Malta
  • 39 Estonia
  • 40 Croatia
  • 41 Lithuania
  • 42 Latvia
  • 43 Slovenia
  • 44 Armenia
  • 45 Azerbaijan
  • 46 Cyprus
  • 47 Faroe Islands
  • 48 Georgia
  • 49 Gibraltar
  • 50 Iceland
  • 51 Monaco
  • 52 Russia
  • 53 Vatican
  • 54 Kosovo
  • 55 United Arab Emirates
  • 56 Afghanistan
  • 57 Argentina
  • 58 Australia
  • 59 Bangladesh
  • 60 Bahrain
  • 61 Brunei
  • 62 Bolivia
  • 63 Brazil
  • 64 Bhutan
  • 65 Botswana
  • 66 Belize
  • 67 Canada
  • 68 Congo
  • 69 Cote d'Ivoire
  • 70 Chile
  • 71 Cameroon
  • 72 China
  • 73 Colombia
  • 74 Costa Rica
  • 75 Cuba
  • 76 Dominican Republic
  • 77 Algeria
  • 78 Ecuador
  • 79 Egypt
  • 80 Eritrea
  • 81 Ethiopia
  • 82 Greenland
  • 83 Guatemala
  • 84 Honduras
  • 85 Haiti
  • 86 Indonesia
  • 87 Israel
  • 88 India
  • 89 Iraq
  • 90 Iran
  • 91 Jamaica
  • 92 Jordan
  • 93 Japan
  • 94 Kenya
  • 95 Kyrgyzstan
  • 96 Cambodia
  • 97 Korea
  • 98 Kuwait
  • 99 Kazakhstan
  • 100 Laos
  • 101 Lebanon
  • 102 Liechtenstein
  • 103 Sri Lanka
  • 104 Libya
  • 105 Morocco
  • 106 Mali
  • 107 Myanmar
  • 108 Mongolia
  • 109 Macao SAR
  • 110 Maldives
  • 111 Mexico
  • 112 Malaysia
  • 113 Nigeria
  • 114 Nicaragua
  • 115 Nepal
  • 116 New Zealand
  • 117 Oman
  • 118 Panama
  • 119 Peru
  • 120 Philippines
  • 121 Pakistan
  • 122 Puerto Rico
  • 123 Paraguay
  • 124 Qatar
  • 125 Reunion
  • 126 Rwanda
  • 127 Saudi Arabia
  • 128 Singapore
  • 129 Senegal
  • 130 Somalia
  • 131 El Salvador
  • 132 Syria
  • 133 Thailand
  • 134 Tajikistan
  • 135 Turkmenistan
  • 136 Tunisia
  • 137 Trinidad and Tobago
  • 138 Taiwan
  • 139 United States
  • 140 Uruguay
  • 141 Uzbekistan
  • 142 Venezuela
  • 143 Vietnam
  • 144 Yemen
  • 145 South Africa
  • 146 Zimbabwe
  • 147 Guinea-Bissau
  • 148 Angola
  • 149 Cabo Verde
  • 150 Sao Tome and Principe
  • 151 Mozambique
  • 152 Guinea
  • 153 Mauritania
  • 9999 Unknown
Entity.Priority

- No Priority 0 Priority 0 (lowest) 1 Priority 1 2 Priority 2 3 Priority 3 4 Priority 4 5 Priority 5 6 Priority 6 7 Priority 7 8 Priority 8 9 Priority 9 (highest)

401Unauthorized
403Forbidden
417ExpectationFailed
429Too Many Requests

Delete point of interest

Deletes a point of interest.

Request body

object

FieldTypeRequired
Idstringrequired
{
  "Id": "00000000-0000-0000-0000-000000000000"
}

Responses

200OK
400BadRequest
FieldType
EntityPoi
ValidationResultarray
Allowed values in nested fields
Entity.Country
151 allowed values
  • 0 Belgium
  • 1 France
  • 2 Netherlands
  • 3 Luxembourg
  • 4 Italy
  • 5 Norway
  • 6 Denmark
  • 7 Sweden
  • 8 San Marino
  • 9 Andorra
  • 10 Germany
  • 11 United Kingdom
  • 12 Spain
  • 13 Portugal
  • 14 Switzerland
  • 15 Austria
  • 20 Hungary
  • 21 Czechia
  • 22 Greece
  • 23 Poland
  • 24 Slovakia
  • 25 Turkey
  • 26 Albania
  • 27 Bulgaria
  • 28 Bosnia Herzegovina
  • 29 Belarus
  • 30 Moldova
  • 31 Macedonia
  • 32 Montenegro
  • 33 Romania
  • 34 Serbia
  • 35 Ukraine
  • 36 Finland
  • 37 Ireland
  • 38 Malta
  • 39 Estonia
  • 40 Croatia
  • 41 Lithuania
  • 42 Latvia
  • 43 Slovenia
  • 44 Armenia
  • 45 Azerbaijan
  • 46 Cyprus
  • 47 Faroe Islands
  • 48 Georgia
  • 49 Gibraltar
  • 50 Iceland
  • 51 Monaco
  • 52 Russia
  • 53 Vatican
  • 54 Kosovo
  • 55 United Arab Emirates
  • 56 Afghanistan
  • 57 Argentina
  • 58 Australia
  • 59 Bangladesh
  • 60 Bahrain
  • 61 Brunei
  • 62 Bolivia
  • 63 Brazil
  • 64 Bhutan
  • 65 Botswana
  • 66 Belize
  • 67 Canada
  • 68 Congo
  • 69 Cote d'Ivoire
  • 70 Chile
  • 71 Cameroon
  • 72 China
  • 73 Colombia
  • 74 Costa Rica
  • 75 Cuba
  • 76 Dominican Republic
  • 77 Algeria
  • 78 Ecuador
  • 79 Egypt
  • 80 Eritrea
  • 81 Ethiopia
  • 82 Greenland
  • 83 Guatemala
  • 84 Honduras
  • 85 Haiti
  • 86 Indonesia
  • 87 Israel
  • 88 India
  • 89 Iraq
  • 90 Iran
  • 91 Jamaica
  • 92 Jordan
  • 93 Japan
  • 94 Kenya
  • 95 Kyrgyzstan
  • 96 Cambodia
  • 97 Korea
  • 98 Kuwait
  • 99 Kazakhstan
  • 100 Laos
  • 101 Lebanon
  • 102 Liechtenstein
  • 103 Sri Lanka
  • 104 Libya
  • 105 Morocco
  • 106 Mali
  • 107 Myanmar
  • 108 Mongolia
  • 109 Macao SAR
  • 110 Maldives
  • 111 Mexico
  • 112 Malaysia
  • 113 Nigeria
  • 114 Nicaragua
  • 115 Nepal
  • 116 New Zealand
  • 117 Oman
  • 118 Panama
  • 119 Peru
  • 120 Philippines
  • 121 Pakistan
  • 122 Puerto Rico
  • 123 Paraguay
  • 124 Qatar
  • 125 Reunion
  • 126 Rwanda
  • 127 Saudi Arabia
  • 128 Singapore
  • 129 Senegal
  • 130 Somalia
  • 131 El Salvador
  • 132 Syria
  • 133 Thailand
  • 134 Tajikistan
  • 135 Turkmenistan
  • 136 Tunisia
  • 137 Trinidad and Tobago
  • 138 Taiwan
  • 139 United States
  • 140 Uruguay
  • 141 Uzbekistan
  • 142 Venezuela
  • 143 Vietnam
  • 144 Yemen
  • 145 South Africa
  • 146 Zimbabwe
  • 147 Guinea-Bissau
  • 148 Angola
  • 149 Cabo Verde
  • 150 Sao Tome and Principe
  • 151 Mozambique
  • 152 Guinea
  • 153 Mauritania
  • 9999 Unknown
Entity.Priority

- No Priority 0 Priority 0 (lowest) 1 Priority 1 2 Priority 2 3 Priority 3 4 Priority 4 5 Priority 5 6 Priority 6 7 Priority 7 8 Priority 8 9 Priority 9 (highest)

401Unauthorized
403Forbidden
417ExpectationFailed
429Too Many Requests

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 = -)

- No Priority 0 Priority 0 (lowest) 1 Priority 1 2 Priority 2 3 Priority 3 4 Priority 4 5 Priority 5 6 Priority 6 7 Priority 7 8 Priority 8 9 Priority 9 (highest)

stringrequired
Description(default = null)stringoptional
{
  "Id": "00000000-0000-0000-0000-000000000000",
  "Name": "Work",
  "Code": "012345",
  "PoiTypeId": "00000000-0000-0000-0000-000000000000",
  "IsAssetLocation": false,
  "Priority": "0",
  "Description": "Work"
}

Responses

200OK
FieldType
Data(default = null)object
Allowed values in nested fields
Data.Country
151 allowed values
  • 0 Belgium
  • 1 France
  • 2 Netherlands
  • 3 Luxembourg
  • 4 Italy
  • 5 Norway
  • 6 Denmark
  • 7 Sweden
  • 8 San Marino
  • 9 Andorra
  • 10 Germany
  • 11 United Kingdom
  • 12 Spain
  • 13 Portugal
  • 14 Switzerland
  • 15 Austria
  • 20 Hungary
  • 21 Czechia
  • 22 Greece
  • 23 Poland
  • 24 Slovakia
  • 25 Turkey
  • 26 Albania
  • 27 Bulgaria
  • 28 Bosnia Herzegovina
  • 29 Belarus
  • 30 Moldova
  • 31 Macedonia
  • 32 Montenegro
  • 33 Romania
  • 34 Serbia
  • 35 Ukraine
  • 36 Finland
  • 37 Ireland
  • 38 Malta
  • 39 Estonia
  • 40 Croatia
  • 41 Lithuania
  • 42 Latvia
  • 43 Slovenia
  • 44 Armenia
  • 45 Azerbaijan
  • 46 Cyprus
  • 47 Faroe Islands
  • 48 Georgia
  • 49 Gibraltar
  • 50 Iceland
  • 51 Monaco
  • 52 Russia
  • 53 Vatican
  • 54 Kosovo
  • 55 United Arab Emirates
  • 56 Afghanistan
  • 57 Argentina
  • 58 Australia
  • 59 Bangladesh
  • 60 Bahrain
  • 61 Brunei
  • 62 Bolivia
  • 63 Brazil
  • 64 Bhutan
  • 65 Botswana
  • 66 Belize
  • 67 Canada
  • 68 Congo
  • 69 Cote d'Ivoire
  • 70 Chile
  • 71 Cameroon
  • 72 China
  • 73 Colombia
  • 74 Costa Rica
  • 75 Cuba
  • 76 Dominican Republic
  • 77 Algeria
  • 78 Ecuador
  • 79 Egypt
  • 80 Eritrea
  • 81 Ethiopia
  • 82 Greenland
  • 83 Guatemala
  • 84 Honduras
  • 85 Haiti
  • 86 Indonesia
  • 87 Israel
  • 88 India
  • 89 Iraq
  • 90 Iran
  • 91 Jamaica
  • 92 Jordan
  • 93 Japan
  • 94 Kenya
  • 95 Kyrgyzstan
  • 96 Cambodia
  • 97 Korea
  • 98 Kuwait
  • 99 Kazakhstan
  • 100 Laos
  • 101 Lebanon
  • 102 Liechtenstein
  • 103 Sri Lanka
  • 104 Libya
  • 105 Morocco
  • 106 Mali
  • 107 Myanmar
  • 108 Mongolia
  • 109 Macao SAR
  • 110 Maldives
  • 111 Mexico
  • 112 Malaysia
  • 113 Nigeria
  • 114 Nicaragua
  • 115 Nepal
  • 116 New Zealand
  • 117 Oman
  • 118 Panama
  • 119 Peru
  • 120 Philippines
  • 121 Pakistan
  • 122 Puerto Rico
  • 123 Paraguay
  • 124 Qatar
  • 125 Reunion
  • 126 Rwanda
  • 127 Saudi Arabia
  • 128 Singapore
  • 129 Senegal
  • 130 Somalia
  • 131 El Salvador
  • 132 Syria
  • 133 Thailand
  • 134 Tajikistan
  • 135 Turkmenistan
  • 136 Tunisia
  • 137 Trinidad and Tobago
  • 138 Taiwan
  • 139 United States
  • 140 Uruguay
  • 141 Uzbekistan
  • 142 Venezuela
  • 143 Vietnam
  • 144 Yemen
  • 145 South Africa
  • 146 Zimbabwe
  • 147 Guinea-Bissau
  • 148 Angola
  • 149 Cabo Verde
  • 150 Sao Tome and Principe
  • 151 Mozambique
  • 152 Guinea
  • 153 Mauritania
  • 9999 Unknown
Data.Priority

- No Priority 0 Priority 0 (lowest) 1 Priority 1 2 Priority 2 3 Priority 3 4 Priority 4 5 Priority 5 6 Priority 6 7 Priority 7 8 Priority 8 9 Priority 9 (highest)

Data.Type.Level

0 Street 1 Suburb 2 City 3 District 4 Province 5 Region 6 Country 7 Continent

{
  "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
FieldType
EntityPoiLiteRequest
ValidationResultarray
Allowed values in nested fields
Entity.Priority

- No Priority 0 Priority 0 (lowest) 1 Priority 1 2 Priority 2 3 Priority 3 4 Priority 4 5 Priority 5 6 Priority 6 7 Priority 7 8 Priority 8 9 Priority 9 (highest)

401Unauthorized
403Forbidden
417ExpectationFailed
429Too Many Requests

Activate point of interest

Re-activates a point of interest.

Request body

string[]

[
  "00000000-0000-0000-0000-000000000000",
  "00000000-0000-0000-0000-000000000000"
]

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
FieldType
EntityPoi
ValidationResultarray
Allowed values in nested fields
Entity.Country
151 allowed values
  • 0 Belgium
  • 1 France
  • 2 Netherlands
  • 3 Luxembourg
  • 4 Italy
  • 5 Norway
  • 6 Denmark
  • 7 Sweden
  • 8 San Marino
  • 9 Andorra
  • 10 Germany
  • 11 United Kingdom
  • 12 Spain
  • 13 Portugal
  • 14 Switzerland
  • 15 Austria
  • 20 Hungary
  • 21 Czechia
  • 22 Greece
  • 23 Poland
  • 24 Slovakia
  • 25 Turkey
  • 26 Albania
  • 27 Bulgaria
  • 28 Bosnia Herzegovina
  • 29 Belarus
  • 30 Moldova
  • 31 Macedonia
  • 32 Montenegro
  • 33 Romania
  • 34 Serbia
  • 35 Ukraine
  • 36 Finland
  • 37 Ireland
  • 38 Malta
  • 39 Estonia
  • 40 Croatia
  • 41 Lithuania
  • 42 Latvia
  • 43 Slovenia
  • 44 Armenia
  • 45 Azerbaijan
  • 46 Cyprus
  • 47 Faroe Islands
  • 48 Georgia
  • 49 Gibraltar
  • 50 Iceland
  • 51 Monaco
  • 52 Russia
  • 53 Vatican
  • 54 Kosovo
  • 55 United Arab Emirates
  • 56 Afghanistan
  • 57 Argentina
  • 58 Australia
  • 59 Bangladesh
  • 60 Bahrain
  • 61 Brunei
  • 62 Bolivia
  • 63 Brazil
  • 64 Bhutan
  • 65 Botswana
  • 66 Belize
  • 67 Canada
  • 68 Congo
  • 69 Cote d'Ivoire
  • 70 Chile
  • 71 Cameroon
  • 72 China
  • 73 Colombia
  • 74 Costa Rica
  • 75 Cuba
  • 76 Dominican Republic
  • 77 Algeria
  • 78 Ecuador
  • 79 Egypt
  • 80 Eritrea
  • 81 Ethiopia
  • 82 Greenland
  • 83 Guatemala
  • 84 Honduras
  • 85 Haiti
  • 86 Indonesia
  • 87 Israel
  • 88 India
  • 89 Iraq
  • 90 Iran
  • 91 Jamaica
  • 92 Jordan
  • 93 Japan
  • 94 Kenya
  • 95 Kyrgyzstan
  • 96 Cambodia
  • 97 Korea
  • 98 Kuwait
  • 99 Kazakhstan
  • 100 Laos
  • 101 Lebanon
  • 102 Liechtenstein
  • 103 Sri Lanka
  • 104 Libya
  • 105 Morocco
  • 106 Mali
  • 107 Myanmar
  • 108 Mongolia
  • 109 Macao SAR
  • 110 Maldives
  • 111 Mexico
  • 112 Malaysia
  • 113 Nigeria
  • 114 Nicaragua
  • 115 Nepal
  • 116 New Zealand
  • 117 Oman
  • 118 Panama
  • 119 Peru
  • 120 Philippines
  • 121 Pakistan
  • 122 Puerto Rico
  • 123 Paraguay
  • 124 Qatar
  • 125 Reunion
  • 126 Rwanda
  • 127 Saudi Arabia
  • 128 Singapore
  • 129 Senegal
  • 130 Somalia
  • 131 El Salvador
  • 132 Syria
  • 133 Thailand
  • 134 Tajikistan
  • 135 Turkmenistan
  • 136 Tunisia
  • 137 Trinidad and Tobago
  • 138 Taiwan
  • 139 United States
  • 140 Uruguay
  • 141 Uzbekistan
  • 142 Venezuela
  • 143 Vietnam
  • 144 Yemen
  • 145 South Africa
  • 146 Zimbabwe
  • 147 Guinea-Bissau
  • 148 Angola
  • 149 Cabo Verde
  • 150 Sao Tome and Principe
  • 151 Mozambique
  • 152 Guinea
  • 153 Mauritania
  • 9999 Unknown
Entity.Priority

- No Priority 0 Priority 0 (lowest) 1 Priority 1 2 Priority 2 3 Priority 3 4 Priority 4 5 Priority 5 6 Priority 6 7 Priority 7 8 Priority 8 9 Priority 9 (highest)

Entity.Type.Level

0 Street 1 Suburb 2 City 3 District 4 Province 5 Region 6 Country 7 Continent

401Unauthorized
403Forbidden
417ExpectationFailed
429Too Many Requests

Deactivate point of interest

Deactivates a point of interest.

Request body

string[]

[
  "00000000-0000-0000-0000-000000000000",
  "00000000-0000-0000-0000-000000000000"
]

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
FieldType
EntityPoi
ValidationResultarray
Allowed values in nested fields
Entity.Country
151 allowed values
  • 0 Belgium
  • 1 France
  • 2 Netherlands
  • 3 Luxembourg
  • 4 Italy
  • 5 Norway
  • 6 Denmark
  • 7 Sweden
  • 8 San Marino
  • 9 Andorra
  • 10 Germany
  • 11 United Kingdom
  • 12 Spain
  • 13 Portugal
  • 14 Switzerland
  • 15 Austria
  • 20 Hungary
  • 21 Czechia
  • 22 Greece
  • 23 Poland
  • 24 Slovakia
  • 25 Turkey
  • 26 Albania
  • 27 Bulgaria
  • 28 Bosnia Herzegovina
  • 29 Belarus
  • 30 Moldova
  • 31 Macedonia
  • 32 Montenegro
  • 33 Romania
  • 34 Serbia
  • 35 Ukraine
  • 36 Finland
  • 37 Ireland
  • 38 Malta
  • 39 Estonia
  • 40 Croatia
  • 41 Lithuania
  • 42 Latvia
  • 43 Slovenia
  • 44 Armenia
  • 45 Azerbaijan
  • 46 Cyprus
  • 47 Faroe Islands
  • 48 Georgia
  • 49 Gibraltar
  • 50 Iceland
  • 51 Monaco
  • 52 Russia
  • 53 Vatican
  • 54 Kosovo
  • 55 United Arab Emirates
  • 56 Afghanistan
  • 57 Argentina
  • 58 Australia
  • 59 Bangladesh
  • 60 Bahrain
  • 61 Brunei
  • 62 Bolivia
  • 63 Brazil
  • 64 Bhutan
  • 65 Botswana
  • 66 Belize
  • 67 Canada
  • 68 Congo
  • 69 Cote d'Ivoire
  • 70 Chile
  • 71 Cameroon
  • 72 China
  • 73 Colombia
  • 74 Costa Rica
  • 75 Cuba
  • 76 Dominican Republic
  • 77 Algeria
  • 78 Ecuador
  • 79 Egypt
  • 80 Eritrea
  • 81 Ethiopia
  • 82 Greenland
  • 83 Guatemala
  • 84 Honduras
  • 85 Haiti
  • 86 Indonesia
  • 87 Israel
  • 88 India
  • 89 Iraq
  • 90 Iran
  • 91 Jamaica
  • 92 Jordan
  • 93 Japan
  • 94 Kenya
  • 95 Kyrgyzstan
  • 96 Cambodia
  • 97 Korea
  • 98 Kuwait
  • 99 Kazakhstan
  • 100 Laos
  • 101 Lebanon
  • 102 Liechtenstein
  • 103 Sri Lanka
  • 104 Libya
  • 105 Morocco
  • 106 Mali
  • 107 Myanmar
  • 108 Mongolia
  • 109 Macao SAR
  • 110 Maldives
  • 111 Mexico
  • 112 Malaysia
  • 113 Nigeria
  • 114 Nicaragua
  • 115 Nepal
  • 116 New Zealand
  • 117 Oman
  • 118 Panama
  • 119 Peru
  • 120 Philippines
  • 121 Pakistan
  • 122 Puerto Rico
  • 123 Paraguay
  • 124 Qatar
  • 125 Reunion
  • 126 Rwanda
  • 127 Saudi Arabia
  • 128 Singapore
  • 129 Senegal
  • 130 Somalia
  • 131 El Salvador
  • 132 Syria
  • 133 Thailand
  • 134 Tajikistan
  • 135 Turkmenistan
  • 136 Tunisia
  • 137 Trinidad and Tobago
  • 138 Taiwan
  • 139 United States
  • 140 Uruguay
  • 141 Uzbekistan
  • 142 Venezuela
  • 143 Vietnam
  • 144 Yemen
  • 145 South Africa
  • 146 Zimbabwe
  • 147 Guinea-Bissau
  • 148 Angola
  • 149 Cabo Verde
  • 150 Sao Tome and Principe
  • 151 Mozambique
  • 152 Guinea
  • 153 Mauritania
  • 9999 Unknown
Entity.Priority

- No Priority 0 Priority 0 (lowest) 1 Priority 1 2 Priority 2 3 Priority 3 4 Priority 4 5 Priority 5 6 Priority 6 7 Priority 7 8 Priority 8 9 Priority 9 (highest)

Entity.Type.Level

0 Street 1 Suburb 2 City 3 District 4 Province 5 Region 6 Country 7 Continent

401Unauthorized
403Forbidden
417ExpectationFailed
429Too Many Requests

Poi groups

GEThttps://api.geodynamics.dev/intellitracer/v1/poigroupApi: Poi's read or Api: Poi's edit

Get point of interest groups

Returns a list of all point of interest groups.

Responses

200OK
FieldType
Idstring
Namestring
Pois(default = [])Poi[]
NumberOfPois(default = 0)number
_typeDescriptorstring
Allowed values in nested fields
Pois[].Country
151 allowed values
  • 0 Belgium
  • 1 France
  • 2 Netherlands
  • 3 Luxembourg
  • 4 Italy
  • 5 Norway
  • 6 Denmark
  • 7 Sweden
  • 8 San Marino
  • 9 Andorra
  • 10 Germany
  • 11 United Kingdom
  • 12 Spain
  • 13 Portugal
  • 14 Switzerland
  • 15 Austria
  • 20 Hungary
  • 21 Czechia
  • 22 Greece
  • 23 Poland
  • 24 Slovakia
  • 25 Turkey
  • 26 Albania
  • 27 Bulgaria
  • 28 Bosnia Herzegovina
  • 29 Belarus
  • 30 Moldova
  • 31 Macedonia
  • 32 Montenegro
  • 33 Romania
  • 34 Serbia
  • 35 Ukraine
  • 36 Finland
  • 37 Ireland
  • 38 Malta
  • 39 Estonia
  • 40 Croatia
  • 41 Lithuania
  • 42 Latvia
  • 43 Slovenia
  • 44 Armenia
  • 45 Azerbaijan
  • 46 Cyprus
  • 47 Faroe Islands
  • 48 Georgia
  • 49 Gibraltar
  • 50 Iceland
  • 51 Monaco
  • 52 Russia
  • 53 Vatican
  • 54 Kosovo
  • 55 United Arab Emirates
  • 56 Afghanistan
  • 57 Argentina
  • 58 Australia
  • 59 Bangladesh
  • 60 Bahrain
  • 61 Brunei
  • 62 Bolivia
  • 63 Brazil
  • 64 Bhutan
  • 65 Botswana
  • 66 Belize
  • 67 Canada
  • 68 Congo
  • 69 Cote d'Ivoire
  • 70 Chile
  • 71 Cameroon
  • 72 China
  • 73 Colombia
  • 74 Costa Rica
  • 75 Cuba
  • 76 Dominican Republic
  • 77 Algeria
  • 78 Ecuador
  • 79 Egypt
  • 80 Eritrea
  • 81 Ethiopia
  • 82 Greenland
  • 83 Guatemala
  • 84 Honduras
  • 85 Haiti
  • 86 Indonesia
  • 87 Israel
  • 88 India
  • 89 Iraq
  • 90 Iran
  • 91 Jamaica
  • 92 Jordan
  • 93 Japan
  • 94 Kenya
  • 95 Kyrgyzstan
  • 96 Cambodia
  • 97 Korea
  • 98 Kuwait
  • 99 Kazakhstan
  • 100 Laos
  • 101 Lebanon
  • 102 Liechtenstein
  • 103 Sri Lanka
  • 104 Libya
  • 105 Morocco
  • 106 Mali
  • 107 Myanmar
  • 108 Mongolia
  • 109 Macao SAR
  • 110 Maldives
  • 111 Mexico
  • 112 Malaysia
  • 113 Nigeria
  • 114 Nicaragua
  • 115 Nepal
  • 116 New Zealand
  • 117 Oman
  • 118 Panama
  • 119 Peru
  • 120 Philippines
  • 121 Pakistan
  • 122 Puerto Rico
  • 123 Paraguay
  • 124 Qatar
  • 125 Reunion
  • 126 Rwanda
  • 127 Saudi Arabia
  • 128 Singapore
  • 129 Senegal
  • 130 Somalia
  • 131 El Salvador
  • 132 Syria
  • 133 Thailand
  • 134 Tajikistan
  • 135 Turkmenistan
  • 136 Tunisia
  • 137 Trinidad and Tobago
  • 138 Taiwan
  • 139 United States
  • 140 Uruguay
  • 141 Uzbekistan
  • 142 Venezuela
  • 143 Vietnam
  • 144 Yemen
  • 145 South Africa
  • 146 Zimbabwe
  • 147 Guinea-Bissau
  • 148 Angola
  • 149 Cabo Verde
  • 150 Sao Tome and Principe
  • 151 Mozambique
  • 152 Guinea
  • 153 Mauritania
  • 9999 Unknown
Pois[].Priority

- No Priority 0 Priority 0 (lowest) 1 Priority 1 2 Priority 2 3 Priority 3 4 Priority 4 5 Priority 5 6 Priority 6 7 Priority 7 8 Priority 8 9 Priority 9 (highest)

[
  {
    "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
429Too Many Requests

Update point of interest group

Updates a point of interest group.

Request body

object

FieldTypeRequired
Namestringrequired
Idstringrequired
{
  "Name": "Work places",
  "Id": "00000000-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
}
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
429Too Many Requests

Create point of interest group

Creates a new point of interest group.

Request body

object

FieldTypeRequired
Namestringrequired
{
  "Name": "Work places"
}

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
429Too Many Requests

Delete point of interest group

Deletes a point of interest group.

Request body

object

FieldTypeRequired
Idstringrequired
{
  "Id": "00000000-0000-0000-0000-000000000000"
}

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
429Too Many Requests

Get point of interest group

Returns a point of interest group by id.

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
429Too Many Requests

Poi group - Pois

Get pois of poi group

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

Path parameters

NameTypeRequiredExample
idstringrequired00000000-0000-0000-0000-000000000000

Responses

200OK
FieldType
Idstring
Namestring
[
  {
    "Id": "00000000-0000-0000-0000-000000000000",
    "Name": "Work"
  }
]
401Unauthorized
403Forbidden
429Too Many Requests

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

object

FieldTypeRequired
Items(default = [])arrayoptional
AddAll(default = false)booleanoptional
SearchString(default = null)stringoptional
{
  "Items": [
    "00000000-0000-0000-0000-000000000000",
    "00000000-0000-0000-0000-000000000000"
  ],
  "AddAll": false,
  "SearchString": null
}

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
429Too Many Requests

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

object

FieldTypeRequired
Items(default = [])arrayoptional
DeleteAll(default = false)booleanoptional
SearchString(default = null)stringoptional
{
  "Items": [
    "00000000-0000-0000-0000-000000000000",
    "00000000-0000-0000-0000-000000000000"
  ],
  "DeleteAll": false,
  "SearchString": null
}

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
429Too Many Requests

Poi types

GEThttps://api.geodynamics.dev/intellitracer/v1/poitypeApi: Poi's read or Api: Poi's edit

Get point of interest types

Returns a list of all point of interest types.

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
429Too Many Requests

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
{
  "Name": "Work place",
  "Color": "#00FF2F",
  "Id": "00000000-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"
}
400BadRequest
FieldType
Entityobject
ValidationResultarray
{
  "Entity": {
    "Id": "00000000-0000-0000-0000-000000000000",
    "Name": "Work place",
    "Color": "#00FF2F"
  },
  "ValidationResult": [
    {
      "Message": "",
      "SourceMemberNames": []
    }
  ]
}
401Unauthorized
403Forbidden
417ExpectationFailed
429Too Many Requests

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
{
  "Name": "Work place",
  "Color": "#00FF2F"
}

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
429Too Many Requests

Delete point of interest type

Deletes a point of interest type.

Request body

object

FieldTypeRequired
Idstringrequired
{
  "Id": "00000000-0000-0000-0000-000000000000"
}

Responses

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

Get point of interest type

Returns a point of interest type by id.

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
429Too Many Requests

RFID tags

Get RFID tag

Returns an RFID tag by id.

Path parameters

NameTypeRequiredExample
idstringrequired00000000-0000-0000-0000-000000000000

Responses

200OK
FieldType
Dataobject
Allowed values in nested fields
Data.Type
13 allowed values
  • 0 Passive 1356 Mhz Mifare
  • 1 Passive 125 Khz Proximity
  • 2 H Id
  • 3 Active Tag Ingecom
  • 4 Active RFID Tag Wavetrend
  • 5 Active/Passive Wavetrend
  • 6 iButton
  • 7 HID Prox
  • 8 NFC NTag 21x
  • 9 BLE
  • 10 BLE IET10
  • 11 BLE ELA
  • 12 EID BE
Data.User.Type

0 User 1 Vehicle 2 Timeclock 3 Asset 4 Ivr phone number 5 Cost center 6 Work place 7 Mobile clocking

{
  "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
417ExpectationFailed
429Too Many Requests

Delete RFID tag

Deletes an RFID tag.

Path parameters

NameTypeRequiredExample
idstringrequired00000000-0000-0000-0000-000000000000

Responses

200OK
FieldType
Dataobject
Allowed values in nested fields
Data.Type
13 allowed values
  • 0 Passive 1356 Mhz Mifare
  • 1 Passive 125 Khz Proximity
  • 2 H Id
  • 3 Active Tag Ingecom
  • 4 Active RFID Tag Wavetrend
  • 5 Active/Passive Wavetrend
  • 6 iButton
  • 7 HID Prox
  • 8 NFC NTag 21x
  • 9 BLE
  • 10 BLE IET10
  • 11 BLE ELA
  • 12 EID BE
Data.User.Type

0 User 1 Vehicle 2 Timeclock 3 Asset 4 Ivr phone number 5 Cost center 6 Work place 7 Mobile clocking

{
  "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
Allowed values in nested fields
Entity.Type
13 allowed values
  • 0 Passive 1356 Mhz Mifare
  • 1 Passive 125 Khz Proximity
  • 2 H Id
  • 3 Active Tag Ingecom
  • 4 Active RFID Tag Wavetrend
  • 5 Active/Passive Wavetrend
  • 6 iButton
  • 7 HID Prox
  • 8 NFC NTag 21x
  • 9 BLE
  • 10 BLE IET10
  • 11 BLE ELA
  • 12 EID BE
{
  "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
429Too Many Requests

Update RFID tag

Updates an RFID tag.

Request body

object

FieldTypeRequired
Idstringrequired
InternalNumberstringrequired
ExternalNumber(default = null)stringoptional
Type
13 allowed values
  • 0 Passive 1356 Mhz Mifare
  • 1 Passive 125 Khz Proximity
  • 2 H Id
  • 3 Active Tag Ingecom
  • 4 Active RFID Tag Wavetrend
  • 5 Active/Passive Wavetrend
  • 6 iButton
  • 7 HID Prox
  • 8 NFC NTag 21x
  • 9 BLE
  • 10 BLE IET10
  • 11 BLE ELA
  • 12 EID BE
numberrequired
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
{
  "Id": "00000000-0000-0000-0000-000000000000",
  "InternalNumber": "00AA11BB",
  "ExternalNumber": "12345678",
  "Type": 0,
  "BeaconRateSeconds": "15.0",
  "SiteCode": "1234",
  "PassiveTagNumber": "123456789",
  "MacAddress": "AABBCCDDEEFF"
}

Responses

200OK
FieldType
Dataobject
Allowed values in nested fields
Data.Type
13 allowed values
  • 0 Passive 1356 Mhz Mifare
  • 1 Passive 125 Khz Proximity
  • 2 H Id
  • 3 Active Tag Ingecom
  • 4 Active RFID Tag Wavetrend
  • 5 Active/Passive Wavetrend
  • 6 iButton
  • 7 HID Prox
  • 8 NFC NTag 21x
  • 9 BLE
  • 10 BLE IET10
  • 11 BLE ELA
  • 12 EID BE
Data.User.Type

0 User 1 Vehicle 2 Timeclock 3 Asset 4 Ivr phone number 5 Cost center 6 Work place 7 Mobile clocking

{
  "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
Allowed values in nested fields
Entity.Type
13 allowed values
  • 0 Passive 1356 Mhz Mifare
  • 1 Passive 125 Khz Proximity
  • 2 H Id
  • 3 Active Tag Ingecom
  • 4 Active RFID Tag Wavetrend
  • 5 Active/Passive Wavetrend
  • 6 iButton
  • 7 HID Prox
  • 8 NFC NTag 21x
  • 9 BLE
  • 10 BLE IET10
  • 11 BLE ELA
  • 12 EID BE
{
  "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
429Too Many Requests

Create RFID tag

Creates a new RFID tag.

Request body

object

FieldTypeRequired
Idstringoptional
InternalNumberstringrequired
ExternalNumber(default = null)stringoptional
Type
13 allowed values
  • 0 Passive 1356 Mhz Mifare
  • 1 Passive 125 Khz Proximity
  • 2 H Id
  • 3 Active Tag Ingecom
  • 4 Active RFID Tag Wavetrend
  • 5 Active/Passive Wavetrend
  • 6 iButton
  • 7 HID Prox
  • 8 NFC NTag 21x
  • 9 BLE
  • 10 BLE IET10
  • 11 BLE ELA
  • 12 EID BE
numberrequired
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
{
  "Id": "00000000-0000-0000-0000-000000000000",
  "InternalNumber": "00AA11BB",
  "ExternalNumber": "12345678",
  "Type": 0,
  "BeaconRateSeconds": "15.0",
  "SiteCode": "1234",
  "PassiveTagNumber": "123456789",
  "MacAddress": "AABBCCDDEEFF"
}

Responses

200OK
FieldType
Dataobject
Allowed values in nested fields
Data.Type
13 allowed values
  • 0 Passive 1356 Mhz Mifare
  • 1 Passive 125 Khz Proximity
  • 2 H Id
  • 3 Active Tag Ingecom
  • 4 Active RFID Tag Wavetrend
  • 5 Active/Passive Wavetrend
  • 6 iButton
  • 7 HID Prox
  • 8 NFC NTag 21x
  • 9 BLE
  • 10 BLE IET10
  • 11 BLE ELA
  • 12 EID BE
Data.User.Type

0 User 1 Vehicle 2 Timeclock 3 Asset 4 Ivr phone number 5 Cost center 6 Work place 7 Mobile clocking

{
  "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
Allowed values in nested fields
Entity.Type
13 allowed values
  • 0 Passive 1356 Mhz Mifare
  • 1 Passive 125 Khz Proximity
  • 2 H Id
  • 3 Active Tag Ingecom
  • 4 Active RFID Tag Wavetrend
  • 5 Active/Passive Wavetrend
  • 6 iButton
  • 7 HID Prox
  • 8 NFC NTag 21x
  • 9 BLE
  • 10 BLE IET10
  • 11 BLE ELA
  • 12 EID BE
{
  "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
429Too Many Requests

RFID tags - User

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
417ExpectationFailed
429Too Many Requests

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
{
  "BadgeId": "00000000-0000-0000-0000-000000000000",
  "InternalNumber": "00AA11BB",
  "OverrideExistingUser": false
}

Responses

200OK
FieldType
Dataobject
Allowed values in nested fields
Data.Type
13 allowed values
  • 0 Passive 1356 Mhz Mifare
  • 1 Passive 125 Khz Proximity
  • 2 H Id
  • 3 Active Tag Ingecom
  • 4 Active RFID Tag Wavetrend
  • 5 Active/Passive Wavetrend
  • 6 iButton
  • 7 HID Prox
  • 8 NFC NTag 21x
  • 9 BLE
  • 10 BLE IET10
  • 11 BLE ELA
  • 12 EID BE
Data.User.Type

0 User 1 Vehicle 2 Timeclock 3 Asset 4 Ivr phone number 5 Cost center 6 Work place 7 Mobile clocking

{
  "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
Allowed values in nested fields
Entity.Type
13 allowed values
  • 0 Passive 1356 Mhz Mifare
  • 1 Passive 125 Khz Proximity
  • 2 H Id
  • 3 Active Tag Ingecom
  • 4 Active RFID Tag Wavetrend
  • 5 Active/Passive Wavetrend
  • 6 iButton
  • 7 HID Prox
  • 8 NFC NTag 21x
  • 9 BLE
  • 10 BLE IET10
  • 11 BLE ELA
  • 12 EID BE
{
  "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
429Too Many Requests

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
{
  "BadgeId": "00000000-0000-0000-0000-000000000000",
  "InternalNumber": "00AA11BB"
}

Responses

200OK
FieldType
Dataobject
Allowed values in nested fields
Data.Type
13 allowed values
  • 0 Passive 1356 Mhz Mifare
  • 1 Passive 125 Khz Proximity
  • 2 H Id
  • 3 Active Tag Ingecom
  • 4 Active RFID Tag Wavetrend
  • 5 Active/Passive Wavetrend
  • 6 iButton
  • 7 HID Prox
  • 8 NFC NTag 21x
  • 9 BLE
  • 10 BLE IET10
  • 11 BLE ELA
  • 12 EID BE
Data.User.Type

0 User 1 Vehicle 2 Timeclock 3 Asset 4 Ivr phone number 5 Cost center 6 Work place 7 Mobile clocking

{
  "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
Allowed values in nested fields
Entity.Type
13 allowed values
  • 0 Passive 1356 Mhz Mifare
  • 1 Passive 125 Khz Proximity
  • 2 H Id
  • 3 Active Tag Ingecom
  • 4 Active RFID Tag Wavetrend
  • 5 Active/Passive Wavetrend
  • 6 iButton
  • 7 HID Prox
  • 8 NFC NTag 21x
  • 9 BLE
  • 10 BLE IET10
  • 11 BLE ELA
  • 12 EID BE
{
  "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
429Too Many Requests

RFID scanners

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
429Too Many Requests

Update mobile RFID scanner

Updates a mobile RFID scanner.

Request body

object

FieldTypeRequired
Idstringrequired
CurrentUserIdstringoptional
CostCenterIdstringoptional
{
  "Id": "00000000-0000-0000-0000-000000000000",
  "CurrentUserId": "00000000-0000-0000-0000-000000000000",
  "CostCenterId": "00000000-0000-0000-0000-000000000000"
}

Responses

200OK
FieldType
Idstring
UnitIdstring
UserUserLite
CostCenterCostCenterLite
{
  "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
Allowed values in nested fields
Entity.Type

0 Folder 1 Job - No input 2 Job - With input 3 Job - With POI 4 Job - With Cost center 5 Job - With Planning 6 Start External 7 Stop External 8 Start Travel Time 9 Stop Travel Time 10 Separator

Entity.InputFilter

0 Free field 1 Numeric only 2 Hexadecimal only 3 Numeric and Symbols only

Entity.InputType

0 Scan and input 1 Input only 2 Scan only

Entity.ClockingType
19 allowed values
  • 0 Default
  • 1 Start work
  • 2 Stop work
  • 3 Start activity
  • 4 Stop activity
  • 5 Start break
  • 6 Stop break
  • 7 Start absence
  • 8 Stop absence
  • 11 Stop activity break
  • 12 Start movement driver
  • 13 Start movement passenger
  • 14 Stop movement
  • 15 Switch activity
  • 16 Finish activity
  • 17 Start external
  • 18 Stop external
  • 19 Start travel time
  • 20 Stop travel time
Entity.ExternalType

0 Log Moment 1 Custom 2 Mobility

{
  "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
429Too Many Requests

Smartphones

Get smartphone

Returns a smartphone clocking device by id.

Only usable when the Self Service App is disabled for the company. With the Self Service App enabled, the endpoint answers 400.

Path parameters

NameTypeRequiredExample
idstringrequired00000000-0000-0000-0000-000000000000

Responses

200OK
FieldType
Idstring
Namestring
UIdstring
Active(default = true)boolean
Type(default = 0)

0 Android 1 iOS

number
Orientation(default = 0)

0 Use default 1 Portrait 2 Landscape 3 Landscape (reversed)

number
FilterMenusByUserFilter(default = false)boolean
UserIdentification(default = 0)

0 Use default 1 Fixed user 2 User identification

number
UserIdentificationConfig(default = null)object
ResourceDetection(default = 0)

0 Use default 1 Retain smartphone clocking device 2 Fixed vehicle 3 User's last clocking resource 4 Available vehicles (allowed vehicles) 5 Vehicle from list

number
ResourceDetectionConfig(default = null)object
Positioning(default = 0)

0 Use default 1 Device's GPS 2 Position of the connected vehicle 3 User's last car clocking 4 Connected to a point of interest

number
PositioningConfig(default = null)object
Team(default = 0)

0 Use default 1 User only 2 All available users

number
TeamConfig(default = null)object
TimeRegistration(default = 0)

0 Use default 1 Use menu 2 Use default clocking

number
TimeRegistrationConfig(default = null)object
CostCenterobject
Allowed values in nested fields
UserIdentificationConfig.FixedUser.Type

0 User 1 Vehicle 2 Timeclock 3 Asset 4 Ivr phone number 5 Cost center 6 Work place 7 Mobile clocking

ResourceDetectionConfig.FixedVehicle.Type

0 User 1 Vehicle 2 Timeclock 3 Asset 4 Ivr phone number 5 Cost center 6 Work place 7 Mobile clocking

CostCenter.Type

0 User 1 Vehicle 2 Timeclock 3 Asset 4 Ivr phone number 5 Cost center 6 Work place 7 Mobile clocking

{
  "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
401Unauthorized
403Forbidden
417ExpectationFailed
429Too Many Requests

Delete smartphone

Deletes a smartphone clocking device.

Only usable when the Self Service App is disabled for the company. With the Self Service App enabled, the endpoint answers 400.

Path parameters

NameTypeRequiredExample
idstringrequired00000000-0000-0000-0000-000000000000

Responses

200OK
FieldType
Idstring
Namestring
UIdstring
Active(default = true)boolean
Type(default = 0)

0 Android 1 iOS

number
Orientation(default = 0)

0 Use default 1 Portrait 2 Landscape 3 Landscape (reversed)

number
FilterMenusByUserFilter(default = false)boolean
UserIdentification(default = 0)

0 Use default 1 Fixed user 2 User identification

number
UserIdentificationConfig(default = null)object
ResourceDetection(default = 0)

0 Use default 1 Retain smartphone clocking device 2 Fixed vehicle 3 User's last clocking resource 4 Available vehicles (allowed vehicles) 5 Vehicle from list

number
ResourceDetectionConfig(default = null)object
Positioning(default = 0)

0 Use default 1 Device's GPS 2 Position of the connected vehicle 3 User's last car clocking 4 Connected to a point of interest

number
PositioningConfig(default = null)object
Team(default = 0)

0 Use default 1 User only 2 All available users

number
TeamConfig(default = null)object
TimeRegistration(default = 0)

0 Use default 1 Use menu 2 Use default clocking

number
TimeRegistrationConfig(default = null)object
CostCenterobject
Allowed values in nested fields
UserIdentificationConfig.FixedUser.Type

0 User 1 Vehicle 2 Timeclock 3 Asset 4 Ivr phone number 5 Cost center 6 Work place 7 Mobile clocking

ResourceDetectionConfig.FixedVehicle.Type

0 User 1 Vehicle 2 Timeclock 3 Asset 4 Ivr phone number 5 Cost center 6 Work place 7 Mobile clocking

CostCenter.Type

0 User 1 Vehicle 2 Timeclock 3 Asset 4 Ivr phone number 5 Cost center 6 Work place 7 Mobile clocking

{
  "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
Allowed values in nested fields
Entity.Type

0 Android 1 iOS

Entity.Orientation

0 Use default 1 Portrait 2 Landscape 3 Landscape (reversed)

Entity.UserIdentification

0 Use default 1 Fixed user 2 User identification

Entity.ResourceDetection

0 Use default 1 Retain smartphone clocking device 2 Fixed vehicle 3 User's last clocking resource 4 Available vehicles (allowed vehicles) 5 Vehicle from list

Entity.Positioning

0 Use default 1 Device's GPS 2 Position of the connected vehicle 3 User's last car clocking 4 Connected to a point of interest

Entity.Team

0 Use default 1 User only 2 All available users

Entity.TimeRegistration

0 Use default 1 Use menu 2 Use default clocking

{
  "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
429Too Many Requests

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).

Only usable when the Self Service App is disabled for the company. With the Self Service App enabled, the endpoint answers 400.

Request body

object

FieldTypeRequired
Idstringrequired
Namestringrequired
UIdstringrequired
Active(default = true)booleanoptional
Type(default = 0)

0 Android 1 iOS

numberoptional
Orientation(default = 0)

0 Use default 1 Portrait 2 Landscape 3 Landscape (reversed)

numberoptional
FilterMenusByUserFilter(default = false)booleanoptional
UserIdentification(default = 0)

0 Use default 1 Fixed user 2 User identification

numberoptional
UserIdentificationConfig(default = null)objectoptional
ResourceDetection(default = 0)

0 Use default 1 Retain smartphone clocking device 2 Fixed vehicle 3 User's last clocking resource 4 Available vehicles (allowed vehicles) 5 Vehicle from list

numberoptional
ResourceDetectionConfig(default = null)objectoptional
Positioning(default = 0)

0 Use default 1 Device's GPS 2 Position of the connected vehicle 3 User's last car clocking 4 Connected to a point of interest

numberoptional
PositioningConfig(default = null)objectoptional
Team(default = 0)

0 Use default 1 User only 2 All available users

numberoptional
TeamConfig(default = null)objectoptional
TimeRegistration(default = 0)

0 Use default 1 Use menu 2 Use default clocking

numberoptional
TimeRegistrationConfig(default = null)objectoptional
CostCenterIdstringoptional
{
  "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"
}

Responses

200OK
FieldType
Idstring
Namestring
UIdstring
Active(default = true)boolean
Type(default = 0)

0 Android 1 iOS

number
Orientation(default = 0)

0 Use default 1 Portrait 2 Landscape 3 Landscape (reversed)

number
FilterMenusByUserFilter(default = false)boolean
UserIdentification(default = 0)

0 Use default 1 Fixed user 2 User identification

number
UserIdentificationConfig(default = null)object
ResourceDetection(default = 0)

0 Use default 1 Retain smartphone clocking device 2 Fixed vehicle 3 User's last clocking resource 4 Available vehicles (allowed vehicles) 5 Vehicle from list

number
ResourceDetectionConfig(default = null)object
Positioning(default = 0)

0 Use default 1 Device's GPS 2 Position of the connected vehicle 3 User's last car clocking 4 Connected to a point of interest

number
PositioningConfig(default = null)object
Team(default = 0)

0 Use default 1 User only 2 All available users

number
TeamConfig(default = null)object
TimeRegistration(default = 0)

0 Use default 1 Use menu 2 Use default clocking

number
TimeRegistrationConfig(default = null)object
CostCenterobject
Allowed values in nested fields
UserIdentificationConfig.FixedUser.Type

0 User 1 Vehicle 2 Timeclock 3 Asset 4 Ivr phone number 5 Cost center 6 Work place 7 Mobile clocking

ResourceDetectionConfig.FixedVehicle.Type

0 User 1 Vehicle 2 Timeclock 3 Asset 4 Ivr phone number 5 Cost center 6 Work place 7 Mobile clocking

CostCenter.Type

0 User 1 Vehicle 2 Timeclock 3 Asset 4 Ivr phone number 5 Cost center 6 Work place 7 Mobile clocking

{
  "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
Allowed values in nested fields
Entity.Type

0 Android 1 iOS

Entity.Orientation

0 Use default 1 Portrait 2 Landscape 3 Landscape (reversed)

Entity.UserIdentification

0 Use default 1 Fixed user 2 User identification

Entity.ResourceDetection

0 Use default 1 Retain smartphone clocking device 2 Fixed vehicle 3 User's last clocking resource 4 Available vehicles (allowed vehicles) 5 Vehicle from list

Entity.Positioning

0 Use default 1 Device's GPS 2 Position of the connected vehicle 3 User's last car clocking 4 Connected to a point of interest

Entity.Team

0 Use default 1 User only 2 All available users

Entity.TimeRegistration

0 Use default 1 Use menu 2 Use default clocking

{
  "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
429Too Many Requests

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).

Only usable when the Self Service App is disabled for the company. With the Self Service App enabled, the endpoint answers 400.

Request body

object

FieldTypeRequired
Idstringoptional
Namestringrequired
UIdstringrequired
Active(default = true)booleanoptional
Type(default = 0)

0 Android 1 iOS

numberoptional
Orientation(default = 0)

0 Use default 1 Portrait 2 Landscape 3 Landscape (reversed)

numberoptional
FilterMenusByUserFilter(default = false)booleanoptional
UserIdentification(default = 0)

0 Use default 1 Fixed user 2 User identification

numberoptional
UserIdentificationConfig(default = null)objectoptional
ResourceDetection(default = 0)

0 Use default 1 Retain smartphone clocking device 2 Fixed vehicle 3 User's last clocking resource 4 Available vehicles (allowed vehicles) 5 Vehicle from list

numberoptional
ResourceDetectionConfig(default = null)objectoptional
Positioning(default = 0)

0 Use default 1 Device's GPS 2 Position of the connected vehicle 3 User's last car clocking 4 Connected to a point of interest

numberoptional
PositioningConfig(default = null)objectoptional
Team(default = 0)

0 Use default 1 User only 2 All available users

numberoptional
TeamConfig(default = null)objectoptional
TimeRegistration(default = 0)

0 Use default 1 Use menu 2 Use default clocking

numberoptional
TimeRegistrationConfig(default = null)objectoptional
CostCenterIdstringoptional
{
  "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"
}

Responses

200OK
FieldType
Idstring
Namestring
UIdstring
Active(default = true)boolean
Type(default = 0)

0 Android 1 iOS

number
Orientation(default = 0)

0 Use default 1 Portrait 2 Landscape 3 Landscape (reversed)

number
FilterMenusByUserFilter(default = false)boolean
UserIdentification(default = 0)

0 Use default 1 Fixed user 2 User identification

number
UserIdentificationConfig(default = null)object
ResourceDetection(default = 0)

0 Use default 1 Retain smartphone clocking device 2 Fixed vehicle 3 User's last clocking resource 4 Available vehicles (allowed vehicles) 5 Vehicle from list

number
ResourceDetectionConfig(default = null)object
Positioning(default = 0)

0 Use default 1 Device's GPS 2 Position of the connected vehicle 3 User's last car clocking 4 Connected to a point of interest

number
PositioningConfig(default = null)object
Team(default = 0)

0 Use default 1 User only 2 All available users

number
TeamConfig(default = null)object
TimeRegistration(default = 0)

0 Use default 1 Use menu 2 Use default clocking

number
TimeRegistrationConfig(default = null)object
CostCenterobject
Allowed values in nested fields
UserIdentificationConfig.FixedUser.Type

0 User 1 Vehicle 2 Timeclock 3 Asset 4 Ivr phone number 5 Cost center 6 Work place 7 Mobile clocking

ResourceDetectionConfig.FixedVehicle.Type

0 User 1 Vehicle 2 Timeclock 3 Asset 4 Ivr phone number 5 Cost center 6 Work place 7 Mobile clocking

CostCenter.Type

0 User 1 Vehicle 2 Timeclock 3 Asset 4 Ivr phone number 5 Cost center 6 Work place 7 Mobile clocking

{
  "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
Allowed values in nested fields
Entity.Type

0 Android 1 iOS

Entity.Orientation

0 Use default 1 Portrait 2 Landscape 3 Landscape (reversed)

Entity.UserIdentification

0 Use default 1 Fixed user 2 User identification

Entity.ResourceDetection

0 Use default 1 Retain smartphone clocking device 2 Fixed vehicle 3 User's last clocking resource 4 Available vehicles (allowed vehicles) 5 Vehicle from list

Entity.Positioning

0 Use default 1 Device's GPS 2 Position of the connected vehicle 3 User's last car clocking 4 Connected to a point of interest

Entity.Team

0 Use default 1 User only 2 All available users

Entity.TimeRegistration

0 Use default 1 Use menu 2 Use default clocking

{
  "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
429Too Many Requests

Users

GEThttps://api.geodynamics.dev/intellitracer/v2/user/{id}Api: Resource read or Api: Resource management

Get user

Returns a user by id.

Path parameters

NameTypeRequiredExample
idstringrequired00000000-0000-0000-0000-000000000000

Responses

200OK
FieldType
Data(default = null)object
Allowed values in nested fields
Data.Country
151 allowed values
  • 0 Belgium
  • 1 France
  • 2 Netherlands
  • 3 Luxembourg
  • 4 Italy
  • 5 Norway
  • 6 Denmark
  • 7 Sweden
  • 8 San Marino
  • 9 Andorra
  • 10 Germany
  • 11 United Kingdom
  • 12 Spain
  • 13 Portugal
  • 14 Switzerland
  • 15 Austria
  • 20 Hungary
  • 21 Czechia
  • 22 Greece
  • 23 Poland
  • 24 Slovakia
  • 25 Turkey
  • 26 Albania
  • 27 Bulgaria
  • 28 Bosnia Herzegovina
  • 29 Belarus
  • 30 Moldova
  • 31 Macedonia
  • 32 Montenegro
  • 33 Romania
  • 34 Serbia
  • 35 Ukraine
  • 36 Finland
  • 37 Ireland
  • 38 Malta
  • 39 Estonia
  • 40 Croatia
  • 41 Lithuania
  • 42 Latvia
  • 43 Slovenia
  • 44 Armenia
  • 45 Azerbaijan
  • 46 Cyprus
  • 47 Faroe Islands
  • 48 Georgia
  • 49 Gibraltar
  • 50 Iceland
  • 51 Monaco
  • 52 Russia
  • 53 Vatican
  • 54 Kosovo
  • 55 United Arab Emirates
  • 56 Afghanistan
  • 57 Argentina
  • 58 Australia
  • 59 Bangladesh
  • 60 Bahrain
  • 61 Brunei
  • 62 Bolivia
  • 63 Brazil
  • 64 Bhutan
  • 65 Botswana
  • 66 Belize
  • 67 Canada
  • 68 Congo
  • 69 Cote d'Ivoire
  • 70 Chile
  • 71 Cameroon
  • 72 China
  • 73 Colombia
  • 74 Costa Rica
  • 75 Cuba
  • 76 Dominican Republic
  • 77 Algeria
  • 78 Ecuador
  • 79 Egypt
  • 80 Eritrea
  • 81 Ethiopia
  • 82 Greenland
  • 83 Guatemala
  • 84 Honduras
  • 85 Haiti
  • 86 Indonesia
  • 87 Israel
  • 88 India
  • 89 Iraq
  • 90 Iran
  • 91 Jamaica
  • 92 Jordan
  • 93 Japan
  • 94 Kenya
  • 95 Kyrgyzstan
  • 96 Cambodia
  • 97 Korea
  • 98 Kuwait
  • 99 Kazakhstan
  • 100 Laos
  • 101 Lebanon
  • 102 Liechtenstein
  • 103 Sri Lanka
  • 104 Libya
  • 105 Morocco
  • 106 Mali
  • 107 Myanmar
  • 108 Mongolia
  • 109 Macao SAR
  • 110 Maldives
  • 111 Mexico
  • 112 Malaysia
  • 113 Nigeria
  • 114 Nicaragua
  • 115 Nepal
  • 116 New Zealand
  • 117 Oman
  • 118 Panama
  • 119 Peru
  • 120 Philippines
  • 121 Pakistan
  • 122 Puerto Rico
  • 123 Paraguay
  • 124 Qatar
  • 125 Reunion
  • 126 Rwanda
  • 127 Saudi Arabia
  • 128 Singapore
  • 129 Senegal
  • 130 Somalia
  • 131 El Salvador
  • 132 Syria
  • 133 Thailand
  • 134 Tajikistan
  • 135 Turkmenistan
  • 136 Tunisia
  • 137 Trinidad and Tobago
  • 138 Taiwan
  • 139 United States
  • 140 Uruguay
  • 141 Uzbekistan
  • 142 Venezuela
  • 143 Vietnam
  • 144 Yemen
  • 145 South Africa
  • 146 Zimbabwe
  • 147 Guinea-Bissau
  • 148 Angola
  • 149 Cabo Verde
  • 150 Sao Tome and Principe
  • 151 Mozambique
  • 152 Guinea
  • 153 Mauritania
  • 9999 Unknown
Data.MobilityRule

0 None 1 CAO Construction (PC 124) 2 CAO Cleaning (PC 121) 5 CAO Electricity (PC 149.01) 6 CAO Metal (PC 111) 7 CAO Horticulture (PC 132/145) 8 CAO Employees (PC 200) 9 CAO Metal (PC 209) 10 CAO Concrete 12 Cleaning Cat8

{
  "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
404NotFound
429Too Many Requests

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)
151 allowed values
  • 0 Belgium
  • 1 France
  • 2 Netherlands
  • 3 Luxembourg
  • 4 Italy
  • 5 Norway
  • 6 Denmark
  • 7 Sweden
  • 8 San Marino
  • 9 Andorra
  • 10 Germany
  • 11 United Kingdom
  • 12 Spain
  • 13 Portugal
  • 14 Switzerland
  • 15 Austria
  • 20 Hungary
  • 21 Czechia
  • 22 Greece
  • 23 Poland
  • 24 Slovakia
  • 25 Turkey
  • 26 Albania
  • 27 Bulgaria
  • 28 Bosnia Herzegovina
  • 29 Belarus
  • 30 Moldova
  • 31 Macedonia
  • 32 Montenegro
  • 33 Romania
  • 34 Serbia
  • 35 Ukraine
  • 36 Finland
  • 37 Ireland
  • 38 Malta
  • 39 Estonia
  • 40 Croatia
  • 41 Lithuania
  • 42 Latvia
  • 43 Slovenia
  • 44 Armenia
  • 45 Azerbaijan
  • 46 Cyprus
  • 47 Faroe Islands
  • 48 Georgia
  • 49 Gibraltar
  • 50 Iceland
  • 51 Monaco
  • 52 Russia
  • 53 Vatican
  • 54 Kosovo
  • 55 United Arab Emirates
  • 56 Afghanistan
  • 57 Argentina
  • 58 Australia
  • 59 Bangladesh
  • 60 Bahrain
  • 61 Brunei
  • 62 Bolivia
  • 63 Brazil
  • 64 Bhutan
  • 65 Botswana
  • 66 Belize
  • 67 Canada
  • 68 Congo
  • 69 Cote d'Ivoire
  • 70 Chile
  • 71 Cameroon
  • 72 China
  • 73 Colombia
  • 74 Costa Rica
  • 75 Cuba
  • 76 Dominican Republic
  • 77 Algeria
  • 78 Ecuador
  • 79 Egypt
  • 80 Eritrea
  • 81 Ethiopia
  • 82 Greenland
  • 83 Guatemala
  • 84 Honduras
  • 85 Haiti
  • 86 Indonesia
  • 87 Israel
  • 88 India
  • 89 Iraq
  • 90 Iran
  • 91 Jamaica
  • 92 Jordan
  • 93 Japan
  • 94 Kenya
  • 95 Kyrgyzstan
  • 96 Cambodia
  • 97 Korea
  • 98 Kuwait
  • 99 Kazakhstan
  • 100 Laos
  • 101 Lebanon
  • 102 Liechtenstein
  • 103 Sri Lanka
  • 104 Libya
  • 105 Morocco
  • 106 Mali
  • 107 Myanmar
  • 108 Mongolia
  • 109 Macao SAR
  • 110 Maldives
  • 111 Mexico
  • 112 Malaysia
  • 113 Nigeria
  • 114 Nicaragua
  • 115 Nepal
  • 116 New Zealand
  • 117 Oman
  • 118 Panama
  • 119 Peru
  • 120 Philippines
  • 121 Pakistan
  • 122 Puerto Rico
  • 123 Paraguay
  • 124 Qatar
  • 125 Reunion
  • 126 Rwanda
  • 127 Saudi Arabia
  • 128 Singapore
  • 129 Senegal
  • 130 Somalia
  • 131 El Salvador
  • 132 Syria
  • 133 Thailand
  • 134 Tajikistan
  • 135 Turkmenistan
  • 136 Tunisia
  • 137 Trinidad and Tobago
  • 138 Taiwan
  • 139 United States
  • 140 Uruguay
  • 141 Uzbekistan
  • 142 Venezuela
  • 143 Vietnam
  • 144 Yemen
  • 145 South Africa
  • 146 Zimbabwe
  • 147 Guinea-Bissau
  • 148 Angola
  • 149 Cabo Verde
  • 150 Sao Tome and Principe
  • 151 Mozambique
  • 152 Guinea
  • 153 Mauritania
  • 9999 Unknown
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)

0 None 1 CAO Construction (PC 124) 2 CAO Cleaning (PC 121) 5 CAO Electricity (PC 149.01) 6 CAO Metal (PC 111) 7 CAO Horticulture (PC 132/145) 8 CAO Employees (PC 200) 9 CAO Metal (PC 209) 10 CAO Concrete 12 Cleaning Cat8

numberoptional
FilterIvrCode(default = null)stringoptional
DefaultDayProgramId(default = null)stringoptional
OvertimeConfigId(default = null)stringoptional
{
  "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",
  "DefaultDayProgramId": "00000000-0000-0000-0000-000000000000",
  "OvertimeConfigId": "00000000-0000-0000-0000-000000000000"
}

Responses

200OK
FieldType
Data(default = null)object
Allowed values in nested fields
Data.Country
151 allowed values
  • 0 Belgium
  • 1 France
  • 2 Netherlands
  • 3 Luxembourg
  • 4 Italy
  • 5 Norway
  • 6 Denmark
  • 7 Sweden
  • 8 San Marino
  • 9 Andorra
  • 10 Germany
  • 11 United Kingdom
  • 12 Spain
  • 13 Portugal
  • 14 Switzerland
  • 15 Austria
  • 20 Hungary
  • 21 Czechia
  • 22 Greece
  • 23 Poland
  • 24 Slovakia
  • 25 Turkey
  • 26 Albania
  • 27 Bulgaria
  • 28 Bosnia Herzegovina
  • 29 Belarus
  • 30 Moldova
  • 31 Macedonia
  • 32 Montenegro
  • 33 Romania
  • 34 Serbia
  • 35 Ukraine
  • 36 Finland
  • 37 Ireland
  • 38 Malta
  • 39 Estonia
  • 40 Croatia
  • 41 Lithuania
  • 42 Latvia
  • 43 Slovenia
  • 44 Armenia
  • 45 Azerbaijan
  • 46 Cyprus
  • 47 Faroe Islands
  • 48 Georgia
  • 49 Gibraltar
  • 50 Iceland
  • 51 Monaco
  • 52 Russia
  • 53 Vatican
  • 54 Kosovo
  • 55 United Arab Emirates
  • 56 Afghanistan
  • 57 Argentina
  • 58 Australia
  • 59 Bangladesh
  • 60 Bahrain
  • 61 Brunei
  • 62 Bolivia
  • 63 Brazil
  • 64 Bhutan
  • 65 Botswana
  • 66 Belize
  • 67 Canada
  • 68 Congo
  • 69 Cote d'Ivoire
  • 70 Chile
  • 71 Cameroon
  • 72 China
  • 73 Colombia
  • 74 Costa Rica
  • 75 Cuba
  • 76 Dominican Republic
  • 77 Algeria
  • 78 Ecuador
  • 79 Egypt
  • 80 Eritrea
  • 81 Ethiopia
  • 82 Greenland
  • 83 Guatemala
  • 84 Honduras
  • 85 Haiti
  • 86 Indonesia
  • 87 Israel
  • 88 India
  • 89 Iraq
  • 90 Iran
  • 91 Jamaica
  • 92 Jordan
  • 93 Japan
  • 94 Kenya
  • 95 Kyrgyzstan
  • 96 Cambodia
  • 97 Korea
  • 98 Kuwait
  • 99 Kazakhstan
  • 100 Laos
  • 101 Lebanon
  • 102 Liechtenstein
  • 103 Sri Lanka
  • 104 Libya
  • 105 Morocco
  • 106 Mali
  • 107 Myanmar
  • 108 Mongolia
  • 109 Macao SAR
  • 110 Maldives
  • 111 Mexico
  • 112 Malaysia
  • 113 Nigeria
  • 114 Nicaragua
  • 115 Nepal
  • 116 New Zealand
  • 117 Oman
  • 118 Panama
  • 119 Peru
  • 120 Philippines
  • 121 Pakistan
  • 122 Puerto Rico
  • 123 Paraguay
  • 124 Qatar
  • 125 Reunion
  • 126 Rwanda
  • 127 Saudi Arabia
  • 128 Singapore
  • 129 Senegal
  • 130 Somalia
  • 131 El Salvador
  • 132 Syria
  • 133 Thailand
  • 134 Tajikistan
  • 135 Turkmenistan
  • 136 Tunisia
  • 137 Trinidad and Tobago
  • 138 Taiwan
  • 139 United States
  • 140 Uruguay
  • 141 Uzbekistan
  • 142 Venezuela
  • 143 Vietnam
  • 144 Yemen
  • 145 South Africa
  • 146 Zimbabwe
  • 147 Guinea-Bissau
  • 148 Angola
  • 149 Cabo Verde
  • 150 Sao Tome and Principe
  • 151 Mozambique
  • 152 Guinea
  • 153 Mauritania
  • 9999 Unknown
Data.MobilityRule

0 None 1 CAO Construction (PC 124) 2 CAO Cleaning (PC 121) 5 CAO Electricity (PC 149.01) 6 CAO Metal (PC 111) 7 CAO Horticulture (PC 132/145) 8 CAO Employees (PC 200) 9 CAO Metal (PC 209) 10 CAO Concrete 12 Cleaning Cat8

{
  "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
Allowed values in nested fields
Entity.Country
151 allowed values
  • 0 Belgium
  • 1 France
  • 2 Netherlands
  • 3 Luxembourg
  • 4 Italy
  • 5 Norway
  • 6 Denmark
  • 7 Sweden
  • 8 San Marino
  • 9 Andorra
  • 10 Germany
  • 11 United Kingdom
  • 12 Spain
  • 13 Portugal
  • 14 Switzerland
  • 15 Austria
  • 20 Hungary
  • 21 Czechia
  • 22 Greece
  • 23 Poland
  • 24 Slovakia
  • 25 Turkey
  • 26 Albania
  • 27 Bulgaria
  • 28 Bosnia Herzegovina
  • 29 Belarus
  • 30 Moldova
  • 31 Macedonia
  • 32 Montenegro
  • 33 Romania
  • 34 Serbia
  • 35 Ukraine
  • 36 Finland
  • 37 Ireland
  • 38 Malta
  • 39 Estonia
  • 40 Croatia
  • 41 Lithuania
  • 42 Latvia
  • 43 Slovenia
  • 44 Armenia
  • 45 Azerbaijan
  • 46 Cyprus
  • 47 Faroe Islands
  • 48 Georgia
  • 49 Gibraltar
  • 50 Iceland
  • 51 Monaco
  • 52 Russia
  • 53 Vatican
  • 54 Kosovo
  • 55 United Arab Emirates
  • 56 Afghanistan
  • 57 Argentina
  • 58 Australia
  • 59 Bangladesh
  • 60 Bahrain
  • 61 Brunei
  • 62 Bolivia
  • 63 Brazil
  • 64 Bhutan
  • 65 Botswana
  • 66 Belize
  • 67 Canada
  • 68 Congo
  • 69 Cote d'Ivoire
  • 70 Chile
  • 71 Cameroon
  • 72 China
  • 73 Colombia
  • 74 Costa Rica
  • 75 Cuba
  • 76 Dominican Republic
  • 77 Algeria
  • 78 Ecuador
  • 79 Egypt
  • 80 Eritrea
  • 81 Ethiopia
  • 82 Greenland
  • 83 Guatemala
  • 84 Honduras
  • 85 Haiti
  • 86 Indonesia
  • 87 Israel
  • 88 India
  • 89 Iraq
  • 90 Iran
  • 91 Jamaica
  • 92 Jordan
  • 93 Japan
  • 94 Kenya
  • 95 Kyrgyzstan
  • 96 Cambodia
  • 97 Korea
  • 98 Kuwait
  • 99 Kazakhstan
  • 100 Laos
  • 101 Lebanon
  • 102 Liechtenstein
  • 103 Sri Lanka
  • 104 Libya
  • 105 Morocco
  • 106 Mali
  • 107 Myanmar
  • 108 Mongolia
  • 109 Macao SAR
  • 110 Maldives
  • 111 Mexico
  • 112 Malaysia
  • 113 Nigeria
  • 114 Nicaragua
  • 115 Nepal
  • 116 New Zealand
  • 117 Oman
  • 118 Panama
  • 119 Peru
  • 120 Philippines
  • 121 Pakistan
  • 122 Puerto Rico
  • 123 Paraguay
  • 124 Qatar
  • 125 Reunion
  • 126 Rwanda
  • 127 Saudi Arabia
  • 128 Singapore
  • 129 Senegal
  • 130 Somalia
  • 131 El Salvador
  • 132 Syria
  • 133 Thailand
  • 134 Tajikistan
  • 135 Turkmenistan
  • 136 Tunisia
  • 137 Trinidad and Tobago
  • 138 Taiwan
  • 139 United States
  • 140 Uruguay
  • 141 Uzbekistan
  • 142 Venezuela
  • 143 Vietnam
  • 144 Yemen
  • 145 South Africa
  • 146 Zimbabwe
  • 147 Guinea-Bissau
  • 148 Angola
  • 149 Cabo Verde
  • 150 Sao Tome and Principe
  • 151 Mozambique
  • 152 Guinea
  • 153 Mauritania
  • 9999 Unknown
Entity.MobilityRule

0 None 1 CAO Construction (PC 124) 2 CAO Cleaning (PC 121) 5 CAO Electricity (PC 149.01) 6 CAO Metal (PC 111) 7 CAO Horticulture (PC 132/145) 8 CAO Employees (PC 200) 9 CAO Metal (PC 209) 10 CAO Concrete 12 Cleaning Cat8

{
  "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
429Too Many Requests

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)
151 allowed values
  • 0 Belgium
  • 1 France
  • 2 Netherlands
  • 3 Luxembourg
  • 4 Italy
  • 5 Norway
  • 6 Denmark
  • 7 Sweden
  • 8 San Marino
  • 9 Andorra
  • 10 Germany
  • 11 United Kingdom
  • 12 Spain
  • 13 Portugal
  • 14 Switzerland
  • 15 Austria
  • 20 Hungary
  • 21 Czechia
  • 22 Greece
  • 23 Poland
  • 24 Slovakia
  • 25 Turkey
  • 26 Albania
  • 27 Bulgaria
  • 28 Bosnia Herzegovina
  • 29 Belarus
  • 30 Moldova
  • 31 Macedonia
  • 32 Montenegro
  • 33 Romania
  • 34 Serbia
  • 35 Ukraine
  • 36 Finland
  • 37 Ireland
  • 38 Malta
  • 39 Estonia
  • 40 Croatia
  • 41 Lithuania
  • 42 Latvia
  • 43 Slovenia
  • 44 Armenia
  • 45 Azerbaijan
  • 46 Cyprus
  • 47 Faroe Islands
  • 48 Georgia
  • 49 Gibraltar
  • 50 Iceland
  • 51 Monaco
  • 52 Russia
  • 53 Vatican
  • 54 Kosovo
  • 55 United Arab Emirates
  • 56 Afghanistan
  • 57 Argentina
  • 58 Australia
  • 59 Bangladesh
  • 60 Bahrain
  • 61 Brunei
  • 62 Bolivia
  • 63 Brazil
  • 64 Bhutan
  • 65 Botswana
  • 66 Belize
  • 67 Canada
  • 68 Congo
  • 69 Cote d'Ivoire
  • 70 Chile
  • 71 Cameroon
  • 72 China
  • 73 Colombia
  • 74 Costa Rica
  • 75 Cuba
  • 76 Dominican Republic
  • 77 Algeria
  • 78 Ecuador
  • 79 Egypt
  • 80 Eritrea
  • 81 Ethiopia
  • 82 Greenland
  • 83 Guatemala
  • 84 Honduras
  • 85 Haiti
  • 86 Indonesia
  • 87 Israel
  • 88 India
  • 89 Iraq
  • 90 Iran
  • 91 Jamaica
  • 92 Jordan
  • 93 Japan
  • 94 Kenya
  • 95 Kyrgyzstan
  • 96 Cambodia
  • 97 Korea
  • 98 Kuwait
  • 99 Kazakhstan
  • 100 Laos
  • 101 Lebanon
  • 102 Liechtenstein
  • 103 Sri Lanka
  • 104 Libya
  • 105 Morocco
  • 106 Mali
  • 107 Myanmar
  • 108 Mongolia
  • 109 Macao SAR
  • 110 Maldives
  • 111 Mexico
  • 112 Malaysia
  • 113 Nigeria
  • 114 Nicaragua
  • 115 Nepal
  • 116 New Zealand
  • 117 Oman
  • 118 Panama
  • 119 Peru
  • 120 Philippines
  • 121 Pakistan
  • 122 Puerto Rico
  • 123 Paraguay
  • 124 Qatar
  • 125 Reunion
  • 126 Rwanda
  • 127 Saudi Arabia
  • 128 Singapore
  • 129 Senegal
  • 130 Somalia
  • 131 El Salvador
  • 132 Syria
  • 133 Thailand
  • 134 Tajikistan
  • 135 Turkmenistan
  • 136 Tunisia
  • 137 Trinidad and Tobago
  • 138 Taiwan
  • 139 United States
  • 140 Uruguay
  • 141 Uzbekistan
  • 142 Venezuela
  • 143 Vietnam
  • 144 Yemen
  • 145 South Africa
  • 146 Zimbabwe
  • 147 Guinea-Bissau
  • 148 Angola
  • 149 Cabo Verde
  • 150 Sao Tome and Principe
  • 151 Mozambique
  • 152 Guinea
  • 153 Mauritania
  • 9999 Unknown
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)

0 None 1 CAO Construction (PC 124) 2 CAO Cleaning (PC 121) 5 CAO Electricity (PC 149.01) 6 CAO Metal (PC 111) 7 CAO Horticulture (PC 132/145) 8 CAO Employees (PC 200) 9 CAO Metal (PC 209) 10 CAO Concrete 12 Cleaning Cat8

numberoptional
FilterIvrCode(default = null)stringoptional
DefaultDayProgramId(default = null)stringoptional
OvertimeConfigId(default = null)stringoptional
{
  "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",
  "DefaultDayProgramId": "00000000-0000-0000-0000-000000000000",
  "OvertimeConfigId": "00000000-0000-0000-0000-000000000000"
}

Responses

200OK
FieldType
Data(default = null)object
Allowed values in nested fields
Data.Country
151 allowed values
  • 0 Belgium
  • 1 France
  • 2 Netherlands
  • 3 Luxembourg
  • 4 Italy
  • 5 Norway
  • 6 Denmark
  • 7 Sweden
  • 8 San Marino
  • 9 Andorra
  • 10 Germany
  • 11 United Kingdom
  • 12 Spain
  • 13 Portugal
  • 14 Switzerland
  • 15 Austria
  • 20 Hungary
  • 21 Czechia
  • 22 Greece
  • 23 Poland
  • 24 Slovakia
  • 25 Turkey
  • 26 Albania
  • 27 Bulgaria
  • 28 Bosnia Herzegovina
  • 29 Belarus
  • 30 Moldova
  • 31 Macedonia
  • 32 Montenegro
  • 33 Romania
  • 34 Serbia
  • 35 Ukraine
  • 36 Finland
  • 37 Ireland
  • 38 Malta
  • 39 Estonia
  • 40 Croatia
  • 41 Lithuania
  • 42 Latvia
  • 43 Slovenia
  • 44 Armenia
  • 45 Azerbaijan
  • 46 Cyprus
  • 47 Faroe Islands
  • 48 Georgia
  • 49 Gibraltar
  • 50 Iceland
  • 51 Monaco
  • 52 Russia
  • 53 Vatican
  • 54 Kosovo
  • 55 United Arab Emirates
  • 56 Afghanistan
  • 57 Argentina
  • 58 Australia
  • 59 Bangladesh
  • 60 Bahrain
  • 61 Brunei
  • 62 Bolivia
  • 63 Brazil
  • 64 Bhutan
  • 65 Botswana
  • 66 Belize
  • 67 Canada
  • 68 Congo
  • 69 Cote d'Ivoire
  • 70 Chile
  • 71 Cameroon
  • 72 China
  • 73 Colombia
  • 74 Costa Rica
  • 75 Cuba
  • 76 Dominican Republic
  • 77 Algeria
  • 78 Ecuador
  • 79 Egypt
  • 80 Eritrea
  • 81 Ethiopia
  • 82 Greenland
  • 83 Guatemala
  • 84 Honduras
  • 85 Haiti
  • 86 Indonesia
  • 87 Israel
  • 88 India
  • 89 Iraq
  • 90 Iran
  • 91 Jamaica
  • 92 Jordan
  • 93 Japan
  • 94 Kenya
  • 95 Kyrgyzstan
  • 96 Cambodia
  • 97 Korea
  • 98 Kuwait
  • 99 Kazakhstan
  • 100 Laos
  • 101 Lebanon
  • 102 Liechtenstein
  • 103 Sri Lanka
  • 104 Libya
  • 105 Morocco
  • 106 Mali
  • 107 Myanmar
  • 108 Mongolia
  • 109 Macao SAR
  • 110 Maldives
  • 111 Mexico
  • 112 Malaysia
  • 113 Nigeria
  • 114 Nicaragua
  • 115 Nepal
  • 116 New Zealand
  • 117 Oman
  • 118 Panama
  • 119 Peru
  • 120 Philippines
  • 121 Pakistan
  • 122 Puerto Rico
  • 123 Paraguay
  • 124 Qatar
  • 125 Reunion
  • 126 Rwanda
  • 127 Saudi Arabia
  • 128 Singapore
  • 129 Senegal
  • 130 Somalia
  • 131 El Salvador
  • 132 Syria
  • 133 Thailand
  • 134 Tajikistan
  • 135 Turkmenistan
  • 136 Tunisia
  • 137 Trinidad and Tobago
  • 138 Taiwan
  • 139 United States
  • 140 Uruguay
  • 141 Uzbekistan
  • 142 Venezuela
  • 143 Vietnam
  • 144 Yemen
  • 145 South Africa
  • 146 Zimbabwe
  • 147 Guinea-Bissau
  • 148 Angola
  • 149 Cabo Verde
  • 150 Sao Tome and Principe
  • 151 Mozambique
  • 152 Guinea
  • 153 Mauritania
  • 9999 Unknown
Data.MobilityRule

0 None 1 CAO Construction (PC 124) 2 CAO Cleaning (PC 121) 5 CAO Electricity (PC 149.01) 6 CAO Metal (PC 111) 7 CAO Horticulture (PC 132/145) 8 CAO Employees (PC 200) 9 CAO Metal (PC 209) 10 CAO Concrete 12 Cleaning Cat8

{
  "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
Allowed values in nested fields
Entity.Country
151 allowed values
  • 0 Belgium
  • 1 France
  • 2 Netherlands
  • 3 Luxembourg
  • 4 Italy
  • 5 Norway
  • 6 Denmark
  • 7 Sweden
  • 8 San Marino
  • 9 Andorra
  • 10 Germany
  • 11 United Kingdom
  • 12 Spain
  • 13 Portugal
  • 14 Switzerland
  • 15 Austria
  • 20 Hungary
  • 21 Czechia
  • 22 Greece
  • 23 Poland
  • 24 Slovakia
  • 25 Turkey
  • 26 Albania
  • 27 Bulgaria
  • 28 Bosnia Herzegovina
  • 29 Belarus
  • 30 Moldova
  • 31 Macedonia
  • 32 Montenegro
  • 33 Romania
  • 34 Serbia
  • 35 Ukraine
  • 36 Finland
  • 37 Ireland
  • 38 Malta
  • 39 Estonia
  • 40 Croatia
  • 41 Lithuania
  • 42 Latvia
  • 43 Slovenia
  • 44 Armenia
  • 45 Azerbaijan
  • 46 Cyprus
  • 47 Faroe Islands
  • 48 Georgia
  • 49 Gibraltar
  • 50 Iceland
  • 51 Monaco
  • 52 Russia
  • 53 Vatican
  • 54 Kosovo
  • 55 United Arab Emirates
  • 56 Afghanistan
  • 57 Argentina
  • 58 Australia
  • 59 Bangladesh
  • 60 Bahrain
  • 61 Brunei
  • 62 Bolivia
  • 63 Brazil
  • 64 Bhutan
  • 65 Botswana
  • 66 Belize
  • 67 Canada
  • 68 Congo
  • 69 Cote d'Ivoire
  • 70 Chile
  • 71 Cameroon
  • 72 China
  • 73 Colombia
  • 74 Costa Rica
  • 75 Cuba
  • 76 Dominican Republic
  • 77 Algeria
  • 78 Ecuador
  • 79 Egypt
  • 80 Eritrea
  • 81 Ethiopia
  • 82 Greenland
  • 83 Guatemala
  • 84 Honduras
  • 85 Haiti
  • 86 Indonesia
  • 87 Israel
  • 88 India
  • 89 Iraq
  • 90 Iran
  • 91 Jamaica
  • 92 Jordan
  • 93 Japan
  • 94 Kenya
  • 95 Kyrgyzstan
  • 96 Cambodia
  • 97 Korea
  • 98 Kuwait
  • 99 Kazakhstan
  • 100 Laos
  • 101 Lebanon
  • 102 Liechtenstein
  • 103 Sri Lanka
  • 104 Libya
  • 105 Morocco
  • 106 Mali
  • 107 Myanmar
  • 108 Mongolia
  • 109 Macao SAR
  • 110 Maldives
  • 111 Mexico
  • 112 Malaysia
  • 113 Nigeria
  • 114 Nicaragua
  • 115 Nepal
  • 116 New Zealand
  • 117 Oman
  • 118 Panama
  • 119 Peru
  • 120 Philippines
  • 121 Pakistan
  • 122 Puerto Rico
  • 123 Paraguay
  • 124 Qatar
  • 125 Reunion
  • 126 Rwanda
  • 127 Saudi Arabia
  • 128 Singapore
  • 129 Senegal
  • 130 Somalia
  • 131 El Salvador
  • 132 Syria
  • 133 Thailand
  • 134 Tajikistan
  • 135 Turkmenistan
  • 136 Tunisia
  • 137 Trinidad and Tobago
  • 138 Taiwan
  • 139 United States
  • 140 Uruguay
  • 141 Uzbekistan
  • 142 Venezuela
  • 143 Vietnam
  • 144 Yemen
  • 145 South Africa
  • 146 Zimbabwe
  • 147 Guinea-Bissau
  • 148 Angola
  • 149 Cabo Verde
  • 150 Sao Tome and Principe
  • 151 Mozambique
  • 152 Guinea
  • 153 Mauritania
  • 9999 Unknown
Entity.MobilityRule

0 None 1 CAO Construction (PC 124) 2 CAO Cleaning (PC 121) 5 CAO Electricity (PC 149.01) 6 CAO Metal (PC 111) 7 CAO Horticulture (PC 132/145) 8 CAO Employees (PC 200) 9 CAO Metal (PC 209) 10 CAO Concrete 12 Cleaning Cat8

{
  "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
429Too Many Requests

Delete user

Deletes a user.

Request body

object

FieldTypeRequired
Idstringrequired
{
  "Id": "00000000-0000-0000-0000-000000000000"
}

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)
151 allowed values
  • 0 Belgium
  • 1 France
  • 2 Netherlands
  • 3 Luxembourg
  • 4 Italy
  • 5 Norway
  • 6 Denmark
  • 7 Sweden
  • 8 San Marino
  • 9 Andorra
  • 10 Germany
  • 11 United Kingdom
  • 12 Spain
  • 13 Portugal
  • 14 Switzerland
  • 15 Austria
  • 20 Hungary
  • 21 Czechia
  • 22 Greece
  • 23 Poland
  • 24 Slovakia
  • 25 Turkey
  • 26 Albania
  • 27 Bulgaria
  • 28 Bosnia Herzegovina
  • 29 Belarus
  • 30 Moldova
  • 31 Macedonia
  • 32 Montenegro
  • 33 Romania
  • 34 Serbia
  • 35 Ukraine
  • 36 Finland
  • 37 Ireland
  • 38 Malta
  • 39 Estonia
  • 40 Croatia
  • 41 Lithuania
  • 42 Latvia
  • 43 Slovenia
  • 44 Armenia
  • 45 Azerbaijan
  • 46 Cyprus
  • 47 Faroe Islands
  • 48 Georgia
  • 49 Gibraltar
  • 50 Iceland
  • 51 Monaco
  • 52 Russia
  • 53 Vatican
  • 54 Kosovo
  • 55 United Arab Emirates
  • 56 Afghanistan
  • 57 Argentina
  • 58 Australia
  • 59 Bangladesh
  • 60 Bahrain
  • 61 Brunei
  • 62 Bolivia
  • 63 Brazil
  • 64 Bhutan
  • 65 Botswana
  • 66 Belize
  • 67 Canada
  • 68 Congo
  • 69 Cote d'Ivoire
  • 70 Chile
  • 71 Cameroon
  • 72 China
  • 73 Colombia
  • 74 Costa Rica
  • 75 Cuba
  • 76 Dominican Republic
  • 77 Algeria
  • 78 Ecuador
  • 79 Egypt
  • 80 Eritrea
  • 81 Ethiopia
  • 82 Greenland
  • 83 Guatemala
  • 84 Honduras
  • 85 Haiti
  • 86 Indonesia
  • 87 Israel
  • 88 India
  • 89 Iraq
  • 90 Iran
  • 91 Jamaica
  • 92 Jordan
  • 93 Japan
  • 94 Kenya
  • 95 Kyrgyzstan
  • 96 Cambodia
  • 97 Korea
  • 98 Kuwait
  • 99 Kazakhstan
  • 100 Laos
  • 101 Lebanon
  • 102 Liechtenstein
  • 103 Sri Lanka
  • 104 Libya
  • 105 Morocco
  • 106 Mali
  • 107 Myanmar
  • 108 Mongolia
  • 109 Macao SAR
  • 110 Maldives
  • 111 Mexico
  • 112 Malaysia
  • 113 Nigeria
  • 114 Nicaragua
  • 115 Nepal
  • 116 New Zealand
  • 117 Oman
  • 118 Panama
  • 119 Peru
  • 120 Philippines
  • 121 Pakistan
  • 122 Puerto Rico
  • 123 Paraguay
  • 124 Qatar
  • 125 Reunion
  • 126 Rwanda
  • 127 Saudi Arabia
  • 128 Singapore
  • 129 Senegal
  • 130 Somalia
  • 131 El Salvador
  • 132 Syria
  • 133 Thailand
  • 134 Tajikistan
  • 135 Turkmenistan
  • 136 Tunisia
  • 137 Trinidad and Tobago
  • 138 Taiwan
  • 139 United States
  • 140 Uruguay
  • 141 Uzbekistan
  • 142 Venezuela
  • 143 Vietnam
  • 144 Yemen
  • 145 South Africa
  • 146 Zimbabwe
  • 147 Guinea-Bissau
  • 148 Angola
  • 149 Cabo Verde
  • 150 Sao Tome and Principe
  • 151 Mozambique
  • 152 Guinea
  • 153 Mauritania
  • 9999 Unknown
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
Allowed values in nested fields
Entity.Country
151 allowed values
  • 0 Belgium
  • 1 France
  • 2 Netherlands
  • 3 Luxembourg
  • 4 Italy
  • 5 Norway
  • 6 Denmark
  • 7 Sweden
  • 8 San Marino
  • 9 Andorra
  • 10 Germany
  • 11 United Kingdom
  • 12 Spain
  • 13 Portugal
  • 14 Switzerland
  • 15 Austria
  • 20 Hungary
  • 21 Czechia
  • 22 Greece
  • 23 Poland
  • 24 Slovakia
  • 25 Turkey
  • 26 Albania
  • 27 Bulgaria
  • 28 Bosnia Herzegovina
  • 29 Belarus
  • 30 Moldova
  • 31 Macedonia
  • 32 Montenegro
  • 33 Romania
  • 34 Serbia
  • 35 Ukraine
  • 36 Finland
  • 37 Ireland
  • 38 Malta
  • 39 Estonia
  • 40 Croatia
  • 41 Lithuania
  • 42 Latvia
  • 43 Slovenia
  • 44 Armenia
  • 45 Azerbaijan
  • 46 Cyprus
  • 47 Faroe Islands
  • 48 Georgia
  • 49 Gibraltar
  • 50 Iceland
  • 51 Monaco
  • 52 Russia
  • 53 Vatican
  • 54 Kosovo
  • 55 United Arab Emirates
  • 56 Afghanistan
  • 57 Argentina
  • 58 Australia
  • 59 Bangladesh
  • 60 Bahrain
  • 61 Brunei
  • 62 Bolivia
  • 63 Brazil
  • 64 Bhutan
  • 65 Botswana
  • 66 Belize
  • 67 Canada
  • 68 Congo
  • 69 Cote d'Ivoire
  • 70 Chile
  • 71 Cameroon
  • 72 China
  • 73 Colombia
  • 74 Costa Rica
  • 75 Cuba
  • 76 Dominican Republic
  • 77 Algeria
  • 78 Ecuador
  • 79 Egypt
  • 80 Eritrea
  • 81 Ethiopia
  • 82 Greenland
  • 83 Guatemala
  • 84 Honduras
  • 85 Haiti
  • 86 Indonesia
  • 87 Israel
  • 88 India
  • 89 Iraq
  • 90 Iran
  • 91 Jamaica
  • 92 Jordan
  • 93 Japan
  • 94 Kenya
  • 95 Kyrgyzstan
  • 96 Cambodia
  • 97 Korea
  • 98 Kuwait
  • 99 Kazakhstan
  • 100 Laos
  • 101 Lebanon
  • 102 Liechtenstein
  • 103 Sri Lanka
  • 104 Libya
  • 105 Morocco
  • 106 Mali
  • 107 Myanmar
  • 108 Mongolia
  • 109 Macao SAR
  • 110 Maldives
  • 111 Mexico
  • 112 Malaysia
  • 113 Nigeria
  • 114 Nicaragua
  • 115 Nepal
  • 116 New Zealand
  • 117 Oman
  • 118 Panama
  • 119 Peru
  • 120 Philippines
  • 121 Pakistan
  • 122 Puerto Rico
  • 123 Paraguay
  • 124 Qatar
  • 125 Reunion
  • 126 Rwanda
  • 127 Saudi Arabia
  • 128 Singapore
  • 129 Senegal
  • 130 Somalia
  • 131 El Salvador
  • 132 Syria
  • 133 Thailand
  • 134 Tajikistan
  • 135 Turkmenistan
  • 136 Tunisia
  • 137 Trinidad and Tobago
  • 138 Taiwan
  • 139 United States
  • 140 Uruguay
  • 141 Uzbekistan
  • 142 Venezuela
  • 143 Vietnam
  • 144 Yemen
  • 145 South Africa
  • 146 Zimbabwe
  • 147 Guinea-Bissau
  • 148 Angola
  • 149 Cabo Verde
  • 150 Sao Tome and Principe
  • 151 Mozambique
  • 152 Guinea
  • 153 Mauritania
  • 9999 Unknown
{
  "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
429Too Many Requests

Users - Permitted Resource Groups

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
Type

user User vehicle Vehicle timeclock Timeclock asset Asset ivrphonenumber Ivr phone number costcenter Cost center workplace Work place mobileclocking Mobile clocking

stringrequired
{
  "GroupIds": [],
  "Type": ""
}

Responses

200OK
400Bad Request
401Unauthorized
403Forbidden
417ExpectationFailed
429Too Many Requests

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

string[]

[
  "00000000-0000-0000-0000-000000000000",
  "00000000-0000-0000-0000-000000000000"
]

Responses

200OK
400Bad Request
401Unauthorized
403Forbidden
417ExpectationFailed
429Too Many Requests

Users - Day Programs

Get user day programs

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

Path parameters

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

Responses

200OK
FieldType
UserDayProgramUser
DayProgramDayProgram
DateLocalstring
IsDefaultboolean
[
  {
    "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
429Too Many Requests

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
{
  "DayProgramId": "00000000-0000-0000-0000-000000000000",
  "FromDate": "2019-01-25",
  "ToDate": "2019-01-27"
}

Responses

200OK
400Bad Request
401Unauthorized
403Forbidden
417ExpectationFailed
429Too Many Requests

Overtime configurations

GEThttps://api.geodynamics.dev/intellitracer/v2/overtimeconfig/{id}Api: Timesheet read or Api: Timesheet management

Get overtime configuration

Returns an overtime configuration by id.

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
417ExpectationFailed
429Too Many Requests