openapi: 3.0.0
info:
title: GeoDynamics API
version: ""
description: >-
The GeoDynamics APIs allow you to programmatically access the GeoDynamics
platform. You can use these APIs to configure the application (resources)
and to retrieve locations, timesheets and more. We will make future
additions and changes to this API. We'll keep the endpoints backwards
compatible.
If you have feedback or if your specific use case can't be met, [contact us](https://geodynamics.eu/nl-be/support/).
# Starting
Each web service API is described using several parts:
* The content type is `application/json`.
* The HTTP method. Includes GET, POST, PUT, PATCH, DELETE.
* The required IntelliTracer privileges.
* The base path. All URLs referenced in the documentation have the base path https://api.intellitracer.be. This base path goes before the endpoint path.
* Required parameters. These parameters must be included in a request. You must replace the placeholders.
* Optional parameters. These parameters can be included in a request to customize the query.
# Authentication
Access to the API is via a company-level Personal Access Token (PAT).
A request carries a header field of the form `Authorization: Bearer itr_pat_...`.
You create and manage tokens in IntelliTracer under `Public API tokens`, which needs the `Manage public API tokens` privilege. Signed in with a GeoDynamics account, you can also create one from the [developer portal dashboard](https://build.geodynamics.eu/dashboard).
A token belongs to the company, not to a user, so rotating someone's password never breaks your integration.
A token only carries the scopes you grant it on its `Privileges` page. An endpoint whose scope the token lacks responds with an HTTP `403`, even though the token itself is valid.
When we are unable to validate the data we respond with an HTTP `401` response.
# Privileges
The user using the webservice needs to have the privileges required for webservice usage. We indicate the required privileges for each method.
# Rate limits
IntelliTracer APIs have rate limits that cap the number of requests that you can make. If you exceed a rate limit, your request will be throttled and you will receive an HTTP `429 Too Many Requests` response.
All rate limits are counted per company (see Authentication), not by IP.
Try to optimize your API usage so that you don't request similar data more often than needed.
We monitor the API usage and act automatically to ensure the stability of our systems.
## Request counting
We count all requests by the identity that made the request. A bad request is a request that returns an HTTP status from `400` to `500`, these are counted as a request and as a bad request.
| Request | Rate limit |
|:---------------|----------------------|
| Requests | 1800 per 30 minutes |
| Bad Requests | 5 per 60 seconds |
## Throttle response
When you exceed a rate limit we will respond with an HTTP `429 Too Many Requests` and we will add a rate limit header `Retry-After` indicating the number of seconds your remain throttled.
Once the request limit is reached, you will be throttled for 3 minutes for every additional request until 30 minutes have passed.
| HTTP Response | Description |
|:---------------|----------------------|
| `429` | Too Many Requests |
| `401` | Unauthorized |
| Header | Description |
|:---------------|----------------------|
| Retry-After | number of seconds you remain throttled |
# Date and time
Unless otherwise specified, dates and times returned by IntelliTracer APIs are represented in Coordinated Universal Time or UTC.
As GPS systems run in UTC time, we need to view time as continuous in our platform. So all timestamps used in parameters are standard UTC time, in responses the default display is also UTC based.
In certain scenarios we will add the local datetime. For example in time registration, postcalculation.
# Linking resources
Each resource (eg. user, vehicle, tag,..) has a unique id. This field is referred as `Id` or ending with `Id` in the field name.
Only use this field when linking to a resource in your application, other fields might not be unique or can be changed by the customer.
# Pagination
Pagination and search are only available on the V2 API endpoints. These can be recognized by the URI that starts with V2.
The following optional parameters can be used:
| Parameter | Description |
|:---------------|----------------------|
| `search` | Default is empty, can be used to filter results by a search variable |
| `page` | Default is 1, can be used to select a results page. |
## Parsing the result
Requests that return multiple items will be paginated to 30 items by default. To view the next page you can follow the links. The available options are documented below:
| Response | Description |
|:---------------|----------------------|
| `PagingFilter.Page` | Current Page, first page is 1. |
| `PagingFilter.PageCount` | Total number of result pages. |
| `PagingFilter.TotalCount` | Total number of result items. |
| `PagingFilter.Links.Base` | Base link to use in the links default is `https://api.intellitracer.be`. |
| `PagingFilter.Links.Next` | The link to the next page (example: `/api/v2/asset?page=2`) or `null`. |
Under `Links` we also give the link to `First`, `Prev` and `Last` page if available, otherwise the content is `null`.
# Best Practices
## Talk to us
We're very friendly people, most problems don't happen if we get to know each other a little bit, [just contact us](https://support.geodynamics.be/) and we're 5 steps further.
## HTTPS
You can only access the IntelliTracer API web service using HTTPS with a minimum TLS 1.2 protocol.
## Cache!
If you are integrating your product/ERP using the IntelliTracer API, we recommend that you do all API requests on the server side, and if possible cache them.
## Common sense
Should be simple. For example, don't check for the last position of a vehicle every other second. Most vehicles update location while driving between 1 and 3 minutes. Checking more often than that won't give you much of an advantage.
## Internet is unreliable
Networks in general are unreliable, and particularly one as large and complex as the Internet. Your application should not assume it will get an answer. There may be timeouts.
# Deprecated API calls
A number of API calls have since been replaced by a newer version. They are no longer listed on this page as we recommend using the most recent version, but for archival purposes they can be found here: https://developer.geodynamics.be/deprecated
# Updates
Need more information? Don't hesitate to [contact us](https://support.geodynamics.be/).
## February 2026
* New method 'Get user day programs' and 'Update user day programs'.
* Added additional filters to 'Get workplaces'.
* Added new method 'Approve absence request' and 'Refuse absence request'.
## January 2026
* Added new methods 'Get user permitted resource groups', 'Add permitted resource groups to user' and 'Remove permitted resource groups from user'
## December 2024
* Updated 'Get Plannings' to include new property 'Poi'
## November 2024
* Updated 'Add Planning' and 'Update Planning' to include new property 'Poi'
## August 2024
* New methods: 'Get inactive pois', 'Activate poi' and 'Deactivate poi'.
## July 2024
* Create/Update workplace: added support for multiple codes based on semicolons
## October 2023
* Updated 'Get vehicle usage': Drivings
## September 2023
* New 'Add Planning' and 'Update Planning' methods to include new property 'ActivityNumber'.
## June 2023
* Create/Update workplace: new option 'syncPoisByCode'
## May 2023
* New method for 'Get multi-job lists' and 'Get multi-job list'.
## February 2023
* Updated 'Get RFID tags' and 'Put RFID tag' : BeaconRateSeconds, SiteCode, PassiveTagNumber and MacAddress are added.
* New 'Update RFID tag', 'Delete RFID tag' and 'Get RFID tag' methods.
* New methods for managing asset identifications.
* Updated Export post calculation : option IncludeLossCostCenter is added to PostCalculationExportQuery.
## November 2022
* New method to update and delete planning.
* New method to update RRN of a person.
## October 2022
* Updated 'Get user(s)' : FilterIvrCode is added to User.
* New methods for create and update User.
* Updated Export post calculation : VerifiedDate added and Resource added to PostCalculationEvent.
## August 2022
* Updated Export post calculation : IndirectAssignedTravelTime and IndirectAssignedTravelDistance are added to PostCalculationDetails.
* New method for 'Get verified days' (Time Validation).
* New version of 'Export post calculation' (Post Calculation).
## June 2022
* New methods for Persons by BIS number (CheckInAtWork).
* New methods to create, update and delete badges (CheckInAtWork).
* New method to create a planning.
## May 2022
* New get vehicle counter method.
* Updated Get absence types : get by id and filter by includeInExport.
* Updated Export post calculation : EventType is added to TimesheetEvent.
* Updated Link badge to person: Type is added to Badge.
## March 2022
* New method to update a POI without changing its location.
## January 2022
* New 'Person group' methods for CheckInAtWork.
## September 2021
* New 'Validate workplaces with RSZ' method.
* 'Get access locations' now returns a list of relais and readers.
* 'Export postcalculation' has a new option to return TimesheetEvents.
* New 'Resoures at POI' method.
* New 'Get last positions' method.
* New BadgeNumber field in the 'Get access log' response.
## July 2021
* New 'add clocking' method.
## June 2021
* New 'Get timeclocks' and 'Get timeclock by ID' methods.
## February 2021
* Paged version of "Get all pois" added.
## January 2021
* New "Validate DUC" method.
* New Asset Responsible methods.
* Added A1 and Visa expiration dates for CIAW Persons.
## October 2020
* New "Update vehicle" method.
## September 2020
* New methods for CIAW product leads
## July 2020
* New method Inspection types by asset
* New method Vehicle per costcenter
## June 2020
* Added new webhooks
* Added QR code to CIAW Person & Workplace
* Added new methods to link inspection types to assets
* Added new method to edit a jobnumber
## March 2020
* Added new methods for Access Control groups.
## November 2019
* Added new methods for CheckInAtWork.
* Added new methods to create and delete absence types.
## September 2019
* Added new methods for Asset management.
## August 2019
* Added new methods to link and unlink a User and a Person (CIAW).
* Added new methods for RFID tags.
* Added new methods for smartphones.
* Added new methods for access control exceptions.
* Added new method for visits per POI (place of interest).
## June 2019
* Added new accessibility method to get persons on a workplace by VAT number.
* Added absence integration for ESS systems.
* Added extra relevant properties 'StartMovement', 'StartWork', 'StopWork', 'StopMovement' and 'NormalWorkedHours' have been added to postcalculation export.
* Added extra properties to fueltransactions.
## May 2019
* Added Link URLs
* Changed preferred host to api.intellitracer.be
## April 2019
* Added fuel transactions
* Added group membership information to users, point-of-interests and vehicles
paths:
/api/v1/resourcegroups:
get:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/IntelliTracer.ApiV1.ResourceGroup"
examples:
response:
value:
- Id: 00000000-0000-0000-0000-000000000000
Name: Employees
Type: 0
Code: "012345"
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Get resource groups
operationId: Get resource groups
description: |-
Returns a list of all resource groups.
*Privilege required: `Api: Resource read` or `Api: Resource management`*
x-resource: Resource groups
tags:
- Config
security:
- pat: []
/api/v1/resourcegroup:
get:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/IntelliTracer.ApiV1.ResourceGroup"
examples:
response:
value:
- Id: 00000000-0000-0000-0000-000000000000
Name: Employees
Type: 0
Code: "012345"
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Get resource groups by type
operationId: Get resource groups by type
description: >-
Returns a list of all resource groups of a certain resource type
(Vehicle, User, TimeClock, ...).
Possible resource types are explained in [Resource Types](#types-resourcetype).
*Privilege required: `Api: Resource read` or `Api: Resource management`*
x-resource: Resource groups
tags:
- Config
parameters:
- name: type
in: query
description: ""
required: true
example: "0"
schema:
type: number
x-enum-type: IntelliTracer.ApiV1.ResourceType
enum:
- "0"
- "1"
- "2"
- "3"
- "4"
- "5"
- "6"
- "7"
security:
- pat: []
put:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Id:
type: string
Name:
type: string
Type:
type: number
x-enum-type: IntelliTracer.ApiV1.ResourceType
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
description: (default = 0)
Code:
description: (default = null)
nullable: true
type: string
_typeDescriptor:
type: string
required:
- Id
- Name
examples:
response:
value:
Id: 00000000-0000-0000-0000-000000000000
Name: Employees
Type: 0
Code: "012345"
"400":
description: BadRequest
headers: {}
content:
application/json:
schema:
type: object
properties:
Entity:
type: object
properties:
Id:
type: string
Name:
type: string
Type:
type: number
x-enum-type: IntelliTracer.ApiV1.ResourceType
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
description: (default = 0)
Code:
description: (default = null)
nullable: true
type: string
_typeDescriptor:
type: string
required:
- Id
- Name
ValidationResult:
type: array
items: {}
required:
- Entity
- ValidationResult
examples:
response:
value:
Entity:
Id: 00000000-0000-0000-0000-000000000000
Name: Employees
Type: 0
Code: "012345"
ValidationResult:
- Message: ""
SourceMemberNames: []
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Create resource group
operationId: Create resource group
description: |-
Creates a new resource group.
*Privilege required: `Api: Resource management`*
x-resource: Resource groups
tags:
- Config
requestBody:
content:
application/json:
schema:
type: object
properties:
Name:
type: string
Type:
type: number
x-enum-type: IntelliTracer.ApiV1.ResourceType
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
description: (default = 0)
Code:
description: (default = null)
nullable: true
type: string
required:
- Name
- Type
example:
Name: Employees
Type: 0
Code: "012345"
security:
- pat: []
post:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Id:
type: string
Name:
type: string
Type:
type: number
x-enum-type: IntelliTracer.ApiV1.ResourceType
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
description: (default = 0)
Code:
description: (default = null)
nullable: true
type: string
_typeDescriptor:
type: string
required:
- Id
- Name
examples:
response:
value:
Id: 00000000-0000-0000-0000-000000000000
Name: Employees
Type: 0
Code: "012345"
"400":
description: BadRequest
headers: {}
content:
application/json:
schema:
type: object
properties:
Entity:
type: object
properties:
Id:
type: string
Name:
type: string
Type:
type: number
x-enum-type: IntelliTracer.ApiV1.ResourceType
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
description: (default = 0)
Code:
description: (default = null)
nullable: true
type: string
_typeDescriptor:
type: string
required:
- Id
- Name
ValidationResult:
type: array
items: {}
required:
- Entity
- ValidationResult
examples:
response:
value:
Entity:
Id: 00000000-0000-0000-0000-000000000000
Name: Employees
Type: 0
Code: "012345"
ValidationResult:
- Message: ""
SourceMemberNames: []
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Update resource group
operationId: Update resource group
description: |-
Updates a resource group.
*Privilege required: `Api: Resource management`*
x-resource: Resource groups
tags:
- Config
requestBody:
content:
application/json:
schema:
type: object
properties:
Id:
type: string
Name:
type: string
Code:
description: (default = null)
nullable: true
type: string
required:
- Id
- Name
example:
Id: 00000000-0000-0000-0000-000000000000
Name: Employees
Code: "012345"
security:
- pat: []
delete:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Id:
type: string
Name:
type: string
Type:
type: number
x-enum-type: IntelliTracer.ApiV1.ResourceType
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
description: (default = 0)
Code:
description: (default = null)
nullable: true
type: string
_typeDescriptor:
type: string
required:
- Id
- Name
examples:
response:
value:
Id: 00000000-0000-0000-0000-000000000000
Name: Employees
Type: 0
Code: "012345"
"400":
description: BadRequest
headers: {}
content:
application/json:
schema:
type: object
properties:
Entity:
type: object
properties:
Id:
type: string
Name:
type: string
Type:
type: number
x-enum-type: IntelliTracer.ApiV1.ResourceType
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
description: (default = 0)
Code:
description: (default = null)
nullable: true
type: string
_typeDescriptor:
type: string
required:
- Id
- Name
ValidationResult:
type: array
items: {}
required:
- Entity
- ValidationResult
examples:
response:
value:
Entity:
Id: 00000000-0000-0000-0000-000000000000
Name: Employees
Type: 0
Code: "012345"
ValidationResult:
- Message: ""
SourceMemberNames: []
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Delete resource group
operationId: Delete resource group
description: |-
Deletes a resource group.
*Privilege required: `Api: Resource management`*
x-resource: Resource groups
tags:
- Config
requestBody:
content:
application/json:
schema:
type: object
properties:
Id:
type: string
Type:
type: number
x-enum-type: IntelliTracer.ApiV1.ResourceType
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
description: "(default = 0) "
required:
- Id
- Type
example:
Id: 00000000-0000-0000-0000-000000000000
Type: 0
security:
- pat: []
"/api/v1/resourcegroup/{id}/resources":
get:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/IntelliTracer.ApiV1.Resource"
examples:
response:
value:
- Id: 00000000-0000-0000-0000-000000000000
Name: John Doe
Code: "012345"
Type: 0
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Get resources of resource group
operationId: Get resources of resource group
description: |-
Returns a list of all resources of a resource group.
*Privilege required: `Api: Resource read` or `Api: Resource management`*
x-resource: Resource group - Resources
tags:
- Config
parameters:
- name: id
in: path
description: ""
required: true
example: 00000000-0000-0000-0000-000000000000
schema:
type: string
security:
- pat: []
put:
responses:
"200":
description: OK
headers: {}
"400":
description: BadRequest
headers: {}
content:
application/json:
schema:
type: object
properties:
Entity:
type: object
properties:
Id:
type: string
Name:
type: string
Type:
type: number
x-enum-type: IntelliTracer.ApiV1.ResourceType
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
description: (default = 0)
Code:
description: (default = null)
nullable: true
type: string
_typeDescriptor:
type: string
required:
- Id
- Name
ValidationResult:
type: array
items: {}
required:
- Entity
- ValidationResult
examples:
response:
value:
Entity:
Id: 00000000-0000-0000-0000-000000000000
Name: Employees
Type: 0
Code: "012345"
ValidationResult:
- Message: ""
SourceMemberNames: []
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Add resources to resource group
operationId: Add resources to resource group
description: >-
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](#types-resourcetype).
*Privilege required: `Api: Resource management`*
x-resource: Resource group - Resources
tags:
- Config
parameters:
- name: id
in: path
description: ""
required: true
example: 00000000-0000-0000-0000-000000000000
schema:
type: string
- name: type
in: query
description: ""
required: true
example: "0"
schema:
type: number
x-enum-type: IntelliTracer.ApiV1.ResourceType
enum:
- "0"
- "1"
- "2"
- "3"
- "4"
- "5"
- "6"
- "7"
requestBody:
$ref: "#/components/requestBodies/Add_resources_to_resource_groupBody"
security:
- pat: []
delete:
responses:
"200":
description: OK
headers: {}
"400":
description: BadRequest
headers: {}
content:
application/json:
schema:
type: object
properties:
Entity:
type: object
properties:
Id:
type: string
Name:
type: string
Type:
type: number
x-enum-type: IntelliTracer.ApiV1.ResourceType
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
description: (default = 0)
Code:
description: (default = null)
nullable: true
type: string
_typeDescriptor:
type: string
required:
- Id
- Name
ValidationResult:
type: array
items: {}
required:
- Entity
- ValidationResult
examples:
response:
value:
Entity:
Id: 00000000-0000-0000-0000-000000000000
Name: Employees
Type: 0
Code: "012345"
ValidationResult:
- Message: ""
SourceMemberNames: []
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Remove resources from resource group
operationId: Remove resources from resource group
description: >-
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`.
*Privilege required: `Api: Resource management`*
x-resource: Resource group - Resources
tags:
- Config
parameters:
- name: id
in: path
description: ""
required: true
example: 00000000-0000-0000-0000-000000000000
schema:
type: string
requestBody:
$ref: "#/components/requestBodies/Remove_resources_from_resource_groupBody"
security:
- pat: []
/api/v1/vehicle:
get:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/IntelliTracer.ApiV1.Vehicle"
examples:
response:
value:
- 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"
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Get vehicles
operationId: Get vehicles
description: >-
Returns a list of all vehicles.
*Privilege required: `Api: Resource read` or `Api: Resource management`*
x-resource: Vehicles
tags:
- Config
security:
- pat: []
put:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Id:
type: string
Name:
type: string
IvrCode:
description: >-
(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.
nullable: true
type: number
Code:
description: (default = null)
nullable: true
type: string
Category:
type: number
x-enum-type: IntelliTracer.Domain.VehicleCategory
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
description: >-
(default = 0)
The type of vehicle (see the overview of all options below). Only used in IntelliTracer V3.
FuelType:
x-enum-type: IntelliTracer.Domain.VehicleFuelType
anyOf:
- type: number
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- type: string
enum:
- "1"
description: (default = 0)
Co2Emission:
description: >-
(default = null)
Average C02 emission for this vehicle in grams per kilometer. Only used in IntelliTracer V3.
nullable: true
type: number
RowOfSeatsCount:
description: >-
(default = null)
Amount of seat rows in the vehicle. Only used in IntelliTracer V3.
nullable: true
type: number
SeatsCount:
description: >-
(default = null)
Amount of seats in the vehicle. Only used in IntelliTracer V3.
nullable: true
type: number
LicensePlate:
description: (default = null)
nullable: true
type: string
VinNumber:
description: |-
(default = null)
Vehicle identification number.
nullable: true
type: string
HasTrackingData:
type: boolean
description: (default = false)
LastReportDate:
description: >-
(default = null)
Date and time of the most recent tracking report we have received from this vehicle.
nullable: true
type: string
LastSyncDate:
description: >-
(default = null)
Date and time of the most recent sync report we have received from this vehicle.
nullable: true
type: string
UserNotes:
description: >-
(default = null)
Any additional information of your choice can be entered here.
nullable: true
type: string
Weight:
type: number
description: |-
(default = 0)
Weight of this vehicle in kilograms.
EmissionStandard:
x-enum-type: IntelliTracer.Domain.VehicleEuropeanEmissionStandard
anyOf:
- type: number
enum:
- 0
- 100
- 200
- 300
- 400
- 500
- 600
- type: string
enum:
- "300"
description: |-
(default = 0)
European emission standard for this vehicle.
MaximumSpeed:
description: (default = null)
nullable: true
type: number
NominalConsumption:
type: number
description: |-
(default = 0.0)
Fuel consumption of this vehicle in liters per 100km.
CostCenter:
properties:
Id:
type: string
Name:
type: string
Code:
description: (default = null)
nullable: true
type: string
Poi:
properties:
Id:
type: string
Name:
type: string
Code:
description: (default = null)
nullable: true
type: string
PoiType:
properties:
Id:
type: string
Name:
type: string
Color:
description: >-
(default = null)
Color to be used for POIs of this type in IntelliTracer.
nullable: true
type: string
_typeDescriptor:
type: string
required:
- Id
- Name
description: (default = null)
nullable: true
type: object
IsAssetLocation:
type: boolean
description: (default = false)
Street:
description: (default = null)
nullable: true
type: string
HouseNumber:
description: (default = null)
nullable: true
type: string
City:
description: (default = null)
nullable: true
type: string
Submunicipality:
description: (default = null)
nullable: true
type: string
PostalCode:
description: (default = null)
nullable: true
type: string
Country:
type: number
x-enum-type: IntelliTracer.Domain.Country
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
- 47
- 48
- 49
- 50
- 51
- 52
- 53
- 54
- 55
- 56
- 57
- 58
- 59
- 60
- 61
- 62
- 63
- 64
- 65
- 66
- 67
- 68
- 69
- 70
- 71
- 72
- 73
- 74
- 75
- 76
- 77
- 78
- 79
- 80
- 81
- 82
- 83
- 84
- 85
- 86
- 87
- 88
- 89
- 90
- 91
- 92
- 93
- 94
- 95
- 96
- 97
- 98
- 99
- 100
- 101
- 102
- 103
- 104
- 105
- 106
- 107
- 108
- 109
- 110
- 111
- 112
- 113
- 114
- 115
- 116
- 117
- 118
- 119
- 120
- 121
- 122
- 123
- 124
- 125
- 126
- 127
- 128
- 129
- 130
- 131
- 132
- 133
- 134
- 135
- 136
- 137
- 138
- 139
- 140
- 141
- 142
- 143
- 144
- 145
- 146
- 147
- 148
- 149
- 150
- 151
- 152
- 153
- 9999
description: (default = 0)
Priority:
x-enum-type: IntelliTracer.ApiV1.PoiPriority
enum:
- "-"
- "0"
- "1"
- "2"
- "3"
- "4"
- "5"
- "6"
- "7"
- "8"
- "9"
- "0"
- null
description: >-
(default = null)
Determines which POI will be displayed on top in IntelliTracer (in case of overlapping POIs).
nullable: true
type: string
Description:
description: (default = null)
nullable: true
type: string
GeographyWkt:
description: >-
(default = null)
The coordinates of all points that define the shape of the POI.
nullable: true
type: string
LonMin:
type: number
description: >-
(default = 0.0)
Lowest longitude coordinate of the shape of the POI.
LonMax:
type: number
description: >-
(default = 0.0)
Highest longitude coordinate of the shape of the POI.
LatMin:
type: number
description: >-
(default = 0.0)
Lowest latitude coordinate of the shape of the POI.
LatMax:
type: number
description: >-
(default = 0.0)
Highest latitude coordinate of the shape of the POI.
MarkerLon:
description: |-
(default = null)
Longitude coordinate of the marker.
nullable: true
type: number
MarkerLat:
description: |-
(default = null)
Latitude coordinate of the marker.
nullable: true
type: number
IsLambert72:
type: boolean
description: >-
(default = false)
Different geological projection system often used by Belgian governmental institutes.
Radius:
description: >-
(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).
nullable: true
type: number
ReverseGeocoding:
description: >-
(default = false)
Indicates whether location will be determined by position or address.
nullable: true
type: boolean
Groups:
description: (default = null)
nullable: true
type: array
items: {}
_typeDescriptor:
type: string
required:
- Id
- Name
description: (default = null)
nullable: true
type: object
_typeDescriptor:
type: string
required:
- Id
- Name
description: >-
(default = null)
In case work in this vehicle should always be linked to a certain costcenter, that costcenter can be entered here.
nullable: true
type: object
Groups:
description: "(default = null) "
nullable: true
type: array
items: {}
_typeDescriptor:
type: string
required:
- Id
- Name
examples:
response:
value:
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"
"400":
description: BadRequest
headers: {}
content:
application/json:
schema:
$ref: "#/components/schemas/IntelliTracer.ApiV1.VehicleValidationResult"
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Create vehicle
operationId: Create vehicle
description: |-
Creates a new vehicle.
*Privilege required: `Api: Resource management`*
x-resource: Vehicles
tags:
- Config
requestBody:
content:
application/json:
schema:
type: object
properties:
Name:
type: string
IvrCode:
description: >-
(default = null)
Code field that can be used for IVR based identification and app based filtering.
nullable: true
type: string
Code:
description: (default = null)
nullable: true
type: string
Category:
type: number
x-enum-type: IntelliTracer.Domain.VehicleCategory
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
description: >-
(default = 0)
A vehicle category classifies a land vehicle for regulatory purposes.
FuelType:
x-enum-type: IntelliTracer.Domain.VehicleFuelType
anyOf:
- type: number
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- type: string
enum:
- "1"
description: (default = 0)
Co2Emission:
description: (default = null)
nullable: true
type: number
RowOfSeatsCount:
description: |-
(default = null)
Number of seat rows
nullable: true
type: number
SeatsCount:
description: |-
(default = null)
Number of seats
nullable: true
type: number
LicensePlate:
description: (default = null)
nullable: true
type: string
VinNumber:
description: |-
(default = null)
Vehicle Identification Number
nullable: true
type: string
HasTrackingData:
type: boolean
description: (default = false)
LastReportDate:
description: |-
(default = null)
Datetime of the most recent report.
nullable: true
type: string
LastSyncDate:
description: |-
(default = null)
Datetime of the most recent server synchronization.
nullable: true
type: string
UserNotes:
description: |-
(default = null)
User notes
nullable: true
type: string
Weight:
type: number
description: |-
(default = 0)
Weight for viapass.
EmissionStandard:
x-enum-type: IntelliTracer.Domain.VehicleEuropeanEmissionStandard
anyOf:
- type: number
enum:
- 0
- 100
- 200
- 300
- 400
- 500
- 600
- type: string
enum:
- "300"
description: |-
(default = 0)
Emission standard for viapass
MaximumSpeed:
description: (default = null)
nullable: true
type: number
NominalConsumption:
type: number
description: |-
(default = 0.0)
Normal consumption for Fleet Eco
CostCenter:
properties:
Id:
type: string
required:
- Id
description: |-
(default = null)
Selected Cost Center
nullable: true
type: object
required:
- Name
example:
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
security:
- pat: []
post:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Id:
type: string
Name:
type: string
IvrCode:
description: >-
(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.
nullable: true
type: number
Code:
description: (default = null)
nullable: true
type: string
Category:
type: number
x-enum-type: IntelliTracer.Domain.VehicleCategory
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
description: >-
(default = 0)
The type of vehicle (see the overview of all options below). Only used in IntelliTracer V3.
FuelType:
x-enum-type: IntelliTracer.Domain.VehicleFuelType
anyOf:
- type: number
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- type: string
enum:
- "1"
description: (default = 0)
Co2Emission:
description: >-
(default = null)
Average C02 emission for this vehicle in grams per kilometer. Only used in IntelliTracer V3.
nullable: true
type: number
RowOfSeatsCount:
description: >-
(default = null)
Amount of seat rows in the vehicle. Only used in IntelliTracer V3.
nullable: true
type: number
SeatsCount:
description: >-
(default = null)
Amount of seats in the vehicle. Only used in IntelliTracer V3.
nullable: true
type: number
LicensePlate:
description: (default = null)
nullable: true
type: string
VinNumber:
description: |-
(default = null)
Vehicle identification number.
nullable: true
type: string
HasTrackingData:
type: boolean
description: (default = false)
LastReportDate:
description: >-
(default = null)
Date and time of the most recent tracking report we have received from this vehicle.
nullable: true
type: string
LastSyncDate:
description: >-
(default = null)
Date and time of the most recent sync report we have received from this vehicle.
nullable: true
type: string
UserNotes:
description: >-
(default = null)
Any additional information of your choice can be entered here.
nullable: true
type: string
Weight:
type: number
description: |-
(default = 0)
Weight of this vehicle in kilograms.
EmissionStandard:
x-enum-type: IntelliTracer.Domain.VehicleEuropeanEmissionStandard
anyOf:
- type: number
enum:
- 0
- 100
- 200
- 300
- 400
- 500
- 600
- type: string
enum:
- "300"
description: |-
(default = 0)
European emission standard for this vehicle.
MaximumSpeed:
description: (default = null)
nullable: true
type: number
NominalConsumption:
type: number
description: |-
(default = 0.0)
Fuel consumption of this vehicle in liters per 100km.
CostCenter:
properties:
Id:
type: string
Name:
type: string
Code:
description: (default = null)
nullable: true
type: string
Poi:
properties:
Id:
type: string
Name:
type: string
Code:
description: (default = null)
nullable: true
type: string
PoiType:
properties:
Id:
type: string
Name:
type: string
Color:
description: >-
(default = null)
Color to be used for POIs of this type in IntelliTracer.
nullable: true
type: string
_typeDescriptor:
type: string
required:
- Id
- Name
description: (default = null)
nullable: true
type: object
IsAssetLocation:
type: boolean
description: (default = false)
Street:
description: (default = null)
nullable: true
type: string
HouseNumber:
description: (default = null)
nullable: true
type: string
City:
description: (default = null)
nullable: true
type: string
Submunicipality:
description: (default = null)
nullable: true
type: string
PostalCode:
description: (default = null)
nullable: true
type: string
Country:
type: number
x-enum-type: IntelliTracer.Domain.Country
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
- 47
- 48
- 49
- 50
- 51
- 52
- 53
- 54
- 55
- 56
- 57
- 58
- 59
- 60
- 61
- 62
- 63
- 64
- 65
- 66
- 67
- 68
- 69
- 70
- 71
- 72
- 73
- 74
- 75
- 76
- 77
- 78
- 79
- 80
- 81
- 82
- 83
- 84
- 85
- 86
- 87
- 88
- 89
- 90
- 91
- 92
- 93
- 94
- 95
- 96
- 97
- 98
- 99
- 100
- 101
- 102
- 103
- 104
- 105
- 106
- 107
- 108
- 109
- 110
- 111
- 112
- 113
- 114
- 115
- 116
- 117
- 118
- 119
- 120
- 121
- 122
- 123
- 124
- 125
- 126
- 127
- 128
- 129
- 130
- 131
- 132
- 133
- 134
- 135
- 136
- 137
- 138
- 139
- 140
- 141
- 142
- 143
- 144
- 145
- 146
- 147
- 148
- 149
- 150
- 151
- 152
- 153
- 9999
description: (default = 0)
Priority:
x-enum-type: IntelliTracer.ApiV1.PoiPriority
enum:
- "-"
- "0"
- "1"
- "2"
- "3"
- "4"
- "5"
- "6"
- "7"
- "8"
- "9"
- "0"
- null
description: >-
(default = null)
Determines which POI will be displayed on top in IntelliTracer (in case of overlapping POIs).
nullable: true
type: string
Description:
description: (default = null)
nullable: true
type: string
GeographyWkt:
description: >-
(default = null)
The coordinates of all points that define the shape of the POI.
nullable: true
type: string
LonMin:
type: number
description: >-
(default = 0.0)
Lowest longitude coordinate of the shape of the POI.
LonMax:
type: number
description: >-
(default = 0.0)
Highest longitude coordinate of the shape of the POI.
LatMin:
type: number
description: >-
(default = 0.0)
Lowest latitude coordinate of the shape of the POI.
LatMax:
type: number
description: >-
(default = 0.0)
Highest latitude coordinate of the shape of the POI.
MarkerLon:
description: |-
(default = null)
Longitude coordinate of the marker.
nullable: true
type: number
MarkerLat:
description: |-
(default = null)
Latitude coordinate of the marker.
nullable: true
type: number
IsLambert72:
type: boolean
description: >-
(default = false)
Different geological projection system often used by Belgian governmental institutes.
Radius:
description: >-
(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).
nullable: true
type: number
ReverseGeocoding:
description: >-
(default = false)
Indicates whether location will be determined by position or address.
nullable: true
type: boolean
Groups:
description: (default = null)
nullable: true
type: array
items: {}
_typeDescriptor:
type: string
required:
- Id
- Name
description: (default = null)
nullable: true
type: object
_typeDescriptor:
type: string
required:
- Id
- Name
description: >-
(default = null)
In case work in this vehicle should always be linked to a certain costcenter, that costcenter can be entered here.
nullable: true
type: object
Groups:
description: "(default = null) "
nullable: true
type: array
items: {}
_typeDescriptor:
type: string
required:
- Id
- Name
examples:
response:
value:
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"
"400":
description: BadRequest
headers: {}
content:
application/json:
schema:
$ref: "#/components/schemas/IntelliTracer.ApiV1.VehicleValidationResult"
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Update vehicle
operationId: Update vehicle
description: |-
Updates an existing vehicle.
*Privilege required: `Api: Resource management`*
x-resource: Vehicles
tags:
- Config
requestBody:
content:
application/json:
schema:
type: object
properties:
Id:
type: string
Name:
type: string
IvrCode:
description: >-
(default = null)
Code field that can be used for IVR based identification and app based filtering.
nullable: true
type: string
Code:
description: (default = null)
nullable: true
type: string
Category:
type: number
x-enum-type: IntelliTracer.Domain.VehicleCategory
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
description: >-
(default = 0)
A vehicle category classifies a land vehicle for regulatory purposes.
FuelType:
x-enum-type: IntelliTracer.Domain.VehicleFuelType
anyOf:
- type: number
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- type: string
enum:
- "1"
description: (default = 0)
Co2Emission:
description: (default = null)
nullable: true
type: number
RowOfSeatsCount:
description: |-
(default = null)
Number of seat rows
nullable: true
type: number
SeatsCount:
description: |-
(default = null)
Number of seats
nullable: true
type: number
LicensePlate:
description: (default = null)
nullable: true
type: string
VinNumber:
description: |-
(default = null)
Vehicle Identification Number
nullable: true
type: string
HasTrackingData:
type: boolean
description: (default = false)
LastReportDate:
description: |-
(default = null)
Datetime of the most recent report.
nullable: true
type: string
LastSyncDate:
description: |-
(default = null)
Datetime of the most recent server synchronization.
nullable: true
type: string
UserNotes:
description: |-
(default = null)
User notes
nullable: true
type: string
Weight:
type: number
description: |-
(default = 0)
Weight for viapass.
EmissionStandard:
x-enum-type: IntelliTracer.Domain.VehicleEuropeanEmissionStandard
anyOf:
- type: number
enum:
- 0
- 100
- 200
- 300
- 400
- 500
- 600
- type: string
enum:
- "300"
description: |-
(default = 0)
Emission standard for viapass
MaximumSpeed:
description: (default = null)
nullable: true
type: number
NominalConsumption:
type: number
description: |-
(default = 0.0)
Normal consumption for Fleet Eco
CostCenter:
properties:
Id:
type: string
required:
- Id
description: |-
(default = null)
Selected Cost Center
nullable: true
type: object
required:
- Id
- Name
example:
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
security:
- pat: []
"/api/v1/vehicle/{id}":
get:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Id:
type: string
Name:
type: string
IvrCode:
description: >-
(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.
nullable: true
type: number
Code:
description: (default = null)
nullable: true
type: string
Category:
type: number
x-enum-type: IntelliTracer.Domain.VehicleCategory
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
description: >-
(default = 0)
The type of vehicle (see the overview of all options below). Only used in IntelliTracer V3.
FuelType:
x-enum-type: IntelliTracer.Domain.VehicleFuelType
anyOf:
- type: number
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- type: string
enum:
- "1"
description: (default = 0)
Co2Emission:
description: >-
(default = null)
Average C02 emission for this vehicle in grams per kilometer. Only used in IntelliTracer V3.
nullable: true
type: number
RowOfSeatsCount:
description: >-
(default = null)
Amount of seat rows in the vehicle. Only used in IntelliTracer V3.
nullable: true
type: number
SeatsCount:
description: >-
(default = null)
Amount of seats in the vehicle. Only used in IntelliTracer V3.
nullable: true
type: number
LicensePlate:
description: (default = null)
nullable: true
type: string
VinNumber:
description: |-
(default = null)
Vehicle identification number.
nullable: true
type: string
HasTrackingData:
type: boolean
description: (default = false)
LastReportDate:
description: >-
(default = null)
Date and time of the most recent tracking report we have received from this vehicle.
nullable: true
type: string
LastSyncDate:
description: >-
(default = null)
Date and time of the most recent sync report we have received from this vehicle.
nullable: true
type: string
UserNotes:
description: >-
(default = null)
Any additional information of your choice can be entered here.
nullable: true
type: string
Weight:
type: number
description: |-
(default = 0)
Weight of this vehicle in kilograms.
EmissionStandard:
x-enum-type: IntelliTracer.Domain.VehicleEuropeanEmissionStandard
anyOf:
- type: number
enum:
- 0
- 100
- 200
- 300
- 400
- 500
- 600
- type: string
enum:
- "300"
description: |-
(default = 0)
European emission standard for this vehicle.
MaximumSpeed:
description: (default = null)
nullable: true
type: number
NominalConsumption:
type: number
description: |-
(default = 0.0)
Fuel consumption of this vehicle in liters per 100km.
CostCenter:
properties:
Id:
type: string
Name:
type: string
Code:
description: (default = null)
nullable: true
type: string
Poi:
properties:
Id:
type: string
Name:
type: string
Code:
description: (default = null)
nullable: true
type: string
PoiType:
properties:
Id:
type: string
Name:
type: string
Color:
description: >-
(default = null)
Color to be used for POIs of this type in IntelliTracer.
nullable: true
type: string
_typeDescriptor:
type: string
required:
- Id
- Name
description: (default = null)
nullable: true
type: object
IsAssetLocation:
type: boolean
description: (default = false)
Street:
description: (default = null)
nullable: true
type: string
HouseNumber:
description: (default = null)
nullable: true
type: string
City:
description: (default = null)
nullable: true
type: string
Submunicipality:
description: (default = null)
nullable: true
type: string
PostalCode:
description: (default = null)
nullable: true
type: string
Country:
type: number
x-enum-type: IntelliTracer.Domain.Country
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
- 47
- 48
- 49
- 50
- 51
- 52
- 53
- 54
- 55
- 56
- 57
- 58
- 59
- 60
- 61
- 62
- 63
- 64
- 65
- 66
- 67
- 68
- 69
- 70
- 71
- 72
- 73
- 74
- 75
- 76
- 77
- 78
- 79
- 80
- 81
- 82
- 83
- 84
- 85
- 86
- 87
- 88
- 89
- 90
- 91
- 92
- 93
- 94
- 95
- 96
- 97
- 98
- 99
- 100
- 101
- 102
- 103
- 104
- 105
- 106
- 107
- 108
- 109
- 110
- 111
- 112
- 113
- 114
- 115
- 116
- 117
- 118
- 119
- 120
- 121
- 122
- 123
- 124
- 125
- 126
- 127
- 128
- 129
- 130
- 131
- 132
- 133
- 134
- 135
- 136
- 137
- 138
- 139
- 140
- 141
- 142
- 143
- 144
- 145
- 146
- 147
- 148
- 149
- 150
- 151
- 152
- 153
- 9999
description: (default = 0)
Priority:
x-enum-type: IntelliTracer.ApiV1.PoiPriority
enum:
- "-"
- "0"
- "1"
- "2"
- "3"
- "4"
- "5"
- "6"
- "7"
- "8"
- "9"
- "0"
- null
description: >-
(default = null)
Determines which POI will be displayed on top in IntelliTracer (in case of overlapping POIs).
nullable: true
type: string
Description:
description: (default = null)
nullable: true
type: string
GeographyWkt:
description: >-
(default = null)
The coordinates of all points that define the shape of the POI.
nullable: true
type: string
LonMin:
type: number
description: >-
(default = 0.0)
Lowest longitude coordinate of the shape of the POI.
LonMax:
type: number
description: >-
(default = 0.0)
Highest longitude coordinate of the shape of the POI.
LatMin:
type: number
description: >-
(default = 0.0)
Lowest latitude coordinate of the shape of the POI.
LatMax:
type: number
description: >-
(default = 0.0)
Highest latitude coordinate of the shape of the POI.
MarkerLon:
description: |-
(default = null)
Longitude coordinate of the marker.
nullable: true
type: number
MarkerLat:
description: |-
(default = null)
Latitude coordinate of the marker.
nullable: true
type: number
IsLambert72:
type: boolean
description: >-
(default = false)
Different geological projection system often used by Belgian governmental institutes.
Radius:
description: >-
(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).
nullable: true
type: number
ReverseGeocoding:
description: >-
(default = false)
Indicates whether location will be determined by position or address.
nullable: true
type: boolean
Groups:
description: (default = null)
nullable: true
type: array
items: {}
_typeDescriptor:
type: string
required:
- Id
- Name
description: (default = null)
nullable: true
type: object
_typeDescriptor:
type: string
required:
- Id
- Name
description: >-
(default = null)
In case work in this vehicle should always be linked to a certain costcenter, that costcenter can be entered here.
nullable: true
type: object
Groups:
description: "(default = null) "
nullable: true
type: array
items: {}
_typeDescriptor:
type: string
required:
- Id
- Name
examples:
response:
value:
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"
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Get vehicle
operationId: Get vehicle
description: >-
Returns a vehicle by id.
*Privilege required: `Api: Resource read` or `Api: Resource management`*
x-resource: Vehicles
tags:
- Config
parameters:
- name: id
in: path
description: ""
required: true
example: 00000000-0000-0000-0000-000000000000
schema:
type: string
security:
- pat: []
"/api/v2/timeclock?page={page}&search={search}":
get:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Data:
description: (default = null)
nullable: true
type: array
items: {}
PagingFilter:
properties:
Page:
type: number
Search:
nullable: true
type: string
PageCount:
type: number
TotalCount:
type: number
Links:
type: object
properties:
Base:
type: string
First:
type: string
Prev:
type: string
Next:
type: string
Last:
type: string
required:
- Base
required:
- Page
- PageCount
- TotalCount
- Links
description: (default = null)
nullable: true
type: object
examples:
response:
value:
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
PagingFilter:
Page: 1
Search: ABC
PageCount: 4
TotalCount: 100
Links:
Base: https://api.intellitracer.be
First: /api/v2/asset?page=1
Prev: /api/v2/asset?page=2
Next: /api/v2/asset?page=4
Last: /api/v2/asset?page=4
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Get timeclocks
operationId: Get timeclocks
description: |-
Returns a paged list of time clocks.
Pagination and searching is explained in [Pagination](#pagination).
*Privilege required: `Api: Resource read` or `Api: Resource management`*
x-resource: Timeclocks
tags:
- Config
parameters:
- name: page
in: path
description: ""
required: true
example: "1"
schema:
type: number
- name: search
in: path
description: ""
required: true
example: ABC
schema:
type: string
security:
- pat: []
"/api/v2/timeclock/{id}":
get:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Data:
properties:
Id:
type: string
Name:
type: string
Code:
description: (default = null)
nullable: true
type: string
UnitId:
type: number
SerialNumber:
description: (default = null)
nullable: true
type: string
ReaderType:
x-enum-type: IntelliTracer.ApiV2.TimeClockReaderType
anyOf:
- type: number
enum:
- 0
- 1
- 2
- 3
- type: string
enum:
- "0"
description: (default = 0)
TimeClockType:
x-enum-type: IntelliTracer.ApiV2.TimeClockType
anyOf:
- type: number
enum:
- 0
- 2
- 3
- 4
- 5
- 6
- 7
- type: string
enum:
- "0"
description: (default = 0)
FirmwareVersion:
x-enum-type: IntelliTracer.ApiV2.TimeClockFirmwareVersion
anyOf:
- type: number
enum:
- 0
- 1
- 2
- type: string
enum:
- "0"
description: (default = 0)
Address:
properties:
CountryName:
description: (default = null)
nullable: true
type: string
AddressLine:
description: (default = null)
nullable: true
type: string
PoiList:
description: |-
(default = null)
List of point-of-interests, the unique id only.
nullable: true
type: array
items: {}
City:
description: (default = null)
nullable: true
type: string
CityLine:
description: |-
(default = null)
The postalnumber, city and country as a text line.
nullable: true
type: string
CountryCode:
type: number
x-enum-type: IntelliTracer.Domain.Country
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
- 47
- 48
- 49
- 50
- 51
- 52
- 53
- 54
- 55
- 56
- 57
- 58
- 59
- 60
- 61
- 62
- 63
- 64
- 65
- 66
- 67
- 68
- 69
- 70
- 71
- 72
- 73
- 74
- 75
- 76
- 77
- 78
- 79
- 80
- 81
- 82
- 83
- 84
- 85
- 86
- 87
- 88
- 89
- 90
- 91
- 92
- 93
- 94
- 95
- 96
- 97
- 98
- 99
- 100
- 101
- 102
- 103
- 104
- 105
- 106
- 107
- 108
- 109
- 110
- 111
- 112
- 113
- 114
- 115
- 116
- 117
- 118
- 119
- 120
- 121
- 122
- 123
- 124
- 125
- 126
- 127
- 128
- 129
- 130
- 131
- 132
- 133
- 134
- 135
- 136
- 137
- 138
- 139
- 140
- 141
- 142
- 143
- 144
- 145
- 146
- 147
- 148
- 149
- 150
- 151
- 152
- 153
- 9999
description: (default = 0)
HouseNumber:
description: (default = null)
nullable: true
type: string
Latitude:
description: >-
(default = null)
Geographic coordinate that specifies the north–south position of a point on the Earth's surface.
nullable: true
type: number
Longitude:
description: >-
(default = null)
Geographic coordinate that specifies the east–west position of a point on the Earth's surface.
nullable: true
type: number
PostalCode:
nullable: true
type: string
ShortAddressLine:
description: (default = null)
nullable: true
type: string
Street:
description: (default = null)
nullable: true
type: string
StreetLine:
description: (default = null)
nullable: true
type: string
Submunicipality:
description: (default = null)
nullable: true
type: string
_typeDescriptor:
type: string
description: (default = null)
nullable: true
type: object
Latitude:
description: >-
(default = null)
Geographic coordinate that specifies the north–south position of a point on the Earth's surface.
nullable: true
type: number
Longitude:
description: >-
(default = null)
Geographic coordinate that specifies the east–west position of a point on the Earth's surface.
nullable: true
type: number
CostCenter:
properties:
Id:
type: string
Code:
description: (default = null)
nullable: true
type: string
Name:
type: string
Type:
type: number
x-enum-type: IntelliTracer.Domain.ResourceType
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
description: (default = 0)
required:
- Id
- Name
description: (default = null)
nullable: true
type: object
LastReadDateLocal:
description: (default = null)
nullable: true
type: string
LastReadDateUtc:
description: (default = null)
nullable: true
type: string
LastWriteDateLocal:
description: (default = null)
nullable: true
type: string
LastWriteDateUtc:
description: (default = null)
nullable: true
type: string
required:
- Id
- Name
- UnitId
- ReaderType
- TimeClockType
- FirmwareVersion
description: (default = null)
nullable: true
type: object
examples:
response:
value:
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
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"404":
description: NotFound
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Get timeclock
operationId: Get timeclock
description: |-
Returns a timeclock by id.
*Privilege required: `Api: Resource read` or `Api: Resource management`*
x-resource: Timeclocks
tags:
- Config
parameters:
- name: id
in: path
description: ""
required: true
example: 00000000-0000-0000-0000-000000000000
schema:
type: string
security:
- pat: []
/api/v2/timevalidation/day/verified:
get:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Data:
description: (default = null)
nullable: true
type: array
items: {}
examples:
response:
value:
Data:
- DateUtc: 2019-01-25T07:00:00
DateLocal: 2019-01-25T08:00:00
UserIds:
- 00000000-0000-0000-0000-000000000000
- 00000000-0000-0000-0000-000000000000
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Get verified days
operationId: Get verified days
description: |-
Returns a list of all verified days based on given parameters.
*Privilege required: `Api: Time validation`*
x-resource: Time Validation
tags:
- Config
parameters:
- name: fromDateUtc
in: query
description: ""
required: true
example: 2020-01-01
schema:
type: string
- name: verifiedSinceUtc
in: query
description: ""
required: true
example: 2020-01-01
schema:
type: string
security:
- pat: []
"/api/v2/poi?page={page}&search={search}":
get:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Data:
nullable: true
type: array
items: {}
PagingFilter:
properties:
Page:
type: number
Search:
nullable: true
type: string
PageCount:
type: number
TotalCount:
type: number
Links:
type: object
properties:
Base:
type: string
First:
type: string
Prev:
type: string
Next:
type: string
Last:
type: string
required:
- Base
required:
- Page
- PageCount
- TotalCount
- Links
nullable: true
type: object
examples:
response:
value:
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
PagingFilter:
Page: 1
Search: ABC
PageCount: 4
TotalCount: 100
Links:
Base: https://api.intellitracer.be
First: /api/v2/asset?page=1
Prev: /api/v2/asset?page=2
Next: /api/v2/asset?page=4
Last: /api/v2/asset?page=4
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Get points of interest
operationId: Get points of interest
description: |-
Returns a paged list of points of interest.
Pagination and searching is explained in [Pagination](#pagination).
*Privilege required: `Api: Poi's read` or `Api: Poi's edit`*
x-resource: Pois
tags:
- Config
parameters:
- name: page
in: path
description: ""
required: true
example: "1"
schema:
type: number
- name: search
in: path
description: ""
required: true
example: ABC
schema:
type: string
security:
- pat: []
"/api/v2/poi/inactive?page={page}&search={search}":
get:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Data:
nullable: true
type: array
items: {}
PagingFilter:
properties:
Page:
type: number
Search:
nullable: true
type: string
PageCount:
type: number
TotalCount:
type: number
Links:
type: object
properties:
Base:
type: string
First:
type: string
Prev:
type: string
Next:
type: string
Last:
type: string
required:
- Base
required:
- Page
- PageCount
- TotalCount
- Links
nullable: true
type: object
examples:
response:
value:
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
PagingFilter:
Page: 1
Search: ABC
PageCount: 4
TotalCount: 100
Links:
Base: https://api.intellitracer.be
First: /api/v2/asset?page=1
Prev: /api/v2/asset?page=2
Next: /api/v2/asset?page=4
Last: /api/v2/asset?page=4
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Get inactive points of interest
operationId: Get inactive points of interest
description: |-
Returns a paged list of inactive points of interest.
Pagination and searching is explained in [Pagination](#pagination).
*Privilege required: `Api: Poi's read` or `Api: Poi's edit`*
x-resource: Pois
tags:
- Config
parameters:
- name: page
in: path
description: ""
required: true
example: "1"
schema:
type: number
- name: search
in: path
description: ""
required: true
example: ABC
schema:
type: string
security:
- pat: []
"/api/v2/poi/{id}":
get:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Data:
properties:
Id:
type: string
Code:
description: (default = null)
nullable: true
type: string
Name:
type: string
Street:
description: (default = null)
nullable: true
type: string
HouseNumber:
description: (default = null)
nullable: true
type: string
City:
description: (default = null)
nullable: true
type: string
Submunicipality:
description: (default = null)
nullable: true
type: string
PostalCode:
description: (default = null)
nullable: true
type: string
Country:
type: number
x-enum-type: IntelliTracer.Domain.Country
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
- 47
- 48
- 49
- 50
- 51
- 52
- 53
- 54
- 55
- 56
- 57
- 58
- 59
- 60
- 61
- 62
- 63
- 64
- 65
- 66
- 67
- 68
- 69
- 70
- 71
- 72
- 73
- 74
- 75
- 76
- 77
- 78
- 79
- 80
- 81
- 82
- 83
- 84
- 85
- 86
- 87
- 88
- 89
- 90
- 91
- 92
- 93
- 94
- 95
- 96
- 97
- 98
- 99
- 100
- 101
- 102
- 103
- 104
- 105
- 106
- 107
- 108
- 109
- 110
- 111
- 112
- 113
- 114
- 115
- 116
- 117
- 118
- 119
- 120
- 121
- 122
- 123
- 124
- 125
- 126
- 127
- 128
- 129
- 130
- 131
- 132
- 133
- 134
- 135
- 136
- 137
- 138
- 139
- 140
- 141
- 142
- 143
- 144
- 145
- 146
- 147
- 148
- 149
- 150
- 151
- 152
- 153
- 9999
description: (default = 0)
Priority:
x-enum-type: IntelliTracer.ApiV1.PoiPriority
enum:
- "-"
- "0"
- "1"
- "2"
- "3"
- "4"
- "5"
- "6"
- "7"
- "8"
- "9"
- "0"
- null
description: (default = null)
nullable: true
type: string
Description:
description: (default = null)
nullable: true
type: string
GeographyWkt:
description: (default = null)
nullable: true
type: string
LonMin:
type: number
description: (default = 0.0)
LonMax:
type: number
description: (default = 0.0)
LatMin:
type: number
description: (default = 0.0)
LatMax:
type: number
description: (default = 0.0)
MarkerLon:
description: (default = null)P
nullable: true
type: number
MarkerLat:
description: (default = null)
nullable: true
type: number
IsAssetLocation:
type: boolean
description: (default = false)
Type:
properties:
Id:
type: string
Name:
type: string
Level:
type: number
x-enum-type: IntelliTracer.ApiV1.PoiTypeLevel
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
description: (default = 0)
Color:
description: (default = null)
nullable: true
type: string
required:
- Id
- Name
description: (default = null)
nullable: true
type: object
Groups:
description: (default = null)
nullable: true
type: array
items: {}
required:
- Id
- Name
- IsAssetLocation
description: (default = null)
nullable: true
type: object
examples:
response:
value:
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
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"404":
description: NotFound
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Get point of interest
operationId: Get point of interest
description: |-
Returns a point of interest by id.
*Privilege required: `Api: Poi's read` or `Api: Poi's edit`*
x-resource: Pois
tags:
- Config
parameters:
- name: id
in: path
description: ""
required: true
example: 00000000-0000-0000-0000-000000000000
schema:
type: string
security:
- pat: []
/api/v1/poi:
put:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Id:
type: string
Name:
type: string
Code:
description: (default = null)
nullable: true
type: string
PoiType:
properties:
Id:
type: string
Name:
type: string
Color:
description: >-
(default = null)
Color to be used for POIs of this type in IntelliTracer.
nullable: true
type: string
_typeDescriptor:
type: string
required:
- Id
- Name
description: (default = null)
nullable: true
type: object
IsAssetLocation:
type: boolean
description: (default = false)
Street:
description: (default = null)
nullable: true
type: string
HouseNumber:
description: (default = null)
nullable: true
type: string
City:
description: (default = null)
nullable: true
type: string
Submunicipality:
description: (default = null)
nullable: true
type: string
PostalCode:
description: (default = null)
nullable: true
type: string
Country:
type: number
x-enum-type: IntelliTracer.Domain.Country
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
- 47
- 48
- 49
- 50
- 51
- 52
- 53
- 54
- 55
- 56
- 57
- 58
- 59
- 60
- 61
- 62
- 63
- 64
- 65
- 66
- 67
- 68
- 69
- 70
- 71
- 72
- 73
- 74
- 75
- 76
- 77
- 78
- 79
- 80
- 81
- 82
- 83
- 84
- 85
- 86
- 87
- 88
- 89
- 90
- 91
- 92
- 93
- 94
- 95
- 96
- 97
- 98
- 99
- 100
- 101
- 102
- 103
- 104
- 105
- 106
- 107
- 108
- 109
- 110
- 111
- 112
- 113
- 114
- 115
- 116
- 117
- 118
- 119
- 120
- 121
- 122
- 123
- 124
- 125
- 126
- 127
- 128
- 129
- 130
- 131
- 132
- 133
- 134
- 135
- 136
- 137
- 138
- 139
- 140
- 141
- 142
- 143
- 144
- 145
- 146
- 147
- 148
- 149
- 150
- 151
- 152
- 153
- 9999
description: (default = 0)
Priority:
x-enum-type: IntelliTracer.ApiV1.PoiPriority
enum:
- "-"
- "0"
- "1"
- "2"
- "3"
- "4"
- "5"
- "6"
- "7"
- "8"
- "9"
- "0"
- null
description: >-
(default = null)
Determines which POI will be displayed on top in IntelliTracer (in case of overlapping POIs).
nullable: true
type: string
Description:
description: (default = null)
nullable: true
type: string
GeographyWkt:
description: >-
(default = null)
The coordinates of all points that define the shape of the POI.
nullable: true
type: string
LonMin:
type: number
description: |-
(default = 0.0)
Lowest longitude coordinate of the shape of the POI.
LonMax:
type: number
description: |-
(default = 0.0)
Highest longitude coordinate of the shape of the POI.
LatMin:
type: number
description: |-
(default = 0.0)
Lowest latitude coordinate of the shape of the POI.
LatMax:
type: number
description: |-
(default = 0.0)
Highest latitude coordinate of the shape of the POI.
MarkerLon:
description: |-
(default = null)
Longitude coordinate of the marker.
nullable: true
type: number
MarkerLat:
description: |-
(default = null)
Latitude coordinate of the marker.
nullable: true
type: number
IsLambert72:
type: boolean
description: >-
(default = false)
Different geological projection system often used by Belgian governmental institutes.
Radius:
description: >-
(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).
nullable: true
type: number
ReverseGeocoding:
description: >-
(default = false)
Indicates whether location will be determined by position or address.
nullable: true
type: boolean
Groups:
description: (default = null)
nullable: true
type: array
items: {}
_typeDescriptor:
type: string
required:
- Id
- Name
examples:
response:
value:
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
"400":
description: BadRequest
headers: {}
content:
application/json:
schema:
$ref: "#/components/schemas/IntelliTracer.ApiV1.PoiValidationResult"
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Create point of interest
operationId: Create point of interest
description: >-
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.
*Privilege required: `Api: Poi's edit`*
x-resource: Pois
tags:
- Config
requestBody:
content:
application/json:
schema:
type: object
properties:
Name:
type: string
description: max length = 50
Code:
description: |-
default = null
max length = 500
nullable: true
type: string
PoiType:
type: object
properties:
Id:
type: string
required:
- Id
description: (default = null)
IsAssetLocation:
type: boolean
description: (default = false)
Street:
description: |-
default = null
max length = 70
nullable: true
type: string
HouseNumber:
description: |-
default = null
max length = 10
nullable: true
type: string
City:
description: |-
default = null
max length = 70
nullable: true
type: string
Submunicipality:
description: |-
default = null
max length = 70
nullable: true
type: string
PostalCode:
description: |-
default = null
max length = 10
nullable: true
type: string
Country:
type: number
x-enum-type: IntelliTracer.Domain.Country
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
- 47
- 48
- 49
- 50
- 51
- 52
- 53
- 54
- 55
- 56
- 57
- 58
- 59
- 60
- 61
- 62
- 63
- 64
- 65
- 66
- 67
- 68
- 69
- 70
- 71
- 72
- 73
- 74
- 75
- 76
- 77
- 78
- 79
- 80
- 81
- 82
- 83
- 84
- 85
- 86
- 87
- 88
- 89
- 90
- 91
- 92
- 93
- 94
- 95
- 96
- 97
- 98
- 99
- 100
- 101
- 102
- 103
- 104
- 105
- 106
- 107
- 108
- 109
- 110
- 111
- 112
- 113
- 114
- 115
- 116
- 117
- 118
- 119
- 120
- 121
- 122
- 123
- 124
- 125
- 126
- 127
- 128
- 129
- 130
- 131
- 132
- 133
- 134
- 135
- 136
- 137
- 138
- 139
- 140
- 141
- 142
- 143
- 144
- 145
- 146
- 147
- 148
- 149
- 150
- 151
- 152
- 153
- 9999
description: (default = 0 or Belgium)
Priority:
type: string
x-enum-type: IntelliTracer.ApiV1.PoiPriority
enum:
- "-"
- "0"
- "1"
- "2"
- "3"
- "4"
- "5"
- "6"
- "7"
- "8"
- "9"
- "0"
description: >-
(default = -)
Determines which POI will be displayed on top in IntelliTracer (in case of overlapping POIs).
Description:
description: (default = null)
nullable: true
type: string
MarkerLon:
description: |-
(default = null)
Longitude coordinate
nullable: true
type: number
MarkerLat:
description: |-
(default = null)
Latitude coordinate
nullable: true
type: number
IsLambert72:
type: boolean
description: >-
(default = false)
Different geological projection system often used by Belgian governmental institutes.
Radius:
description: >-
(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).
nullable: true
type: number
ReverseGeocoding:
description: >-
(default = false)
Indicates whether location will be determined by position or address.
nullable: true
type: boolean
required:
- Name
- PoiType
- Priority
example:
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
security:
- pat: []
post:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Id:
type: string
Name:
type: string
Code:
description: (default = null)
nullable: true
type: string
PoiType:
properties:
Id:
type: string
Name:
type: string
Color:
description: >-
(default = null)
Color to be used for POIs of this type in IntelliTracer.
nullable: true
type: string
_typeDescriptor:
type: string
required:
- Id
- Name
description: (default = null)
nullable: true
type: object
IsAssetLocation:
type: boolean
description: (default = false)
Street:
description: (default = null)
nullable: true
type: string
HouseNumber:
description: (default = null)
nullable: true
type: string
City:
description: (default = null)
nullable: true
type: string
Submunicipality:
description: (default = null)
nullable: true
type: string
PostalCode:
description: (default = null)
nullable: true
type: string
Country:
type: number
x-enum-type: IntelliTracer.Domain.Country
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
- 47
- 48
- 49
- 50
- 51
- 52
- 53
- 54
- 55
- 56
- 57
- 58
- 59
- 60
- 61
- 62
- 63
- 64
- 65
- 66
- 67
- 68
- 69
- 70
- 71
- 72
- 73
- 74
- 75
- 76
- 77
- 78
- 79
- 80
- 81
- 82
- 83
- 84
- 85
- 86
- 87
- 88
- 89
- 90
- 91
- 92
- 93
- 94
- 95
- 96
- 97
- 98
- 99
- 100
- 101
- 102
- 103
- 104
- 105
- 106
- 107
- 108
- 109
- 110
- 111
- 112
- 113
- 114
- 115
- 116
- 117
- 118
- 119
- 120
- 121
- 122
- 123
- 124
- 125
- 126
- 127
- 128
- 129
- 130
- 131
- 132
- 133
- 134
- 135
- 136
- 137
- 138
- 139
- 140
- 141
- 142
- 143
- 144
- 145
- 146
- 147
- 148
- 149
- 150
- 151
- 152
- 153
- 9999
description: (default = 0)
Priority:
x-enum-type: IntelliTracer.ApiV1.PoiPriority
enum:
- "-"
- "0"
- "1"
- "2"
- "3"
- "4"
- "5"
- "6"
- "7"
- "8"
- "9"
- "0"
- null
description: >-
(default = null)
Determines which POI will be displayed on top in IntelliTracer (in case of overlapping POIs).
nullable: true
type: string
Description:
description: (default = null)
nullable: true
type: string
GeographyWkt:
description: >-
(default = null)
The coordinates of all points that define the shape of the POI.
nullable: true
type: string
LonMin:
type: number
description: |-
(default = 0.0)
Lowest longitude coordinate of the shape of the POI.
LonMax:
type: number
description: |-
(default = 0.0)
Highest longitude coordinate of the shape of the POI.
LatMin:
type: number
description: |-
(default = 0.0)
Lowest latitude coordinate of the shape of the POI.
LatMax:
type: number
description: |-
(default = 0.0)
Highest latitude coordinate of the shape of the POI.
MarkerLon:
description: |-
(default = null)
Longitude coordinate of the marker.
nullable: true
type: number
MarkerLat:
description: |-
(default = null)
Latitude coordinate of the marker.
nullable: true
type: number
IsLambert72:
type: boolean
description: >-
(default = false)
Different geological projection system often used by Belgian governmental institutes.
Radius:
description: >-
(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).
nullable: true
type: number
ReverseGeocoding:
description: >-
(default = false)
Indicates whether location will be determined by position or address.
nullable: true
type: boolean
Groups:
description: (default = null)
nullable: true
type: array
items: {}
_typeDescriptor:
type: string
required:
- Id
- Name
examples:
response:
value:
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
"400":
description: BadRequest
headers: {}
content:
application/json:
schema:
$ref: "#/components/schemas/IntelliTracer.ApiV1.PoiValidationResult"
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Update point of interest (with location change)
operationId: Update point of interest (with location change)
description: >-
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.
*Privilege required: `Api: Poi's edit`*
x-resource: Pois
tags:
- Config
requestBody:
content:
application/json:
schema:
type: object
properties:
Name:
type: string
description: max length = 50
Code:
description: |-
default = null
max length = 500
nullable: true
type: string
PoiType:
type: object
properties:
Id:
type: string
required:
- Id
description: (default = null)
IsAssetLocation:
type: boolean
description: (default = false)
Street:
description: |-
default = null
max length = 70
nullable: true
type: string
HouseNumber:
description: |-
default = null
max length = 10
nullable: true
type: string
City:
description: |-
default = null
max length = 70
nullable: true
type: string
Submunicipality:
description: |-
default = null
max length = 70
nullable: true
type: string
PostalCode:
description: |-
default = null
max length = 10
nullable: true
type: string
Country:
type: number
x-enum-type: IntelliTracer.Domain.Country
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
- 47
- 48
- 49
- 50
- 51
- 52
- 53
- 54
- 55
- 56
- 57
- 58
- 59
- 60
- 61
- 62
- 63
- 64
- 65
- 66
- 67
- 68
- 69
- 70
- 71
- 72
- 73
- 74
- 75
- 76
- 77
- 78
- 79
- 80
- 81
- 82
- 83
- 84
- 85
- 86
- 87
- 88
- 89
- 90
- 91
- 92
- 93
- 94
- 95
- 96
- 97
- 98
- 99
- 100
- 101
- 102
- 103
- 104
- 105
- 106
- 107
- 108
- 109
- 110
- 111
- 112
- 113
- 114
- 115
- 116
- 117
- 118
- 119
- 120
- 121
- 122
- 123
- 124
- 125
- 126
- 127
- 128
- 129
- 130
- 131
- 132
- 133
- 134
- 135
- 136
- 137
- 138
- 139
- 140
- 141
- 142
- 143
- 144
- 145
- 146
- 147
- 148
- 149
- 150
- 151
- 152
- 153
- 9999
description: (default = 0 or Belgium)
Priority:
type: string
x-enum-type: IntelliTracer.ApiV1.PoiPriority
enum:
- "-"
- "0"
- "1"
- "2"
- "3"
- "4"
- "5"
- "6"
- "7"
- "8"
- "9"
- "0"
description: >-
(default = -)
Determines which POI will be displayed on top in IntelliTracer (in case of overlapping POIs).
Description:
description: (default = null)
nullable: true
type: string
MarkerLon:
description: |-
(default = null)
Longitude coordinate
nullable: true
type: number
MarkerLat:
description: |-
(default = null)
Latitude coordinate
nullable: true
type: number
IsLambert72:
type: boolean
description: >-
(default = false)
Different geological projection system often used by Belgian governmental institutes.
Radius:
description: >-
(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).
nullable: true
type: number
ReverseGeocoding:
description: >-
(default = false)
Indicates whether location will be determined by position or address.
nullable: true
type: boolean
Id:
type: string
required:
- Name
- PoiType
- Priority
- Id
example:
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
security:
- pat: []
delete:
responses:
"200":
description: OK
headers: {}
"400":
description: BadRequest
headers: {}
content:
"*/*":
schema:
$ref: "#/components/schemas/IntelliTracer.ApiV1.PoiValidationResult"
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Delete point of interest
operationId: Delete point of interest
description: |-
Deletes a point of interest.
*Privilege required: `Api: Poi's edit`*
x-resource: Pois
tags:
- Config
requestBody:
$ref: "#/components/requestBodies/Delete_point_of_interestBody"
security:
- pat: []
/api/v2/poi/lite:
post:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Data:
properties:
Id:
type: string
Code:
description: (default = null)
nullable: true
type: string
Name:
type: string
Street:
description: (default = null)
nullable: true
type: string
HouseNumber:
description: (default = null)
nullable: true
type: string
City:
description: (default = null)
nullable: true
type: string
Submunicipality:
description: (default = null)
nullable: true
type: string
PostalCode:
description: (default = null)
nullable: true
type: string
Country:
type: number
x-enum-type: IntelliTracer.Domain.Country
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
- 47
- 48
- 49
- 50
- 51
- 52
- 53
- 54
- 55
- 56
- 57
- 58
- 59
- 60
- 61
- 62
- 63
- 64
- 65
- 66
- 67
- 68
- 69
- 70
- 71
- 72
- 73
- 74
- 75
- 76
- 77
- 78
- 79
- 80
- 81
- 82
- 83
- 84
- 85
- 86
- 87
- 88
- 89
- 90
- 91
- 92
- 93
- 94
- 95
- 96
- 97
- 98
- 99
- 100
- 101
- 102
- 103
- 104
- 105
- 106
- 107
- 108
- 109
- 110
- 111
- 112
- 113
- 114
- 115
- 116
- 117
- 118
- 119
- 120
- 121
- 122
- 123
- 124
- 125
- 126
- 127
- 128
- 129
- 130
- 131
- 132
- 133
- 134
- 135
- 136
- 137
- 138
- 139
- 140
- 141
- 142
- 143
- 144
- 145
- 146
- 147
- 148
- 149
- 150
- 151
- 152
- 153
- 9999
description: (default = 0)
Priority:
x-enum-type: IntelliTracer.ApiV1.PoiPriority
enum:
- "-"
- "0"
- "1"
- "2"
- "3"
- "4"
- "5"
- "6"
- "7"
- "8"
- "9"
- "0"
- null
description: (default = null)
nullable: true
type: string
Description:
description: (default = null)
nullable: true
type: string
GeographyWkt:
description: (default = null)
nullable: true
type: string
LonMin:
type: number
description: (default = 0.0)
LonMax:
type: number
description: (default = 0.0)
LatMin:
type: number
description: (default = 0.0)
LatMax:
type: number
description: (default = 0.0)
MarkerLon:
description: (default = null)P
nullable: true
type: number
MarkerLat:
description: (default = null)
nullable: true
type: number
IsAssetLocation:
type: boolean
description: (default = false)
Type:
properties:
Id:
type: string
Name:
type: string
Level:
type: number
x-enum-type: IntelliTracer.ApiV1.PoiTypeLevel
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
description: (default = 0)
Color:
description: (default = null)
nullable: true
type: string
required:
- Id
- Name
description: (default = null)
nullable: true
type: object
Groups:
description: (default = null)
nullable: true
type: array
items: {}
required:
- Id
- Name
- IsAssetLocation
description: (default = null)
nullable: true
type: object
examples:
response:
value:
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
"400":
description: BadRequest
headers: {}
content:
application/json:
schema:
$ref: "#/components/schemas/IntelliTracer.ApiV2.PoiLiteValidationResult"
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Update point of interest (without location change)
operationId: Update point of interest (without location change)
description: >-
Updates a point of interest, while retaining its current address and the
coordinates of the polygon that defines its location.
*Privilege required: `Api: Poi's edit`*
x-resource: Pois
tags:
- Config
requestBody:
content:
application/json:
schema:
type: object
properties:
Id:
type: string
Name:
type: string
Code:
description: (default = null)
nullable: true
type: string
PoiTypeId:
type: string
IsAssetLocation:
type: boolean
description: (default = false)
Priority:
type: string
x-enum-type: IntelliTracer.ApiV1.PoiPriority
enum:
- "-"
- "0"
- "1"
- "2"
- "3"
- "4"
- "5"
- "6"
- "7"
- "8"
- "9"
- "0"
description: (default = -)
Description:
description: (default = null)
nullable: true
type: string
required:
- Id
- Name
- PoiTypeId
- Priority
example:
Id: 00000000-0000-0000-0000-000000000000
Name: Work
Code: "012345"
PoiTypeId: 00000000-0000-0000-0000-000000000000
IsAssetLocation: false
Priority: "0"
Description: Work
security:
- pat: []
/api/v2/poi/activate:
post:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Data:
nullable: true
type: array
items: {}
examples:
response:
value:
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
"400":
description: BadRequest
headers: {}
content:
application/json:
schema:
$ref: "#/components/schemas/IntelliTracer.ApiV2.PoiValidationResult"
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Activate point of interest
operationId: Activate point of interest
description: |-
Re-activates a point of interest.
*Privilege required: `Api: Poi's edit`*
x-resource: Pois
tags:
- Config
requestBody:
content:
application/json:
schema:
type: array
items:
type: string
example:
- 00000000-0000-0000-0000-000000000000
- 00000000-0000-0000-0000-000000000000
security:
- pat: []
/api/v2/poi/deactivate:
post:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Data:
nullable: true
type: array
items: {}
examples:
response:
value:
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
"400":
description: BadRequest
headers: {}
content:
application/json:
schema:
$ref: "#/components/schemas/IntelliTracer.ApiV2.PoiValidationResult"
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Deactivate point of interest
operationId: Deactivate point of interest
description: |-
Deactivates a point of interest.
*Privilege required: `Api: Poi's edit`*
x-resource: Pois
tags:
- Config
requestBody:
content:
application/json:
schema:
type: array
items:
type: string
example:
- 00000000-0000-0000-0000-000000000000
- 00000000-0000-0000-0000-000000000000
security:
- pat: []
/api/v1/poigroup:
get:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/IntelliTracer.ApiV1.PoiGroup"
examples:
response:
value:
- 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
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Get point of interest groups
operationId: Get point of interest groups
description: |-
Returns a list of all point of interest groups.
*Privilege required: `Api: Poi's read` or `Api: Poi's edit`*
x-resource: Poi groups
tags:
- Config
security:
- pat: []
put:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Id:
type: string
Name:
type: string
Pois:
description: (default = [])
nullable: true
type: array
items: {}
NumberOfPois:
type: number
description: (default = 0)
_typeDescriptor:
type: string
required:
- Id
- Name
examples:
response:
value:
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
"400":
description: BadRequest
headers: {}
content:
application/json:
schema:
type: object
properties:
Entity:
type: object
properties:
Id:
type: string
Name:
type: string
Pois:
description: (default = [])
nullable: true
type: array
items: {}
NumberOfPois:
type: number
description: (default = 0)
_typeDescriptor:
type: string
required:
- Id
- Name
ValidationResult:
type: array
items: {}
required:
- Entity
- ValidationResult
examples:
response:
value:
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: []
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Create point of interest group
operationId: Create point of interest group
description: |-
Creates a new point of interest group.
*Privilege required: `Api: Poi's edit`*
x-resource: Poi groups
tags:
- Config
requestBody:
content:
application/json:
schema:
type: object
properties:
Name:
type: string
required:
- Name
example:
Name: Work places
security:
- pat: []
post:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Id:
type: string
Name:
type: string
Pois:
description: (default = [])
nullable: true
type: array
items: {}
NumberOfPois:
type: number
description: (default = 0)
_typeDescriptor:
type: string
required:
- Id
- Name
examples:
response:
value:
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
"400":
description: BadRequest
headers: {}
content:
application/json:
schema:
type: object
properties:
Entity:
type: object
properties:
Id:
type: string
Name:
type: string
Pois:
description: (default = [])
nullable: true
type: array
items: {}
NumberOfPois:
type: number
description: (default = 0)
_typeDescriptor:
type: string
required:
- Id
- Name
ValidationResult:
type: array
items: {}
required:
- Entity
- ValidationResult
examples:
response:
value:
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: []
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Update point of interest group
operationId: Update point of interest group
description: |-
Updates a point of interest group.
*Privilege required: `Api: Poi's edit`*
x-resource: Poi groups
tags:
- Config
requestBody:
content:
application/json:
schema:
type: object
properties:
Name:
type: string
Id:
type: string
required:
- Name
- Id
example:
Name: Work places
Id: 00000000-0000-0000-0000-000000000000
security:
- pat: []
delete:
responses:
"200":
description: OK
headers: {}
"400":
description: BadRequest
headers: {}
content:
application/json:
schema:
type: object
properties:
Entity:
type: object
properties:
Id:
type: string
Name:
type: string
Pois:
description: (default = [])
nullable: true
type: array
items: {}
NumberOfPois:
type: number
description: (default = 0)
_typeDescriptor:
type: string
required:
- Id
- Name
ValidationResult:
type: array
items: {}
required:
- Entity
- ValidationResult
examples:
response:
value:
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: []
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Delete point of interest group
operationId: Delete point of interest group
description: |-
Deletes a point of interest group.
*Privilege required: `Api: Poi's edit`*
x-resource: Poi groups
tags:
- Config
requestBody:
$ref: "#/components/requestBodies/Delete_point_of_interestBody"
security:
- pat: []
"/api/v1/poigroup/{id}":
get:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Id:
type: string
Name:
type: string
Pois:
description: (default = [])
nullable: true
type: array
items: {}
NumberOfPois:
type: number
description: (default = 0)
_typeDescriptor:
type: string
required:
- Id
- Name
examples:
response:
value:
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
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Get point of interest group
operationId: Get point of interest group
description: |-
Returns a point of interest group by id.
*Privilege required: `Api: Poi's read` or `Api: Poi's edit`*
x-resource: Poi groups
tags:
- Config
parameters:
- name: id
in: path
description: ""
required: true
example: 00000000-0000-0000-0000-000000000000
schema:
type: string
security:
- pat: []
"/api/v1/poigroup/{id}/pois":
get:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/IntelliTracer.ApiV1.PoiLite"
examples:
response:
value:
- Id: 00000000-0000-0000-0000-000000000000
Name: Work
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Get pois of poi group
operationId: Get pois of poi group
description: |-
Returns a list of all point of interests of a point of interest group.
*Privilege required: `Api: Poi's read` or `Api: Poi's edit`*
x-resource: Poi group - Pois
tags:
- Config
parameters:
- name: id
in: path
description: ""
required: true
example: 00000000-0000-0000-0000-000000000000
schema:
type: string
security:
- pat: []
put:
responses:
"200":
description: OK
headers: {}
"400":
description: BadRequest
headers: {}
content:
application/json:
schema:
type: object
properties:
Entity:
type: object
properties:
Id:
type: string
Name:
type: string
Pois:
description: (default = [])
nullable: true
type: array
items: {}
NumberOfPois:
type: number
description: (default = 0)
_typeDescriptor:
type: string
required:
- Id
- Name
ValidationResult:
type: array
items: {}
required:
- Entity
- ValidationResult
examples:
response:
value:
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: []
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Add pois to poi group
operationId: Add pois to poi group
description: >-
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`.
*Privilege required: `Api: Poi's edit`*
x-resource: Poi group - Pois
tags:
- Config
parameters:
- name: id
in: path
description: ""
required: true
example: 00000000-0000-0000-0000-000000000000
schema:
type: string
requestBody:
$ref: "#/components/requestBodies/Add_resources_to_resource_groupBody"
security:
- pat: []
delete:
responses:
"200":
description: OK
headers: {}
"400":
description: BadRequest
headers: {}
content:
application/json:
schema:
type: object
properties:
Entity:
type: object
properties:
Id:
type: string
Name:
type: string
Pois:
description: (default = [])
nullable: true
type: array
items: {}
NumberOfPois:
type: number
description: (default = 0)
_typeDescriptor:
type: string
required:
- Id
- Name
ValidationResult:
type: array
items: {}
required:
- Entity
- ValidationResult
examples:
response:
value:
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: []
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Remove pois from poi group
operationId: Remove pois from poi group
description: >-
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`.
*Privilege required: `Api: Poi's edit`*
x-resource: Poi group - Pois
tags:
- Config
parameters:
- name: id
in: path
description: ""
required: true
example: 00000000-0000-0000-0000-000000000000
schema:
type: string
requestBody:
$ref: "#/components/requestBodies/Remove_resources_from_resource_groupBody"
security:
- pat: []
/api/v1/poitype:
get:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/IntelliTracer.ApiV1.PoiType"
examples:
response:
value:
- Id: 00000000-0000-0000-0000-000000000000
Name: Work place
Color: "#00FF2F"
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Get point of interest types
operationId: Get point of interest types
description: |-
Returns a list of all point of interest types.
*Privilege required: `Api: Poi's read` or `Api: Poi's edit`*
x-resource: Poi types
tags:
- Config
security:
- pat: []
put:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Id:
type: string
Name:
type: string
Color:
description: |-
(default = null)
Color to be used for POIs of this type in IntelliTracer.
nullable: true
type: string
_typeDescriptor:
type: string
required:
- Id
- Name
examples:
response:
value:
Id: 00000000-0000-0000-0000-000000000000
Name: Work place
Color: "#00FF2F"
"400":
description: BadRequest
headers: {}
content:
application/json:
schema:
type: object
properties:
Entity:
type: object
properties:
Id:
type: string
Name:
type: string
Color:
description: >-
(default = null)
Color to be used for POIs of this type in IntelliTracer.
nullable: true
type: string
_typeDescriptor:
type: string
required:
- Id
- Name
ValidationResult:
type: array
items: {}
required:
- Entity
- ValidationResult
examples:
response:
value:
Entity:
Id: 00000000-0000-0000-0000-000000000000
Name: Work place
Color: "#00FF2F"
ValidationResult:
- Message: ""
SourceMemberNames: []
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Create point of interest type
operationId: Create point of interest type
description: |-
Creates a new point of interest type.
*Privilege required: `Api: Poi's edit`*
x-resource: Poi types
tags:
- Config
requestBody:
content:
application/json:
schema:
type: object
properties:
Name:
type: string
Color:
description: |-
(default = null)
Color to be used for POIs of this type in IntelliTracer.
nullable: true
type: string
required:
- Name
example:
Name: Work place
Color: "#00FF2F"
security:
- pat: []
post:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Id:
type: string
Name:
type: string
Color:
description: |-
(default = null)
Color to be used for POIs of this type in IntelliTracer.
nullable: true
type: string
_typeDescriptor:
type: string
required:
- Id
- Name
examples:
response:
value:
Id: 00000000-0000-0000-0000-000000000000
Name: Work place
Color: "#00FF2F"
"400":
description: BadRequest
headers: {}
content:
application/json:
schema:
type: object
properties:
Entity:
type: object
properties:
Id:
type: string
Name:
type: string
Color:
description: >-
(default = null)
Color to be used for POIs of this type in IntelliTracer.
nullable: true
type: string
_typeDescriptor:
type: string
required:
- Id
- Name
ValidationResult:
type: array
items: {}
required:
- Entity
- ValidationResult
examples:
response:
value:
Entity:
Id: 00000000-0000-0000-0000-000000000000
Name: Work place
Color: "#00FF2F"
ValidationResult:
- Message: ""
SourceMemberNames: []
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Update point of interest type
operationId: Update point of interest type
description: |-
Updates a point of interest type.
*Privilege required: `Api: Poi's edit`*
x-resource: Poi types
tags:
- Config
requestBody:
content:
application/json:
schema:
type: object
properties:
Name:
type: string
Color:
description: |-
(default = null)
Color to be used for POIs of this type in IntelliTracer.
nullable: true
type: string
Id:
type: string
required:
- Name
- Id
example:
Name: Work place
Color: "#00FF2F"
Id: 00000000-0000-0000-0000-000000000000
security:
- pat: []
delete:
responses:
"200":
description: OK
headers: {}
"400":
description: BadRequest
headers: {}
content:
application/json:
schema:
type: object
properties:
Entity:
type: object
properties:
Id:
type: string
Name:
type: string
Color:
description: >-
(default = null)
Color to be used for POIs of this type in IntelliTracer.
nullable: true
type: string
_typeDescriptor:
type: string
required:
- Id
- Name
ValidationResult:
type: array
items: {}
required:
- Entity
- ValidationResult
examples:
response:
value:
Entity:
Id: 00000000-0000-0000-0000-000000000000
Name: Work place
Color: "#00FF2F"
ValidationResult:
- Message: ""
SourceMemberNames: []
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Delete point of interest type
operationId: Delete point of interest type
description: |-
Deletes a point of interest type.
*Privilege required: `Api: Poi's edit`*
x-resource: Poi types
tags:
- Config
requestBody:
$ref: "#/components/requestBodies/Delete_point_of_interestBody"
security:
- pat: []
"/api/v1/poitype/{id}":
get:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Id:
type: string
Name:
type: string
Color:
description: |-
(default = null)
Color to be used for POIs of this type in IntelliTracer.
nullable: true
type: string
_typeDescriptor:
type: string
required:
- Id
- Name
examples:
response:
value:
Id: 00000000-0000-0000-0000-000000000000
Name: Work place
Color: "#00FF2F"
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Get point of interest type
operationId: Get point of interest type
description: |-
Returns a point of interest type by id.
*Privilege required: `Api: Poi's read` or `Api: Poi's edit`*
x-resource: Poi types
tags:
- Config
parameters:
- name: id
in: path
description: ""
required: true
example: 00000000-0000-0000-0000-000000000000
schema:
type: string
security:
- pat: []
"/api/v2/rfidtag?page={page}&search={search}":
get:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Data:
nullable: true
type: array
items: {}
PagingFilter:
properties:
Page:
type: number
Search:
nullable: true
type: string
PageCount:
type: number
TotalCount:
type: number
Links:
type: object
properties:
Base:
type: string
First:
type: string
Prev:
type: string
Next:
type: string
Last:
type: string
required:
- Base
required:
- Page
- PageCount
- TotalCount
- Links
nullable: true
type: object
examples:
response:
value:
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
PagingFilter:
Page: 1
Search: ABC
PageCount: 4
TotalCount: 100
Links:
Base: https://api.intellitracer.be
First: /api/v2/asset?page=1
Prev: /api/v2/asset?page=2
Next: /api/v2/asset?page=4
Last: /api/v2/asset?page=4
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Get RFID tags
operationId: Get RFID tags
description: |-
Returns a paged list of RFID tags.
Pagination and searching is explained in [Pagination](#pagination).
*Privilege required: `Api: RFID tags`*
x-resource: RFID tags
tags:
- Config
parameters:
- name: page
in: path
description: ""
required: true
example: "1"
schema:
type: number
- name: search
in: path
description: ""
required: true
example: ABC
schema:
type: string
security:
- pat: []
"/api/v2/rfidtag/{id}":
get:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Data:
properties:
Id:
type: string
InternalNumber:
type: string
ExternalNumber:
type: string
description: (default = null)
Type:
x-enum-type: IntelliTracer.ApiV2.RFIDTagType
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- null
- 12
nullable: true
type: number
BeaconRateSeconds:
description: (default = null)
nullable: true
type: string
SiteCode:
description: >-
(default = null)
This field is required for types 'Active Tag Ingecom', 'Active RFID Tag Wavetrend', 'Active/Passive Wavetrend', 'BLE', 'BLE IET10' and 'BLE ELA'.
nullable: true
type: string
PassiveTagNumber:
description: >-
(default = null)
This field is required for type 'Active/Passive Wavetrend'.
nullable: true
type: string
MacAddress:
description: >-
(default = null)
This field is required for type 'BLE IET10' and 'BLE ELA'.
nullable: true
type: string
User:
properties:
Id:
type: string
Code:
description: (default = null)
nullable: true
type: string
Name:
type: string
Type:
type: number
x-enum-type: IntelliTracer.Domain.ResourceType
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
description: (default = 0)
required:
- Id
- Name
description: The user linked to this RFID tag (if any).
nullable: true
type: object
required:
- InternalNumber
- Type
nullable: true
type: object
examples:
response:
value:
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
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Get RFID tag
operationId: Get RFID tag
description: |-
Returns an RFID tag by id.
*Privilege required: `Api: RFID tags`*
x-resource: RFID tags
tags:
- Config
parameters:
- name: id
in: path
description: ""
required: true
example: 00000000-0000-0000-0000-000000000000
schema:
type: string
security:
- pat: []
delete:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Data:
properties:
Id:
type: string
InternalNumber:
type: string
ExternalNumber:
type: string
description: (default = null)
Type:
x-enum-type: IntelliTracer.ApiV2.RFIDTagType
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- null
- 12
nullable: true
type: number
BeaconRateSeconds:
description: (default = null)
nullable: true
type: string
SiteCode:
description: >-
(default = null)
This field is required for types 'Active Tag Ingecom', 'Active RFID Tag Wavetrend', 'Active/Passive Wavetrend', 'BLE', 'BLE IET10' and 'BLE ELA'.
nullable: true
type: string
PassiveTagNumber:
description: >-
(default = null)
This field is required for type 'Active/Passive Wavetrend'.
nullable: true
type: string
MacAddress:
description: >-
(default = null)
This field is required for type 'BLE IET10' and 'BLE ELA'.
nullable: true
type: string
User:
properties:
Id:
type: string
Code:
description: (default = null)
nullable: true
type: string
Name:
type: string
Type:
type: number
x-enum-type: IntelliTracer.Domain.ResourceType
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
description: (default = 0)
required:
- Id
- Name
description: The user linked to this RFID tag (if any).
nullable: true
type: object
required:
- InternalNumber
- Type
nullable: true
type: object
examples:
response:
value:
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
"400":
description: BadRequest
headers: {}
content:
application/json:
schema:
type: object
properties:
Entity:
type: object
properties:
Id:
type: string
InternalNumber:
type: string
ExternalNumber:
type: string
description: (default = null)
Type:
x-enum-type: IntelliTracer.ApiV2.RFIDTagType
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- null
- 12
nullable: true
type: number
BeaconRateSeconds:
description: (default = null)
nullable: true
type: string
SiteCode:
description: >-
(default = null)
This field is required for types 'Active Tag Ingecom', 'Active RFID Tag Wavetrend', 'Active/Passive Wavetrend', 'BLE', 'BLE IET10' and 'BLE ELA'.
nullable: true
type: string
PassiveTagNumber:
description: >-
(default = null)
This field is required for type 'Active/Passive Wavetrend'.
nullable: true
type: string
MacAddress:
description: >-
(default = null)
This field is required for type 'BLE IET10' and 'BLE ELA'.
nullable: true
type: string
required:
- InternalNumber
- Type
ValidationResult:
type: array
items: {}
required:
- Entity
- ValidationResult
examples:
response:
value:
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: []
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Delete RFID tag
operationId: Delete RFID tag
description: |-
Deletes an RFID tag.
*Privilege required: `Api: RFID tags`*
x-resource: RFID tags
tags:
- Config
parameters:
- name: id
in: path
description: ""
required: true
example: 00000000-0000-0000-0000-000000000000
schema:
type: string
security:
- pat: []
/api/v2/rfidtag:
put:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Data:
properties:
Id:
type: string
InternalNumber:
type: string
ExternalNumber:
type: string
description: (default = null)
Type:
x-enum-type: IntelliTracer.ApiV2.RFIDTagType
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- null
- 12
nullable: true
type: number
BeaconRateSeconds:
description: (default = null)
nullable: true
type: string
SiteCode:
description: >-
(default = null)
This field is required for types 'Active Tag Ingecom', 'Active RFID Tag Wavetrend', 'Active/Passive Wavetrend', 'BLE', 'BLE IET10' and 'BLE ELA'.
nullable: true
type: string
PassiveTagNumber:
description: >-
(default = null)
This field is required for type 'Active/Passive Wavetrend'.
nullable: true
type: string
MacAddress:
description: >-
(default = null)
This field is required for type 'BLE IET10' and 'BLE ELA'.
nullable: true
type: string
User:
properties:
Id:
type: string
Code:
description: (default = null)
nullable: true
type: string
Name:
type: string
Type:
type: number
x-enum-type: IntelliTracer.Domain.ResourceType
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
description: (default = 0)
required:
- Id
- Name
description: The user linked to this RFID tag (if any).
nullable: true
type: object
required:
- InternalNumber
- Type
nullable: true
type: object
examples:
response:
value:
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
"400":
description: BadRequest
headers: {}
content:
application/json:
schema:
type: object
properties:
Entity:
type: object
properties:
Id:
type: string
InternalNumber:
type: string
ExternalNumber:
type: string
description: (default = null)
Type:
x-enum-type: IntelliTracer.ApiV2.RFIDTagType
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- null
- 12
nullable: true
type: number
BeaconRateSeconds:
description: (default = null)
nullable: true
type: string
SiteCode:
description: >-
(default = null)
This field is required for types 'Active Tag Ingecom', 'Active RFID Tag Wavetrend', 'Active/Passive Wavetrend', 'BLE', 'BLE IET10' and 'BLE ELA'.
nullable: true
type: string
PassiveTagNumber:
description: >-
(default = null)
This field is required for type 'Active/Passive Wavetrend'.
nullable: true
type: string
MacAddress:
description: >-
(default = null)
This field is required for type 'BLE IET10' and 'BLE ELA'.
nullable: true
type: string
required:
- InternalNumber
- Type
ValidationResult:
type: array
items: {}
required:
- Entity
- ValidationResult
examples:
response:
value:
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: []
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Create RFID tag
operationId: Create RFID tag
description: |-
Creates a new RFID tag.
*Privilege required: `Api: RFID tags`*
x-resource: RFID tags
tags:
- Config
requestBody:
content:
application/json:
schema:
type: object
properties:
Id:
type: string
InternalNumber:
type: string
ExternalNumber:
type: string
description: (default = null)
Type:
x-enum-type: IntelliTracer.ApiV2.RFIDTagType
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- null
- 12
nullable: true
type: number
BeaconRateSeconds:
description: (default = null)
nullable: true
type: string
SiteCode:
description: >-
(default = null)
This field is required for types 'Active Tag Ingecom', 'Active RFID Tag Wavetrend', 'Active/Passive Wavetrend', 'BLE', 'BLE IET10' and 'BLE ELA'.
nullable: true
type: string
PassiveTagNumber:
description: |-
(default = null)
This field is required for type 'Active/Passive Wavetrend'.
nullable: true
type: string
MacAddress:
description: |-
(default = null)
This field is required for type 'BLE IET10' and 'BLE ELA'.
nullable: true
type: string
required:
- InternalNumber
- Type
example:
Id: 00000000-0000-0000-0000-000000000000
InternalNumber: 00AA11BB
ExternalNumber: "12345678"
Type: 0
BeaconRateSeconds: "15.0"
SiteCode: "1234"
PassiveTagNumber: "123456789"
MacAddress: AABBCCDDEEFF
security:
- pat: []
post:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Data:
properties:
Id:
type: string
InternalNumber:
type: string
ExternalNumber:
type: string
description: (default = null)
Type:
x-enum-type: IntelliTracer.ApiV2.RFIDTagType
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- null
- 12
nullable: true
type: number
BeaconRateSeconds:
description: (default = null)
nullable: true
type: string
SiteCode:
description: >-
(default = null)
This field is required for types 'Active Tag Ingecom', 'Active RFID Tag Wavetrend', 'Active/Passive Wavetrend', 'BLE', 'BLE IET10' and 'BLE ELA'.
nullable: true
type: string
PassiveTagNumber:
description: >-
(default = null)
This field is required for type 'Active/Passive Wavetrend'.
nullable: true
type: string
MacAddress:
description: >-
(default = null)
This field is required for type 'BLE IET10' and 'BLE ELA'.
nullable: true
type: string
User:
properties:
Id:
type: string
Code:
description: (default = null)
nullable: true
type: string
Name:
type: string
Type:
type: number
x-enum-type: IntelliTracer.Domain.ResourceType
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
description: (default = 0)
required:
- Id
- Name
description: The user linked to this RFID tag (if any).
nullable: true
type: object
required:
- InternalNumber
- Type
nullable: true
type: object
examples:
response:
value:
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
"400":
description: BadRequest
headers: {}
content:
application/json:
schema:
type: object
properties:
Entity:
type: object
properties:
Id:
type: string
InternalNumber:
type: string
ExternalNumber:
type: string
description: (default = null)
Type:
x-enum-type: IntelliTracer.ApiV2.RFIDTagType
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- null
- 12
nullable: true
type: number
BeaconRateSeconds:
description: (default = null)
nullable: true
type: string
SiteCode:
description: >-
(default = null)
This field is required for types 'Active Tag Ingecom', 'Active RFID Tag Wavetrend', 'Active/Passive Wavetrend', 'BLE', 'BLE IET10' and 'BLE ELA'.
nullable: true
type: string
PassiveTagNumber:
description: >-
(default = null)
This field is required for type 'Active/Passive Wavetrend'.
nullable: true
type: string
MacAddress:
description: >-
(default = null)
This field is required for type 'BLE IET10' and 'BLE ELA'.
nullable: true
type: string
required:
- InternalNumber
- Type
ValidationResult:
type: array
items: {}
required:
- Entity
- ValidationResult
examples:
response:
value:
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: []
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Update RFID tag
operationId: Update RFID tag
description: |-
Updates an RFID tag.
*Privilege required: `Api: RFID tags`*
x-resource: RFID tags
tags:
- Config
requestBody:
content:
application/json:
schema:
type: object
properties:
Id:
type: string
InternalNumber:
type: string
ExternalNumber:
type: string
description: (default = null)
Type:
x-enum-type: IntelliTracer.ApiV2.RFIDTagType
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- null
- 12
nullable: true
type: number
BeaconRateSeconds:
description: (default = null)
nullable: true
type: string
SiteCode:
description: >-
(default = null)
This field is required for types 'Active Tag Ingecom', 'Active RFID Tag Wavetrend', 'Active/Passive Wavetrend', 'BLE', 'BLE IET10' and 'BLE ELA'.
nullable: true
type: string
PassiveTagNumber:
description: |-
(default = null)
This field is required for type 'Active/Passive Wavetrend'.
nullable: true
type: string
MacAddress:
description: |-
(default = null)
This field is required for type 'BLE IET10' and 'BLE ELA'.
nullable: true
type: string
required:
- Id
- InternalNumber
- Type
example:
Id: 00000000-0000-0000-0000-000000000000
InternalNumber: 00AA11BB
ExternalNumber: "12345678"
Type: 0
BeaconRateSeconds: "15.0"
SiteCode: "1234"
PassiveTagNumber: "123456789"
MacAddress: AABBCCDDEEFF
security:
- pat: []
"/api/v2/user/{userId}/rfidtag":
get:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Data:
nullable: true
type: array
items: {}
examples:
response:
value:
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
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Get RFID tags by user
operationId: Get RFID tags by user
description: |-
Returns a list of all RFID tags linked to a user.
*Privilege required: `Api: RFID tags`*
x-resource: RFID tags - User
tags:
- Config
parameters:
- name: userId
in: path
description: ""
required: true
example: 00000000-0000-0000-0000-000000000000
schema:
type: string
security:
- pat: []
put:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Data:
properties:
Id:
type: string
InternalNumber:
type: string
ExternalNumber:
type: string
description: (default = null)
Type:
x-enum-type: IntelliTracer.ApiV2.RFIDTagType
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- null
- 12
nullable: true
type: number
BeaconRateSeconds:
description: (default = null)
nullable: true
type: string
SiteCode:
description: >-
(default = null)
This field is required for types 'Active Tag Ingecom', 'Active RFID Tag Wavetrend', 'Active/Passive Wavetrend', 'BLE', 'BLE IET10' and 'BLE ELA'.
nullable: true
type: string
PassiveTagNumber:
description: >-
(default = null)
This field is required for type 'Active/Passive Wavetrend'.
nullable: true
type: string
MacAddress:
description: >-
(default = null)
This field is required for type 'BLE IET10' and 'BLE ELA'.
nullable: true
type: string
User:
properties:
Id:
type: string
Code:
description: (default = null)
nullable: true
type: string
Name:
type: string
Type:
type: number
x-enum-type: IntelliTracer.Domain.ResourceType
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
description: (default = 0)
required:
- Id
- Name
description: The user linked to this RFID tag (if any).
nullable: true
type: object
required:
- InternalNumber
- Type
nullable: true
type: object
examples:
response:
value:
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
"400":
description: BadRequest
headers: {}
content:
application/json:
schema:
type: object
properties:
Entity:
type: object
properties:
Id:
type: string
InternalNumber:
type: string
ExternalNumber:
type: string
description: (default = null)
Type:
x-enum-type: IntelliTracer.ApiV2.RFIDTagType
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- null
- 12
nullable: true
type: number
BeaconRateSeconds:
description: (default = null)
nullable: true
type: string
SiteCode:
description: >-
(default = null)
This field is required for types 'Active Tag Ingecom', 'Active RFID Tag Wavetrend', 'Active/Passive Wavetrend', 'BLE', 'BLE IET10' and 'BLE ELA'.
nullable: true
type: string
PassiveTagNumber:
description: >-
(default = null)
This field is required for type 'Active/Passive Wavetrend'.
nullable: true
type: string
MacAddress:
description: >-
(default = null)
This field is required for type 'BLE IET10' and 'BLE ELA'.
nullable: true
type: string
required:
- InternalNumber
- Type
ValidationResult:
type: array
items: {}
required:
- Entity
- ValidationResult
examples:
response:
value:
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: []
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Link RFID tag to user
operationId: Link RFID tag to user
description: >-
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.
*Privilege required: `Api: RFID tags`*
x-resource: RFID tags - User
tags:
- Config
parameters:
- name: userId
in: path
description: ""
required: true
example: 00000000-0000-0000-0000-000000000000
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
properties:
BadgeId:
type: string
InternalNumber:
type: string
OverrideExistingUser:
type: boolean
required:
- OverrideExistingUser
example:
BadgeId: 00000000-0000-0000-0000-000000000000
InternalNumber: 00AA11BB
OverrideExistingUser: false
security:
- pat: []
delete:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Data:
properties:
Id:
type: string
InternalNumber:
type: string
ExternalNumber:
type: string
description: (default = null)
Type:
x-enum-type: IntelliTracer.ApiV2.RFIDTagType
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- null
- 12
nullable: true
type: number
BeaconRateSeconds:
description: (default = null)
nullable: true
type: string
SiteCode:
description: >-
(default = null)
This field is required for types 'Active Tag Ingecom', 'Active RFID Tag Wavetrend', 'Active/Passive Wavetrend', 'BLE', 'BLE IET10' and 'BLE ELA'.
nullable: true
type: string
PassiveTagNumber:
description: >-
(default = null)
This field is required for type 'Active/Passive Wavetrend'.
nullable: true
type: string
MacAddress:
description: >-
(default = null)
This field is required for type 'BLE IET10' and 'BLE ELA'.
nullable: true
type: string
User:
properties:
Id:
type: string
Code:
description: (default = null)
nullable: true
type: string
Name:
type: string
Type:
type: number
x-enum-type: IntelliTracer.Domain.ResourceType
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
description: (default = 0)
required:
- Id
- Name
description: The user linked to this RFID tag (if any).
nullable: true
type: object
required:
- InternalNumber
- Type
nullable: true
type: object
examples:
response:
value:
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
"400":
description: BadRequest
headers: {}
content:
application/json:
schema:
type: object
properties:
Entity:
type: object
properties:
Id:
type: string
InternalNumber:
type: string
ExternalNumber:
type: string
description: (default = null)
Type:
x-enum-type: IntelliTracer.ApiV2.RFIDTagType
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- null
- 12
nullable: true
type: number
BeaconRateSeconds:
description: (default = null)
nullable: true
type: string
SiteCode:
description: >-
(default = null)
This field is required for types 'Active Tag Ingecom', 'Active RFID Tag Wavetrend', 'Active/Passive Wavetrend', 'BLE', 'BLE IET10' and 'BLE ELA'.
nullable: true
type: string
PassiveTagNumber:
description: >-
(default = null)
This field is required for type 'Active/Passive Wavetrend'.
nullable: true
type: string
MacAddress:
description: >-
(default = null)
This field is required for type 'BLE IET10' and 'BLE ELA'.
nullable: true
type: string
required:
- InternalNumber
- Type
ValidationResult:
type: array
items: {}
required:
- Entity
- ValidationResult
examples:
response:
value:
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: []
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Unlink RFID tag from user
operationId: Unlink RFID tag from user
description: |-
Unlinks an RFID tag from a user by id or internal number.
*Privilege required: `Api: RFID tags`*
x-resource: RFID tags - User
tags:
- Config
parameters:
- name: userId
in: path
description: ""
required: true
example: 00000000-0000-0000-0000-000000000000
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
properties:
BadgeId:
type: string
InternalNumber:
type: string
example:
BadgeId: 00000000-0000-0000-0000-000000000000
InternalNumber: 00AA11BB
security:
- pat: []
"/api/v2/mobilerfidscanner?page={page}&search={search}":
get:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
$ref: "#/components/schemas/IntelliTracer.ApiV1.MobileRFIDScannersWithPaging"
examples:
response:
value:
Data:
- 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"
PagingFilter:
Page: 1
Search: ABC
PageCount: 4
TotalCount: 100
Links:
Base: https://api.intellitracer.be
First: /api/v2/asset?page=1
Prev: /api/v2/asset?page=2
Next: /api/v2/asset?page=4
Last: /api/v2/asset?page=4
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Get mobile RFID scanners
operationId: Get mobile RFID scanners
description: |-
Gets all mobile RFID scanners.
Pagination and searching is explained in [Pagination](#pagination).
*Privilege required: `Api: Mobile RFID scanner`*
x-resource: RFID scanners
tags:
- Config
parameters:
- name: page
in: path
description: ""
required: true
example: "1"
schema:
type: number
- name: search
in: path
description: ""
required: true
example: ABC
schema:
type: string
security:
- pat: []
"/api/v1/mobilerfidscanner/{id}":
get:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Id:
type: string
UnitId:
type: string
User:
properties:
Id:
type: string
Name:
type: string
Code:
description: (default = null)
nullable: true
type: string
required:
- Id
- Name
nullable: true
type: object
CostCenter:
properties:
Id:
type: string
Name:
type: string
Code:
description: (default = null)
nullable: true
type: string
required:
- Id
- Name
nullable: true
type: object
required:
- Id
examples:
response:
value:
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"
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Get mobile RFID scanner by Id
operationId: Get mobile RFID scanner by Id
description: |-
Gets a mobile RFID scanners by Id.
*Privilege required: `Api: Mobile RFID scanner`*
x-resource: RFID scanners
tags:
- Config
parameters:
- name: id
in: path
description: ""
required: true
example: 00000000-0000-0000-0000-000000000000
schema:
type: string
security:
- pat: []
/api/v1/mobilerfidscanner:
post:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
$ref: "#/components/schemas/IntelliTracer.ApiV1.MobileRFIDScanner"
examples:
response:
value:
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"
"400":
description: BadRequest
headers: {}
content:
application/json:
schema:
type: object
properties:
Entity:
type: object
properties:
Id:
type: string
Name_Nl:
description: (default = null)
nullable: true
type: string
Name_Fr:
description: (default = null)
nullable: true
type: string
Name_En:
description: (default = null)
nullable: true
type: string
Name_Pl:
description: (default = null)
nullable: true
type: string
Type:
type: number
x-enum-type: IntelliTracer.ApiV1.MobileClockingNodeType
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
description: >-
(default = 0)
Type of the mobile clocking node (folder or jobnumber).
FilterText:
description: >-
(default = null)
Filters the visible mobile clocking nodes based on what's in the "Filter/IVR code" field in the config of the logged in user. Only nodes in which that field matches the FilterText will be visible for that user.
nullable: true
type: string
Prefix:
description: >-
(default = null)
This prefix will automatically be added in front of the jobnumber entered by the user.
nullable: true
type: string
JobNumber:
description: >-
(default = null)
Job number used for postcalculation or activity based timeregistration
nullable: true
type: string
Regex:
description: >-
(default = null)
A jobnumber entered by the user will only be accepted if it matches this regex.
nullable: true
type: string
InputFilter:
type: number
x-enum-type: IntelliTracer.ApiV1.MobileClockingNodeInputFilter
enum:
- 0
- 1
- 2
- 3
description: >-
(default = 0)
What kind of input is allowed (free input, only numbers, or hexadecimal).
InputType:
type: number
x-enum-type: IntelliTracer.ApiV1.MenuJobInputType
enum:
- 0
- 1
- 2
description: >-
(default = 0)
What type of input is allowed (scanning, manual entry or both).
ClockingType:
x-enum-type: IntelliTracer.Domain.ClockingType
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- null
description: >-
(default = null)
Type of the clocking to be generated (see options below).
nullable: true
type: number
Children:
description: >-
(default = null)
Only for folders. Children of this mobile clocking node.
nullable: true
type: array
items: {}
PoiGroupId:
nullable: true
type: string
PoiRequired:
type: boolean
description: (default = false)
ValidatePoiCode:
type: boolean
description: (default = false)
CostCenterGroupId:
nullable: true
type: string
CostCenterRequired:
type: boolean
description: (default = false)
ValidateCostCenterCode:
type: boolean
description: (default = false)
ExternalCode:
description: (default = null)
nullable: true
type: string
ExternalType:
x-enum-type: IntelliTracer.Domain.ExternalClockingType
enum:
- 0
- 1
- 2
- null
description: (default = null)
nullable: true
type: number
_typeDescriptor:
type: string
required:
- Id
ValidationResult:
type: array
items: {}
required:
- Entity
- ValidationResult
examples:
response:
value:
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: []
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Update mobile RFID scanner
operationId: Update mobile RFID scanner
description: |-
Updates a mobile RFID scanner.
*Privilege required: `Api: Mobile RFID scanner`*
x-resource: RFID scanners
tags:
- Config
requestBody:
content:
application/json:
schema:
type: object
properties:
Id:
type: string
CurrentUserId:
type: string
CostCenterId:
type: string
required:
- Id
example:
Id: 00000000-0000-0000-0000-000000000000
CurrentUserId: 00000000-0000-0000-0000-000000000000
CostCenterId: 00000000-0000-0000-0000-000000000000
security:
- pat: []
"/api/v2/smartphone?page={page}&search={search}":
get:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
$ref: "#/components/schemas/IntelliTracer.ApiV2.PagedSmartphoneResponse"
examples:
response:
value:
Data:
- 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
PagingFilter:
Page: 1
Search: ABC
PageCount: 4
TotalCount: 100
Links:
Base: https://api.intellitracer.be
First: /api/v2/asset?page=1
Prev: /api/v2/asset?page=2
Next: /api/v2/asset?page=4
Last: /api/v2/asset?page=4
"400":
description: BadRequest
headers: {}
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Get smartphones
operationId: Get smartphones
description: |-
Returns a paged list of smartphone clocking devices.
Pagination and searching is explained in [Pagination](#pagination).
Only usable when the Self Service App is disabled for the company. With the Self Service App enabled, the endpoint answers 400.
*Privilege required: `Api: Mobile Application Configs`*
x-resource: Smartphones
tags:
- Config
parameters:
- name: page
in: path
description: ""
required: true
example: "1"
schema:
type: number
- name: search
in: path
description: ""
required: true
example: ABC
schema:
type: string
security:
- pat: []
"/api/v2/smartphone/{id}":
get:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Id:
type: string
Name:
type: string
UId:
type: string
Active:
type: boolean
description: (default = true)
Type:
type: number
x-enum-type: IntelliTracer.ApiV2.SmartphoneType
enum:
- 0
- 1
description: (default = 0)
Orientation:
type: number
x-enum-type: IntelliTracer.ApiV2.SmartphoneOrientation
enum:
- 0
- 1
- 2
- 3
description: (default = 0)
FilterMenusByUserFilter:
type: boolean
description: (default = false)
UserIdentification:
type: number
x-enum-type: IntelliTracer.ApiV2.SmartphoneUserIdentification
enum:
- 0
- 1
- 2
description: (default = 0)
UserIdentificationConfig:
properties:
ByBadge:
type: boolean
description: (default = false)
ByUserCode:
type: boolean
description: (default = false)
ByCiawCode:
type: boolean
description: (default = false)
FixedUser:
properties:
Id:
type: string
Code:
description: (default = null)
nullable: true
type: string
Name:
type: string
Type:
type: number
x-enum-type: IntelliTracer.Domain.ResourceType
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
description: (default = 0)
required:
- Id
- Name
description: (default = null)
nullable: true
type: object
CiawWorkplace:
properties:
Id:
type: string
DUC:
type: string
Code:
description: (default = null)
nullable: true
type: string
Name:
description: (default = null)
nullable: true
type: string
required:
- Id
- DUC
description: (default = null)
nullable: true
type: object
description: (default = null)
nullable: true
type: object
ResourceDetection:
type: number
x-enum-type: IntelliTracer.ApiV2.SmartphoneResourceDetection
enum:
- 0
- 1
- 2
- 3
- 4
- 5
description: (default = 0)
ResourceDetectionConfig:
properties:
FixedVehicle:
properties:
Id:
type: string
Code:
description: (default = null)
nullable: true
type: string
Name:
type: string
Type:
type: number
x-enum-type: IntelliTracer.Domain.ResourceType
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
description: (default = 0)
required:
- Id
- Name
description: (default = null)
nullable: true
type: object
Vehicles:
description: (default = [])
nullable: true
type: array
items: {}
description: (default = null)
nullable: true
type: object
Positioning:
type: number
x-enum-type: IntelliTracer.ApiV2.SmartphonePositioning
enum:
- 0
- 1
- 2
- 3
- 4
description: (default = 0)
PositioningConfig:
properties:
FixedPoi:
properties:
Id:
type: string
Name:
type: string
Code:
description: "(default = null) "
nullable: true
type: string
required:
- Id
- Name
description: (default = null)
nullable: true
type: object
description: (default = null)
nullable: true
type: object
Team:
type: number
x-enum-type: IntelliTracer.ApiV2.SmartphoneTeam
enum:
- 0
- 1
- 2
description: (default = 0)
TeamConfig:
properties:
GroupUsersByVehicle:
type: boolean
description: (default = false)
description: (default = null)
nullable: true
type: object
TimeRegistration:
type: number
x-enum-type: IntelliTracer.ApiV2.SmartphoneTimeRegistration
enum:
- 0
- 1
- 2
description: (default = 0)
TimeRegistrationConfig:
properties:
Menu:
properties:
Id:
type: string
Name:
type: string
required:
- Id
- Name
description: (default = null)
nullable: true
type: object
description: (default = null)
nullable: true
type: object
CostCenter:
properties:
Id:
type: string
Code:
description: (default = null)
nullable: true
type: string
Name:
type: string
Type:
type: number
x-enum-type: IntelliTracer.Domain.ResourceType
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
description: (default = 0)
required:
- Id
- Name
nullable: true
type: object
required:
- Id
- Name
- UId
examples:
response:
value:
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
"400":
description: BadRequest
headers: {}
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Get smartphone
operationId: Get smartphone
description: |-
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.
*Privilege required: `Api: Mobile Application Configs`*
x-resource: Smartphones
tags:
- Config
parameters:
- name: id
in: path
description: ""
required: true
example: 00000000-0000-0000-0000-000000000000
schema:
type: string
security:
- pat: []
delete:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Id:
type: string
Name:
type: string
UId:
type: string
Active:
type: boolean
description: (default = true)
Type:
type: number
x-enum-type: IntelliTracer.ApiV2.SmartphoneType
enum:
- 0
- 1
description: (default = 0)
Orientation:
type: number
x-enum-type: IntelliTracer.ApiV2.SmartphoneOrientation
enum:
- 0
- 1
- 2
- 3
description: (default = 0)
FilterMenusByUserFilter:
type: boolean
description: (default = false)
UserIdentification:
type: number
x-enum-type: IntelliTracer.ApiV2.SmartphoneUserIdentification
enum:
- 0
- 1
- 2
description: (default = 0)
UserIdentificationConfig:
properties:
ByBadge:
type: boolean
description: (default = false)
ByUserCode:
type: boolean
description: (default = false)
ByCiawCode:
type: boolean
description: (default = false)
FixedUser:
properties:
Id:
type: string
Code:
description: (default = null)
nullable: true
type: string
Name:
type: string
Type:
type: number
x-enum-type: IntelliTracer.Domain.ResourceType
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
description: (default = 0)
required:
- Id
- Name
description: (default = null)
nullable: true
type: object
CiawWorkplace:
properties:
Id:
type: string
DUC:
type: string
Code:
description: (default = null)
nullable: true
type: string
Name:
description: (default = null)
nullable: true
type: string
required:
- Id
- DUC
description: (default = null)
nullable: true
type: object
description: (default = null)
nullable: true
type: object
ResourceDetection:
type: number
x-enum-type: IntelliTracer.ApiV2.SmartphoneResourceDetection
enum:
- 0
- 1
- 2
- 3
- 4
- 5
description: (default = 0)
ResourceDetectionConfig:
properties:
FixedVehicle:
properties:
Id:
type: string
Code:
description: (default = null)
nullable: true
type: string
Name:
type: string
Type:
type: number
x-enum-type: IntelliTracer.Domain.ResourceType
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
description: (default = 0)
required:
- Id
- Name
description: (default = null)
nullable: true
type: object
Vehicles:
description: (default = [])
nullable: true
type: array
items: {}
description: (default = null)
nullable: true
type: object
Positioning:
type: number
x-enum-type: IntelliTracer.ApiV2.SmartphonePositioning
enum:
- 0
- 1
- 2
- 3
- 4
description: (default = 0)
PositioningConfig:
properties:
FixedPoi:
properties:
Id:
type: string
Name:
type: string
Code:
description: "(default = null) "
nullable: true
type: string
required:
- Id
- Name
description: (default = null)
nullable: true
type: object
description: (default = null)
nullable: true
type: object
Team:
type: number
x-enum-type: IntelliTracer.ApiV2.SmartphoneTeam
enum:
- 0
- 1
- 2
description: (default = 0)
TeamConfig:
properties:
GroupUsersByVehicle:
type: boolean
description: (default = false)
description: (default = null)
nullable: true
type: object
TimeRegistration:
type: number
x-enum-type: IntelliTracer.ApiV2.SmartphoneTimeRegistration
enum:
- 0
- 1
- 2
description: (default = 0)
TimeRegistrationConfig:
properties:
Menu:
properties:
Id:
type: string
Name:
type: string
required:
- Id
- Name
description: (default = null)
nullable: true
type: object
description: (default = null)
nullable: true
type: object
CostCenter:
properties:
Id:
type: string
Code:
description: (default = null)
nullable: true
type: string
Name:
type: string
Type:
type: number
x-enum-type: IntelliTracer.Domain.ResourceType
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
description: (default = 0)
required:
- Id
- Name
nullable: true
type: object
required:
- Id
- Name
- UId
examples:
response:
value:
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
"400":
description: BadRequest
headers: {}
content:
application/json:
schema:
type: object
properties:
Entity:
type: object
properties:
Id:
type: string
Name:
type: string
UId:
type: string
Active:
type: boolean
description: (default = true)
Type:
type: number
x-enum-type: IntelliTracer.ApiV2.SmartphoneType
enum:
- 0
- 1
description: (default = 0)
Orientation:
type: number
x-enum-type: IntelliTracer.ApiV2.SmartphoneOrientation
enum:
- 0
- 1
- 2
- 3
description: (default = 0)
FilterMenusByUserFilter:
type: boolean
description: (default = false)
UserIdentification:
type: number
x-enum-type: IntelliTracer.ApiV2.SmartphoneUserIdentification
enum:
- 0
- 1
- 2
description: (default = 0)
UserIdentificationConfig:
properties:
ByBadge:
type: boolean
description: (default = false)
ByUserCode:
type: boolean
description: (default = false)
ByCiawCode:
type: boolean
description: (default = false)
FixedUserId:
description: (default = null)
nullable: true
type: string
CiawWorkplaceId:
description: (default = null)
nullable: true
type: string
description: (default = null)
nullable: true
type: object
ResourceDetection:
type: number
x-enum-type: IntelliTracer.ApiV2.SmartphoneResourceDetection
enum:
- 0
- 1
- 2
- 3
- 4
- 5
description: (default = 0)
ResourceDetectionConfig:
properties:
FixedVehicleId:
description: (default = null)
nullable: true
type: string
VehicleIds:
description: (default = [])
nullable: true
type: array
items: {}
description: (default = null)
nullable: true
type: object
Positioning:
type: number
x-enum-type: IntelliTracer.ApiV2.SmartphonePositioning
enum:
- 0
- 1
- 2
- 3
- 4
description: (default = 0)
PositioningConfig:
properties:
FixedPoiId:
description: (default = null)
nullable: true
type: string
description: (default = null)
nullable: true
type: object
Team:
type: number
x-enum-type: IntelliTracer.ApiV2.SmartphoneTeam
enum:
- 0
- 1
- 2
description: (default = 0)
TeamConfig:
properties:
GroupUsersByVehicle:
type: boolean
description: (default = false)
description: (default = null)
nullable: true
type: object
TimeRegistration:
type: number
x-enum-type: IntelliTracer.ApiV2.SmartphoneTimeRegistration
enum:
- 0
- 1
- 2
description: (default = 0)
TimeRegistrationConfig:
properties:
MenuId:
description: (default = null)
nullable: true
type: string
description: (default = null)
nullable: true
type: object
CostCenterId:
nullable: true
type: string
required:
- Id
- Name
- UId
ValidationResult:
type: array
items: {}
required:
- Entity
- ValidationResult
examples:
response:
value:
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: []
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Delete smartphone
operationId: Delete smartphone
description: |-
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.
*Privilege required: `Api: Mobile Application Configs`*
x-resource: Smartphones
tags:
- Config
parameters:
- name: id
in: path
description: ""
required: true
example: 00000000-0000-0000-0000-000000000000
schema:
type: string
security:
- pat: []
/api/v2/smartphone:
put:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Id:
type: string
Name:
type: string
UId:
type: string
Active:
type: boolean
description: (default = true)
Type:
type: number
x-enum-type: IntelliTracer.ApiV2.SmartphoneType
enum:
- 0
- 1
description: (default = 0)
Orientation:
type: number
x-enum-type: IntelliTracer.ApiV2.SmartphoneOrientation
enum:
- 0
- 1
- 2
- 3
description: (default = 0)
FilterMenusByUserFilter:
type: boolean
description: (default = false)
UserIdentification:
type: number
x-enum-type: IntelliTracer.ApiV2.SmartphoneUserIdentification
enum:
- 0
- 1
- 2
description: (default = 0)
UserIdentificationConfig:
properties:
ByBadge:
type: boolean
description: (default = false)
ByUserCode:
type: boolean
description: (default = false)
ByCiawCode:
type: boolean
description: (default = false)
FixedUser:
properties:
Id:
type: string
Code:
description: (default = null)
nullable: true
type: string
Name:
type: string
Type:
type: number
x-enum-type: IntelliTracer.Domain.ResourceType
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
description: (default = 0)
required:
- Id
- Name
description: (default = null)
nullable: true
type: object
CiawWorkplace:
properties:
Id:
type: string
DUC:
type: string
Code:
description: (default = null)
nullable: true
type: string
Name:
description: (default = null)
nullable: true
type: string
required:
- Id
- DUC
description: (default = null)
nullable: true
type: object
description: (default = null)
nullable: true
type: object
ResourceDetection:
type: number
x-enum-type: IntelliTracer.ApiV2.SmartphoneResourceDetection
enum:
- 0
- 1
- 2
- 3
- 4
- 5
description: (default = 0)
ResourceDetectionConfig:
properties:
FixedVehicle:
properties:
Id:
type: string
Code:
description: (default = null)
nullable: true
type: string
Name:
type: string
Type:
type: number
x-enum-type: IntelliTracer.Domain.ResourceType
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
description: (default = 0)
required:
- Id
- Name
description: (default = null)
nullable: true
type: object
Vehicles:
description: (default = [])
nullable: true
type: array
items: {}
description: (default = null)
nullable: true
type: object
Positioning:
type: number
x-enum-type: IntelliTracer.ApiV2.SmartphonePositioning
enum:
- 0
- 1
- 2
- 3
- 4
description: (default = 0)
PositioningConfig:
properties:
FixedPoi:
properties:
Id:
type: string
Name:
type: string
Code:
description: "(default = null) "
nullable: true
type: string
required:
- Id
- Name
description: (default = null)
nullable: true
type: object
description: (default = null)
nullable: true
type: object
Team:
type: number
x-enum-type: IntelliTracer.ApiV2.SmartphoneTeam
enum:
- 0
- 1
- 2
description: (default = 0)
TeamConfig:
properties:
GroupUsersByVehicle:
type: boolean
description: (default = false)
description: (default = null)
nullable: true
type: object
TimeRegistration:
type: number
x-enum-type: IntelliTracer.ApiV2.SmartphoneTimeRegistration
enum:
- 0
- 1
- 2
description: (default = 0)
TimeRegistrationConfig:
properties:
Menu:
properties:
Id:
type: string
Name:
type: string
required:
- Id
- Name
description: (default = null)
nullable: true
type: object
description: (default = null)
nullable: true
type: object
CostCenter:
properties:
Id:
type: string
Code:
description: (default = null)
nullable: true
type: string
Name:
type: string
Type:
type: number
x-enum-type: IntelliTracer.Domain.ResourceType
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
description: (default = 0)
required:
- Id
- Name
nullable: true
type: object
required:
- Id
- Name
- UId
examples:
response:
value:
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
"400":
description: BadRequest
headers: {}
content:
application/json:
schema:
type: object
properties:
Entity:
type: object
properties:
Id:
type: string
Name:
type: string
UId:
type: string
Active:
type: boolean
description: (default = true)
Type:
type: number
x-enum-type: IntelliTracer.ApiV2.SmartphoneType
enum:
- 0
- 1
description: (default = 0)
Orientation:
type: number
x-enum-type: IntelliTracer.ApiV2.SmartphoneOrientation
enum:
- 0
- 1
- 2
- 3
description: (default = 0)
FilterMenusByUserFilter:
type: boolean
description: (default = false)
UserIdentification:
type: number
x-enum-type: IntelliTracer.ApiV2.SmartphoneUserIdentification
enum:
- 0
- 1
- 2
description: (default = 0)
UserIdentificationConfig:
properties:
ByBadge:
type: boolean
description: (default = false)
ByUserCode:
type: boolean
description: (default = false)
ByCiawCode:
type: boolean
description: (default = false)
FixedUserId:
description: (default = null)
nullable: true
type: string
CiawWorkplaceId:
description: (default = null)
nullable: true
type: string
description: (default = null)
nullable: true
type: object
ResourceDetection:
type: number
x-enum-type: IntelliTracer.ApiV2.SmartphoneResourceDetection
enum:
- 0
- 1
- 2
- 3
- 4
- 5
description: (default = 0)
ResourceDetectionConfig:
properties:
FixedVehicleId:
description: (default = null)
nullable: true
type: string
VehicleIds:
description: (default = [])
nullable: true
type: array
items: {}
description: (default = null)
nullable: true
type: object
Positioning:
type: number
x-enum-type: IntelliTracer.ApiV2.SmartphonePositioning
enum:
- 0
- 1
- 2
- 3
- 4
description: (default = 0)
PositioningConfig:
properties:
FixedPoiId:
description: (default = null)
nullable: true
type: string
description: (default = null)
nullable: true
type: object
Team:
type: number
x-enum-type: IntelliTracer.ApiV2.SmartphoneTeam
enum:
- 0
- 1
- 2
description: (default = 0)
TeamConfig:
properties:
GroupUsersByVehicle:
type: boolean
description: (default = false)
description: (default = null)
nullable: true
type: object
TimeRegistration:
type: number
x-enum-type: IntelliTracer.ApiV2.SmartphoneTimeRegistration
enum:
- 0
- 1
- 2
description: (default = 0)
TimeRegistrationConfig:
properties:
MenuId:
description: (default = null)
nullable: true
type: string
description: (default = null)
nullable: true
type: object
CostCenterId:
nullable: true
type: string
required:
- Id
- Name
- UId
ValidationResult:
type: array
items: {}
required:
- Entity
- ValidationResult
examples:
response:
value:
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: []
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Create smartphone
operationId: Create smartphone
description: >-
Creates a new smartphone clocking device.
Settings that are not provided will be set to the default settings, which can be configured in IntelliTracer (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.
*Privilege required: `Api: Mobile Application Configs`*
x-resource: Smartphones
tags:
- Config
requestBody:
content:
application/json:
schema:
type: object
properties:
Id:
type: string
Name:
type: string
UId:
type: string
Active:
type: boolean
description: (default = true)
Type:
type: number
x-enum-type: IntelliTracer.ApiV2.SmartphoneType
enum:
- 0
- 1
description: (default = 0)
Orientation:
type: number
x-enum-type: IntelliTracer.ApiV2.SmartphoneOrientation
enum:
- 0
- 1
- 2
- 3
description: (default = 0)
FilterMenusByUserFilter:
type: boolean
description: (default = false)
UserIdentification:
type: number
x-enum-type: IntelliTracer.ApiV2.SmartphoneUserIdentification
enum:
- 0
- 1
- 2
description: (default = 0)
UserIdentificationConfig:
properties:
ByBadge:
type: boolean
description: (default = false)
ByUserCode:
type: boolean
description: (default = false)
ByCiawCode:
type: boolean
description: (default = false)
FixedUserId:
description: (default = null)
nullable: true
type: string
CiawWorkplaceId:
description: (default = null)
nullable: true
type: string
description: (default = null)
nullable: true
type: object
ResourceDetection:
type: number
x-enum-type: IntelliTracer.ApiV2.SmartphoneResourceDetection
enum:
- 0
- 1
- 2
- 3
- 4
- 5
description: (default = 0)
ResourceDetectionConfig:
properties:
FixedVehicleId:
description: (default = null)
nullable: true
type: string
VehicleIds:
description: (default = [])
nullable: true
type: array
items: {}
description: (default = null)
nullable: true
type: object
Positioning:
type: number
x-enum-type: IntelliTracer.ApiV2.SmartphonePositioning
enum:
- 0
- 1
- 2
- 3
- 4
description: (default = 0)
PositioningConfig:
properties:
FixedPoiId:
description: (default = null)
nullable: true
type: string
description: (default = null)
nullable: true
type: object
Team:
type: number
x-enum-type: IntelliTracer.ApiV2.SmartphoneTeam
enum:
- 0
- 1
- 2
description: (default = 0)
TeamConfig:
properties:
GroupUsersByVehicle:
type: boolean
description: (default = false)
description: (default = null)
nullable: true
type: object
TimeRegistration:
type: number
x-enum-type: IntelliTracer.ApiV2.SmartphoneTimeRegistration
enum:
- 0
- 1
- 2
description: (default = 0)
TimeRegistrationConfig:
properties:
MenuId:
description: (default = null)
nullable: true
type: string
description: (default = null)
nullable: true
type: object
CostCenterId:
nullable: true
type: string
required:
- Name
- UId
example:
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
security:
- pat: []
post:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Id:
type: string
Name:
type: string
UId:
type: string
Active:
type: boolean
description: (default = true)
Type:
type: number
x-enum-type: IntelliTracer.ApiV2.SmartphoneType
enum:
- 0
- 1
description: (default = 0)
Orientation:
type: number
x-enum-type: IntelliTracer.ApiV2.SmartphoneOrientation
enum:
- 0
- 1
- 2
- 3
description: (default = 0)
FilterMenusByUserFilter:
type: boolean
description: (default = false)
UserIdentification:
type: number
x-enum-type: IntelliTracer.ApiV2.SmartphoneUserIdentification
enum:
- 0
- 1
- 2
description: (default = 0)
UserIdentificationConfig:
properties:
ByBadge:
type: boolean
description: (default = false)
ByUserCode:
type: boolean
description: (default = false)
ByCiawCode:
type: boolean
description: (default = false)
FixedUser:
properties:
Id:
type: string
Code:
description: (default = null)
nullable: true
type: string
Name:
type: string
Type:
type: number
x-enum-type: IntelliTracer.Domain.ResourceType
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
description: (default = 0)
required:
- Id
- Name
description: (default = null)
nullable: true
type: object
CiawWorkplace:
properties:
Id:
type: string
DUC:
type: string
Code:
description: (default = null)
nullable: true
type: string
Name:
description: (default = null)
nullable: true
type: string
required:
- Id
- DUC
description: (default = null)
nullable: true
type: object
description: (default = null)
nullable: true
type: object
ResourceDetection:
type: number
x-enum-type: IntelliTracer.ApiV2.SmartphoneResourceDetection
enum:
- 0
- 1
- 2
- 3
- 4
- 5
description: (default = 0)
ResourceDetectionConfig:
properties:
FixedVehicle:
properties:
Id:
type: string
Code:
description: (default = null)
nullable: true
type: string
Name:
type: string
Type:
type: number
x-enum-type: IntelliTracer.Domain.ResourceType
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
description: (default = 0)
required:
- Id
- Name
description: (default = null)
nullable: true
type: object
Vehicles:
description: (default = [])
nullable: true
type: array
items: {}
description: (default = null)
nullable: true
type: object
Positioning:
type: number
x-enum-type: IntelliTracer.ApiV2.SmartphonePositioning
enum:
- 0
- 1
- 2
- 3
- 4
description: (default = 0)
PositioningConfig:
properties:
FixedPoi:
properties:
Id:
type: string
Name:
type: string
Code:
description: "(default = null) "
nullable: true
type: string
required:
- Id
- Name
description: (default = null)
nullable: true
type: object
description: (default = null)
nullable: true
type: object
Team:
type: number
x-enum-type: IntelliTracer.ApiV2.SmartphoneTeam
enum:
- 0
- 1
- 2
description: (default = 0)
TeamConfig:
properties:
GroupUsersByVehicle:
type: boolean
description: (default = false)
description: (default = null)
nullable: true
type: object
TimeRegistration:
type: number
x-enum-type: IntelliTracer.ApiV2.SmartphoneTimeRegistration
enum:
- 0
- 1
- 2
description: (default = 0)
TimeRegistrationConfig:
properties:
Menu:
properties:
Id:
type: string
Name:
type: string
required:
- Id
- Name
description: (default = null)
nullable: true
type: object
description: (default = null)
nullable: true
type: object
CostCenter:
properties:
Id:
type: string
Code:
description: (default = null)
nullable: true
type: string
Name:
type: string
Type:
type: number
x-enum-type: IntelliTracer.Domain.ResourceType
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
description: (default = 0)
required:
- Id
- Name
nullable: true
type: object
required:
- Id
- Name
- UId
examples:
response:
value:
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
"400":
description: BadRequest
headers: {}
content:
application/json:
schema:
type: object
properties:
Entity:
type: object
properties:
Id:
type: string
Name:
type: string
UId:
type: string
Active:
type: boolean
description: (default = true)
Type:
type: number
x-enum-type: IntelliTracer.ApiV2.SmartphoneType
enum:
- 0
- 1
description: (default = 0)
Orientation:
type: number
x-enum-type: IntelliTracer.ApiV2.SmartphoneOrientation
enum:
- 0
- 1
- 2
- 3
description: (default = 0)
FilterMenusByUserFilter:
type: boolean
description: (default = false)
UserIdentification:
type: number
x-enum-type: IntelliTracer.ApiV2.SmartphoneUserIdentification
enum:
- 0
- 1
- 2
description: (default = 0)
UserIdentificationConfig:
properties:
ByBadge:
type: boolean
description: (default = false)
ByUserCode:
type: boolean
description: (default = false)
ByCiawCode:
type: boolean
description: (default = false)
FixedUserId:
description: (default = null)
nullable: true
type: string
CiawWorkplaceId:
description: (default = null)
nullable: true
type: string
description: (default = null)
nullable: true
type: object
ResourceDetection:
type: number
x-enum-type: IntelliTracer.ApiV2.SmartphoneResourceDetection
enum:
- 0
- 1
- 2
- 3
- 4
- 5
description: (default = 0)
ResourceDetectionConfig:
properties:
FixedVehicleId:
description: (default = null)
nullable: true
type: string
VehicleIds:
description: (default = [])
nullable: true
type: array
items: {}
description: (default = null)
nullable: true
type: object
Positioning:
type: number
x-enum-type: IntelliTracer.ApiV2.SmartphonePositioning
enum:
- 0
- 1
- 2
- 3
- 4
description: (default = 0)
PositioningConfig:
properties:
FixedPoiId:
description: (default = null)
nullable: true
type: string
description: (default = null)
nullable: true
type: object
Team:
type: number
x-enum-type: IntelliTracer.ApiV2.SmartphoneTeam
enum:
- 0
- 1
- 2
description: (default = 0)
TeamConfig:
properties:
GroupUsersByVehicle:
type: boolean
description: (default = false)
description: (default = null)
nullable: true
type: object
TimeRegistration:
type: number
x-enum-type: IntelliTracer.ApiV2.SmartphoneTimeRegistration
enum:
- 0
- 1
- 2
description: (default = 0)
TimeRegistrationConfig:
properties:
MenuId:
description: (default = null)
nullable: true
type: string
description: (default = null)
nullable: true
type: object
CostCenterId:
nullable: true
type: string
required:
- Id
- Name
- UId
ValidationResult:
type: array
items: {}
required:
- Entity
- ValidationResult
examples:
response:
value:
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: []
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Update smartphone
operationId: Update smartphone
description: >-
Updates a smartphone clocking device.
Settings that are not provided will be set to the default settings, which can be configured in IntelliTracer (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.
*Privilege required: `Api: Mobile Application Configs`*
x-resource: Smartphones
tags:
- Config
requestBody:
content:
application/json:
schema:
type: object
properties:
Id:
type: string
Name:
type: string
UId:
type: string
Active:
type: boolean
description: (default = true)
Type:
type: number
x-enum-type: IntelliTracer.ApiV2.SmartphoneType
enum:
- 0
- 1
description: (default = 0)
Orientation:
type: number
x-enum-type: IntelliTracer.ApiV2.SmartphoneOrientation
enum:
- 0
- 1
- 2
- 3
description: (default = 0)
FilterMenusByUserFilter:
type: boolean
description: (default = false)
UserIdentification:
type: number
x-enum-type: IntelliTracer.ApiV2.SmartphoneUserIdentification
enum:
- 0
- 1
- 2
description: (default = 0)
UserIdentificationConfig:
properties:
ByBadge:
type: boolean
description: (default = false)
ByUserCode:
type: boolean
description: (default = false)
ByCiawCode:
type: boolean
description: (default = false)
FixedUserId:
description: (default = null)
nullable: true
type: string
CiawWorkplaceId:
description: (default = null)
nullable: true
type: string
description: (default = null)
nullable: true
type: object
ResourceDetection:
type: number
x-enum-type: IntelliTracer.ApiV2.SmartphoneResourceDetection
enum:
- 0
- 1
- 2
- 3
- 4
- 5
description: (default = 0)
ResourceDetectionConfig:
properties:
FixedVehicleId:
description: (default = null)
nullable: true
type: string
VehicleIds:
description: (default = [])
nullable: true
type: array
items: {}
description: (default = null)
nullable: true
type: object
Positioning:
type: number
x-enum-type: IntelliTracer.ApiV2.SmartphonePositioning
enum:
- 0
- 1
- 2
- 3
- 4
description: (default = 0)
PositioningConfig:
properties:
FixedPoiId:
description: (default = null)
nullable: true
type: string
description: (default = null)
nullable: true
type: object
Team:
type: number
x-enum-type: IntelliTracer.ApiV2.SmartphoneTeam
enum:
- 0
- 1
- 2
description: (default = 0)
TeamConfig:
properties:
GroupUsersByVehicle:
type: boolean
description: (default = false)
description: (default = null)
nullable: true
type: object
TimeRegistration:
type: number
x-enum-type: IntelliTracer.ApiV2.SmartphoneTimeRegistration
enum:
- 0
- 1
- 2
description: (default = 0)
TimeRegistrationConfig:
properties:
MenuId:
description: (default = null)
nullable: true
type: string
description: (default = null)
nullable: true
type: object
CostCenterId:
nullable: true
type: string
required:
- Id
- Name
- UId
example:
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
security:
- pat: []
"/api/v2/user?page={page}&search={search}":
get:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Data:
description: (default = null)
nullable: true
type: array
items: {}
PagingFilter:
properties:
Page:
type: number
Search:
nullable: true
type: string
PageCount:
type: number
TotalCount:
type: number
Links:
type: object
properties:
Base:
type: string
First:
type: string
Prev:
type: string
Next:
type: string
Last:
type: string
required:
- Base
required:
- Page
- PageCount
- TotalCount
- Links
description: (default = null)
nullable: true
type: object
examples:
response:
value:
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"
PagingFilter:
Page: 1
Search: ABC
PageCount: 4
TotalCount: 100
Links:
Base: https://api.intellitracer.be
First: /api/v2/asset?page=1
Prev: /api/v2/asset?page=2
Next: /api/v2/asset?page=4
Last: /api/v2/asset?page=4
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Get users
operationId: Get users
description: |-
Returns a paged list of users.
Pagination and searching is explained in [Pagination](#pagination).
*Privilege required: `Api: Resource read` or `Api: Resource management`*
x-resource: Users
tags:
- Config
parameters:
- name: page
in: path
description: ""
required: true
example: "1"
schema:
type: number
- name: search
in: path
description: ""
required: true
example: ABC
schema:
type: string
security:
- pat: []
"/api/v2/user/{id}":
get:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Data:
properties:
Id:
type: string
Name:
type: string
Code:
description: (default = null)
nullable: true
type: string
EmployerCode:
description: (default = null)
nullable: true
type: string
Email:
description: (default = null)
nullable: true
type: string
Gsm:
description: (default = null)
nullable: true
type: string
FreeField1:
description: (default = null)
nullable: true
type: string
FreeField2:
description: (default = null)
nullable: true
type: string
FreeField3:
description: (default = null)
nullable: true
type: string
FreeField4:
description: (default = null)
nullable: true
type: string
FreeField5:
description: (default = null)
nullable: true
type: string
FreeField6:
description: "(default = null) "
nullable: true
type: string
Notes:
description: (default = null)
nullable: true
type: string
Street:
description: (default = null)
nullable: true
type: string
HouseNumber:
description: (default = null)
nullable: true
type: string
City:
description: (default = null)
nullable: true
type: string
PostalCode:
description: (default = null)
nullable: true
type: string
Submunicipality:
description: (default = null)
nullable: true
type: string
Country:
type: number
x-enum-type: IntelliTracer.Domain.Country
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
- 47
- 48
- 49
- 50
- 51
- 52
- 53
- 54
- 55
- 56
- 57
- 58
- 59
- 60
- 61
- 62
- 63
- 64
- 65
- 66
- 67
- 68
- 69
- 70
- 71
- 72
- 73
- 74
- 75
- 76
- 77
- 78
- 79
- 80
- 81
- 82
- 83
- 84
- 85
- 86
- 87
- 88
- 89
- 90
- 91
- 92
- 93
- 94
- 95
- 96
- 97
- 98
- 99
- 100
- 101
- 102
- 103
- 104
- 105
- 106
- 107
- 108
- 109
- 110
- 111
- 112
- 113
- 114
- 115
- 116
- 117
- 118
- 119
- 120
- 121
- 122
- 123
- 124
- 125
- 126
- 127
- 128
- 129
- 130
- 131
- 132
- 133
- 134
- 135
- 136
- 137
- 138
- 139
- 140
- 141
- 142
- 143
- 144
- 145
- 146
- 147
- 148
- 149
- 150
- 151
- 152
- 153
- 9999
description: (default = 0)
Longitude:
description: >-
(default = null)
Geographic coordinate that specifies the east–west position of a point on the Earth's surface.
nullable: true
type: number
Latitude:
description: >-
(default = null)
Geographic coordinate that specifies the north–south position of a point on the Earth's surface.
nullable: true
type: number
DefaultDayProgram:
properties:
Id:
type: string
Name:
type: string
required:
- Id
- Name
description: (default = null)
nullable: true
type: object
MobilityRule:
type: number
x-enum-type: IntelliTracer.ApiV2.UserMobilityRule
enum:
- 0
- 1
- 2
- 5
- 6
- 7
- 8
- 9
- 10
- 12
description: (default = 0)
OvertimeConfig:
properties:
Id:
type: string
Name:
type: string
FirstHourCode:
type: string
FirstHourDescription:
type: string
ExtraHoursCode:
type: string
ExtraHoursDescription:
type: string
SaturdayHoursCode:
type: string
SaturdayOvertimeCode:
type: string
SundayHoursCode:
type: string
SundayOvertimeCode:
type: string
HoursType:
type: string
required:
- Id
- Name
- HoursType
description: (default = null)
nullable: true
type: object
Groups:
description: (default = null)
nullable: true
type: array
items: {}
FilterIvrCode:
description: (default = null)
nullable: true
type: string
required:
- Id
- Name
description: (default = null)
nullable: true
type: object
examples:
response:
value:
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"
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"404":
description: NotFound
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Get user
operationId: Get user
description: |-
Returns a user by id.
*Privilege required: `Api: Resource read` or `Api: Resource management`*
x-resource: Users
tags:
- Config
parameters:
- name: id
in: path
description: ""
required: true
example: 00000000-0000-0000-0000-000000000000
schema:
type: string
security:
- pat: []
/api/v3/user:
put:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Data:
properties:
Id:
type: string
Name:
type: string
Code:
description: (default = null)
nullable: true
type: string
EmployerCode:
description: (default = null)
nullable: true
type: string
Email:
description: (default = null)
nullable: true
type: string
Gsm:
description: (default = null)
nullable: true
type: string
FreeField1:
description: (default = null)
nullable: true
type: string
FreeField2:
description: (default = null)
nullable: true
type: string
FreeField3:
description: (default = null)
nullable: true
type: string
FreeField4:
description: (default = null)
nullable: true
type: string
FreeField5:
description: (default = null)
nullable: true
type: string
FreeField6:
description: "(default = null) "
nullable: true
type: string
Notes:
description: (default = null)
nullable: true
type: string
Street:
description: (default = null)
nullable: true
type: string
HouseNumber:
description: (default = null)
nullable: true
type: string
City:
description: (default = null)
nullable: true
type: string
PostalCode:
description: (default = null)
nullable: true
type: string
Submunicipality:
description: (default = null)
nullable: true
type: string
Country:
type: number
x-enum-type: IntelliTracer.Domain.Country
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
- 47
- 48
- 49
- 50
- 51
- 52
- 53
- 54
- 55
- 56
- 57
- 58
- 59
- 60
- 61
- 62
- 63
- 64
- 65
- 66
- 67
- 68
- 69
- 70
- 71
- 72
- 73
- 74
- 75
- 76
- 77
- 78
- 79
- 80
- 81
- 82
- 83
- 84
- 85
- 86
- 87
- 88
- 89
- 90
- 91
- 92
- 93
- 94
- 95
- 96
- 97
- 98
- 99
- 100
- 101
- 102
- 103
- 104
- 105
- 106
- 107
- 108
- 109
- 110
- 111
- 112
- 113
- 114
- 115
- 116
- 117
- 118
- 119
- 120
- 121
- 122
- 123
- 124
- 125
- 126
- 127
- 128
- 129
- 130
- 131
- 132
- 133
- 134
- 135
- 136
- 137
- 138
- 139
- 140
- 141
- 142
- 143
- 144
- 145
- 146
- 147
- 148
- 149
- 150
- 151
- 152
- 153
- 9999
description: (default = 0)
Longitude:
description: >-
(default = null)
Geographic coordinate that specifies the east–west position of a point on the Earth's surface.
nullable: true
type: number
Latitude:
description: >-
(default = null)
Geographic coordinate that specifies the north–south position of a point on the Earth's surface.
nullable: true
type: number
MobilityRule:
type: number
x-enum-type: IntelliTracer.ApiV2.UserMobilityRule
enum:
- 0
- 1
- 2
- 5
- 6
- 7
- 8
- 9
- 10
- 12
description: (default = 0)
FilterIvrCode:
type: string
description: (default = null)
DefaultDayProgram:
properties:
Id:
type: string
Name:
type: string
required:
- Id
- Name
description: (default = null)
nullable: true
type: object
OvertimeConfig:
properties:
Id:
type: string
Name:
type: string
FirstHourCode:
type: string
FirstHourDescription:
type: string
ExtraHoursCode:
type: string
ExtraHoursDescription:
type: string
SaturdayHoursCode:
type: string
SaturdayOvertimeCode:
type: string
SundayHoursCode:
type: string
SundayOvertimeCode:
type: string
HoursType:
type: string
required:
- Id
- Name
- HoursType
description: (default = null)
nullable: true
type: object
Groups:
description: (default = null)
nullable: true
type: array
items: {}
required:
- Id
- Name
description: (default = null)
nullable: true
type: object
examples:
response:
value:
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
"400":
description: BadRequest
headers: {}
content:
application/json:
schema:
type: object
properties:
Entity:
type: object
properties:
Id:
type: string
Name:
type: string
Code:
description: (default = null)
nullable: true
type: string
EmployerCode:
description: (default = null)
nullable: true
type: string
Email:
description: (default = null)
nullable: true
type: string
Gsm:
description: (default = null)
nullable: true
type: string
FreeField1:
description: (default = null)
nullable: true
type: string
FreeField2:
description: (default = null)
nullable: true
type: string
FreeField3:
description: (default = null)
nullable: true
type: string
FreeField4:
description: (default = null)
nullable: true
type: string
FreeField5:
description: (default = null)
nullable: true
type: string
FreeField6:
description: "(default = null) "
nullable: true
type: string
Notes:
description: (default = null)
nullable: true
type: string
Street:
description: (default = null)
nullable: true
type: string
HouseNumber:
description: (default = null)
nullable: true
type: string
City:
description: (default = null)
nullable: true
type: string
PostalCode:
description: (default = null)
nullable: true
type: string
Submunicipality:
description: (default = null)
nullable: true
type: string
Country:
type: number
x-enum-type: IntelliTracer.Domain.Country
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
- 47
- 48
- 49
- 50
- 51
- 52
- 53
- 54
- 55
- 56
- 57
- 58
- 59
- 60
- 61
- 62
- 63
- 64
- 65
- 66
- 67
- 68
- 69
- 70
- 71
- 72
- 73
- 74
- 75
- 76
- 77
- 78
- 79
- 80
- 81
- 82
- 83
- 84
- 85
- 86
- 87
- 88
- 89
- 90
- 91
- 92
- 93
- 94
- 95
- 96
- 97
- 98
- 99
- 100
- 101
- 102
- 103
- 104
- 105
- 106
- 107
- 108
- 109
- 110
- 111
- 112
- 113
- 114
- 115
- 116
- 117
- 118
- 119
- 120
- 121
- 122
- 123
- 124
- 125
- 126
- 127
- 128
- 129
- 130
- 131
- 132
- 133
- 134
- 135
- 136
- 137
- 138
- 139
- 140
- 141
- 142
- 143
- 144
- 145
- 146
- 147
- 148
- 149
- 150
- 151
- 152
- 153
- 9999
description: (default = 0)
Longitude:
description: >-
(default = null)
Geographic coordinate that specifies the east–west position of a point on the Earth's surface.
nullable: true
type: number
Latitude:
description: >-
(default = null)
Geographic coordinate that specifies the north–south position of a point on the Earth's surface.
nullable: true
type: number
MobilityRule:
type: number
x-enum-type: IntelliTracer.ApiV2.UserMobilityRule
enum:
- 0
- 1
- 2
- 5
- 6
- 7
- 8
- 9
- 10
- 12
description: (default = 0)
FilterIvrCode:
type: string
description: (default = null)
required:
- Id
- Name
ValidationResult:
type: array
items: {}
required:
- Entity
- ValidationResult
examples:
response:
value:
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: []
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Create user
operationId: Create user
description: |-
Creates a new user.
*Privilege required: `Api: Resource management`*
x-resource: Users
tags:
- Config
requestBody:
content:
application/json:
schema:
type: object
properties:
Id:
type: string
Name:
type: string
Code:
description: (default = null)
nullable: true
type: string
EmployerCode:
description: (default = null)
nullable: true
type: string
Email:
description: (default = null)
nullable: true
type: string
Gsm:
description: (default = null)
nullable: true
type: string
FreeField1:
description: (default = null)
nullable: true
type: string
FreeField2:
description: (default = null)
nullable: true
type: string
FreeField3:
description: (default = null)
nullable: true
type: string
FreeField4:
description: (default = null)
nullable: true
type: string
FreeField5:
description: (default = null)
nullable: true
type: string
FreeField6:
description: "(default = null) "
nullable: true
type: string
Notes:
description: (default = null)
nullable: true
type: string
Street:
description: (default = null)
nullable: true
type: string
HouseNumber:
description: (default = null)
nullable: true
type: string
City:
description: (default = null)
nullable: true
type: string
PostalCode:
description: (default = null)
nullable: true
type: string
Submunicipality:
description: (default = null)
nullable: true
type: string
Country:
type: number
x-enum-type: IntelliTracer.Domain.Country
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
- 47
- 48
- 49
- 50
- 51
- 52
- 53
- 54
- 55
- 56
- 57
- 58
- 59
- 60
- 61
- 62
- 63
- 64
- 65
- 66
- 67
- 68
- 69
- 70
- 71
- 72
- 73
- 74
- 75
- 76
- 77
- 78
- 79
- 80
- 81
- 82
- 83
- 84
- 85
- 86
- 87
- 88
- 89
- 90
- 91
- 92
- 93
- 94
- 95
- 96
- 97
- 98
- 99
- 100
- 101
- 102
- 103
- 104
- 105
- 106
- 107
- 108
- 109
- 110
- 111
- 112
- 113
- 114
- 115
- 116
- 117
- 118
- 119
- 120
- 121
- 122
- 123
- 124
- 125
- 126
- 127
- 128
- 129
- 130
- 131
- 132
- 133
- 134
- 135
- 136
- 137
- 138
- 139
- 140
- 141
- 142
- 143
- 144
- 145
- 146
- 147
- 148
- 149
- 150
- 151
- 152
- 153
- 9999
description: (default = 0)
Longitude:
description: >-
(default = null)
Geographic coordinate that specifies the east–west position of a point on the Earth's surface.
nullable: true
type: number
Latitude:
description: >-
(default = null)
Geographic coordinate that specifies the north–south position of a point on the Earth's surface.
nullable: true
type: number
MobilityRule:
type: number
x-enum-type: IntelliTracer.ApiV2.UserMobilityRule
enum:
- 0
- 1
- 2
- 5
- 6
- 7
- 8
- 9
- 10
- 12
description: (default = 0)
FilterIvrCode:
type: string
description: (default = null)
DefaultDayProgramId:
type: string
description: (default = null)
OvertimeConfigId:
type: string
description: (default = null)
required:
- Name
example:
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
security:
- pat: []
post:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Data:
properties:
Id:
type: string
Name:
type: string
Code:
description: (default = null)
nullable: true
type: string
EmployerCode:
description: (default = null)
nullable: true
type: string
Email:
description: (default = null)
nullable: true
type: string
Gsm:
description: (default = null)
nullable: true
type: string
FreeField1:
description: (default = null)
nullable: true
type: string
FreeField2:
description: (default = null)
nullable: true
type: string
FreeField3:
description: (default = null)
nullable: true
type: string
FreeField4:
description: (default = null)
nullable: true
type: string
FreeField5:
description: (default = null)
nullable: true
type: string
FreeField6:
description: "(default = null) "
nullable: true
type: string
Notes:
description: (default = null)
nullable: true
type: string
Street:
description: (default = null)
nullable: true
type: string
HouseNumber:
description: (default = null)
nullable: true
type: string
City:
description: (default = null)
nullable: true
type: string
PostalCode:
description: (default = null)
nullable: true
type: string
Submunicipality:
description: (default = null)
nullable: true
type: string
Country:
type: number
x-enum-type: IntelliTracer.Domain.Country
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
- 47
- 48
- 49
- 50
- 51
- 52
- 53
- 54
- 55
- 56
- 57
- 58
- 59
- 60
- 61
- 62
- 63
- 64
- 65
- 66
- 67
- 68
- 69
- 70
- 71
- 72
- 73
- 74
- 75
- 76
- 77
- 78
- 79
- 80
- 81
- 82
- 83
- 84
- 85
- 86
- 87
- 88
- 89
- 90
- 91
- 92
- 93
- 94
- 95
- 96
- 97
- 98
- 99
- 100
- 101
- 102
- 103
- 104
- 105
- 106
- 107
- 108
- 109
- 110
- 111
- 112
- 113
- 114
- 115
- 116
- 117
- 118
- 119
- 120
- 121
- 122
- 123
- 124
- 125
- 126
- 127
- 128
- 129
- 130
- 131
- 132
- 133
- 134
- 135
- 136
- 137
- 138
- 139
- 140
- 141
- 142
- 143
- 144
- 145
- 146
- 147
- 148
- 149
- 150
- 151
- 152
- 153
- 9999
description: (default = 0)
Longitude:
description: >-
(default = null)
Geographic coordinate that specifies the east–west position of a point on the Earth's surface.
nullable: true
type: number
Latitude:
description: >-
(default = null)
Geographic coordinate that specifies the north–south position of a point on the Earth's surface.
nullable: true
type: number
MobilityRule:
type: number
x-enum-type: IntelliTracer.ApiV2.UserMobilityRule
enum:
- 0
- 1
- 2
- 5
- 6
- 7
- 8
- 9
- 10
- 12
description: (default = 0)
FilterIvrCode:
type: string
description: (default = null)
DefaultDayProgram:
properties:
Id:
type: string
Name:
type: string
required:
- Id
- Name
description: (default = null)
nullable: true
type: object
OvertimeConfig:
properties:
Id:
type: string
Name:
type: string
FirstHourCode:
type: string
FirstHourDescription:
type: string
ExtraHoursCode:
type: string
ExtraHoursDescription:
type: string
SaturdayHoursCode:
type: string
SaturdayOvertimeCode:
type: string
SundayHoursCode:
type: string
SundayOvertimeCode:
type: string
HoursType:
type: string
required:
- Id
- Name
- HoursType
description: (default = null)
nullable: true
type: object
Groups:
description: (default = null)
nullable: true
type: array
items: {}
required:
- Id
- Name
description: (default = null)
nullable: true
type: object
examples:
response:
value:
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
"400":
description: BadRequest
headers: {}
content:
application/json:
schema:
type: object
properties:
Entity:
type: object
properties:
Id:
type: string
Name:
type: string
Code:
description: (default = null)
nullable: true
type: string
EmployerCode:
description: (default = null)
nullable: true
type: string
Email:
description: (default = null)
nullable: true
type: string
Gsm:
description: (default = null)
nullable: true
type: string
FreeField1:
description: (default = null)
nullable: true
type: string
FreeField2:
description: (default = null)
nullable: true
type: string
FreeField3:
description: (default = null)
nullable: true
type: string
FreeField4:
description: (default = null)
nullable: true
type: string
FreeField5:
description: (default = null)
nullable: true
type: string
FreeField6:
description: "(default = null) "
nullable: true
type: string
Notes:
description: (default = null)
nullable: true
type: string
Street:
description: (default = null)
nullable: true
type: string
HouseNumber:
description: (default = null)
nullable: true
type: string
City:
description: (default = null)
nullable: true
type: string
PostalCode:
description: (default = null)
nullable: true
type: string
Submunicipality:
description: (default = null)
nullable: true
type: string
Country:
type: number
x-enum-type: IntelliTracer.Domain.Country
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
- 47
- 48
- 49
- 50
- 51
- 52
- 53
- 54
- 55
- 56
- 57
- 58
- 59
- 60
- 61
- 62
- 63
- 64
- 65
- 66
- 67
- 68
- 69
- 70
- 71
- 72
- 73
- 74
- 75
- 76
- 77
- 78
- 79
- 80
- 81
- 82
- 83
- 84
- 85
- 86
- 87
- 88
- 89
- 90
- 91
- 92
- 93
- 94
- 95
- 96
- 97
- 98
- 99
- 100
- 101
- 102
- 103
- 104
- 105
- 106
- 107
- 108
- 109
- 110
- 111
- 112
- 113
- 114
- 115
- 116
- 117
- 118
- 119
- 120
- 121
- 122
- 123
- 124
- 125
- 126
- 127
- 128
- 129
- 130
- 131
- 132
- 133
- 134
- 135
- 136
- 137
- 138
- 139
- 140
- 141
- 142
- 143
- 144
- 145
- 146
- 147
- 148
- 149
- 150
- 151
- 152
- 153
- 9999
description: (default = 0)
Longitude:
description: >-
(default = null)
Geographic coordinate that specifies the east–west position of a point on the Earth's surface.
nullable: true
type: number
Latitude:
description: >-
(default = null)
Geographic coordinate that specifies the north–south position of a point on the Earth's surface.
nullable: true
type: number
MobilityRule:
type: number
x-enum-type: IntelliTracer.ApiV2.UserMobilityRule
enum:
- 0
- 1
- 2
- 5
- 6
- 7
- 8
- 9
- 10
- 12
description: (default = 0)
FilterIvrCode:
type: string
description: (default = null)
required:
- Id
- Name
ValidationResult:
type: array
items: {}
required:
- Entity
- ValidationResult
examples:
response:
value:
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: []
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Update user
operationId: Update user
description: |-
Updates a user.
*Privilege required: `Api: Resource management`*
x-resource: Users
tags:
- Config
requestBody:
content:
application/json:
schema:
type: object
properties:
Id:
type: string
Name:
type: string
Code:
description: (default = null)
nullable: true
type: string
EmployerCode:
description: (default = null)
nullable: true
type: string
Email:
description: (default = null)
nullable: true
type: string
Gsm:
description: (default = null)
nullable: true
type: string
FreeField1:
description: (default = null)
nullable: true
type: string
FreeField2:
description: (default = null)
nullable: true
type: string
FreeField3:
description: (default = null)
nullable: true
type: string
FreeField4:
description: (default = null)
nullable: true
type: string
FreeField5:
description: (default = null)
nullable: true
type: string
FreeField6:
description: "(default = null) "
nullable: true
type: string
Notes:
description: (default = null)
nullable: true
type: string
Street:
description: (default = null)
nullable: true
type: string
HouseNumber:
description: (default = null)
nullable: true
type: string
City:
description: (default = null)
nullable: true
type: string
PostalCode:
description: (default = null)
nullable: true
type: string
Submunicipality:
description: (default = null)
nullable: true
type: string
Country:
type: number
x-enum-type: IntelliTracer.Domain.Country
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
- 47
- 48
- 49
- 50
- 51
- 52
- 53
- 54
- 55
- 56
- 57
- 58
- 59
- 60
- 61
- 62
- 63
- 64
- 65
- 66
- 67
- 68
- 69
- 70
- 71
- 72
- 73
- 74
- 75
- 76
- 77
- 78
- 79
- 80
- 81
- 82
- 83
- 84
- 85
- 86
- 87
- 88
- 89
- 90
- 91
- 92
- 93
- 94
- 95
- 96
- 97
- 98
- 99
- 100
- 101
- 102
- 103
- 104
- 105
- 106
- 107
- 108
- 109
- 110
- 111
- 112
- 113
- 114
- 115
- 116
- 117
- 118
- 119
- 120
- 121
- 122
- 123
- 124
- 125
- 126
- 127
- 128
- 129
- 130
- 131
- 132
- 133
- 134
- 135
- 136
- 137
- 138
- 139
- 140
- 141
- 142
- 143
- 144
- 145
- 146
- 147
- 148
- 149
- 150
- 151
- 152
- 153
- 9999
description: (default = 0)
Longitude:
description: >-
(default = null)
Geographic coordinate that specifies the east–west position of a point on the Earth's surface.
nullable: true
type: number
Latitude:
description: >-
(default = null)
Geographic coordinate that specifies the north–south position of a point on the Earth's surface.
nullable: true
type: number
MobilityRule:
type: number
x-enum-type: IntelliTracer.ApiV2.UserMobilityRule
enum:
- 0
- 1
- 2
- 5
- 6
- 7
- 8
- 9
- 10
- 12
description: (default = 0)
FilterIvrCode:
type: string
description: (default = null)
DefaultDayProgramId:
type: string
description: (default = null)
OvertimeConfigId:
type: string
description: (default = null)
required:
- Id
- Name
example:
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
security:
- pat: []
/api/v1/user:
delete:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Id:
type: string
Name:
type: string
Code:
description: (default = null)
nullable: true
type: string
EmployerCode:
description: (default = null)
nullable: true
type: string
Email:
description: (default = null)
nullable: true
type: string
Gsm:
description: (default = null)
nullable: true
type: string
FreeField1:
description: (default = null)
nullable: true
type: string
FreeField2:
description: (default = null)
nullable: true
type: string
FreeField3:
description: (default = null)
nullable: true
type: string
FreeField4:
description: (default = null)
nullable: true
type: string
FreeField5:
description: (default = null)
nullable: true
type: string
FreeField6:
description: "(default = null) "
nullable: true
type: string
Notes:
description: (default = null)
nullable: true
type: string
Street:
description: (default = null)
nullable: true
type: string
HouseNumber:
description: (default = null)
nullable: true
type: string
City:
description: (default = null)
nullable: true
type: string
PostalCode:
description: (default = null)
nullable: true
type: string
Submunicipality:
description: (default = null)
nullable: true
type: string
Country:
type: number
x-enum-type: IntelliTracer.Domain.Country
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
- 47
- 48
- 49
- 50
- 51
- 52
- 53
- 54
- 55
- 56
- 57
- 58
- 59
- 60
- 61
- 62
- 63
- 64
- 65
- 66
- 67
- 68
- 69
- 70
- 71
- 72
- 73
- 74
- 75
- 76
- 77
- 78
- 79
- 80
- 81
- 82
- 83
- 84
- 85
- 86
- 87
- 88
- 89
- 90
- 91
- 92
- 93
- 94
- 95
- 96
- 97
- 98
- 99
- 100
- 101
- 102
- 103
- 104
- 105
- 106
- 107
- 108
- 109
- 110
- 111
- 112
- 113
- 114
- 115
- 116
- 117
- 118
- 119
- 120
- 121
- 122
- 123
- 124
- 125
- 126
- 127
- 128
- 129
- 130
- 131
- 132
- 133
- 134
- 135
- 136
- 137
- 138
- 139
- 140
- 141
- 142
- 143
- 144
- 145
- 146
- 147
- 148
- 149
- 150
- 151
- 152
- 153
- 9999
description: (default = 0)
Longitude:
description: >-
(default = null)
Geographic coordinate that specifies the east–west position of a point on the Earth's surface.
nullable: true
type: number
Latitude:
description: >-
(default = null)
Geographic coordinate that specifies the north–south position of a point on the Earth's surface.
nullable: true
type: number
DefaultDayProgram:
properties:
Id:
type: string
Name:
type: string
_typeDescriptor:
type: string
required:
- Id
- Name
description: (default = null)
nullable: true
type: object
Groups:
description: (default = null)
nullable: true
type: array
items: {}
_typeDescriptor:
type: string
required:
- Id
- Name
examples:
response:
value:
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"
"400":
description: BadRequest
headers: {}
content:
application/json:
schema:
type: object
properties:
Entity:
type: object
properties:
Id:
type: string
Name:
type: string
Code:
description: (default = null)
nullable: true
type: string
EmployerCode:
description: (default = null)
nullable: true
type: string
Email:
description: (default = null)
nullable: true
type: string
Gsm:
description: (default = null)
nullable: true
type: string
FreeField1:
description: (default = null)
nullable: true
type: string
FreeField2:
description: (default = null)
nullable: true
type: string
FreeField3:
description: (default = null)
nullable: true
type: string
FreeField4:
description: (default = null)
nullable: true
type: string
FreeField5:
description: (default = null)
nullable: true
type: string
FreeField6:
description: "(default = null) "
nullable: true
type: string
Notes:
description: (default = null)
nullable: true
type: string
Street:
description: (default = null)
nullable: true
type: string
HouseNumber:
description: (default = null)
nullable: true
type: string
City:
description: (default = null)
nullable: true
type: string
PostalCode:
description: (default = null)
nullable: true
type: string
Submunicipality:
description: (default = null)
nullable: true
type: string
Country:
type: number
x-enum-type: IntelliTracer.Domain.Country
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
- 47
- 48
- 49
- 50
- 51
- 52
- 53
- 54
- 55
- 56
- 57
- 58
- 59
- 60
- 61
- 62
- 63
- 64
- 65
- 66
- 67
- 68
- 69
- 70
- 71
- 72
- 73
- 74
- 75
- 76
- 77
- 78
- 79
- 80
- 81
- 82
- 83
- 84
- 85
- 86
- 87
- 88
- 89
- 90
- 91
- 92
- 93
- 94
- 95
- 96
- 97
- 98
- 99
- 100
- 101
- 102
- 103
- 104
- 105
- 106
- 107
- 108
- 109
- 110
- 111
- 112
- 113
- 114
- 115
- 116
- 117
- 118
- 119
- 120
- 121
- 122
- 123
- 124
- 125
- 126
- 127
- 128
- 129
- 130
- 131
- 132
- 133
- 134
- 135
- 136
- 137
- 138
- 139
- 140
- 141
- 142
- 143
- 144
- 145
- 146
- 147
- 148
- 149
- 150
- 151
- 152
- 153
- 9999
description: (default = 0)
Longitude:
description: >-
(default = null)
Geographic coordinate that specifies the east–west position of a point on the Earth's surface.
nullable: true
type: number
Latitude:
description: >-
(default = null)
Geographic coordinate that specifies the north–south position of a point on the Earth's surface.
nullable: true
type: number
DefaultDayProgram:
properties:
Id:
type: string
Name:
type: string
_typeDescriptor:
type: string
required:
- Id
- Name
description: (default = null)
nullable: true
type: object
Groups:
description: (default = null)
nullable: true
type: array
items: {}
_typeDescriptor:
type: string
required:
- Id
- Name
ValidationResult:
type: array
items: {}
required:
- Entity
- ValidationResult
examples:
response:
value:
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: []
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Delete user
operationId: Delete user
description: |-
Deletes a user.
*Privilege required: `Api: Resource management`*
x-resource: Users
tags:
- Config
requestBody:
$ref: "#/components/requestBodies/Delete_point_of_interestBody"
security:
- pat: []
"/api/v3/user/{id}/permitted-groups?page={page}&search={search}":
get:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Data:
description: (default = null)
nullable: true
type: array
items: {}
PagingFilter:
properties:
Page:
type: number
Search:
nullable: true
type: string
PageCount:
type: number
TotalCount:
type: number
Links:
type: object
properties:
Base:
type: string
First:
type: string
Prev:
type: string
Next:
type: string
Last:
type: string
required:
- Base
required:
- Page
- PageCount
- TotalCount
- Links
description: (default = null)
nullable: true
type: object
examples:
response:
value:
Data:
- Id: 00000000-0000-0000-0000-000000000000
Code: "012345"
Name: John Doe
Type: ""
PagingFilter:
Page: 1
Search: ABC
PageCount: 4
TotalCount: 100
Links:
Base: https://api.intellitracer.be
First: /api/v2/asset?page=1
Prev: /api/v2/asset?page=2
Next: /api/v2/asset?page=4
Last: /api/v2/asset?page=4
"400":
description: Bad Request
headers: {}
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Get user permitted resource groups
operationId: Get user permitted resource groups
description: |-
Returns a list of all permitted resource groups of a user.
*Privilege required: `Api: Resource read` or `Api: Resource management`*
x-resource: Users - Permitted Resource Groups
tags:
- Config
parameters:
- name: id
in: path
description: ""
required: true
example: 00000000-0000-0000-0000-000000000000
schema:
type: string
- name: page
in: path
description: ""
required: true
example: "1"
schema:
type: number
- name: search
in: path
description: ""
required: true
example: ABC
schema:
type: string
security:
- pat: []
"/api/v3/user/{id}/permitted-groups":
put:
responses:
"200":
description: OK
headers: {}
"400":
description: Bad Request
headers: {}
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Add permitted resource groups to user
operationId: Add permitted resource groups to user
description: |-
Adds a list of permitted resource groups to a user.
*Privilege required: `Api: Resource management`*
x-resource: Users - Permitted Resource Groups
tags:
- Config
parameters:
- name: id
in: path
description: ""
required: true
example: 00000000-0000-0000-0000-000000000000
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
properties:
GroupIds:
type: array
items: {}
Type:
type: string
x-enum-type: IntelliTracer.Domain.ResourceTypeString
enum:
- user
- vehicle
- timeclock
- asset
- ivrphonenumber
- costcenter
- workplace
- mobileclocking
required:
- GroupIds
- Type
example:
GroupIds: []
Type: ""
security:
- pat: []
delete:
responses:
"200":
description: OK
headers: {}
"400":
description: Bad Request
headers: {}
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Remove permitted resource groups from user
operationId: Remove permitted resource groups from user
description: |-
Removes a list of permitted resource groups from a user.
*Privilege required: `Api: Resource management`*
x-resource: Users - Permitted Resource Groups
tags:
- Config
parameters:
- name: id
in: path
description: ""
required: true
example: 00000000-0000-0000-0000-000000000000
schema:
type: string
requestBody:
content:
application/json:
schema:
type: array
items:
type: string
example:
- 00000000-0000-0000-0000-000000000000
- 00000000-0000-0000-0000-000000000000
security:
- pat: []
"/api/v3/user/{id}/dayprograms?fromDate={fromDate}&toDate={toDate}":
get:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/IntelliTracer.ApiV3.UserDayProgram"
examples:
response:
value:
- 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
"400":
description: Bad Request
headers: {}
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Get user day programs
operationId: Get user day programs
description: |-
Returns a list of all day programs of a user within a date range.
*Privilege required: `Api: Resource read` or `Api: Resource management`*
x-resource: Users - Day Programs
tags:
- Config
parameters:
- name: id
in: path
description: ""
required: true
example: 00000000-0000-0000-0000-000000000000
schema:
type: string
- name: fromDate
in: path
description: ""
required: true
example: 2019-01-25
schema:
type: string
- name: toDate
in: path
description: ""
required: true
example: 2019-01-27
schema:
type: string
security:
- pat: []
"/api/v3/user/{id}/dayprograms":
put:
responses:
"200":
description: OK
headers: {}
"400":
description: Bad Request
headers: {}
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Update user day programs
operationId: Update user day programs
description: |-
Updates the day programs of a user within a date range.
*Privilege required: `Api: Resource management`*
x-resource: Users - Day Programs
tags:
- Config
parameters:
- name: id
in: path
description: ""
required: true
example: 00000000-0000-0000-0000-000000000000
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
properties:
DayProgramId:
type: string
FromDate:
type: string
ToDate:
type: string
required:
- DayProgramId
- FromDate
- ToDate
example:
DayProgramId: 00000000-0000-0000-0000-000000000000
FromDate: 2019-01-25
ToDate: 2019-01-27
security:
- pat: []
"/api/v2/overtimeconfig?page={page}&search={search}":
get:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Data:
nullable: true
type: array
items: {}
PagingFilter:
properties:
Page:
type: number
Search:
nullable: true
type: string
PageCount:
type: number
TotalCount:
type: number
Links:
type: object
properties:
Base:
type: string
First:
type: string
Prev:
type: string
Next:
type: string
Last:
type: string
required:
- Base
required:
- Page
- PageCount
- TotalCount
- Links
description: (default = null)
nullable: true
type: object
examples:
response:
value:
Data:
- Id: 00000000-0000-0000-0000-000000000000
Name: ""
FirstHourCode: "001"
ExtraHoursCode: "002"
SaturdayHoursCode: SA01
SaturdayOvertimeCode: SA02
SundayHoursCode: SU01
SundayOvertimeCode: SU02
HoursType: 01:00:00
PagingFilter:
Page: 1
Search: ABC
PageCount: 4
TotalCount: 100
Links:
Base: https://api.intellitracer.be
First: /api/v2/asset?page=1
Prev: /api/v2/asset?page=2
Next: /api/v2/asset?page=4
Last: /api/v2/asset?page=4
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Get overtime configurations
operationId: Get overtime configurations
description: >-
Returns a paged list of overtime configurations.
*Privilege required: `Api: Timesheet read` or `Api: Timesheet management`*
x-resource: Overtime configurations
tags:
- Config
parameters:
- name: page
in: path
description: ""
required: true
example: "1"
schema:
type: number
- name: search
in: path
description: ""
required: true
example: ABC
schema:
type: string
security:
- pat: []
"/api/v2/overtimeconfig/{id}":
get:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Data:
properties:
Id:
type: string
Name:
type: string
FirstHourCode:
type: string
FirstHourDescription:
type: string
ExtraHoursCode:
type: string
ExtraHoursDescription:
type: string
SaturdayHoursCode:
type: string
SaturdayOvertimeCode:
type: string
SundayHoursCode:
type: string
SundayOvertimeCode:
type: string
HoursType:
type: string
required:
- Id
- Name
- HoursType
description: (default = null)
nullable: true
type: object
examples:
response:
value:
Data:
Id: 00000000-0000-0000-0000-000000000000
Name: ""
FirstHourCode: "001"
ExtraHoursCode: "002"
SaturdayHoursCode: SA01
SaturdayOvertimeCode: SA02
SundayHoursCode: SU01
SundayOvertimeCode: SU02
HoursType: 01:00:00
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Get overtime configuration
operationId: Get overtime configuration
description: >-
Returns an overtime configuration by id.
*Privilege required: `Api: Timesheet read` or `Api: Timesheet management`*
x-resource: Overtime configurations
tags:
- Config
parameters:
- name: id
in: path
description: ""
required: true
example: 00000000-0000-0000-0000-000000000000
schema:
type: string
security:
- pat: []
"/api/v2/location/lastposition?page={page}&limit={limit}&search={search}":
get:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Data:
description: (default = null)
nullable: true
type: array
items: {}
PagingFilter:
properties:
Page:
type: number
Search:
nullable: true
type: string
PageCount:
type: number
TotalCount:
type: number
Links:
type: object
properties:
Base:
type: string
First:
type: string
Prev:
type: string
Next:
type: string
Last:
type: string
required:
- Base
required:
- Page
- PageCount
- TotalCount
- Links
description: (default = null)
nullable: true
type: object
examples:
response:
value:
Data:
- Id: 00000000-0000-0000-0000-000000000000
Name: Vehicle 1
Code: "12345"
UnitId: "1234567890"
Type: 0
Counter:
Mileage: 48145
RunningHours: 774
DateTimeLocal: 2021-07-12T08:29:37
DateTimeUtc: 2021-07-12T06:29:37
Location:
Address: Dumolinlaan 9, 8500 Kortrijk, BE
Latitude: 50.812939
Longitude: 3.245304
DateTimeLocal: 2021-07-12T08:29:37
DateTimeUtc: 2021-07-12T06:29:37
DetectedBy:
- Id: 00000000-0000-0000-0000-000000000000
Name: Vehicle 1
PagingFilter:
Page: 1
Search: ABC
PageCount: 4
TotalCount: 100
Links:
Base: https://api.intellitracer.be
First: /api/v2/asset?page=1
Prev: /api/v2/asset?page=2
Next: /api/v2/asset?page=4
Last: /api/v2/asset?page=4
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Get last positions
operationId: Get last positions
description: >-
Returns a paged list of vehicles and assets including last position and
current mileage and running hours.
Pagination and searching is explained in [Pagination](#pagination).
*Privilege required: `Api: Location`*
x-resource: Last positions
tags:
- Location
parameters:
- name: page
in: path
description: ""
required: true
example: "1"
schema:
type: number
- name: limit
in: path
description: ""
required: true
example: "100"
schema:
type: number
- name: search
in: path
description: ""
required: true
example: ABC
schema:
type: string
security:
- pat: []
/api/v2/location/lastposition:
post:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/IntelliTracer.ApiV2.lastposition"
examples:
response:
value:
- Id: 00000000-0000-0000-0000-000000000000
Name: Vehicle 1
Code: "12345"
UnitId: "1234567890"
Type: 0
Counter:
Mileage: 48145
RunningHours: 774
DateTimeLocal: 2021-07-12T08:29:37
DateTimeUtc: 2021-07-12T06:29:37
Location:
Address: Dumolinlaan 9, 8500 Kortrijk, BE
Latitude: 50.812939
Longitude: 3.245304
DateTimeLocal: 2021-07-12T08:29:37
DateTimeUtc: 2021-07-12T06:29:37
DetectedBy:
- Id: 00000000-0000-0000-0000-000000000000
Name: Vehicle 1
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Get last positions by resources
operationId: Get last positions by resources
description: >-
Returns a list of vehicles and assets including last position and
current mileage and running hours.
*Privilege required: `Api: Location`*
x-resource: Last positions
tags:
- Location
requestBody:
content:
application/json:
schema:
type: array
items:
type: string
example:
- 00000000-0000-0000-0000-000000000000
- 00000000-0000-0000-0000-000000000000
security:
- pat: []
/api/v1/location/lastposition:
get:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Id:
type: string
MileageToday:
description: |-
(default = null)
Total mileage driven today.
nullable: true
type: number
MileageTotal:
description: |-
(default = null)
Total mileage driven ever.
nullable: true
type: number
Type:
x-enum-type: IntelliTracer.Domain.TrackingReportType
anyOf:
- type: number
enum:
- 1
- 21
- 23
- 24
- 100
- 101
- 200
- 201
- 202
- 203
- 204
- 205
- 206
- 207
- 208
- 209
- 210
- 211
- 212
- 213
- 214
- 215
- 250
- 251
- 252
- 253
- 254
- 255
- 256
- 257
- 300
- 301
- 400
- 401
- 500
- 501
- 1000
- 1001
- 1002
- 1003
- 1004
- 1005
- 1006
- 2000
- 2001
- 2002
- 2003
- 2004
- 2005
- 2006
- 2007
- 2008
- 2009
- 2010
- 2011
- 2012
- 2013
- 2014
- 2015
- 2016
- 2017
- 2018
- 2019
- 2020
- 2021
- 2022
- 2023
- 2024
- 2025
- 2026
- 2027
- 2028
- 2029
- 2030
- 2031
- 2032
- 2033
- 2034
- 2035
- 2036
- 2037
- 2038
- 2039
- 2040
- 2041
- 2042
- 2043
- 2044
- 2045
- 2046
- 2047
- 2048
- 2049
- 2050
- 2051
- 2052
- 2053
- 2054
- 2055
- 2056
- 2057
- 2058
- 2059
- 2060
- 2061
- 2062
- 2063
- 2064
- 2065
- 2066
- 2067
- 2068
- 2069
- 2070
- 2071
- 2072
- 2073
- 2074
- 2075
- 2076
- 2077
- 2078
- 2079
- 2080
- 2081
- 2082
- 2083
- 2084
- 2085
- 2086
- 2087
- 2088
- 2089
- 2090
- 2091
- 2092
- 2093
- 2094
- 2095
- 2096
- 2097
- 2098
- 2099
- 2100
- 3000
- 3001
- 4001
- 5000
- 5001
- 5003
- 5004
- 5005
- 5006
- 5007
- 5008
- 6000
- 6001
- 7000
- 7001
- 7002
- 7003
- 7004
- 7005
- 7006
- 7007
- 8000
- 8001
- 8002
- 8003
- 9000
- 10000
- 10001
- 10002
- 10003
- 10004
- 10005
- 10006
- 10007
- 11000
- 11001
- 11002
- 11003
- 11004
- 12000
- 12001
- 12002
- 12003
- 12004
- 12005
- 12006
- 12007
- 13000
- 13001
- 13500
- 13501
- 13502
- 13503
- 13504
- 13505
- 13506
- 13507
- 13508
- 13509
- 13510
- 13511
- 13512
- 13513
- 13514
- 13515
- 13516
- 13517
- 13518
- 13519
- 13520
- 13521
- 13522
- 13523
- 13524
- 13525
- 13526
- 13527
- 13528
- 13529
- 13530
- 13531
- 14000
- 14500
- 14501
- 14502
- 14503
- 15000
- 15002
- 17000
- 17001
- 17002
- 17003
- 17004
- 17005
- 17006
- 17007
- 17008
- 17009
- 17010
- 17011
- 17012
- 17013
- 17014
- 17015
- 17016
- 17017
- 17018
- 17019
- 17020
- 17021
- 17022
- 17023
- 17024
- 18000
- 18001
- 19000
- -9999
- -9000
- -3000
- -2000
- -1003
- -1002
- -1001
- -1000
- type: string
enum:
- "1"
description: |-
(default = -9999)
Type of this tracking report.
TypeName:
description: |-
(default = null)
Type name of this tracking report.
nullable: true
type: string
RtcDateTime:
type: string
description: Assumed datetime of the location.
GpsDateTime:
type: string
description: GPS datetime of the location.
Speed:
description: |-
(default = null)
Current measured speed.
nullable: true
type: number
AllowedSpeed:
description: |-
(default = null)
Allowed speed at this location.
nullable: true
type: number
Heading:
description: |-
(default = null)
Direction the car is driving in in degrees (0 = north).
nullable: true
type: number
Latitude:
description: >-
(default = null)
Geographic coordinate that specifies the north–south position of a point on the Earth's surface.
nullable: true
type: number
Longitude:
description: >-
(default = null)
Geographic coordinate that specifies the east–west position of a point on the Earth's surface.
nullable: true
type: number
Satellites:
type: number
description: >-
(default = 0)
Amount of satellites within range and used to determine the current location.
Pois:
description: |-
(default = [])
Point(s) of interest located at this position.
nullable: true
type: array
items: {}
IoStates:
description: |-
(default = [])
State of the vehicle's inputs and outputs.
nullable: true
type: array
items: {}
StatusInfo:
description: |-
(default = null)
Status of the vehicle.
nullable: true
type: string
Address:
properties:
CountryName:
description: (default = null)
nullable: true
type: string
AddressLine:
description: (default = null)
nullable: true
type: string
PoiList:
description: |-
(default = null)
List of point-of-interests, the unique id only.
nullable: true
type: array
items: {}
City:
description: (default = null)
nullable: true
type: string
CityLine:
description: |-
(default = null)
The postalnumber, city and country as a text line.
nullable: true
type: string
CountryCode:
type: number
x-enum-type: IntelliTracer.Domain.Country
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
- 47
- 48
- 49
- 50
- 51
- 52
- 53
- 54
- 55
- 56
- 57
- 58
- 59
- 60
- 61
- 62
- 63
- 64
- 65
- 66
- 67
- 68
- 69
- 70
- 71
- 72
- 73
- 74
- 75
- 76
- 77
- 78
- 79
- 80
- 81
- 82
- 83
- 84
- 85
- 86
- 87
- 88
- 89
- 90
- 91
- 92
- 93
- 94
- 95
- 96
- 97
- 98
- 99
- 100
- 101
- 102
- 103
- 104
- 105
- 106
- 107
- 108
- 109
- 110
- 111
- 112
- 113
- 114
- 115
- 116
- 117
- 118
- 119
- 120
- 121
- 122
- 123
- 124
- 125
- 126
- 127
- 128
- 129
- 130
- 131
- 132
- 133
- 134
- 135
- 136
- 137
- 138
- 139
- 140
- 141
- 142
- 143
- 144
- 145
- 146
- 147
- 148
- 149
- 150
- 151
- 152
- 153
- 9999
description: (default = 0)
HouseNumber:
description: (default = null)
nullable: true
type: string
Latitude:
description: >-
(default = null)
Geographic coordinate that specifies the north–south position of a point on the Earth's surface.
nullable: true
type: number
Longitude:
description: >-
(default = null)
Geographic coordinate that specifies the east–west position of a point on the Earth's surface.
nullable: true
type: number
PostalCode:
nullable: true
type: string
ShortAddressLine:
description: (default = null)
nullable: true
type: string
Street:
description: (default = null)
nullable: true
type: string
StreetLine:
description: (default = null)
nullable: true
type: string
Submunicipality:
description: (default = null)
nullable: true
type: string
_typeDescriptor:
type: string
description: |-
(default = null)
Address of the current location.
nullable: true
type: object
BadgeNr:
description: |-
(default = null)
Number of the badge that was used
nullable: true
type: string
BadgeUser:
properties:
Id:
type: string
Name:
type: string
Code:
description: (default = null)
nullable: true
type: string
EmployerCode:
description: (default = null)
nullable: true
type: string
Email:
description: (default = null)
nullable: true
type: string
Gsm:
description: (default = null)
nullable: true
type: string
FreeField1:
description: (default = null)
nullable: true
type: string
FreeField2:
description: (default = null)
nullable: true
type: string
FreeField3:
description: (default = null)
nullable: true
type: string
FreeField4:
description: (default = null)
nullable: true
type: string
FreeField5:
description: (default = null)
nullable: true
type: string
FreeField6:
description: "(default = null) "
nullable: true
type: string
Notes:
description: (default = null)
nullable: true
type: string
Street:
description: (default = null)
nullable: true
type: string
HouseNumber:
description: (default = null)
nullable: true
type: string
City:
description: (default = null)
nullable: true
type: string
PostalCode:
description: (default = null)
nullable: true
type: string
Submunicipality:
description: (default = null)
nullable: true
type: string
Country:
type: number
x-enum-type: IntelliTracer.Domain.Country
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
- 47
- 48
- 49
- 50
- 51
- 52
- 53
- 54
- 55
- 56
- 57
- 58
- 59
- 60
- 61
- 62
- 63
- 64
- 65
- 66
- 67
- 68
- 69
- 70
- 71
- 72
- 73
- 74
- 75
- 76
- 77
- 78
- 79
- 80
- 81
- 82
- 83
- 84
- 85
- 86
- 87
- 88
- 89
- 90
- 91
- 92
- 93
- 94
- 95
- 96
- 97
- 98
- 99
- 100
- 101
- 102
- 103
- 104
- 105
- 106
- 107
- 108
- 109
- 110
- 111
- 112
- 113
- 114
- 115
- 116
- 117
- 118
- 119
- 120
- 121
- 122
- 123
- 124
- 125
- 126
- 127
- 128
- 129
- 130
- 131
- 132
- 133
- 134
- 135
- 136
- 137
- 138
- 139
- 140
- 141
- 142
- 143
- 144
- 145
- 146
- 147
- 148
- 149
- 150
- 151
- 152
- 153
- 9999
description: (default = 0)
Longitude:
description: >-
(default = null)
Geographic coordinate that specifies the east–west position of a point on the Earth's surface.
nullable: true
type: number
Latitude:
description: >-
(default = null)
Geographic coordinate that specifies the north–south position of a point on the Earth's surface.
nullable: true
type: number
DefaultDayProgram:
properties:
Id:
type: string
Name:
type: string
_typeDescriptor:
type: string
required:
- Id
- Name
description: (default = null)
nullable: true
type: object
Groups:
description: (default = null)
nullable: true
type: array
items: {}
_typeDescriptor:
type: string
required:
- Id
- Name
description: |-
(default = null)
Name of the user who badged.
nullable: true
type: object
ResourceId:
type: string
description: ID of the resource currently at this location.
_typeDescriptor:
type: string
required:
- Id
- RtcDateTime
- GpsDateTime
- ResourceId
examples:
response:
value:
Id: 00000000-0000-0000-0000-000000000000
MileageToday: 1.02
MileageTotal: 11245.02
Type: "1"
TypeName: Position
RtcDateTime: 2019-01-09T11:16:51+01:00
GpsDateTime: 2019-01-09T11:16:51+01:00
Speed: 50
AllowedSpeed: 50
Heading: 189
Latitude: 50.812939
Longitude: 3.245304
Satellites: 9
Pois:
- 00000000-0000-0000-0000-000000000000
- 00000000-0000-0000-0000-000000000000
IoStates:
- ContactName: Contact
StateName: Off
IoNameType: "8"
VehicleIoType: "200"
StatusInfo: Contact off
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
BadgeNr: 00AA11BB
BadgeUser:
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"
ResourceId: 00000000-0000-0000-0000-000000000000
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Get last position by resource
operationId: Get last position by resource
description: |-
Returns the last position of a resource.
*Privilege required: `Api: Location`*
x-resource: Last positions
tags:
- Location
parameters:
- name: resourceId
in: query
description: ""
required: true
example: 00000000-0000-0000-0000-000000000000
schema:
type: string
security:
- pat: []
/api/v1/location/lastpositionbytypes:
post:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/IntelliTracer.ApiV1.Location"
examples:
response:
value:
- Id: 00000000-0000-0000-0000-000000000000
MileageToday: 1.02
MileageTotal: 11245.02
Type: "1"
TypeName: Position
RtcDateTime: 2019-01-09T11:16:51+01:00
GpsDateTime: 2019-01-09T11:16:51+01:00
Speed: 50
AllowedSpeed: 50
Heading: 189
Latitude: 50.812939
Longitude: 3.245304
Satellites: 9
Pois:
- 00000000-0000-0000-0000-000000000000
- 00000000-0000-0000-0000-000000000000
IoStates:
- ContactName: Contact
StateName: Off
IoNameType: "8"
VehicleIoType: "200"
StatusInfo: Contact off
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
BadgeNr: 00AA11BB
BadgeUser:
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"
ResourceId: 00000000-0000-0000-0000-000000000000
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Get last position by types
operationId: Get last position by types
description: >-
Returns the last position of all resources for one or more resource
type(s).
*Privilege required: `Api: Location`*
x-resource: Last positions
tags:
- Location
requestBody:
content:
application/json:
schema:
type: array
items:
type: number
x-enum-type: IntelliTracer.ApiV1.ResourceType
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
example:
- 0
- 1
security:
- pat: []
/api/v1/location/lastpositionbyresources:
post:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/IntelliTracer.ApiV1.Location"
examples:
response:
value:
- Id: 00000000-0000-0000-0000-000000000000
MileageToday: 1.02
MileageTotal: 11245.02
Type: "1"
TypeName: Position
RtcDateTime: 2019-01-09T11:16:51+01:00
GpsDateTime: 2019-01-09T11:16:51+01:00
Speed: 50
AllowedSpeed: 50
Heading: 189
Latitude: 50.812939
Longitude: 3.245304
Satellites: 9
Pois:
- 00000000-0000-0000-0000-000000000000
- 00000000-0000-0000-0000-000000000000
IoStates:
- ContactName: Contact
StateName: Off
IoNameType: "8"
VehicleIoType: "200"
StatusInfo: Contact off
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
BadgeNr: 00AA11BB
BadgeUser:
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"
ResourceId: 00000000-0000-0000-0000-000000000000
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Get last position by resources
operationId: Get last position by resources
description: |-
Returns the last position of one or more resources.
*Privilege required: `Api: Location`*
x-resource: Last positions
tags:
- Location
requestBody:
content:
application/json:
schema:
type: array
items:
type: string
example:
- 00000000-0000-0000-0000-000000000000
- 00000000-0000-0000-0000-000000000000
security:
- pat: []
/api/v1/location/position:
get:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/IntelliTracer.ApiV1.Location"
examples:
response:
value:
- Id: 00000000-0000-0000-0000-000000000000
MileageToday: 1.02
MileageTotal: 11245.02
Type: "1"
TypeName: Position
RtcDateTime: 2019-01-09T11:16:51+01:00
GpsDateTime: 2019-01-09T11:16:51+01:00
Speed: 50
AllowedSpeed: 50
Heading: 189
Latitude: 50.812939
Longitude: 3.245304
Satellites: 9
Pois:
- 00000000-0000-0000-0000-000000000000
- 00000000-0000-0000-0000-000000000000
IoStates:
- ContactName: Contact
StateName: Off
IoNameType: "8"
VehicleIoType: "200"
StatusInfo: Contact off
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
BadgeNr: 00AA11BB
BadgeUser:
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"
ResourceId: 00000000-0000-0000-0000-000000000000
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Get positions by resource
operationId: Get positions by resource
description: |-
Returns a list of all positions of a resource within a date/time range.
*Privilege required: `Api: Location`*
x-resource: Positions by resource
tags:
- Location
parameters:
- name: resourceId
in: query
description: ""
required: true
example: 00000000-0000-0000-0000-000000000000
schema:
type: string
- name: from
in: query
description: ""
required: true
example: 2019-01-25T08:00:00
schema:
type: string
- name: to
in: query
description: ""
required: true
example: 2019-01-25T17:00:00
schema:
type: string
security:
- pat: []
post:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/IntelliTracer.ApiV1.ResourceLocations"
examples:
response:
value:
- ResourceId: 00000000-0000-0000-0000-000000000000
Positions:
- Id: 00000000-0000-0000-0000-000000000000
MileageToday: 1.02
MileageTotal: 11245.02
Type: "1"
TypeName: Position
RtcDateTime: 2019-01-09T11:16:51+01:00
GpsDateTime: 2019-01-09T11:16:51+01:00
Speed: 50
AllowedSpeed: 50
Heading: 189
Latitude: 50.812939
Longitude: 3.245304
Satellites: 9
Pois:
- 00000000-0000-0000-0000-000000000000
- 00000000-0000-0000-0000-000000000000
IoStates:
- ContactName: Contact
StateName: Off
IoNameType: "8"
VehicleIoType: "200"
StatusInfo: Contact off
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
BadgeNr: 00AA11BB
BadgeUser:
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"
ResourceId: 00000000-0000-0000-0000-000000000000
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Get positions by resources
operationId: Get positions by resources
description: >-
Returns a list of all positions of one or more resources within a
date/time range.
*Privilege required: `Api: Location`*
x-resource: Positions by resource
tags:
- Location
parameters:
- name: from
in: query
description: ""
required: true
example: 2019-01-25T08:00:00
schema:
type: string
- name: to
in: query
description: ""
required: true
example: 2019-01-25T17:00:00
schema:
type: string
requestBody:
content:
application/json:
schema:
type: array
items:
type: string
example:
- 00000000-0000-0000-0000-000000000000
- 00000000-0000-0000-0000-000000000000
security:
- pat: []
/api/v1/location/status:
get:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
ResourceId:
type: string
StatusResults:
description: |-
(default = [])
Time registration bars for this vehicle.
nullable: true
type: array
items: {}
_typeDescriptor:
type: string
required:
- ResourceId
examples:
response:
value:
ResourceId: 00000000-0000-0000-0000-000000000000
StatusResults:
- ResourceId: 00000000-0000-0000-0000-000000000000
ResourceName: Vehicle 1
FromDate: 2019-01-25T08:00:00+01:00
ToDate: 2019-01-25T17:00:00+01:00
Bars:
- StateName: Driving
Start: 2019-01-25T08:00:00+01:00
Stop: 2019-01-25T08:51:22+01:00
Duration: 00:51:22
MileageBirdFlight: 108.23
MileageDriven: 111.85
DriverId: 00000000-0000-0000-0000-000000000000
DriverName: John Doe
StartLocation:
Id: 00000000-0000-0000-0000-000000000000
MileageToday: 1.02
MileageTotal: 11245.02
Type: "1"
TypeName: Position
RtcDateTime: 2019-01-09T11:16:51+01:00
GpsDateTime: 2019-01-09T11:16:51+01:00
Speed: 50
AllowedSpeed: 50
Heading: 189
Latitude: 50.812939
Longitude: 3.245304
Satellites: 9
Pois:
- 00000000-0000-0000-0000-000000000000
- 00000000-0000-0000-0000-000000000000
IoStates:
- ContactName: Contact
StateName: Off
IoNameType: "8"
VehicleIoType: "200"
StatusInfo: Contact off
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
BadgeNr: 00AA11BB
BadgeUser:
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"
ResourceId: 00000000-0000-0000-0000-000000000000
StopLocation:
Id: 00000000-0000-0000-0000-000000000000
MileageToday: 1.02
MileageTotal: 11245.02
Type: "1"
TypeName: Position
RtcDateTime: 2019-01-09T11:16:51+01:00
GpsDateTime: 2019-01-09T11:16:51+01:00
Speed: 50
AllowedSpeed: 50
Heading: 189
Latitude: 50.812939
Longitude: 3.245304
Satellites: 9
Pois:
- 00000000-0000-0000-0000-000000000000
- 00000000-0000-0000-0000-000000000000
IoStates:
- ContactName: Contact
StateName: Off
IoNameType: "8"
VehicleIoType: "200"
StatusInfo: Contact off
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
BadgeNr: 00AA11BB
BadgeUser:
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"
ResourceId: 00000000-0000-0000-0000-000000000000
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Get statuses by resource
operationId: Get statuses by resource
description: >-
Returns a list of all status bars of a resource within a date/time
range.
*Privilege required: `Api: Location`*
x-resource: Statuses by resource
tags:
- Location
parameters:
- name: resourceId
in: query
description: ""
required: true
example: 00000000-0000-0000-0000-000000000000
schema:
type: string
- name: from
in: query
description: ""
required: true
example: 2019-01-25T08:00:00
schema:
type: string
- name: to
in: query
description: ""
required: true
example: 2019-01-25T17:00:00
schema:
type: string
- name: friendlyName
in: query
description: ""
required: false
schema:
type: string
security:
- pat: []
post:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/IntelliTracer.ApiV1.ResourceLocationStatuses"
examples:
response:
value:
- ResourceId: 00000000-0000-0000-0000-000000000000
StatusResults:
- ResourceId: 00000000-0000-0000-0000-000000000000
ResourceName: Vehicle 1
FromDate: 2019-01-25T08:00:00+01:00
ToDate: 2019-01-25T17:00:00+01:00
Bars:
- StateName: Driving
Start: 2019-01-25T08:00:00+01:00
Stop: 2019-01-25T08:51:22+01:00
Duration: 00:51:22
MileageBirdFlight: 108.23
MileageDriven: 111.85
DriverId: 00000000-0000-0000-0000-000000000000
DriverName: John Doe
StartLocation:
Id: 00000000-0000-0000-0000-000000000000
MileageToday: 1.02
MileageTotal: 11245.02
Type: "1"
TypeName: Position
RtcDateTime: 2019-01-09T11:16:51+01:00
GpsDateTime: 2019-01-09T11:16:51+01:00
Speed: 50
AllowedSpeed: 50
Heading: 189
Latitude: 50.812939
Longitude: 3.245304
Satellites: 9
Pois:
- 00000000-0000-0000-0000-000000000000
- 00000000-0000-0000-0000-000000000000
IoStates:
- ContactName: Contact
StateName: Off
IoNameType: "8"
VehicleIoType: "200"
StatusInfo: Contact off
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
BadgeNr: 00AA11BB
BadgeUser:
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"
ResourceId: 00000000-0000-0000-0000-000000000000
StopLocation:
Id: 00000000-0000-0000-0000-000000000000
MileageToday: 1.02
MileageTotal: 11245.02
Type: "1"
TypeName: Position
RtcDateTime: 2019-01-09T11:16:51+01:00
GpsDateTime: 2019-01-09T11:16:51+01:00
Speed: 50
AllowedSpeed: 50
Heading: 189
Latitude: 50.812939
Longitude: 3.245304
Satellites: 9
Pois:
- 00000000-0000-0000-0000-000000000000
- 00000000-0000-0000-0000-000000000000
IoStates:
- ContactName: Contact
StateName: Off
IoNameType: "8"
VehicleIoType: "200"
StatusInfo: Contact off
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
BadgeNr: 00AA11BB
BadgeUser:
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"
ResourceId: 00000000-0000-0000-0000-000000000000
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Get statuses by resources
operationId: Get statuses by resources
description: >-
Returns a list of all status bars of one or more resources within a
date/time range.
*Privilege required: `Api: Location`*
x-resource: Statuses by resource
tags:
- Location
parameters:
- name: from
in: query
description: ""
required: true
example: 2019-01-25T08:00:00
schema:
type: string
- name: to
in: query
description: ""
required: true
example: 2019-01-25T17:00:00
schema:
type: string
- name: friendlyName
in: query
description: ""
required: false
schema:
type: string
requestBody:
content:
application/json:
schema:
type: array
items:
type: string
example:
- 00000000-0000-0000-0000-000000000000
- 00000000-0000-0000-0000-000000000000
security:
- pat: []
/api/v1/clocking_getbydaterange:
get:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/IntelliTracer.ApiV1.Clocking"
examples:
response:
value:
- Id: 00000000-0000-0000-0000-000000000000
DateTimeUtc: 2019-01-25T07:29:37
DateTimeLocal: 2019-01-25T08:29:37
User:
Id: 00000000-0000-0000-0000-000000000000
Code: "012345"
EmployerCode: "012345"
Name: John Doe
Badge:
Id: 00000000-0000-0000-0000-000000000000
InternalNumber: 00AA11BB
ExternalNumber: "12345678"
DayProgramId: 00000000-0000-0000-0000-000000000000
Vehicle:
Id: 00000000-0000-0000-0000-000000000000
Code: "012345"
Name: Vehicle 1
VehicleTypeId: 00000000-0000-0000-0000-000000000000
LastSyncDateUtc: 2019-01-25T07:29:37
LastPosition:
AnalogExportList:
- Number: 0
Name: null
StatusName: null
AnalogInputType: 0
InputExportList:
- Number: 0
Name: null
Status: null
StatusName: null
IsPrivate: false
BadgeUser: John Doe
BadgeNr: 00AA11BB
TypeText: Position
Type: "1"
VehicleId: 00000000-0000-0000-0000-000000000000
InputAcc: false
Heading: 10
Speed: 50
Altitude: 0
Latitude: 50.812939
Longitude: 3.245304
AddressExport:
Street: Dumolinlaan
HouseNumber: "9"
PostalCode: "8500"
City: Kortrijk
Submunicipality: Kortrijk
Country: 0
ReportDateLocal: 2019-01-25T08:29:37
ReportDateUtc: 2019-01-25T07:29:37
GpsDateUtc: 2019-01-25T07:29:37
OutputExportList:
- Number: 0
Name: null
Status: null
StatusName: null
Pois:
- 00000000-0000-0000-0000-000000000000
- 00000000-0000-0000-0000-000000000000
Type: 0
Location:
Address:
Street: Dumolinlaan
HouseNumber: "9"
PostalCode: "8500"
City: Kortrijk
Submunicipality: Kortrijk
Country: 0
Longitude: 3.245304
Latitude: 50.812939
Pois:
- 00000000-0000-0000-0000-000000000000
- 00000000-0000-0000-0000-000000000000
IsManual: false
Description: null
AbsenceCode: null
JobNumber: 1575-7577-4
Note: clocking note
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Get clockings
operationId: Get clockings
description: |-
Returns a list of all clockings within a date/time range.
*Privilege required: `Api: Timesheet read`*
x-resource: Clockings
tags:
- Clocking
parameters:
- name: fromDate
in: query
description: ""
required: true
example: 2019-01-25T08:00:00
schema:
type: string
- name: toDate
in: query
description: ""
required: true
example: 2019-01-25T17:00:00
schema:
type: string
- name: includeClockingsWithoutUser
in: query
description: ""
required: false
example: "false"
schema:
type: boolean
security:
- pat: []
/api/v2/clocking:
put:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Data:
properties:
Id:
type: string
DateTimeUtc:
type: string
DateTimeLocal:
type: string
ClockingType:
type: number
x-enum-type: IntelliTracer.ApiV2.ClockingType
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
description: (default = 0)
Description:
description: (default = null)
nullable: true
type: string
JobNumber:
description: (default = null)
nullable: true
type: string
ExternalType:
x-enum-type: IntelliTracer.ApiV2.ExternalClockingType
enum:
- 0
- 1
- 2
- null
description: (default = 0)
nullable: true
type: number
ExternalCode:
description: (default = null)
nullable: true
type: string
IsManual:
type: boolean
description: (default = false)
User:
properties:
Id:
type: string
Code:
description: (default = null)
nullable: true
type: string
Name:
type: string
Type:
type: number
x-enum-type: IntelliTracer.Domain.ResourceType
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
description: (default = 0)
required:
- Id
- Name
description: (default = null)
nullable: true
type: object
Vehicle:
properties:
Id:
type: string
Code:
description: (default = null)
nullable: true
type: string
Name:
type: string
Type:
type: number
x-enum-type: IntelliTracer.Domain.ResourceType
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
description: (default = 0)
required:
- Id
- Name
description: (default = null)
nullable: true
type: object
Location:
properties:
Address:
properties:
CountryName:
description: (default = null)
nullable: true
type: string
AddressLine:
description: (default = null)
nullable: true
type: string
PoiList:
description: >-
(default = null)
List of point-of-interests, the unique id only.
nullable: true
type: array
items: {}
City:
description: (default = null)
nullable: true
type: string
CityLine:
description: >-
(default = null)
The postalnumber, city and country as a text line.
nullable: true
type: string
CountryCode:
type: number
x-enum-type: IntelliTracer.Domain.Country
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
- 47
- 48
- 49
- 50
- 51
- 52
- 53
- 54
- 55
- 56
- 57
- 58
- 59
- 60
- 61
- 62
- 63
- 64
- 65
- 66
- 67
- 68
- 69
- 70
- 71
- 72
- 73
- 74
- 75
- 76
- 77
- 78
- 79
- 80
- 81
- 82
- 83
- 84
- 85
- 86
- 87
- 88
- 89
- 90
- 91
- 92
- 93
- 94
- 95
- 96
- 97
- 98
- 99
- 100
- 101
- 102
- 103
- 104
- 105
- 106
- 107
- 108
- 109
- 110
- 111
- 112
- 113
- 114
- 115
- 116
- 117
- 118
- 119
- 120
- 121
- 122
- 123
- 124
- 125
- 126
- 127
- 128
- 129
- 130
- 131
- 132
- 133
- 134
- 135
- 136
- 137
- 138
- 139
- 140
- 141
- 142
- 143
- 144
- 145
- 146
- 147
- 148
- 149
- 150
- 151
- 152
- 153
- 9999
description: (default = 0)
HouseNumber:
description: (default = null)
nullable: true
type: string
Latitude:
description: >-
(default = null)
Geographic coordinate that specifies the north–south position of a point on the Earth's surface.
nullable: true
type: number
Longitude:
description: >-
(default = null)
Geographic coordinate that specifies the east–west position of a point on the Earth's surface.
nullable: true
type: number
PostalCode:
nullable: true
type: string
ShortAddressLine:
description: (default = null)
nullable: true
type: string
Street:
description: (default = null)
nullable: true
type: string
StreetLine:
description: (default = null)
nullable: true
type: string
Submunicipality:
description: (default = null)
nullable: true
type: string
_typeDescriptor:
type: string
description: (default = null)
nullable: true
type: object
Pois:
type: array
description: (default = [])
items: {}
Latitude:
description: >-
(default = null)
Geographic coordinate that specifies the north–south position of a point on the Earth's surface.
nullable: true
type: number
Longitude:
description: (default = null)
nullable: true
type: number
description: (default = null)
nullable: true
type: object
AbsenceType:
properties:
Name:
description: (default = null)
nullable: true
type: string
AbsenceCode:
description: (default = null)
nullable: true
type: string
Paid:
type: boolean
description: (default = false)
TemporaryUnemployment:
type: boolean
description: (default = false)
Color:
description: (default = null)
nullable: true
type: string
IncludeInExport:
type: boolean
description: >-
(default = true)
Determines whether absences of this type will be included in exports to social secretaries created through specific Excel exports generated via our website.
required:
- Name
- AbsenceCode
description: (default = null)
nullable: true
type: object
required:
- Id
- DateTimeUtc
- DateTimeLocal
description: (default = null)
nullable: true
type: object
examples:
response:
value:
Data:
Id: 00000000-0000-0000-0000-000000000000
DateTimeUtc: 2021-11-25T07:00:00
DateTimeLocal: 2021-11-25T08:00:00
ClockingType: 0
Description: null
JobNumber: 1575-7577-4
ExternalType: 0
ExternalCode: null
IsManual: false
User:
Id: 00000000-0000-0000-0000-000000000000
Code: "012345"
Name: John Doe
Type: 0
Vehicle:
Id: 00000000-0000-0000-0000-000000000000
Code: "012345"
Name: John Doe
Type: 0
Location:
Address:
CountryName: Belgium
AddressLine: Dumolinlaan 9, 8500 Kortrijk, BE
PoiList:
- 00000000-0000-0000-0000-000000000000
- 00000000-0000-0000-0000-000000000000
City: Kortrijk
CityLine: 8500 Kortrijk, BE
CountryCode: 0
HouseNumber: "9"
Latitude: 50.812939
Longitude: 3.245304
PostalCode: "8500"
ShortAddressLine: Dumolinlaan 9, Kortrijk, BE
Street: Dumolinlaan
StreetLine: Dumolinlaan 9
Submunicipality: Kortrijk
Pois:
- Id: 00000000-0000-0000-0000-000000000000
Name: Work
Code: "012345"
Latitude: 50.812939
Longitude: 3.245304
AbsenceType:
Name: Sickness
AbsenceCode: "100"
Paid: false
TemporaryUnemployment: false
Color: "#000000"
IncludeInExport: true
"400":
description: BadRequest
headers: {}
content:
application/json:
schema:
type: object
properties:
Entity:
type: object
properties:
Id:
type: string
DateTimeUtc:
type: string
DateTimeLocal:
type: string
ClockingType:
type: number
x-enum-type: IntelliTracer.ApiV2.ClockingType
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
description: (default = 0)
Description:
description: (default = null)
nullable: true
type: string
JobNumber:
description: (default = null)
nullable: true
type: string
ExternalType:
x-enum-type: IntelliTracer.ApiV2.ExternalClockingType
enum:
- 0
- 1
- 2
- null
description: (default = 0)
nullable: true
type: number
ExternalCode:
description: (default = null)
nullable: true
type: string
IsManual:
type: boolean
description: (default = false)
User:
properties:
Id:
type: string
Code:
description: (default = null)
nullable: true
type: string
Name:
type: string
Type:
type: number
x-enum-type: IntelliTracer.Domain.ResourceType
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
description: (default = 0)
required:
- Id
- Name
description: (default = null)
nullable: true
type: object
Vehicle:
properties:
Id:
type: string
Code:
description: (default = null)
nullable: true
type: string
Name:
type: string
Type:
type: number
x-enum-type: IntelliTracer.Domain.ResourceType
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
description: (default = 0)
required:
- Id
- Name
description: (default = null)
nullable: true
type: object
Location:
properties:
Address:
properties:
CountryName:
description: (default = null)
nullable: true
type: string
AddressLine:
description: (default = null)
nullable: true
type: string
PoiList:
description: >-
(default = null)
List of point-of-interests, the unique id only.
nullable: true
type: array
items: {}
City:
description: (default = null)
nullable: true
type: string
CityLine:
description: >-
(default = null)
The postalnumber, city and country as a text line.
nullable: true
type: string
CountryCode:
type: number
x-enum-type: IntelliTracer.Domain.Country
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
- 47
- 48
- 49
- 50
- 51
- 52
- 53
- 54
- 55
- 56
- 57
- 58
- 59
- 60
- 61
- 62
- 63
- 64
- 65
- 66
- 67
- 68
- 69
- 70
- 71
- 72
- 73
- 74
- 75
- 76
- 77
- 78
- 79
- 80
- 81
- 82
- 83
- 84
- 85
- 86
- 87
- 88
- 89
- 90
- 91
- 92
- 93
- 94
- 95
- 96
- 97
- 98
- 99
- 100
- 101
- 102
- 103
- 104
- 105
- 106
- 107
- 108
- 109
- 110
- 111
- 112
- 113
- 114
- 115
- 116
- 117
- 118
- 119
- 120
- 121
- 122
- 123
- 124
- 125
- 126
- 127
- 128
- 129
- 130
- 131
- 132
- 133
- 134
- 135
- 136
- 137
- 138
- 139
- 140
- 141
- 142
- 143
- 144
- 145
- 146
- 147
- 148
- 149
- 150
- 151
- 152
- 153
- 9999
description: (default = 0)
HouseNumber:
description: (default = null)
nullable: true
type: string
Latitude:
description: >-
(default = null)
Geographic coordinate that specifies the north–south position of a point on the Earth's surface.
nullable: true
type: number
Longitude:
description: >-
(default = null)
Geographic coordinate that specifies the east–west position of a point on the Earth's surface.
nullable: true
type: number
PostalCode:
nullable: true
type: string
ShortAddressLine:
description: (default = null)
nullable: true
type: string
Street:
description: (default = null)
nullable: true
type: string
StreetLine:
description: (default = null)
nullable: true
type: string
Submunicipality:
description: (default = null)
nullable: true
type: string
_typeDescriptor:
type: string
description: (default = null)
nullable: true
type: object
Pois:
type: array
description: (default = [])
items: {}
Latitude:
description: >-
(default = null)
Geographic coordinate that specifies the north–south position of a point on the Earth's surface.
nullable: true
type: number
Longitude:
description: (default = null)
nullable: true
type: number
description: (default = null)
nullable: true
type: object
AbsenceType:
properties:
Name:
description: (default = null)
nullable: true
type: string
AbsenceCode:
description: (default = null)
nullable: true
type: string
Paid:
type: boolean
description: (default = false)
TemporaryUnemployment:
type: boolean
description: (default = false)
Color:
description: (default = null)
nullable: true
type: string
IncludeInExport:
type: boolean
description: >-
(default = true)
Determines whether absences of this type will be included in exports to social secretaries created through specific Excel exports generated via our website.
required:
- Name
- AbsenceCode
description: (default = null)
nullable: true
type: object
required:
- Id
- DateTimeUtc
- DateTimeLocal
ValidationResult:
type: array
items: {}
required:
- Entity
- ValidationResult
examples:
response:
value:
Entity:
Id: 00000000-0000-0000-0000-000000000000
DateTimeUtc: 2021-11-25T07:00:00
DateTimeLocal: 2021-11-25T08:00:00
ClockingType: 0
Description: null
JobNumber: 1575-7577-4
ExternalType: 0
ExternalCode: null
IsManual: false
User:
Id: 00000000-0000-0000-0000-000000000000
Code: "012345"
Name: John Doe
Type: 0
Vehicle:
Id: 00000000-0000-0000-0000-000000000000
Code: "012345"
Name: John Doe
Type: 0
Location:
Address:
CountryName: Belgium
AddressLine: Dumolinlaan 9, 8500 Kortrijk, BE
PoiList:
- 00000000-0000-0000-0000-000000000000
- 00000000-0000-0000-0000-000000000000
City: Kortrijk
CityLine: 8500 Kortrijk, BE
CountryCode: 0
HouseNumber: "9"
Latitude: 50.812939
Longitude: 3.245304
PostalCode: "8500"
ShortAddressLine: Dumolinlaan 9, Kortrijk, BE
Street: Dumolinlaan
StreetLine: Dumolinlaan 9
Submunicipality: Kortrijk
Pois:
- Id: 00000000-0000-0000-0000-000000000000
Name: Work
Code: "012345"
Latitude: 50.812939
Longitude: 3.245304
AbsenceType:
Name: Sickness
AbsenceCode: "100"
Paid: false
TemporaryUnemployment: false
Color: "#000000"
IncludeInExport: true
ValidationResult:
- Message: ""
SourceMemberNames: []
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Create clocking
operationId: Create clocking
description: >-
Creates a new clocking.
The allowed clocking types are: Start work, Start activity, Start external & Stop external.
*Privilege required: `Api: Timesheet management`*
x-resource: Clockings
tags:
- Clocking
requestBody:
content:
application/json:
schema:
type: object
properties:
ClockingType:
x-enum-type: IntelliTracer.ApiV2.ClockingTypeEdit
anyOf:
- type: number
enum:
- 1
- 3
- 17
- 18
- type: string
enum:
- "1"
description: (default = 1)
Description:
description: (default = null)
nullable: true
type: string
JobNumber:
description: (default = null)
nullable: true
type: string
ExternalType:
x-enum-type: IntelliTracer.ApiV2.ExternalClockingType
enum:
- 0
- 1
- 2
- null
description: (default = 0)
nullable: true
type: number
ExternalCode:
description: (default = null)
nullable: true
type: string
DateTimeUtc:
description: (default = null)
nullable: true
type: string
UserCode:
type: string
VehicleCode:
nullable: true
type: string
required:
- ClockingType
- UserCode
example:
ClockingType: "1"
Description: null
JobNumber: 1575-7577-4
ExternalType: 0
ExternalCode: null
DateTimeUtc: 2021-11-25T07:00:00
UserCode: ""
VehicleCode: null
security:
- pat: []
/api/v3/clocking:
put:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Data:
properties:
Id:
type: string
DateTimeUtc:
type: string
DateTimeLocal:
type: string
ClockingType:
type: string
x-enum-type: IntelliTracer.Domain.ClockingTypeString
enum:
- default
- work.start
- work.stop
- activity.start
- activity.stop
- activity.stop.break
- activity.switch
- activity.finish
- break.start
- break.stop
- absence.start
- absence.stop
- movement.start.driver
- movement.start.passenger
- movement.stop
- external.start
- external.stop
- travel.start
- travel.stop
IsManual:
type: boolean
User:
type: object
properties:
Id:
type: string
Code:
description: (default = null)
nullable: true
type: string
Name:
type: string
Type:
type: string
x-enum-type: IntelliTracer.Domain.ResourceTypeString
enum:
- user
- vehicle
- timeclock
- asset
- ivrphonenumber
- costcenter
- workplace
- mobileclocking
description: (default = 0)
required:
- Id
- Name
Vehicle:
properties:
Id:
type: string
Code:
description: (default = null)
nullable: true
type: string
Name:
type: string
Type:
type: string
x-enum-type: IntelliTracer.Domain.ResourceTypeString
enum:
- user
- vehicle
- timeclock
- asset
- ivrphonenumber
- costcenter
- workplace
- mobileclocking
description: (default = 0)
required:
- Id
- Name
description: (default = null)
nullable: true
type: object
Location:
properties:
Address:
properties:
Street:
description: (default = null)
nullable: true
type: string
HouseNumber:
description: (default = null)
nullable: true
type: string
City:
description: (default = null)
nullable: true
type: string
Submunicipality:
description: (default = null)
nullable: true
type: string
PostalCode:
description: (default = null)
nullable: true
type: string
Country:
type: string
x-enum-type: IntelliTracer.Domain.CountryString
enum:
- belgium
- france
- netherlands
- luxembourg
- italy
- norway
- denmark
- sweden
- sanmarino
- andorra
- germany
- unitedkingdom
- spain
- portugal
- switzerland
- austria
- hungary
- czechia
- greece
- poland
- slovakia
- turkey
- albania
- bulgaria
- bosniaherzegovina
- belarus
- moldova
- macedonia
- montenegro
- romania
- serbia
- ukraine
- finland
- ireland
- malta
- estland
- croatia
- lithuania
- latvia
- slovenia
- armenia
- azerbaijan
- cyprus
- faroeislands
- georgia
- gibraltar
- iceland
- monaco
- russia
- vatican
- kosovo
- unitedarabemirates
- afghanistan
- argentina
- australia
- bangladesh
- bahrain
- brunei
- bolivia
- brazil
- bhutan
- botswana
- belize
- canada
- congo
- cotedivoire
- chile
- cameroon
- china
- colombia
- costarica
- cuba
- dominicanrepublic
- algeria
- ecuador
- egypt
- eritrea
- ethiopia
- greenland
- guatemala
- honduras
- haiti
- indonesia
- israel
- india
- iraq
- iran
- jamaica
- jordan
- japan
- kenya
- kyrgyzstan
- cambodia
- korea
- kuwait
- kazakhstan
- laos
- lebanon
- liechtenstein
- srilanka
- libya
- morocco
- mali
- myanmar
- mongolia
- macaosar
- maldives
- mexico
- malaysia
- nigeria
- nicaragua
- nepal
- newzealand
- oman
- panama
- peru
- philippines
- pakistan
- puertorico
- paraguay
- qatar
- reunion
- rwanda
- saudiarabia
- singapore
- senegal
- somalia
- elsalvador
- syria
- thailand
- tajikistan
- turkmenistan
- tunisia
- trinidadandtobago
- taiwan
- unitedstates
- uruguay
- uzbekistan
- venezuela
- vietnam
- yemen
- southafrica
- zimbabwe
- guineabissau
- angola
- caboverde
- saotomeandprincipe
- mozambique
- guinea
- mauritania
- unknown
description: (default = 0)
Latitude:
description: (default = null)
nullable: true
type: number
Longitude:
description: (default = null)
nullable: true
type: number
description: (default = null)
nullable: true
type: object
Pois:
description: (default = null)
nullable: true
type: array
items: {}
Longitude:
description: (default = null)
nullable: true
type: number
Latitude:
description: (default = null)
nullable: true
type: number
description: (default = null)
nullable: true
type: object
AbsenceType:
properties:
Id:
type: string
Name:
type: string
Code:
type: string
Paid:
type: boolean
TemporaryUnemployed:
type: boolean
Color:
type: string
IncludeInExport:
type: boolean
required:
- Id
- Name
- Code
- Paid
- TemporaryUnemployed
- Color
- IncludeInExport
description: (default = null)
nullable: true
type: object
Description:
description: (default = null)
nullable: true
type: string
JobNumber:
description: (default = null)
nullable: true
type: string
ExternalType:
x-enum-type: IntelliTracer.Domain.ExternalClockingTypeString
enum:
- logmoment
- custom
- mobility
- null
nullable: true
type: string
ExternalCode:
description: (default = null)
nullable: true
type: string
required:
- Id
- DateTimeUtc
- DateTimeLocal
- ClockingType
- IsManual
- User
nullable: true
type: object
examples:
response:
value:
Data:
Id: 00000000-0000-0000-0000-000000000000
DateTimeUtc: 2021-11-25T07:00:00
DateTimeLocal: 2021-11-25T08:00:00
ClockingType: ""
IsManual: true
User:
Id: 00000000-0000-0000-0000-000000000000
Code: "012345"
Name: John Doe
Type: ""
Vehicle:
Id: 00000000-0000-0000-0000-000000000000
Code: "012345"
Name: John Doe
Type: ""
Location:
Address:
Street: Dumolinlaan
HouseNumber: "9"
City: Kortrijk
Submunicipality: Kortrijk
PostalCode: "8500"
Country: ""
Latitude: 50.81293
Longitude: 3.2453
Pois:
- Id: 00000000-0000-0000-0000-000000000000
Name: Work
Code: "012345"
Longitude: 3.2453
Latitude: 50.81293
AbsenceType:
Id: 00000000-0000-0000-0000-000000000000
Name: Sick leave
Code: SICKNESS
Paid: true
TemporaryUnemployed: false
Color: "#FF0000"
IncludeInExport: true
Description: null
JobNumber: null
ExternalType: ""
ExternalCode: null
"400":
description: BadRequest
headers: {}
content:
application/json:
schema:
type: object
properties:
Entity:
type: object
properties:
Id:
type: string
DateTimeUtc:
type: string
DateTimeLocal:
type: string
ClockingType:
type: string
x-enum-type: IntelliTracer.Domain.ClockingTypeString
enum:
- default
- work.start
- work.stop
- activity.start
- activity.stop
- activity.stop.break
- activity.switch
- activity.finish
- break.start
- break.stop
- absence.start
- absence.stop
- movement.start.driver
- movement.start.passenger
- movement.stop
- external.start
- external.stop
- travel.start
- travel.stop
IsManual:
type: boolean
User:
type: object
properties:
Id:
type: string
Code:
description: (default = null)
nullable: true
type: string
Name:
type: string
Type:
type: string
x-enum-type: IntelliTracer.Domain.ResourceTypeString
enum:
- user
- vehicle
- timeclock
- asset
- ivrphonenumber
- costcenter
- workplace
- mobileclocking
description: (default = 0)
required:
- Id
- Name
Vehicle:
properties:
Id:
type: string
Code:
description: (default = null)
nullable: true
type: string
Name:
type: string
Type:
type: string
x-enum-type: IntelliTracer.Domain.ResourceTypeString
enum:
- user
- vehicle
- timeclock
- asset
- ivrphonenumber
- costcenter
- workplace
- mobileclocking
description: (default = 0)
required:
- Id
- Name
description: (default = null)
nullable: true
type: object
Location:
properties:
Address:
properties:
Street:
description: (default = null)
nullable: true
type: string
HouseNumber:
description: (default = null)
nullable: true
type: string
City:
description: (default = null)
nullable: true
type: string
Submunicipality:
description: (default = null)
nullable: true
type: string
PostalCode:
description: (default = null)
nullable: true
type: string
Country:
type: string
x-enum-type: IntelliTracer.Domain.CountryString
enum:
- belgium
- france
- netherlands
- luxembourg
- italy
- norway
- denmark
- sweden
- sanmarino
- andorra
- germany
- unitedkingdom
- spain
- portugal
- switzerland
- austria
- hungary
- czechia
- greece
- poland
- slovakia
- turkey
- albania
- bulgaria
- bosniaherzegovina
- belarus
- moldova
- macedonia
- montenegro
- romania
- serbia
- ukraine
- finland
- ireland
- malta
- estland
- croatia
- lithuania
- latvia
- slovenia
- armenia
- azerbaijan
- cyprus
- faroeislands
- georgia
- gibraltar
- iceland
- monaco
- russia
- vatican
- kosovo
- unitedarabemirates
- afghanistan
- argentina
- australia
- bangladesh
- bahrain
- brunei
- bolivia
- brazil
- bhutan
- botswana
- belize
- canada
- congo
- cotedivoire
- chile
- cameroon
- china
- colombia
- costarica
- cuba
- dominicanrepublic
- algeria
- ecuador
- egypt
- eritrea
- ethiopia
- greenland
- guatemala
- honduras
- haiti
- indonesia
- israel
- india
- iraq
- iran
- jamaica
- jordan
- japan
- kenya
- kyrgyzstan
- cambodia
- korea
- kuwait
- kazakhstan
- laos
- lebanon
- liechtenstein
- srilanka
- libya
- morocco
- mali
- myanmar
- mongolia
- macaosar
- maldives
- mexico
- malaysia
- nigeria
- nicaragua
- nepal
- newzealand
- oman
- panama
- peru
- philippines
- pakistan
- puertorico
- paraguay
- qatar
- reunion
- rwanda
- saudiarabia
- singapore
- senegal
- somalia
- elsalvador
- syria
- thailand
- tajikistan
- turkmenistan
- tunisia
- trinidadandtobago
- taiwan
- unitedstates
- uruguay
- uzbekistan
- venezuela
- vietnam
- yemen
- southafrica
- zimbabwe
- guineabissau
- angola
- caboverde
- saotomeandprincipe
- mozambique
- guinea
- mauritania
- unknown
description: (default = 0)
Latitude:
description: (default = null)
nullable: true
type: number
Longitude:
description: (default = null)
nullable: true
type: number
description: (default = null)
nullable: true
type: object
Pois:
description: (default = null)
nullable: true
type: array
items: {}
Longitude:
description: (default = null)
nullable: true
type: number
Latitude:
description: (default = null)
nullable: true
type: number
description: (default = null)
nullable: true
type: object
AbsenceType:
properties:
Id:
type: string
Name:
type: string
Code:
type: string
Paid:
type: boolean
TemporaryUnemployed:
type: boolean
Color:
type: string
IncludeInExport:
type: boolean
required:
- Id
- Name
- Code
- Paid
- TemporaryUnemployed
- Color
- IncludeInExport
description: (default = null)
nullable: true
type: object
Description:
description: (default = null)
nullable: true
type: string
JobNumber:
description: (default = null)
nullable: true
type: string
ExternalType:
x-enum-type: IntelliTracer.Domain.ExternalClockingTypeString
enum:
- logmoment
- custom
- mobility
- null
nullable: true
type: string
ExternalCode:
description: (default = null)
nullable: true
type: string
required:
- Id
- DateTimeUtc
- DateTimeLocal
- ClockingType
- IsManual
- User
ValidationResult:
type: array
items: {}
required:
- Entity
- ValidationResult
examples:
response:
value:
Entity:
Id: 00000000-0000-0000-0000-000000000000
DateTimeUtc: 2021-11-25T07:00:00
DateTimeLocal: 2021-11-25T08:00:00
ClockingType: ""
IsManual: true
User:
Id: 00000000-0000-0000-0000-000000000000
Code: "012345"
Name: John Doe
Type: ""
Vehicle:
Id: 00000000-0000-0000-0000-000000000000
Code: "012345"
Name: John Doe
Type: ""
Location:
Address:
Street: Dumolinlaan
HouseNumber: "9"
City: Kortrijk
Submunicipality: Kortrijk
PostalCode: "8500"
Country: ""
Latitude: 50.81293
Longitude: 3.2453
Pois:
- Id: 00000000-0000-0000-0000-000000000000
Name: Work
Code: "012345"
Longitude: 3.2453
Latitude: 50.81293
AbsenceType:
Id: 00000000-0000-0000-0000-000000000000
Name: Sick leave
Code: SICKNESS
Paid: true
TemporaryUnemployed: false
Color: "#FF0000"
IncludeInExport: true
Description: null
JobNumber: null
ExternalType: ""
ExternalCode: null
ValidationResult:
- Message: ""
SourceMemberNames: []
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
"503":
description: ServiceUnavailable
headers: {}
summary: Create clocking (all types)
operationId: Create clocking (all types)
description: >-
Creates a new clocking.
This endpoint requires the 'Clocking API: all types' option to be enabled by software support. Contact softwaresupport@geodynamics.be for assistance.
*Privilege required: `Api: Timesheet management`*
x-resource: Clockings
tags:
- Clocking
requestBody:
content:
application/json:
schema:
type: object
properties:
DateTimeUtc:
description: (default = null)
nullable: true
type: string
ClockingType:
type: string
x-enum-type: IntelliTracer.Domain.ClockingTypeString
enum:
- default
- work.start
- work.stop
- activity.start
- activity.stop
- activity.stop.break
- activity.switch
- activity.finish
- break.start
- break.stop
- absence.start
- absence.stop
- movement.start.driver
- movement.start.passenger
- movement.stop
- external.start
- external.stop
- travel.start
- travel.stop
UserCode:
type: string
VehicleCode:
description: (default = null)
nullable: true
type: string
Description:
description: (default = null)
nullable: true
type: string
JobNumber:
description: (default = null)
nullable: true
type: string
ExternalType:
x-enum-type: IntelliTracer.Domain.ExternalClockingTypeString
enum:
- logmoment
- custom
- mobility
- null
nullable: true
type: string
ExternalCode:
description: (default = null)
nullable: true
type: string
AbsenceTypeId:
description: (default = null)
nullable: true
type: string
required:
- ClockingType
- UserCode
example:
DateTimeUtc: 2021-11-25T07:00:00
ClockingType: ""
UserCode: ""
VehicleCode: null
Description: null
JobNumber: 1575-7577-4
ExternalType: ""
ExternalCode: null
AbsenceTypeId: 00000000-0000-0000-0000-000000000000
security:
- pat: []
/api/v1/Clocking_GetByUserIdDateRange:
get:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/IntelliTracer.ApiV1.Clocking"
examples:
response:
value:
- Id: 00000000-0000-0000-0000-000000000000
DateTimeUtc: 2019-01-25T07:29:37
DateTimeLocal: 2019-01-25T08:29:37
User:
Id: 00000000-0000-0000-0000-000000000000
Code: "012345"
EmployerCode: "012345"
Name: John Doe
Badge:
Id: 00000000-0000-0000-0000-000000000000
InternalNumber: 00AA11BB
ExternalNumber: "12345678"
DayProgramId: 00000000-0000-0000-0000-000000000000
Vehicle:
Id: 00000000-0000-0000-0000-000000000000
Code: "012345"
Name: Vehicle 1
VehicleTypeId: 00000000-0000-0000-0000-000000000000
LastSyncDateUtc: 2019-01-25T07:29:37
LastPosition:
AnalogExportList:
- Number: 0
Name: null
StatusName: null
AnalogInputType: 0
InputExportList:
- Number: 0
Name: null
Status: null
StatusName: null
IsPrivate: false
BadgeUser: John Doe
BadgeNr: 00AA11BB
TypeText: Position
Type: "1"
VehicleId: 00000000-0000-0000-0000-000000000000
InputAcc: false
Heading: 10
Speed: 50
Altitude: 0
Latitude: 50.812939
Longitude: 3.245304
AddressExport:
Street: Dumolinlaan
HouseNumber: "9"
PostalCode: "8500"
City: Kortrijk
Submunicipality: Kortrijk
Country: 0
ReportDateLocal: 2019-01-25T08:29:37
ReportDateUtc: 2019-01-25T07:29:37
GpsDateUtc: 2019-01-25T07:29:37
OutputExportList:
- Number: 0
Name: null
Status: null
StatusName: null
Pois:
- 00000000-0000-0000-0000-000000000000
- 00000000-0000-0000-0000-000000000000
Type: 0
Location:
Address:
Street: Dumolinlaan
HouseNumber: "9"
PostalCode: "8500"
City: Kortrijk
Submunicipality: Kortrijk
Country: 0
Longitude: 3.245304
Latitude: 50.812939
Pois:
- 00000000-0000-0000-0000-000000000000
- 00000000-0000-0000-0000-000000000000
IsManual: false
Description: null
AbsenceCode: null
JobNumber: 1575-7577-4
Note: clocking note
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Get clockings by user
operationId: Get clockings by user
description: |-
Returns a list of all clockings for a user within a date/time range.
*Privilege required: `Api: Timesheet read`*
x-resource: Clockings by user
tags:
- Clocking
parameters:
- name: userId
in: query
description: ""
required: true
example: 00000000-0000-0000-0000-000000000000
schema:
type: string
- name: fromDate
in: query
description: ""
required: true
example: 2019-01-25T08:00:00
schema:
type: string
- name: toDate
in: query
description: ""
required: true
example: 2019-01-25T17:00:00
schema:
type: string
security:
- pat: []
/api/v1/Clocking_GetByUserIdListDateRange:
post:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/IntelliTracer.ApiV1.Clocking"
examples:
response:
value:
- Id: 00000000-0000-0000-0000-000000000000
DateTimeUtc: 2019-01-25T07:29:37
DateTimeLocal: 2019-01-25T08:29:37
User:
Id: 00000000-0000-0000-0000-000000000000
Code: "012345"
EmployerCode: "012345"
Name: John Doe
Badge:
Id: 00000000-0000-0000-0000-000000000000
InternalNumber: 00AA11BB
ExternalNumber: "12345678"
DayProgramId: 00000000-0000-0000-0000-000000000000
Vehicle:
Id: 00000000-0000-0000-0000-000000000000
Code: "012345"
Name: Vehicle 1
VehicleTypeId: 00000000-0000-0000-0000-000000000000
LastSyncDateUtc: 2019-01-25T07:29:37
LastPosition:
AnalogExportList:
- Number: 0
Name: null
StatusName: null
AnalogInputType: 0
InputExportList:
- Number: 0
Name: null
Status: null
StatusName: null
IsPrivate: false
BadgeUser: John Doe
BadgeNr: 00AA11BB
TypeText: Position
Type: "1"
VehicleId: 00000000-0000-0000-0000-000000000000
InputAcc: false
Heading: 10
Speed: 50
Altitude: 0
Latitude: 50.812939
Longitude: 3.245304
AddressExport:
Street: Dumolinlaan
HouseNumber: "9"
PostalCode: "8500"
City: Kortrijk
Submunicipality: Kortrijk
Country: 0
ReportDateLocal: 2019-01-25T08:29:37
ReportDateUtc: 2019-01-25T07:29:37
GpsDateUtc: 2019-01-25T07:29:37
OutputExportList:
- Number: 0
Name: null
Status: null
StatusName: null
Pois:
- 00000000-0000-0000-0000-000000000000
- 00000000-0000-0000-0000-000000000000
Type: 0
Location:
Address:
Street: Dumolinlaan
HouseNumber: "9"
PostalCode: "8500"
City: Kortrijk
Submunicipality: Kortrijk
Country: 0
Longitude: 3.245304
Latitude: 50.812939
Pois:
- 00000000-0000-0000-0000-000000000000
- 00000000-0000-0000-0000-000000000000
IsManual: false
Description: null
AbsenceCode: null
JobNumber: 1575-7577-4
Note: clocking note
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Get clockings by users
operationId: Get clockings by users
description: >-
Returns a list of all clockings for one or more users within a date/time
range.
*Privilege required: `Api: Timesheet read`*
x-resource: Clockings by user
tags:
- Clocking
parameters:
- name: fromDate
in: query
description: ""
required: true
example: 2019-01-25T08:00:00
schema:
type: string
- name: toDate
in: query
description: ""
required: true
example: 2019-01-25T17:00:00
schema:
type: string
requestBody:
content:
application/json:
schema:
type: array
items:
type: string
example:
- 00000000-0000-0000-0000-000000000000
- 00000000-0000-0000-0000-000000000000
security:
- pat: []
/api/v1/Clocking_GetIsManualByUserIdDateRange:
get:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/IntelliTracer.ApiV1.Clocking"
examples:
response:
value:
- Id: 00000000-0000-0000-0000-000000000000
DateTimeUtc: 2019-01-25T07:29:37
DateTimeLocal: 2019-01-25T08:29:37
User:
Id: 00000000-0000-0000-0000-000000000000
Code: "012345"
EmployerCode: "012345"
Name: John Doe
Badge:
Id: 00000000-0000-0000-0000-000000000000
InternalNumber: 00AA11BB
ExternalNumber: "12345678"
DayProgramId: 00000000-0000-0000-0000-000000000000
Vehicle:
Id: 00000000-0000-0000-0000-000000000000
Code: "012345"
Name: Vehicle 1
VehicleTypeId: 00000000-0000-0000-0000-000000000000
LastSyncDateUtc: 2019-01-25T07:29:37
LastPosition:
AnalogExportList:
- Number: 0
Name: null
StatusName: null
AnalogInputType: 0
InputExportList:
- Number: 0
Name: null
Status: null
StatusName: null
IsPrivate: false
BadgeUser: John Doe
BadgeNr: 00AA11BB
TypeText: Position
Type: "1"
VehicleId: 00000000-0000-0000-0000-000000000000
InputAcc: false
Heading: 10
Speed: 50
Altitude: 0
Latitude: 50.812939
Longitude: 3.245304
AddressExport:
Street: Dumolinlaan
HouseNumber: "9"
PostalCode: "8500"
City: Kortrijk
Submunicipality: Kortrijk
Country: 0
ReportDateLocal: 2019-01-25T08:29:37
ReportDateUtc: 2019-01-25T07:29:37
GpsDateUtc: 2019-01-25T07:29:37
OutputExportList:
- Number: 0
Name: null
Status: null
StatusName: null
Pois:
- 00000000-0000-0000-0000-000000000000
- 00000000-0000-0000-0000-000000000000
Type: 0
Location:
Address:
Street: Dumolinlaan
HouseNumber: "9"
PostalCode: "8500"
City: Kortrijk
Submunicipality: Kortrijk
Country: 0
Longitude: 3.245304
Latitude: 50.812939
Pois:
- 00000000-0000-0000-0000-000000000000
- 00000000-0000-0000-0000-000000000000
IsManual: false
Description: null
AbsenceCode: null
JobNumber: 1575-7577-4
Note: clocking note
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Get manual clockings by user
operationId: Get manual clockings by user
description: >-
Returns a list of all manual clockings for a user within a date/time
range.
*Privilege required: `Api: Timesheet read`*
x-resource: Manual clockings by user
tags:
- Clocking
parameters:
- name: userId
in: query
description: ""
required: true
example: 00000000-0000-0000-0000-000000000000
schema:
type: string
- name: fromDate
in: query
description: ""
required: true
example: 2019-01-25T08:00:00
schema:
type: string
- name: toDate
in: query
description: ""
required: true
example: 2019-01-25T17:00:00
schema:
type: string
security:
- pat: []
"/api/v2/clocking/{clockingId}/jobNumber":
post:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
$ref: "#/components/schemas/IntelliTracer.ApiV2.Clocking"
examples:
response:
value:
Id: 00000000-0000-0000-0000-000000000000
DateTimeUtc: 2021-11-25T07:00:00
DateTimeLocal: 2021-11-25T08:00:00
ClockingType: 0
Description: null
JobNumber: 1575-7577-4
ExternalType: 0
ExternalCode: null
IsManual: false
User:
Id: 00000000-0000-0000-0000-000000000000
Code: "012345"
Name: John Doe
Type: 0
Vehicle:
Id: 00000000-0000-0000-0000-000000000000
Code: "012345"
Name: John Doe
Type: 0
Location:
Address:
CountryName: Belgium
AddressLine: Dumolinlaan 9, 8500 Kortrijk, BE
PoiList:
- 00000000-0000-0000-0000-000000000000
- 00000000-0000-0000-0000-000000000000
City: Kortrijk
CityLine: 8500 Kortrijk, BE
CountryCode: 0
HouseNumber: "9"
Latitude: 50.812939
Longitude: 3.245304
PostalCode: "8500"
ShortAddressLine: Dumolinlaan 9, Kortrijk, BE
Street: Dumolinlaan
StreetLine: Dumolinlaan 9
Submunicipality: Kortrijk
Pois:
- Id: 00000000-0000-0000-0000-000000000000
Name: Work
Code: "012345"
Latitude: 50.812939
Longitude: 3.245304
AbsenceType:
Name: Sickness
AbsenceCode: "100"
Paid: false
TemporaryUnemployment: false
Color: "#000000"
IncludeInExport: true
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Edit jobnumber by Clocking ID
operationId: Edit jobnumber by Clocking ID
description: |-
Updates the jobnumber of a clocking by its clocking ID.
*Privilege required: `Api: Timesheet management`*
x-resource: Edit jobnumber by Clocking ID
tags:
- Clocking
parameters:
- name: clockingId
in: path
description: ""
required: true
example: 00000000-0000-0000-0000-000000000000
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
properties:
JobNumber:
description: (default = null)
nullable: true
type: string
example:
JobNumber: 1575-7577-4
security:
- pat: []
"/api/v2/costcenter?page={page}&search={search}":
get:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Data:
description: (default = null)
nullable: true
type: array
items: {}
PagingFilter:
properties:
Page:
type: number
Search:
nullable: true
type: string
PageCount:
type: number
TotalCount:
type: number
Links:
type: object
properties:
Base:
type: string
First:
type: string
Prev:
type: string
Next:
type: string
Last:
type: string
required:
- Base
required:
- Page
- PageCount
- TotalCount
- Links
description: (default = null)
nullable: true
type: object
examples:
response:
value:
Data:
- Id: 00000000-0000-0000-0000-000000000000
Name: Workplace 1
Code: "012345"
ExpirationDate: 2022-08-24T17:00:00+01:00
Poi:
Id: 00000000-0000-0000-0000-000000000000
Name: Home
Code: "012345"
AutoCreate: false
CreationDate: 2021-08-24T17:00:00+01:00
PagingFilter:
Page: 1
Search: ABC
PageCount: 4
TotalCount: 100
Links:
Base: https://api.intellitracer.be
First: /api/v2/asset?page=1
Prev: /api/v2/asset?page=2
Next: /api/v2/asset?page=4
Last: /api/v2/asset?page=4
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Get cost centers
operationId: Get cost centers
description: |-
Returns a paged list of cost centers.
Pagination and searching is explained in [Pagination](#pagination).
*Privilege required: `Api: Resource read` or `Api: Resource management`*
x-resource: Cost centers
tags:
- Time
parameters:
- name: page
in: path
description: ""
required: true
example: "1"
schema:
type: number
- name: search
in: path
description: ""
required: true
example: ABC
schema:
type: string
security:
- pat: []
"/api/v2/costcenter/{id}":
get:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Data:
properties:
Id:
type: string
Name:
type: string
Code:
description: (default = null)
nullable: true
type: string
ExpirationDate:
description: "(default = null) "
nullable: true
type: string
Poi:
properties:
Id:
type: string
Name:
type: string
Code:
description: "(default = null) "
nullable: true
type: string
required:
- Id
- Name
description: (default = null)
nullable: true
type: object
AutoCreate:
type: boolean
description: (default = false)
CreationDate:
type: string
description: (default = null)
required:
- Id
- Name
- AutoCreate
- CreationDate
description: (default = null)
nullable: true
type: object
examples:
response:
value:
Data:
Id: 00000000-0000-0000-0000-000000000000
Name: Workplace 1
Code: "012345"
ExpirationDate: 2022-08-24T17:00:00+01:00
Poi:
Id: 00000000-0000-0000-0000-000000000000
Name: Home
Code: "012345"
AutoCreate: false
CreationDate: 2021-08-24T17:00:00+01:00
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Get cost center
operationId: Get cost center
description: |-
Returns a cost center by id.
*Privilege required: `Api: Resource read` or `Api: Resource management`*
x-resource: Cost centers
tags:
- Time
parameters:
- name: id
in: path
description: ""
required: true
example: 00000000-0000-0000-0000-000000000000
schema:
type: string
security:
- pat: []
/api/v2/costcenter:
post:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Data:
properties:
Id:
type: string
Name:
type: string
Code:
description: (default = null)
nullable: true
type: string
ExpirationDate:
description: "(default = null) "
nullable: true
type: string
Poi:
properties:
Id:
type: string
Name:
type: string
Code:
description: "(default = null) "
nullable: true
type: string
required:
- Id
- Name
description: (default = null)
nullable: true
type: object
AutoCreate:
type: boolean
description: (default = false)
CreationDate:
type: string
description: (default = null)
required:
- Id
- Name
- AutoCreate
- CreationDate
description: (default = null)
nullable: true
type: object
examples:
response:
value:
Data:
Id: 00000000-0000-0000-0000-000000000000
Name: Workplace 1
Code: "012345"
ExpirationDate: 2022-08-24T17:00:00+01:00
Poi:
Id: 00000000-0000-0000-0000-000000000000
Name: Home
Code: "012345"
AutoCreate: false
CreationDate: 2021-08-24T17:00:00+01:00
"400":
description: BadRequest
headers: {}
content:
application/json:
schema:
type: object
properties:
Entity:
type: object
properties:
Name:
type: string
Code:
type: string
description: (default = null)
ExpirationDate:
description: (default = null)
nullable: true
type: string
PoiId:
description: (default = null)
nullable: true
type: string
ValidatorIds:
description: (default = [])
nullable: true
type: array
items: {}
required:
- Name
- Code
ValidationResult:
type: array
items: {}
required:
- Entity
- ValidationResult
examples:
response:
value:
Entity:
Name: Workplace 1
Code: "012345"
ExpirationDate: 2021-08-24T17:00:00+01:00
PoiId: 00000000-0000-0000-0000-000000000000
ValidatorIds:
- 00000000-0000-0000-0000-000000000000
- 00000000-0000-0000-0000-000000000000
ValidationResult:
- Message: ""
SourceMemberNames: []
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Create/Update cost center
operationId: Create/Update cost center
description: >-
Creates a new cost center if no cost center exists with the given code.
Updates the cost center if a cost center exists with the given code.
If no expiration date is provided, the cost center will expire within one year.
*Privilege required: `Api: Resource management`*
x-resource: Cost centers
tags:
- Time
requestBody:
content:
application/json:
schema:
type: object
properties:
Name:
type: string
Code:
type: string
description: (default = null)
ExpirationDate:
description: (default = null)
nullable: true
type: string
PoiId:
description: (default = null)
nullable: true
type: string
ValidatorIds:
description: (default = [])
nullable: true
type: array
items: {}
required:
- Name
- Code
example:
Name: Workplace 1
Code: "012345"
ExpirationDate: 2021-08-24T17:00:00+01:00
PoiId: 00000000-0000-0000-0000-000000000000
ValidatorIds:
- 00000000-0000-0000-0000-000000000000
- 00000000-0000-0000-0000-000000000000
security:
- pat: []
/api/v1/costcenter:
delete:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Id:
type: string
Name:
type: string
Code:
description: (default = null)
nullable: true
type: string
Poi:
properties:
Id:
type: string
Name:
type: string
Code:
description: (default = null)
nullable: true
type: string
PoiType:
properties:
Id:
type: string
Name:
type: string
Color:
description: >-
(default = null)
Color to be used for POIs of this type in IntelliTracer.
nullable: true
type: string
_typeDescriptor:
type: string
required:
- Id
- Name
description: (default = null)
nullable: true
type: object
IsAssetLocation:
type: boolean
description: (default = false)
Street:
description: (default = null)
nullable: true
type: string
HouseNumber:
description: (default = null)
nullable: true
type: string
City:
description: (default = null)
nullable: true
type: string
Submunicipality:
description: (default = null)
nullable: true
type: string
PostalCode:
description: (default = null)
nullable: true
type: string
Country:
type: number
x-enum-type: IntelliTracer.Domain.Country
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
- 47
- 48
- 49
- 50
- 51
- 52
- 53
- 54
- 55
- 56
- 57
- 58
- 59
- 60
- 61
- 62
- 63
- 64
- 65
- 66
- 67
- 68
- 69
- 70
- 71
- 72
- 73
- 74
- 75
- 76
- 77
- 78
- 79
- 80
- 81
- 82
- 83
- 84
- 85
- 86
- 87
- 88
- 89
- 90
- 91
- 92
- 93
- 94
- 95
- 96
- 97
- 98
- 99
- 100
- 101
- 102
- 103
- 104
- 105
- 106
- 107
- 108
- 109
- 110
- 111
- 112
- 113
- 114
- 115
- 116
- 117
- 118
- 119
- 120
- 121
- 122
- 123
- 124
- 125
- 126
- 127
- 128
- 129
- 130
- 131
- 132
- 133
- 134
- 135
- 136
- 137
- 138
- 139
- 140
- 141
- 142
- 143
- 144
- 145
- 146
- 147
- 148
- 149
- 150
- 151
- 152
- 153
- 9999
description: (default = 0)
Priority:
x-enum-type: IntelliTracer.ApiV1.PoiPriority
enum:
- "-"
- "0"
- "1"
- "2"
- "3"
- "4"
- "5"
- "6"
- "7"
- "8"
- "9"
- "0"
- null
description: >-
(default = null)
Determines which POI will be displayed on top in IntelliTracer (in case of overlapping POIs).
nullable: true
type: string
Description:
description: (default = null)
nullable: true
type: string
GeographyWkt:
description: >-
(default = null)
The coordinates of all points that define the shape of the POI.
nullable: true
type: string
LonMin:
type: number
description: |-
(default = 0.0)
Lowest longitude coordinate of the shape of the POI.
LonMax:
type: number
description: |-
(default = 0.0)
Highest longitude coordinate of the shape of the POI.
LatMin:
type: number
description: |-
(default = 0.0)
Lowest latitude coordinate of the shape of the POI.
LatMax:
type: number
description: |-
(default = 0.0)
Highest latitude coordinate of the shape of the POI.
MarkerLon:
description: |-
(default = null)
Longitude coordinate of the marker.
nullable: true
type: number
MarkerLat:
description: |-
(default = null)
Latitude coordinate of the marker.
nullable: true
type: number
IsLambert72:
type: boolean
description: >-
(default = false)
Different geological projection system often used by Belgian governmental institutes.
Radius:
description: >-
(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).
nullable: true
type: number
ReverseGeocoding:
description: >-
(default = false)
Indicates whether location will be determined by position or address.
nullable: true
type: boolean
Groups:
description: (default = null)
nullable: true
type: array
items: {}
_typeDescriptor:
type: string
required:
- Id
- Name
description: (default = null)
nullable: true
type: object
_typeDescriptor:
type: string
required:
- Id
- Name
examples:
response:
value:
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
"400":
description: BadRequest
headers: {}
content:
application/json:
schema:
type: object
properties:
Entity:
type: object
properties:
Id:
type: string
Name:
type: string
Code:
description: (default = null)
nullable: true
type: string
Poi:
properties:
Id:
type: string
Name:
type: string
Code:
description: (default = null)
nullable: true
type: string
PoiType:
properties:
Id:
type: string
Name:
type: string
Color:
description: >-
(default = null)
Color to be used for POIs of this type in IntelliTracer.
nullable: true
type: string
_typeDescriptor:
type: string
required:
- Id
- Name
description: (default = null)
nullable: true
type: object
IsAssetLocation:
type: boolean
description: (default = false)
Street:
description: (default = null)
nullable: true
type: string
HouseNumber:
description: (default = null)
nullable: true
type: string
City:
description: (default = null)
nullable: true
type: string
Submunicipality:
description: (default = null)
nullable: true
type: string
PostalCode:
description: (default = null)
nullable: true
type: string
Country:
type: number
x-enum-type: IntelliTracer.Domain.Country
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
- 47
- 48
- 49
- 50
- 51
- 52
- 53
- 54
- 55
- 56
- 57
- 58
- 59
- 60
- 61
- 62
- 63
- 64
- 65
- 66
- 67
- 68
- 69
- 70
- 71
- 72
- 73
- 74
- 75
- 76
- 77
- 78
- 79
- 80
- 81
- 82
- 83
- 84
- 85
- 86
- 87
- 88
- 89
- 90
- 91
- 92
- 93
- 94
- 95
- 96
- 97
- 98
- 99
- 100
- 101
- 102
- 103
- 104
- 105
- 106
- 107
- 108
- 109
- 110
- 111
- 112
- 113
- 114
- 115
- 116
- 117
- 118
- 119
- 120
- 121
- 122
- 123
- 124
- 125
- 126
- 127
- 128
- 129
- 130
- 131
- 132
- 133
- 134
- 135
- 136
- 137
- 138
- 139
- 140
- 141
- 142
- 143
- 144
- 145
- 146
- 147
- 148
- 149
- 150
- 151
- 152
- 153
- 9999
description: (default = 0)
Priority:
x-enum-type: IntelliTracer.ApiV1.PoiPriority
enum:
- "-"
- "0"
- "1"
- "2"
- "3"
- "4"
- "5"
- "6"
- "7"
- "8"
- "9"
- "0"
- null
description: >-
(default = null)
Determines which POI will be displayed on top in IntelliTracer (in case of overlapping POIs).
nullable: true
type: string
Description:
description: (default = null)
nullable: true
type: string
GeographyWkt:
description: >-
(default = null)
The coordinates of all points that define the shape of the POI.
nullable: true
type: string
LonMin:
type: number
description: >-
(default = 0.0)
Lowest longitude coordinate of the shape of the POI.
LonMax:
type: number
description: >-
(default = 0.0)
Highest longitude coordinate of the shape of the POI.
LatMin:
type: number
description: >-
(default = 0.0)
Lowest latitude coordinate of the shape of the POI.
LatMax:
type: number
description: >-
(default = 0.0)
Highest latitude coordinate of the shape of the POI.
MarkerLon:
description: |-
(default = null)
Longitude coordinate of the marker.
nullable: true
type: number
MarkerLat:
description: |-
(default = null)
Latitude coordinate of the marker.
nullable: true
type: number
IsLambert72:
type: boolean
description: >-
(default = false)
Different geological projection system often used by Belgian governmental institutes.
Radius:
description: >-
(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).
nullable: true
type: number
ReverseGeocoding:
description: >-
(default = false)
Indicates whether location will be determined by position or address.
nullable: true
type: boolean
Groups:
description: (default = null)
nullable: true
type: array
items: {}
_typeDescriptor:
type: string
required:
- Id
- Name
description: (default = null)
nullable: true
type: object
_typeDescriptor:
type: string
required:
- Id
- Name
ValidationResult:
type: array
items: {}
required:
- Entity
- ValidationResult
examples:
response:
value:
Entity:
Id: 00000000-0000-0000-0000-000000000000
Name: Workplace 1
Code: "012345"
Poi:
Id: 00000000-0000-0000-0000-000000000000
Name: Work
Code: "012345"
PoiType:
Id: 00000000-0000-0000-0000-000000000000
Name: Work place
Color: "#00FF2F"
IsAssetLocation: false
Street: Dumolinlaan
HouseNumber: "9"
City: Kortrijk
Submunicipality: Kortrijk
PostalCode: "8500"
Country: 0
Priority: "0"
Description: Work
GeographyWkt: POLYGON ((3.145219 50.81309, 3.244998 50.81309, 3.244998 50.91806,
3.145219 50.91806, 3.145219 50.81309))
LonMin: 3.145219
LonMax: 3.244998
LatMin: 50.81309
LatMax: 50.91806
MarkerLon: 3.145219
MarkerLat: 50.81309
IsLambert72: false
Radius: 0.03
ReverseGeocoding: false
Groups:
- Id: 00000000-0000-0000-0000-000000000000
Name: Work places
Pois:
- {}
NumberOfPois: 1
ValidationResult:
- Message: ""
SourceMemberNames: []
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Delete cost center
operationId: Delete cost center
description: |-
Deletes a cost center.
*Privilege required: `Api: Resource management`*
x-resource: Cost centers
tags:
- Time
requestBody:
$ref: "#/components/requestBodies/Delete_point_of_interestBody"
security:
- pat: []
/api/v1/costcenter/linktoresource:
get:
responses:
"200":
description: OK
headers: {}
"400":
description: BadRequest
headers: {}
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Link cost center to resource
operationId: Link cost center to resource
description: |-
Links a cost center to a resource.
*Privilege required: `Api: Resource management`*
x-resource: Cost centers
tags:
- Time
parameters:
- name: costCenterId
in: query
description: ""
required: true
example: 00000000-0000-0000-0000-000000000000
schema:
type: string
- name: resourceId
in: query
description: ""
required: true
example: 00000000-0000-0000-0000-000000000000
schema:
type: string
security:
- pat: []
"/api/v2/costcenter/{id}/validator?page={page}&search={search}":
get:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Data:
description: (default = null)
nullable: true
type: array
items: {}
PagingFilter:
properties:
Page:
type: number
Search:
nullable: true
type: string
PageCount:
type: number
TotalCount:
type: number
Links:
type: object
properties:
Base:
type: string
First:
type: string
Prev:
type: string
Next:
type: string
Last:
type: string
required:
- Base
required:
- Page
- PageCount
- TotalCount
- Links
description: (default = null)
nullable: true
type: object
examples:
response:
value:
Data:
- Id: 00000000-0000-0000-0000-000000000000
Name: Workplace 1
Code: "012345"
PagingFilter:
Page: 1
Search: ABC
PageCount: 4
TotalCount: 100
Links:
Base: https://api.intellitracer.be
First: /api/v2/asset?page=1
Prev: /api/v2/asset?page=2
Next: /api/v2/asset?page=4
Last: /api/v2/asset?page=4
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Get validators
operationId: Get validators
description: |-
Returns a paged list of validators linked to a cost center.
Pagination and searching is explained in [Pagination](#pagination).
*Privilege required: `Api: Resource read` or `Api: Resource management`*
x-resource: Cost center - Validators
tags:
- Time
parameters:
- name: id
in: path
description: ""
required: true
example: 00000000-0000-0000-0000-000000000000
schema:
type: string
- name: page
in: path
description: ""
required: true
example: "1"
schema:
type: number
- name: search
in: path
description: ""
required: true
example: ABC
schema:
type: string
security:
- pat: []
"/api/v2/costcenter/{id}/validator":
put:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Data:
description: (default = null)
nullable: true
type: array
items: {}
examples:
response:
value:
Data:
- Id: 00000000-0000-0000-0000-000000000000
Name: Workplace 1
Code: "012345"
"400":
description: BadRequest
headers: {}
content:
application/json:
schema:
type: object
properties:
Entity:
type: object
properties:
ValidatorIds:
type: array
items: {}
required:
- ValidatorIds
ValidationResult:
type: array
items: {}
required:
- Entity
- ValidationResult
examples:
response:
value:
Entity:
ValidatorIds:
- 00000000-0000-0000-0000-000000000000
- 00000000-0000-0000-0000-000000000000
ValidationResult:
- Message: ""
SourceMemberNames: []
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Link validators to cost center
operationId: Link validators to cost center
description: |-
Links one or more validators to a cost center.
*Privilege required: `Api: Resource management`*
x-resource: Cost center - Validators
tags:
- Time
parameters:
- name: id
in: path
description: ""
required: true
example: 00000000-0000-0000-0000-000000000000
schema:
type: string
requestBody:
$ref: "#/components/requestBodies/Link_validators_to_cost_centerBody"
security:
- pat: []
"/api/v2/costcenter/{id}/validator/delete":
post:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Data:
description: (default = null)
nullable: true
type: array
items: {}
examples:
response:
value:
Data:
- Id: 00000000-0000-0000-0000-000000000000
Name: Workplace 1
Code: "012345"
"400":
description: BadRequest
headers: {}
content:
application/json:
schema:
type: object
properties:
Entity:
type: object
properties:
ValidatorIds:
type: array
items: {}
required:
- ValidatorIds
ValidationResult:
type: array
items: {}
required:
- Entity
- ValidationResult
examples:
response:
value:
Entity:
ValidatorIds:
- 00000000-0000-0000-0000-000000000000
- 00000000-0000-0000-0000-000000000000
ValidationResult:
- Message: ""
SourceMemberNames: []
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Unlink validators from cost center
operationId: Unlink validators from cost center
description: |-
Unlinks one or more validators from a cost center.
*Privilege required: `Api: Resource management`*
x-resource: Cost center - Validators
tags:
- Time
parameters:
- name: id
in: path
description: ""
required: true
example: 00000000-0000-0000-0000-000000000000
schema:
type: string
requestBody:
$ref: "#/components/requestBodies/Link_validators_to_cost_centerBody"
security:
- pat: []
/api/v1/dayprogram_V2:
get:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/IntelliTracer.ApiV1.DayProgram"
examples:
response:
value:
- Id: 00000000-0000-0000-0000-000000000000
Name: Default
Code: "012345"
DayStartBoundary: 00:00:00
DayDuration: 24:00:00
Break1StartRelativeToDayBoundary: 00:00:00
Break1StopRelativeToDayBoundary: 00:00:00
Break2StartRelativeToDayBoundary: 00:00:00
Break2StopRelativeToDayBoundary: 00:00:00
Break3StartRelativeToDayBoundary: 00:00:00
Break3StopRelativeToDayBoundary: 00:00:00
MondayWorkingStartRelativeToDayBoundary: 00:00:00
MondayWorkingStopRelativeToDayBoundary: 00:00:00
TuesdayWorkingStartRelativeToDayBoundary: 00:00:00
TuesdayWorkingStopRelativeToDayBoundary: 00:00:00
WednesdayWorkingStartRelativeToDayBoundary: 00:00:00
WednesdayWorkingStopRelativeToDayBoundary: 00:00:00
ThursdayWorkingStartRelativeToDayBoundary: 00:00:00
ThursdayWorkingStopRelativeToDayBoundary: 00:00:00
FridayWorkingStartRelativeToDayBoundary: 00:00:00
FridayWorkingStopRelativeToDayBoundary: 00:00:00
SaturdayWorkingStartRelativeToDayBoundary: 00:00:00
SaturdayWorkingStopRelativeToDayBoundary: 00:00:00
SundayWorkingStartRelativeToDayBoundary: 00:00:00
SundayWorkingStopRelativeToDayBoundary: 00:00:00
Users:
- Id: 00000000-0000-0000-0000-000000000000
Name: John Doe
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Get day programs
operationId: Get day programs
description: >-
Returns a list of all day programs in detail.
*Privilege required: `Api: Timesheet read` or `Api: Timesheet management`*
x-resource: Day programs
tags:
- Time
security:
- pat: []
/api/v1/byuseriddaterange:
get:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/IntelliTracer.ApiV1.Planning"
examples:
response:
value:
- Id: 00000000-0000-0000-0000-000000000000
User:
Id: 00000000-0000-0000-0000-000000000000
Name: John Doe
Code: "012345"
EmployerCode: "012345"
Email: john.doe@doe.com
Gsm: "+32477665544"
FreeField1: null
FreeField2: null
FreeField3: null
FreeField4: null
FreeField5: null
FreeField6: null
Notes: null
Street: Dumolinlaan
HouseNumber: "9"
City: Kortrijk
PostalCode: "8500"
Submunicipality: Kortrijk
Country: 0
Longitude: 3.245304
Latitude: 50.812939
DefaultDayProgram:
Id: 00000000-0000-0000-0000-000000000000
Name: Default
Groups:
- Id: 00000000-0000-0000-0000-000000000000
Name: Employees
Type: 0
Code: "012345"
Resource:
Id: 00000000-0000-0000-0000-000000000000
Name: John Doe
Code: "012345"
Type: 0
FromDate: 2019-01-24T08:00:00
ToDate: 2019-01-24T17:00:00
BreakTime: 01:00:00
Description: "012345"
ActivityNumber: "012345"
Poi:
Id: 00000000-0000-0000-0000-000000000000
Name: Work
Code: "012345"
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Get plannings
operationId: Get plannings
description: |-
Returns a list of all plannings for a user within a date/time range.
*Privilege required: `Api: Planning read` or `Api: Planning management`*
x-resource: Plannings
tags:
- Time
parameters:
- name: userId
in: query
description: ""
required: true
example: 00000000-0000-0000-0000-000000000000
schema:
type: string
- name: fromDate
in: query
description: ""
required: true
example: 2019-01-25T08:00:00
schema:
type: string
- name: toDate
in: query
description: ""
required: true
example: 2019-01-25T17:00:00
schema:
type: string
security:
- pat: []
delete:
responses:
"200":
description: OK
headers: {}
content:
"*/*":
schema:
type: number
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Delete plannings
operationId: Delete plannings
description: |-
Deletes all plannings for a user within a date/time range.
*Privilege required: `Api: Planning management`*
x-resource: Plannings
tags:
- Time
parameters:
- name: userId
in: query
description: ""
required: true
example: 00000000-0000-0000-0000-000000000000
schema:
type: string
- name: fromDate
in: query
description: ""
required: true
example: 2019-01-25T08:00:00
schema:
type: string
- name: toDate
in: query
description: ""
required: true
example: 2019-01-25T17:00:00
schema:
type: string
security:
- pat: []
/api/v3/planning:
put:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Data:
properties:
Id:
type: string
User:
type: object
properties:
Id:
type: string
Code:
description: (default = null)
nullable: true
type: string
Name:
type: string
Type:
type: number
x-enum-type: IntelliTracer.Domain.ResourceType
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
description: (default = 0)
required:
- Id
- Name
Resource:
properties:
Id:
type: string
Code:
description: (default = null)
nullable: true
type: string
Name:
type: string
Type:
type: number
x-enum-type: IntelliTracer.Domain.ResourceType
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
description: (default = 0)
required:
- Id
- Name
nullable: true
type: object
FromDateUtc:
type: string
ToDateUtc:
type: string
BreakTime:
type: string
description: (default = null)
Description:
description: (default = null)
nullable: true
type: string
ActivityNumber:
description: (default = null)
nullable: true
type: string
Poi:
properties:
Id:
type: string
Name:
type: string
Code:
description: (default = null)
nullable: true
type: string
required:
- Id
- Name
nullable: true
type: object
required:
- Id
- User
- FromDateUtc
- ToDateUtc
description: (default = null)
nullable: true
type: object
examples:
response:
value:
Data:
Id: 00000000-0000-0000-0000-000000000000
User:
Id: 00000000-0000-0000-0000-000000000000
Code: "012345"
Name: John Doe
Type: 0
Resource:
Id: 00000000-0000-0000-0000-000000000000
Code: "012345"
Name: John Doe
Type: 0
FromDateUtc: 2019-01-25T08:00:00
ToDateUtc: 2019-01-25T08:00:00
BreakTime: 01:00:00
Description: "012345"
ActivityNumber: 2023/0017
Poi:
Id: 00000000-0000-0000-0000-000000000000
Name: Work
Code: "012345"
"400":
description: BadRequest
headers: {}
content:
application/json:
schema:
type: object
properties:
Entity:
type: object
properties:
Id:
type: string
User:
type: object
properties:
Id:
type: string
Code:
description: (default = null)
nullable: true
type: string
Name:
type: string
Type:
type: number
x-enum-type: IntelliTracer.Domain.ResourceType
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
description: (default = 0)
required:
- Id
- Name
Resource:
properties:
Id:
type: string
Code:
description: (default = null)
nullable: true
type: string
Name:
type: string
Type:
type: number
x-enum-type: IntelliTracer.Domain.ResourceType
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
description: (default = 0)
required:
- Id
- Name
nullable: true
type: object
FromDateLocal:
type: string
FromDateUtc:
type: string
ToDateLocal:
type: string
ToDateUtc:
type: string
BreakTime:
type: string
description: (default = null)
Description:
description: (default = null)
nullable: true
type: string
Poi:
properties:
Id:
type: string
Name:
type: string
Code:
description: (default = null)
nullable: true
type: string
required:
- Id
- Name
nullable: true
type: object
required:
- Id
- User
- FromDateLocal
- FromDateUtc
- ToDateLocal
- ToDateUtc
ValidationResult:
type: array
items: {}
required:
- Entity
- ValidationResult
examples:
response:
value:
Entity:
Id: 00000000-0000-0000-0000-000000000000
User:
Id: 00000000-0000-0000-0000-000000000000
Code: "012345"
Name: John Doe
Type: 0
Resource:
Id: 00000000-0000-0000-0000-000000000000
Code: "012345"
Name: John Doe
Type: 0
FromDateLocal: 2019-01-25T10:00:00
FromDateUtc: 2019-01-25T08:00:00
ToDateLocal: 2019-01-25T10:00:00
ToDateUtc: 2019-01-25T08:00:00
BreakTime: 01:00:00
Description: "012345"
Poi:
Id: 00000000-0000-0000-0000-000000000000
Name: Work
Code: "012345"
ValidationResult:
- Message: ""
SourceMemberNames: []
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Create planning
operationId: Create planning
description: |-
Creates a new planning for the given resource.
*Privilege required: `Api: Planning management`*
x-resource: Plannings
tags:
- Time
requestBody:
content:
application/json:
schema:
type: object
properties:
Id:
type: string
UserId:
type: string
ResourceId:
description: (default = null)
nullable: true
type: string
FromDateUtc:
type: string
ToDateUtc:
type: string
BreakTime:
type: string
description: (default = null)
Description:
description: (default = null)
nullable: true
type: string
ActivityNumber:
description: (default = null)
nullable: true
type: string
PoiId:
description: (default = null)
nullable: true
type: string
required:
- UserId
- FromDateUtc
- ToDateUtc
example:
Id: 00000000-0000-0000-0000-000000000000
UserId: 00000000-0000-0000-0000-000000000000
ResourceId: 00000000-0000-0000-0000-000000000000
FromDateUtc: 2019-01-25T08:00:00
ToDateUtc: 2019-01-25T08:00:00
BreakTime: 01:00:00
Description: "012345"
ActivityNumber: 2023/0017
PoiId: 00000000-0000-0000-0000-000000000000
security:
- pat: []
post:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Data:
properties:
Id:
type: string
User:
type: object
properties:
Id:
type: string
Code:
description: (default = null)
nullable: true
type: string
Name:
type: string
Type:
type: number
x-enum-type: IntelliTracer.Domain.ResourceType
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
description: (default = 0)
required:
- Id
- Name
Resource:
properties:
Id:
type: string
Code:
description: (default = null)
nullable: true
type: string
Name:
type: string
Type:
type: number
x-enum-type: IntelliTracer.Domain.ResourceType
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
description: (default = 0)
required:
- Id
- Name
nullable: true
type: object
FromDateUtc:
type: string
ToDateUtc:
type: string
BreakTime:
type: string
description: (default = null)
Description:
description: (default = null)
nullable: true
type: string
ActivityNumber:
description: (default = null)
nullable: true
type: string
Poi:
properties:
Id:
type: string
Name:
type: string
Code:
description: (default = null)
nullable: true
type: string
required:
- Id
- Name
nullable: true
type: object
required:
- Id
- User
- FromDateUtc
- ToDateUtc
description: (default = null)
nullable: true
type: object
examples:
response:
value:
Data:
Id: 00000000-0000-0000-0000-000000000000
User:
Id: 00000000-0000-0000-0000-000000000000
Code: "012345"
Name: John Doe
Type: 0
Resource:
Id: 00000000-0000-0000-0000-000000000000
Code: "012345"
Name: John Doe
Type: 0
FromDateUtc: 2019-01-25T08:00:00
ToDateUtc: 2019-01-25T08:00:00
BreakTime: 01:00:00
Description: "012345"
ActivityNumber: 2023/0017
Poi:
Id: 00000000-0000-0000-0000-000000000000
Name: Work
Code: "012345"
"400":
description: BadRequest
headers: {}
content:
application/json:
schema:
type: object
properties:
Entity:
type: object
properties:
Id:
type: string
User:
type: object
properties:
Id:
type: string
Code:
description: (default = null)
nullable: true
type: string
Name:
type: string
Type:
type: number
x-enum-type: IntelliTracer.Domain.ResourceType
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
description: (default = 0)
required:
- Id
- Name
Resource:
properties:
Id:
type: string
Code:
description: (default = null)
nullable: true
type: string
Name:
type: string
Type:
type: number
x-enum-type: IntelliTracer.Domain.ResourceType
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
description: (default = 0)
required:
- Id
- Name
nullable: true
type: object
FromDateLocal:
type: string
FromDateUtc:
type: string
ToDateLocal:
type: string
ToDateUtc:
type: string
BreakTime:
type: string
description: (default = null)
Description:
description: (default = null)
nullable: true
type: string
Poi:
properties:
Id:
type: string
Name:
type: string
Code:
description: (default = null)
nullable: true
type: string
required:
- Id
- Name
nullable: true
type: object
required:
- Id
- User
- FromDateLocal
- FromDateUtc
- ToDateLocal
- ToDateUtc
ValidationResult:
type: array
items: {}
required:
- Entity
- ValidationResult
examples:
response:
value:
Entity:
Id: 00000000-0000-0000-0000-000000000000
User:
Id: 00000000-0000-0000-0000-000000000000
Code: "012345"
Name: John Doe
Type: 0
Resource:
Id: 00000000-0000-0000-0000-000000000000
Code: "012345"
Name: John Doe
Type: 0
FromDateLocal: 2019-01-25T10:00:00
FromDateUtc: 2019-01-25T08:00:00
ToDateLocal: 2019-01-25T10:00:00
ToDateUtc: 2019-01-25T08:00:00
BreakTime: 01:00:00
Description: "012345"
Poi:
Id: 00000000-0000-0000-0000-000000000000
Name: Work
Code: "012345"
ValidationResult:
- Message: ""
SourceMemberNames: []
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Edit planning
operationId: Edit planning
description: |-
Edit a planning with given id.
*Privilege required: `Api: Planning management`*
x-resource: Plannings
tags:
- Time
requestBody:
content:
application/json:
schema:
type: object
properties:
Id:
type: string
UserId:
type: string
ResourceId:
description: (default = null)
nullable: true
type: string
FromDateUtc:
type: string
ToDateUtc:
type: string
BreakTime:
type: string
description: (default = null)
Description:
description: (default = null)
nullable: true
type: string
ActivityNumber:
description: (default = null)
nullable: true
type: string
PoiId:
description: (default = null)
nullable: true
type: string
required:
- Id
- UserId
- FromDateUtc
- ToDateUtc
example:
Id: 00000000-0000-0000-0000-000000000000
UserId: 00000000-0000-0000-0000-000000000000
ResourceId: 00000000-0000-0000-0000-000000000000
FromDateUtc: 2019-01-25T08:00:00
ToDateUtc: 2019-01-25T08:00:00
BreakTime: 01:00:00
Description: "012345"
ActivityNumber: 2023/0017
PoiId: 00000000-0000-0000-0000-000000000000
security:
- pat: []
"/api/v2/planning/{id}":
delete:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Data:
properties:
Id:
type: string
User:
type: object
properties:
Id:
type: string
Code:
description: (default = null)
nullable: true
type: string
Name:
type: string
Type:
type: number
x-enum-type: IntelliTracer.Domain.ResourceType
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
description: (default = 0)
required:
- Id
- Name
Resource:
properties:
Id:
type: string
Code:
description: (default = null)
nullable: true
type: string
Name:
type: string
Type:
type: number
x-enum-type: IntelliTracer.Domain.ResourceType
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
description: (default = 0)
required:
- Id
- Name
nullable: true
type: object
FromDateLocal:
type: string
FromDateUtc:
type: string
ToDateLocal:
type: string
ToDateUtc:
type: string
BreakTime:
type: string
description: (default = null)
Description:
description: (default = null)
nullable: true
type: string
Poi:
properties:
Id:
type: string
Name:
type: string
Code:
description: (default = null)
nullable: true
type: string
required:
- Id
- Name
nullable: true
type: object
required:
- Id
- User
- FromDateLocal
- FromDateUtc
- ToDateLocal
- ToDateUtc
description: (default = null)
nullable: true
type: object
examples:
response:
value:
Data:
Id: 00000000-0000-0000-0000-000000000000
User:
Id: 00000000-0000-0000-0000-000000000000
Code: "012345"
Name: John Doe
Type: 0
Resource:
Id: 00000000-0000-0000-0000-000000000000
Code: "012345"
Name: John Doe
Type: 0
FromDateLocal: 2019-01-25T10:00:00
FromDateUtc: 2019-01-25T08:00:00
ToDateLocal: 2019-01-25T10:00:00
ToDateUtc: 2019-01-25T08:00:00
BreakTime: 01:00:00
Description: "012345"
Poi:
Id: 00000000-0000-0000-0000-000000000000
Name: Work
Code: "012345"
"400":
description: BadRequest
headers: {}
content:
application/json:
schema:
type: object
properties:
Entity:
type: object
properties:
Id:
type: string
User:
type: object
properties:
Id:
type: string
Code:
description: (default = null)
nullable: true
type: string
Name:
type: string
Type:
type: number
x-enum-type: IntelliTracer.Domain.ResourceType
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
description: (default = 0)
required:
- Id
- Name
Resource:
properties:
Id:
type: string
Code:
description: (default = null)
nullable: true
type: string
Name:
type: string
Type:
type: number
x-enum-type: IntelliTracer.Domain.ResourceType
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
description: (default = 0)
required:
- Id
- Name
nullable: true
type: object
FromDateLocal:
type: string
FromDateUtc:
type: string
ToDateLocal:
type: string
ToDateUtc:
type: string
BreakTime:
type: string
description: (default = null)
Description:
description: (default = null)
nullable: true
type: string
Poi:
properties:
Id:
type: string
Name:
type: string
Code:
description: (default = null)
nullable: true
type: string
required:
- Id
- Name
nullable: true
type: object
required:
- Id
- User
- FromDateLocal
- FromDateUtc
- ToDateLocal
- ToDateUtc
ValidationResult:
type: array
items: {}
required:
- Entity
- ValidationResult
examples:
response:
value:
Entity:
Id: 00000000-0000-0000-0000-000000000000
User:
Id: 00000000-0000-0000-0000-000000000000
Code: "012345"
Name: John Doe
Type: 0
Resource:
Id: 00000000-0000-0000-0000-000000000000
Code: "012345"
Name: John Doe
Type: 0
FromDateLocal: 2019-01-25T10:00:00
FromDateUtc: 2019-01-25T08:00:00
ToDateLocal: 2019-01-25T10:00:00
ToDateUtc: 2019-01-25T08:00:00
BreakTime: 01:00:00
Description: "012345"
Poi:
Id: 00000000-0000-0000-0000-000000000000
Name: Work
Code: "012345"
ValidationResult:
- Message: ""
SourceMemberNames: []
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Delete planning
operationId: Delete planning
description: |-
Deletes a planning by id.
*Privilege required: `Api: Planning management`*
x-resource: Plannings
tags:
- Time
parameters:
- name: id
in: path
description: ""
required: true
example: 00000000-0000-0000-0000-000000000000
schema:
type: string
security:
- pat: []
/api/v1/anomaliesbyuseriddate:
get:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
AnomalyTypes:
description: (default = null)
nullable: true
type: array
items:
$ref: "#/components/schemas/IntelliTracer.ApiV1.PlanningAnomalyType"
WorkedHours:
description: (default = null)
nullable: true
type: string
PlannedHours:
description: (default = null)
nullable: true
type: string
WorkedFrom:
description: (default = null)
nullable: true
type: string
WorkedTo:
description: (default = null)
nullable: true
type: string
_typeDescriptor:
type: string
examples:
response:
value:
AnomalyTypes:
- 6
- 7
WorkedHours: 01:00:00
PlannedHours: 08:00:00
WorkedFrom: 2019-01-24T08:00:00+01:00
WorkedTo: 2019-01-24T09:00:00+01:00
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Get planning anomalies
operationId: Get planning anomalies
description: |-
Returns a list of all planning anomalies for a user on a single day.
*Privilege required: `Api: Planning read` or `Api: Planning management`*
x-resource: Planning anomalies
tags:
- Time
parameters:
- name: userId
in: query
description: ""
required: true
example: 00000000-0000-0000-0000-000000000000
schema:
type: string
- name: year
in: query
description: ""
required: true
example: "2019"
schema:
type: number
- name: month
in: query
description: ""
required: true
example: "1"
schema:
type: number
- name: day
in: query
description: ""
required: true
example: "25"
schema:
type: number
security:
- pat: []
"/api/v2/asset?page={page}&search={search}":
get:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Data:
nullable: true
type: array
items: {}
PagingFilter:
properties:
Page:
type: number
Search:
nullable: true
type: string
PageCount:
type: number
TotalCount:
type: number
Links:
type: object
properties:
Base:
type: string
First:
type: string
Prev:
type: string
Next:
type: string
Last:
type: string
required:
- Base
required:
- Page
- PageCount
- TotalCount
- Links
nullable: true
type: object
examples:
response:
value:
Data:
- Id: 00000000-0000-0000-0000-000000000000
Name: Work
Code: "012345"
Type: "012345"
Brand: "012345"
TypeNumber: "012345"
SerialNumber: "012345"
Description: "012345"
Quantity: 1
CommissioningDate: 2019-01-25T07:29:37
Category: 0
AdministrativeLocations:
- Location:
Id: 00000000-0000-0000-0000-000000000000
Name: Work
Code: "012345"
Country: 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))
HouseNumber: "9"
LonMin: 3.145219
LonMax: 3.244998
LatMin: 50.81309
LatMax: 50.91806
MarkerLon: 3.145219
MarkerLat: 50.81309
IsAssetLocation: false
PostalCode: "8500"
Street: Dumolinlaan
Submunicipality: Kortrijk
City: Kortrijk
Quantity: 1
LastSeen:
Address: Dumolinlaan 9, 8500 Kortrijk, BE
DateTime: 2019-01-25T08:29:37+02:00
DetectedBy: Vehicle 1
Picture: https://prodassetmanagement.blob.core.windows.net/geodynamics-899192c530d46fde13b9164f2ea1253d/assets/3022e805-e786-4564-b561-0685920de8dd.jpg
Responsible:
Id: 00000000-0000-0000-0000-000000000000
Code: "012345"
Name: John Doe
Type: 0
CreatedOn: 2019-01-25T08:29:37+02:00
PagingFilter:
Page: 1
Search: ABC
PageCount: 4
TotalCount: 100
Links:
Base: https://api.intellitracer.be
First: /api/v2/asset?page=1
Prev: /api/v2/asset?page=2
Next: /api/v2/asset?page=4
Last: /api/v2/asset?page=4
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Get assets
operationId: Get assets
description: |-
Returns a paged list of assets.
Pagination and searching is explained in [Pagination](#pagination).
*Privilege required: `Api: Asset management`*
x-resource: Assets
tags:
- Assets
parameters:
- name: page
in: path
description: ""
required: true
example: "1"
schema:
type: number
- name: search
in: path
description: ""
required: true
example: ABC
schema:
type: string
security:
- pat: []
"/api/v2/asset/{id}":
get:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Data:
properties:
Id:
type: string
Name:
type: string
Code:
description: (default = null)
nullable: true
type: string
Type:
description: (default = null)
nullable: true
type: string
Brand:
description: (default = null)
nullable: true
type: string
TypeNumber:
description: (default = null)
nullable: true
type: string
SerialNumber:
description: (default = null)
nullable: true
type: string
Description:
description: (default = null)
nullable: true
type: string
Quantity:
description: (default = `1`)
nullable: true
type: number
CommissioningDate:
description: (default = null)
nullable: true
type: string
Category:
x-enum-type: IntelliTracer.ApiV1.AssetCategory
enum:
- 0
- 1
- null
description: (default = null)
nullable: true
type: number
AdministrativeLocations:
description: "(default = null) "
nullable: true
type: array
items: {}
LastSeen:
properties:
Address:
type: string
DateTime:
type: string
DetectedBy:
type: string
required:
- Address
- DateTime
- DetectedBy
description: (default = null)
nullable: true
type: object
Picture:
description: (default = null)
nullable: true
type: string
Responsible:
properties:
Id:
type: string
Code:
description: (default = null)
nullable: true
type: string
Name:
type: string
Type:
type: number
x-enum-type: IntelliTracer.Domain.ResourceType
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
description: (default = 0)
required:
- Id
- Name
description: (default = null)
nullable: true
type: object
CreatedOn:
nullable: true
type: string
required:
- Id
description: (default = null)
nullable: true
type: object
examples:
response:
value:
Data:
Id: 00000000-0000-0000-0000-000000000000
Name: Work
Code: "012345"
Type: "012345"
Brand: "012345"
TypeNumber: "012345"
SerialNumber: "012345"
Description: "012345"
Quantity: 1
CommissioningDate: 2019-01-25T07:29:37
Category: 0
AdministrativeLocations:
- Location:
Id: 00000000-0000-0000-0000-000000000000
Name: Work
Code: "012345"
Country: 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))
HouseNumber: "9"
LonMin: 3.145219
LonMax: 3.244998
LatMin: 50.81309
LatMax: 50.91806
MarkerLon: 3.145219
MarkerLat: 50.81309
IsAssetLocation: false
PostalCode: "8500"
Street: Dumolinlaan
Submunicipality: Kortrijk
City: Kortrijk
Quantity: 1
LastSeen:
Address: Dumolinlaan 9, 8500 Kortrijk, BE
DateTime: 2019-01-25T08:29:37+02:00
DetectedBy: Vehicle 1
Picture: https://prodassetmanagement.blob.core.windows.net/geodynamics-899192c530d46fde13b9164f2ea1253d/assets/3022e805-e786-4564-b561-0685920de8dd.jpg
Responsible:
Id: 00000000-0000-0000-0000-000000000000
Code: "012345"
Name: John Doe
Type: 0
CreatedOn: 2019-01-25T08:29:37+02:00
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"404":
description: NotFound
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Get asset by Id
operationId: Get asset by Id
description: |-
Returns an asset by its Id.
*Privilege required: `Api: Asset management`*
x-resource: Assets
tags:
- Assets
parameters:
- name: id
in: path
description: ""
required: true
example: 00000000-0000-0000-0000-000000000000
schema:
type: string
security:
- pat: []
delete:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Data:
properties:
Id:
type: string
Name:
type: string
Code:
description: (default = null)
nullable: true
type: string
Type:
description: (default = null)
nullable: true
type: string
Brand:
description: (default = null)
nullable: true
type: string
TypeNumber:
description: (default = null)
nullable: true
type: string
SerialNumber:
description: (default = null)
nullable: true
type: string
Description:
description: (default = null)
nullable: true
type: string
Quantity:
description: (default = `1`)
nullable: true
type: number
CommissioningDate:
description: (default = null)
nullable: true
type: string
Category:
x-enum-type: IntelliTracer.ApiV1.AssetCategory
enum:
- 0
- 1
- null
description: (default = null)
nullable: true
type: number
AdministrativeLocations:
description: "(default = null) "
nullable: true
type: array
items: {}
LastSeen:
properties:
Address:
type: string
DateTime:
type: string
DetectedBy:
type: string
required:
- Address
- DateTime
- DetectedBy
description: (default = null)
nullable: true
type: object
Picture:
description: (default = null)
nullable: true
type: string
Responsible:
properties:
Id:
type: string
Code:
description: (default = null)
nullable: true
type: string
Name:
type: string
Type:
type: number
x-enum-type: IntelliTracer.Domain.ResourceType
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
description: (default = 0)
required:
- Id
- Name
description: (default = null)
nullable: true
type: object
CreatedOn:
nullable: true
type: string
required:
- Id
description: (default = null)
nullable: true
type: object
examples:
response:
value:
Data:
Id: 00000000-0000-0000-0000-000000000000
Name: Work
Code: "012345"
Type: "012345"
Brand: "012345"
TypeNumber: "012345"
SerialNumber: "012345"
Description: "012345"
Quantity: 1
CommissioningDate: 2019-01-25T07:29:37
Category: 0
AdministrativeLocations:
- Location:
Id: 00000000-0000-0000-0000-000000000000
Name: Work
Code: "012345"
Country: 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))
HouseNumber: "9"
LonMin: 3.145219
LonMax: 3.244998
LatMin: 50.81309
LatMax: 50.91806
MarkerLon: 3.145219
MarkerLat: 50.81309
IsAssetLocation: false
PostalCode: "8500"
Street: Dumolinlaan
Submunicipality: Kortrijk
City: Kortrijk
Quantity: 1
LastSeen:
Address: Dumolinlaan 9, 8500 Kortrijk, BE
DateTime: 2019-01-25T08:29:37+02:00
DetectedBy: Vehicle 1
Picture: https://prodassetmanagement.blob.core.windows.net/geodynamics-899192c530d46fde13b9164f2ea1253d/assets/3022e805-e786-4564-b561-0685920de8dd.jpg
Responsible:
Id: 00000000-0000-0000-0000-000000000000
Code: "012345"
Name: John Doe
Type: 0
CreatedOn: 2019-01-25T08:29:37+02:00
"400":
description: BadRequest
headers: {}
content:
application/json:
schema:
type: object
properties:
Entity:
type: object
properties:
Id:
type: string
Name:
type: string
Code:
description: (default = null)
nullable: true
type: string
Type:
description: (default = null)
nullable: true
type: string
Brand:
description: (default = null)
nullable: true
type: string
TypeNumber:
description: (default = null)
nullable: true
type: string
SerialNumber:
description: (default = null)
nullable: true
type: string
Description:
description: (default = null)
nullable: true
type: string
Quantity:
description: (default = `1`)
nullable: true
type: number
CommissioningDate:
description: (default = null)
nullable: true
type: string
Category:
x-enum-type: IntelliTracer.ApiV1.AssetCategory
enum:
- 0
- 1
- null
description: (default = null)
nullable: true
type: number
AdministrativeLocations:
description: "(default = null) "
nullable: true
type: array
items: {}
LastSeen:
properties:
Address:
type: string
DateTime:
type: string
DetectedBy:
type: string
required:
- Address
- DateTime
- DetectedBy
description: (default = null)
nullable: true
type: object
Picture:
description: (default = null)
nullable: true
type: string
Responsible:
properties:
Id:
type: string
Code:
description: (default = null)
nullable: true
type: string
Name:
type: string
Type:
type: number
x-enum-type: IntelliTracer.Domain.ResourceType
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
description: (default = 0)
required:
- Id
- Name
description: (default = null)
nullable: true
type: object
CreatedOn:
nullable: true
type: string
required:
- Id
ValidationResult:
type: array
items: {}
required:
- Entity
- ValidationResult
examples:
response:
value:
Entity:
Id: 00000000-0000-0000-0000-000000000000
Name: Work
Code: "012345"
Type: "012345"
Brand: "012345"
TypeNumber: "012345"
SerialNumber: "012345"
Description: "012345"
Quantity: 1
CommissioningDate: 2019-01-25T07:29:37
Category: 0
AdministrativeLocations:
- Location:
Id: 00000000-0000-0000-0000-000000000000
Name: Work
Code: "012345"
Country: 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))
HouseNumber: "9"
LonMin: 3.145219
LonMax: 3.244998
LatMin: 50.81309
LatMax: 50.91806
MarkerLon: 3.145219
MarkerLat: 50.81309
IsAssetLocation: false
PostalCode: "8500"
Street: Dumolinlaan
Submunicipality: Kortrijk
City: Kortrijk
Quantity: 1
LastSeen:
Address: Dumolinlaan 9, 8500 Kortrijk, BE
DateTime: 2019-01-25T08:29:37+02:00
DetectedBy: Vehicle 1
Picture: https://prodassetmanagement.blob.core.windows.net/geodynamics-899192c530d46fde13b9164f2ea1253d/assets/3022e805-e786-4564-b561-0685920de8dd.jpg
Responsible:
Id: 00000000-0000-0000-0000-000000000000
Code: "012345"
Name: John Doe
Type: 0
CreatedOn: 2019-01-25T08:29:37+02:00
ValidationResult:
- Message: ""
SourceMemberNames: []
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Delete asset
operationId: Delete asset
description: |-
Deletes an asset by its Id.
*Privilege required: `Api: Asset management`*
x-resource: Assets
tags:
- Assets
parameters:
- name: id
in: path
description: ""
required: true
example: 00000000-0000-0000-0000-000000000000
schema:
type: string
security:
- pat: []
/api/v2/asset:
put:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Data:
properties:
Id:
type: string
Name:
type: string
Code:
description: (default = null)
nullable: true
type: string
Type:
description: (default = null)
nullable: true
type: string
Brand:
description: (default = null)
nullable: true
type: string
TypeNumber:
description: (default = null)
nullable: true
type: string
SerialNumber:
description: (default = null)
nullable: true
type: string
Description:
description: (default = null)
nullable: true
type: string
Quantity:
description: (default = `1`)
nullable: true
type: number
CommissioningDate:
description: (default = null)
nullable: true
type: string
Category:
x-enum-type: IntelliTracer.ApiV1.AssetCategory
enum:
- 0
- 1
- null
description: (default = null)
nullable: true
type: number
AdministrativeLocations:
description: "(default = null) "
nullable: true
type: array
items: {}
LastSeen:
properties:
Address:
type: string
DateTime:
type: string
DetectedBy:
type: string
required:
- Address
- DateTime
- DetectedBy
description: (default = null)
nullable: true
type: object
Picture:
description: (default = null)
nullable: true
type: string
Responsible:
properties:
Id:
type: string
Code:
description: (default = null)
nullable: true
type: string
Name:
type: string
Type:
type: number
x-enum-type: IntelliTracer.Domain.ResourceType
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
description: (default = 0)
required:
- Id
- Name
description: (default = null)
nullable: true
type: object
CreatedOn:
nullable: true
type: string
required:
- Id
description: (default = null)
nullable: true
type: object
examples:
response:
value:
Data:
Id: 00000000-0000-0000-0000-000000000000
Name: Work
Code: "012345"
Type: "012345"
Brand: "012345"
TypeNumber: "012345"
SerialNumber: "012345"
Description: "012345"
Quantity: 1
CommissioningDate: 2019-01-25T07:29:37
Category: 0
AdministrativeLocations:
- Location:
Id: 00000000-0000-0000-0000-000000000000
Name: Work
Code: "012345"
Country: 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))
HouseNumber: "9"
LonMin: 3.145219
LonMax: 3.244998
LatMin: 50.81309
LatMax: 50.91806
MarkerLon: 3.145219
MarkerLat: 50.81309
IsAssetLocation: false
PostalCode: "8500"
Street: Dumolinlaan
Submunicipality: Kortrijk
City: Kortrijk
Quantity: 1
LastSeen:
Address: Dumolinlaan 9, 8500 Kortrijk, BE
DateTime: 2019-01-25T08:29:37+02:00
DetectedBy: Vehicle 1
Picture: https://prodassetmanagement.blob.core.windows.net/geodynamics-899192c530d46fde13b9164f2ea1253d/assets/3022e805-e786-4564-b561-0685920de8dd.jpg
Responsible:
Id: 00000000-0000-0000-0000-000000000000
Code: "012345"
Name: John Doe
Type: 0
CreatedOn: 2019-01-25T08:29:37+02:00
"400":
description: BadRequest
headers: {}
content:
application/json:
schema:
$ref: "#/components/schemas/IntelliTracer.ApiV1.PoiValidationResult"
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Create asset
operationId: Create asset
description: |-
Creates a new asset.
*Privilege required: `Api: Asset management`*
x-resource: Assets
tags:
- Assets
requestBody:
content:
application/json:
schema:
type: object
properties:
Name:
type: string
Code:
description: (default = null)
nullable: true
type: string
Type:
description: (default = null)
nullable: true
type: string
Brand:
description: (default = null)
nullable: true
type: string
TypeNumber:
description: (default = null)
nullable: true
type: string
SerialNumber:
description: (default = null)
nullable: true
type: string
Description:
description: (default = null)
nullable: true
type: string
Category:
x-enum-type: IntelliTracer.ApiV1.AssetCategory
enum:
- 0
- 1
- null
nullable: true
type: number
Quantity:
description: (default = `1`)
nullable: true
type: number
CommissioningDate:
description: (default = null)
nullable: true
type: string
_typeDescriptor:
type: string
required:
- Name
example:
Name: Work
Code: "012345"
Type: "012345"
Brand: "012345"
TypeNumber: "012345"
SerialNumber: "012345"
Description: "012345"
Category: 0
Quantity: 1
CommissioningDate: 2019-01-25T07:29:37
security:
- pat: []
post:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Data:
properties:
Id:
type: string
Name:
type: string
Code:
description: (default = null)
nullable: true
type: string
Type:
description: (default = null)
nullable: true
type: string
Brand:
description: (default = null)
nullable: true
type: string
TypeNumber:
description: (default = null)
nullable: true
type: string
SerialNumber:
description: (default = null)
nullable: true
type: string
Description:
description: (default = null)
nullable: true
type: string
Quantity:
description: (default = `1`)
nullable: true
type: number
CommissioningDate:
description: (default = null)
nullable: true
type: string
Category:
x-enum-type: IntelliTracer.ApiV1.AssetCategory
enum:
- 0
- 1
- null
description: (default = null)
nullable: true
type: number
AdministrativeLocations:
description: "(default = null) "
nullable: true
type: array
items: {}
LastSeen:
properties:
Address:
type: string
DateTime:
type: string
DetectedBy:
type: string
required:
- Address
- DateTime
- DetectedBy
description: (default = null)
nullable: true
type: object
Picture:
description: (default = null)
nullable: true
type: string
Responsible:
properties:
Id:
type: string
Code:
description: (default = null)
nullable: true
type: string
Name:
type: string
Type:
type: number
x-enum-type: IntelliTracer.Domain.ResourceType
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
description: (default = 0)
required:
- Id
- Name
description: (default = null)
nullable: true
type: object
CreatedOn:
nullable: true
type: string
required:
- Id
description: (default = null)
nullable: true
type: object
examples:
response:
value:
Data:
Id: 00000000-0000-0000-0000-000000000000
Name: Work
Code: "012345"
Type: "012345"
Brand: "012345"
TypeNumber: "012345"
SerialNumber: "012345"
Description: "012345"
Quantity: 1
CommissioningDate: 2019-01-25T07:29:37
Category: 0
AdministrativeLocations:
- Location:
Id: 00000000-0000-0000-0000-000000000000
Name: Work
Code: "012345"
Country: 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))
HouseNumber: "9"
LonMin: 3.145219
LonMax: 3.244998
LatMin: 50.81309
LatMax: 50.91806
MarkerLon: 3.145219
MarkerLat: 50.81309
IsAssetLocation: false
PostalCode: "8500"
Street: Dumolinlaan
Submunicipality: Kortrijk
City: Kortrijk
Quantity: 1
LastSeen:
Address: Dumolinlaan 9, 8500 Kortrijk, BE
DateTime: 2019-01-25T08:29:37+02:00
DetectedBy: Vehicle 1
Picture: https://prodassetmanagement.blob.core.windows.net/geodynamics-899192c530d46fde13b9164f2ea1253d/assets/3022e805-e786-4564-b561-0685920de8dd.jpg
Responsible:
Id: 00000000-0000-0000-0000-000000000000
Code: "012345"
Name: John Doe
Type: 0
CreatedOn: 2019-01-25T08:29:37+02:00
"400":
description: BadRequest
headers: {}
content:
application/json:
schema:
$ref: "#/components/schemas/IntelliTracer.ApiV2.AssetValidationResult"
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Update asset
operationId: Update asset
description: |-
Updates an asset.
*Privilege required: `Api: Asset management`*
x-resource: Assets
tags:
- Assets
requestBody:
content:
application/json:
schema:
type: object
properties:
Id:
type: string
Name:
type: string
Code:
description: (default = null)
nullable: true
type: string
Type:
description: (default = null)
nullable: true
type: string
Brand:
description: (default = null)
nullable: true
type: string
Type number:
description: (default = null)
nullable: true
type: string
Serial number:
description: (default = null)
nullable: true
type: string
Description:
description: (default = null)
nullable: true
type: string
Category:
x-enum-type: IntelliTracer.ApiV1.AssetCategory
enum:
- 0
- 1
- null
nullable: true
type: number
Quantity:
description: (default = `1`)
nullable: true
type: number
CommissioningDate:
description: (default = null)
nullable: true
type: string
_typeDescriptor:
type: string
required:
- Id
example:
Id: 00000000-0000-0000-0000-000000000000
Name: Work
Code: "012345"
Type: "012345"
Brand: "012345"
Type number: "012345"
Serial number: "012345"
Description: "012345"
Category: 0
Quantity: 1
CommissioningDate: 2019-01-25T07:29:37
security:
- pat: []
"/api/v2/asset/{assetId}/responsible/{userId}":
put:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Data:
properties:
Id:
type: string
Name:
type: string
Code:
description: (default = null)
nullable: true
type: string
Type:
description: (default = null)
nullable: true
type: string
Brand:
description: (default = null)
nullable: true
type: string
TypeNumber:
description: (default = null)
nullable: true
type: string
SerialNumber:
description: (default = null)
nullable: true
type: string
Description:
description: (default = null)
nullable: true
type: string
Quantity:
description: (default = `1`)
nullable: true
type: number
CommissioningDate:
description: (default = null)
nullable: true
type: string
Category:
x-enum-type: IntelliTracer.ApiV1.AssetCategory
enum:
- 0
- 1
- null
description: (default = null)
nullable: true
type: number
AdministrativeLocations:
description: "(default = null) "
nullable: true
type: array
items: {}
LastSeen:
properties:
Address:
type: string
DateTime:
type: string
DetectedBy:
type: string
required:
- Address
- DateTime
- DetectedBy
description: (default = null)
nullable: true
type: object
Picture:
description: (default = null)
nullable: true
type: string
Responsible:
properties:
Id:
type: string
Code:
description: (default = null)
nullable: true
type: string
Name:
type: string
Type:
type: number
x-enum-type: IntelliTracer.Domain.ResourceType
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
description: (default = 0)
required:
- Id
- Name
description: (default = null)
nullable: true
type: object
CreatedOn:
nullable: true
type: string
required:
- Id
description: (default = null)
nullable: true
type: object
examples:
response:
value:
Data:
Id: 00000000-0000-0000-0000-000000000000
Name: Work
Code: "012345"
Type: "012345"
Brand: "012345"
TypeNumber: "012345"
SerialNumber: "012345"
Description: "012345"
Quantity: 1
CommissioningDate: 2019-01-25T07:29:37
Category: 0
AdministrativeLocations:
- Location:
Id: 00000000-0000-0000-0000-000000000000
Name: Work
Code: "012345"
Country: 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))
HouseNumber: "9"
LonMin: 3.145219
LonMax: 3.244998
LatMin: 50.81309
LatMax: 50.91806
MarkerLon: 3.145219
MarkerLat: 50.81309
IsAssetLocation: false
PostalCode: "8500"
Street: Dumolinlaan
Submunicipality: Kortrijk
City: Kortrijk
Quantity: 1
LastSeen:
Address: Dumolinlaan 9, 8500 Kortrijk, BE
DateTime: 2019-01-25T08:29:37+02:00
DetectedBy: Vehicle 1
Picture: https://prodassetmanagement.blob.core.windows.net/geodynamics-899192c530d46fde13b9164f2ea1253d/assets/3022e805-e786-4564-b561-0685920de8dd.jpg
Responsible:
Id: 00000000-0000-0000-0000-000000000000
Code: "012345"
Name: John Doe
Type: 0
CreatedOn: 2019-01-25T08:29:37+02:00
"400":
description: Bad Request
headers: {}
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Link responsible user to asset
operationId: Link responsible user to asset
description: |-
Links a responsible user to an asset by id.
*Privilege required: `Api: Asset management`*
x-resource: Asset - Link/Unlink responsible
tags:
- Assets
parameters:
- name: assetId
in: path
description: ""
required: true
example: 00000000-0000-0000-0000-000000000000
schema:
type: string
- name: userId
in: path
description: ""
required: true
example: 00000000-0000-0000-0000-000000000000
schema:
type: string
security:
- pat: []
"/api/v2/asset/{assetId}/responsible":
delete:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Data:
properties:
Id:
type: string
Name:
type: string
Code:
description: (default = null)
nullable: true
type: string
Type:
description: (default = null)
nullable: true
type: string
Brand:
description: (default = null)
nullable: true
type: string
TypeNumber:
description: (default = null)
nullable: true
type: string
SerialNumber:
description: (default = null)
nullable: true
type: string
Description:
description: (default = null)
nullable: true
type: string
Quantity:
description: (default = `1`)
nullable: true
type: number
CommissioningDate:
description: (default = null)
nullable: true
type: string
Category:
x-enum-type: IntelliTracer.ApiV1.AssetCategory
enum:
- 0
- 1
- null
description: (default = null)
nullable: true
type: number
AdministrativeLocations:
description: "(default = null) "
nullable: true
type: array
items: {}
LastSeen:
properties:
Address:
type: string
DateTime:
type: string
DetectedBy:
type: string
required:
- Address
- DateTime
- DetectedBy
description: (default = null)
nullable: true
type: object
Picture:
description: (default = null)
nullable: true
type: string
Responsible:
properties:
Id:
type: string
Code:
description: (default = null)
nullable: true
type: string
Name:
type: string
Type:
type: number
x-enum-type: IntelliTracer.Domain.ResourceType
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
description: (default = 0)
required:
- Id
- Name
description: (default = null)
nullable: true
type: object
CreatedOn:
nullable: true
type: string
required:
- Id
description: (default = null)
nullable: true
type: object
examples:
response:
value:
Data:
Id: 00000000-0000-0000-0000-000000000000
Name: Work
Code: "012345"
Type: "012345"
Brand: "012345"
TypeNumber: "012345"
SerialNumber: "012345"
Description: "012345"
Quantity: 1
CommissioningDate: 2019-01-25T07:29:37
Category: 0
AdministrativeLocations:
- Location:
Id: 00000000-0000-0000-0000-000000000000
Name: Work
Code: "012345"
Country: 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))
HouseNumber: "9"
LonMin: 3.145219
LonMax: 3.244998
LatMin: 50.81309
LatMax: 50.91806
MarkerLon: 3.145219
MarkerLat: 50.81309
IsAssetLocation: false
PostalCode: "8500"
Street: Dumolinlaan
Submunicipality: Kortrijk
City: Kortrijk
Quantity: 1
LastSeen:
Address: Dumolinlaan 9, 8500 Kortrijk, BE
DateTime: 2019-01-25T08:29:37+02:00
DetectedBy: Vehicle 1
Picture: https://prodassetmanagement.blob.core.windows.net/geodynamics-899192c530d46fde13b9164f2ea1253d/assets/3022e805-e786-4564-b561-0685920de8dd.jpg
Responsible:
Id: 00000000-0000-0000-0000-000000000000
Code: "012345"
Name: John Doe
Type: 0
CreatedOn: 2019-01-25T08:29:37+02:00
"400":
description: Bad Request
headers: {}
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Unlink responsible user from asset
operationId: Unlink responsible user from asset
description: |-
Unlinks a responsible user from an asset by id.
*Privilege required: `Api: Asset management`*
x-resource: Asset - Link/Unlink responsible
tags:
- Assets
parameters:
- name: assetId
in: path
description: ""
required: true
example: 00000000-0000-0000-0000-000000000000
schema:
type: string
security:
- pat: []
"/api/v2/asset/{id}/mutation?page={page}&search={search}":
get:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Data:
description: (default = null)
nullable: true
type: array
items: {}
PagingFilter:
properties:
Page:
type: number
Search:
nullable: true
type: string
PageCount:
type: number
TotalCount:
type: number
Links:
type: object
properties:
Base:
type: string
First:
type: string
Prev:
type: string
Next:
type: string
Last:
type: string
required:
- Base
required:
- Page
- PageCount
- TotalCount
- Links
description: (default = null)
nullable: true
type: object
examples:
response:
value:
Data:
- TimeStamp: 2019-01-25T08:06:45+01:00
Asset:
Id: 00000000-0000-0000-0000-000000000000
Name: Work
Code: "012345"
Type: "012345"
Brand: "012345"
TypeNumber: "012345"
SerialNumber: "012345"
Description: "012345"
Quantity: 1
CommissioningDate: 2019-01-25T07:29:37
Category: 0
AdministrativeLocations:
- Location:
Id: 00000000-0000-0000-0000-000000000000
Name: Work
Code: "012345"
Country: 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))
HouseNumber: "9"
LonMin: 3.145219
LonMax: 3.244998
LatMin: 50.81309
LatMax: 50.91806
MarkerLon: 3.145219
MarkerLat: 50.81309
IsAssetLocation: false
PostalCode: "8500"
Street: Dumolinlaan
Submunicipality: Kortrijk
City: Kortrijk
Quantity: 1
LastSeen:
Address: Dumolinlaan 9, 8500 Kortrijk, BE
DateTime: 2019-01-25T08:29:37+02:00
DetectedBy: Vehicle 1
Picture: https://prodassetmanagement.blob.core.windows.net/geodynamics-899192c530d46fde13b9164f2ea1253d/assets/3022e805-e786-4564-b561-0685920de8dd.jpg
Responsible:
Id: 00000000-0000-0000-0000-000000000000
Code: "012345"
Name: John Doe
Type: 0
CreatedOn: 2019-01-25T08:29:37+02:00
FromLocation:
Id: 00000000-0000-0000-0000-000000000000
Name: Work
Code: "012345"
Country: 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))
HouseNumber: "9"
LonMin: 3.145219
LonMax: 3.244998
LatMin: 50.81309
LatMax: 50.91806
MarkerLon: 3.145219
MarkerLat: 50.81309
IsAssetLocation: false
PostalCode: "8500"
Street: Dumolinlaan
Submunicipality: Kortrijk
City: Kortrijk
ToLocation:
Id: 00000000-0000-0000-0000-000000000000
Name: Work
Code: "012345"
Country: 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))
HouseNumber: "9"
LonMin: 3.145219
LonMax: 3.244998
LatMin: 50.81309
LatMax: 50.91806
MarkerLon: 3.145219
MarkerLat: 50.81309
IsAssetLocation: false
PostalCode: "8500"
Street: Dumolinlaan
Submunicipality: Kortrijk
City: Kortrijk
Quantity: 1
By:
Id: 00000000-0000-0000-0000-000000000000
Code: "012345"
Name: John Doe
Type: 0
PagingFilter:
Page: 1
Search: ABC
PageCount: 4
TotalCount: 100
Links:
Base: https://api.intellitracer.be
First: /api/v2/asset?page=1
Prev: /api/v2/asset?page=2
Next: /api/v2/asset?page=4
Last: /api/v2/asset?page=4
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Get mutations by asset
operationId: Get mutations by asset
description: |-
Returns a paged list of mutations on an asset.
Pagination and searching is explained in [Pagination](#pagination).
*Privilege required: `Api: Asset management`*
x-resource: Asset - Mutations
tags:
- Assets
parameters:
- name: id
in: path
description: ""
required: true
example: 00000000-0000-0000-0000-000000000000
schema:
type: string
- name: page
in: path
description: ""
required: true
example: "1"
schema:
type: number
- name: search
in: path
description: ""
required: true
example: ABC
schema:
type: string
security:
- pat: []
"/api/v2/asset/{id}/mutation":
put:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Data:
properties:
TimeStamp:
type: string
Asset:
type: object
properties:
Id:
type: string
Name:
type: string
Code:
description: (default = null)
nullable: true
type: string
Type:
description: (default = null)
nullable: true
type: string
Brand:
description: (default = null)
nullable: true
type: string
TypeNumber:
description: (default = null)
nullable: true
type: string
SerialNumber:
description: (default = null)
nullable: true
type: string
Description:
description: (default = null)
nullable: true
type: string
Quantity:
description: (default = `1`)
nullable: true
type: number
CommissioningDate:
description: (default = null)
nullable: true
type: string
Category:
x-enum-type: IntelliTracer.ApiV1.AssetCategory
enum:
- 0
- 1
- null
description: (default = null)
nullable: true
type: number
AdministrativeLocations:
description: "(default = null) "
nullable: true
type: array
items: {}
LastSeen:
properties:
Address:
type: string
DateTime:
type: string
DetectedBy:
type: string
required:
- Address
- DateTime
- DetectedBy
description: (default = null)
nullable: true
type: object
Picture:
description: (default = null)
nullable: true
type: string
Responsible:
properties:
Id:
type: string
Code:
description: (default = null)
nullable: true
type: string
Name:
type: string
Type:
type: number
x-enum-type: IntelliTracer.Domain.ResourceType
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
description: (default = 0)
required:
- Id
- Name
description: (default = null)
nullable: true
type: object
CreatedOn:
nullable: true
type: string
required:
- Id
FromLocation:
type: object
properties:
Id:
type: string
Name:
type: string
Code:
description: (default = null)
nullable: true
type: string
Country:
type: number
x-enum-type: IntelliTracer.Domain.Country
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
- 47
- 48
- 49
- 50
- 51
- 52
- 53
- 54
- 55
- 56
- 57
- 58
- 59
- 60
- 61
- 62
- 63
- 64
- 65
- 66
- 67
- 68
- 69
- 70
- 71
- 72
- 73
- 74
- 75
- 76
- 77
- 78
- 79
- 80
- 81
- 82
- 83
- 84
- 85
- 86
- 87
- 88
- 89
- 90
- 91
- 92
- 93
- 94
- 95
- 96
- 97
- 98
- 99
- 100
- 101
- 102
- 103
- 104
- 105
- 106
- 107
- 108
- 109
- 110
- 111
- 112
- 113
- 114
- 115
- 116
- 117
- 118
- 119
- 120
- 121
- 122
- 123
- 124
- 125
- 126
- 127
- 128
- 129
- 130
- 131
- 132
- 133
- 134
- 135
- 136
- 137
- 138
- 139
- 140
- 141
- 142
- 143
- 144
- 145
- 146
- 147
- 148
- 149
- 150
- 151
- 152
- 153
- 9999
description: (default = 0)
Description:
description: (default = null)
nullable: true
type: string
GeographyWkt:
description: >-
(default = null)
The coordinates of all points that define the shape of the asset location.
nullable: true
type: string
HouseNumber:
description: (default = null)
nullable: true
type: string
LonMin:
type: number
description: (default = 0.0)
LonMax:
type: number
description: (default = 0.0)
LatMin:
type: number
description: (default = 0.0)
LatMax:
type: number
description: (default = 0.0)
MarkerLon:
description: (default = null)
nullable: true
type: number
MarkerLat:
description: (default = null)
nullable: true
type: number
IsAssetLocation:
type: boolean
description: (default = false)
PostalCode:
description: (default = null)
nullable: true
type: string
Street:
description: (default = null)
nullable: true
type: string
Submunicipality:
description: (default = null)
nullable: true
type: string
City:
description: (default = null)
nullable: true
type: string
required:
- Id
- Name
- Country
ToLocation:
type: object
properties:
Id:
type: string
Name:
type: string
Code:
description: (default = null)
nullable: true
type: string
Country:
type: number
x-enum-type: IntelliTracer.Domain.Country
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
- 47
- 48
- 49
- 50
- 51
- 52
- 53
- 54
- 55
- 56
- 57
- 58
- 59
- 60
- 61
- 62
- 63
- 64
- 65
- 66
- 67
- 68
- 69
- 70
- 71
- 72
- 73
- 74
- 75
- 76
- 77
- 78
- 79
- 80
- 81
- 82
- 83
- 84
- 85
- 86
- 87
- 88
- 89
- 90
- 91
- 92
- 93
- 94
- 95
- 96
- 97
- 98
- 99
- 100
- 101
- 102
- 103
- 104
- 105
- 106
- 107
- 108
- 109
- 110
- 111
- 112
- 113
- 114
- 115
- 116
- 117
- 118
- 119
- 120
- 121
- 122
- 123
- 124
- 125
- 126
- 127
- 128
- 129
- 130
- 131
- 132
- 133
- 134
- 135
- 136
- 137
- 138
- 139
- 140
- 141
- 142
- 143
- 144
- 145
- 146
- 147
- 148
- 149
- 150
- 151
- 152
- 153
- 9999
description: (default = 0)
Description:
description: (default = null)
nullable: true
type: string
GeographyWkt:
description: >-
(default = null)
The coordinates of all points that define the shape of the asset location.
nullable: true
type: string
HouseNumber:
description: (default = null)
nullable: true
type: string
LonMin:
type: number
description: (default = 0.0)
LonMax:
type: number
description: (default = 0.0)
LatMin:
type: number
description: (default = 0.0)
LatMax:
type: number
description: (default = 0.0)
MarkerLon:
description: (default = null)
nullable: true
type: number
MarkerLat:
description: (default = null)
nullable: true
type: number
IsAssetLocation:
type: boolean
description: (default = false)
PostalCode:
description: (default = null)
nullable: true
type: string
Street:
description: (default = null)
nullable: true
type: string
Submunicipality:
description: (default = null)
nullable: true
type: string
City:
description: (default = null)
nullable: true
type: string
required:
- Id
- Name
- Country
Quantity:
type: number
description: (default = `1`)
By:
type: object
properties:
Id:
type: string
Code:
description: (default = null)
nullable: true
type: string
Name:
type: string
Type:
type: number
x-enum-type: IntelliTracer.Domain.ResourceType
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
description: (default = 0)
required:
- Id
- Name
required:
- TimeStamp
- Asset
- FromLocation
- ToLocation
- Quantity
- By
description: (default = null)
nullable: true
type: object
examples:
response:
value:
Data:
TimeStamp: 2019-01-25T08:06:45+01:00
Asset:
Id: 00000000-0000-0000-0000-000000000000
Name: Work
Code: "012345"
Type: "012345"
Brand: "012345"
TypeNumber: "012345"
SerialNumber: "012345"
Description: "012345"
Quantity: 1
CommissioningDate: 2019-01-25T07:29:37
Category: 0
AdministrativeLocations:
- Location:
Id: 00000000-0000-0000-0000-000000000000
Name: Work
Code: "012345"
Country: 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))
HouseNumber: "9"
LonMin: 3.145219
LonMax: 3.244998
LatMin: 50.81309
LatMax: 50.91806
MarkerLon: 3.145219
MarkerLat: 50.81309
IsAssetLocation: false
PostalCode: "8500"
Street: Dumolinlaan
Submunicipality: Kortrijk
City: Kortrijk
Quantity: 1
LastSeen:
Address: Dumolinlaan 9, 8500 Kortrijk, BE
DateTime: 2019-01-25T08:29:37+02:00
DetectedBy: Vehicle 1
Picture: https://prodassetmanagement.blob.core.windows.net/geodynamics-899192c530d46fde13b9164f2ea1253d/assets/3022e805-e786-4564-b561-0685920de8dd.jpg
Responsible:
Id: 00000000-0000-0000-0000-000000000000
Code: "012345"
Name: John Doe
Type: 0
CreatedOn: 2019-01-25T08:29:37+02:00
FromLocation:
Id: 00000000-0000-0000-0000-000000000000
Name: Work
Code: "012345"
Country: 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))
HouseNumber: "9"
LonMin: 3.145219
LonMax: 3.244998
LatMin: 50.81309
LatMax: 50.91806
MarkerLon: 3.145219
MarkerLat: 50.81309
IsAssetLocation: false
PostalCode: "8500"
Street: Dumolinlaan
Submunicipality: Kortrijk
City: Kortrijk
ToLocation:
Id: 00000000-0000-0000-0000-000000000000
Name: Work
Code: "012345"
Country: 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))
HouseNumber: "9"
LonMin: 3.145219
LonMax: 3.244998
LatMin: 50.81309
LatMax: 50.91806
MarkerLon: 3.145219
MarkerLat: 50.81309
IsAssetLocation: false
PostalCode: "8500"
Street: Dumolinlaan
Submunicipality: Kortrijk
City: Kortrijk
Quantity: 1
By:
Id: 00000000-0000-0000-0000-000000000000
Code: "012345"
Name: John Doe
Type: 0
"400":
description: BadRequest
headers: {}
content:
application/json:
schema:
type: object
properties:
Entity:
type: object
properties:
TimeStamp:
type: string
Asset:
type: object
properties:
Id:
type: string
Name:
type: string
Code:
description: (default = null)
nullable: true
type: string
Type:
description: (default = null)
nullable: true
type: string
Brand:
description: (default = null)
nullable: true
type: string
TypeNumber:
description: (default = null)
nullable: true
type: string
SerialNumber:
description: (default = null)
nullable: true
type: string
Description:
description: (default = null)
nullable: true
type: string
Quantity:
description: (default = `1`)
nullable: true
type: number
CommissioningDate:
description: (default = null)
nullable: true
type: string
Category:
x-enum-type: IntelliTracer.ApiV1.AssetCategory
enum:
- 0
- 1
- null
description: (default = null)
nullable: true
type: number
AdministrativeLocations:
description: "(default = null) "
nullable: true
type: array
items: {}
LastSeen:
properties:
Address:
type: string
DateTime:
type: string
DetectedBy:
type: string
required:
- Address
- DateTime
- DetectedBy
description: (default = null)
nullable: true
type: object
Picture:
description: (default = null)
nullable: true
type: string
Responsible:
properties:
Id:
type: string
Code:
description: (default = null)
nullable: true
type: string
Name:
type: string
Type:
type: number
x-enum-type: IntelliTracer.Domain.ResourceType
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
description: (default = 0)
required:
- Id
- Name
description: (default = null)
nullable: true
type: object
CreatedOn:
nullable: true
type: string
required:
- Id
FromLocation:
type: object
properties:
Id:
type: string
Name:
type: string
Code:
description: (default = null)
nullable: true
type: string
Country:
type: number
x-enum-type: IntelliTracer.Domain.Country
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
- 47
- 48
- 49
- 50
- 51
- 52
- 53
- 54
- 55
- 56
- 57
- 58
- 59
- 60
- 61
- 62
- 63
- 64
- 65
- 66
- 67
- 68
- 69
- 70
- 71
- 72
- 73
- 74
- 75
- 76
- 77
- 78
- 79
- 80
- 81
- 82
- 83
- 84
- 85
- 86
- 87
- 88
- 89
- 90
- 91
- 92
- 93
- 94
- 95
- 96
- 97
- 98
- 99
- 100
- 101
- 102
- 103
- 104
- 105
- 106
- 107
- 108
- 109
- 110
- 111
- 112
- 113
- 114
- 115
- 116
- 117
- 118
- 119
- 120
- 121
- 122
- 123
- 124
- 125
- 126
- 127
- 128
- 129
- 130
- 131
- 132
- 133
- 134
- 135
- 136
- 137
- 138
- 139
- 140
- 141
- 142
- 143
- 144
- 145
- 146
- 147
- 148
- 149
- 150
- 151
- 152
- 153
- 9999
description: (default = 0)
Description:
description: (default = null)
nullable: true
type: string
GeographyWkt:
description: >-
(default = null)
The coordinates of all points that define the shape of the asset location.
nullable: true
type: string
HouseNumber:
description: (default = null)
nullable: true
type: string
LonMin:
type: number
description: (default = 0.0)
LonMax:
type: number
description: (default = 0.0)
LatMin:
type: number
description: (default = 0.0)
LatMax:
type: number
description: (default = 0.0)
MarkerLon:
description: (default = null)
nullable: true
type: number
MarkerLat:
description: (default = null)
nullable: true
type: number
IsAssetLocation:
type: boolean
description: (default = false)
PostalCode:
description: (default = null)
nullable: true
type: string
Street:
description: (default = null)
nullable: true
type: string
Submunicipality:
description: (default = null)
nullable: true
type: string
City:
description: (default = null)
nullable: true
type: string
required:
- Id
- Name
- Country
ToLocation:
type: object
properties:
Id:
type: string
Name:
type: string
Code:
description: (default = null)
nullable: true
type: string
Country:
type: number
x-enum-type: IntelliTracer.Domain.Country
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
- 47
- 48
- 49
- 50
- 51
- 52
- 53
- 54
- 55
- 56
- 57
- 58
- 59
- 60
- 61
- 62
- 63
- 64
- 65
- 66
- 67
- 68
- 69
- 70
- 71
- 72
- 73
- 74
- 75
- 76
- 77
- 78
- 79
- 80
- 81
- 82
- 83
- 84
- 85
- 86
- 87
- 88
- 89
- 90
- 91
- 92
- 93
- 94
- 95
- 96
- 97
- 98
- 99
- 100
- 101
- 102
- 103
- 104
- 105
- 106
- 107
- 108
- 109
- 110
- 111
- 112
- 113
- 114
- 115
- 116
- 117
- 118
- 119
- 120
- 121
- 122
- 123
- 124
- 125
- 126
- 127
- 128
- 129
- 130
- 131
- 132
- 133
- 134
- 135
- 136
- 137
- 138
- 139
- 140
- 141
- 142
- 143
- 144
- 145
- 146
- 147
- 148
- 149
- 150
- 151
- 152
- 153
- 9999
description: (default = 0)
Description:
description: (default = null)
nullable: true
type: string
GeographyWkt:
description: >-
(default = null)
The coordinates of all points that define the shape of the asset location.
nullable: true
type: string
HouseNumber:
description: (default = null)
nullable: true
type: string
LonMin:
type: number
description: (default = 0.0)
LonMax:
type: number
description: (default = 0.0)
LatMin:
type: number
description: (default = 0.0)
LatMax:
type: number
description: (default = 0.0)
MarkerLon:
description: (default = null)
nullable: true
type: number
MarkerLat:
description: (default = null)
nullable: true
type: number
IsAssetLocation:
type: boolean
description: (default = false)
PostalCode:
description: (default = null)
nullable: true
type: string
Street:
description: (default = null)
nullable: true
type: string
Submunicipality:
description: (default = null)
nullable: true
type: string
City:
description: (default = null)
nullable: true
type: string
required:
- Id
- Name
- Country
Quantity:
type: number
description: (default = `1`)
By:
type: object
properties:
Id:
type: string
Code:
description: (default = null)
nullable: true
type: string
Name:
type: string
Type:
type: number
x-enum-type: IntelliTracer.Domain.ResourceType
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
description: (default = 0)
required:
- Id
- Name
required:
- TimeStamp
- Asset
- FromLocation
- ToLocation
- Quantity
- By
ValidationResult:
type: array
items: {}
required:
- Entity
- ValidationResult
examples:
response:
value:
Entity:
TimeStamp: 2019-01-25T08:06:45+01:00
Asset:
Id: 00000000-0000-0000-0000-000000000000
Name: Work
Code: "012345"
Type: "012345"
Brand: "012345"
TypeNumber: "012345"
SerialNumber: "012345"
Description: "012345"
Quantity: 1
CommissioningDate: 2019-01-25T07:29:37
Category: 0
AdministrativeLocations:
- Location:
Id: 00000000-0000-0000-0000-000000000000
Name: Work
Code: "012345"
Country: 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))
HouseNumber: "9"
LonMin: 3.145219
LonMax: 3.244998
LatMin: 50.81309
LatMax: 50.91806
MarkerLon: 3.145219
MarkerLat: 50.81309
IsAssetLocation: false
PostalCode: "8500"
Street: Dumolinlaan
Submunicipality: Kortrijk
City: Kortrijk
Quantity: 1
LastSeen:
Address: Dumolinlaan 9, 8500 Kortrijk, BE
DateTime: 2019-01-25T08:29:37+02:00
DetectedBy: Vehicle 1
Picture: https://prodassetmanagement.blob.core.windows.net/geodynamics-899192c530d46fde13b9164f2ea1253d/assets/3022e805-e786-4564-b561-0685920de8dd.jpg
Responsible:
Id: 00000000-0000-0000-0000-000000000000
Code: "012345"
Name: John Doe
Type: 0
CreatedOn: 2019-01-25T08:29:37+02:00
FromLocation:
Id: 00000000-0000-0000-0000-000000000000
Name: Work
Code: "012345"
Country: 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))
HouseNumber: "9"
LonMin: 3.145219
LonMax: 3.244998
LatMin: 50.81309
LatMax: 50.91806
MarkerLon: 3.145219
MarkerLat: 50.81309
IsAssetLocation: false
PostalCode: "8500"
Street: Dumolinlaan
Submunicipality: Kortrijk
City: Kortrijk
ToLocation:
Id: 00000000-0000-0000-0000-000000000000
Name: Work
Code: "012345"
Country: 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))
HouseNumber: "9"
LonMin: 3.145219
LonMax: 3.244998
LatMin: 50.81309
LatMax: 50.91806
MarkerLon: 3.145219
MarkerLat: 50.81309
IsAssetLocation: false
PostalCode: "8500"
Street: Dumolinlaan
Submunicipality: Kortrijk
City: Kortrijk
Quantity: 1
By:
Id: 00000000-0000-0000-0000-000000000000
Code: "012345"
Name: John Doe
Type: 0
ValidationResult:
- Message: ""
SourceMemberNames: []
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Mutate asset
operationId: Mutate asset
description: >-
Mutates a quantity of an asset from a location to another location.
The quantity of unique assets is limited to one!
The quantity of collective assets is limited to the number of assets at the source location.
*Privilege required: `Api: Asset management`*
x-resource: Asset - Mutations
tags:
- Assets
parameters:
- name: id
in: path
description: ""
required: true
example: 00000000-0000-0000-0000-000000000000
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
properties:
FromLocationId:
type: string
ToLocationId:
type: string
Quantity:
type: number
description: (default = `1`)
required:
- FromLocationId
- ToLocationId
example:
FromLocationId: 00000000-0000-0000-0000-000000000000
ToLocationId: 00000000-0000-0000-0000-000000000000
Quantity: 1
security:
- pat: []
"/api/v2/assetlocation?page={page}&search={search}":
get:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
$ref: "#/components/schemas/IntelliTracer.ApiV1.AssetLocationsWithPaging"
examples:
response:
value:
Data:
- Id: 00000000-0000-0000-0000-000000000000
Name: Work
Code: "012345"
Country: 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))
HouseNumber: "9"
LonMin: 3.145219
LonMax: 3.244998
LatMin: 50.81309
LatMax: 50.91806
MarkerLon: 3.145219
MarkerLat: 50.81309
PostalCode: "8500"
Street: Dumolinlaan
Submunicipality: Kortrijk
City: Kortrijk
PagingFilter:
Page: 1
Search: ABC
PageCount: 4
TotalCount: 100
Links:
Base: https://api.intellitracer.be
First: /api/v2/asset?page=1
Prev: /api/v2/asset?page=2
Next: /api/v2/asset?page=4
Last: /api/v2/asset?page=4
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Get asset locations
operationId: Get asset locations
description: >-
Returns a list of all asset locations (= all points of interest with
IsAssetLocation = True.)
Pagination and searching is explained in [Pagination](#pagination).
*Privilege required: `Api: Asset management`*
x-resource: Asset locations
tags:
- Assets
parameters:
- name: page
in: path
description: ""
required: true
example: "1"
schema:
type: number
- name: search
in: path
description: ""
required: true
example: ABC
schema:
type: string
security:
- pat: []
"/api/v2/assetlocation/{id}":
get:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Id:
type: string
Name:
type: string
Code:
description: (default = null)
nullable: true
type: string
Country:
type: number
x-enum-type: IntelliTracer.Domain.Country
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
- 47
- 48
- 49
- 50
- 51
- 52
- 53
- 54
- 55
- 56
- 57
- 58
- 59
- 60
- 61
- 62
- 63
- 64
- 65
- 66
- 67
- 68
- 69
- 70
- 71
- 72
- 73
- 74
- 75
- 76
- 77
- 78
- 79
- 80
- 81
- 82
- 83
- 84
- 85
- 86
- 87
- 88
- 89
- 90
- 91
- 92
- 93
- 94
- 95
- 96
- 97
- 98
- 99
- 100
- 101
- 102
- 103
- 104
- 105
- 106
- 107
- 108
- 109
- 110
- 111
- 112
- 113
- 114
- 115
- 116
- 117
- 118
- 119
- 120
- 121
- 122
- 123
- 124
- 125
- 126
- 127
- 128
- 129
- 130
- 131
- 132
- 133
- 134
- 135
- 136
- 137
- 138
- 139
- 140
- 141
- 142
- 143
- 144
- 145
- 146
- 147
- 148
- 149
- 150
- 151
- 152
- 153
- 9999
description: (default = 0)
Description:
description: (default = null)
nullable: true
type: string
GeographyWkt:
description: >-
(default = null)
The coordinates of all points that define the shape of the POI.
nullable: true
type: string
HouseNumber:
description: (default = null)
nullable: true
type: string
LonMin:
type: number
description: |-
(default = 0.0)
Lowest longitude coordinate of the shape of the POI.
LonMax:
type: number
description: |-
(default = 0.0)
Highest longitude coordinate of the shape of the POI.
LatMin:
type: number
description: |-
(default = 0.0)
Lowest latitude coordinate of the shape of the POI.
LatMax:
type: number
description: |-
(default = 0.0)
Highest latitude coordinate of the shape of the POI.
MarkerLon:
description: |-
(default = null)
Longitude coordinate of the marker.
nullable: true
type: number
MarkerLat:
description: |-
(default = null)
Latitude coordinate of the marker.
nullable: true
type: number
IsAssetLocation:
type: boolean
PostalCode:
description: (default = null)
nullable: true
type: string
Street:
description: (default = null)
nullable: true
type: string
Submunicipality:
description: (default = null)
nullable: true
type: string
City:
description: (default = null)
nullable: true
type: string
_typeDescriptor:
type: string
required:
- Id
- Name
examples:
response:
value:
Id: 00000000-0000-0000-0000-000000000000
Name: Work
Code: "012345"
Country: 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))
HouseNumber: "9"
LonMin: 3.145219
LonMax: 3.244998
LatMin: 50.81309
LatMax: 50.91806
MarkerLon: 3.145219
MarkerLat: 50.81309
PostalCode: "8500"
Street: Dumolinlaan
Submunicipality: Kortrijk
City: Kortrijk
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Get asset location by Id
operationId: Get asset location by Id
description: |-
Returns an asset location by its Id.
*Privilege required: `Api: Asset management`*
x-resource: Asset locations
tags:
- Assets
parameters:
- name: id
in: path
description: ""
required: true
example: 00000000-0000-0000-0000-000000000000
schema:
type: string
security:
- pat: []
"/api/v2/assetlocation/{id}/asset?page={page}&search={search}":
get:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Data:
description: (default = null)
nullable: true
type: array
items: {}
PagingFilter:
properties:
Page:
type: number
Search:
nullable: true
type: string
PageCount:
type: number
TotalCount:
type: number
Links:
type: object
properties:
Base:
type: string
First:
type: string
Prev:
type: string
Next:
type: string
Last:
type: string
required:
- Base
required:
- Page
- PageCount
- TotalCount
- Links
description: (default = null)
nullable: true
type: object
examples:
response:
value:
Data:
- Id: 00000000-0000-0000-0000-000000000000
Name: Work
Code: "012345"
Type: "012345"
Brand: "012345"
TypeNumber: "012345"
SerialNumber: "012345"
Description: "012345"
Quantity: 1
CommissioningDate: 2019-01-25T07:29:37
Category: 0
AdministrativeLocations:
- Location:
Id: 00000000-0000-0000-0000-000000000000
Name: Work
Code: "012345"
Country: 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))
HouseNumber: "9"
LonMin: 3.145219
LonMax: 3.244998
LatMin: 50.81309
LatMax: 50.91806
MarkerLon: 3.145219
MarkerLat: 50.81309
IsAssetLocation: false
PostalCode: "8500"
Street: Dumolinlaan
Submunicipality: Kortrijk
City: Kortrijk
Quantity: 1
LastSeen:
Address: Dumolinlaan 9, 8500 Kortrijk, BE
DateTime: 2019-01-25T08:29:37+02:00
DetectedBy: Vehicle 1
Picture: https://prodassetmanagement.blob.core.windows.net/geodynamics-899192c530d46fde13b9164f2ea1253d/assets/3022e805-e786-4564-b561-0685920de8dd.jpg
Responsible:
Id: 00000000-0000-0000-0000-000000000000
Code: "012345"
Name: John Doe
Type: 0
CreatedOn: 2019-01-25T08:29:37+02:00
PagingFilter:
Page: 1
Search: ABC
PageCount: 4
TotalCount: 100
Links:
Base: https://api.intellitracer.be
First: /api/v2/asset?page=1
Prev: /api/v2/asset?page=2
Next: /api/v2/asset?page=4
Last: /api/v2/asset?page=4
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Get assets by asset location
operationId: Get assets by asset location
description: |-
Returns a paged list of assets at a location.
Pagination and searching is explained in [Pagination](#pagination).
*Privilege required: `Api: Asset management`*
x-resource: Asset location - Assets
tags:
- Assets
parameters:
- name: id
in: path
description: ""
required: true
example: 00000000-0000-0000-0000-000000000000
schema:
type: string
- name: page
in: path
description: ""
required: true
example: "1"
schema:
type: number
- name: search
in: path
description: ""
required: true
example: ABC
schema:
type: string
security:
- pat: []
"/api/v2/assetlocation/{id}/mutation?page={page}&search={search}":
get:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Data:
description: (default = null)
nullable: true
type: array
items: {}
PagingFilter:
properties:
Page:
type: number
Search:
nullable: true
type: string
PageCount:
type: number
TotalCount:
type: number
Links:
type: object
properties:
Base:
type: string
First:
type: string
Prev:
type: string
Next:
type: string
Last:
type: string
required:
- Base
required:
- Page
- PageCount
- TotalCount
- Links
description: (default = null)
nullable: true
type: object
examples:
response:
value:
Data:
- TimeStamp: 2019-01-25T08:06:45+01:00
Asset:
Id: 00000000-0000-0000-0000-000000000000
Name: Work
Code: "012345"
Type: "012345"
Brand: "012345"
TypeNumber: "012345"
SerialNumber: "012345"
Description: "012345"
Quantity: 1
CommissioningDate: 2019-01-25T07:29:37
Category: 0
AdministrativeLocations:
- Location:
Id: 00000000-0000-0000-0000-000000000000
Name: Work
Code: "012345"
Country: 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))
HouseNumber: "9"
LonMin: 3.145219
LonMax: 3.244998
LatMin: 50.81309
LatMax: 50.91806
MarkerLon: 3.145219
MarkerLat: 50.81309
IsAssetLocation: false
PostalCode: "8500"
Street: Dumolinlaan
Submunicipality: Kortrijk
City: Kortrijk
Quantity: 1
LastSeen:
Address: Dumolinlaan 9, 8500 Kortrijk, BE
DateTime: 2019-01-25T08:29:37+02:00
DetectedBy: Vehicle 1
Picture: https://prodassetmanagement.blob.core.windows.net/geodynamics-899192c530d46fde13b9164f2ea1253d/assets/3022e805-e786-4564-b561-0685920de8dd.jpg
Responsible:
Id: 00000000-0000-0000-0000-000000000000
Code: "012345"
Name: John Doe
Type: 0
CreatedOn: 2019-01-25T08:29:37+02:00
FromLocation:
Id: 00000000-0000-0000-0000-000000000000
Name: Work
Code: "012345"
Country: 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))
HouseNumber: "9"
LonMin: 3.145219
LonMax: 3.244998
LatMin: 50.81309
LatMax: 50.91806
MarkerLon: 3.145219
MarkerLat: 50.81309
IsAssetLocation: false
PostalCode: "8500"
Street: Dumolinlaan
Submunicipality: Kortrijk
City: Kortrijk
ToLocation:
Id: 00000000-0000-0000-0000-000000000000
Name: Work
Code: "012345"
Country: 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))
HouseNumber: "9"
LonMin: 3.145219
LonMax: 3.244998
LatMin: 50.81309
LatMax: 50.91806
MarkerLon: 3.145219
MarkerLat: 50.81309
IsAssetLocation: false
PostalCode: "8500"
Street: Dumolinlaan
Submunicipality: Kortrijk
City: Kortrijk
Quantity: 1
By:
Id: 00000000-0000-0000-0000-000000000000
Code: "012345"
Name: John Doe
Type: 0
PagingFilter:
Page: 1
Search: ABC
PageCount: 4
TotalCount: 100
Links:
Base: https://api.intellitracer.be
First: /api/v2/asset?page=1
Prev: /api/v2/asset?page=2
Next: /api/v2/asset?page=4
Last: /api/v2/asset?page=4
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Get mutations by asset location
operationId: Get mutations by asset location
description: |-
Returns a paged list of mutations at a location.
Pagination and searching is explained in [Pagination](#pagination).
*Privilege required: `Api: Asset management`*
x-resource: Asset location - Mutations
tags:
- Assets
parameters:
- name: id
in: path
description: ""
required: true
example: 00000000-0000-0000-0000-000000000000
schema:
type: string
- name: page
in: path
description: ""
required: true
example: "1"
schema:
type: number
- name: search
in: path
description: ""
required: true
example: ABC
schema:
type: string
security:
- pat: []
"/api/v2/assetlocation/{id}/mutation":
put:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Data:
description: (default = null)
nullable: true
type: array
items: {}
examples:
response:
value:
Data:
- TimeStamp: 2019-01-25T08:06:45+01:00
Asset:
Id: 00000000-0000-0000-0000-000000000000
Name: Work
Code: "012345"
Type: "012345"
Brand: "012345"
TypeNumber: "012345"
SerialNumber: "012345"
Description: "012345"
Quantity: 1
CommissioningDate: 2019-01-25T07:29:37
Category: 0
AdministrativeLocations:
- Location:
Id: 00000000-0000-0000-0000-000000000000
Name: Work
Code: "012345"
Country: 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))
HouseNumber: "9"
LonMin: 3.145219
LonMax: 3.244998
LatMin: 50.81309
LatMax: 50.91806
MarkerLon: 3.145219
MarkerLat: 50.81309
IsAssetLocation: false
PostalCode: "8500"
Street: Dumolinlaan
Submunicipality: Kortrijk
City: Kortrijk
Quantity: 1
LastSeen:
Address: Dumolinlaan 9, 8500 Kortrijk, BE
DateTime: 2019-01-25T08:29:37+02:00
DetectedBy: Vehicle 1
Picture: https://prodassetmanagement.blob.core.windows.net/geodynamics-899192c530d46fde13b9164f2ea1253d/assets/3022e805-e786-4564-b561-0685920de8dd.jpg
Responsible:
Id: 00000000-0000-0000-0000-000000000000
Code: "012345"
Name: John Doe
Type: 0
CreatedOn: 2019-01-25T08:29:37+02:00
FromLocation:
Id: 00000000-0000-0000-0000-000000000000
Name: Work
Code: "012345"
Country: 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))
HouseNumber: "9"
LonMin: 3.145219
LonMax: 3.244998
LatMin: 50.81309
LatMax: 50.91806
MarkerLon: 3.145219
MarkerLat: 50.81309
IsAssetLocation: false
PostalCode: "8500"
Street: Dumolinlaan
Submunicipality: Kortrijk
City: Kortrijk
ToLocation:
Id: 00000000-0000-0000-0000-000000000000
Name: Work
Code: "012345"
Country: 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))
HouseNumber: "9"
LonMin: 3.145219
LonMax: 3.244998
LatMin: 50.81309
LatMax: 50.91806
MarkerLon: 3.145219
MarkerLat: 50.81309
IsAssetLocation: false
PostalCode: "8500"
Street: Dumolinlaan
Submunicipality: Kortrijk
City: Kortrijk
Quantity: 1
By:
Id: 00000000-0000-0000-0000-000000000000
Code: "012345"
Name: John Doe
Type: 0
"400":
description: BadRequest
headers: {}
content:
application/json:
schema:
type: object
properties:
Data:
description: (default = null)
nullable: true
type: array
items: {}
examples:
response:
value:
Data:
- Entity:
TimeStamp: 2019-01-25T08:06:45+01:00
Asset:
Id: 00000000-0000-0000-0000-000000000000
Name: Work
Code: "012345"
Type: "012345"
Brand: "012345"
TypeNumber: "012345"
SerialNumber: "012345"
Description: "012345"
Quantity: 1
CommissioningDate: 2019-01-25T07:29:37
Category: 0
AdministrativeLocations:
- Location:
Id: 00000000-0000-0000-0000-000000000000
Name: Work
Code: "012345"
Country: 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))
HouseNumber: "9"
LonMin: 3.145219
LonMax: 3.244998
LatMin: 50.81309
LatMax: 50.91806
MarkerLon: 3.145219
MarkerLat: 50.81309
IsAssetLocation: false
PostalCode: "8500"
Street: Dumolinlaan
Submunicipality: Kortrijk
City: Kortrijk
Quantity: 1
LastSeen:
Address: Dumolinlaan 9, 8500 Kortrijk, BE
DateTime: 2019-01-25T08:29:37+02:00
DetectedBy: Vehicle 1
Picture: https://prodassetmanagement.blob.core.windows.net/geodynamics-899192c530d46fde13b9164f2ea1253d/assets/3022e805-e786-4564-b561-0685920de8dd.jpg
Responsible:
Id: 00000000-0000-0000-0000-000000000000
Code: "012345"
Name: John Doe
Type: 0
CreatedOn: 2019-01-25T08:29:37+02:00
FromLocation:
Id: 00000000-0000-0000-0000-000000000000
Name: Work
Code: "012345"
Country: 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))
HouseNumber: "9"
LonMin: 3.145219
LonMax: 3.244998
LatMin: 50.81309
LatMax: 50.91806
MarkerLon: 3.145219
MarkerLat: 50.81309
IsAssetLocation: false
PostalCode: "8500"
Street: Dumolinlaan
Submunicipality: Kortrijk
City: Kortrijk
ToLocation:
Id: 00000000-0000-0000-0000-000000000000
Name: Work
Code: "012345"
Country: 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))
HouseNumber: "9"
LonMin: 3.145219
LonMax: 3.244998
LatMin: 50.81309
LatMax: 50.91806
MarkerLon: 3.145219
MarkerLat: 50.81309
IsAssetLocation: false
PostalCode: "8500"
Street: Dumolinlaan
Submunicipality: Kortrijk
City: Kortrijk
Quantity: 1
By:
Id: 00000000-0000-0000-0000-000000000000
Code: "012345"
Name: John Doe
Type: 0
ValidationResult:
- Message: ""
SourceMemberNames: []
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Mutate assets
operationId: Mutate assets
description: >-
Mutates quantities of assets from a location to another location.
The quantity of unique assets is limited to one!
The quantity of collective assets is limited to the number of assets at the source location.
*Privilege required: `Api: Asset management`*
x-resource: Asset location - Mutations
tags:
- Assets
parameters:
- name: id
in: path
description: ""
required: true
example: 00000000-0000-0000-0000-000000000000
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
properties:
AssetQuantities:
type: array
description: (default = null)
items: {}
ToLocationId:
type: string
required:
- AssetQuantities
- ToLocationId
example:
AssetQuantities:
- AssetId: 00000000-0000-0000-0000-000000000000
Quantity: 1
ToLocationId: 00000000-0000-0000-0000-000000000000
security:
- pat: []
"/api/v2/asset/{assetId}/administrativelocation/{locationId}":
put:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Data:
properties:
Id:
type: string
Name:
type: string
Code:
description: (default = null)
nullable: true
type: string
Type:
description: (default = null)
nullable: true
type: string
Brand:
description: (default = null)
nullable: true
type: string
TypeNumber:
description: (default = null)
nullable: true
type: string
SerialNumber:
description: (default = null)
nullable: true
type: string
Description:
description: (default = null)
nullable: true
type: string
Quantity:
description: (default = `1`)
nullable: true
type: number
CommissioningDate:
description: (default = null)
nullable: true
type: string
Category:
x-enum-type: IntelliTracer.ApiV1.AssetCategory
enum:
- 0
- 1
- null
description: (default = null)
nullable: true
type: number
AdministrativeLocations:
description: "(default = null) "
nullable: true
type: array
items: {}
LastSeen:
properties:
Address:
type: string
DateTime:
type: string
DetectedBy:
type: string
required:
- Address
- DateTime
- DetectedBy
description: (default = null)
nullable: true
type: object
Picture:
description: (default = null)
nullable: true
type: string
Responsible:
properties:
Id:
type: string
Code:
description: (default = null)
nullable: true
type: string
Name:
type: string
Type:
type: number
x-enum-type: IntelliTracer.Domain.ResourceType
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
description: (default = 0)
required:
- Id
- Name
description: (default = null)
nullable: true
type: object
CreatedOn:
nullable: true
type: string
required:
- Id
description: (default = null)
nullable: true
type: object
examples:
response:
value:
Data:
Id: 00000000-0000-0000-0000-000000000000
Name: Work
Code: "012345"
Type: "012345"
Brand: "012345"
TypeNumber: "012345"
SerialNumber: "012345"
Description: "012345"
Quantity: 1
CommissioningDate: 2019-01-25T07:29:37
Category: 0
AdministrativeLocations:
- Location:
Id: 00000000-0000-0000-0000-000000000000
Name: Work
Code: "012345"
Country: 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))
HouseNumber: "9"
LonMin: 3.145219
LonMax: 3.244998
LatMin: 50.81309
LatMax: 50.91806
MarkerLon: 3.145219
MarkerLat: 50.81309
IsAssetLocation: false
PostalCode: "8500"
Street: Dumolinlaan
Submunicipality: Kortrijk
City: Kortrijk
Quantity: 1
LastSeen:
Address: Dumolinlaan 9, 8500 Kortrijk, BE
DateTime: 2019-01-25T08:29:37+02:00
DetectedBy: Vehicle 1
Picture: https://prodassetmanagement.blob.core.windows.net/geodynamics-899192c530d46fde13b9164f2ea1253d/assets/3022e805-e786-4564-b561-0685920de8dd.jpg
Responsible:
Id: 00000000-0000-0000-0000-000000000000
Code: "012345"
Name: John Doe
Type: 0
CreatedOn: 2019-01-25T08:29:37+02:00
"400":
description: Bad Request
headers: {}
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Link administrative location to unique asset
operationId: Link administrative location to unique asset
description: >-
Links an administrative location to a unique asset.
A unique asset means an asset with the property Category set to 0.
In this case, only one administrative location can be linked.
An administrative location is a point of interest with IsAssetLocation set to true.
*Privilege required: `Api: Asset management`*
x-resource: Administrative location
tags:
- Assets
parameters:
- name: assetId
in: path
description: ""
required: true
example: 00000000-0000-0000-0000-000000000000
schema:
type: string
- name: locationId
in: path
description: ""
required: true
example: 00000000-0000-0000-0000-000000000000
schema:
type: string
security:
- pat: []
delete:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Data:
properties:
Id:
type: string
Name:
type: string
Code:
description: (default = null)
nullable: true
type: string
Type:
description: (default = null)
nullable: true
type: string
Brand:
description: (default = null)
nullable: true
type: string
TypeNumber:
description: (default = null)
nullable: true
type: string
SerialNumber:
description: (default = null)
nullable: true
type: string
Description:
description: (default = null)
nullable: true
type: string
Quantity:
description: (default = `1`)
nullable: true
type: number
CommissioningDate:
description: (default = null)
nullable: true
type: string
Category:
x-enum-type: IntelliTracer.ApiV1.AssetCategory
enum:
- 0
- 1
- null
description: (default = null)
nullable: true
type: number
AdministrativeLocations:
description: "(default = null) "
nullable: true
type: array
items: {}
LastSeen:
properties:
Address:
type: string
DateTime:
type: string
DetectedBy:
type: string
required:
- Address
- DateTime
- DetectedBy
description: (default = null)
nullable: true
type: object
Picture:
description: (default = null)
nullable: true
type: string
Responsible:
properties:
Id:
type: string
Code:
description: (default = null)
nullable: true
type: string
Name:
type: string
Type:
type: number
x-enum-type: IntelliTracer.Domain.ResourceType
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
description: (default = 0)
required:
- Id
- Name
description: (default = null)
nullable: true
type: object
CreatedOn:
nullable: true
type: string
required:
- Id
description: (default = null)
nullable: true
type: object
examples:
response:
value:
Data:
Id: 00000000-0000-0000-0000-000000000000
Name: Work
Code: "012345"
Type: "012345"
Brand: "012345"
TypeNumber: "012345"
SerialNumber: "012345"
Description: "012345"
Quantity: 1
CommissioningDate: 2019-01-25T07:29:37
Category: 0
AdministrativeLocations:
- Location:
Id: 00000000-0000-0000-0000-000000000000
Name: Work
Code: "012345"
Country: 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))
HouseNumber: "9"
LonMin: 3.145219
LonMax: 3.244998
LatMin: 50.81309
LatMax: 50.91806
MarkerLon: 3.145219
MarkerLat: 50.81309
IsAssetLocation: false
PostalCode: "8500"
Street: Dumolinlaan
Submunicipality: Kortrijk
City: Kortrijk
Quantity: 1
LastSeen:
Address: Dumolinlaan 9, 8500 Kortrijk, BE
DateTime: 2019-01-25T08:29:37+02:00
DetectedBy: Vehicle 1
Picture: https://prodassetmanagement.blob.core.windows.net/geodynamics-899192c530d46fde13b9164f2ea1253d/assets/3022e805-e786-4564-b561-0685920de8dd.jpg
Responsible:
Id: 00000000-0000-0000-0000-000000000000
Code: "012345"
Name: John Doe
Type: 0
CreatedOn: 2019-01-25T08:29:37+02:00
"400":
description: Bad Request
headers: {}
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Unlink administrative location from asset
operationId: Unlink administrative location from asset
description: >-
Unlinks an administrative location from an asset.
An administrative location is a point of interest with IsAssetLocation set to true.
*Privilege required: `Api: Asset management`*
x-resource: Administrative location
tags:
- Assets
parameters:
- name: assetId
in: path
description: ""
required: true
example: 00000000-0000-0000-0000-000000000000
schema:
type: string
- name: locationId
in: path
description: ""
required: true
example: 00000000-0000-0000-0000-000000000000
schema:
type: string
security:
- pat: []
"/api/v2/asset/{id}/administrativelocations":
post:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Data:
properties:
Id:
type: string
Name:
type: string
Code:
description: (default = null)
nullable: true
type: string
Type:
description: (default = null)
nullable: true
type: string
Brand:
description: (default = null)
nullable: true
type: string
TypeNumber:
description: (default = null)
nullable: true
type: string
SerialNumber:
description: (default = null)
nullable: true
type: string
Description:
description: (default = null)
nullable: true
type: string
Quantity:
description: (default = `1`)
nullable: true
type: number
CommissioningDate:
description: (default = null)
nullable: true
type: string
Category:
x-enum-type: IntelliTracer.ApiV1.AssetCategory
enum:
- 0
- 1
- null
description: (default = null)
nullable: true
type: number
AdministrativeLocations:
description: "(default = null) "
nullable: true
type: array
items: {}
LastSeen:
properties:
Address:
type: string
DateTime:
type: string
DetectedBy:
type: string
required:
- Address
- DateTime
- DetectedBy
description: (default = null)
nullable: true
type: object
Picture:
description: (default = null)
nullable: true
type: string
Responsible:
properties:
Id:
type: string
Code:
description: (default = null)
nullable: true
type: string
Name:
type: string
Type:
type: number
x-enum-type: IntelliTracer.Domain.ResourceType
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
description: (default = 0)
required:
- Id
- Name
description: (default = null)
nullable: true
type: object
CreatedOn:
nullable: true
type: string
required:
- Id
description: (default = null)
nullable: true
type: object
examples:
response:
value:
Data:
Id: 00000000-0000-0000-0000-000000000000
Name: Work
Code: "012345"
Type: "012345"
Brand: "012345"
TypeNumber: "012345"
SerialNumber: "012345"
Description: "012345"
Quantity: 1
CommissioningDate: 2019-01-25T07:29:37
Category: 0
AdministrativeLocations:
- Location:
Id: 00000000-0000-0000-0000-000000000000
Name: Work
Code: "012345"
Country: 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))
HouseNumber: "9"
LonMin: 3.145219
LonMax: 3.244998
LatMin: 50.81309
LatMax: 50.91806
MarkerLon: 3.145219
MarkerLat: 50.81309
IsAssetLocation: false
PostalCode: "8500"
Street: Dumolinlaan
Submunicipality: Kortrijk
City: Kortrijk
Quantity: 1
LastSeen:
Address: Dumolinlaan 9, 8500 Kortrijk, BE
DateTime: 2019-01-25T08:29:37+02:00
DetectedBy: Vehicle 1
Picture: https://prodassetmanagement.blob.core.windows.net/geodynamics-899192c530d46fde13b9164f2ea1253d/assets/3022e805-e786-4564-b561-0685920de8dd.jpg
Responsible:
Id: 00000000-0000-0000-0000-000000000000
Code: "012345"
Name: John Doe
Type: 0
CreatedOn: 2019-01-25T08:29:37+02:00
"400":
description: Bad Request
headers: {}
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Link administrative location to collective asset
operationId: Link administrative location to collective asset
description: >-
Links administrative locations to a collective asset.
A collective asset means an asset with the property Category set to 1.
In this case, multiple administrative locations can be linked, each with their own amount of items.
An administrative location is a point of interest with IsAssetLocation set to true.
*Privilege required: `Api: Asset management`*
x-resource: Administrative location
tags:
- Assets
parameters:
- name: id
in: path
description: ""
required: true
example: 00000000-0000-0000-0000-000000000000
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
properties:
Data:
description: (default = null)
nullable: true
type: array
items: {}
example:
Data:
- LocationId: 00000000-0000-0000-0000-000000000000
Quantity: 1
security:
- pat: []
"/api/v2/assetinspectiontype?page={page}&search={search}":
get:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Data:
nullable: true
type: array
items: {}
Meta:
properties:
Filter:
type: string
Page:
type: number
Per_Page:
type: number
nullable: true
type: object
examples:
response:
value:
Data:
- Id: 00000000-0000-0000-0000-000000000000
Name: Inspection
Description: Description
Responsible: 0
WarningThresholdDays: 0
IntervalYears: 0
IntervalMonths: 6
IntervalDays: 0
Meta:
Filter: ABCD123
Page: 1
Per_Page: 10
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Get asset inspection types
operationId: Get asset inspection types
description: |-
Get all asset inspections for a specific Asset Id.
Pagination and searching is explained in [Pagination](#pagination).
*Privilege required: `Api: Asset management`*
x-resource: Asset inspection types
tags:
- Assets
parameters:
- name: page
in: path
description: ""
required: true
example: "1"
schema:
type: number
- name: search
in: path
description: ""
required: true
example: ABC
schema:
type: string
security:
- pat: []
"/api/v2/asset/{assetId}/inspectiontype":
get:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Data:
type: array
items:
$ref: "#/components/schemas/IntelliTracer.ApiV1.AssetInspectionType"
examples:
response:
value:
Data:
- Id: 00000000-0000-0000-0000-000000000000
Name: Inspection
Description: Description
Responsible: 0
WarningThresholdDays: 0
IntervalYears: 0
IntervalMonths: 6
IntervalDays: 0
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Get linked inspection types by asset
operationId: Get linked inspection types by asset
description: |-
Returns a list of asset inspection types linked to a particular asset.
*Privilege required: `Api: Asset management`*
x-resource: Asset inspection types
tags:
- Assets
parameters:
- name: assetId
in: path
description: ""
required: true
example: 00000000-0000-0000-0000-000000000000
schema:
type: string
security:
- pat: []
/api/v2/assetinspectiontype:
put:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Id:
type: string
Name:
description: (default = null)
nullable: true
type: string
Description:
description: (default = null)
nullable: true
type: string
Responsible:
x-enum-type: IntelliTracer.ApiV1.InspectionResponsible
enum:
- 0
- 1
- null
nullable: true
type: number
WarningThresholdDays:
description: (default = null)
nullable: true
type: number
IntervalYears:
description: (default = null)
nullable: true
type: number
IntervalMonths:
description: (default = null)
nullable: true
type: number
IntervalDays:
description: (default = null)
nullable: true
type: number
required:
- Id
- Name
examples:
response:
value:
Id: 00000000-0000-0000-0000-000000000000
Name: Inspection
Description: Description
Responsible: 0
WarningThresholdDays: 0
IntervalYears: 0
IntervalMonths: 6
IntervalDays: 0
"400":
description: Bad Request
headers: {}
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Create asset inspection type
operationId: Create asset inspection type
description: |-
Creates a new asset inspection.
*Privilege required: `Api: Asset management`*
x-resource: Asset inspection types
tags:
- Assets
requestBody:
content:
application/json:
schema:
type: object
properties:
Name:
description: (default = null)
nullable: true
type: string
Description:
description: (default = null)
nullable: true
type: string
Responsible:
x-enum-type: IntelliTracer.ApiV1.InspectionResponsible
enum:
- 0
- 1
- null
nullable: true
type: number
WarningThresholdDays:
description: (default = null)
nullable: true
type: number
IntervalYears:
description: (default = null)
nullable: true
type: number
IntervalMonths:
description: (default = null)
nullable: true
type: number
IntervalDays:
description: (default = null)
nullable: true
type: number
required:
- Name
example:
Name: Inspection
Description: Description
Responsible: 0
WarningThresholdDays: 0
IntervalYears: 0
IntervalMonths: 6
IntervalDays: 0
security:
- pat: []
post:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Id:
type: string
Name:
description: (default = null)
nullable: true
type: string
Description:
description: (default = null)
nullable: true
type: string
Responsible:
x-enum-type: IntelliTracer.ApiV1.InspectionResponsible
enum:
- 0
- 1
- null
nullable: true
type: number
WarningThresholdDays:
description: (default = null)
nullable: true
type: number
IntervalYears:
description: (default = null)
nullable: true
type: number
IntervalMonths:
description: (default = null)
nullable: true
type: number
IntervalDays:
description: (default = null)
nullable: true
type: number
required:
- Id
- Name
examples:
response:
value:
Id: 00000000-0000-0000-0000-000000000000
Name: Inspection
Description: Description
Responsible: 0
WarningThresholdDays: 0
IntervalYears: 0
IntervalMonths: 6
IntervalDays: 0
"400":
description: Bad Request
headers: {}
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Update asset inspection type
operationId: Update asset inspection type
description: |-
Updates an existing asset inspection type.
*Privilege required: `Api: Asset management`*
x-resource: Asset inspection types
tags:
- Assets
requestBody:
content:
application/json:
schema:
type: object
properties:
Id:
type: string
Name:
description: (default = null)
nullable: true
type: string
Description:
description: (default = null)
nullable: true
type: string
Responsible:
x-enum-type: IntelliTracer.ApiV1.InspectionResponsible
enum:
- 0
- 1
- null
nullable: true
type: number
WarningThresholdDays:
description: (default = null)
nullable: true
type: number
IntervalYears:
description: (default = null)
nullable: true
type: number
IntervalMonths:
description: (default = null)
nullable: true
type: number
IntervalDays:
description: (default = null)
nullable: true
type: number
required:
- Id
- Name
example:
Id: 00000000-0000-0000-0000-000000000000
Name: Inspection
Description: Description
Responsible: 0
WarningThresholdDays: 0
IntervalYears: 0
IntervalMonths: 6
IntervalDays: 0
security:
- pat: []
"/api/v2/assetinspectiontype/{assetInspectionTypeId}":
delete:
responses:
"200":
description: OK
headers: {}
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Delete asset inspection type
operationId: Delete asset inspection type
description: |-
Deletes an asset inspection type by its Id.
*Privilege required: `Api: Asset management`*
x-resource: Asset inspection types
tags:
- Assets
parameters:
- name: assetInspectionTypeId
in: path
description: ""
required: true
example: 00000000-0000-0000-0000-000000000000
schema:
type: string
security:
- pat: []
"/api/v2/asset/{assetId}/inspectionType/{inspectionTypeId}":
put:
responses:
"200":
description: OK
headers: {}
"400":
description: Bad Request
headers: {}
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Link inspection type to asset
operationId: Link inspection type to asset
description: |-
Links an inspection type to an asset by Id.
*Privilege required: `Api: Asset management`*
x-resource: Asset inspection types
tags:
- Assets
parameters:
- name: assetId
in: path
description: ""
required: true
example: 00000000-0000-0000-0000-000000000000
schema:
type: string
- name: inspectionTypeId
in: path
description: ""
required: true
example: 00000000-0000-0000-0000-000000000000
schema:
type: string
security:
- pat: []
delete:
responses:
"200":
description: OK
headers: {}
"400":
description: Bad Request
headers: {}
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Unlink inspection type from asset
operationId: Unlink inspection type from asset
description: |-
Unlinks an inspection type from an asset by Id.
*Privilege required: `Api: Asset management`*
x-resource: Asset inspection types
tags:
- Assets
parameters:
- name: assetId
in: path
description: ""
required: true
example: 00000000-0000-0000-0000-000000000000
schema:
type: string
- name: inspectionTypeId
in: path
description: ""
required: true
example: 00000000-0000-0000-0000-000000000000
schema:
type: string
security:
- pat: []
"/api/v2/asset/{assetId}/inspection":
get:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Id:
type: string
AssetId:
type: string
Type:
properties:
Id:
type: string
Name:
description: (default = null)
nullable: true
type: string
Description:
description: (default = null)
nullable: true
type: string
Responsible:
x-enum-type: IntelliTracer.ApiV1.InspectionResponsible
enum:
- 0
- 1
- null
nullable: true
type: number
WarningThresholdDays:
description: (default = null)
nullable: true
type: number
IntervalYears:
description: (default = null)
nullable: true
type: number
IntervalMonths:
description: (default = null)
nullable: true
type: number
IntervalDays:
description: (default = null)
nullable: true
type: number
required:
- Id
- Name
nullable: true
type: object
Status:
type: number
x-enum-type: IntelliTracer.ApiV1.AssetInspectionState
enum:
- 0
- 1
- 2
description: (default = 0)
Comments:
description: (default = null)
nullable: true
type: string
DateCompleted:
description: (default = null)
nullable: true
type: string
Picture:
description: (default = null)
nullable: true
type: string
required:
- Id
- AssetId
- Type
examples:
response:
value:
Id: 00000000-0000-0000-0000-000000000000
AssetId: 00000000-0000-0000-0000-000000000000
Type:
Id: 00000000-0000-0000-0000-000000000000
Name: Inspection
Description: Description
Responsible: 0
WarningThresholdDays: 0
IntervalYears: 0
IntervalMonths: 6
IntervalDays: 0
Status: 0
Comments: Comments
DateCompleted: 2019-09-10
Picture: https://prodassetmanagement.blob.core.windows.net/geodynamics-899192c530d46fde13b9164f2ea1253d/assets/3022e805-e786-4564-b561-0685920de8dd.jpg
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Get asset inspections by Asset Id
operationId: Get asset inspections by Asset Id
description: |-
Get all asset inspections for a specific Asset Id.
*Privilege required: `Api: Asset management`*
x-resource: Asset inspections
tags:
- Assets
parameters:
- name: assetId
in: path
description: ""
required: true
example: 00000000-0000-0000-0000-000000000000
schema:
type: string
security:
- pat: []
"/api/v2/inspection?date={date}":
get:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Id:
type: string
AssetId:
type: string
Type:
properties:
Id:
type: string
Name:
description: (default = null)
nullable: true
type: string
Description:
description: (default = null)
nullable: true
type: string
Responsible:
x-enum-type: IntelliTracer.ApiV1.InspectionResponsible
enum:
- 0
- 1
- null
nullable: true
type: number
WarningThresholdDays:
description: (default = null)
nullable: true
type: number
IntervalYears:
description: (default = null)
nullable: true
type: number
IntervalMonths:
description: (default = null)
nullable: true
type: number
IntervalDays:
description: (default = null)
nullable: true
type: number
required:
- Id
- Name
nullable: true
type: object
Status:
type: number
x-enum-type: IntelliTracer.ApiV1.AssetInspectionState
enum:
- 0
- 1
- 2
description: (default = 0)
Comments:
description: (default = null)
nullable: true
type: string
DateCompleted:
description: (default = null)
nullable: true
type: string
Picture:
description: (default = null)
nullable: true
type: string
required:
- Id
- AssetId
- Type
examples:
response:
value:
Id: 00000000-0000-0000-0000-000000000000
AssetId: 00000000-0000-0000-0000-000000000000
Type:
Id: 00000000-0000-0000-0000-000000000000
Name: Inspection
Description: Description
Responsible: 0
WarningThresholdDays: 0
IntervalYears: 0
IntervalMonths: 6
IntervalDays: 0
Status: 0
Comments: Comments
DateCompleted: 2019-09-10
Picture: https://prodassetmanagement.blob.core.windows.net/geodynamics-899192c530d46fde13b9164f2ea1253d/assets/3022e805-e786-4564-b561-0685920de8dd.jpg
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Get asset inspections by Date
operationId: Get asset inspections by Date
description: |-
Get all asset inspections that occurred on or after a specific date.
*Privilege required: `Api: Asset management`*
x-resource: Asset inspections
tags:
- Assets
parameters:
- name: date
in: path
description: ""
required: true
example: 2020-01-01
schema:
type: string
security:
- pat: []
/api/v2/inspection:
put:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Id:
type: string
AssetId:
type: string
Type:
properties:
Id:
type: string
Name:
description: (default = null)
nullable: true
type: string
Description:
description: (default = null)
nullable: true
type: string
Responsible:
x-enum-type: IntelliTracer.ApiV1.InspectionResponsible
enum:
- 0
- 1
- null
nullable: true
type: number
WarningThresholdDays:
description: (default = null)
nullable: true
type: number
IntervalYears:
description: (default = null)
nullable: true
type: number
IntervalMonths:
description: (default = null)
nullable: true
type: number
IntervalDays:
description: (default = null)
nullable: true
type: number
required:
- Id
- Name
nullable: true
type: object
Status:
type: number
x-enum-type: IntelliTracer.ApiV1.AssetInspectionState
enum:
- 0
- 1
- 2
description: (default = 0)
Comments:
description: (default = null)
nullable: true
type: string
DateCompleted:
description: (default = null)
nullable: true
type: string
Picture:
description: (default = null)
nullable: true
type: string
required:
- Id
- AssetId
- Type
examples:
response:
value:
Id: 00000000-0000-0000-0000-000000000000
AssetId: 00000000-0000-0000-0000-000000000000
Type:
Id: 00000000-0000-0000-0000-000000000000
Name: Inspection
Description: Description
Responsible: 0
WarningThresholdDays: 0
IntervalYears: 0
IntervalMonths: 6
IntervalDays: 0
Status: 0
Comments: Comments
DateCompleted: 2019-09-10
Picture: https://prodassetmanagement.blob.core.windows.net/geodynamics-899192c530d46fde13b9164f2ea1253d/assets/3022e805-e786-4564-b561-0685920de8dd.jpg
"400":
description: BadRequest
headers: {}
content:
application/json:
schema:
$ref: "#/components/schemas/IntelliTracer.ApiV1.PoiValidationResult"
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Create asset inspection
operationId: Create asset inspection
description: |-
Creates a new asset inspection.
*Privilege required: `Api: Asset management`*
x-resource: Asset inspections
tags:
- Assets
requestBody:
content:
application/json:
schema:
type: object
properties:
AssetId:
type: string
TypeId:
type: string
Status:
type: number
x-enum-type: IntelliTracer.ApiV1.AssetInspectionState
enum:
- 0
- 1
- 2
description: (default = 0)
Comments:
description: (default = null)
nullable: true
type: string
DateCompleted:
description: (default = null)
nullable: true
type: string
Picture:
description: (default = null)
nullable: true
type: string
required:
- AssetId
- TypeId
example:
AssetId: 00000000-0000-0000-0000-000000000000
TypeId: 00000000-0000-0000-0000-000000000000
Status: 0
Comments: Comments
DateCompleted: 2019-09-10
Picture: https://prodassetmanagement.blob.core.windows.net/geodynamics-899192c530d46fde13b9164f2ea1253d/assets/3022e805-e786-4564-b561-0685920de8dd.jpg
security:
- pat: []
post:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Id:
type: string
AssetId:
type: string
Type:
properties:
Id:
type: string
Name:
description: (default = null)
nullable: true
type: string
Description:
description: (default = null)
nullable: true
type: string
Responsible:
x-enum-type: IntelliTracer.ApiV1.InspectionResponsible
enum:
- 0
- 1
- null
nullable: true
type: number
WarningThresholdDays:
description: (default = null)
nullable: true
type: number
IntervalYears:
description: (default = null)
nullable: true
type: number
IntervalMonths:
description: (default = null)
nullable: true
type: number
IntervalDays:
description: (default = null)
nullable: true
type: number
required:
- Id
- Name
nullable: true
type: object
Status:
type: number
x-enum-type: IntelliTracer.ApiV1.AssetInspectionState
enum:
- 0
- 1
- 2
description: (default = 0)
Comments:
description: (default = null)
nullable: true
type: string
DateCompleted:
description: (default = null)
nullable: true
type: string
Picture:
description: (default = null)
nullable: true
type: string
required:
- Id
- AssetId
- Type
examples:
response:
value:
Id: 00000000-0000-0000-0000-000000000000
AssetId: 00000000-0000-0000-0000-000000000000
Type:
Id: 00000000-0000-0000-0000-000000000000
Name: Inspection
Description: Description
Responsible: 0
WarningThresholdDays: 0
IntervalYears: 0
IntervalMonths: 6
IntervalDays: 0
Status: 0
Comments: Comments
DateCompleted: 2019-09-10
Picture: https://prodassetmanagement.blob.core.windows.net/geodynamics-899192c530d46fde13b9164f2ea1253d/assets/3022e805-e786-4564-b561-0685920de8dd.jpg
"400":
description: BadRequest
headers: {}
content:
application/json:
schema:
$ref: "#/components/schemas/IntelliTracer.ApiV1.PoiValidationResult"
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Update asset inspection
operationId: Update asset inspection
description: |-
Updates an existing asset inspection.
*Privilege required: `Api: Asset management`*
x-resource: Asset inspections
tags:
- Assets
requestBody:
content:
application/json:
schema:
type: object
properties:
Id:
type: string
AssetId:
type: string
TypeId:
type: string
Status:
type: number
x-enum-type: IntelliTracer.ApiV1.AssetInspectionState
enum:
- 0
- 1
- 2
description: (default = 0)
Comments:
description: (default = null)
nullable: true
type: string
DateCompleted:
description: (default = null)
nullable: true
type: string
Picture:
description: (default = null)
nullable: true
type: string
required:
- Id
- AssetId
example:
Id: 00000000-0000-0000-0000-000000000000
AssetId: 00000000-0000-0000-0000-000000000000
TypeId: 00000000-0000-0000-0000-000000000000
Status: 0
Comments: Comments
DateCompleted: 2019-09-10
Picture: https://prodassetmanagement.blob.core.windows.net/geodynamics-899192c530d46fde13b9164f2ea1253d/assets/3022e805-e786-4564-b561-0685920de8dd.jpg
security:
- pat: []
"/api/v3/asset/{assetId}/identification?page={page}&search={search}":
get:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
$ref: "#/components/schemas/IntelliTracer.ApiV3.AssetIdentificationPagedDataResponse"
examples:
response:
value:
Data:
- Id: 00000000-0000-0000-0000-000000000000
BadgeId: 00000000-0000-0000-0000-000000000000
Value: 123ABC
Type: 0
PagingFilter:
Page: 1
Search: ABC
PageCount: 4
TotalCount: 100
Links:
Base: https://api.intellitracer.be
First: /api/v2/asset?page=1
Prev: /api/v2/asset?page=2
Next: /api/v2/asset?page=4
Last: /api/v2/asset?page=4
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Get asset identifications
operationId: Get asset identifications
description: |-
Returns a paged list of asset identifications for an asset.
Pagination and searching is explained in [Pagination](#pagination).
*Privilege required: `Api: Asset management`*
x-resource: Asset identifications
tags:
- Assets
parameters:
- name: assetId
in: path
description: ""
required: true
example: 00000000-0000-0000-0000-000000000000
schema:
type: string
- name: page
in: path
description: ""
required: true
example: "1"
schema:
type: number
- name: search
in: path
description: ""
required: true
example: ABC
schema:
type: string
security:
- pat: []
"/api/v3/asset/{assetId}/identification/badge/{badgeId}":
get:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Data:
description: (default = null)
nullable: true
type: array
items: {}
examples:
response:
value:
Data:
- Id: 00000000-0000-0000-0000-000000000000
BadgeId: 00000000-0000-0000-0000-000000000000
Value: 123ABC
Type: 0
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"404":
description: NotFound
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Get asset identifications by badge id
operationId: Get asset identifications by badge id
description: |-
Returns all asset identifications for an asset by badge id.
*Privilege required: `Api: Asset management`*
x-resource: Asset identifications
tags:
- Assets
parameters:
- name: assetId
in: path
description: ""
required: true
example: 00000000-0000-0000-0000-000000000000
schema:
type: string
- name: badgeId
in: path
description: ""
required: true
example: 00000000-0000-0000-0000-000000000000
schema:
type: string
security:
- pat: []
delete:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Data:
description: (default = null)
nullable: true
type: array
items: {}
examples:
response:
value:
Data:
- Id: 00000000-0000-0000-0000-000000000000
BadgeId: 00000000-0000-0000-0000-000000000000
Value: 123ABC
Type: 0
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Delete asset identifications by badge id
operationId: Delete asset identifications by badge id
description: |-
Deletes all asset identifications for an asset by badge id.
*Privilege required: `Api: Asset management`*
x-resource: Asset identifications
tags:
- Assets
parameters:
- name: assetId
in: path
description: ""
required: true
example: 00000000-0000-0000-0000-000000000000
schema:
type: string
- name: badgeId
in: path
description: ""
required: true
example: 00000000-0000-0000-0000-000000000000
schema:
type: string
security:
- pat: []
"/api/v3/asset/{assetId}/identification/custom/{value}":
get:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Data:
properties:
Id:
type: string
BadgeId:
description: (default = null)
nullable: true
type: string
Value:
description: (default = null)
nullable: true
type: string
Type:
type: number
x-enum-type: IntelliTracer.Domain.AssetIdentificationType
enum:
- -1
- 0
- 1
- 2
required:
- Id
- Type
description: (default = null)
nullable: true
type: object
examples:
response:
value:
Data:
Id: 00000000-0000-0000-0000-000000000000
BadgeId: 00000000-0000-0000-0000-000000000000
Value: 123ABC
Type: 0
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Get asset identification by custom value
operationId: Get asset identification by custom value
description: |-
Returns an asset identification for an asset by custom value.
*Privilege required: `Api: Asset management`*
x-resource: Asset identifications
tags:
- Assets
parameters:
- name: assetId
in: path
description: ""
required: true
example: 00000000-0000-0000-0000-000000000000
schema:
type: string
- name: value
in: path
description: ""
required: true
example: 123ABC
schema:
type: string
security:
- pat: []
delete:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Data:
properties:
Id:
type: string
BadgeId:
description: (default = null)
nullable: true
type: string
Value:
description: (default = null)
nullable: true
type: string
Type:
type: number
x-enum-type: IntelliTracer.Domain.AssetIdentificationType
enum:
- -1
- 0
- 1
- 2
required:
- Id
- Type
description: (default = null)
nullable: true
type: object
examples:
response:
value:
Data:
Id: 00000000-0000-0000-0000-000000000000
BadgeId: 00000000-0000-0000-0000-000000000000
Value: 123ABC
Type: 0
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Delete asset identification by custom value
operationId: Delete asset identification by custom value
description: |-
Deletes an asset identification for an asset by custom value.
*Privilege required: `Api: Asset management`*
x-resource: Asset identifications
tags:
- Assets
parameters:
- name: assetId
in: path
description: ""
required: true
example: 00000000-0000-0000-0000-000000000000
schema:
type: string
- name: value
in: path
description: ""
required: true
example: 123ABC
schema:
type: string
security:
- pat: []
"/api/v3/asset/{assetId}/identification/badge":
put:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Data:
description: (default = null)
nullable: true
type: array
items: {}
examples:
response:
value:
Data:
- Id: 00000000-0000-0000-0000-000000000000
BadgeId: 00000000-0000-0000-0000-000000000000
Value: 123ABC
Type: 0
"400":
description: Bad Request
headers: {}
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Create asset identification by badge id
operationId: Create asset identification by badge id
description: |-
Creates a new asset identification by badge id.
*Privilege required: `Api: Asset management`*
x-resource: Asset identifications
tags:
- Assets
parameters:
- name: assetId
in: path
description: ""
required: true
example: 00000000-0000-0000-0000-000000000000
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
properties:
BadgeId:
type: string
required:
- BadgeId
example:
BadgeId: 00000000-0000-0000-0000-000000000000
security:
- pat: []
"/api/v3/asset/{assetId}/identification/custom":
put:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Data:
properties:
Id:
type: string
BadgeId:
description: (default = null)
nullable: true
type: string
Value:
description: (default = null)
nullable: true
type: string
Type:
type: number
x-enum-type: IntelliTracer.Domain.AssetIdentificationType
enum:
- -1
- 0
- 1
- 2
required:
- Id
- Type
description: (default = null)
nullable: true
type: object
examples:
response:
value:
Data:
Id: 00000000-0000-0000-0000-000000000000
BadgeId: 00000000-0000-0000-0000-000000000000
Value: 123ABC
Type: 0
"400":
description: Bad Request
headers: {}
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Create asset identification by custom value
operationId: Create asset identification by custom value
description: |-
Creates a new asset identification by custom value.
*Privilege required: `Api: Asset management`*
x-resource: Asset identifications
tags:
- Assets
parameters:
- name: assetId
in: path
description: ""
required: true
example: 00000000-0000-0000-0000-000000000000
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
properties:
Value:
type: string
required:
- Value
example:
Value: 123ABC
security:
- pat: []
post:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Data:
properties:
Id:
type: string
BadgeId:
description: (default = null)
nullable: true
type: string
Value:
description: (default = null)
nullable: true
type: string
Type:
type: number
x-enum-type: IntelliTracer.Domain.AssetIdentificationType
enum:
- -1
- 0
- 1
- 2
required:
- Id
- Type
description: (default = null)
nullable: true
type: object
examples:
response:
value:
Data:
Id: 00000000-0000-0000-0000-000000000000
BadgeId: 00000000-0000-0000-0000-000000000000
Value: 123ABC
Type: 0
"400":
description: Bad Request
headers: {}
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Update asset identification by custom value
operationId: Update asset identification by custom value
description: |-
Updates an existing asset identification by custom value.
Only personalized assets can be updated.
*Privilege required: `Api: Asset management`*
x-resource: Asset identifications
tags:
- Assets
parameters:
- name: assetId
in: path
description: ""
required: true
example: 00000000-0000-0000-0000-000000000000
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
properties:
Id:
type: string
Value:
type: string
required:
- Id
- Value
example:
Id: 00000000-0000-0000-0000-000000000000
Value: 123ABC
security:
- pat: []
"/api/v2/absencetype?page={page}&search={search}":
get:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Data:
description: (default = null)
nullable: true
type: array
items: {}
PagingFilter:
properties:
Page:
type: number
Search:
nullable: true
type: string
PageCount:
type: number
TotalCount:
type: number
Links:
type: object
properties:
Base:
type: string
First:
type: string
Prev:
type: string
Next:
type: string
Last:
type: string
required:
- Base
required:
- Page
- PageCount
- TotalCount
- Links
description: (default = null)
nullable: true
type: object
examples:
response:
value:
Data:
- Name: Sickness
AbsenceCode: "100"
Paid: false
TemporaryUnemployment: false
Color: "#000000"
IncludeInExport: true
Id: 00000000-0000-0000-0000-000000000000
PagingFilter:
Page: 1
Search: ABC
PageCount: 4
TotalCount: 100
Links:
Base: https://api.intellitracer.be
First: /api/v2/asset?page=1
Prev: /api/v2/asset?page=2
Next: /api/v2/asset?page=4
Last: /api/v2/asset?page=4
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Get absence types
operationId: Get absence types
description: |-
Returns a paged list of absence types.
*Privilege required: `Api: Timesheet read` or `Api: Timesheet management`*
x-resource: Absence types
tags:
- Absences
parameters:
- name: page
in: path
description: ""
required: true
example: "1"
schema:
type: number
- name: search
in: path
description: ""
required: true
example: ABC
schema:
type: string
security:
- pat: []
"/api/v2/absencetype/{id}":
get:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Data:
properties:
Name:
description: (default = null)
nullable: true
type: string
AbsenceCode:
description: (default = null)
nullable: true
type: string
Paid:
type: boolean
description: (default = false)
TemporaryUnemployment:
type: boolean
description: (default = false)
Color:
description: (default = null)
nullable: true
type: string
IncludeInExport:
type: boolean
description: >-
(default = true)
Determines whether absences of this type will be included in exports to social secretaries created through specific Excel exports generated via our website.
Id:
type: string
required:
- Name
- AbsenceCode
- Id
description: (default = null)
nullable: true
type: object
examples:
response:
value:
Data:
Name: Sickness
AbsenceCode: "100"
Paid: false
TemporaryUnemployment: false
Color: "#000000"
IncludeInExport: true
Id: 00000000-0000-0000-0000-000000000000
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"404":
description: NotFound
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Get absence type by Id
operationId: Get absence type by Id
description: |-
Gets an absence type by its Id.
*Privilege required: `Api: Timesheet read` or `Api: Timesheet management`*
x-resource: Absence types
tags:
- Absences
parameters:
- name: id
in: path
description: ""
required: true
example: 00000000-0000-0000-0000-000000000000
schema:
type: string
security:
- pat: []
delete:
responses:
"200":
description: OK
headers: {}
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Delete absence type
operationId: Delete absence type
description: |-
Deletes an absence type.
*Privilege required: `Api: Timesheet management`*
x-resource: Absence types
tags:
- Absences
parameters:
- name: id
in: path
description: ""
required: true
example: 00000000-0000-0000-0000-000000000000
schema:
type: string
security:
- pat: []
/api/v2/absencetype:
put:
responses:
"200":
description: OK
headers: {}
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Create absence type
operationId: Create absence type
description: |-
Creates a new absence type.
*Privilege required: `Api: Timesheet management`*
x-resource: Absence types
tags:
- Absences
requestBody:
content:
application/json:
schema:
type: object
properties:
Name:
description: (default = null)
nullable: true
type: string
AbsenceCode:
description: (default = null)
nullable: true
type: string
Paid:
type: boolean
description: (default = false)
TemporaryUnemployment:
type: boolean
description: (default = false)
Color:
description: (default = null)
nullable: true
type: string
IncludeInExport:
type: boolean
description: >-
(default = true)
Determines whether absences of this type will be included in exports to social secretaries created through specific Excel exports generated via our website.
If unsure, don't include this boolean in your request or leave it on 'true'.
required:
- Name
- AbsenceCode
example:
Name: Sickness
AbsenceCode: "100"
Paid: false
TemporaryUnemployment: false
Color: "#000000"
IncludeInExport: true
security:
- pat: []
"/api/v2/absence/user/list?page={page}&search={search}":
post:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Data:
description: (default = null)
nullable: true
type: array
items: {}
PagingFilter:
properties:
Page:
type: number
Search:
nullable: true
type: string
PageCount:
type: number
TotalCount:
type: number
Links:
type: object
properties:
Base:
type: string
First:
type: string
Prev:
type: string
Next:
type: string
Last:
type: string
required:
- Base
required:
- Page
- PageCount
- TotalCount
- Links
description: (default = null)
nullable: true
type: object
examples:
response:
value:
Data:
- User:
Id: 00000000-0000-0000-0000-000000000000
Code: "012345"
Name: John Doe
Type: 0
Absences:
- Id: 00000000-0000-0000-0000-000000000000
Date: 2019-01-24
AbsenceType:
Name: Sickness
AbsenceCode: "100"
Paid: false
TemporaryUnemployment: false
Color: "#000000"
IncludeInExport: true
Start: 2019-01-24T07:00:00+01:00
Stop: 2019-01-24T15:00:00+01:00
Duration: 08:00:00
Notes: Notes
PagingFilter:
Page: 1
Search: ABC
PageCount: 4
TotalCount: 100
Links:
Base: https://api.intellitracer.be
First: /api/v2/asset?page=1
Prev: /api/v2/asset?page=2
Next: /api/v2/asset?page=4
Last: /api/v2/asset?page=4
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Get absences
operationId: Get absences
description: >-
Returns a paged list of absences within a date/time range for one or
more users.
Pagination and searching is explained in [Pagination](#pagination).
*Privilege required: `Api: Timesheet management`*
x-resource: Absences
tags:
- Absences
parameters:
- name: page
in: path
description: ""
required: true
example: "1"
schema:
type: number
- name: search
in: path
description: ""
required: true
example: ABC
schema:
type: string
requestBody:
$ref: "#/components/requestBodies/Get_absencesBody"
security:
- pat: []
/api/v2/absence/bulk/user:
post:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Data:
description: (default = null)
nullable: true
type: array
items: {}
examples:
response:
value:
Data:
- User:
Id: 00000000-0000-0000-0000-000000000000
Code: "012345"
Name: John Doe
Type: 0
Absences:
- Id: 00000000-0000-0000-0000-000000000000
Date: 2019-01-24
AbsenceType:
Name: Sickness
AbsenceCode: "100"
Paid: false
TemporaryUnemployment: false
Color: "#000000"
IncludeInExport: true
Start: 2019-01-24T07:00:00+01:00
Stop: 2019-01-24T15:00:00+01:00
Duration: 08:00:00
Notes: Notes
"400":
description: BadRequest
headers: {}
content:
application/json:
schema:
type: object
properties:
Data:
description: (default = null)
nullable: true
type: array
items: {}
examples:
response:
value:
Data:
- Entity:
Id: 00000000-0000-0000-0000-000000000000
Date: 2019-01-24
AbsenceType:
Name: Sickness
AbsenceCode: "100"
Paid: false
TemporaryUnemployment: false
Color: "#000000"
IncludeInExport: true
Start: 2019-01-24T07:00:00+01:00
Stop: 2019-01-24T15:00:00+01:00
Duration: 08:00:00
Notes: Notes
ValidationResult:
- Message: ""
SourceMemberNames: []
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Update absences by user
operationId: Update absences by user
description: >-
Updates the absences for one user on one or more days. Existing absences
for these users/days are removed.
The number of days is limited to a maximum of 100.
*Privilege required: `Api: Timesheet management`*
x-resource: Absences
tags:
- Absences
requestBody:
content:
application/json:
schema:
type: object
properties:
UserId:
type: string
Absences:
type: array
items: {}
required:
- UserId
- Absences
example:
UserId: 00000000-0000-0000-0000-000000000000
Absences:
- Date: 2019-01-24
Absence:
AbsenceCode: SICKNESS
Start: 07:00:00
Stop: 15:00:00
security:
- pat: []
/api/v2/absence/bulk/date:
post:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Data:
description: (default = null)
nullable: true
type: array
items: {}
examples:
response:
value:
Data:
- User:
Id: 00000000-0000-0000-0000-000000000000
Code: "012345"
Name: John Doe
Type: 0
Absences:
- Id: 00000000-0000-0000-0000-000000000000
Date: 2019-01-24
AbsenceType:
Name: Sickness
AbsenceCode: "100"
Paid: false
TemporaryUnemployment: false
Color: "#000000"
IncludeInExport: true
Start: 2019-01-24T07:00:00+01:00
Stop: 2019-01-24T15:00:00+01:00
Duration: 08:00:00
Notes: Notes
"400":
description: BadRequest
headers: {}
content:
application/json:
schema:
type: object
properties:
Data:
description: (default = null)
nullable: true
type: array
items: {}
examples:
response:
value:
Data:
- Entity:
Id: 00000000-0000-0000-0000-000000000000
Date: 2019-01-24
AbsenceType:
Name: Sickness
AbsenceCode: "100"
Paid: false
TemporaryUnemployment: false
Color: "#000000"
IncludeInExport: true
Start: 2019-01-24T07:00:00+01:00
Stop: 2019-01-24T15:00:00+01:00
Duration: 08:00:00
Notes: Notes
ValidationResult:
- Message: ""
SourceMemberNames: []
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Update absences by date
operationId: Update absences by date
description: >-
Updates the absences for one or more users on one day. Existing absences
for these users/days are removed.
The number of users is limited to a maximum of 100.
*Privilege required: `Api: Timesheet management`*
x-resource: Absences
tags:
- Absences
requestBody:
content:
application/json:
schema:
type: object
properties:
Date:
type: string
Absences:
type: array
items: {}
required:
- Date
- Absences
example:
Date: 2019-01-24
Absences:
- UserId: 00000000-0000-0000-0000-000000000000
Absence:
AbsenceCode: SICKNESS
Start: 07:00:00
Stop: 15:00:00
security:
- pat: []
"/api/v3/absencerequests/user/?page={page}&search={search}&includeResolvedRequests={includeResolvedRequests}":
post:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Data:
description: (default = null)
nullable: true
type: array
items: {}
PagingFilter:
properties:
Page:
type: number
Search:
nullable: true
type: string
PageCount:
type: number
TotalCount:
type: number
Links:
type: object
properties:
Base:
type: string
First:
type: string
Prev:
type: string
Next:
type: string
Last:
type: string
required:
- Base
required:
- Page
- PageCount
- TotalCount
- Links
description: (default = null)
nullable: true
type: object
examples:
response:
value:
Data:
- User:
Id: 00000000-0000-0000-0000-000000000000
Code: "012345"
Name: John Doe
Type: ""
AbsenceRequests:
- Id: 00000000-0000-0000-0000-000000000000
RequestDateTime: 2019-01-24T07:00:00+01:00
Type: ""
AbsenceType:
Id: 00000000-0000-0000-0000-000000000000
Name: Sick leave
Code: SICKNESS
Paid: true
TemporaryUnemployed: false
Color: "#FF0000"
IncludeInExport: true
Date: 2019-01-24
TimeslotType: ""
Status: ""
Hours: 4
PagingFilter:
Page: 1
Search: ABC
PageCount: 4
TotalCount: 100
Links:
Base: https://api.intellitracer.be
First: /api/v2/asset?page=1
Prev: /api/v2/asset?page=2
Next: /api/v2/asset?page=4
Last: /api/v2/asset?page=4
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Get absence requests
operationId: Get absence requests
description: >-
Returns a paged list of absence requests within a date/time range for
one or more users.
Pagination and searching is explained in [Pagination](#pagination).
*Privilege required: `Api: Timesheet management`*
x-resource: Absence Requests
tags:
- Absences
parameters:
- name: page
in: path
description: ""
required: true
example: "1"
schema:
type: number
- name: search
in: path
description: ""
required: true
example: ABC
schema:
type: string
- name: includeResolvedRequests
in: path
description: ""
required: true
example: "false"
schema:
type: boolean
requestBody:
$ref: "#/components/requestBodies/Get_absencesBody"
security:
- pat: []
"/api/v3/absencerequest/{id}/approve":
post:
responses:
"200":
description: OK
headers: {}
"400":
description: BadRequest
headers: {}
content:
application/json:
schema:
type: array
items: {}
examples:
response:
value:
- Property: Name
Message: Required
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Approve absence request
operationId: Approve absence request
description: |-
Approves an absence request.
*Privilege required: `Api: Timesheet management`*
x-resource: Absence Requests
tags:
- Absences
parameters:
- name: id
in: path
description: ""
required: true
example: 00000000-0000-0000-0000-000000000000
schema:
type: string
security:
- pat: []
"/api/v3/absencerequest/{id}/refuse":
post:
responses:
"200":
description: OK
headers: {}
"400":
description: BadRequest
headers: {}
content:
application/json:
schema:
type: array
items: {}
examples:
response:
value:
- Property: Name
Message: Required
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Refuse absence request
operationId: Refuse absence request
description: |-
Refuses an absence request.
*Privilege required: `Api: Timesheet management`*
x-resource: Absence Requests
tags:
- Absences
parameters:
- name: id
in: path
description: ""
required: true
example: 00000000-0000-0000-0000-000000000000
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
properties:
Notes:
type: string
required:
- Notes
example:
Notes: I'm sorry, but I can't approve this request.
security:
- pat: []
"/api/v2/postcalculation/export?page={page}&search={search}":
post:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Data:
type: array
items:
$ref: "#/components/schemas/IntelliTracer.ApiV2.PostCalculationExport"
PagingFilter:
$ref: "#/components/schemas/IntelliTracer.Api.PagingFilter"
examples:
response:
value:
Data:
- User:
Id: 00000000-0000-0000-0000-000000000000
Name: John Doe
Code: "012345"
EmployerCode: ReplaceWithEncodedAuthentication
FreeField1: null
FreeField2: null
FreeField3: null
FreeField4: null
FreeField5: null
FreeField6: null
DateUtc: 2019-01-18T00:00:00
DateLocal: 2019-01-18T00:00:00
TimeSheet:
NormalHours: 7.6
WorkedHours: 7.6
NormalWorkedHours: 7.6
Pause: 0.3
LoadUnload: 7.6
OvertimePositive: 7.6
OvertimeNegative: 7.6
OvertimeFirstHour: 7.6
OvertimeExtraHours: 7.6
OvertimeFirstHourCode: "`123'"
OvertimeExtraHoursCode: "`123'"
PoiCodeStart: "`012345'"
PoiNameStart: "`Poi 1'"
VehicleNameStart: "`Vehicle 1'"
PoiCodeStop: "`012345'"
PoiNameStop: "`Poi 1'"
VehicleNameStop: "`Vehicle 1'"
Mobility:
KmDriver: 100.2
KmPassenger: 100.2
KmSingleDriver: 12.4
KmHomeWork: 100.2
KmHomeSite: 100.2
KmHomeOther: 100.2
EurDriver: 9.53
EurPassenger: 9.53
EurSingleDriver: 6.53
EurHomeWork: 9.53
EurHomeSite: 9.53
EurHomeOther: 9.53
EurMobility: 9.53
Absence:
Duration: 7.6
Code: SICKNESS
StartMovementUtc: 07:03:55
StartMovementLocal: 07:03:55
StartWorkUtc: 07:03:55
StartWorkLocal: 07:03:55
StopWorkUtc: 07:03:55
StopWorkLocal: 07:03:55
StopMovementUtc: 07:03:55
StopMovementLocal: 07:03:55
TimesheetEvents:
- Type: 0
EventType: 0
StartDateTimeLocal: 2019-03-12T11:01:51
StartDateTimeUtc: 2019-03-12T11:00:51
StopDateTimeLocal: 2019-03-12T11:01:51
StopDateTimeUtc: 2019-03-12T11:00:51
StartResource:
Id: 00000000-0000-0000-0000-000000000000
Code: "012345"
Name: John Doe
Type: 0
StopResource:
Id: 00000000-0000-0000-0000-000000000000
Code: "012345"
Name: John Doe
Type: 0
StartLocation:
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
StopLocation:
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
Duration: 00:37:54
Mileage: 1245.4
MileageBirdflight: 1100.5
JobNumber: "12345"
PostCalculationEvents:
- CostCenter: Workplace 1
CostCenterFullCode: Workplace 1
ActivityCode: "001"
ActivityContext1: Context 1
ActivityContext2: Context2
ActivityContext3: Context3
Duration: 7.6
TimeFromLocal: 2019-01-18T05:54:15
TimeFromUtc: 2019-01-18T06:54:15
TimeToLocal: 2019-01-18T05:58:16
TimeToUtc: 2019-01-18T06:58:16
Mobility:
KmDriver: 100.2
KmPassenger: 100.2
KmSingleDriver: 12.4
KmHomeWork: 100.2
KmHomeSite: 100.2
KmHomeOther: 100.2
EurDriver: 9.53
EurPassenger: 9.53
EurSingleDriver: 6.53
EurHomeWork: 9.53
EurHomeSite: 9.53
EurHomeOther: 9.53
EurMobility: 9.53
Resource:
Id: 00000000-0000-0000-0000-000000000000
Code: "012345"
Name: John Doe
Type: 0
Details:
DirectAssignedWorkTime: 7.6
IndirectAssignedWorkTime: 7.6
IndirectAssignedMobilityBeforeTime: 7.6
IndirectAssignedMobilityAfterTime: 7.6
IndirectAssignedMobilityTotalTime: 7.6
IndirectAssignedLoadUnloadTime: 7.6
IndirectAssignedTravelTime: 7.6
IndirectAssignedAbsencePaidTime: 7.6
IndirectAssignedAbsenceUnpaidTime: 7.6
DirectAssignedWorkDistance: 7.6
IndirectAssignedWorkDistance: 7.6
IndirectAssignedMobilityBeforeDistance: 7.6
IndirectAssignedMobilityAfterDistance: 7.6
IndirectAssignedMobilityTotalDistance: 7.6
IndirectAssignedLoadUnloadDistance: 7.6
IndirectAssignedTravelDistance: 7.6
TotalAssignedTime: 7.6
TotalAssignedDistance: 7.6
NormalWorkedHours: 7.6
FirstOvertimeHour: 7.6
ExtraOvertimeHours: 7.6
IndirectEvents:
- Type: 0
Duration: 9.53
Resource:
Id: 00000000-0000-0000-0000-000000000000
Code: "012345"
Name: John Doe
Type: 0
JobNumber: "12345"
TimeValidation:
Approvals:
- Approver:
Id: 00000000-0000-0000-0000-000000000000
Code: "012345"
Name: John Doe
Type: 0
Disapprovals:
- Disapprover:
Id: 00000000-0000-0000-0000-000000000000
Code: "012345"
Name: John Doe
Type: 0
Reason:
En: Bad
Nl: Slecht
Fr: Pas bien
PostCalculationLog:
- Data: ""
Entries:
- {}
Verified: null
VerifiedDateUtc: 2019-01-18T00:00:00
VerifiedDateLocal: 2019-01-18T00:00:00
PagingFilter:
Page: 1
Search: ABC
PageCount: 4
TotalCount: 100
Links:
Base: https://api.intellitracer.be
First: /api/v2/postcalculation/export?page=1
Prev: /api/v2/postcalculation/export?page=1
Next: /api/v2/postcalculation/export?page=2
Last: /api/v2/postcalculation/export?page=4
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Export post calculation
operationId: Export post calculation
description: >-
Exports the time registration enriched with post calculation information
if available. Results are grouped per day, per user.
In order to export time registration for all users, set *AllUsers* to `true`.
In order to export time registration for the listed users, set *AllUsers* to `false`.
*Privilege required: `Api: Postcalculation`*
x-resource: Export
tags:
- Post Calculation
parameters:
- name: page
in: path
description: ""
required: true
example: "1"
schema:
type: number
- name: search
in: path
description: ""
required: true
example: ABC
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
properties:
UserIds:
description: (default = null)
nullable: true
type: array
items: {}
AllUsers:
type: boolean
description: (default = false)
Mode:
type: number
x-enum-type: IntelliTracer.ApiV2.PostCalculationExportType
enum:
- 0
- 1
description: |-
(default = 0)
Calculate the postcalculation by activity or by costcenter.
GroupCostcenterByActivity:
type: boolean
description: |-
(default = false)
Group postcalculation by activity?
DateUtc:
type: string
Filter:
description: |-
(default = null)
Filter on cost center.
nullable: true
type: string
IncludeTimesheet:
type: boolean
description: (default = false)
IncludeTimesheetEvents:
type: boolean
description: >-
(default = false)
Include an overview of every event this day. This is similar to the bar graphs you can find on the 'Overview per user per day' screen in IntelliTracer.
IncludeTimeValidation:
type: boolean
description: (default = false)
IncludePostCalculationLog:
type: boolean
description: (default = false)
IncludeLossCostcenter:
type: boolean
description: (default = false)
required:
- DateUtc
example:
UserIds:
- 00000000-0000-0000-0000-000000000000
- 00000000-0000-0000-0000-000000000000
AllUsers: false
Mode: 0
GroupCostcenterByActivity: false
DateUtc: 2019-01-18T00:00:00
Filter: null
IncludeTimesheet: false
IncludeTimesheetEvents: false
IncludeTimeValidation: false
IncludePostCalculationLog: false
IncludeLossCostcenter: false
security:
- pat: []
/api/v2/postcalculation/vehiclepercostcenter:
post:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/IntelliTracer.ApiV2.PostCalculationVehiclePerCostcenterExport"
examples:
response:
value:
- Poi:
Id: 00000000-0000-0000-0000-000000000000
Name: Home
Code: "012345"
Date: 2019-01-18
Vehicle:
Id: 00000000-0000-0000-0000-000000000000
Code: "012345"
Name: John Doe
Type: 0
TimeFrom: 00:00:00
TimeTo: 00:00:00
TimeDuration: 00:00:00
DrivingToMileage: "100"
DrivingToDuration: 00:00:00
DrivingAtMileage: "100"
DrivingAtDuration: 00:00:00
DurationContactOn: 00:00:00
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Vehicle per costcenter
operationId: Vehicle per costcenter
description: "*Privilege required: `Api: Postcalculation`*"
x-resource: Vehicle per costcenter
tags:
- Post Calculation
requestBody:
content:
application/json:
schema:
type: object
properties:
PoiIds:
type: array
description: "If no PoiIds are provided, the results will be for all Points of
Interest. "
items: {}
ResourceIds:
type: array
items: {}
FromDate:
type: string
ToDate:
type: string
MinimumDuration:
type: number
description: |-
(default = 0.0)
Minimum duration in minutes.
required:
- ResourceIds
- FromDate
- ToDate
example:
PoiIds:
- 00000000-0000-0000-0000-000000000000
- 00000000-0000-0000-0000-000000000000
ResourceIds:
- 00000000-0000-0000-0000-000000000000
- 00000000-0000-0000-0000-000000000000
FromDate: 2019-01-18T00:00:00
ToDate: 2019-01-20T00:00:00
MinimumDuration: 5
security:
- pat: []
/api/v1/access/schedule/all:
get:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/IntelliTracer.ApiV1.AccessScheduleLite"
examples:
response:
value:
- Id: 00000000-0000-0000-0000-000000000000
Name: Office hours
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Get access schedules
operationId: Get access schedules
description: >-
Returns a list of all access schedules.
*Privilege required: `Api: Accesscontrol read` or `Api: Accesscontrol edit`*
x-resource: Access schedules
tags:
- Access Control
security:
- pat: []
/api/v1/access/exceptionschedules:
get:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/IntelliTracer.ApiV1.AccessScheduleException"
examples:
response:
value:
- Id: 00000000-0000-0000-0000-000000000000
Name: Office hours
TimeClockIds: []
Dates: []
AccessControl: false
ConstantRelais: false
Pulse: false
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Get exceptions
operationId: Get exceptions
description: >-
Gets a list of all access schedule exceptions.
*Privilege required: `Api: Accesscontrol read` or `Api: Accesscontrol edit`*
x-resource: Access schedule exceptions
tags:
- Access Control
security:
- pat: []
put:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
$ref: "#/components/schemas/IntelliTracer.ApiV1.AccessScheduleException"
examples:
response:
value:
Id: 00000000-0000-0000-0000-000000000000
Name: Office hours
TimeClockIds: []
Dates: []
AccessControl: false
ConstantRelais: false
Pulse: false
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Create exception
operationId: Create exception
description: |-
Creates an access schedule exception.
*Privilege required: `Api: Accesscontrol edit`*
x-resource: Access schedule exceptions
tags:
- Access Control
requestBody:
content:
application/json:
schema:
type: object
properties:
Id:
type: string
description: "Optional on create. Send a new GUID when TimeClockIds is not empty: the time clocks are linked to this id."
Name:
type: string
description: Unique within your company, 50 characters at most.
TimeClockIds:
type: array
items:
type: string
Dates:
type: array
items:
type: string
description: "Only the date counts: send it without a time (2026-12-25), because the API converts a time with an offset to server time first, which can move it to another day."
AccessControl:
type: boolean
description: (default = false)
ConstantRelais:
type: boolean
description: (default = false)
Pulse:
type: boolean
description: (default = false)
required:
- Name
- TimeClockIds
- Dates
example:
Name: Office hours
TimeClockIds: []
Dates: []
AccessControl: false
ConstantRelais: false
Pulse: false
security:
- pat: []
post:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
$ref: "#/components/schemas/IntelliTracer.ApiV1.AccessScheduleException"
examples:
response:
value:
Id: 00000000-0000-0000-0000-000000000000
Name: Office hours
TimeClockIds: []
Dates: []
AccessControl: false
ConstantRelais: false
Pulse: false
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Update exception
operationId: Update exception
description: |-
Updates an access schedule exception.
*Privilege required: `Api: Accesscontrol edit`*
x-resource: Access schedule exceptions
tags:
- Access Control
requestBody:
content:
application/json:
schema:
type: object
properties:
Id:
type: string
Name:
type: string
description: Unique within your company, 50 characters at most.
TimeClockIds:
type: array
items:
type: string
description: "Replaces the time clocks of the exception: one you leave out is unlinked."
Dates:
type: array
items:
type: string
description: "Replaces the days of the exception. Only the date counts: send it without a time (2026-12-25), because the API converts a time with an offset to server time first."
AccessControl:
type: boolean
description: (default = false)
ConstantRelais:
type: boolean
description: (default = false)
Pulse:
type: boolean
description: (default = false)
required:
- Id
- Name
- TimeClockIds
- Dates
example:
Id: 00000000-0000-0000-0000-000000000000
Name: Office hours
TimeClockIds: []
Dates: []
AccessControl: false
ConstantRelais: false
Pulse: false
security:
- pat: []
"/api/v1/access/exceptionschedules/{id}":
get:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
$ref: "#/components/schemas/IntelliTracer.ApiV1.AccessScheduleException"
examples:
response:
value:
Id: 00000000-0000-0000-0000-000000000000
Name: Office hours
TimeClockIds: []
Dates: []
AccessControl: false
ConstantRelais: false
Pulse: false
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Get exception by Id
operationId: Get exception by Id
description: >-
Gets an access schedule exception by its Id.
*Privilege required: `Api: Accesscontrol read` or `Api: Accesscontrol edit`*
x-resource: Access schedule exceptions
tags:
- Access Control
parameters:
- name: id
in: path
description: ""
required: true
example: 00000000-0000-0000-0000-000000000000
schema:
type: string
security:
- pat: []
delete:
responses:
"200":
description: OK
headers: {}
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Delete exception by Id
operationId: Delete exception by Id
description: |-
Deletes an access schedule exception by its Id.
*Privilege required: `Api: Accesscontrol edit`*
x-resource: Access schedule exceptions
tags:
- Access Control
parameters:
- name: id
in: path
description: ""
required: true
example: 00000000-0000-0000-0000-000000000000
schema:
type: string
security:
- pat: []
"/api/v2/accessgroup?page={page}&search={search}":
get:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Data:
description: (default = null)
nullable: true
type: array
items: {}
PagingFilter:
properties:
Page:
type: number
Search:
nullable: true
type: string
PageCount:
type: number
TotalCount:
type: number
Links:
type: object
properties:
Base:
type: string
First:
type: string
Prev:
type: string
Next:
type: string
Last:
type: string
required:
- Base
required:
- Page
- PageCount
- TotalCount
- Links
description: (default = null)
nullable: true
type: object
examples:
response:
value:
Data:
- Id: 00000000-0000-0000-0000-000000000000
Name: Everyone
Users:
- Id: 00000000-0000-0000-0000-000000000000
Code: "012345"
Name: John Doe
Type: 0
PagingFilter:
Page: 1
Search: ABC
PageCount: 4
TotalCount: 100
Links:
Base: https://api.intellitracer.be
First: /api/v2/asset?page=1
Prev: /api/v2/asset?page=2
Next: /api/v2/asset?page=4
Last: /api/v2/asset?page=4
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Get access groups
operationId: Get access groups
description: >-
Returns a paged list of access groups.
Pagination and searching is explained in [Pagination](#pagination).
*Privilege required: `Api: Accesscontrol read` or `Api: Accesscontrol edit`*
x-resource: Access groups
tags:
- Access Control
parameters:
- name: page
in: path
description: ""
required: true
example: "1"
schema:
type: number
- name: search
in: path
description: ""
required: true
example: ABC
schema:
type: string
security:
- pat: []
"/api/v2/accessgroup/{id}":
get:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Data:
properties:
Id:
type: string
Name:
type: string
Users:
description: (default = [])
nullable: true
type: array
items: {}
required:
- Id
- Name
description: (default = null)
nullable: true
type: object
examples:
response:
value:
Data:
Id: 00000000-0000-0000-0000-000000000000
Name: Everyone
Users:
- Id: 00000000-0000-0000-0000-000000000000
Code: "012345"
Name: John Doe
Type: 0
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Get access group
operationId: Get access group
description: >-
Returns an access group by id.
*Privilege required: `Api: Accesscontrol read` or `Api: Accesscontrol edit`*
x-resource: Access groups
tags:
- Access Control
parameters:
- name: id
in: path
description: ""
required: true
example: 00000000-0000-0000-0000-000000000000
schema:
type: string
security:
- pat: []
delete:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Data:
properties:
Id:
type: string
Name:
type: string
Users:
description: (default = [])
nullable: true
type: array
items: {}
required:
- Id
- Name
description: (default = null)
nullable: true
type: object
examples:
response:
value:
Data:
Id: 00000000-0000-0000-0000-000000000000
Name: Everyone
Users:
- Id: 00000000-0000-0000-0000-000000000000
Code: "012345"
Name: John Doe
Type: 0
"400":
description: BadRequest
headers: {}
content:
application/json:
schema:
type: object
properties:
Entity:
type: object
properties:
Id:
type: string
Name:
type: string
Users:
description: (default = [])
nullable: true
type: array
items: {}
required:
- Id
- Name
ValidationResult:
type: array
items: {}
required:
- Entity
- ValidationResult
examples:
response:
value:
Entity:
Id: 00000000-0000-0000-0000-000000000000
Name: Everyone
Users:
- Id: 00000000-0000-0000-0000-000000000000
Code: "012345"
Name: John Doe
Type: 0
ValidationResult:
- Message: ""
SourceMemberNames: []
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Delete access group
operationId: Delete access group
description: |-
Deletes an access group.
*Privilege required: `Api: Accesscontrol edit`*
x-resource: Access groups
tags:
- Access Control
parameters:
- name: id
in: path
description: ""
required: true
example: 00000000-0000-0000-0000-000000000000
schema:
type: string
security:
- pat: []
/api/v2/accessgroup:
put:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Data:
properties:
Id:
type: string
Name:
type: string
Users:
description: (default = [])
nullable: true
type: array
items: {}
required:
- Id
- Name
description: (default = null)
nullable: true
type: object
examples:
response:
value:
Data:
Id: 00000000-0000-0000-0000-000000000000
Name: Everyone
Users:
- Id: 00000000-0000-0000-0000-000000000000
Code: "012345"
Name: John Doe
Type: 0
"400":
description: BadRequest
headers: {}
content:
application/json:
schema:
type: object
properties:
Entity:
type: object
properties:
Id:
type: string
Name:
type: string
Users:
description: (default = [])
nullable: true
type: array
items: {}
required:
- Id
- Name
ValidationResult:
type: array
items: {}
required:
- Entity
- ValidationResult
examples:
response:
value:
Entity:
Id: 00000000-0000-0000-0000-000000000000
Name: Everyone
Users:
- Id: 00000000-0000-0000-0000-000000000000
Code: "012345"
Name: John Doe
Type: 0
ValidationResult:
- Message: ""
SourceMemberNames: []
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Create access group
operationId: Create access group
description: |-
Creates a new access group.
*Privilege required: `Api: Accesscontrol edit`*
x-resource: Access groups
tags:
- Access Control
requestBody:
content:
application/json:
schema:
type: object
properties:
Name:
type: string
UserIds:
description: (default = [])
nullable: true
type: array
items: {}
required:
- Name
example:
Name: Everyone
UserIds:
- 00000000-0000-0000-0000-000000000000
- 00000000-0000-0000-0000-000000000000
security:
- pat: []
post:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Data:
properties:
Id:
type: string
Name:
type: string
Users:
description: (default = [])
nullable: true
type: array
items: {}
required:
- Id
- Name
description: (default = null)
nullable: true
type: object
examples:
response:
value:
Data:
Id: 00000000-0000-0000-0000-000000000000
Name: Everyone
Users:
- Id: 00000000-0000-0000-0000-000000000000
Code: "012345"
Name: John Doe
Type: 0
"400":
description: BadRequest
headers: {}
content:
application/json:
schema:
type: object
properties:
Entity:
type: object
properties:
Id:
type: string
Name:
type: string
Users:
description: (default = [])
nullable: true
type: array
items: {}
required:
- Id
- Name
ValidationResult:
type: array
items: {}
required:
- Entity
- ValidationResult
examples:
response:
value:
Entity:
Id: 00000000-0000-0000-0000-000000000000
Name: Everyone
Users:
- Id: 00000000-0000-0000-0000-000000000000
Code: "012345"
Name: John Doe
Type: 0
ValidationResult:
- Message: ""
SourceMemberNames: []
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Update access group
operationId: Update access group
description: |-
Updates an access group.
*Privilege required: `Api: Accesscontrol edit`*
x-resource: Access groups
tags:
- Access Control
requestBody:
content:
application/json:
schema:
type: object
properties:
Id:
type: string
Name:
type: string
UserIds:
description: (default = [])
nullable: true
type: array
items: {}
required:
- Id
- Name
example:
Id: 00000000-0000-0000-0000-000000000000
Name: Everyone
UserIds:
- 00000000-0000-0000-0000-000000000000
- 00000000-0000-0000-0000-000000000000
security:
- pat: []
"/api/v2/accessgroup/{id}/user":
put:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Data:
properties:
Id:
type: string
Name:
type: string
Users:
description: (default = [])
nullable: true
type: array
items: {}
required:
- Id
- Name
description: (default = null)
nullable: true
type: object
examples:
response:
value:
Data:
Id: 00000000-0000-0000-0000-000000000000
Name: Everyone
Users:
- Id: 00000000-0000-0000-0000-000000000000
Code: "012345"
Name: John Doe
Type: 0
"400":
description: BadRequest
headers: {}
content:
application/json:
schema:
type: object
properties:
Entity:
type: object
properties:
Id:
type: string
Name:
type: string
Users:
description: (default = [])
nullable: true
type: array
items: {}
required:
- Id
- Name
ValidationResult:
type: array
items: {}
required:
- Entity
- ValidationResult
examples:
response:
value:
Entity:
Id: 00000000-0000-0000-0000-000000000000
Name: Everyone
Users:
- Id: 00000000-0000-0000-0000-000000000000
Code: "012345"
Name: John Doe
Type: 0
ValidationResult:
- Message: ""
SourceMemberNames: []
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Link users to access group
operationId: Link users to access group
description: |-
Links one or more users to an access group.
*Privilege required: `Api: Accesscontrol edit`*
x-resource: Access group - Users
tags:
- Access Control
parameters:
- name: id
in: path
description: ""
required: true
example: 00000000-0000-0000-0000-000000000000
schema:
type: string
requestBody:
$ref: "#/components/requestBodies/Link_users_to_access_groupBody"
security:
- pat: []
"/api/v2/accessgroup/{id}/user/delete":
post:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Data:
properties:
Id:
type: string
Name:
type: string
Users:
description: (default = [])
nullable: true
type: array
items: {}
required:
- Id
- Name
description: (default = null)
nullable: true
type: object
examples:
response:
value:
Data:
Id: 00000000-0000-0000-0000-000000000000
Name: Everyone
Users:
- Id: 00000000-0000-0000-0000-000000000000
Code: "012345"
Name: John Doe
Type: 0
"400":
description: BadRequest
headers: {}
content:
application/json:
schema:
type: object
properties:
Entity:
type: object
properties:
Id:
type: string
Name:
type: string
Users:
description: (default = [])
nullable: true
type: array
items: {}
required:
- Id
- Name
ValidationResult:
type: array
items: {}
required:
- Entity
- ValidationResult
examples:
response:
value:
Entity:
Id: 00000000-0000-0000-0000-000000000000
Name: Everyone
Users:
- Id: 00000000-0000-0000-0000-000000000000
Code: "012345"
Name: John Doe
Type: 0
ValidationResult:
- Message: ""
SourceMemberNames: []
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Unlink users from access group
operationId: Unlink users from access group
description: |-
Unlinks one or more users from an access group.
*Privilege required: `Api: Accesscontrol edit`*
x-resource: Access group - Users
tags:
- Access Control
parameters:
- name: id
in: path
description: ""
required: true
example: 00000000-0000-0000-0000-000000000000
schema:
type: string
requestBody:
$ref: "#/components/requestBodies/Link_users_to_access_groupBody"
security:
- pat: []
/api/v1/access/location/all:
get:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/IntelliTracer.ApiV1.AccessLocationLite"
examples:
response:
value:
- Id: 00000000-0000-0000-0000-000000000000
Name: Entrance
Readers:
- ReaderId: 00000000-0000-0000-0000-000000000000
ReaderName: Entrance
Relais:
- RelaisId: 00000000-0000-0000-0000-000000000000
RelaisName: Entrance
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Get access locations
operationId: Get access locations
description: >-
Returns a list of all access locations.
*Privilege required: `Api: Accesscontrol read` or `Api: Accesscontrol edit`*
x-resource: Access locations
tags:
- Access Control
security:
- pat: []
"/api/v1/access/location/{id}/useraccess":
get:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/IntelliTracer.ApiV1.AccessLocationUserAccess"
examples:
response:
value:
- PersonId: 00000000-0000-0000-0000-000000000000
UserId: 00000000-0000-0000-0000-000000000000
ScheduleId: 00000000-0000-0000-0000-000000000000
IsMaster: false
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Get user access
operationId: Get user access
description: >-
Returns a list of all users that have access to a location.
*Privilege required: `Api: Accesscontrol read` or `Api: Accesscontrol edit`*
x-resource: Access location - User access
tags:
- Access Control
parameters:
- name: id
in: path
description: ""
required: true
example: 00000000-0000-0000-0000-000000000000
schema:
type: string
security:
- pat: []
post:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Success:
type: boolean
Message:
description: (default = null)
nullable: true
type: string
required:
- Success
examples:
response:
value:
Success: false
Message: null
"400":
description: BadRequest
headers: {}
content:
application/json:
schema:
type: object
properties:
Success:
type: boolean
Message:
description: (default = null)
nullable: true
type: string
required:
- Success
examples:
response:
value:
Success: false
Message: null
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Grant user access
operationId: Grant user access
description: >-
Grants a user access to a location according to a schema. Provide either
a user id or person id to identify a user.
The user is added to the group `{LocationName} - {ScheduleName}`. If necessary, a new group is created before granting access.
*Privilege required: `Api: Accesscontrol edit`*
x-resource: Access location - User access
tags:
- Access Control
parameters:
- name: id
in: path
description: ""
required: true
example: 00000000-0000-0000-0000-000000000000
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
properties:
PersonId:
type: string
description: |-
(default = null)
ID of the person that was granted entry.
UserId:
type: string
description: |-
(default = null)
ID of the user that was denied entry.
AccessScheduleId:
type: string
description: |-
(default = null)
ID of the linked access schedule.
required:
- AccessScheduleId
example:
PersonId: 00000000-0000-0000-0000-000000000000
UserId: 00000000-0000-0000-0000-000000000000
AccessScheduleId: 00000000-0000-0000-0000-000000000000
security:
- pat: []
"/api/v1/access/location/{id}/ciawaccess":
post:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Success:
type: boolean
Message:
description: (default = null)
nullable: true
type: string
UserId:
type: string
PersonId:
type: string
required:
- Success
- UserId
- PersonId
examples:
response:
value:
Success: false
Message: null
UserId: 00000000-0000-0000-0000-000000000000
PersonId: 00000000-0000-0000-0000-000000000000
"400":
description: BadRequest
headers: {}
content:
application/json:
schema:
type: object
properties:
Success:
type: boolean
Message:
description: (default = null)
nullable: true
type: string
UserId:
type: string
PersonId:
type: string
required:
- Success
- UserId
- PersonId
examples:
response:
value:
Success: false
Message: null
UserId: 00000000-0000-0000-0000-000000000000
PersonId: 00000000-0000-0000-0000-000000000000
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Grant user access (ciaw)
operationId: Grant user access (ciaw)
description: >-
Grants a user access to a location according to a schema. Provide a name
to identify a user. Provide either a Limosa number or both Rrn number
and VAT number to identify a CIAW person.
The user is added to the specified user group, linked to the specified RFID tag and linked to the specified CIAW person. If necessary, a new user, RFID tag and/or user group is created before granting access.
*Privilege required: `Api: Accesscontrol edit`*
x-resource: Access location - User access
tags:
- Access Control
parameters:
- name: id
in: path
description: ""
required: true
example: 00000000-0000-0000-0000-000000000000
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
properties:
LimosaNumber:
type: number
description: |-
(default = 0)
Limosa number, used for foreign employees.
RrnNumber:
type: number
description: |-
(default = 0)
Rijksregisternummer, used for Belgian employees.
Name:
type: string
description: Name of the person who was granted access
BtwNumber:
type: string
description: |-
(default = null)
VAT number
BadgeNumber:
type: string
description: Badge number used for this registration
LimosaExpirationDate:
type: string
description: (default = null)
A1ExpirationDate:
description: (default = null)
nullable: true
type: string
VisaExpirationDate:
description: |-
(default = null)
Date this person's Limosa number expires.
nullable: true
type: string
OwnStaff:
type: boolean
description: >-
(default = false)
Whether this employee works for the current company or for a different one.
AddToGroup:
type: string
description: Add this user to an access group.
AccessScheduleId:
type: string
description: ID of the linked access schedule.
required:
- Name
- BadgeNumber
- OwnStaff
- AddToGroup
- AccessScheduleId
example:
LimosaNumber: 11223344556677888
RrnNumber: 79040205768
Name: John Doe
BtwNumber: "1122334455"
BadgeNumber: 00AA11BB
LimosaExpirationDate: 2019-01-24T17:00:00+01:00
A1ExpirationDate: 2019-01-25T08:00:00+02:00
VisaExpirationDate: 2019-01-25T08:00:00+02:00
OwnStaff: false
AddToGroup: Employees
AccessScheduleId: 00000000-0000-0000-0000-000000000000
security:
- pat: []
"/api/v1/access/location/{id}/removeuseraccess":
post:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Success:
type: boolean
Message:
description: (default = null)
nullable: true
type: string
required:
- Success
examples:
response:
value:
Success: false
Message: null
"400":
description: BadRequest
headers: {}
content:
application/json:
schema:
type: object
properties:
Success:
type: boolean
Message:
description: (default = null)
nullable: true
type: string
required:
- Success
examples:
response:
value:
Success: false
Message: null
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Deny user access
operationId: Deny user access
description: >-
Denies a user access to a location. Provide either a user id or person
id to identify a user.
The user is removed from all groups of the location.
*Privilege required: `Api: Accesscontrol edit`*
x-resource: Access location - User access
tags:
- Access Control
parameters:
- name: id
in: path
description: ""
required: true
example: 00000000-0000-0000-0000-000000000000
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
properties:
PersonId:
type: string
description: |-
(default = null)
ID of the person that was denied entry.
UserId:
type: string
description: |-
(default = null)
ID of the user that was denied entry.
example:
PersonId: 00000000-0000-0000-0000-000000000000
UserId: 00000000-0000-0000-0000-000000000000
security:
- pat: []
"/api/v1/access/location/{id}/removeschedules":
post:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Success:
type: boolean
Message:
description: (default = null)
nullable: true
type: string
required:
- Success
examples:
response:
value:
Success: false
Message: null
"400":
description: BadRequest
headers: {}
content:
application/json:
schema:
type: object
properties:
Success:
type: boolean
Message:
description: (default = null)
nullable: true
type: string
required:
- Success
examples:
response:
value:
Success: false
Message: null
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Remove schedules from access location
operationId: Remove schedules from access location
description: |-
Removes a list of schedules from an access location.
*Privilege required: `Api: Accesscontrol edit`*
x-resource: Access location - Remove schedules
tags:
- Access Control
parameters:
- name: id
in: path
description: ""
required: true
example: 00000000-0000-0000-0000-000000000000
schema:
type: string
security:
- pat: []
"/api/v2/accesslocation/{id}/accesscontrol/schedule":
get:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Data:
nullable: true
type: array
items: {}
examples:
response:
value:
Data:
- Schedule:
Id: 00000000-0000-0000-0000-000000000000
Name: Office hours
Groups:
- Id: 00000000-0000-0000-0000-000000000000
Name: Everyone
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Get access control schedules by access location
operationId: Get access control schedules by access location
description: >-
Returns a list of all access control schedules linked to an access
location.
*Privilege required: `Api: Accesscontrol read` or `Api: Accesscontrol edit`*
x-resource: Access location - Access control schedules
tags:
- Access Control
parameters:
- name: id
in: path
description: ""
required: true
example: 00000000-0000-0000-0000-000000000000
schema:
type: string
security:
- pat: []
put:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Data:
properties:
Schedule:
type: object
properties:
Id:
type: string
Name:
type: string
required:
- Id
- Name
Groups:
type: array
items: {}
required:
- Schedule
- Groups
nullable: true
type: object
examples:
response:
value:
Data:
Schedule:
Id: 00000000-0000-0000-0000-000000000000
Name: Office hours
Groups:
- Id: 00000000-0000-0000-0000-000000000000
Name: Everyone
"400":
description: BadRequest
headers: {}
content:
application/json:
schema:
type: object
properties:
Entity:
type: object
properties:
Schedule:
type: object
properties:
Id:
type: string
Name:
type: string
required:
- Id
- Name
Groups:
type: array
items: {}
required:
- Schedule
- Groups
ValidationResult:
type: array
items: {}
required:
- Entity
- ValidationResult
examples:
response:
value:
Entity:
Schedule:
Id: 00000000-0000-0000-0000-000000000000
Name: Office hours
Groups:
- Id: 00000000-0000-0000-0000-000000000000
Name: Everyone
ValidationResult:
- Message: ""
SourceMemberNames: []
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Link access control schedule to access location
operationId: Link access control schedule to access location
description: |-
Links an access control schedule to an access location.
*Privilege required: `Api: Accesscontrol edit`*
x-resource: Access location - Access control schedules
tags:
- Access Control
parameters:
- name: id
in: path
description: ""
required: true
example: 00000000-0000-0000-0000-000000000000
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
properties:
ScheduleId:
type: string
GroupIds:
description: (default = [])
nullable: true
type: array
items: {}
required:
- ScheduleId
example:
ScheduleId: 00000000-0000-0000-0000-000000000000
GroupIds:
- 00000000-0000-0000-0000-000000000000
- 00000000-0000-0000-0000-000000000000
security:
- pat: []
"/api/v2/accesslocation/{locationId}/accesscontrol/schedule/{scheduleId}":
get:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Data:
properties:
Schedule:
type: object
properties:
Id:
type: string
Name:
type: string
required:
- Id
- Name
Groups:
type: array
items: {}
required:
- Schedule
- Groups
nullable: true
type: object
examples:
response:
value:
Data:
Schedule:
Id: 00000000-0000-0000-0000-000000000000
Name: Office hours
Groups:
- Id: 00000000-0000-0000-0000-000000000000
Name: Everyone
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Get access control schedule by access location and id
operationId: Get access control schedule by access location and id
description: >-
Returns an access control schedule linked to an access location by id.
*Privilege required: `Api: Accesscontrol read` or `Api: Accesscontrol edit`*
x-resource: Access location - Access control schedules
tags:
- Access Control
parameters:
- name: locationId
in: path
description: ""
required: true
example: 00000000-0000-0000-0000-000000000000
schema:
type: string
- name: scheduleId
in: path
description: ""
required: true
example: 00000000-0000-0000-0000-000000000000
schema:
type: string
security:
- pat: []
delete:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Data:
properties:
Schedule:
type: object
properties:
Id:
type: string
Name:
type: string
required:
- Id
- Name
Groups:
type: array
items: {}
required:
- Schedule
- Groups
nullable: true
type: object
examples:
response:
value:
Data:
Schedule:
Id: 00000000-0000-0000-0000-000000000000
Name: Office hours
Groups:
- Id: 00000000-0000-0000-0000-000000000000
Name: Everyone
"400":
description: BadRequest
headers: {}
content:
application/json:
schema:
type: object
properties:
Entity:
type: object
properties:
Schedule:
type: object
properties:
Id:
type: string
Name:
type: string
required:
- Id
- Name
Groups:
type: array
items: {}
required:
- Schedule
- Groups
ValidationResult:
type: array
items: {}
required:
- Entity
- ValidationResult
examples:
response:
value:
Entity:
Schedule:
Id: 00000000-0000-0000-0000-000000000000
Name: Office hours
Groups:
- Id: 00000000-0000-0000-0000-000000000000
Name: Everyone
ValidationResult:
- Message: ""
SourceMemberNames: []
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Unlink access control schedule from access location
operationId: Unlink access control schedule from access location
description: |-
Unlinks an access control schedule from an access location.
*Privilege required: `Api: Accesscontrol edit`*
x-resource: Access location - Access control schedules
tags:
- Access Control
parameters:
- name: locationId
in: path
description: ""
required: true
example: 00000000-0000-0000-0000-000000000000
schema:
type: string
- name: scheduleId
in: path
description: ""
required: true
example: 00000000-0000-0000-0000-000000000000
schema:
type: string
security:
- pat: []
"/api/v2/accesslocation/{locationId}/accesscontrol/schedule/{scheduleId}/group":
put:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Data:
properties:
Schedule:
type: object
properties:
Id:
type: string
Name:
type: string
required:
- Id
- Name
Groups:
type: array
items: {}
required:
- Schedule
- Groups
nullable: true
type: object
examples:
response:
value:
Data:
Schedule:
Id: 00000000-0000-0000-0000-000000000000
Name: Office hours
Groups:
- Id: 00000000-0000-0000-0000-000000000000
Name: Everyone
"400":
description: BadRequest
headers: {}
content:
application/json:
schema:
type: object
properties:
Entity:
type: object
properties:
Schedule:
type: object
properties:
Id:
type: string
Name:
type: string
required:
- Id
- Name
Groups:
type: array
items: {}
required:
- Schedule
- Groups
ValidationResult:
type: array
items: {}
required:
- Entity
- ValidationResult
examples:
response:
value:
Entity:
Schedule:
Id: 00000000-0000-0000-0000-000000000000
Name: Office hours
Groups:
- Id: 00000000-0000-0000-0000-000000000000
Name: Everyone
ValidationResult:
- Message: ""
SourceMemberNames: []
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Link groups to access control schedule
operationId: Link groups to access control schedule
description: |-
Links one or more groups to an access control schedule.
*Privilege required: `Api: Accesscontrol edit`*
x-resource: Access location - Access control schedule groups
tags:
- Access Control
parameters:
- name: locationId
in: path
description: ""
required: true
example: 00000000-0000-0000-0000-000000000000
schema:
type: string
- name: scheduleId
in: path
description: ""
required: true
example: 00000000-0000-0000-0000-000000000000
schema:
type: string
requestBody:
$ref: "#/components/requestBodies/Link_groups_to_access_control_scheduleBody"
security:
- pat: []
"/api/v2/accesslocation/{locationId}/accesscontrol/schedule/{scheduleId}/group/delete":
post:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Data:
properties:
Schedule:
type: object
properties:
Id:
type: string
Name:
type: string
required:
- Id
- Name
Groups:
type: array
items: {}
required:
- Schedule
- Groups
nullable: true
type: object
examples:
response:
value:
Data:
Schedule:
Id: 00000000-0000-0000-0000-000000000000
Name: Office hours
Groups:
- Id: 00000000-0000-0000-0000-000000000000
Name: Everyone
"400":
description: BadRequest
headers: {}
content:
application/json:
schema:
type: object
properties:
Entity:
type: object
properties:
Schedule:
type: object
properties:
Id:
type: string
Name:
type: string
required:
- Id
- Name
Groups:
type: array
items: {}
required:
- Schedule
- Groups
ValidationResult:
type: array
items: {}
required:
- Entity
- ValidationResult
examples:
response:
value:
Entity:
Schedule:
Id: 00000000-0000-0000-0000-000000000000
Name: Office hours
Groups:
- Id: 00000000-0000-0000-0000-000000000000
Name: Everyone
ValidationResult:
- Message: ""
SourceMemberNames: []
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Unlink groups from access schedule
operationId: Unlink groups from access schedule
description: |-
Unlinks one or more groups from an access control schedule.
*Privilege required: `Api: Accesscontrol edit`*
x-resource: Access location - Access control schedule groups
tags:
- Access Control
parameters:
- name: locationId
in: path
description: ""
required: true
example: 00000000-0000-0000-0000-000000000000
schema:
type: string
- name: scheduleId
in: path
description: ""
required: true
example: 00000000-0000-0000-0000-000000000000
schema:
type: string
requestBody:
$ref: "#/components/requestBodies/Link_groups_to_access_control_scheduleBody"
security:
- pat: []
/api/v1/accesslog:
get:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/IntelliTracer.ApiV1.AccessLog"
examples:
response:
value:
- TimeStamp: 2019-01-25T08:06:45+01:00
UserName: John Doe
UserId: 00000000-0000-0000-0000-000000000000
LocationName: Entrance
LocationId: 00000000-0000-0000-0000-000000000000
RelaisName: Front
ReaderName: Front
AccessGranted: true
Type: AccessGranted_MagStripe
BadgeNumber: "00000000"
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Get access log
operationId: Get access log
description: |-
Returns the access log for an access location within a date/time range.
*Privilege required: `Api: Accesscontrol read` or `Api: Accesscontrol edit`*
x-resource: Access log
tags:
- Access Control
parameters:
- name: fromDate
in: query
description: ""
required: true
example: 2019-01-25T05:00:00+01:00
schema:
type: string
- name: toDate
in: query
description: ""
required: true
example: 2019-01-25T22:00:00+01:00
schema:
type: string
- name: location
in: query
description: ""
required: false
example: 00000000-0000-0000-0000-000000000000
schema:
type: string
security:
- pat: []
"/api/v2/badge?page={page}&search={search}":
get:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Data:
description: (default = null)
nullable: true
type: array
items: {}
PagingFilter:
properties:
Page:
type: number
Search:
nullable: true
type: string
PageCount:
type: number
TotalCount:
type: number
Links:
type: object
properties:
Base:
type: string
First:
type: string
Prev:
type: string
Next:
type: string
Last:
type: string
required:
- Base
required:
- Page
- PageCount
- TotalCount
- Links
description: (default = null)
nullable: true
type: object
examples:
response:
value:
Data:
- Id: 00000000-0000-0000-0000-000000000000
Number: 00BB4E6F
Type: 0
ExternalNumber: 00BB4E6F
PagingFilter:
Page: 1
Search: ABC
PageCount: 4
TotalCount: 100
Links:
Base: https://api.intellitracer.be
First: /api/v2/asset?page=1
Prev: /api/v2/asset?page=2
Next: /api/v2/asset?page=4
Last: /api/v2/asset?page=4
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Get badges
operationId: Get badges
description: |-
Returns a paged list of badges.
Pagination and searching is explained in [Pagination](#pagination).
*Privilege required: `Api: Check In At Work`*
x-resource: Badges
tags:
- Check In At Work
parameters:
- name: page
in: path
description: ""
required: true
example: "1"
schema:
type: number
- name: search
in: path
description: ""
required: true
example: ABC
schema:
type: string
security:
- pat: []
"/api/v2/badge/{id}":
get:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Data:
properties:
Id:
type: string
Number:
type: string
Type:
type: number
x-enum-type: IntelliTracer.Domain.BadgeType
enum:
- 0
- 1
- 2
- 3
- 4
description: (default = 0)
ExternalNumber:
type: string
required:
- Id
- Number
- Type
- ExternalNumber
description: (default = null)
nullable: true
type: object
examples:
response:
value:
Data:
Id: 00000000-0000-0000-0000-000000000000
Number: 00BB4E6F
Type: 0
ExternalNumber: 00BB4E6F
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"404":
description: NotFound
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Get badge
operationId: Get badge
description: |-
Returns a badge by id.
*Privilege required: `Api: Check In At Work`*
x-resource: Badges
tags:
- Check In At Work
parameters:
- name: id
in: path
description: ""
required: true
example: 00000000-0000-0000-0000-000000000000
schema:
type: string
security:
- pat: []
delete:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Data:
properties:
Id:
type: string
Number:
type: string
Type:
type: number
x-enum-type: IntelliTracer.Domain.BadgeType
enum:
- 0
- 1
- 2
- 3
- 4
description: (default = 0)
ExternalNumber:
type: string
required:
- Id
- Number
- Type
- ExternalNumber
description: (default = null)
nullable: true
type: object
examples:
response:
value:
Data:
Id: 00000000-0000-0000-0000-000000000000
Number: 00BB4E6F
Type: 0
ExternalNumber: 00BB4E6F
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"404":
description: NotFound
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Delete badge
operationId: Delete badge
description: |-
Deletes a badge
*Privilege required: `Api: Check In At Work`*
x-resource: Badges
tags:
- Check In At Work
parameters:
- name: id
in: path
description: ""
required: true
example: 00000000-0000-0000-0000-000000000000
schema:
type: string
security:
- pat: []
/api/v2/badge/:
put:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Data:
properties:
Id:
type: string
Number:
type: string
Type:
type: number
x-enum-type: IntelliTracer.Domain.BadgeType
enum:
- 0
- 1
- 2
- 3
- 4
description: (default = 0)
ExternalNumber:
type: string
required:
- Id
- Number
- Type
- ExternalNumber
description: (default = null)
nullable: true
type: object
examples:
response:
value:
Data:
Id: 00000000-0000-0000-0000-000000000000
Number: 00BB4E6F
Type: 0
ExternalNumber: 00BB4E6F
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"404":
description: NotFound
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Create badge
operationId: Create badge
description: |-
Creates a new badge
*Privilege required: `Api: Check In At Work`*
x-resource: Badges
tags:
- Check In At Work
requestBody:
content:
application/json:
schema:
type: object
properties:
Number:
type: string
Type:
type: number
x-enum-type: IntelliTracer.Domain.BadgeType
enum:
- 0
- 1
- 2
- 3
- 4
description: (default = 0)
ExternalNumber:
type: string
description: (default = null)
required:
- Number
- Type
example:
Number: 00BB4E6F
Type: 0
ExternalNumber: "12345678"
security:
- pat: []
post:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Data:
properties:
Id:
type: string
Number:
type: string
Type:
type: number
x-enum-type: IntelliTracer.Domain.BadgeType
enum:
- 0
- 1
- 2
- 3
- 4
description: (default = 0)
ExternalNumber:
type: string
required:
- Id
- Number
- Type
- ExternalNumber
description: (default = null)
nullable: true
type: object
examples:
response:
value:
Data:
Id: 00000000-0000-0000-0000-000000000000
Number: 00BB4E6F
Type: 0
ExternalNumber: 00BB4E6F
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"404":
description: NotFound
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Update badge
operationId: Update badge
description: |-
Updates an existing badge
*Privilege required: `Api: Check In At Work`*
x-resource: Badges
tags:
- Check In At Work
requestBody:
content:
application/json:
schema:
type: object
properties:
Id:
type: string
Number:
type: string
Type:
type: number
x-enum-type: IntelliTracer.Domain.BadgeType
enum:
- 0
- 1
- 2
- 3
- 4
description: (default = 0)
ExternalNumber:
type: string
required:
- Id
- Number
- Type
- ExternalNumber
example:
Id: 00000000-0000-0000-0000-000000000000
Number: 00BB4E6F
Type: 0
ExternalNumber: 00BB4E6F
security:
- pat: []
"/api/v2/btw?page={page}&search={search}":
get:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Data:
description: (default = null)
nullable: true
type: array
items: {}
PagingFilter:
properties:
Page:
type: number
Search:
nullable: true
type: string
PageCount:
type: number
TotalCount:
type: number
Links:
type: object
properties:
Base:
type: string
First:
type: string
Prev:
type: string
Next:
type: string
Last:
type: string
required:
- Base
required:
- Page
- PageCount
- TotalCount
- Links
description: (default = null)
nullable: true
type: object
examples:
response:
value:
Data:
- Id: 00000000-0000-0000-0000-000000000000
Number: "123456789"
Name: GeoDynamics
Country: 0
CountryCode: BE
FormattedBTWNumber: BE-123456789
PagingFilter:
Page: 1
Search: ABC
PageCount: 4
TotalCount: 100
Links:
Base: https://api.intellitracer.be
First: /api/v2/asset?page=1
Prev: /api/v2/asset?page=2
Next: /api/v2/asset?page=4
Last: /api/v2/asset?page=4
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Get BTW numbers
operationId: Get BTW numbers
description: |-
Returns a paged list of BTW numbers.
Pagination and searching is explained in [Pagination](#pagination).
*Privilege required: `Api: Check In At Work`*
x-resource: BTW numbers
tags:
- Check In At Work
parameters:
- name: page
in: path
description: ""
required: true
example: "1"
schema:
type: number
- name: search
in: path
description: ""
required: true
example: ABC
schema:
type: string
security:
- pat: []
/api/v1/userwithperson:
put:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
$ref: "#/components/schemas/IntelliTracer.ApiV1.UserWithPersonResult"
"400":
description: BadRequest
headers: {}
content:
application/json:
schema:
type: object
properties:
Success:
type: boolean
ErrorMessage:
description: (default = null)
nullable: true
type: string
UserId:
type: string
PersonId:
type: string
required:
- Success
- UserId
- PersonId
examples:
response:
value:
Success: false
ErrorMessage: null
UserId: ""
PersonId: ""
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
"500":
description: InternalServerError
headers: {}
summary: Create user with person
operationId: Create user with person
description: >-
Creates a new user and a new person. Links the user to the person.
In order to add a single Limosa, use *LimosaNumber* and *LimosaEndDate*. This Limosa is automatically set as the default.
In order to add multiple Limosas, use *Limosas*.
*Privilege required: `Api: Resource management`*
x-resource: User with person
tags:
- Check In At Work
requestBody:
content:
application/json:
schema:
type: object
properties:
User:
type: object
properties:
Name:
type: string
Code:
description: (default = null)
nullable: true
type: string
EmployerCode:
description: (default = null)
nullable: true
type: string
Email:
description: (default = null)
nullable: true
type: string
Gsm:
description: (default = null)
nullable: true
type: string
FreeField1:
description: (default = null)
nullable: true
type: string
FreeField2:
description: (default = null)
nullable: true
type: string
FreeField3:
description: (default = null)
nullable: true
type: string
FreeField4:
description: (default = null)
nullable: true
type: string
FreeField5:
description: (default = null)
nullable: true
type: string
FreeField6:
description: "(default = null) "
nullable: true
type: string
Notes:
description: |-
(default = null)
Notes for this user.
nullable: true
type: string
Street:
description: (default = null)
nullable: true
type: string
HouseNumber:
description: (default = null)
nullable: true
type: string
City:
description: (default = null)
nullable: true
type: string
PostalCode:
description: (default = null)
nullable: true
type: string
Submunicipality:
description: (default = null)
nullable: true
type: string
Country:
type: number
x-enum-type: IntelliTracer.Domain.Country
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
- 47
- 48
- 49
- 50
- 51
- 52
- 53
- 54
- 55
- 56
- 57
- 58
- 59
- 60
- 61
- 62
- 63
- 64
- 65
- 66
- 67
- 68
- 69
- 70
- 71
- 72
- 73
- 74
- 75
- 76
- 77
- 78
- 79
- 80
- 81
- 82
- 83
- 84
- 85
- 86
- 87
- 88
- 89
- 90
- 91
- 92
- 93
- 94
- 95
- 96
- 97
- 98
- 99
- 100
- 101
- 102
- 103
- 104
- 105
- 106
- 107
- 108
- 109
- 110
- 111
- 112
- 113
- 114
- 115
- 116
- 117
- 118
- 119
- 120
- 121
- 122
- 123
- 124
- 125
- 126
- 127
- 128
- 129
- 130
- 131
- 132
- 133
- 134
- 135
- 136
- 137
- 138
- 139
- 140
- 141
- 142
- 143
- 144
- 145
- 146
- 147
- 148
- 149
- 150
- 151
- 152
- 153
- 9999
description: (default = 0)
Longitude:
description: >-
(default = null)
Geographic coordinate that specifies the east–west position of a point on the Earth's surface.
nullable: true
type: number
Latitude:
description: >-
(default = null)
Geographic coordinate that specifies the north–south position of a point on the Earth's surface.
nullable: true
type: number
DefaultDayProgram:
properties:
Id:
type: string
required:
- Id
description: (default = null)
nullable: true
type: object
required:
- Name
Person:
type: object
properties:
ShortCode:
type: number
description: |-
(default = 0)
ShortCode for this person.
Code:
description: |-
(default = null)
Code for this person.
nullable: true
type: string
Notes:
description: |-
(default = null)
Notes for this person.
nullable: true
type: string
Type:
type: number
x-enum-type: IntelliTracer.ApiV1.PersonType
enum:
- 0
- 1
description: >-
(default = 0)
Type of person (RRN for Belgian employees, or Limosa for foreign employees).
RRNNumber:
type: number
description: |-
(default = 0)
Rijksregisternummer, used for Belgian employees.
LimosaNumber:
type: number
description: >-
(default = 0)
Limosa number, used for foreign employees instead of a rijksregisternummer.
BisNumber:
type: number
BTW:
properties:
Id:
type: string
Number:
type: string
Country:
type: number
x-enum-type: IntelliTracer.Domain.Country
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
- 47
- 48
- 49
- 50
- 51
- 52
- 53
- 54
- 55
- 56
- 57
- 58
- 59
- 60
- 61
- 62
- 63
- 64
- 65
- 66
- 67
- 68
- 69
- 70
- 71
- 72
- 73
- 74
- 75
- 76
- 77
- 78
- 79
- 80
- 81
- 82
- 83
- 84
- 85
- 86
- 87
- 88
- 89
- 90
- 91
- 92
- 93
- 94
- 95
- 96
- 97
- 98
- 99
- 100
- 101
- 102
- 103
- 104
- 105
- 106
- 107
- 108
- 109
- 110
- 111
- 112
- 113
- 114
- 115
- 116
- 117
- 118
- 119
- 120
- 121
- 122
- 123
- 124
- 125
- 126
- 127
- 128
- 129
- 130
- 131
- 132
- 133
- 134
- 135
- 136
- 137
- 138
- 139
- 140
- 141
- 142
- 143
- 144
- 145
- 146
- 147
- 148
- 149
- 150
- 151
- 152
- 153
- 9999
description: (default = 0)
required:
- Id
- Number
description: |-
(default = null)
This person's VAT number.
nullable: true
type: object
Badges:
description: |-
(default = null)
List of badges linked to this person.
nullable: true
type: array
items: {}
FeedbackGSM:
properties:
Id:
type: string
required:
- Id
description: >-
(default = null)
Phone number for this person, used to receive feedback text messages.
nullable: true
type: object
RegisterGSM:
properties:
Id:
type: string
required:
- Id
description: >-
(default = null)
Phone number for this person, used to create new CheckInAtWork registrations.
nullable: true
type: object
LimosaEndDate:
description: (default = null)
nullable: true
type: string
A1ExpirationDate:
description: (default = null)
nullable: true
type: string
VisaExpirationDate:
description: |-
(default = null)
The date this person's Limosa number expires.
nullable: true
type: string
BirthDate:
description: |-
(default = null)
Birth date for this person.
nullable: true
type: string
ReceiveFeedback:
type: boolean
description: >-
(default = false)
Whether this person should receive feedback text messages or emails when registrations are created.
ApproveRegistration:
type: boolean
description: >-
(default = false)
Whether CheckInAtWork registrations from this person need to be manually approved before they are sent to the RSZ.
Inactive:
type: boolean
description: (default = false)
StaffType:
x-enum-type: IntelliTracer.Domain.StaffType
enum:
- 0
- 1
- null
description: (default = null)
nullable: true
type: number
_typeDescriptor:
type: string
required:
- User
- Person
example:
User:
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
Person:
ShortCode: 100
Code: "012345"
Notes: Name
Type: 0
RRNNumber: 79040205768
LimosaNumber: 11223344556677888
BisNumber: 79040205768
BTW:
Id: 00000000-0000-0000-0000-000000000000
Number: "1122334455"
Country: 0
Badges:
- Id: 00000000-0000-0000-0000-000000000000
FeedbackGSM:
Id: 00000000-0000-0000-0000-000000000000
RegisterGSM:
Id: 00000000-0000-0000-0000-000000000000
LimosaEndDate: 2015-10-30T00:00:00+01:00
A1ExpirationDate: 2019-01-25T08:00:00+02:00
VisaExpirationDate: 2019-01-25T08:00:00+02:00
BirthDate: 1979-04-02T00:00:00
ReceiveFeedback: false
ApproveRegistration: false
Inactive: false
StaffType: 0
security:
- pat: []
/api/v1/person:
get:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/IntelliTracer.ApiV1.Person"
examples:
response:
value:
- Id: 00000000-0000-0000-0000-000000000000
UserId: 00000000-0000-0000-0000-000000000000
Label: John Doe
ShortCode: 100
Code: "012345"
Type: 0
RRNNumber: 79040205768
FormattedRRNNumber: 79.04.02-057.68
LimosaNumber: 11223344556677888
BisNumber: 79040205768
FormattedBisNumber: 79.04.02-057.68
BTW:
Id: 00000000-0000-0000-0000-000000000000
Number: "1122334455"
Name: Geodynamics
Country: 0
FormattedBTWNumber: BE-1122334455
Notes: null
Badges:
- Id: 00000000-0000-0000-0000-000000000000
Number: 00AA11BB
FeedbackGSM:
Id: 00000000-0000-0000-0000-000000000000
GSMNumber: "+32498465432"
RegisterGSM:
Id: 00000000-0000-0000-0000-000000000000
GSMNumber: "+32498465432"
LimosaEndDate: 2015-10-30T00:00:00+01:00
CreationTimeStamp: 2015-09-21T22:01:20+02:00
BirthDate: 1979-04-02T00:00:00
ReceiveFeedback: false
ApproveRegistration: false
Inactive: false
InactivityTimestamp: 2019-01-25T08:00:00+02:00
QrUrl: https://api.intellitracer.be/qrcode.pdf
Limosas:
- Id: 00000000-0000-0000-0000-000000000000
LimosaNumber: 11223344556677888
IsDefault: false
EndDate: 2020-10-30T00:00:00+01:00
Workplaces:
- Id: 00000000-0000-0000-0000-000000000000
DUC: 1Y100001AB1CD
Code: "012345"
Name: GeoDynamics
StaffType: 0
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Get persons
operationId: Get persons
description: |-
Returns a list of all persons.
*Privilege required: `Api: Resource read` or `Api: Resource management`*
x-resource: Persons
tags:
- Check In At Work
security:
- pat: []
/api/v1/person/bystaff:
get:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/IntelliTracer.ApiV1.Person"
examples:
response:
value:
- Id: 00000000-0000-0000-0000-000000000000
UserId: 00000000-0000-0000-0000-000000000000
Label: John Doe
ShortCode: 100
Code: "012345"
Type: 0
RRNNumber: 79040205768
FormattedRRNNumber: 79.04.02-057.68
LimosaNumber: 11223344556677888
BisNumber: 79040205768
FormattedBisNumber: 79.04.02-057.68
BTW:
Id: 00000000-0000-0000-0000-000000000000
Number: "1122334455"
Name: Geodynamics
Country: 0
FormattedBTWNumber: BE-1122334455
Notes: null
Badges:
- Id: 00000000-0000-0000-0000-000000000000
Number: 00AA11BB
FeedbackGSM:
Id: 00000000-0000-0000-0000-000000000000
GSMNumber: "+32498465432"
RegisterGSM:
Id: 00000000-0000-0000-0000-000000000000
GSMNumber: "+32498465432"
LimosaEndDate: 2015-10-30T00:00:00+01:00
CreationTimeStamp: 2015-09-21T22:01:20+02:00
BirthDate: 1979-04-02T00:00:00
ReceiveFeedback: false
ApproveRegistration: false
Inactive: false
InactivityTimestamp: 2019-01-25T08:00:00+02:00
QrUrl: https://api.intellitracer.be/qrcode.pdf
Limosas:
- Id: 00000000-0000-0000-0000-000000000000
LimosaNumber: 11223344556677888
IsDefault: false
EndDate: 2020-10-30T00:00:00+01:00
Workplaces:
- Id: 00000000-0000-0000-0000-000000000000
DUC: 1Y100001AB1CD
Code: "012345"
Name: GeoDynamics
StaffType: 0
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Get persons by staff
operationId: Get persons by staff
description: |-
Returns a list of all persons by staff type.
*Privilege required: `Api: Resource read` or `Api: Resource management`*
x-resource: Persons
tags:
- Check In At Work
parameters:
- name: ownStaff
in: query
description: ""
required: true
example: "false"
schema:
type: boolean
security:
- pat: []
/api/v1/person/bybtwnumber:
get:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/IntelliTracer.ApiV1.Person"
examples:
response:
value:
- Id: 00000000-0000-0000-0000-000000000000
UserId: 00000000-0000-0000-0000-000000000000
Label: John Doe
ShortCode: 100
Code: "012345"
Type: 0
RRNNumber: 79040205768
FormattedRRNNumber: 79.04.02-057.68
LimosaNumber: 11223344556677888
BisNumber: 79040205768
FormattedBisNumber: 79.04.02-057.68
BTW:
Id: 00000000-0000-0000-0000-000000000000
Number: "1122334455"
Name: Geodynamics
Country: 0
FormattedBTWNumber: BE-1122334455
Notes: null
Badges:
- Id: 00000000-0000-0000-0000-000000000000
Number: 00AA11BB
FeedbackGSM:
Id: 00000000-0000-0000-0000-000000000000
GSMNumber: "+32498465432"
RegisterGSM:
Id: 00000000-0000-0000-0000-000000000000
GSMNumber: "+32498465432"
LimosaEndDate: 2015-10-30T00:00:00+01:00
CreationTimeStamp: 2015-09-21T22:01:20+02:00
BirthDate: 1979-04-02T00:00:00
ReceiveFeedback: false
ApproveRegistration: false
Inactive: false
InactivityTimestamp: 2019-01-25T08:00:00+02:00
QrUrl: https://api.intellitracer.be/qrcode.pdf
Limosas:
- Id: 00000000-0000-0000-0000-000000000000
LimosaNumber: 11223344556677888
IsDefault: false
EndDate: 2020-10-30T00:00:00+01:00
Workplaces:
- Id: 00000000-0000-0000-0000-000000000000
DUC: 1Y100001AB1CD
Code: "012345"
Name: GeoDynamics
StaffType: 0
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Get persons by BTW
operationId: Get persons by BTW
description: |-
Returns a list of all persons by BTW number.
The default Limosa is indicated by *LimosaNumber* and *LimosaEndDate*.
*Privilege required: `Api: Resource read` or `Api: Resource management`*
x-resource: Persons
tags:
- Check In At Work
parameters:
- name: btwNumber
in: query
description: ""
required: true
example: BE-0000000000
schema:
type: string
security:
- pat: []
"/api/v2/person/bybis?bisnumber={bisNumber}":
get:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Data:
description: (default = null)
nullable: true
type: array
items: {}
examples:
response:
value:
Data:
- Id: 00000000-0000-0000-0000-000000000000
ShortCode: 123456789
Code: "12345"
Type: 0
RRNNumber: 79040205768
FormattedRRNNumber: 79.04.02-057.68
LimosaNumber: 11223344556677888
BTW:
Id: 00000000-0000-0000-0000-000000000000
Number: "123456789"
Name: GeoDynamics
Country: 0
CountryCode: BE
FormattedBTWNumber: BE-123456789
Notes: John Doe
Badges:
- Id: 00000000-0000-0000-0000-000000000000
Number: 00BB4E6F
Type: 0
ExternalNumber: 00BB4E6F
FeedbackGSM:
Id: 00000000-0000-0000-0000-000000000000
Number: "+32478123456"
RegisterGSM:
Id: 00000000-0000-0000-0000-000000000000
Number: "+32478123456"
LimosaEndDate: 2019-01-25T08:00:00+02:00
CreationTimeStamp: 2019-01-25T08:00:00+02:00
BirthDate: 2019-01-25
ReceiveFeedback: false
ApproveRegistration: false
User:
Id: 00000000-0000-0000-0000-000000000000
Code: "012345"
Name: John Doe
Type: 0
BadgeTimeStamp: 2019-01-25T08:00:00+02:00
Inactive: false
InactivityTimestamp: 2019-01-25T08:00:00+02:00
A1ExpirationDate: 2019-01-25T08:00:00+02:00
VisaExpirationDate: 2019-01-25T08:00:00+02:00
Limosas:
- Id: 00000000-0000-0000-0000-000000000000
LimosaNumber: 11223344556677888
IsDefault: false
EndDate: 2020-10-30T00:00:00+01:00
Workplaces:
- Id: 00000000-0000-0000-0000-000000000000
DUC: ""
Code: "012345"
Name: GeoDynamics
QrUrl: https://api.intellitracer.be/qrcode.pdf
Info: Person info
LimosaStartDate: 2019-01-25T08:00:00
BISNumber: 79040205768
FormattedBISNumber: 79.04.02-057.68
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"404":
description: NotFound
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Get persons by BIS number
operationId: Get persons by BIS number
description: |-
Returns a list of all persons by BIS number.
The default Limosa is indicated by *LimosaNumber* and *LimosaEndDate*.
*Privilege required: `Api: Check In At Work`*
x-resource: Persons
tags:
- Check In At Work
parameters:
- name: bisNumber
in: path
description: ""
required: true
example: "00000000000"
schema:
type: string
security:
- pat: []
"/api/v2/person/{id}":
get:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Data:
properties:
Id:
type: string
ShortCode:
type: number
Code:
description: (default = null)
nullable: true
type: string
Type:
type: number
x-enum-type: IntelliTracer.ApiV2.PersonType
enum:
- 0
- 1
description: (default = 0)
RRNNumber:
type: number
description: (default = null)
FormattedRRNNumber:
description: (default = null)
nullable: true
type: string
LimosaNumber:
type: number
description: (default = null)
BTW:
properties:
Id:
type: string
Number:
type: string
Name:
type: string
Country:
type: number
x-enum-type: IntelliTracer.Domain.Country
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
- 47
- 48
- 49
- 50
- 51
- 52
- 53
- 54
- 55
- 56
- 57
- 58
- 59
- 60
- 61
- 62
- 63
- 64
- 65
- 66
- 67
- 68
- 69
- 70
- 71
- 72
- 73
- 74
- 75
- 76
- 77
- 78
- 79
- 80
- 81
- 82
- 83
- 84
- 85
- 86
- 87
- 88
- 89
- 90
- 91
- 92
- 93
- 94
- 95
- 96
- 97
- 98
- 99
- 100
- 101
- 102
- 103
- 104
- 105
- 106
- 107
- 108
- 109
- 110
- 111
- 112
- 113
- 114
- 115
- 116
- 117
- 118
- 119
- 120
- 121
- 122
- 123
- 124
- 125
- 126
- 127
- 128
- 129
- 130
- 131
- 132
- 133
- 134
- 135
- 136
- 137
- 138
- 139
- 140
- 141
- 142
- 143
- 144
- 145
- 146
- 147
- 148
- 149
- 150
- 151
- 152
- 153
- 9999
description: (default = 0)
CountryCode:
type: string
FormattedBTWNumber:
type: string
required:
- Id
- Number
- Name
- Country
- CountryCode
- FormattedBTWNumber
description: (default = null)
nullable: true
type: object
Notes:
description: (default = null)
nullable: true
type: string
Badges:
description: (default = [])
nullable: true
type: array
items: {}
FeedbackGSM:
properties:
Id:
type: string
Number:
type: string
required:
- Id
- Number
description: (default = null)
nullable: true
type: object
RegisterGSM:
properties:
Id:
type: string
Number:
type: string
required:
- Id
- Number
description: (default = null)
nullable: true
type: object
LimosaEndDate:
description: (default = null)
nullable: true
type: string
CreationTimeStamp:
description: (default = null)
nullable: true
type: string
BirthDate:
description: (default = null)
nullable: true
type: string
ReceiveFeedback:
type: boolean
description: (default = false)
ApproveRegistration:
type: boolean
description: (default = false)
User:
properties:
Id:
type: string
Code:
description: (default = null)
nullable: true
type: string
Name:
type: string
Type:
type: number
x-enum-type: IntelliTracer.Domain.ResourceType
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
description: (default = 0)
required:
- Id
- Name
description: (default = null)
nullable: true
type: object
BadgeTimeStamp:
description: "(default = null) "
nullable: true
type: string
Inactive:
type: boolean
description: (default = false)
InactivityTimestamp:
description: (default = null)
nullable: true
type: string
A1ExpirationDate:
description: (default = null)
nullable: true
type: string
VisaExpirationDate:
description: (default = null)
nullable: true
type: string
Limosas:
description: (default = null)
nullable: true
type: array
items: {}
QrUrl:
description: (default = null)
nullable: true
type: string
Info:
type: string
LimosaStartDate:
description: (default = null)
nullable: true
type: string
BISNumber:
type: number
description: (default = null)
FormattedBISNumber:
description: (default = null)
nullable: true
type: string
required:
- Id
- ShortCode
- Type
description: (default = null)
nullable: true
type: object
examples:
response:
value:
Data:
Id: 00000000-0000-0000-0000-000000000000
ShortCode: 123456789
Code: "12345"
Type: 0
RRNNumber: 79040205768
FormattedRRNNumber: 79.04.02-057.68
LimosaNumber: 11223344556677888
BTW:
Id: 00000000-0000-0000-0000-000000000000
Number: "123456789"
Name: GeoDynamics
Country: 0
CountryCode: BE
FormattedBTWNumber: BE-123456789
Notes: John Doe
Badges:
- Id: 00000000-0000-0000-0000-000000000000
Number: 00BB4E6F
Type: 0
ExternalNumber: 00BB4E6F
FeedbackGSM:
Id: 00000000-0000-0000-0000-000000000000
Number: "+32478123456"
RegisterGSM:
Id: 00000000-0000-0000-0000-000000000000
Number: "+32478123456"
LimosaEndDate: 2019-01-25T08:00:00+02:00
CreationTimeStamp: 2019-01-25T08:00:00+02:00
BirthDate: 2019-01-25
ReceiveFeedback: false
ApproveRegistration: false
User:
Id: 00000000-0000-0000-0000-000000000000
Code: "012345"
Name: John Doe
Type: 0
BadgeTimeStamp: 2019-01-25T08:00:00+02:00
Inactive: false
InactivityTimestamp: 2019-01-25T08:00:00+02:00
A1ExpirationDate: 2019-01-25T08:00:00+02:00
VisaExpirationDate: 2019-01-25T08:00:00+02:00
Limosas:
- Id: 00000000-0000-0000-0000-000000000000
LimosaNumber: 11223344556677888
IsDefault: false
EndDate: 2020-10-30T00:00:00+01:00
Workplaces:
- Id: 00000000-0000-0000-0000-000000000000
DUC: ""
Code: "012345"
Name: GeoDynamics
QrUrl: https://api.intellitracer.be/qrcode.pdf
Info: Person info
LimosaStartDate: 2019-01-25T08:00:00
BISNumber: 79040205768
FormattedBISNumber: 79.04.02-057.68
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"404":
description: NotFound
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Get person
operationId: Get person
description: |-
Returns a person by id.
The default Limosa is indicated by *LimosaNumber* and *LimosaEndDate*.
*Privilege required: `Api: Check In At Work`*
x-resource: Persons
tags:
- Check In At Work
parameters:
- name: id
in: path
description: ""
required: true
example: 00000000-0000-0000-0000-000000000000
schema:
type: string
security:
- pat: []
delete:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Data:
properties:
Id:
type: string
ShortCode:
type: number
Code:
description: (default = null)
nullable: true
type: string
Type:
type: number
x-enum-type: IntelliTracer.ApiV2.PersonType
enum:
- 0
- 1
description: (default = 0)
RRNNumber:
type: number
description: (default = null)
FormattedRRNNumber:
description: (default = null)
nullable: true
type: string
LimosaNumber:
type: number
description: (default = null)
BTW:
properties:
Id:
type: string
Number:
type: string
Name:
type: string
Country:
type: number
x-enum-type: IntelliTracer.Domain.Country
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
- 47
- 48
- 49
- 50
- 51
- 52
- 53
- 54
- 55
- 56
- 57
- 58
- 59
- 60
- 61
- 62
- 63
- 64
- 65
- 66
- 67
- 68
- 69
- 70
- 71
- 72
- 73
- 74
- 75
- 76
- 77
- 78
- 79
- 80
- 81
- 82
- 83
- 84
- 85
- 86
- 87
- 88
- 89
- 90
- 91
- 92
- 93
- 94
- 95
- 96
- 97
- 98
- 99
- 100
- 101
- 102
- 103
- 104
- 105
- 106
- 107
- 108
- 109
- 110
- 111
- 112
- 113
- 114
- 115
- 116
- 117
- 118
- 119
- 120
- 121
- 122
- 123
- 124
- 125
- 126
- 127
- 128
- 129
- 130
- 131
- 132
- 133
- 134
- 135
- 136
- 137
- 138
- 139
- 140
- 141
- 142
- 143
- 144
- 145
- 146
- 147
- 148
- 149
- 150
- 151
- 152
- 153
- 9999
description: (default = 0)
CountryCode:
type: string
FormattedBTWNumber:
type: string
required:
- Id
- Number
- Name
- Country
- CountryCode
- FormattedBTWNumber
description: (default = null)
nullable: true
type: object
Notes:
description: (default = null)
nullable: true
type: string
Badges:
description: (default = [])
nullable: true
type: array
items: {}
FeedbackGSM:
properties:
Id:
type: string
Number:
type: string
required:
- Id
- Number
description: (default = null)
nullable: true
type: object
RegisterGSM:
properties:
Id:
type: string
Number:
type: string
required:
- Id
- Number
description: (default = null)
nullable: true
type: object
LimosaEndDate:
description: (default = null)
nullable: true
type: string
CreationTimeStamp:
description: (default = null)
nullable: true
type: string
BirthDate:
description: (default = null)
nullable: true
type: string
ReceiveFeedback:
type: boolean
description: (default = false)
ApproveRegistration:
type: boolean
description: (default = false)
User:
properties:
Id:
type: string
Code:
description: (default = null)
nullable: true
type: string
Name:
type: string
Type:
type: number
x-enum-type: IntelliTracer.Domain.ResourceType
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
description: (default = 0)
required:
- Id
- Name
description: (default = null)
nullable: true
type: object
BadgeTimeStamp:
description: "(default = null) "
nullable: true
type: string
Inactive:
type: boolean
description: (default = false)
InactivityTimestamp:
description: (default = null)
nullable: true
type: string
A1ExpirationDate:
description: (default = null)
nullable: true
type: string
VisaExpirationDate:
description: (default = null)
nullable: true
type: string
Limosas:
description: (default = null)
nullable: true
type: array
items: {}
QrUrl:
description: (default = null)
nullable: true
type: string
Info:
type: string
LimosaStartDate:
description: (default = null)
nullable: true
type: string
BISNumber:
type: number
description: (default = null)
FormattedBISNumber:
description: (default = null)
nullable: true
type: string
required:
- Id
- ShortCode
- Type
description: (default = null)
nullable: true
type: object
examples:
response:
value:
Data:
Id: 00000000-0000-0000-0000-000000000000
ShortCode: 123456789
Code: "12345"
Type: 0
RRNNumber: 79040205768
FormattedRRNNumber: 79.04.02-057.68
LimosaNumber: 11223344556677888
BTW:
Id: 00000000-0000-0000-0000-000000000000
Number: "123456789"
Name: GeoDynamics
Country: 0
CountryCode: BE
FormattedBTWNumber: BE-123456789
Notes: John Doe
Badges:
- Id: 00000000-0000-0000-0000-000000000000
Number: 00BB4E6F
Type: 0
ExternalNumber: 00BB4E6F
FeedbackGSM:
Id: 00000000-0000-0000-0000-000000000000
Number: "+32478123456"
RegisterGSM:
Id: 00000000-0000-0000-0000-000000000000
Number: "+32478123456"
LimosaEndDate: 2019-01-25T08:00:00+02:00
CreationTimeStamp: 2019-01-25T08:00:00+02:00
BirthDate: 2019-01-25
ReceiveFeedback: false
ApproveRegistration: false
User:
Id: 00000000-0000-0000-0000-000000000000
Code: "012345"
Name: John Doe
Type: 0
BadgeTimeStamp: 2019-01-25T08:00:00+02:00
Inactive: false
InactivityTimestamp: 2019-01-25T08:00:00+02:00
A1ExpirationDate: 2019-01-25T08:00:00+02:00
VisaExpirationDate: 2019-01-25T08:00:00+02:00
Limosas:
- Id: 00000000-0000-0000-0000-000000000000
LimosaNumber: 11223344556677888
IsDefault: false
EndDate: 2020-10-30T00:00:00+01:00
Workplaces:
- Id: 00000000-0000-0000-0000-000000000000
DUC: ""
Code: "012345"
Name: GeoDynamics
QrUrl: https://api.intellitracer.be/qrcode.pdf
Info: Person info
LimosaStartDate: 2019-01-25T08:00:00
BISNumber: 79040205768
FormattedBISNumber: 79.04.02-057.68
"400":
description: BadRequest
headers: {}
content:
application/json:
schema:
type: array
items: {}
examples:
response:
value:
- Property: Name
Message: Required
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"404":
description: NotFound
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Delete person
operationId: Delete person
description: |-
Deletes a person by id.
*Privilege required: `Api: Check In At Work`*
x-resource: Persons
tags:
- Check In At Work
parameters:
- name: id
in: path
description: ""
required: true
example: 00000000-0000-0000-0000-000000000000
schema:
type: string
security:
- pat: []
/api/v2/person/bylimosa:
get:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Data:
properties:
Id:
type: string
ShortCode:
type: number
Code:
description: (default = null)
nullable: true
type: string
Type:
type: number
x-enum-type: IntelliTracer.ApiV2.PersonType
enum:
- 0
- 1
description: (default = 0)
RRNNumber:
type: number
description: (default = null)
FormattedRRNNumber:
description: (default = null)
nullable: true
type: string
LimosaNumber:
type: number
description: (default = null)
BTW:
properties:
Id:
type: string
Number:
type: string
Name:
type: string
Country:
type: number
x-enum-type: IntelliTracer.Domain.Country
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
- 47
- 48
- 49
- 50
- 51
- 52
- 53
- 54
- 55
- 56
- 57
- 58
- 59
- 60
- 61
- 62
- 63
- 64
- 65
- 66
- 67
- 68
- 69
- 70
- 71
- 72
- 73
- 74
- 75
- 76
- 77
- 78
- 79
- 80
- 81
- 82
- 83
- 84
- 85
- 86
- 87
- 88
- 89
- 90
- 91
- 92
- 93
- 94
- 95
- 96
- 97
- 98
- 99
- 100
- 101
- 102
- 103
- 104
- 105
- 106
- 107
- 108
- 109
- 110
- 111
- 112
- 113
- 114
- 115
- 116
- 117
- 118
- 119
- 120
- 121
- 122
- 123
- 124
- 125
- 126
- 127
- 128
- 129
- 130
- 131
- 132
- 133
- 134
- 135
- 136
- 137
- 138
- 139
- 140
- 141
- 142
- 143
- 144
- 145
- 146
- 147
- 148
- 149
- 150
- 151
- 152
- 153
- 9999
description: (default = 0)
CountryCode:
type: string
FormattedBTWNumber:
type: string
required:
- Id
- Number
- Name
- Country
- CountryCode
- FormattedBTWNumber
description: (default = null)
nullable: true
type: object
Notes:
description: (default = null)
nullable: true
type: string
Badges:
description: (default = [])
nullable: true
type: array
items: {}
FeedbackGSM:
properties:
Id:
type: string
Number:
type: string
required:
- Id
- Number
description: (default = null)
nullable: true
type: object
RegisterGSM:
properties:
Id:
type: string
Number:
type: string
required:
- Id
- Number
description: (default = null)
nullable: true
type: object
LimosaEndDate:
description: (default = null)
nullable: true
type: string
CreationTimeStamp:
description: (default = null)
nullable: true
type: string
BirthDate:
description: (default = null)
nullable: true
type: string
ReceiveFeedback:
type: boolean
description: (default = false)
ApproveRegistration:
type: boolean
description: (default = false)
User:
properties:
Id:
type: string
Code:
description: (default = null)
nullable: true
type: string
Name:
type: string
Type:
type: number
x-enum-type: IntelliTracer.Domain.ResourceType
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
description: (default = 0)
required:
- Id
- Name
description: (default = null)
nullable: true
type: object
BadgeTimeStamp:
description: "(default = null) "
nullable: true
type: string
Inactive:
type: boolean
description: (default = false)
InactivityTimestamp:
description: (default = null)
nullable: true
type: string
A1ExpirationDate:
description: (default = null)
nullable: true
type: string
VisaExpirationDate:
description: (default = null)
nullable: true
type: string
Limosas:
description: (default = null)
nullable: true
type: array
items: {}
QrUrl:
description: (default = null)
nullable: true
type: string
Info:
type: string
LimosaStartDate:
description: (default = null)
nullable: true
type: string
BISNumber:
type: number
description: (default = null)
FormattedBISNumber:
description: (default = null)
nullable: true
type: string
required:
- Id
- ShortCode
- Type
description: (default = null)
nullable: true
type: object
examples:
response:
value:
Data:
Id: 00000000-0000-0000-0000-000000000000
ShortCode: 123456789
Code: "12345"
Type: 0
RRNNumber: 79040205768
FormattedRRNNumber: 79.04.02-057.68
LimosaNumber: 11223344556677888
BTW:
Id: 00000000-0000-0000-0000-000000000000
Number: "123456789"
Name: GeoDynamics
Country: 0
CountryCode: BE
FormattedBTWNumber: BE-123456789
Notes: John Doe
Badges:
- Id: 00000000-0000-0000-0000-000000000000
Number: 00BB4E6F
Type: 0
ExternalNumber: 00BB4E6F
FeedbackGSM:
Id: 00000000-0000-0000-0000-000000000000
Number: "+32478123456"
RegisterGSM:
Id: 00000000-0000-0000-0000-000000000000
Number: "+32478123456"
LimosaEndDate: 2019-01-25T08:00:00+02:00
CreationTimeStamp: 2019-01-25T08:00:00+02:00
BirthDate: 2019-01-25
ReceiveFeedback: false
ApproveRegistration: false
User:
Id: 00000000-0000-0000-0000-000000000000
Code: "012345"
Name: John Doe
Type: 0
BadgeTimeStamp: 2019-01-25T08:00:00+02:00
Inactive: false
InactivityTimestamp: 2019-01-25T08:00:00+02:00
A1ExpirationDate: 2019-01-25T08:00:00+02:00
VisaExpirationDate: 2019-01-25T08:00:00+02:00
Limosas:
- Id: 00000000-0000-0000-0000-000000000000
LimosaNumber: 11223344556677888
IsDefault: false
EndDate: 2020-10-30T00:00:00+01:00
Workplaces:
- Id: 00000000-0000-0000-0000-000000000000
DUC: ""
Code: "012345"
Name: GeoDynamics
QrUrl: https://api.intellitracer.be/qrcode.pdf
Info: Person info
LimosaStartDate: 2019-01-25T08:00:00
BISNumber: 79040205768
FormattedBISNumber: 79.04.02-057.68
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"404":
description: NotFound
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Get person by Limosa
operationId: Get person by Limosa
description: |-
Returns a person by Limosa number.
The default Limosa is indicated by *LimosaNumber* and *LimosaEndDate*.
*Privilege required: `Api: Check In At Work`*
x-resource: Persons
tags:
- Check In At Work
parameters:
- name: limosaNumber
in: query
description: ""
required: true
example: "12345678912"
schema:
type: number
security:
- pat: []
put:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Data:
properties:
Id:
type: string
ShortCode:
type: number
Code:
description: (default = null)
nullable: true
type: string
Type:
type: number
x-enum-type: IntelliTracer.ApiV2.PersonType
enum:
- 0
- 1
description: (default = 0)
RRNNumber:
type: number
description: (default = null)
FormattedRRNNumber:
description: (default = null)
nullable: true
type: string
LimosaNumber:
type: number
description: (default = null)
BTW:
properties:
Id:
type: string
Number:
type: string
Name:
type: string
Country:
type: number
x-enum-type: IntelliTracer.Domain.Country
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
- 47
- 48
- 49
- 50
- 51
- 52
- 53
- 54
- 55
- 56
- 57
- 58
- 59
- 60
- 61
- 62
- 63
- 64
- 65
- 66
- 67
- 68
- 69
- 70
- 71
- 72
- 73
- 74
- 75
- 76
- 77
- 78
- 79
- 80
- 81
- 82
- 83
- 84
- 85
- 86
- 87
- 88
- 89
- 90
- 91
- 92
- 93
- 94
- 95
- 96
- 97
- 98
- 99
- 100
- 101
- 102
- 103
- 104
- 105
- 106
- 107
- 108
- 109
- 110
- 111
- 112
- 113
- 114
- 115
- 116
- 117
- 118
- 119
- 120
- 121
- 122
- 123
- 124
- 125
- 126
- 127
- 128
- 129
- 130
- 131
- 132
- 133
- 134
- 135
- 136
- 137
- 138
- 139
- 140
- 141
- 142
- 143
- 144
- 145
- 146
- 147
- 148
- 149
- 150
- 151
- 152
- 153
- 9999
description: (default = 0)
CountryCode:
type: string
FormattedBTWNumber:
type: string
required:
- Id
- Number
- Name
- Country
- CountryCode
- FormattedBTWNumber
description: (default = null)
nullable: true
type: object
Notes:
description: (default = null)
nullable: true
type: string
Badges:
description: (default = [])
nullable: true
type: array
items: {}
FeedbackGSM:
properties:
Id:
type: string
Number:
type: string
required:
- Id
- Number
description: (default = null)
nullable: true
type: object
RegisterGSM:
properties:
Id:
type: string
Number:
type: string
required:
- Id
- Number
description: (default = null)
nullable: true
type: object
LimosaEndDate:
description: (default = null)
nullable: true
type: string
CreationTimeStamp:
description: (default = null)
nullable: true
type: string
BirthDate:
description: (default = null)
nullable: true
type: string
ReceiveFeedback:
type: boolean
description: (default = false)
ApproveRegistration:
type: boolean
description: (default = false)
User:
properties:
Id:
type: string
Code:
description: (default = null)
nullable: true
type: string
Name:
type: string
Type:
type: number
x-enum-type: IntelliTracer.Domain.ResourceType
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
description: (default = 0)
required:
- Id
- Name
description: (default = null)
nullable: true
type: object
BadgeTimeStamp:
description: "(default = null) "
nullable: true
type: string
Inactive:
type: boolean
description: (default = false)
InactivityTimestamp:
description: (default = null)
nullable: true
type: string
A1ExpirationDate:
description: (default = null)
nullable: true
type: string
VisaExpirationDate:
description: (default = null)
nullable: true
type: string
Limosas:
description: (default = null)
nullable: true
type: array
items: {}
QrUrl:
description: (default = null)
nullable: true
type: string
Info:
type: string
LimosaStartDate:
description: (default = null)
nullable: true
type: string
BISNumber:
type: number
description: (default = null)
FormattedBISNumber:
description: (default = null)
nullable: true
type: string
required:
- Id
- ShortCode
- Type
description: (default = null)
nullable: true
type: object
examples:
response:
value:
Data:
Id: 00000000-0000-0000-0000-000000000000
ShortCode: 123456789
Code: "12345"
Type: 0
RRNNumber: 79040205768
FormattedRRNNumber: 79.04.02-057.68
LimosaNumber: 11223344556677888
BTW:
Id: 00000000-0000-0000-0000-000000000000
Number: "123456789"
Name: GeoDynamics
Country: 0
CountryCode: BE
FormattedBTWNumber: BE-123456789
Notes: John Doe
Badges:
- Id: 00000000-0000-0000-0000-000000000000
Number: 00BB4E6F
Type: 0
ExternalNumber: 00BB4E6F
FeedbackGSM:
Id: 00000000-0000-0000-0000-000000000000
Number: "+32478123456"
RegisterGSM:
Id: 00000000-0000-0000-0000-000000000000
Number: "+32478123456"
LimosaEndDate: 2019-01-25T08:00:00+02:00
CreationTimeStamp: 2019-01-25T08:00:00+02:00
BirthDate: 2019-01-25
ReceiveFeedback: false
ApproveRegistration: false
User:
Id: 00000000-0000-0000-0000-000000000000
Code: "012345"
Name: John Doe
Type: 0
BadgeTimeStamp: 2019-01-25T08:00:00+02:00
Inactive: false
InactivityTimestamp: 2019-01-25T08:00:00+02:00
A1ExpirationDate: 2019-01-25T08:00:00+02:00
VisaExpirationDate: 2019-01-25T08:00:00+02:00
Limosas:
- Id: 00000000-0000-0000-0000-000000000000
LimosaNumber: 11223344556677888
IsDefault: false
EndDate: 2020-10-30T00:00:00+01:00
Workplaces:
- Id: 00000000-0000-0000-0000-000000000000
DUC: ""
Code: "012345"
Name: GeoDynamics
QrUrl: https://api.intellitracer.be/qrcode.pdf
Info: Person info
LimosaStartDate: 2019-01-25T08:00:00
BISNumber: 79040205768
FormattedBISNumber: 79.04.02-057.68
"400":
description: BadRequest
headers: {}
content:
application/json:
schema:
type: array
items: {}
examples:
response:
value:
- Property: Name
Message: Required
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Create person by Limosa
operationId: Create person by Limosa
description: >-
Creates a new person by Limosa number and links the person to a badge.
If necessary, a new badge is created.
*Privilege required: `Api: Check In At Work`*
x-resource: Persons
tags:
- Check In At Work
requestBody:
content:
application/json:
schema:
type: object
properties:
Code:
description: (default = null)
nullable: true
type: string
Name:
description: (default = null)
nullable: true
type: string
BTWNumber:
description: (default = null)
nullable: true
type: string
FeedbackGSMNumber:
description: (default = null)
nullable: true
type: string
RegisterGSMNumber:
description: (default = null)
nullable: true
type: string
OwnStaff:
type: boolean
description: "(default = false) "
BadgeNumber:
description: "(default = null) "
nullable: true
type: string
ReceiveFeedback:
type: boolean
description: (default = false)
LimosaNumber:
type: number
BirthDate:
description: (default = null)
nullable: true
type: string
ExpirationDate:
description: (default = null)
nullable: true
type: string
BisNumber:
nullable: true
type: number
required:
- LimosaNumber
example:
Code: "12345"
Name: John Doe
BTWNumber: BE-0000000000
FeedbackGSMNumber: "+32478123456"
RegisterGSMNumber: "+32478123456"
OwnStaff: false
BadgeNumber: 00BB4E6F
ReceiveFeedback: false
LimosaNumber: 11223344556677888
BirthDate: 2019-01-25
ExpirationDate: 2019-01-25T08:00:00+02:00
BisNumber: 79040205768
security:
- pat: []
/api/v2/person/byrrnbtw:
get:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Data:
properties:
Id:
type: string
ShortCode:
type: number
Code:
description: (default = null)
nullable: true
type: string
Type:
type: number
x-enum-type: IntelliTracer.ApiV2.PersonType
enum:
- 0
- 1
description: (default = 0)
RRNNumber:
type: number
description: (default = null)
FormattedRRNNumber:
description: (default = null)
nullable: true
type: string
LimosaNumber:
type: number
description: (default = null)
BTW:
properties:
Id:
type: string
Number:
type: string
Name:
type: string
Country:
type: number
x-enum-type: IntelliTracer.Domain.Country
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
- 47
- 48
- 49
- 50
- 51
- 52
- 53
- 54
- 55
- 56
- 57
- 58
- 59
- 60
- 61
- 62
- 63
- 64
- 65
- 66
- 67
- 68
- 69
- 70
- 71
- 72
- 73
- 74
- 75
- 76
- 77
- 78
- 79
- 80
- 81
- 82
- 83
- 84
- 85
- 86
- 87
- 88
- 89
- 90
- 91
- 92
- 93
- 94
- 95
- 96
- 97
- 98
- 99
- 100
- 101
- 102
- 103
- 104
- 105
- 106
- 107
- 108
- 109
- 110
- 111
- 112
- 113
- 114
- 115
- 116
- 117
- 118
- 119
- 120
- 121
- 122
- 123
- 124
- 125
- 126
- 127
- 128
- 129
- 130
- 131
- 132
- 133
- 134
- 135
- 136
- 137
- 138
- 139
- 140
- 141
- 142
- 143
- 144
- 145
- 146
- 147
- 148
- 149
- 150
- 151
- 152
- 153
- 9999
description: (default = 0)
CountryCode:
type: string
FormattedBTWNumber:
type: string
required:
- Id
- Number
- Name
- Country
- CountryCode
- FormattedBTWNumber
description: (default = null)
nullable: true
type: object
Notes:
description: (default = null)
nullable: true
type: string
Badges:
description: (default = [])
nullable: true
type: array
items: {}
FeedbackGSM:
properties:
Id:
type: string
Number:
type: string
required:
- Id
- Number
description: (default = null)
nullable: true
type: object
RegisterGSM:
properties:
Id:
type: string
Number:
type: string
required:
- Id
- Number
description: (default = null)
nullable: true
type: object
LimosaEndDate:
description: (default = null)
nullable: true
type: string
CreationTimeStamp:
description: (default = null)
nullable: true
type: string
BirthDate:
description: (default = null)
nullable: true
type: string
ReceiveFeedback:
type: boolean
description: (default = false)
ApproveRegistration:
type: boolean
description: (default = false)
User:
properties:
Id:
type: string
Code:
description: (default = null)
nullable: true
type: string
Name:
type: string
Type:
type: number
x-enum-type: IntelliTracer.Domain.ResourceType
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
description: (default = 0)
required:
- Id
- Name
description: (default = null)
nullable: true
type: object
BadgeTimeStamp:
description: "(default = null) "
nullable: true
type: string
Inactive:
type: boolean
description: (default = false)
InactivityTimestamp:
description: (default = null)
nullable: true
type: string
A1ExpirationDate:
description: (default = null)
nullable: true
type: string
VisaExpirationDate:
description: (default = null)
nullable: true
type: string
Limosas:
description: (default = null)
nullable: true
type: array
items: {}
QrUrl:
description: (default = null)
nullable: true
type: string
Info:
type: string
LimosaStartDate:
description: (default = null)
nullable: true
type: string
BISNumber:
type: number
description: (default = null)
FormattedBISNumber:
description: (default = null)
nullable: true
type: string
required:
- Id
- ShortCode
- Type
description: (default = null)
nullable: true
type: object
examples:
response:
value:
Data:
Id: 00000000-0000-0000-0000-000000000000
ShortCode: 123456789
Code: "12345"
Type: 0
RRNNumber: 79040205768
FormattedRRNNumber: 79.04.02-057.68
LimosaNumber: 11223344556677888
BTW:
Id: 00000000-0000-0000-0000-000000000000
Number: "123456789"
Name: GeoDynamics
Country: 0
CountryCode: BE
FormattedBTWNumber: BE-123456789
Notes: John Doe
Badges:
- Id: 00000000-0000-0000-0000-000000000000
Number: 00BB4E6F
Type: 0
ExternalNumber: 00BB4E6F
FeedbackGSM:
Id: 00000000-0000-0000-0000-000000000000
Number: "+32478123456"
RegisterGSM:
Id: 00000000-0000-0000-0000-000000000000
Number: "+32478123456"
LimosaEndDate: 2019-01-25T08:00:00+02:00
CreationTimeStamp: 2019-01-25T08:00:00+02:00
BirthDate: 2019-01-25
ReceiveFeedback: false
ApproveRegistration: false
User:
Id: 00000000-0000-0000-0000-000000000000
Code: "012345"
Name: John Doe
Type: 0
BadgeTimeStamp: 2019-01-25T08:00:00+02:00
Inactive: false
InactivityTimestamp: 2019-01-25T08:00:00+02:00
A1ExpirationDate: 2019-01-25T08:00:00+02:00
VisaExpirationDate: 2019-01-25T08:00:00+02:00
Limosas:
- Id: 00000000-0000-0000-0000-000000000000
LimosaNumber: 11223344556677888
IsDefault: false
EndDate: 2020-10-30T00:00:00+01:00
Workplaces:
- Id: 00000000-0000-0000-0000-000000000000
DUC: ""
Code: "012345"
Name: GeoDynamics
QrUrl: https://api.intellitracer.be/qrcode.pdf
Info: Person info
LimosaStartDate: 2019-01-25T08:00:00
BISNumber: 79040205768
FormattedBISNumber: 79.04.02-057.68
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"404":
description: NotFound
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Get person by RRN and BTW
operationId: Get person by RRN and BTW
description: |-
Returns a person by RRN and BTW number.
*Privilege required: `Api: Check In At Work`*
x-resource: Persons
tags:
- Check In At Work
parameters:
- name: rrnNumber
in: query
description: ""
required: true
example: "12345678912"
schema:
type: number
- name: btwNumber
in: query
description: ""
required: true
example: BE-0000000000
schema:
type: string
security:
- pat: []
put:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Data:
properties:
Id:
type: string
ShortCode:
type: number
Code:
description: (default = null)
nullable: true
type: string
Type:
type: number
x-enum-type: IntelliTracer.ApiV2.PersonType
enum:
- 0
- 1
description: (default = 0)
RRNNumber:
type: number
description: (default = null)
FormattedRRNNumber:
description: (default = null)
nullable: true
type: string
LimosaNumber:
type: number
description: (default = null)
BTW:
properties:
Id:
type: string
Number:
type: string
Name:
type: string
Country:
type: number
x-enum-type: IntelliTracer.Domain.Country
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
- 47
- 48
- 49
- 50
- 51
- 52
- 53
- 54
- 55
- 56
- 57
- 58
- 59
- 60
- 61
- 62
- 63
- 64
- 65
- 66
- 67
- 68
- 69
- 70
- 71
- 72
- 73
- 74
- 75
- 76
- 77
- 78
- 79
- 80
- 81
- 82
- 83
- 84
- 85
- 86
- 87
- 88
- 89
- 90
- 91
- 92
- 93
- 94
- 95
- 96
- 97
- 98
- 99
- 100
- 101
- 102
- 103
- 104
- 105
- 106
- 107
- 108
- 109
- 110
- 111
- 112
- 113
- 114
- 115
- 116
- 117
- 118
- 119
- 120
- 121
- 122
- 123
- 124
- 125
- 126
- 127
- 128
- 129
- 130
- 131
- 132
- 133
- 134
- 135
- 136
- 137
- 138
- 139
- 140
- 141
- 142
- 143
- 144
- 145
- 146
- 147
- 148
- 149
- 150
- 151
- 152
- 153
- 9999
description: (default = 0)
CountryCode:
type: string
FormattedBTWNumber:
type: string
required:
- Id
- Number
- Name
- Country
- CountryCode
- FormattedBTWNumber
description: (default = null)
nullable: true
type: object
Notes:
description: (default = null)
nullable: true
type: string
Badges:
description: (default = [])
nullable: true
type: array
items: {}
FeedbackGSM:
properties:
Id:
type: string
Number:
type: string
required:
- Id
- Number
description: (default = null)
nullable: true
type: object
RegisterGSM:
properties:
Id:
type: string
Number:
type: string
required:
- Id
- Number
description: (default = null)
nullable: true
type: object
LimosaEndDate:
description: (default = null)
nullable: true
type: string
CreationTimeStamp:
description: (default = null)
nullable: true
type: string
BirthDate:
description: (default = null)
nullable: true
type: string
ReceiveFeedback:
type: boolean
description: (default = false)
ApproveRegistration:
type: boolean
description: (default = false)
User:
properties:
Id:
type: string
Code:
description: (default = null)
nullable: true
type: string
Name:
type: string
Type:
type: number
x-enum-type: IntelliTracer.Domain.ResourceType
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
description: (default = 0)
required:
- Id
- Name
description: (default = null)
nullable: true
type: object
BadgeTimeStamp:
description: "(default = null) "
nullable: true
type: string
Inactive:
type: boolean
description: (default = false)
InactivityTimestamp:
description: (default = null)
nullable: true
type: string
A1ExpirationDate:
description: (default = null)
nullable: true
type: string
VisaExpirationDate:
description: (default = null)
nullable: true
type: string
Limosas:
description: (default = null)
nullable: true
type: array
items: {}
QrUrl:
description: (default = null)
nullable: true
type: string
Info:
type: string
LimosaStartDate:
description: (default = null)
nullable: true
type: string
BISNumber:
type: number
description: (default = null)
FormattedBISNumber:
description: (default = null)
nullable: true
type: string
required:
- Id
- ShortCode
- Type
description: (default = null)
nullable: true
type: object
examples:
response:
value:
Data:
Id: 00000000-0000-0000-0000-000000000000
ShortCode: 123456789
Code: "12345"
Type: 0
RRNNumber: 79040205768
FormattedRRNNumber: 79.04.02-057.68
LimosaNumber: 11223344556677888
BTW:
Id: 00000000-0000-0000-0000-000000000000
Number: "123456789"
Name: GeoDynamics
Country: 0
CountryCode: BE
FormattedBTWNumber: BE-123456789
Notes: John Doe
Badges:
- Id: 00000000-0000-0000-0000-000000000000
Number: 00BB4E6F
Type: 0
ExternalNumber: 00BB4E6F
FeedbackGSM:
Id: 00000000-0000-0000-0000-000000000000
Number: "+32478123456"
RegisterGSM:
Id: 00000000-0000-0000-0000-000000000000
Number: "+32478123456"
LimosaEndDate: 2019-01-25T08:00:00+02:00
CreationTimeStamp: 2019-01-25T08:00:00+02:00
BirthDate: 2019-01-25
ReceiveFeedback: false
ApproveRegistration: false
User:
Id: 00000000-0000-0000-0000-000000000000
Code: "012345"
Name: John Doe
Type: 0
BadgeTimeStamp: 2019-01-25T08:00:00+02:00
Inactive: false
InactivityTimestamp: 2019-01-25T08:00:00+02:00
A1ExpirationDate: 2019-01-25T08:00:00+02:00
VisaExpirationDate: 2019-01-25T08:00:00+02:00
Limosas:
- Id: 00000000-0000-0000-0000-000000000000
LimosaNumber: 11223344556677888
IsDefault: false
EndDate: 2020-10-30T00:00:00+01:00
Workplaces:
- Id: 00000000-0000-0000-0000-000000000000
DUC: ""
Code: "012345"
Name: GeoDynamics
QrUrl: https://api.intellitracer.be/qrcode.pdf
Info: Person info
LimosaStartDate: 2019-01-25T08:00:00
BISNumber: 79040205768
FormattedBISNumber: 79.04.02-057.68
"400":
description: BadRequest
headers: {}
content:
application/json:
schema:
type: array
items: {}
examples:
response:
value:
- Property: Name
Message: Required
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Create person by RRN and BTW
operationId: Create person by RRN and BTW
description: >-
Creates a new person by RRN and BTW number and links the person to a
badge. If necessary, a new badge is created.
*Privilege required: `Api: Check In At Work`*
x-resource: Persons
tags:
- Check In At Work
requestBody:
content:
application/json:
schema:
type: object
properties:
Code:
description: (default = null)
nullable: true
type: string
Name:
description: (default = null)
nullable: true
type: string
BTWNumber:
type: string
description: (default = null)
FeedbackGSMNumber:
description: (default = null)
nullable: true
type: string
RegisterGSMNumber:
description: (default = null)
nullable: true
type: string
OwnStaff:
type: boolean
description: "(default = false) "
BadgeNumber:
description: "(default = null) "
nullable: true
type: string
ReceiveFeedback:
type: boolean
description: (default = false)
RRNNumber:
type: number
required:
- BTWNumber
- RRNNumber
example:
Code: "12345"
Name: John Doe
BTWNumber: BE-0000000000
FeedbackGSMNumber: "+32478123456"
RegisterGSMNumber: "+32478123456"
OwnStaff: false
BadgeNumber: 00BB4E6F
ReceiveFeedback: false
RRNNumber: 79040205768
security:
- pat: []
/api/v2/person/bybis:
put:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Data:
properties:
Id:
type: string
ShortCode:
type: number
Code:
description: (default = null)
nullable: true
type: string
Type:
type: number
x-enum-type: IntelliTracer.ApiV2.PersonType
enum:
- 0
- 1
description: (default = 0)
RRNNumber:
type: number
description: (default = null)
FormattedRRNNumber:
description: (default = null)
nullable: true
type: string
LimosaNumber:
type: number
description: (default = null)
BTW:
properties:
Id:
type: string
Number:
type: string
Name:
type: string
Country:
type: number
x-enum-type: IntelliTracer.Domain.Country
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
- 47
- 48
- 49
- 50
- 51
- 52
- 53
- 54
- 55
- 56
- 57
- 58
- 59
- 60
- 61
- 62
- 63
- 64
- 65
- 66
- 67
- 68
- 69
- 70
- 71
- 72
- 73
- 74
- 75
- 76
- 77
- 78
- 79
- 80
- 81
- 82
- 83
- 84
- 85
- 86
- 87
- 88
- 89
- 90
- 91
- 92
- 93
- 94
- 95
- 96
- 97
- 98
- 99
- 100
- 101
- 102
- 103
- 104
- 105
- 106
- 107
- 108
- 109
- 110
- 111
- 112
- 113
- 114
- 115
- 116
- 117
- 118
- 119
- 120
- 121
- 122
- 123
- 124
- 125
- 126
- 127
- 128
- 129
- 130
- 131
- 132
- 133
- 134
- 135
- 136
- 137
- 138
- 139
- 140
- 141
- 142
- 143
- 144
- 145
- 146
- 147
- 148
- 149
- 150
- 151
- 152
- 153
- 9999
description: (default = 0)
CountryCode:
type: string
FormattedBTWNumber:
type: string
required:
- Id
- Number
- Name
- Country
- CountryCode
- FormattedBTWNumber
description: (default = null)
nullable: true
type: object
Notes:
description: (default = null)
nullable: true
type: string
Badges:
description: (default = [])
nullable: true
type: array
items: {}
FeedbackGSM:
properties:
Id:
type: string
Number:
type: string
required:
- Id
- Number
description: (default = null)
nullable: true
type: object
RegisterGSM:
properties:
Id:
type: string
Number:
type: string
required:
- Id
- Number
description: (default = null)
nullable: true
type: object
LimosaEndDate:
description: (default = null)
nullable: true
type: string
CreationTimeStamp:
description: (default = null)
nullable: true
type: string
BirthDate:
description: (default = null)
nullable: true
type: string
ReceiveFeedback:
type: boolean
description: (default = false)
ApproveRegistration:
type: boolean
description: (default = false)
User:
properties:
Id:
type: string
Code:
description: (default = null)
nullable: true
type: string
Name:
type: string
Type:
type: number
x-enum-type: IntelliTracer.Domain.ResourceType
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
description: (default = 0)
required:
- Id
- Name
description: (default = null)
nullable: true
type: object
BadgeTimeStamp:
description: "(default = null) "
nullable: true
type: string
Inactive:
type: boolean
description: (default = false)
InactivityTimestamp:
description: (default = null)
nullable: true
type: string
A1ExpirationDate:
description: (default = null)
nullable: true
type: string
VisaExpirationDate:
description: (default = null)
nullable: true
type: string
Limosas:
description: (default = null)
nullable: true
type: array
items: {}
QrUrl:
description: (default = null)
nullable: true
type: string
Info:
type: string
LimosaStartDate:
description: (default = null)
nullable: true
type: string
BISNumber:
type: number
description: (default = null)
FormattedBISNumber:
description: (default = null)
nullable: true
type: string
required:
- Id
- ShortCode
- Type
description: (default = null)
nullable: true
type: object
examples:
response:
value:
Data:
Id: 00000000-0000-0000-0000-000000000000
ShortCode: 123456789
Code: "12345"
Type: 0
RRNNumber: 79040205768
FormattedRRNNumber: 79.04.02-057.68
LimosaNumber: 11223344556677888
BTW:
Id: 00000000-0000-0000-0000-000000000000
Number: "123456789"
Name: GeoDynamics
Country: 0
CountryCode: BE
FormattedBTWNumber: BE-123456789
Notes: John Doe
Badges:
- Id: 00000000-0000-0000-0000-000000000000
Number: 00BB4E6F
Type: 0
ExternalNumber: 00BB4E6F
FeedbackGSM:
Id: 00000000-0000-0000-0000-000000000000
Number: "+32478123456"
RegisterGSM:
Id: 00000000-0000-0000-0000-000000000000
Number: "+32478123456"
LimosaEndDate: 2019-01-25T08:00:00+02:00
CreationTimeStamp: 2019-01-25T08:00:00+02:00
BirthDate: 2019-01-25
ReceiveFeedback: false
ApproveRegistration: false
User:
Id: 00000000-0000-0000-0000-000000000000
Code: "012345"
Name: John Doe
Type: 0
BadgeTimeStamp: 2019-01-25T08:00:00+02:00
Inactive: false
InactivityTimestamp: 2019-01-25T08:00:00+02:00
A1ExpirationDate: 2019-01-25T08:00:00+02:00
VisaExpirationDate: 2019-01-25T08:00:00+02:00
Limosas:
- Id: 00000000-0000-0000-0000-000000000000
LimosaNumber: 11223344556677888
IsDefault: false
EndDate: 2020-10-30T00:00:00+01:00
Workplaces:
- Id: 00000000-0000-0000-0000-000000000000
DUC: ""
Code: "012345"
Name: GeoDynamics
QrUrl: https://api.intellitracer.be/qrcode.pdf
Info: Person info
LimosaStartDate: 2019-01-25T08:00:00
BISNumber: 79040205768
FormattedBISNumber: 79.04.02-057.68
"400":
description: BadRequest
headers: {}
content:
application/json:
schema:
type: array
items: {}
examples:
response:
value:
- Property: Name
Message: Required
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Create person by BIS
operationId: Create person by BIS
description: >-
Creates a new person by BIS number and links the person to a badge. If
necessary, a new badge is created.
*Privilege required: `Api: Check In At Work`*
x-resource: Persons
tags:
- Check In At Work
requestBody:
content:
application/json:
schema:
type: object
properties:
Code:
description: (default = null)
nullable: true
type: string
Name:
description: (default = null)
nullable: true
type: string
BTWNumber:
description: (default = null)
nullable: true
type: string
FeedbackGSMNumber:
description: (default = null)
nullable: true
type: string
RegisterGSMNumber:
description: (default = null)
nullable: true
type: string
OwnStaff:
type: boolean
description: "(default = false) "
BadgeNumber:
description: "(default = null) "
nullable: true
type: string
ReceiveFeedback:
type: boolean
description: (default = false)
BisNumber:
type: number
LimosaNumber:
nullable: true
type: number
StartDate:
description: (default = null)
nullable: true
type: string
BirthDate:
description: (default = null)
nullable: true
type: string
ExpirationDate:
description: (default = null)
nullable: true
type: string
required:
- BisNumber
example:
Code: "12345"
Name: John Doe
BTWNumber: BE-0000000000
FeedbackGSMNumber: "+32478123456"
RegisterGSMNumber: "+32478123456"
OwnStaff: false
BadgeNumber: 00BB4E6F
ReceiveFeedback: false
BisNumber: 79040205768
LimosaNumber: 11223344556677888
StartDate: 2019-01-25T08:00:00+02:00
BirthDate: 2019-01-25
ExpirationDate: 2019-01-25T08:00:00+02:00
security:
- pat: []
"/api/v3/person/{personId}/limosa?page={page}&search={search}":
get:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Data:
description: (default = null)
nullable: true
type: array
items: {}
PagingFilter:
properties:
Page:
type: number
Search:
nullable: true
type: string
PageCount:
type: number
TotalCount:
type: number
Links:
type: object
properties:
Base:
type: string
First:
type: string
Prev:
type: string
Next:
type: string
Last:
type: string
required:
- Base
required:
- Page
- PageCount
- TotalCount
- Links
description: (default = null)
nullable: true
type: object
examples:
response:
value:
Data:
- Id: 00000000-0000-0000-0000-000000000000
LimosaNumber: 11223344556677888
IsDefault: false
EndDate: 2020-10-30T00:00:00+01:00
Workplaces:
- Id: 00000000-0000-0000-0000-000000000000
DUC: 1Y100001AB1CD
Code: "012345"
Name: GeoDynamics
PagingFilter:
Page: 1
Search: ABC
PageCount: 4
TotalCount: 100
Links:
Base: https://api.intellitracer.be
First: /api/v2/asset?page=1
Prev: /api/v2/asset?page=2
Next: /api/v2/asset?page=4
Last: /api/v2/asset?page=4
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Get Limosas
operationId: Get Limosas
description: |-
Returns a paged list of Limosas linked to a person.
Pagination and searching is explained in [Pagination](#pagination).
*Privilege required: `Api: Check In At Work`*
x-resource: Person - Limosas
tags:
- Check In At Work
parameters:
- name: personId
in: path
description: ""
required: true
example: 00000000-0000-0000-0000-000000000000
schema:
type: string
- name: page
in: path
description: ""
required: true
example: "1"
schema:
type: number
- name: search
in: path
description: ""
required: true
example: ABC
schema:
type: string
security:
- pat: []
"/api/v3/person/{personId}/limosa/{limosaNumber}":
get:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Data:
properties:
Id:
type: string
LimosaNumber:
type: number
IsDefault:
type: boolean
description: (default = false)
EndDate:
description: (default = null)
nullable: true
type: string
Workplaces:
description: (default = [])
nullable: true
type: array
items: {}
required:
- Id
- LimosaNumber
description: (default = null)
nullable: true
type: object
examples:
response:
value:
Data:
Id: 00000000-0000-0000-0000-000000000000
LimosaNumber: 11223344556677888
IsDefault: false
EndDate: 2020-10-30T00:00:00+01:00
Workplaces:
- Id: 00000000-0000-0000-0000-000000000000
DUC: 1Y100001AB1CD
Code: "012345"
Name: GeoDynamics
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"404":
description: NotFound
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Get Limosa
operationId: Get Limosa
description: |-
Returns a person's Limosa by number.
*Privilege required: `Api: Check In At Work`*
x-resource: Person - Limosas
tags:
- Check In At Work
parameters:
- name: personId
in: path
description: ""
required: true
example: 00000000-0000-0000-0000-000000000000
schema:
type: string
- name: limosaNumber
in: path
description: ""
required: true
example: "11223344556677889"
schema:
type: number
security:
- pat: []
delete:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Data:
properties:
Id:
type: string
LimosaNumber:
type: number
IsDefault:
type: boolean
description: (default = false)
EndDate:
description: (default = null)
nullable: true
type: string
Workplaces:
description: (default = [])
nullable: true
type: array
items: {}
required:
- Id
- LimosaNumber
description: (default = null)
nullable: true
type: object
examples:
response:
value:
Data:
Id: 00000000-0000-0000-0000-000000000000
LimosaNumber: 11223344556677888
IsDefault: false
EndDate: 2020-10-30T00:00:00+01:00
Workplaces:
- Id: 00000000-0000-0000-0000-000000000000
DUC: 1Y100001AB1CD
Code: "012345"
Name: GeoDynamics
"400":
description: BadRequest
headers: {}
content:
application/json:
schema:
type: object
properties:
Entity:
type: object
properties:
Id:
type: string
LimosaNumber:
type: number
IsDefault:
type: boolean
description: (default = false)
EndDate:
description: (default = null)
nullable: true
type: string
Workplaces:
description: (default = [])
nullable: true
type: array
items: {}
required:
- Id
- LimosaNumber
ValidationResult:
type: array
items: {}
required:
- Entity
- ValidationResult
examples:
response:
value:
Entity:
Id: 00000000-0000-0000-0000-000000000000
LimosaNumber: 11223344556677888
IsDefault: false
EndDate: 2020-10-30T00:00:00+01:00
Workplaces:
- Id: 00000000-0000-0000-0000-000000000000
DUC: 1Y100001AB1CD
Code: "012345"
Name: GeoDynamics
ValidationResult:
- Message: ""
SourceMemberNames: []
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Delete Limosa
operationId: Delete Limosa
description: |-
Deletes a person's Limosa by number.
*Privilege required: `Api: Check In At Work`*
x-resource: Person - Limosas
tags:
- Check In At Work
parameters:
- name: personId
in: path
description: ""
required: true
example: 00000000-0000-0000-0000-000000000000
schema:
type: string
- name: limosaNumber
in: path
description: ""
required: true
example: "11223344556677889"
schema:
type: number
security:
- pat: []
"/api/v3/person/{personId}/limosa":
put:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Data:
properties:
Id:
type: string
LimosaNumber:
type: number
IsDefault:
type: boolean
description: (default = false)
EndDate:
description: (default = null)
nullable: true
type: string
Workplaces:
description: (default = [])
nullable: true
type: array
items: {}
required:
- Id
- LimosaNumber
description: (default = null)
nullable: true
type: object
examples:
response:
value:
Data:
Id: 00000000-0000-0000-0000-000000000000
LimosaNumber: 11223344556677888
IsDefault: false
EndDate: 2020-10-30T00:00:00+01:00
Workplaces:
- Id: 00000000-0000-0000-0000-000000000000
DUC: 1Y100001AB1CD
Code: "012345"
Name: GeoDynamics
"400":
description: BadRequest
headers: {}
content:
application/json:
schema:
type: object
properties:
Entity:
type: object
properties:
Id:
type: string
LimosaNumber:
type: number
IsDefault:
type: boolean
description: (default = false)
EndDate:
description: (default = null)
nullable: true
type: string
Workplaces:
description: (default = [])
nullable: true
type: array
items: {}
required:
- Id
- LimosaNumber
ValidationResult:
type: array
items: {}
required:
- Entity
- ValidationResult
examples:
response:
value:
Entity:
Id: 00000000-0000-0000-0000-000000000000
LimosaNumber: 11223344556677888
IsDefault: false
EndDate: 2020-10-30T00:00:00+01:00
Workplaces:
- Id: 00000000-0000-0000-0000-000000000000
DUC: 1Y100001AB1CD
Code: "012345"
Name: GeoDynamics
ValidationResult:
- Message: ""
SourceMemberNames: []
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Create Limosa
operationId: Create Limosa
description: |-
Creates a new Limosa and links to it to a person.
*Privilege required: `Api: Check In At Work`*
x-resource: Person - Limosas
tags:
- Check In At Work
parameters:
- name: personId
in: path
description: ""
required: true
example: 00000000-0000-0000-0000-000000000000
schema:
type: string
requestBody:
$ref: "#/components/requestBodies/Create_LimosaBody"
security:
- pat: []
post:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Data:
properties:
Id:
type: string
LimosaNumber:
type: number
IsDefault:
type: boolean
description: (default = false)
EndDate:
description: (default = null)
nullable: true
type: string
Workplaces:
description: (default = [])
nullable: true
type: array
items: {}
required:
- Id
- LimosaNumber
description: (default = null)
nullable: true
type: object
examples:
response:
value:
Data:
Id: 00000000-0000-0000-0000-000000000000
LimosaNumber: 11223344556677888
IsDefault: false
EndDate: 2020-10-30T00:00:00+01:00
Workplaces:
- Id: 00000000-0000-0000-0000-000000000000
DUC: 1Y100001AB1CD
Code: "012345"
Name: GeoDynamics
"400":
description: BadRequest
headers: {}
content:
application/json:
schema:
type: object
properties:
Entity:
type: object
properties:
Id:
type: string
LimosaNumber:
type: number
IsDefault:
type: boolean
description: (default = false)
EndDate:
description: (default = null)
nullable: true
type: string
Workplaces:
description: (default = [])
nullable: true
type: array
items: {}
required:
- Id
- LimosaNumber
ValidationResult:
type: array
items: {}
required:
- Entity
- ValidationResult
examples:
response:
value:
Entity:
Id: 00000000-0000-0000-0000-000000000000
LimosaNumber: 11223344556677888
IsDefault: false
EndDate: 2020-10-30T00:00:00+01:00
Workplaces:
- Id: 00000000-0000-0000-0000-000000000000
DUC: 1Y100001AB1CD
Code: "012345"
Name: GeoDynamics
ValidationResult:
- Message: ""
SourceMemberNames: []
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Update Limosa
operationId: Update Limosa
description: |-
Updates a Limosa linked to a person by number.
*Privilege required: `Api: Check In At Work`*
x-resource: Person - Limosas
tags:
- Check In At Work
parameters:
- name: personId
in: path
description: ""
required: true
example: 00000000-0000-0000-0000-000000000000
schema:
type: string
requestBody:
$ref: "#/components/requestBodies/Create_LimosaBody"
security:
- pat: []
"/api/v3/person/{personId}/defaultlimosa":
get:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Data:
properties:
Id:
type: string
LimosaNumber:
type: number
IsDefault:
type: boolean
description: (default = false)
EndDate:
description: (default = null)
nullable: true
type: string
Workplaces:
description: (default = [])
nullable: true
type: array
items: {}
required:
- Id
- LimosaNumber
description: (default = null)
nullable: true
type: object
examples:
response:
value:
Data:
Id: 00000000-0000-0000-0000-000000000000
LimosaNumber: 11223344556677888
IsDefault: false
EndDate: 2020-10-30T00:00:00+01:00
Workplaces:
- Id: 00000000-0000-0000-0000-000000000000
DUC: 1Y100001AB1CD
Code: "012345"
Name: GeoDynamics
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"404":
description: NotFound
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Get default Limosa
operationId: Get default Limosa
description: |-
Returns the default Limosa of a person.
*Privilege required: `Api: Check In At Work`*
x-resource: Person - Default Limosa
tags:
- Check In At Work
parameters:
- name: personId
in: path
description: ""
required: true
example: 00000000-0000-0000-0000-000000000000
schema:
type: string
security:
- pat: []
"/api/v3/person/{personId}/defaultlimosa/{limosaNumber}":
post:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Data:
properties:
Id:
type: string
LimosaNumber:
type: number
IsDefault:
type: boolean
description: (default = false)
EndDate:
description: (default = null)
nullable: true
type: string
Workplaces:
description: (default = [])
nullable: true
type: array
items: {}
required:
- Id
- LimosaNumber
description: (default = null)
nullable: true
type: object
examples:
response:
value:
Data:
Id: 00000000-0000-0000-0000-000000000000
LimosaNumber: 11223344556677888
IsDefault: false
EndDate: 2020-10-30T00:00:00+01:00
Workplaces:
- Id: 00000000-0000-0000-0000-000000000000
DUC: 1Y100001AB1CD
Code: "012345"
Name: GeoDynamics
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Update default Limosa
operationId: Update default Limosa
description: |-
Updates the default Limosa for a person.
*Privilege required: `Api: Check In At Work`*
x-resource: Person - Default Limosa
tags:
- Check In At Work
parameters:
- name: personId
in: path
description: ""
required: true
example: 00000000-0000-0000-0000-000000000000
schema:
type: string
- name: limosaNumber
in: path
description: ""
required: true
example: "11223344556677889"
schema:
type: number
security:
- pat: []
"/api/v3/person/{personId}/limosa/{limosaNumber}/workplace":
put:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Data:
properties:
Id:
type: string
LimosaNumber:
type: number
IsDefault:
type: boolean
description: (default = false)
EndDate:
description: (default = null)
nullable: true
type: string
Workplaces:
description: (default = [])
nullable: true
type: array
items: {}
required:
- Id
- LimosaNumber
description: (default = null)
nullable: true
type: object
examples:
response:
value:
Data:
Id: 00000000-0000-0000-0000-000000000000
LimosaNumber: 11223344556677888
IsDefault: false
EndDate: 2020-10-30T00:00:00+01:00
Workplaces:
- Id: 00000000-0000-0000-0000-000000000000
DUC: 1Y100001AB1CD
Code: "012345"
Name: GeoDynamics
"400":
description: BadRequest
headers: {}
content:
application/json:
schema:
type: object
properties:
Entity:
type: object
properties:
Id:
type: string
LimosaNumber:
type: number
IsDefault:
type: boolean
description: (default = false)
EndDate:
description: (default = null)
nullable: true
type: string
Workplaces:
description: (default = [])
nullable: true
type: array
items: {}
required:
- Id
- LimosaNumber
ValidationResult:
type: array
items: {}
required:
- Entity
- ValidationResult
examples:
response:
value:
Entity:
Id: 00000000-0000-0000-0000-000000000000
LimosaNumber: 11223344556677888
IsDefault: false
EndDate: 2020-10-30T00:00:00+01:00
Workplaces:
- Id: 00000000-0000-0000-0000-000000000000
DUC: 1Y100001AB1CD
Code: "012345"
Name: GeoDynamics
ValidationResult:
- Message: ""
SourceMemberNames: []
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Link workplaces to Limosa
operationId: Link workplaces to Limosa
description: |-
Links one or more workplaces to a Limosa.
*Privilege required: `Api: Check In At Work`*
x-resource: Person - Limosa workplaces
tags:
- Check In At Work
parameters:
- name: personId
in: path
description: ""
required: true
example: 00000000-0000-0000-0000-000000000000
schema:
type: string
- name: limosaNumber
in: path
description: ""
required: true
example: "11223344556677889"
schema:
type: number
requestBody:
$ref: "#/components/requestBodies/Link_workplaces_to_LimosaBody"
security:
- pat: []
"/api/v3/person/{personId}/limosa/{limosaNumber}/workplace/delete":
post:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Data:
properties:
Id:
type: string
LimosaNumber:
type: number
IsDefault:
type: boolean
description: (default = false)
EndDate:
description: (default = null)
nullable: true
type: string
Workplaces:
description: (default = [])
nullable: true
type: array
items: {}
required:
- Id
- LimosaNumber
description: (default = null)
nullable: true
type: object
examples:
response:
value:
Data:
Id: 00000000-0000-0000-0000-000000000000
LimosaNumber: 11223344556677888
IsDefault: false
EndDate: 2020-10-30T00:00:00+01:00
Workplaces:
- Id: 00000000-0000-0000-0000-000000000000
DUC: 1Y100001AB1CD
Code: "012345"
Name: GeoDynamics
"400":
description: BadRequest
headers: {}
content:
application/json:
schema:
type: object
properties:
Entity:
type: object
properties:
Id:
type: string
LimosaNumber:
type: number
IsDefault:
type: boolean
description: (default = false)
EndDate:
description: (default = null)
nullable: true
type: string
Workplaces:
description: (default = [])
nullable: true
type: array
items: {}
required:
- Id
- LimosaNumber
ValidationResult:
type: array
items: {}
required:
- Entity
- ValidationResult
examples:
response:
value:
Entity:
Id: 00000000-0000-0000-0000-000000000000
LimosaNumber: 11223344556677888
IsDefault: false
EndDate: 2020-10-30T00:00:00+01:00
Workplaces:
- Id: 00000000-0000-0000-0000-000000000000
DUC: 1Y100001AB1CD
Code: "012345"
Name: GeoDynamics
ValidationResult:
- Message: ""
SourceMemberNames: []
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Unlink workplaces from Limosa
operationId: Unlink workplaces from Limosa
description: |-
Unlinks one or more workplaces from a Limosa.
*Privilege required: `Api: Check In At Work`*
x-resource: Person - Limosa workplaces
tags:
- Check In At Work
parameters:
- name: personId
in: path
description: ""
required: true
example: 00000000-0000-0000-0000-000000000000
schema:
type: string
- name: limosaNumber
in: path
description: ""
required: true
example: "11223344556677889"
schema:
type: number
requestBody:
$ref: "#/components/requestBodies/Link_workplaces_to_LimosaBody"
security:
- pat: []
"/api/v2/person/{id}/limosa":
post:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Data:
properties:
Id:
type: string
ShortCode:
type: number
Code:
description: (default = null)
nullable: true
type: string
Type:
type: number
x-enum-type: IntelliTracer.ApiV2.PersonType
enum:
- 0
- 1
description: (default = 0)
RRNNumber:
type: number
description: (default = null)
FormattedRRNNumber:
description: (default = null)
nullable: true
type: string
LimosaNumber:
type: number
description: (default = null)
BTW:
properties:
Id:
type: string
Number:
type: string
Name:
type: string
Country:
type: number
x-enum-type: IntelliTracer.Domain.Country
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
- 47
- 48
- 49
- 50
- 51
- 52
- 53
- 54
- 55
- 56
- 57
- 58
- 59
- 60
- 61
- 62
- 63
- 64
- 65
- 66
- 67
- 68
- 69
- 70
- 71
- 72
- 73
- 74
- 75
- 76
- 77
- 78
- 79
- 80
- 81
- 82
- 83
- 84
- 85
- 86
- 87
- 88
- 89
- 90
- 91
- 92
- 93
- 94
- 95
- 96
- 97
- 98
- 99
- 100
- 101
- 102
- 103
- 104
- 105
- 106
- 107
- 108
- 109
- 110
- 111
- 112
- 113
- 114
- 115
- 116
- 117
- 118
- 119
- 120
- 121
- 122
- 123
- 124
- 125
- 126
- 127
- 128
- 129
- 130
- 131
- 132
- 133
- 134
- 135
- 136
- 137
- 138
- 139
- 140
- 141
- 142
- 143
- 144
- 145
- 146
- 147
- 148
- 149
- 150
- 151
- 152
- 153
- 9999
description: (default = 0)
CountryCode:
type: string
FormattedBTWNumber:
type: string
required:
- Id
- Number
- Name
- Country
- CountryCode
- FormattedBTWNumber
description: (default = null)
nullable: true
type: object
Notes:
description: (default = null)
nullable: true
type: string
Badges:
description: (default = [])
nullable: true
type: array
items: {}
FeedbackGSM:
properties:
Id:
type: string
Number:
type: string
required:
- Id
- Number
description: (default = null)
nullable: true
type: object
RegisterGSM:
properties:
Id:
type: string
Number:
type: string
required:
- Id
- Number
description: (default = null)
nullable: true
type: object
LimosaEndDate:
description: (default = null)
nullable: true
type: string
CreationTimeStamp:
description: (default = null)
nullable: true
type: string
BirthDate:
description: (default = null)
nullable: true
type: string
ReceiveFeedback:
type: boolean
description: (default = false)
ApproveRegistration:
type: boolean
description: (default = false)
User:
properties:
Id:
type: string
Code:
description: (default = null)
nullable: true
type: string
Name:
type: string
Type:
type: number
x-enum-type: IntelliTracer.Domain.ResourceType
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
description: (default = 0)
required:
- Id
- Name
description: (default = null)
nullable: true
type: object
BadgeTimeStamp:
description: "(default = null) "
nullable: true
type: string
Inactive:
type: boolean
description: (default = false)
InactivityTimestamp:
description: (default = null)
nullable: true
type: string
A1ExpirationDate:
description: (default = null)
nullable: true
type: string
VisaExpirationDate:
description: (default = null)
nullable: true
type: string
Limosas:
description: (default = null)
nullable: true
type: array
items: {}
QrUrl:
description: (default = null)
nullable: true
type: string
Info:
type: string
LimosaStartDate:
description: (default = null)
nullable: true
type: string
BISNumber:
type: number
description: (default = null)
FormattedBISNumber:
description: (default = null)
nullable: true
type: string
required:
- Id
- ShortCode
- Type
description: (default = null)
nullable: true
type: object
examples:
response:
value:
Data:
Id: 00000000-0000-0000-0000-000000000000
ShortCode: 123456789
Code: "12345"
Type: 0
RRNNumber: 79040205768
FormattedRRNNumber: 79.04.02-057.68
LimosaNumber: 11223344556677888
BTW:
Id: 00000000-0000-0000-0000-000000000000
Number: "123456789"
Name: GeoDynamics
Country: 0
CountryCode: BE
FormattedBTWNumber: BE-123456789
Notes: John Doe
Badges:
- Id: 00000000-0000-0000-0000-000000000000
Number: 00BB4E6F
Type: 0
ExternalNumber: 00BB4E6F
FeedbackGSM:
Id: 00000000-0000-0000-0000-000000000000
Number: "+32478123456"
RegisterGSM:
Id: 00000000-0000-0000-0000-000000000000
Number: "+32478123456"
LimosaEndDate: 2019-01-25T08:00:00+02:00
CreationTimeStamp: 2019-01-25T08:00:00+02:00
BirthDate: 2019-01-25
ReceiveFeedback: false
ApproveRegistration: false
User:
Id: 00000000-0000-0000-0000-000000000000
Code: "012345"
Name: John Doe
Type: 0
BadgeTimeStamp: 2019-01-25T08:00:00+02:00
Inactive: false
InactivityTimestamp: 2019-01-25T08:00:00+02:00
A1ExpirationDate: 2019-01-25T08:00:00+02:00
VisaExpirationDate: 2019-01-25T08:00:00+02:00
Limosas:
- Id: 00000000-0000-0000-0000-000000000000
LimosaNumber: 11223344556677888
IsDefault: false
EndDate: 2020-10-30T00:00:00+01:00
Workplaces:
- Id: 00000000-0000-0000-0000-000000000000
DUC: ""
Code: "012345"
Name: GeoDynamics
QrUrl: https://api.intellitracer.be/qrcode.pdf
Info: Person info
LimosaStartDate: 2019-01-25T08:00:00
BISNumber: 79040205768
FormattedBISNumber: 79.04.02-057.68
"400":
description: BadRequest
headers: {}
content:
application/json:
schema:
type: array
items: {}
examples:
response:
value:
- Property: Name
Message: Required
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"404":
description: NotFound
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Update Limosa
operationId: Update Limosa v2
description: |-
Updates the limosa of a person.
*Privilege required: `Api: Check In At Work`*
x-resource: Person - Limosa
tags:
- Check In At Work
parameters:
- name: id
in: path
description: ""
required: true
example: 00000000-0000-0000-0000-000000000000
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
properties:
LimosaNumber:
type: number
description: (default = 0)
ExpirationDate:
description: (default = null)
nullable: true
type: string
StartDate:
description: (default = null)
nullable: true
type: string
required:
- LimosaNumber
- ExpirationDate
- StartDate
example:
LimosaNumber: 11223344556677888
ExpirationDate: 2019-01-25T08:00:00+02:00
StartDate: 2019-01-25T08:00:00+02:00
security:
- pat: []
"/api/v2/person/{id}/btw":
post:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Data:
properties:
Id:
type: string
ShortCode:
type: number
Code:
description: (default = null)
nullable: true
type: string
Type:
type: number
x-enum-type: IntelliTracer.ApiV2.PersonType
enum:
- 0
- 1
description: (default = 0)
RRNNumber:
type: number
description: (default = null)
FormattedRRNNumber:
description: (default = null)
nullable: true
type: string
LimosaNumber:
type: number
description: (default = null)
BTW:
properties:
Id:
type: string
Number:
type: string
Name:
type: string
Country:
type: number
x-enum-type: IntelliTracer.Domain.Country
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
- 47
- 48
- 49
- 50
- 51
- 52
- 53
- 54
- 55
- 56
- 57
- 58
- 59
- 60
- 61
- 62
- 63
- 64
- 65
- 66
- 67
- 68
- 69
- 70
- 71
- 72
- 73
- 74
- 75
- 76
- 77
- 78
- 79
- 80
- 81
- 82
- 83
- 84
- 85
- 86
- 87
- 88
- 89
- 90
- 91
- 92
- 93
- 94
- 95
- 96
- 97
- 98
- 99
- 100
- 101
- 102
- 103
- 104
- 105
- 106
- 107
- 108
- 109
- 110
- 111
- 112
- 113
- 114
- 115
- 116
- 117
- 118
- 119
- 120
- 121
- 122
- 123
- 124
- 125
- 126
- 127
- 128
- 129
- 130
- 131
- 132
- 133
- 134
- 135
- 136
- 137
- 138
- 139
- 140
- 141
- 142
- 143
- 144
- 145
- 146
- 147
- 148
- 149
- 150
- 151
- 152
- 153
- 9999
description: (default = 0)
CountryCode:
type: string
FormattedBTWNumber:
type: string
required:
- Id
- Number
- Name
- Country
- CountryCode
- FormattedBTWNumber
description: (default = null)
nullable: true
type: object
Notes:
description: (default = null)
nullable: true
type: string
Badges:
description: (default = [])
nullable: true
type: array
items: {}
FeedbackGSM:
properties:
Id:
type: string
Number:
type: string
required:
- Id
- Number
description: (default = null)
nullable: true
type: object
RegisterGSM:
properties:
Id:
type: string
Number:
type: string
required:
- Id
- Number
description: (default = null)
nullable: true
type: object
LimosaEndDate:
description: (default = null)
nullable: true
type: string
CreationTimeStamp:
description: (default = null)
nullable: true
type: string
BirthDate:
description: (default = null)
nullable: true
type: string
ReceiveFeedback:
type: boolean
description: (default = false)
ApproveRegistration:
type: boolean
description: (default = false)
User:
properties:
Id:
type: string
Code:
description: (default = null)
nullable: true
type: string
Name:
type: string
Type:
type: number
x-enum-type: IntelliTracer.Domain.ResourceType
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
description: (default = 0)
required:
- Id
- Name
description: (default = null)
nullable: true
type: object
BadgeTimeStamp:
description: "(default = null) "
nullable: true
type: string
Inactive:
type: boolean
description: (default = false)
InactivityTimestamp:
description: (default = null)
nullable: true
type: string
A1ExpirationDate:
description: (default = null)
nullable: true
type: string
VisaExpirationDate:
description: (default = null)
nullable: true
type: string
Limosas:
description: (default = null)
nullable: true
type: array
items: {}
QrUrl:
description: (default = null)
nullable: true
type: string
Info:
type: string
LimosaStartDate:
description: (default = null)
nullable: true
type: string
BISNumber:
type: number
description: (default = null)
FormattedBISNumber:
description: (default = null)
nullable: true
type: string
required:
- Id
- ShortCode
- Type
description: (default = null)
nullable: true
type: object
examples:
response:
value:
Data:
Id: 00000000-0000-0000-0000-000000000000
ShortCode: 123456789
Code: "12345"
Type: 0
RRNNumber: 79040205768
FormattedRRNNumber: 79.04.02-057.68
LimosaNumber: 11223344556677888
BTW:
Id: 00000000-0000-0000-0000-000000000000
Number: "123456789"
Name: GeoDynamics
Country: 0
CountryCode: BE
FormattedBTWNumber: BE-123456789
Notes: John Doe
Badges:
- Id: 00000000-0000-0000-0000-000000000000
Number: 00BB4E6F
Type: 0
ExternalNumber: 00BB4E6F
FeedbackGSM:
Id: 00000000-0000-0000-0000-000000000000
Number: "+32478123456"
RegisterGSM:
Id: 00000000-0000-0000-0000-000000000000
Number: "+32478123456"
LimosaEndDate: 2019-01-25T08:00:00+02:00
CreationTimeStamp: 2019-01-25T08:00:00+02:00
BirthDate: 2019-01-25
ReceiveFeedback: false
ApproveRegistration: false
User:
Id: 00000000-0000-0000-0000-000000000000
Code: "012345"
Name: John Doe
Type: 0
BadgeTimeStamp: 2019-01-25T08:00:00+02:00
Inactive: false
InactivityTimestamp: 2019-01-25T08:00:00+02:00
A1ExpirationDate: 2019-01-25T08:00:00+02:00
VisaExpirationDate: 2019-01-25T08:00:00+02:00
Limosas:
- Id: 00000000-0000-0000-0000-000000000000
LimosaNumber: 11223344556677888
IsDefault: false
EndDate: 2020-10-30T00:00:00+01:00
Workplaces:
- Id: 00000000-0000-0000-0000-000000000000
DUC: ""
Code: "012345"
Name: GeoDynamics
QrUrl: https://api.intellitracer.be/qrcode.pdf
Info: Person info
LimosaStartDate: 2019-01-25T08:00:00
BISNumber: 79040205768
FormattedBISNumber: 79.04.02-057.68
"400":
description: BadRequest
headers: {}
content:
application/json:
schema:
type: array
items: {}
examples:
response:
value:
- Property: Name
Message: Required
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"404":
description: NotFound
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Update BTW
operationId: Update BTW
description: |-
Updates the BTW number of a person.
*Privilege required: `Api: Check In At Work`*
x-resource: Person - BTW
tags:
- Check In At Work
parameters:
- name: id
in: path
description: ""
required: true
example: 00000000-0000-0000-0000-000000000000
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
properties:
BtwNumber:
type: string
required:
- BtwNumber
example:
BtwNumber: BE-0000000000
security:
- pat: []
"/api/v2/person/{id}/activity":
post:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Data:
properties:
Id:
type: string
ShortCode:
type: number
Code:
description: (default = null)
nullable: true
type: string
Type:
type: number
x-enum-type: IntelliTracer.ApiV2.PersonType
enum:
- 0
- 1
description: (default = 0)
RRNNumber:
type: number
description: (default = null)
FormattedRRNNumber:
description: (default = null)
nullable: true
type: string
LimosaNumber:
type: number
description: (default = null)
BTW:
properties:
Id:
type: string
Number:
type: string
Name:
type: string
Country:
type: number
x-enum-type: IntelliTracer.Domain.Country
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
- 47
- 48
- 49
- 50
- 51
- 52
- 53
- 54
- 55
- 56
- 57
- 58
- 59
- 60
- 61
- 62
- 63
- 64
- 65
- 66
- 67
- 68
- 69
- 70
- 71
- 72
- 73
- 74
- 75
- 76
- 77
- 78
- 79
- 80
- 81
- 82
- 83
- 84
- 85
- 86
- 87
- 88
- 89
- 90
- 91
- 92
- 93
- 94
- 95
- 96
- 97
- 98
- 99
- 100
- 101
- 102
- 103
- 104
- 105
- 106
- 107
- 108
- 109
- 110
- 111
- 112
- 113
- 114
- 115
- 116
- 117
- 118
- 119
- 120
- 121
- 122
- 123
- 124
- 125
- 126
- 127
- 128
- 129
- 130
- 131
- 132
- 133
- 134
- 135
- 136
- 137
- 138
- 139
- 140
- 141
- 142
- 143
- 144
- 145
- 146
- 147
- 148
- 149
- 150
- 151
- 152
- 153
- 9999
description: (default = 0)
CountryCode:
type: string
FormattedBTWNumber:
type: string
required:
- Id
- Number
- Name
- Country
- CountryCode
- FormattedBTWNumber
description: (default = null)
nullable: true
type: object
Notes:
description: (default = null)
nullable: true
type: string
Badges:
description: (default = [])
nullable: true
type: array
items: {}
FeedbackGSM:
properties:
Id:
type: string
Number:
type: string
required:
- Id
- Number
description: (default = null)
nullable: true
type: object
RegisterGSM:
properties:
Id:
type: string
Number:
type: string
required:
- Id
- Number
description: (default = null)
nullable: true
type: object
LimosaEndDate:
description: (default = null)
nullable: true
type: string
CreationTimeStamp:
description: (default = null)
nullable: true
type: string
BirthDate:
description: (default = null)
nullable: true
type: string
ReceiveFeedback:
type: boolean
description: (default = false)
ApproveRegistration:
type: boolean
description: (default = false)
User:
properties:
Id:
type: string
Code:
description: (default = null)
nullable: true
type: string
Name:
type: string
Type:
type: number
x-enum-type: IntelliTracer.Domain.ResourceType
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
description: (default = 0)
required:
- Id
- Name
description: (default = null)
nullable: true
type: object
BadgeTimeStamp:
description: "(default = null) "
nullable: true
type: string
Inactive:
type: boolean
description: (default = false)
InactivityTimestamp:
description: (default = null)
nullable: true
type: string
A1ExpirationDate:
description: (default = null)
nullable: true
type: string
VisaExpirationDate:
description: (default = null)
nullable: true
type: string
Limosas:
description: (default = null)
nullable: true
type: array
items: {}
QrUrl:
description: (default = null)
nullable: true
type: string
Info:
type: string
LimosaStartDate:
description: (default = null)
nullable: true
type: string
BISNumber:
type: number
description: (default = null)
FormattedBISNumber:
description: (default = null)
nullable: true
type: string
required:
- Id
- ShortCode
- Type
description: (default = null)
nullable: true
type: object
examples:
response:
value:
Data:
Id: 00000000-0000-0000-0000-000000000000
ShortCode: 123456789
Code: "12345"
Type: 0
RRNNumber: 79040205768
FormattedRRNNumber: 79.04.02-057.68
LimosaNumber: 11223344556677888
BTW:
Id: 00000000-0000-0000-0000-000000000000
Number: "123456789"
Name: GeoDynamics
Country: 0
CountryCode: BE
FormattedBTWNumber: BE-123456789
Notes: John Doe
Badges:
- Id: 00000000-0000-0000-0000-000000000000
Number: 00BB4E6F
Type: 0
ExternalNumber: 00BB4E6F
FeedbackGSM:
Id: 00000000-0000-0000-0000-000000000000
Number: "+32478123456"
RegisterGSM:
Id: 00000000-0000-0000-0000-000000000000
Number: "+32478123456"
LimosaEndDate: 2019-01-25T08:00:00+02:00
CreationTimeStamp: 2019-01-25T08:00:00+02:00
BirthDate: 2019-01-25
ReceiveFeedback: false
ApproveRegistration: false
User:
Id: 00000000-0000-0000-0000-000000000000
Code: "012345"
Name: John Doe
Type: 0
BadgeTimeStamp: 2019-01-25T08:00:00+02:00
Inactive: false
InactivityTimestamp: 2019-01-25T08:00:00+02:00
A1ExpirationDate: 2019-01-25T08:00:00+02:00
VisaExpirationDate: 2019-01-25T08:00:00+02:00
Limosas:
- Id: 00000000-0000-0000-0000-000000000000
LimosaNumber: 11223344556677888
IsDefault: false
EndDate: 2020-10-30T00:00:00+01:00
Workplaces:
- Id: 00000000-0000-0000-0000-000000000000
DUC: ""
Code: "012345"
Name: GeoDynamics
QrUrl: https://api.intellitracer.be/qrcode.pdf
Info: Person info
LimosaStartDate: 2019-01-25T08:00:00
BISNumber: 79040205768
FormattedBISNumber: 79.04.02-057.68
"400":
description: BadRequest
headers: {}
content:
application/json:
schema:
type: array
items: {}
examples:
response:
value:
- Property: Name
Message: Required
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"404":
description: NotFound
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Update activity
operationId: Update activity
description: |-
Updates whether a person is currently active or not.
*Privilege required: `Api: Check In At Work`*
x-resource: Person - Activity
tags:
- Check In At Work
parameters:
- name: id
in: path
description: ""
required: true
example: 00000000-0000-0000-0000-000000000000
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
properties:
Inactive:
type: boolean
required:
- Inactive
example:
Inactive: false
security:
- pat: []
"/api/v2/person/{id}/byrrnbtw":
post:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Data:
properties:
Id:
type: string
ShortCode:
type: number
Code:
description: (default = null)
nullable: true
type: string
Type:
type: number
x-enum-type: IntelliTracer.ApiV2.PersonType
enum:
- 0
- 1
description: (default = 0)
RRNNumber:
type: number
description: (default = null)
FormattedRRNNumber:
description: (default = null)
nullable: true
type: string
LimosaNumber:
type: number
description: (default = null)
BTW:
properties:
Id:
type: string
Number:
type: string
Name:
type: string
Country:
type: number
x-enum-type: IntelliTracer.Domain.Country
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
- 47
- 48
- 49
- 50
- 51
- 52
- 53
- 54
- 55
- 56
- 57
- 58
- 59
- 60
- 61
- 62
- 63
- 64
- 65
- 66
- 67
- 68
- 69
- 70
- 71
- 72
- 73
- 74
- 75
- 76
- 77
- 78
- 79
- 80
- 81
- 82
- 83
- 84
- 85
- 86
- 87
- 88
- 89
- 90
- 91
- 92
- 93
- 94
- 95
- 96
- 97
- 98
- 99
- 100
- 101
- 102
- 103
- 104
- 105
- 106
- 107
- 108
- 109
- 110
- 111
- 112
- 113
- 114
- 115
- 116
- 117
- 118
- 119
- 120
- 121
- 122
- 123
- 124
- 125
- 126
- 127
- 128
- 129
- 130
- 131
- 132
- 133
- 134
- 135
- 136
- 137
- 138
- 139
- 140
- 141
- 142
- 143
- 144
- 145
- 146
- 147
- 148
- 149
- 150
- 151
- 152
- 153
- 9999
description: (default = 0)
CountryCode:
type: string
FormattedBTWNumber:
type: string
required:
- Id
- Number
- Name
- Country
- CountryCode
- FormattedBTWNumber
description: (default = null)
nullable: true
type: object
Notes:
description: (default = null)
nullable: true
type: string
Badges:
description: (default = [])
nullable: true
type: array
items: {}
FeedbackGSM:
properties:
Id:
type: string
Number:
type: string
required:
- Id
- Number
description: (default = null)
nullable: true
type: object
RegisterGSM:
properties:
Id:
type: string
Number:
type: string
required:
- Id
- Number
description: (default = null)
nullable: true
type: object
LimosaEndDate:
description: (default = null)
nullable: true
type: string
CreationTimeStamp:
description: (default = null)
nullable: true
type: string
BirthDate:
description: (default = null)
nullable: true
type: string
ReceiveFeedback:
type: boolean
description: (default = false)
ApproveRegistration:
type: boolean
description: (default = false)
User:
properties:
Id:
type: string
Code:
description: (default = null)
nullable: true
type: string
Name:
type: string
Type:
type: number
x-enum-type: IntelliTracer.Domain.ResourceType
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
description: (default = 0)
required:
- Id
- Name
description: (default = null)
nullable: true
type: object
BadgeTimeStamp:
description: "(default = null) "
nullable: true
type: string
Inactive:
type: boolean
description: (default = false)
InactivityTimestamp:
description: (default = null)
nullable: true
type: string
A1ExpirationDate:
description: (default = null)
nullable: true
type: string
VisaExpirationDate:
description: (default = null)
nullable: true
type: string
Limosas:
description: (default = null)
nullable: true
type: array
items: {}
QrUrl:
description: (default = null)
nullable: true
type: string
Info:
type: string
LimosaStartDate:
description: (default = null)
nullable: true
type: string
BISNumber:
type: number
description: (default = null)
FormattedBISNumber:
description: (default = null)
nullable: true
type: string
required:
- Id
- ShortCode
- Type
description: (default = null)
nullable: true
type: object
examples:
response:
value:
Data:
Id: 00000000-0000-0000-0000-000000000000
ShortCode: 123456789
Code: "12345"
Type: 0
RRNNumber: 79040205768
FormattedRRNNumber: 79.04.02-057.68
LimosaNumber: 11223344556677888
BTW:
Id: 00000000-0000-0000-0000-000000000000
Number: "123456789"
Name: GeoDynamics
Country: 0
CountryCode: BE
FormattedBTWNumber: BE-123456789
Notes: John Doe
Badges:
- Id: 00000000-0000-0000-0000-000000000000
Number: 00BB4E6F
Type: 0
ExternalNumber: 00BB4E6F
FeedbackGSM:
Id: 00000000-0000-0000-0000-000000000000
Number: "+32478123456"
RegisterGSM:
Id: 00000000-0000-0000-0000-000000000000
Number: "+32478123456"
LimosaEndDate: 2019-01-25T08:00:00+02:00
CreationTimeStamp: 2019-01-25T08:00:00+02:00
BirthDate: 2019-01-25
ReceiveFeedback: false
ApproveRegistration: false
User:
Id: 00000000-0000-0000-0000-000000000000
Code: "012345"
Name: John Doe
Type: 0
BadgeTimeStamp: 2019-01-25T08:00:00+02:00
Inactive: false
InactivityTimestamp: 2019-01-25T08:00:00+02:00
A1ExpirationDate: 2019-01-25T08:00:00+02:00
VisaExpirationDate: 2019-01-25T08:00:00+02:00
Limosas:
- Id: 00000000-0000-0000-0000-000000000000
LimosaNumber: 11223344556677888
IsDefault: false
EndDate: 2020-10-30T00:00:00+01:00
Workplaces:
- Id: 00000000-0000-0000-0000-000000000000
DUC: ""
Code: "012345"
Name: GeoDynamics
QrUrl: https://api.intellitracer.be/qrcode.pdf
Info: Person info
LimosaStartDate: 2019-01-25T08:00:00
BISNumber: 79040205768
FormattedBISNumber: 79.04.02-057.68
"400":
description: BadRequest
headers: {}
content:
application/json:
schema:
type: array
items: {}
examples:
response:
value:
- Property: Name
Message: Required
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"404":
description: NotFound
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Update RRN and BTW
operationId: Update RRN and BTW
description: |-
Updates RRN and BTW of a person.
*Privilege required: `Api: Check In At Work`*
x-resource: Person - RRN and BTW
tags:
- Check In At Work
parameters:
- name: id
in: path
description: ""
required: true
example: 00000000-0000-0000-0000-000000000000
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
properties:
Btw:
type: string
INSZ:
type: string
required:
- Btw
- INSZ
example:
Btw: BE-0000000000
INSZ: "79040205768"
security:
- pat: []
"/api/v2/person/{id}/badge":
post:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Data:
properties:
Id:
type: string
ShortCode:
type: number
Code:
description: (default = null)
nullable: true
type: string
Type:
type: number
x-enum-type: IntelliTracer.ApiV2.PersonType
enum:
- 0
- 1
description: (default = 0)
RRNNumber:
type: number
description: (default = null)
FormattedRRNNumber:
description: (default = null)
nullable: true
type: string
LimosaNumber:
type: number
description: (default = null)
BTW:
properties:
Id:
type: string
Number:
type: string
Name:
type: string
Country:
type: number
x-enum-type: IntelliTracer.Domain.Country
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
- 47
- 48
- 49
- 50
- 51
- 52
- 53
- 54
- 55
- 56
- 57
- 58
- 59
- 60
- 61
- 62
- 63
- 64
- 65
- 66
- 67
- 68
- 69
- 70
- 71
- 72
- 73
- 74
- 75
- 76
- 77
- 78
- 79
- 80
- 81
- 82
- 83
- 84
- 85
- 86
- 87
- 88
- 89
- 90
- 91
- 92
- 93
- 94
- 95
- 96
- 97
- 98
- 99
- 100
- 101
- 102
- 103
- 104
- 105
- 106
- 107
- 108
- 109
- 110
- 111
- 112
- 113
- 114
- 115
- 116
- 117
- 118
- 119
- 120
- 121
- 122
- 123
- 124
- 125
- 126
- 127
- 128
- 129
- 130
- 131
- 132
- 133
- 134
- 135
- 136
- 137
- 138
- 139
- 140
- 141
- 142
- 143
- 144
- 145
- 146
- 147
- 148
- 149
- 150
- 151
- 152
- 153
- 9999
description: (default = 0)
CountryCode:
type: string
FormattedBTWNumber:
type: string
required:
- Id
- Number
- Name
- Country
- CountryCode
- FormattedBTWNumber
description: (default = null)
nullable: true
type: object
Notes:
description: (default = null)
nullable: true
type: string
Badges:
description: (default = [])
nullable: true
type: array
items: {}
FeedbackGSM:
properties:
Id:
type: string
Number:
type: string
required:
- Id
- Number
description: (default = null)
nullable: true
type: object
RegisterGSM:
properties:
Id:
type: string
Number:
type: string
required:
- Id
- Number
description: (default = null)
nullable: true
type: object
LimosaEndDate:
description: (default = null)
nullable: true
type: string
CreationTimeStamp:
description: (default = null)
nullable: true
type: string
BirthDate:
description: (default = null)
nullable: true
type: string
ReceiveFeedback:
type: boolean
description: (default = false)
ApproveRegistration:
type: boolean
description: (default = false)
User:
properties:
Id:
type: string
Code:
description: (default = null)
nullable: true
type: string
Name:
type: string
Type:
type: number
x-enum-type: IntelliTracer.Domain.ResourceType
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
description: (default = 0)
required:
- Id
- Name
description: (default = null)
nullable: true
type: object
BadgeTimeStamp:
description: "(default = null) "
nullable: true
type: string
Inactive:
type: boolean
description: (default = false)
InactivityTimestamp:
description: (default = null)
nullable: true
type: string
A1ExpirationDate:
description: (default = null)
nullable: true
type: string
VisaExpirationDate:
description: (default = null)
nullable: true
type: string
Limosas:
description: (default = null)
nullable: true
type: array
items: {}
QrUrl:
description: (default = null)
nullable: true
type: string
Info:
type: string
LimosaStartDate:
description: (default = null)
nullable: true
type: string
BISNumber:
type: number
description: (default = null)
FormattedBISNumber:
description: (default = null)
nullable: true
type: string
required:
- Id
- ShortCode
- Type
description: (default = null)
nullable: true
type: object
examples:
response:
value:
Data:
Id: 00000000-0000-0000-0000-000000000000
ShortCode: 123456789
Code: "12345"
Type: 0
RRNNumber: 79040205768
FormattedRRNNumber: 79.04.02-057.68
LimosaNumber: 11223344556677888
BTW:
Id: 00000000-0000-0000-0000-000000000000
Number: "123456789"
Name: GeoDynamics
Country: 0
CountryCode: BE
FormattedBTWNumber: BE-123456789
Notes: John Doe
Badges:
- Id: 00000000-0000-0000-0000-000000000000
Number: 00BB4E6F
Type: 0
ExternalNumber: 00BB4E6F
FeedbackGSM:
Id: 00000000-0000-0000-0000-000000000000
Number: "+32478123456"
RegisterGSM:
Id: 00000000-0000-0000-0000-000000000000
Number: "+32478123456"
LimosaEndDate: 2019-01-25T08:00:00+02:00
CreationTimeStamp: 2019-01-25T08:00:00+02:00
BirthDate: 2019-01-25
ReceiveFeedback: false
ApproveRegistration: false
User:
Id: 00000000-0000-0000-0000-000000000000
Code: "012345"
Name: John Doe
Type: 0
BadgeTimeStamp: 2019-01-25T08:00:00+02:00
Inactive: false
InactivityTimestamp: 2019-01-25T08:00:00+02:00
A1ExpirationDate: 2019-01-25T08:00:00+02:00
VisaExpirationDate: 2019-01-25T08:00:00+02:00
Limosas:
- Id: 00000000-0000-0000-0000-000000000000
LimosaNumber: 11223344556677888
IsDefault: false
EndDate: 2020-10-30T00:00:00+01:00
Workplaces:
- Id: 00000000-0000-0000-0000-000000000000
DUC: ""
Code: "012345"
Name: GeoDynamics
QrUrl: https://api.intellitracer.be/qrcode.pdf
Info: Person info
LimosaStartDate: 2019-01-25T08:00:00
BISNumber: 79040205768
FormattedBISNumber: 79.04.02-057.68
"400":
description: BadRequest
headers: {}
content:
application/json:
schema:
type: array
items: {}
examples:
response:
value:
- Property: Name
Message: Required
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"404":
description: NotFound
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Link badge to person
operationId: Link badge to person
description: |-
Links a badge to a person. If necessary, a new badge is created.
*Privilege required: `Api: Check In At Work`*
x-resource: Person - Badges
tags:
- Check In At Work
parameters:
- name: id
in: path
description: ""
required: true
example: 00000000-0000-0000-0000-000000000000
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
properties:
BadgeNumber:
type: string
BadgeType:
type: number
x-enum-type: IntelliTracer.Domain.BadgeType
enum:
- 0
- 1
- 2
- 3
- 4
required:
- BadgeNumber
- BadgeType
example:
BadgeNumber: 00BB4E6F
BadgeType: 0
security:
- pat: []
"/api/v2/person/{id}/badge/{badgeNumber}":
delete:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Data:
properties:
Id:
type: string
ShortCode:
type: number
Code:
description: (default = null)
nullable: true
type: string
Type:
type: number
x-enum-type: IntelliTracer.ApiV2.PersonType
enum:
- 0
- 1
description: (default = 0)
RRNNumber:
type: number
description: (default = null)
FormattedRRNNumber:
description: (default = null)
nullable: true
type: string
LimosaNumber:
type: number
description: (default = null)
BTW:
properties:
Id:
type: string
Number:
type: string
Name:
type: string
Country:
type: number
x-enum-type: IntelliTracer.Domain.Country
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
- 47
- 48
- 49
- 50
- 51
- 52
- 53
- 54
- 55
- 56
- 57
- 58
- 59
- 60
- 61
- 62
- 63
- 64
- 65
- 66
- 67
- 68
- 69
- 70
- 71
- 72
- 73
- 74
- 75
- 76
- 77
- 78
- 79
- 80
- 81
- 82
- 83
- 84
- 85
- 86
- 87
- 88
- 89
- 90
- 91
- 92
- 93
- 94
- 95
- 96
- 97
- 98
- 99
- 100
- 101
- 102
- 103
- 104
- 105
- 106
- 107
- 108
- 109
- 110
- 111
- 112
- 113
- 114
- 115
- 116
- 117
- 118
- 119
- 120
- 121
- 122
- 123
- 124
- 125
- 126
- 127
- 128
- 129
- 130
- 131
- 132
- 133
- 134
- 135
- 136
- 137
- 138
- 139
- 140
- 141
- 142
- 143
- 144
- 145
- 146
- 147
- 148
- 149
- 150
- 151
- 152
- 153
- 9999
description: (default = 0)
CountryCode:
type: string
FormattedBTWNumber:
type: string
required:
- Id
- Number
- Name
- Country
- CountryCode
- FormattedBTWNumber
description: (default = null)
nullable: true
type: object
Notes:
description: (default = null)
nullable: true
type: string
Badges:
description: (default = [])
nullable: true
type: array
items: {}
FeedbackGSM:
properties:
Id:
type: string
Number:
type: string
required:
- Id
- Number
description: (default = null)
nullable: true
type: object
RegisterGSM:
properties:
Id:
type: string
Number:
type: string
required:
- Id
- Number
description: (default = null)
nullable: true
type: object
LimosaEndDate:
description: (default = null)
nullable: true
type: string
CreationTimeStamp:
description: (default = null)
nullable: true
type: string
BirthDate:
description: (default = null)
nullable: true
type: string
ReceiveFeedback:
type: boolean
description: (default = false)
ApproveRegistration:
type: boolean
description: (default = false)
User:
properties:
Id:
type: string
Code:
description: (default = null)
nullable: true
type: string
Name:
type: string
Type:
type: number
x-enum-type: IntelliTracer.Domain.ResourceType
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
description: (default = 0)
required:
- Id
- Name
description: (default = null)
nullable: true
type: object
BadgeTimeStamp:
description: "(default = null) "
nullable: true
type: string
Inactive:
type: boolean
description: (default = false)
InactivityTimestamp:
description: (default = null)
nullable: true
type: string
A1ExpirationDate:
description: (default = null)
nullable: true
type: string
VisaExpirationDate:
description: (default = null)
nullable: true
type: string
Limosas:
description: (default = null)
nullable: true
type: array
items: {}
QrUrl:
description: (default = null)
nullable: true
type: string
Info:
type: string
LimosaStartDate:
description: (default = null)
nullable: true
type: string
BISNumber:
type: number
description: (default = null)
FormattedBISNumber:
description: (default = null)
nullable: true
type: string
required:
- Id
- ShortCode
- Type
description: (default = null)
nullable: true
type: object
examples:
response:
value:
Data:
Id: 00000000-0000-0000-0000-000000000000
ShortCode: 123456789
Code: "12345"
Type: 0
RRNNumber: 79040205768
FormattedRRNNumber: 79.04.02-057.68
LimosaNumber: 11223344556677888
BTW:
Id: 00000000-0000-0000-0000-000000000000
Number: "123456789"
Name: GeoDynamics
Country: 0
CountryCode: BE
FormattedBTWNumber: BE-123456789
Notes: John Doe
Badges:
- Id: 00000000-0000-0000-0000-000000000000
Number: 00BB4E6F
Type: 0
ExternalNumber: 00BB4E6F
FeedbackGSM:
Id: 00000000-0000-0000-0000-000000000000
Number: "+32478123456"
RegisterGSM:
Id: 00000000-0000-0000-0000-000000000000
Number: "+32478123456"
LimosaEndDate: 2019-01-25T08:00:00+02:00
CreationTimeStamp: 2019-01-25T08:00:00+02:00
BirthDate: 2019-01-25
ReceiveFeedback: false
ApproveRegistration: false
User:
Id: 00000000-0000-0000-0000-000000000000
Code: "012345"
Name: John Doe
Type: 0
BadgeTimeStamp: 2019-01-25T08:00:00+02:00
Inactive: false
InactivityTimestamp: 2019-01-25T08:00:00+02:00
A1ExpirationDate: 2019-01-25T08:00:00+02:00
VisaExpirationDate: 2019-01-25T08:00:00+02:00
Limosas:
- Id: 00000000-0000-0000-0000-000000000000
LimosaNumber: 11223344556677888
IsDefault: false
EndDate: 2020-10-30T00:00:00+01:00
Workplaces:
- Id: 00000000-0000-0000-0000-000000000000
DUC: ""
Code: "012345"
Name: GeoDynamics
QrUrl: https://api.intellitracer.be/qrcode.pdf
Info: Person info
LimosaStartDate: 2019-01-25T08:00:00
BISNumber: 79040205768
FormattedBISNumber: 79.04.02-057.68
"400":
description: BadRequest
headers: {}
content:
application/json:
schema:
type: array
items: {}
examples:
response:
value:
- Property: Name
Message: Required
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"404":
description: NotFound
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Unlink badge from person
operationId: Unlink badge from person
description: |-
Unlinks a badge from a person.
*Privilege required: `Api: Check In At Work`*
x-resource: Person - Badges
tags:
- Check In At Work
parameters:
- name: id
in: path
description: ""
required: true
example: 00000000-0000-0000-0000-000000000000
schema:
type: string
- name: badgeNumber
in: path
description: ""
required: true
example: 00BB4E6F
schema:
type: string
security:
- pat: []
"/api/v2/person/{personId}/user":
post:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Data:
properties:
Id:
type: string
ShortCode:
type: number
Code:
description: (default = null)
nullable: true
type: string
Type:
type: number
x-enum-type: IntelliTracer.ApiV2.PersonType
enum:
- 0
- 1
description: (default = 0)
RRNNumber:
type: number
description: (default = null)
FormattedRRNNumber:
description: (default = null)
nullable: true
type: string
LimosaNumber:
type: number
description: (default = null)
BTW:
properties:
Id:
type: string
Number:
type: string
Name:
type: string
Country:
type: number
x-enum-type: IntelliTracer.Domain.Country
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
- 47
- 48
- 49
- 50
- 51
- 52
- 53
- 54
- 55
- 56
- 57
- 58
- 59
- 60
- 61
- 62
- 63
- 64
- 65
- 66
- 67
- 68
- 69
- 70
- 71
- 72
- 73
- 74
- 75
- 76
- 77
- 78
- 79
- 80
- 81
- 82
- 83
- 84
- 85
- 86
- 87
- 88
- 89
- 90
- 91
- 92
- 93
- 94
- 95
- 96
- 97
- 98
- 99
- 100
- 101
- 102
- 103
- 104
- 105
- 106
- 107
- 108
- 109
- 110
- 111
- 112
- 113
- 114
- 115
- 116
- 117
- 118
- 119
- 120
- 121
- 122
- 123
- 124
- 125
- 126
- 127
- 128
- 129
- 130
- 131
- 132
- 133
- 134
- 135
- 136
- 137
- 138
- 139
- 140
- 141
- 142
- 143
- 144
- 145
- 146
- 147
- 148
- 149
- 150
- 151
- 152
- 153
- 9999
description: (default = 0)
CountryCode:
type: string
FormattedBTWNumber:
type: string
required:
- Id
- Number
- Name
- Country
- CountryCode
- FormattedBTWNumber
description: (default = null)
nullable: true
type: object
Notes:
description: (default = null)
nullable: true
type: string
Badges:
description: (default = [])
nullable: true
type: array
items: {}
FeedbackGSM:
properties:
Id:
type: string
Number:
type: string
required:
- Id
- Number
description: (default = null)
nullable: true
type: object
RegisterGSM:
properties:
Id:
type: string
Number:
type: string
required:
- Id
- Number
description: (default = null)
nullable: true
type: object
LimosaEndDate:
description: (default = null)
nullable: true
type: string
CreationTimeStamp:
description: (default = null)
nullable: true
type: string
BirthDate:
description: (default = null)
nullable: true
type: string
ReceiveFeedback:
type: boolean
description: (default = false)
ApproveRegistration:
type: boolean
description: (default = false)
User:
properties:
Id:
type: string
Code:
description: (default = null)
nullable: true
type: string
Name:
type: string
Type:
type: number
x-enum-type: IntelliTracer.Domain.ResourceType
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
description: (default = 0)
required:
- Id
- Name
description: (default = null)
nullable: true
type: object
BadgeTimeStamp:
description: "(default = null) "
nullable: true
type: string
Inactive:
type: boolean
description: (default = false)
InactivityTimestamp:
description: (default = null)
nullable: true
type: string
A1ExpirationDate:
description: (default = null)
nullable: true
type: string
VisaExpirationDate:
description: (default = null)
nullable: true
type: string
Limosas:
description: (default = null)
nullable: true
type: array
items: {}
QrUrl:
description: (default = null)
nullable: true
type: string
Info:
type: string
LimosaStartDate:
description: (default = null)
nullable: true
type: string
BISNumber:
type: number
description: (default = null)
FormattedBISNumber:
description: (default = null)
nullable: true
type: string
required:
- Id
- ShortCode
- Type
description: (default = null)
nullable: true
type: object
examples:
response:
value:
Data:
Id: 00000000-0000-0000-0000-000000000000
ShortCode: 123456789
Code: "12345"
Type: 0
RRNNumber: 79040205768
FormattedRRNNumber: 79.04.02-057.68
LimosaNumber: 11223344556677888
BTW:
Id: 00000000-0000-0000-0000-000000000000
Number: "123456789"
Name: GeoDynamics
Country: 0
CountryCode: BE
FormattedBTWNumber: BE-123456789
Notes: John Doe
Badges:
- Id: 00000000-0000-0000-0000-000000000000
Number: 00BB4E6F
Type: 0
ExternalNumber: 00BB4E6F
FeedbackGSM:
Id: 00000000-0000-0000-0000-000000000000
Number: "+32478123456"
RegisterGSM:
Id: 00000000-0000-0000-0000-000000000000
Number: "+32478123456"
LimosaEndDate: 2019-01-25T08:00:00+02:00
CreationTimeStamp: 2019-01-25T08:00:00+02:00
BirthDate: 2019-01-25
ReceiveFeedback: false
ApproveRegistration: false
User:
Id: 00000000-0000-0000-0000-000000000000
Code: "012345"
Name: John Doe
Type: 0
BadgeTimeStamp: 2019-01-25T08:00:00+02:00
Inactive: false
InactivityTimestamp: 2019-01-25T08:00:00+02:00
A1ExpirationDate: 2019-01-25T08:00:00+02:00
VisaExpirationDate: 2019-01-25T08:00:00+02:00
Limosas:
- Id: 00000000-0000-0000-0000-000000000000
LimosaNumber: 11223344556677888
IsDefault: false
EndDate: 2020-10-30T00:00:00+01:00
Workplaces:
- Id: 00000000-0000-0000-0000-000000000000
DUC: ""
Code: "012345"
Name: GeoDynamics
QrUrl: https://api.intellitracer.be/qrcode.pdf
Info: Person info
LimosaStartDate: 2019-01-25T08:00:00
BISNumber: 79040205768
FormattedBISNumber: 79.04.02-057.68
"400":
description: BadRequest
headers: {}
content:
application/json:
schema:
type: array
items: {}
examples:
response:
value:
- Property: Name
Message: Required
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"404":
description: NotFound
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Link user to person
operationId: Link user to person
description: |-
Links a user to a person.
*Privilege required: `Api: Resource management`*
x-resource: Person - User
tags:
- Check In At Work
parameters:
- name: personId
in: path
description: ""
required: true
example: 00000000-0000-0000-0000-000000000000
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
properties:
UserId:
type: string
required:
- UserId
example:
UserId: 00000000-0000-0000-0000-000000000000
security:
- pat: []
delete:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Data:
properties:
Id:
type: string
ShortCode:
type: number
Code:
description: (default = null)
nullable: true
type: string
Type:
type: number
x-enum-type: IntelliTracer.ApiV2.PersonType
enum:
- 0
- 1
description: (default = 0)
RRNNumber:
type: number
description: (default = null)
FormattedRRNNumber:
description: (default = null)
nullable: true
type: string
LimosaNumber:
type: number
description: (default = null)
BTW:
properties:
Id:
type: string
Number:
type: string
Name:
type: string
Country:
type: number
x-enum-type: IntelliTracer.Domain.Country
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
- 47
- 48
- 49
- 50
- 51
- 52
- 53
- 54
- 55
- 56
- 57
- 58
- 59
- 60
- 61
- 62
- 63
- 64
- 65
- 66
- 67
- 68
- 69
- 70
- 71
- 72
- 73
- 74
- 75
- 76
- 77
- 78
- 79
- 80
- 81
- 82
- 83
- 84
- 85
- 86
- 87
- 88
- 89
- 90
- 91
- 92
- 93
- 94
- 95
- 96
- 97
- 98
- 99
- 100
- 101
- 102
- 103
- 104
- 105
- 106
- 107
- 108
- 109
- 110
- 111
- 112
- 113
- 114
- 115
- 116
- 117
- 118
- 119
- 120
- 121
- 122
- 123
- 124
- 125
- 126
- 127
- 128
- 129
- 130
- 131
- 132
- 133
- 134
- 135
- 136
- 137
- 138
- 139
- 140
- 141
- 142
- 143
- 144
- 145
- 146
- 147
- 148
- 149
- 150
- 151
- 152
- 153
- 9999
description: (default = 0)
CountryCode:
type: string
FormattedBTWNumber:
type: string
required:
- Id
- Number
- Name
- Country
- CountryCode
- FormattedBTWNumber
description: (default = null)
nullable: true
type: object
Notes:
description: (default = null)
nullable: true
type: string
Badges:
description: (default = [])
nullable: true
type: array
items: {}
FeedbackGSM:
properties:
Id:
type: string
Number:
type: string
required:
- Id
- Number
description: (default = null)
nullable: true
type: object
RegisterGSM:
properties:
Id:
type: string
Number:
type: string
required:
- Id
- Number
description: (default = null)
nullable: true
type: object
LimosaEndDate:
description: (default = null)
nullable: true
type: string
CreationTimeStamp:
description: (default = null)
nullable: true
type: string
BirthDate:
description: (default = null)
nullable: true
type: string
ReceiveFeedback:
type: boolean
description: (default = false)
ApproveRegistration:
type: boolean
description: (default = false)
User:
properties:
Id:
type: string
Code:
description: (default = null)
nullable: true
type: string
Name:
type: string
Type:
type: number
x-enum-type: IntelliTracer.Domain.ResourceType
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
description: (default = 0)
required:
- Id
- Name
description: (default = null)
nullable: true
type: object
BadgeTimeStamp:
description: "(default = null) "
nullable: true
type: string
Inactive:
type: boolean
description: (default = false)
InactivityTimestamp:
description: (default = null)
nullable: true
type: string
A1ExpirationDate:
description: (default = null)
nullable: true
type: string
VisaExpirationDate:
description: (default = null)
nullable: true
type: string
Limosas:
description: (default = null)
nullable: true
type: array
items: {}
QrUrl:
description: (default = null)
nullable: true
type: string
Info:
type: string
LimosaStartDate:
description: (default = null)
nullable: true
type: string
BISNumber:
type: number
description: (default = null)
FormattedBISNumber:
description: (default = null)
nullable: true
type: string
required:
- Id
- ShortCode
- Type
description: (default = null)
nullable: true
type: object
examples:
response:
value:
Data:
Id: 00000000-0000-0000-0000-000000000000
ShortCode: 123456789
Code: "12345"
Type: 0
RRNNumber: 79040205768
FormattedRRNNumber: 79.04.02-057.68
LimosaNumber: 11223344556677888
BTW:
Id: 00000000-0000-0000-0000-000000000000
Number: "123456789"
Name: GeoDynamics
Country: 0
CountryCode: BE
FormattedBTWNumber: BE-123456789
Notes: John Doe
Badges:
- Id: 00000000-0000-0000-0000-000000000000
Number: 00BB4E6F
Type: 0
ExternalNumber: 00BB4E6F
FeedbackGSM:
Id: 00000000-0000-0000-0000-000000000000
Number: "+32478123456"
RegisterGSM:
Id: 00000000-0000-0000-0000-000000000000
Number: "+32478123456"
LimosaEndDate: 2019-01-25T08:00:00+02:00
CreationTimeStamp: 2019-01-25T08:00:00+02:00
BirthDate: 2019-01-25
ReceiveFeedback: false
ApproveRegistration: false
User:
Id: 00000000-0000-0000-0000-000000000000
Code: "012345"
Name: John Doe
Type: 0
BadgeTimeStamp: 2019-01-25T08:00:00+02:00
Inactive: false
InactivityTimestamp: 2019-01-25T08:00:00+02:00
A1ExpirationDate: 2019-01-25T08:00:00+02:00
VisaExpirationDate: 2019-01-25T08:00:00+02:00
Limosas:
- Id: 00000000-0000-0000-0000-000000000000
LimosaNumber: 11223344556677888
IsDefault: false
EndDate: 2020-10-30T00:00:00+01:00
Workplaces:
- Id: 00000000-0000-0000-0000-000000000000
DUC: ""
Code: "012345"
Name: GeoDynamics
QrUrl: https://api.intellitracer.be/qrcode.pdf
Info: Person info
LimosaStartDate: 2019-01-25T08:00:00
BISNumber: 79040205768
FormattedBISNumber: 79.04.02-057.68
"400":
description: BadRequest
headers: {}
content:
application/json:
schema:
type: array
items: {}
examples:
response:
value:
- Property: Name
Message: Required
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"404":
description: NotFound
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Unlink user from person
operationId: Unlink user from person
description: |-
Unlinks the current user from a person.
*Privilege required: `Api: Resource management`*
x-resource: Person - User
tags:
- Check In At Work
parameters:
- name: personId
in: path
description: ""
required: true
example: 00000000-0000-0000-0000-000000000000
schema:
type: string
security:
- pat: []
"/api/v2/persongroup?page={page}&search={search}":
get:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Data:
description: (default = null)
nullable: true
type: array
items: {}
PagingFilter:
properties:
Page:
type: number
Search:
nullable: true
type: string
PageCount:
type: number
TotalCount:
type: number
Links:
type: object
properties:
Base:
type: string
First:
type: string
Prev:
type: string
Next:
type: string
Last:
type: string
required:
- Base
required:
- Page
- PageCount
- TotalCount
- Links
description: (default = null)
nullable: true
type: object
examples:
response:
value:
Data:
- Id: 00000000-0000-0000-0000-000000000000
Name: Group 1
Persons:
- Id: 00000000-0000-0000-0000-000000000000
ShortCode: 123456789
Code: "12345"
Type: 0
RRNNumber: 79040205768
FormattedRRNNumber: 79.04.02-057.68
LimosaNumber: 11223344556677888
BTW:
Id: 00000000-0000-0000-0000-000000000000
Number: "123456789"
Name: GeoDynamics
Country: 0
CountryCode: BE
FormattedBTWNumber: BE-123456789
Notes: John Doe
Badges:
- Id: 00000000-0000-0000-0000-000000000000
Number: 00BB4E6F
Type: 0
ExternalNumber: 00BB4E6F
FeedbackGSM:
Id: 00000000-0000-0000-0000-000000000000
Number: "+32478123456"
RegisterGSM:
Id: 00000000-0000-0000-0000-000000000000
Number: "+32478123456"
LimosaEndDate: 2019-01-25T08:00:00+02:00
CreationTimeStamp: 2019-01-25T08:00:00+02:00
BirthDate: 2019-01-25
ReceiveFeedback: false
ApproveRegistration: false
User:
Id: 00000000-0000-0000-0000-000000000000
Code: "012345"
Name: John Doe
Type: 0
BadgeTimeStamp: 2019-01-25T08:00:00+02:00
Inactive: false
InactivityTimestamp: 2019-01-25T08:00:00+02:00
A1ExpirationDate: 2019-01-25T08:00:00+02:00
VisaExpirationDate: 2019-01-25T08:00:00+02:00
Limosas:
- Id: 00000000-0000-0000-0000-000000000000
LimosaNumber: 11223344556677888
IsDefault: false
EndDate: 2020-10-30T00:00:00+01:00
Workplaces:
- Id: 00000000-0000-0000-0000-000000000000
DUC: ""
Code: "012345"
Name: GeoDynamics
QrUrl: https://api.intellitracer.be/qrcode.pdf
Info: Person info
LimosaStartDate: 2019-01-25T08:00:00
BISNumber: 79040205768
FormattedBISNumber: 79.04.02-057.68
PagingFilter:
Page: 1
Search: ABC
PageCount: 4
TotalCount: 100
Links:
Base: https://api.intellitracer.be
First: /api/v2/asset?page=1
Prev: /api/v2/asset?page=2
Next: /api/v2/asset?page=4
Last: /api/v2/asset?page=4
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Get person groups
operationId: Get person groups
description: |-
Returns a paged list of all person groups.
Pagination and searching is explained in [Pagination](#pagination).
*Privilege required: `Api: Check In At Work`*
x-resource: Person groups
tags:
- Check In At Work
parameters:
- name: page
in: path
description: ""
required: true
example: "1"
schema:
type: number
- name: search
in: path
description: ""
required: true
example: ABC
schema:
type: string
security:
- pat: []
"/api/v2/persongroup/{id}":
get:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Id:
type: string
Name:
type: string
Persons:
description: (default = [])
nullable: true
type: array
items: {}
required:
- Id
- Name
examples:
response:
value:
Id: 00000000-0000-0000-0000-000000000000
Name: Group 1
Persons:
- Id: 00000000-0000-0000-0000-000000000000
ShortCode: 123456789
Code: "12345"
Type: 0
RRNNumber: 79040205768
FormattedRRNNumber: 79.04.02-057.68
LimosaNumber: 11223344556677888
BTW:
Id: 00000000-0000-0000-0000-000000000000
Number: "123456789"
Name: GeoDynamics
Country: 0
CountryCode: BE
FormattedBTWNumber: BE-123456789
Notes: John Doe
Badges:
- Id: 00000000-0000-0000-0000-000000000000
Number: 00BB4E6F
Type: 0
ExternalNumber: 00BB4E6F
FeedbackGSM:
Id: 00000000-0000-0000-0000-000000000000
Number: "+32478123456"
RegisterGSM:
Id: 00000000-0000-0000-0000-000000000000
Number: "+32478123456"
LimosaEndDate: 2019-01-25T08:00:00+02:00
CreationTimeStamp: 2019-01-25T08:00:00+02:00
BirthDate: 2019-01-25
ReceiveFeedback: false
ApproveRegistration: false
User:
Id: 00000000-0000-0000-0000-000000000000
Code: "012345"
Name: John Doe
Type: 0
BadgeTimeStamp: 2019-01-25T08:00:00+02:00
Inactive: false
InactivityTimestamp: 2019-01-25T08:00:00+02:00
A1ExpirationDate: 2019-01-25T08:00:00+02:00
VisaExpirationDate: 2019-01-25T08:00:00+02:00
Limosas:
- Id: 00000000-0000-0000-0000-000000000000
LimosaNumber: 11223344556677888
IsDefault: false
EndDate: 2020-10-30T00:00:00+01:00
Workplaces:
- Id: 00000000-0000-0000-0000-000000000000
DUC: ""
Code: "012345"
Name: GeoDynamics
QrUrl: https://api.intellitracer.be/qrcode.pdf
Info: Person info
LimosaStartDate: 2019-01-25T08:00:00
BISNumber: 79040205768
FormattedBISNumber: 79.04.02-057.68
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Get person group
operationId: Get person group
description: |-
Returns a person group by Id.
*Privilege required: `Api: Check In At Work`*
x-resource: Person groups
tags:
- Check In At Work
parameters:
- name: id
in: path
description: ""
required: true
example: 00000000-0000-0000-0000-000000000000
schema:
type: string
security:
- pat: []
delete:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Id:
type: string
Name:
type: string
Persons:
description: (default = [])
nullable: true
type: array
items: {}
required:
- Id
- Name
examples:
response:
value:
Id: 00000000-0000-0000-0000-000000000000
Name: Group 1
Persons:
- Id: 00000000-0000-0000-0000-000000000000
ShortCode: 123456789
Code: "12345"
Type: 0
RRNNumber: 79040205768
FormattedRRNNumber: 79.04.02-057.68
LimosaNumber: 11223344556677888
BTW:
Id: 00000000-0000-0000-0000-000000000000
Number: "123456789"
Name: GeoDynamics
Country: 0
CountryCode: BE
FormattedBTWNumber: BE-123456789
Notes: John Doe
Badges:
- Id: 00000000-0000-0000-0000-000000000000
Number: 00BB4E6F
Type: 0
ExternalNumber: 00BB4E6F
FeedbackGSM:
Id: 00000000-0000-0000-0000-000000000000
Number: "+32478123456"
RegisterGSM:
Id: 00000000-0000-0000-0000-000000000000
Number: "+32478123456"
LimosaEndDate: 2019-01-25T08:00:00+02:00
CreationTimeStamp: 2019-01-25T08:00:00+02:00
BirthDate: 2019-01-25
ReceiveFeedback: false
ApproveRegistration: false
User:
Id: 00000000-0000-0000-0000-000000000000
Code: "012345"
Name: John Doe
Type: 0
BadgeTimeStamp: 2019-01-25T08:00:00+02:00
Inactive: false
InactivityTimestamp: 2019-01-25T08:00:00+02:00
A1ExpirationDate: 2019-01-25T08:00:00+02:00
VisaExpirationDate: 2019-01-25T08:00:00+02:00
Limosas:
- Id: 00000000-0000-0000-0000-000000000000
LimosaNumber: 11223344556677888
IsDefault: false
EndDate: 2020-10-30T00:00:00+01:00
Workplaces:
- Id: 00000000-0000-0000-0000-000000000000
DUC: ""
Code: "012345"
Name: GeoDynamics
QrUrl: https://api.intellitracer.be/qrcode.pdf
Info: Person info
LimosaStartDate: 2019-01-25T08:00:00
BISNumber: 79040205768
FormattedBISNumber: 79.04.02-057.68
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Delete person group
operationId: Delete person group
description: |-
Deletes a person group by Id.
*Privilege required: `Api: Check In At Work`*
x-resource: Person groups
tags:
- Check In At Work
parameters:
- name: id
in: path
description: ""
required: true
example: 00000000-0000-0000-0000-000000000000
schema:
type: string
security:
- pat: []
/api/v2/persongroup:
put:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Id:
type: string
Name:
type: string
Persons:
description: (default = [])
nullable: true
type: array
items: {}
required:
- Id
- Name
examples:
response:
value:
Id: 00000000-0000-0000-0000-000000000000
Name: Group 1
Persons:
- Id: 00000000-0000-0000-0000-000000000000
ShortCode: 123456789
Code: "12345"
Type: 0
RRNNumber: 79040205768
FormattedRRNNumber: 79.04.02-057.68
LimosaNumber: 11223344556677888
BTW:
Id: 00000000-0000-0000-0000-000000000000
Number: "123456789"
Name: GeoDynamics
Country: 0
CountryCode: BE
FormattedBTWNumber: BE-123456789
Notes: John Doe
Badges:
- Id: 00000000-0000-0000-0000-000000000000
Number: 00BB4E6F
Type: 0
ExternalNumber: 00BB4E6F
FeedbackGSM:
Id: 00000000-0000-0000-0000-000000000000
Number: "+32478123456"
RegisterGSM:
Id: 00000000-0000-0000-0000-000000000000
Number: "+32478123456"
LimosaEndDate: 2019-01-25T08:00:00+02:00
CreationTimeStamp: 2019-01-25T08:00:00+02:00
BirthDate: 2019-01-25
ReceiveFeedback: false
ApproveRegistration: false
User:
Id: 00000000-0000-0000-0000-000000000000
Code: "012345"
Name: John Doe
Type: 0
BadgeTimeStamp: 2019-01-25T08:00:00+02:00
Inactive: false
InactivityTimestamp: 2019-01-25T08:00:00+02:00
A1ExpirationDate: 2019-01-25T08:00:00+02:00
VisaExpirationDate: 2019-01-25T08:00:00+02:00
Limosas:
- Id: 00000000-0000-0000-0000-000000000000
LimosaNumber: 11223344556677888
IsDefault: false
EndDate: 2020-10-30T00:00:00+01:00
Workplaces:
- Id: 00000000-0000-0000-0000-000000000000
DUC: ""
Code: "012345"
Name: GeoDynamics
QrUrl: https://api.intellitracer.be/qrcode.pdf
Info: Person info
LimosaStartDate: 2019-01-25T08:00:00
BISNumber: 79040205768
FormattedBISNumber: 79.04.02-057.68
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Create person group
operationId: Create person group
description: |-
Creates a new person group.
*Privilege required: `Api: Check In At Work`*
x-resource: Person groups
tags:
- Check In At Work
requestBody:
content:
application/json:
schema:
type: object
properties:
Name:
type: string
PersonIds:
description: (default = [])
nullable: true
type: array
items: {}
required:
- Name
example:
Name: Group 1
PersonIds:
- 00000000-0000-0000-0000-000000000000
- 00000000-0000-0000-0000-000000000000
security:
- pat: []
post:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Id:
type: string
Name:
type: string
Persons:
description: (default = [])
nullable: true
type: array
items: {}
required:
- Id
- Name
examples:
response:
value:
Id: 00000000-0000-0000-0000-000000000000
Name: Group 1
Persons:
- Id: 00000000-0000-0000-0000-000000000000
ShortCode: 123456789
Code: "12345"
Type: 0
RRNNumber: 79040205768
FormattedRRNNumber: 79.04.02-057.68
LimosaNumber: 11223344556677888
BTW:
Id: 00000000-0000-0000-0000-000000000000
Number: "123456789"
Name: GeoDynamics
Country: 0
CountryCode: BE
FormattedBTWNumber: BE-123456789
Notes: John Doe
Badges:
- Id: 00000000-0000-0000-0000-000000000000
Number: 00BB4E6F
Type: 0
ExternalNumber: 00BB4E6F
FeedbackGSM:
Id: 00000000-0000-0000-0000-000000000000
Number: "+32478123456"
RegisterGSM:
Id: 00000000-0000-0000-0000-000000000000
Number: "+32478123456"
LimosaEndDate: 2019-01-25T08:00:00+02:00
CreationTimeStamp: 2019-01-25T08:00:00+02:00
BirthDate: 2019-01-25
ReceiveFeedback: false
ApproveRegistration: false
User:
Id: 00000000-0000-0000-0000-000000000000
Code: "012345"
Name: John Doe
Type: 0
BadgeTimeStamp: 2019-01-25T08:00:00+02:00
Inactive: false
InactivityTimestamp: 2019-01-25T08:00:00+02:00
A1ExpirationDate: 2019-01-25T08:00:00+02:00
VisaExpirationDate: 2019-01-25T08:00:00+02:00
Limosas:
- Id: 00000000-0000-0000-0000-000000000000
LimosaNumber: 11223344556677888
IsDefault: false
EndDate: 2020-10-30T00:00:00+01:00
Workplaces:
- Id: 00000000-0000-0000-0000-000000000000
DUC: ""
Code: "012345"
Name: GeoDynamics
QrUrl: https://api.intellitracer.be/qrcode.pdf
Info: Person info
LimosaStartDate: 2019-01-25T08:00:00
BISNumber: 79040205768
FormattedBISNumber: 79.04.02-057.68
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Update person group
operationId: Update person group
description: |-
Update a person group.
*Privilege required: `Api: Check In At Work`*
x-resource: Person groups
tags:
- Check In At Work
requestBody:
content:
application/json:
schema:
type: object
properties:
Id:
type: string
Name:
type: string
PersonIds:
description: (default = [])
nullable: true
type: array
items: {}
required:
- Id
- Name
example:
Id: 00000000-0000-0000-0000-000000000000
Name: Group 1
PersonIds:
- 00000000-0000-0000-0000-000000000000
- 00000000-0000-0000-0000-000000000000
security:
- pat: []
"/api/v2/persongroup/{id}/person":
put:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Id:
type: string
Name:
type: string
Persons:
description: (default = [])
nullable: true
type: array
items: {}
required:
- Id
- Name
examples:
response:
value:
Id: 00000000-0000-0000-0000-000000000000
Name: Group 1
Persons:
- Id: 00000000-0000-0000-0000-000000000000
ShortCode: 123456789
Code: "12345"
Type: 0
RRNNumber: 79040205768
FormattedRRNNumber: 79.04.02-057.68
LimosaNumber: 11223344556677888
BTW:
Id: 00000000-0000-0000-0000-000000000000
Number: "123456789"
Name: GeoDynamics
Country: 0
CountryCode: BE
FormattedBTWNumber: BE-123456789
Notes: John Doe
Badges:
- Id: 00000000-0000-0000-0000-000000000000
Number: 00BB4E6F
Type: 0
ExternalNumber: 00BB4E6F
FeedbackGSM:
Id: 00000000-0000-0000-0000-000000000000
Number: "+32478123456"
RegisterGSM:
Id: 00000000-0000-0000-0000-000000000000
Number: "+32478123456"
LimosaEndDate: 2019-01-25T08:00:00+02:00
CreationTimeStamp: 2019-01-25T08:00:00+02:00
BirthDate: 2019-01-25
ReceiveFeedback: false
ApproveRegistration: false
User:
Id: 00000000-0000-0000-0000-000000000000
Code: "012345"
Name: John Doe
Type: 0
BadgeTimeStamp: 2019-01-25T08:00:00+02:00
Inactive: false
InactivityTimestamp: 2019-01-25T08:00:00+02:00
A1ExpirationDate: 2019-01-25T08:00:00+02:00
VisaExpirationDate: 2019-01-25T08:00:00+02:00
Limosas:
- Id: 00000000-0000-0000-0000-000000000000
LimosaNumber: 11223344556677888
IsDefault: false
EndDate: 2020-10-30T00:00:00+01:00
Workplaces:
- Id: 00000000-0000-0000-0000-000000000000
DUC: ""
Code: "012345"
Name: GeoDynamics
QrUrl: https://api.intellitracer.be/qrcode.pdf
Info: Person info
LimosaStartDate: 2019-01-25T08:00:00
BISNumber: 79040205768
FormattedBISNumber: 79.04.02-057.68
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Add persons to person group
operationId: Add persons to person group
description: |-
Adds one or more persons to an existing person group.
*Privilege required: `Api: Check In At Work`*
x-resource: Person group - Persons
tags:
- Check In At Work
parameters:
- name: id
in: path
description: ""
required: true
example: 00000000-0000-0000-0000-000000000000
schema:
type: string
requestBody:
$ref: "#/components/requestBodies/Add_persons_to_person_groupBody"
security:
- pat: []
"/api/v2/persongroup/{id}/person/delete":
post:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Id:
type: string
Name:
type: string
Persons:
description: (default = [])
nullable: true
type: array
items: {}
required:
- Id
- Name
examples:
response:
value:
Id: 00000000-0000-0000-0000-000000000000
Name: Group 1
Persons:
- Id: 00000000-0000-0000-0000-000000000000
ShortCode: 123456789
Code: "12345"
Type: 0
RRNNumber: 79040205768
FormattedRRNNumber: 79.04.02-057.68
LimosaNumber: 11223344556677888
BTW:
Id: 00000000-0000-0000-0000-000000000000
Number: "123456789"
Name: GeoDynamics
Country: 0
CountryCode: BE
FormattedBTWNumber: BE-123456789
Notes: John Doe
Badges:
- Id: 00000000-0000-0000-0000-000000000000
Number: 00BB4E6F
Type: 0
ExternalNumber: 00BB4E6F
FeedbackGSM:
Id: 00000000-0000-0000-0000-000000000000
Number: "+32478123456"
RegisterGSM:
Id: 00000000-0000-0000-0000-000000000000
Number: "+32478123456"
LimosaEndDate: 2019-01-25T08:00:00+02:00
CreationTimeStamp: 2019-01-25T08:00:00+02:00
BirthDate: 2019-01-25
ReceiveFeedback: false
ApproveRegistration: false
User:
Id: 00000000-0000-0000-0000-000000000000
Code: "012345"
Name: John Doe
Type: 0
BadgeTimeStamp: 2019-01-25T08:00:00+02:00
Inactive: false
InactivityTimestamp: 2019-01-25T08:00:00+02:00
A1ExpirationDate: 2019-01-25T08:00:00+02:00
VisaExpirationDate: 2019-01-25T08:00:00+02:00
Limosas:
- Id: 00000000-0000-0000-0000-000000000000
LimosaNumber: 11223344556677888
IsDefault: false
EndDate: 2020-10-30T00:00:00+01:00
Workplaces:
- Id: 00000000-0000-0000-0000-000000000000
DUC: ""
Code: "012345"
Name: GeoDynamics
QrUrl: https://api.intellitracer.be/qrcode.pdf
Info: Person info
LimosaStartDate: 2019-01-25T08:00:00
BISNumber: 79040205768
FormattedBISNumber: 79.04.02-057.68
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Delete persons from person group
operationId: Delete persons from person group
description: |-
Deletes one or more persons from an existing person group.
*Privilege required: `Api: Check In At Work`*
x-resource: Person group - Persons
tags:
- Check In At Work
parameters:
- name: id
in: path
description: ""
required: true
example: 00000000-0000-0000-0000-000000000000
schema:
type: string
requestBody:
$ref: "#/components/requestBodies/Add_persons_to_person_groupBody"
security:
- pat: []
"/api/v2/rsz/workplace/{DUC}":
get:
responses:
"200":
description: OK
headers: {}
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"404":
description: Not Found
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Validate DUC with RSZ
operationId: Validate DUC with RSZ
description: >-
Checks whether the identification number or DUC of a workplace is a
valid number according to the RSZ.
No workplace will be created.
*Privilege required: `Api: Check In At Work`*
x-resource: Validate DUC
tags:
- Check In At Work
parameters:
- name: DUC
in: path
description: ""
required: true
example: 1Y100000CWWPZ
schema:
type: string
security:
- pat: []
/api/v2/workplace/rsz/validation:
post:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Workplaces:
type: array
items: {}
required:
- Workplaces
examples:
response:
value:
Workplaces:
- DUC: 1Y100001AB1CD
IsValid: false
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Validate workplaces with RSZ
operationId: Validate workplaces with RSZ
description: >-
Checks whether the identification numbers or DUCs of one or more
workplaces are valid numbers according to the RSZ.
No workplace(s) will be created.
*Privilege required: `Api: Check In At Work`*
x-resource: Validate workplaces
tags:
- Check In At Work
requestBody:
$ref: "#/components/requestBodies/Link_workplaces_to_LimosaBody"
security:
- pat: []
"/api/v2/workplace?page={page}&search={search}&activeOn={activeOn}&activeFrom={activeFrom}&activeTo={activeTo}&isClosed={isClosed}":
get:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Data:
description: (default = null)
nullable: true
type: array
items: {}
PagingFilter:
properties:
Page:
type: number
Search:
nullable: true
type: string
PageCount:
type: number
TotalCount:
type: number
Links:
type: object
properties:
Base:
type: string
First:
type: string
Prev:
type: string
Next:
type: string
Last:
type: string
required:
- Base
required:
- Page
- PageCount
- TotalCount
- Links
description: (default = null)
nullable: true
type: object
examples:
response:
value:
Data:
- Id: 00000000-0000-0000-0000-000000000000
DUC: 1Y100001AB1CD
Code: "012345"
Owner: GeoDynamics
Type: Werken in onroerende staat
Address: Dumolinlaan 9, 8530 Kortrijk
Notes: GeoDynamics
IsNotifiable: false
IsClosed: false
EmailFeedback:
Enabled: false
EmailAddress: null
EndDate: 2015-09-21T22:01:20+02:00
StartDate: 2015-09-21T22:01:20+02:00
Name: GeoDynamics
CreationTimestamp: 2015-09-21T22:01:20+02:00
BTW:
Id: 00000000-0000-0000-0000-000000000000
Number: "123456789"
Name: GeoDynamics
Country: 0
CountryCode: BE
FormattedBTWNumber: BE-123456789
SmsFeedback:
Enabled: false
GSMs:
- Id: 00000000-0000-0000-0000-000000000000
Number: "+32478123456"
ShortCode: 100
QrUrl: https://api.intellitracer.be/qrcode.pdf
PagingFilter:
Page: 1
Search: ABC
PageCount: 4
TotalCount: 100
Links:
Base: https://api.intellitracer.be
First: /api/v2/asset?page=1
Prev: /api/v2/asset?page=2
Next: /api/v2/asset?page=4
Last: /api/v2/asset?page=4
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Get workplaces
operationId: Get workplaces
description: >-
Returns a paged list of workplaces.
Pagination and searching is explained in [Pagination](#pagination).
The activeOn, activeFrom and activeTo parameters can be used to filter on the active date range of the workplaces.
If activeOn is specified, only workplaces that are active on that date will be returned.
If activeFrom and activeTo is specified, only workplaces that are active inside that date range will be returned.
If isClosed is specified, only workplaces with the corresponding status will be returned.
*Privilege required: `Api: Check In At Work`*
x-resource: Workplaces
tags:
- Check In At Work
parameters:
- name: page
in: path
description: ""
required: true
example: "1"
schema:
type: number
- name: search
in: path
description: ""
required: true
example: ABC
schema:
type: string
- name: activeOn
in: path
description: ""
required: true
example: 2015-09-21
schema:
type: string
- name: activeFrom
in: path
description: ""
required: true
example: 2015-09-21
schema:
type: string
- name: activeTo
in: path
description: ""
required: true
example: 2015-09-21
schema:
type: string
- name: isClosed
in: path
description: ""
required: true
example: "false"
schema:
type: boolean
security:
- pat: []
"/api/v2/workplace/{id}":
get:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Data:
properties:
Id:
type: string
description: (default = `00000000-0000-0000-0000-000000000000`)
DUC:
type: string
Code:
description: (default = null)
nullable: true
type: string
Owner:
description: (default = null)
nullable: true
type: string
Type:
description: (default = null)
nullable: true
type: string
Address:
description: (default = null)
nullable: true
type: string
Notes:
description: (default = null)
nullable: true
type: string
IsNotifiable:
type: boolean
description: (default = false)
IsClosed:
type: boolean
description: (default = false)
EmailFeedback:
properties:
Enabled:
type: boolean
EmailAddress:
description: (default = null)
nullable: true
type: string
required:
- Enabled
description: (default = null)
nullable: true
type: object
EndDate:
description: (default = null)
nullable: true
type: string
StartDate:
description: (default = null)
nullable: true
type: string
Name:
description: (default = null)
nullable: true
type: string
CreationTimestamp:
description: (default = null)
nullable: true
type: string
BTW:
properties:
Id:
type: string
Number:
type: string
Name:
type: string
Country:
type: number
x-enum-type: IntelliTracer.Domain.Country
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
- 47
- 48
- 49
- 50
- 51
- 52
- 53
- 54
- 55
- 56
- 57
- 58
- 59
- 60
- 61
- 62
- 63
- 64
- 65
- 66
- 67
- 68
- 69
- 70
- 71
- 72
- 73
- 74
- 75
- 76
- 77
- 78
- 79
- 80
- 81
- 82
- 83
- 84
- 85
- 86
- 87
- 88
- 89
- 90
- 91
- 92
- 93
- 94
- 95
- 96
- 97
- 98
- 99
- 100
- 101
- 102
- 103
- 104
- 105
- 106
- 107
- 108
- 109
- 110
- 111
- 112
- 113
- 114
- 115
- 116
- 117
- 118
- 119
- 120
- 121
- 122
- 123
- 124
- 125
- 126
- 127
- 128
- 129
- 130
- 131
- 132
- 133
- 134
- 135
- 136
- 137
- 138
- 139
- 140
- 141
- 142
- 143
- 144
- 145
- 146
- 147
- 148
- 149
- 150
- 151
- 152
- 153
- 9999
description: (default = 0)
CountryCode:
type: string
FormattedBTWNumber:
type: string
required:
- Id
- Number
- Name
- Country
- CountryCode
- FormattedBTWNumber
description: (default = null)
nullable: true
type: object
SmsFeedback:
properties:
Enabled:
type: boolean
GSMs:
description: (default = null)
nullable: true
type: array
items: {}
required:
- Enabled
description: (default = null)
nullable: true
type: object
ShortCode:
type: number
description: (default = 0)
QrUrl:
description: (default = null)
nullable: true
type: string
required:
- DUC
description: (default = null)
nullable: true
type: object
examples:
response:
value:
Data:
Id: 00000000-0000-0000-0000-000000000000
DUC: 1Y100001AB1CD
Code: "012345"
Owner: GeoDynamics
Type: Werken in onroerende staat
Address: Dumolinlaan 9, 8530 Kortrijk
Notes: GeoDynamics
IsNotifiable: false
IsClosed: false
EmailFeedback:
Enabled: false
EmailAddress: null
EndDate: 2015-09-21T22:01:20+02:00
StartDate: 2015-09-21T22:01:20+02:00
Name: GeoDynamics
CreationTimestamp: 2015-09-21T22:01:20+02:00
BTW:
Id: 00000000-0000-0000-0000-000000000000
Number: "123456789"
Name: GeoDynamics
Country: 0
CountryCode: BE
FormattedBTWNumber: BE-123456789
SmsFeedback:
Enabled: false
GSMs:
- Id: 00000000-0000-0000-0000-000000000000
Number: "+32478123456"
ShortCode: 100
QrUrl: https://api.intellitracer.be/qrcode.pdf
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"404":
description: NotFound
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Get workplace
operationId: Get workplace
description: |-
Returns a workplace by id.
*Privilege required: `Api: Check In At Work`*
x-resource: Workplaces
tags:
- Check In At Work
parameters:
- name: id
in: path
description: ""
required: true
example: 00000000-0000-0000-0000-000000000000
schema:
type: string
security:
- pat: []
delete:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Data:
properties:
Id:
type: string
description: (default = `00000000-0000-0000-0000-000000000000`)
DUC:
type: string
Code:
description: (default = null)
nullable: true
type: string
Owner:
description: (default = null)
nullable: true
type: string
Type:
description: (default = null)
nullable: true
type: string
Address:
description: (default = null)
nullable: true
type: string
Notes:
description: (default = null)
nullable: true
type: string
IsNotifiable:
type: boolean
description: (default = false)
IsClosed:
type: boolean
description: (default = false)
EmailFeedback:
properties:
Enabled:
type: boolean
EmailAddress:
description: (default = null)
nullable: true
type: string
required:
- Enabled
description: (default = null)
nullable: true
type: object
EndDate:
description: (default = null)
nullable: true
type: string
StartDate:
description: (default = null)
nullable: true
type: string
Name:
description: (default = null)
nullable: true
type: string
CreationTimestamp:
description: (default = null)
nullable: true
type: string
BTW:
properties:
Id:
type: string
Number:
type: string
Name:
type: string
Country:
type: number
x-enum-type: IntelliTracer.Domain.Country
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
- 47
- 48
- 49
- 50
- 51
- 52
- 53
- 54
- 55
- 56
- 57
- 58
- 59
- 60
- 61
- 62
- 63
- 64
- 65
- 66
- 67
- 68
- 69
- 70
- 71
- 72
- 73
- 74
- 75
- 76
- 77
- 78
- 79
- 80
- 81
- 82
- 83
- 84
- 85
- 86
- 87
- 88
- 89
- 90
- 91
- 92
- 93
- 94
- 95
- 96
- 97
- 98
- 99
- 100
- 101
- 102
- 103
- 104
- 105
- 106
- 107
- 108
- 109
- 110
- 111
- 112
- 113
- 114
- 115
- 116
- 117
- 118
- 119
- 120
- 121
- 122
- 123
- 124
- 125
- 126
- 127
- 128
- 129
- 130
- 131
- 132
- 133
- 134
- 135
- 136
- 137
- 138
- 139
- 140
- 141
- 142
- 143
- 144
- 145
- 146
- 147
- 148
- 149
- 150
- 151
- 152
- 153
- 9999
description: (default = 0)
CountryCode:
type: string
FormattedBTWNumber:
type: string
required:
- Id
- Number
- Name
- Country
- CountryCode
- FormattedBTWNumber
description: (default = null)
nullable: true
type: object
SmsFeedback:
properties:
Enabled:
type: boolean
GSMs:
description: (default = null)
nullable: true
type: array
items: {}
required:
- Enabled
description: (default = null)
nullable: true
type: object
ShortCode:
type: number
description: (default = 0)
QrUrl:
description: (default = null)
nullable: true
type: string
required:
- DUC
description: (default = null)
nullable: true
type: object
examples:
response:
value:
Data:
Id: 00000000-0000-0000-0000-000000000000
DUC: 1Y100001AB1CD
Code: "012345"
Owner: GeoDynamics
Type: Werken in onroerende staat
Address: Dumolinlaan 9, 8530 Kortrijk
Notes: GeoDynamics
IsNotifiable: false
IsClosed: false
EmailFeedback:
Enabled: false
EmailAddress: null
EndDate: 2015-09-21T22:01:20+02:00
StartDate: 2015-09-21T22:01:20+02:00
Name: GeoDynamics
CreationTimestamp: 2015-09-21T22:01:20+02:00
BTW:
Id: 00000000-0000-0000-0000-000000000000
Number: "123456789"
Name: GeoDynamics
Country: 0
CountryCode: BE
FormattedBTWNumber: BE-123456789
SmsFeedback:
Enabled: false
GSMs:
- Id: 00000000-0000-0000-0000-000000000000
Number: "+32478123456"
ShortCode: 100
QrUrl: https://api.intellitracer.be/qrcode.pdf
"400":
description: BadRequest
headers: {}
content:
application/json:
schema:
type: array
items: {}
examples:
response:
value:
- Property: Name
Message: Required
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"404":
description: NotFound
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Delete workplace
operationId: Delete workplace
description: |-
Deletes a workplace by id.
*Privilege required: `Api: Check In At Work`*
x-resource: Workplaces
tags:
- Check In At Work
parameters:
- name: id
in: path
description: ""
required: true
example: 00000000-0000-0000-0000-000000000000
schema:
type: string
security:
- pat: []
/api/v2/workplace:
put:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Data:
properties:
Id:
type: string
description: (default = `00000000-0000-0000-0000-000000000000`)
DUC:
type: string
Code:
description: (default = null)
nullable: true
type: string
Owner:
description: (default = null)
nullable: true
type: string
Type:
description: (default = null)
nullable: true
type: string
Address:
description: (default = null)
nullable: true
type: string
Notes:
description: (default = null)
nullable: true
type: string
IsNotifiable:
type: boolean
description: (default = false)
IsClosed:
type: boolean
description: (default = false)
EmailFeedback:
properties:
Enabled:
type: boolean
EmailAddress:
description: (default = null)
nullable: true
type: string
required:
- Enabled
description: (default = null)
nullable: true
type: object
EndDate:
description: (default = null)
nullable: true
type: string
StartDate:
description: (default = null)
nullable: true
type: string
Name:
description: (default = null)
nullable: true
type: string
CreationTimestamp:
description: (default = null)
nullable: true
type: string
BTW:
properties:
Id:
type: string
Number:
type: string
Name:
type: string
Country:
type: number
x-enum-type: IntelliTracer.Domain.Country
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
- 47
- 48
- 49
- 50
- 51
- 52
- 53
- 54
- 55
- 56
- 57
- 58
- 59
- 60
- 61
- 62
- 63
- 64
- 65
- 66
- 67
- 68
- 69
- 70
- 71
- 72
- 73
- 74
- 75
- 76
- 77
- 78
- 79
- 80
- 81
- 82
- 83
- 84
- 85
- 86
- 87
- 88
- 89
- 90
- 91
- 92
- 93
- 94
- 95
- 96
- 97
- 98
- 99
- 100
- 101
- 102
- 103
- 104
- 105
- 106
- 107
- 108
- 109
- 110
- 111
- 112
- 113
- 114
- 115
- 116
- 117
- 118
- 119
- 120
- 121
- 122
- 123
- 124
- 125
- 126
- 127
- 128
- 129
- 130
- 131
- 132
- 133
- 134
- 135
- 136
- 137
- 138
- 139
- 140
- 141
- 142
- 143
- 144
- 145
- 146
- 147
- 148
- 149
- 150
- 151
- 152
- 153
- 9999
description: (default = 0)
CountryCode:
type: string
FormattedBTWNumber:
type: string
required:
- Id
- Number
- Name
- Country
- CountryCode
- FormattedBTWNumber
description: (default = null)
nullable: true
type: object
SmsFeedback:
properties:
Enabled:
type: boolean
GSMs:
description: (default = null)
nullable: true
type: array
items: {}
required:
- Enabled
description: (default = null)
nullable: true
type: object
ShortCode:
type: number
description: (default = 0)
QrUrl:
description: (default = null)
nullable: true
type: string
required:
- DUC
description: (default = null)
nullable: true
type: object
examples:
response:
value:
Data:
Id: 00000000-0000-0000-0000-000000000000
DUC: 1Y100001AB1CD
Code: "012345"
Owner: GeoDynamics
Type: Werken in onroerende staat
Address: Dumolinlaan 9, 8530 Kortrijk
Notes: GeoDynamics
IsNotifiable: false
IsClosed: false
EmailFeedback:
Enabled: false
EmailAddress: null
EndDate: 2015-09-21T22:01:20+02:00
StartDate: 2015-09-21T22:01:20+02:00
Name: GeoDynamics
CreationTimestamp: 2015-09-21T22:01:20+02:00
BTW:
Id: 00000000-0000-0000-0000-000000000000
Number: "123456789"
Name: GeoDynamics
Country: 0
CountryCode: BE
FormattedBTWNumber: BE-123456789
SmsFeedback:
Enabled: false
GSMs:
- Id: 00000000-0000-0000-0000-000000000000
Number: "+32478123456"
ShortCode: 100
QrUrl: https://api.intellitracer.be/qrcode.pdf
"400":
description: BadRequest
headers: {}
content:
application/json:
schema:
type: array
items: {}
examples:
response:
value:
- Property: Name
Message: Required
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Create workplace
operationId: Create workplace
description: >-
Creates a new workplace.
The boolean validateRsz in the request URL determines whether we will validate the DUC (ID unique site number) passed to us in the request with the RSZ. When set to false, any value can be set as the DUC but the RSZ will not be notified of new registrations.
The boolean syncPoisByCode in the request URL determines whether we will try to link a poi to the workplace based on its code.
*Privilege required: `Api: Check In At Work`*
x-resource: Workplaces
tags:
- Check In At Work
parameters:
- name: validateRsz
in: query
description: ""
required: true
example: "false"
schema:
type: boolean
- name: syncPoisByCode
in: query
description: ""
required: false
example: "true"
schema:
type: boolean
requestBody:
content:
application/json:
schema:
type: object
properties:
DUC:
type: string
description: ID unique site number (as known by the RSZ in case
validateRsz=true).
Code:
description: >-
(default = null)
Multiple codes are supported, split them with a semicolon (1;2;3)
If there is an existing point of interest with the same code, it will automatically be linked to the workplace if ‘syncPoisByCode’ is set to true.
nullable: true
type: string
Owner:
description: (default = null)
nullable: true
type: string
Type:
description: (default = null)
nullable: true
type: string
Address:
description: (default = null)
nullable: true
type: string
Notes:
description: (default = null)
nullable: true
type: string
IsNotifiable:
type: boolean
description: |-
(default = false)
CheckInAtWork registrations will be sent to the Rsz if true.
IsClosed:
type: boolean
description: >-
(default = false)
Should be true in case work at this workplace has been completed.
EmailFeedback:
properties:
Enabled:
type: boolean
EmailAddress:
description: (default = null)
nullable: true
type: string
required:
- Enabled
description: >-
(default = null)
Which e-mail addresses should be notified of new registrations at this workplace.
nullable: true
type: object
SmsFeedback:
properties:
Enabled:
type: boolean
"GSMIds `00000000-0000-0000-0000-000000000000`,`00000000-0000-0000-0000-000000000000`":
description: (default = null)
nullable: true
type: array
items: {}
required:
- Enabled
description: >-
(default = null)
Which phone numbers should receive a text message in case of new registrations at this workplace.
nullable: true
type: object
BTWNumber:
description: "(default = null) "
nullable: true
type: string
EndDate:
description: >-
(default = null)
Date on which the work at this workplace is planned to finish.
nullable: true
type: string
StartDate:
description: >-
(default = null)
Date on which the work at this workplace is planned to start.
nullable: true
type: string
required:
- DUC
example:
DUC: 1Y100001AB1CD
Code: "012345"
Owner: GeoDynamics
Type: Werken in onroerende staat
Address: Dumolinlaan 9, 8530 Kortrijk
Notes: GeoDynamics
IsNotifiable: false
IsClosed: false
EmailFeedback:
Enabled: false
EmailAddress: null
SmsFeedback:
Enabled: false
"GSMIds `00000000-0000-0000-0000-000000000000`,`00000000-0000-0000-0000-000000000000`": []
BTWNumber: BE-0000000000
EndDate: 2015-09-21T22:01:20+02:00
StartDate: 2015-09-21T22:01:20+02:00
security:
- pat: []
post:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Data:
properties:
Id:
type: string
description: (default = `00000000-0000-0000-0000-000000000000`)
DUC:
type: string
Code:
description: (default = null)
nullable: true
type: string
Owner:
description: (default = null)
nullable: true
type: string
Type:
description: (default = null)
nullable: true
type: string
Address:
description: (default = null)
nullable: true
type: string
Notes:
description: (default = null)
nullable: true
type: string
IsNotifiable:
type: boolean
description: (default = false)
IsClosed:
type: boolean
description: (default = false)
EmailFeedback:
properties:
Enabled:
type: boolean
EmailAddress:
description: (default = null)
nullable: true
type: string
required:
- Enabled
description: (default = null)
nullable: true
type: object
EndDate:
description: (default = null)
nullable: true
type: string
StartDate:
description: (default = null)
nullable: true
type: string
Name:
description: (default = null)
nullable: true
type: string
CreationTimestamp:
description: (default = null)
nullable: true
type: string
BTW:
properties:
Id:
type: string
Number:
type: string
Name:
type: string
Country:
type: number
x-enum-type: IntelliTracer.Domain.Country
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
- 47
- 48
- 49
- 50
- 51
- 52
- 53
- 54
- 55
- 56
- 57
- 58
- 59
- 60
- 61
- 62
- 63
- 64
- 65
- 66
- 67
- 68
- 69
- 70
- 71
- 72
- 73
- 74
- 75
- 76
- 77
- 78
- 79
- 80
- 81
- 82
- 83
- 84
- 85
- 86
- 87
- 88
- 89
- 90
- 91
- 92
- 93
- 94
- 95
- 96
- 97
- 98
- 99
- 100
- 101
- 102
- 103
- 104
- 105
- 106
- 107
- 108
- 109
- 110
- 111
- 112
- 113
- 114
- 115
- 116
- 117
- 118
- 119
- 120
- 121
- 122
- 123
- 124
- 125
- 126
- 127
- 128
- 129
- 130
- 131
- 132
- 133
- 134
- 135
- 136
- 137
- 138
- 139
- 140
- 141
- 142
- 143
- 144
- 145
- 146
- 147
- 148
- 149
- 150
- 151
- 152
- 153
- 9999
description: (default = 0)
CountryCode:
type: string
FormattedBTWNumber:
type: string
required:
- Id
- Number
- Name
- Country
- CountryCode
- FormattedBTWNumber
description: (default = null)
nullable: true
type: object
SmsFeedback:
properties:
Enabled:
type: boolean
GSMs:
description: (default = null)
nullable: true
type: array
items: {}
required:
- Enabled
description: (default = null)
nullable: true
type: object
ShortCode:
type: number
description: (default = 0)
QrUrl:
description: (default = null)
nullable: true
type: string
required:
- DUC
description: (default = null)
nullable: true
type: object
examples:
response:
value:
Data:
Id: 00000000-0000-0000-0000-000000000000
DUC: 1Y100001AB1CD
Code: "012345"
Owner: GeoDynamics
Type: Werken in onroerende staat
Address: Dumolinlaan 9, 8530 Kortrijk
Notes: GeoDynamics
IsNotifiable: false
IsClosed: false
EmailFeedback:
Enabled: false
EmailAddress: null
EndDate: 2015-09-21T22:01:20+02:00
StartDate: 2015-09-21T22:01:20+02:00
Name: GeoDynamics
CreationTimestamp: 2015-09-21T22:01:20+02:00
BTW:
Id: 00000000-0000-0000-0000-000000000000
Number: "123456789"
Name: GeoDynamics
Country: 0
CountryCode: BE
FormattedBTWNumber: BE-123456789
SmsFeedback:
Enabled: false
GSMs:
- Id: 00000000-0000-0000-0000-000000000000
Number: "+32478123456"
ShortCode: 100
QrUrl: https://api.intellitracer.be/qrcode.pdf
"400":
description: BadRequest
headers: {}
content:
application/json:
schema:
type: array
items: {}
examples:
response:
value:
- Property: Name
Message: Required
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"404":
description: NotFound
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Update workplace
operationId: Update workplace
description: |-
Updates a workplace.
*Privilege required: `Api: Check In At Work`*
x-resource: Workplaces
tags:
- Check In At Work
parameters:
- name: validateRsz
in: query
description: ""
required: false
example: "false"
schema:
type: boolean
- name: syncPoisByCode
in: query
description: ""
required: false
example: "false"
schema:
type: boolean
requestBody:
content:
application/json:
schema:
type: object
properties:
Id:
type: string
description: (default = `00000000-0000-0000-0000-000000000000`)
DUC:
type: string
description: ID unique site number (as known by the RSZ in case
validateRsz=true).
Code:
description: >-
(default = null)
Multiple codes are supported, split them with a semicolon (1;2;3)
If there is an existing point of interest with the same code, it will automatically be linked to the workplace if ‘syncPoisByCode’ is set to true.
nullable: true
type: string
Owner:
description: (default = null)
nullable: true
type: string
Type:
description: (default = null)
nullable: true
type: string
Address:
description: (default = null)
nullable: true
type: string
Notes:
description: (default = null)
nullable: true
type: string
IsNotifiable:
type: boolean
description: |-
(default = false)
CheckInAtWork registrations will be sent to the Rsz if true.
IsClosed:
type: boolean
description: >-
(default = false)
Should be true in case work at this workplace has been completed.
EmailFeedback:
properties:
Enabled:
type: boolean
EmailAddress:
description: (default = null)
nullable: true
type: string
required:
- Enabled
description: >-
(default = null)
Which e-mail addresses should be notified of new registrations at this workplace.
nullable: true
type: object
SmsFeedback:
properties:
Enabled:
type: boolean
"GSMIds `00000000-0000-0000-0000-000000000000`,`00000000-0000-0000-0000-000000000000`":
description: (default = null)
nullable: true
type: array
items: {}
required:
- Enabled
description: >-
(default = null)
Which phone numbers should receive a text message in case of new registrations at this workplace.
nullable: true
type: object
BTWNumber:
description: "(default = null) "
nullable: true
type: string
EndDate:
description: >-
(default = null)
Date on which the work at this workplace is planned to finish.
nullable: true
type: string
StartDate:
description: >-
(default = null)
Date on which the work at this workplace is planned to start.
nullable: true
type: string
required:
- Id
- DUC
example:
Id: 00000000-0000-0000-0000-000000000000
DUC: 1Y100001AB1CD
Code: "012345"
Owner: GeoDynamics
Type: Werken in onroerende staat
Address: Dumolinlaan 9, 8530 Kortrijk
Notes: GeoDynamics
IsNotifiable: false
IsClosed: false
EmailFeedback:
Enabled: false
EmailAddress: null
SmsFeedback:
Enabled: false
"GSMIds `00000000-0000-0000-0000-000000000000`,`00000000-0000-0000-0000-000000000000`": []
BTWNumber: BE-0000000000
EndDate: 2015-09-21T22:01:20+02:00
StartDate: 2015-09-21T22:01:20+02:00
security:
- pat: []
/api/v2/workplace/byduc:
get:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Data:
properties:
Id:
type: string
description: (default = `00000000-0000-0000-0000-000000000000`)
DUC:
type: string
Code:
description: (default = null)
nullable: true
type: string
Owner:
description: (default = null)
nullable: true
type: string
Type:
description: (default = null)
nullable: true
type: string
Address:
description: (default = null)
nullable: true
type: string
Notes:
description: (default = null)
nullable: true
type: string
IsNotifiable:
type: boolean
description: (default = false)
IsClosed:
type: boolean
description: (default = false)
EmailFeedback:
properties:
Enabled:
type: boolean
EmailAddress:
description: (default = null)
nullable: true
type: string
required:
- Enabled
description: (default = null)
nullable: true
type: object
EndDate:
description: (default = null)
nullable: true
type: string
StartDate:
description: (default = null)
nullable: true
type: string
Name:
description: (default = null)
nullable: true
type: string
CreationTimestamp:
description: (default = null)
nullable: true
type: string
BTW:
properties:
Id:
type: string
Number:
type: string
Name:
type: string
Country:
type: number
x-enum-type: IntelliTracer.Domain.Country
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
- 47
- 48
- 49
- 50
- 51
- 52
- 53
- 54
- 55
- 56
- 57
- 58
- 59
- 60
- 61
- 62
- 63
- 64
- 65
- 66
- 67
- 68
- 69
- 70
- 71
- 72
- 73
- 74
- 75
- 76
- 77
- 78
- 79
- 80
- 81
- 82
- 83
- 84
- 85
- 86
- 87
- 88
- 89
- 90
- 91
- 92
- 93
- 94
- 95
- 96
- 97
- 98
- 99
- 100
- 101
- 102
- 103
- 104
- 105
- 106
- 107
- 108
- 109
- 110
- 111
- 112
- 113
- 114
- 115
- 116
- 117
- 118
- 119
- 120
- 121
- 122
- 123
- 124
- 125
- 126
- 127
- 128
- 129
- 130
- 131
- 132
- 133
- 134
- 135
- 136
- 137
- 138
- 139
- 140
- 141
- 142
- 143
- 144
- 145
- 146
- 147
- 148
- 149
- 150
- 151
- 152
- 153
- 9999
description: (default = 0)
CountryCode:
type: string
FormattedBTWNumber:
type: string
required:
- Id
- Number
- Name
- Country
- CountryCode
- FormattedBTWNumber
description: (default = null)
nullable: true
type: object
SmsFeedback:
properties:
Enabled:
type: boolean
GSMs:
description: (default = null)
nullable: true
type: array
items: {}
required:
- Enabled
description: (default = null)
nullable: true
type: object
ShortCode:
type: number
description: (default = 0)
QrUrl:
description: (default = null)
nullable: true
type: string
required:
- DUC
description: (default = null)
nullable: true
type: object
examples:
response:
value:
Data:
Id: 00000000-0000-0000-0000-000000000000
DUC: 1Y100001AB1CD
Code: "012345"
Owner: GeoDynamics
Type: Werken in onroerende staat
Address: Dumolinlaan 9, 8530 Kortrijk
Notes: GeoDynamics
IsNotifiable: false
IsClosed: false
EmailFeedback:
Enabled: false
EmailAddress: null
EndDate: 2015-09-21T22:01:20+02:00
StartDate: 2015-09-21T22:01:20+02:00
Name: GeoDynamics
CreationTimestamp: 2015-09-21T22:01:20+02:00
BTW:
Id: 00000000-0000-0000-0000-000000000000
Number: "123456789"
Name: GeoDynamics
Country: 0
CountryCode: BE
FormattedBTWNumber: BE-123456789
SmsFeedback:
Enabled: false
GSMs:
- Id: 00000000-0000-0000-0000-000000000000
Number: "+32478123456"
ShortCode: 100
QrUrl: https://api.intellitracer.be/qrcode.pdf
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"404":
description: NotFound
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Get workplace by DUC
operationId: Get workplace by DUC
description: |-
Returns a workplace by DUC.
*Privilege required: `Api: Check In At Work`*
x-resource: Workplace by DUC
tags:
- Check In At Work
parameters:
- name: duc
in: query
description: ""
required: true
example: 1Y100001AB1CD
schema:
type: string
security:
- pat: []
delete:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Data:
properties:
Id:
type: string
description: (default = `00000000-0000-0000-0000-000000000000`)
DUC:
type: string
Code:
description: (default = null)
nullable: true
type: string
Owner:
description: (default = null)
nullable: true
type: string
Type:
description: (default = null)
nullable: true
type: string
Address:
description: (default = null)
nullable: true
type: string
Notes:
description: (default = null)
nullable: true
type: string
IsNotifiable:
type: boolean
description: (default = false)
IsClosed:
type: boolean
description: (default = false)
EmailFeedback:
properties:
Enabled:
type: boolean
EmailAddress:
description: (default = null)
nullable: true
type: string
required:
- Enabled
description: (default = null)
nullable: true
type: object
EndDate:
description: (default = null)
nullable: true
type: string
StartDate:
description: (default = null)
nullable: true
type: string
Name:
description: (default = null)
nullable: true
type: string
CreationTimestamp:
description: (default = null)
nullable: true
type: string
BTW:
properties:
Id:
type: string
Number:
type: string
Name:
type: string
Country:
type: number
x-enum-type: IntelliTracer.Domain.Country
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
- 47
- 48
- 49
- 50
- 51
- 52
- 53
- 54
- 55
- 56
- 57
- 58
- 59
- 60
- 61
- 62
- 63
- 64
- 65
- 66
- 67
- 68
- 69
- 70
- 71
- 72
- 73
- 74
- 75
- 76
- 77
- 78
- 79
- 80
- 81
- 82
- 83
- 84
- 85
- 86
- 87
- 88
- 89
- 90
- 91
- 92
- 93
- 94
- 95
- 96
- 97
- 98
- 99
- 100
- 101
- 102
- 103
- 104
- 105
- 106
- 107
- 108
- 109
- 110
- 111
- 112
- 113
- 114
- 115
- 116
- 117
- 118
- 119
- 120
- 121
- 122
- 123
- 124
- 125
- 126
- 127
- 128
- 129
- 130
- 131
- 132
- 133
- 134
- 135
- 136
- 137
- 138
- 139
- 140
- 141
- 142
- 143
- 144
- 145
- 146
- 147
- 148
- 149
- 150
- 151
- 152
- 153
- 9999
description: (default = 0)
CountryCode:
type: string
FormattedBTWNumber:
type: string
required:
- Id
- Number
- Name
- Country
- CountryCode
- FormattedBTWNumber
description: (default = null)
nullable: true
type: object
SmsFeedback:
properties:
Enabled:
type: boolean
GSMs:
description: (default = null)
nullable: true
type: array
items: {}
required:
- Enabled
description: (default = null)
nullable: true
type: object
ShortCode:
type: number
description: (default = 0)
QrUrl:
description: (default = null)
nullable: true
type: string
required:
- DUC
description: (default = null)
nullable: true
type: object
examples:
response:
value:
Data:
Id: 00000000-0000-0000-0000-000000000000
DUC: 1Y100001AB1CD
Code: "012345"
Owner: GeoDynamics
Type: Werken in onroerende staat
Address: Dumolinlaan 9, 8530 Kortrijk
Notes: GeoDynamics
IsNotifiable: false
IsClosed: false
EmailFeedback:
Enabled: false
EmailAddress: null
EndDate: 2015-09-21T22:01:20+02:00
StartDate: 2015-09-21T22:01:20+02:00
Name: GeoDynamics
CreationTimestamp: 2015-09-21T22:01:20+02:00
BTW:
Id: 00000000-0000-0000-0000-000000000000
Number: "123456789"
Name: GeoDynamics
Country: 0
CountryCode: BE
FormattedBTWNumber: BE-123456789
SmsFeedback:
Enabled: false
GSMs:
- Id: 00000000-0000-0000-0000-000000000000
Number: "+32478123456"
ShortCode: 100
QrUrl: https://api.intellitracer.be/qrcode.pdf
"400":
description: BadRequest
headers: {}
content:
application/json:
schema:
type: array
items: {}
examples:
response:
value:
- Property: Name
Message: Required
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"404":
description: NotFound
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Delete workplace by DUC
operationId: Delete workplace by DUC
description: |-
Deletes a workplace by DUC.
*Privilege required: `Api: Check In At Work`*
x-resource: Workplace by DUC
tags:
- Check In At Work
parameters:
- name: duc
in: query
description: ""
required: true
example: 1Y100001AB1CD
schema:
type: string
security:
- pat: []
"/api/v2/workplace/{id}/poi":
put:
responses:
"200":
description: OK
headers: {}
"400":
description: BadRequest
headers: {}
content:
application/json:
schema:
type: object
properties:
Entity:
type: object
properties:
Id:
type: string
Name:
type: string
Code:
description: "(default = null) "
nullable: true
type: string
required:
- Id
- Name
ValidationResult:
type: array
items: {}
required:
- Entity
- ValidationResult
examples:
response:
value:
Entity:
Id: 00000000-0000-0000-0000-000000000000
Name: Home
Code: "012345"
ValidationResult:
- Message: ""
SourceMemberNames: []
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Link pois to workplace
operationId: Link pois to workplace
description: |-
Links one or more pois to a work place.
*Privilege required: `Api: Check In At Work`*
x-resource: Workplace - Pois
tags:
- Check In At Work
parameters:
- name: id
in: path
description: ""
required: true
example: 00000000-0000-0000-0000-000000000000
schema:
type: string
requestBody:
$ref: "#/components/requestBodies/Link_pois_to_workplaceBody"
security:
- pat: []
"/api/v2/workplace/{id}/poi/delete":
post:
responses:
"200":
description: OK
headers: {}
"400":
description: BadRequest
headers: {}
content:
application/json:
schema:
type: object
properties:
Entity:
type: object
properties:
Id:
type: string
Name:
type: string
Code:
description: "(default = null) "
nullable: true
type: string
required:
- Id
- Name
ValidationResult:
type: array
items: {}
required:
- Entity
- ValidationResult
examples:
response:
value:
Entity:
Id: 00000000-0000-0000-0000-000000000000
Name: Home
Code: "012345"
ValidationResult:
- Message: ""
SourceMemberNames: []
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Unlink pois from workplace
operationId: Unlink pois from workplace
description: |-
Unlinks one or more pois from a workplace.
*Privilege required: `Api: Check In At Work`*
x-resource: Workplace - Pois
tags:
- Check In At Work
parameters:
- name: id
in: path
description: ""
required: true
example: 00000000-0000-0000-0000-000000000000
schema:
type: string
requestBody:
$ref: "#/components/requestBodies/Link_pois_to_workplaceBody"
security:
- pat: []
"/api/v2/workplace/byduc/{duc}/poi":
put:
responses:
"200":
description: OK
headers: {}
"400":
description: BadRequest
headers: {}
content:
application/json:
schema:
type: object
properties:
Entity:
type: object
properties:
Id:
type: string
Name:
type: string
Code:
description: "(default = null) "
nullable: true
type: string
required:
- Id
- Name
ValidationResult:
type: array
items: {}
required:
- Entity
- ValidationResult
examples:
response:
value:
Entity:
Id: 00000000-0000-0000-0000-000000000000
Name: Home
Code: "012345"
ValidationResult:
- Message: ""
SourceMemberNames: []
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Link pois to workplace
operationId: Link pois to workplace by DUC
description: |-
Links one or more pois to a work place.
*Privilege required: `Api: Check In At Work`*
x-resource: Workplace by DUC - Pois
tags:
- Check In At Work
parameters:
- name: duc
in: path
description: ""
required: true
example: 1Y100001AB1CD
schema:
type: string
requestBody:
$ref: "#/components/requestBodies/Link_pois_to_workplaceBody"
security:
- pat: []
"/api/v2/workplace/byduc/{duc}/poi/delete":
post:
responses:
"200":
description: OK
headers: {}
"400":
description: BadRequest
headers: {}
content:
application/json:
schema:
type: object
properties:
Entity:
type: object
properties:
Id:
type: string
Name:
type: string
Code:
description: "(default = null) "
nullable: true
type: string
required:
- Id
- Name
ValidationResult:
type: array
items: {}
required:
- Entity
- ValidationResult
examples:
response:
value:
Entity:
Id: 00000000-0000-0000-0000-000000000000
Name: Home
Code: "012345"
ValidationResult:
- Message: ""
SourceMemberNames: []
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Unlink pois from workplace
operationId: Unlink pois from workplace by DUC
description: |-
Unlinks one or more pois from a workplace.
*Privilege required: `Api: Check In At Work`*
x-resource: Workplace by DUC - Pois
tags:
- Check In At Work
parameters:
- name: duc
in: path
description: ""
required: true
example: 1Y100001AB1CD
schema:
type: string
requestBody:
$ref: "#/components/requestBodies/Link_pois_to_workplaceBody"
security:
- pat: []
"/api/v1/workplace/{id}/overview":
get:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/IntelliTracer.ApiV1.WorkplaceOverview"
examples:
response:
value:
- Amount: 1
VAT: BE-1122334455
Workplace: 1Y100001AB1CD
Date: 2019-03-27T00:00:00
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Get workplace overview
operationId: Get workplace overview
description: |-
Returns a list of current (today) registrations for a workplace.
*Privilege required: `Api: Resource read` or `Api: Resource management`*
x-resource: Workplace - Overview
tags:
- Check In At Work
parameters:
- name: id
in: path
description: ""
required: true
example: 00000000-0000-0000-0000-000000000000
schema:
type: string
security:
- pat: []
"/api/v2/projectlead?page={page}&search={search}":
get:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Data:
description: (default = null)
nullable: true
type: array
items: {}
PagingFilter:
properties:
Page:
type: number
Search:
nullable: true
type: string
PageCount:
type: number
TotalCount:
type: number
Links:
type: object
properties:
Base:
type: string
First:
type: string
Prev:
type: string
Next:
type: string
Last:
type: string
required:
- Base
required:
- Page
- PageCount
- TotalCount
- Links
description: (default = null)
nullable: true
type: object
examples:
response:
value:
Data:
- Id: 00000000-0000-0000-0000-000000000000
User:
Id: 00000000-0000-0000-0000-000000000000
Code: "012345"
Name: John Doe
Type: 0
Name: John Doe
RestrictToAllowedBtws: false
Workplaces:
- Id: 00000000-0000-0000-0000-000000000000
DUC: ""
Code: "012345"
Name: GeoDynamics
Btws:
- Id: 00000000-0000-0000-0000-000000000000
Number: "123456789"
Name: GeoDynamics
Country: 0
CountryCode: BE
FormattedBTWNumber: BE-123456789
PagingFilter:
Page: 1
Search: ABC
PageCount: 4
TotalCount: 100
Links:
Base: https://api.intellitracer.be
First: /api/v2/asset?page=1
Prev: /api/v2/asset?page=2
Next: /api/v2/asset?page=4
Last: /api/v2/asset?page=4
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Get project leads
operationId: Get project leads
description: |-
Returns a paged list of project leads.
Pagination and searching is explained in [Pagination](#pagination).
*Privilege required: `Api: Check In At Work`*
x-resource: Project leads
tags:
- Check In At Work
parameters:
- name: page
in: path
description: ""
required: true
example: "1"
schema:
type: number
- name: search
in: path
description: ""
required: true
example: ABC
schema:
type: string
security:
- pat: []
"/api/v2/projectlead/{id}":
get:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Data:
properties:
Id:
type: string
User:
type: object
properties:
Id:
type: string
Code:
description: (default = null)
nullable: true
type: string
Name:
type: string
Type:
type: number
x-enum-type: IntelliTracer.Domain.ResourceType
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
description: (default = 0)
required:
- Id
- Name
Name:
type: string
RestrictToAllowedBtws:
type: boolean
Workplaces:
type: array
items: {}
Btws:
type: array
items: {}
required:
- Id
- User
- Name
description: (default = null)
nullable: true
type: object
examples:
response:
value:
Data:
Id: 00000000-0000-0000-0000-000000000000
User:
Id: 00000000-0000-0000-0000-000000000000
Code: "012345"
Name: John Doe
Type: 0
Name: John Doe
RestrictToAllowedBtws: false
Workplaces:
- Id: 00000000-0000-0000-0000-000000000000
DUC: ""
Code: "012345"
Name: GeoDynamics
Btws:
- Id: 00000000-0000-0000-0000-000000000000
Number: "123456789"
Name: GeoDynamics
Country: 0
CountryCode: BE
FormattedBTWNumber: BE-123456789
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Get project lead
operationId: Get project lead
description: |-
Returns a project lead by id.
*Privilege required: `Api: Check In At Work`*
x-resource: Project leads
tags:
- Check In At Work
parameters:
- name: id
in: path
description: ""
required: true
example: 00000000-0000-0000-0000-000000000000
schema:
type: string
security:
- pat: []
delete:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Data:
properties:
Id:
type: string
User:
type: object
properties:
Id:
type: string
Code:
description: (default = null)
nullable: true
type: string
Name:
type: string
Type:
type: number
x-enum-type: IntelliTracer.Domain.ResourceType
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
description: (default = 0)
required:
- Id
- Name
Name:
type: string
RestrictToAllowedBtws:
type: boolean
Workplaces:
type: array
items: {}
Btws:
type: array
items: {}
required:
- Id
- User
- Name
description: (default = null)
nullable: true
type: object
examples:
response:
value:
Data:
Id: 00000000-0000-0000-0000-000000000000
User:
Id: 00000000-0000-0000-0000-000000000000
Code: "012345"
Name: John Doe
Type: 0
Name: John Doe
RestrictToAllowedBtws: false
Workplaces:
- Id: 00000000-0000-0000-0000-000000000000
DUC: ""
Code: "012345"
Name: GeoDynamics
Btws:
- Id: 00000000-0000-0000-0000-000000000000
Number: "123456789"
Name: GeoDynamics
Country: 0
CountryCode: BE
FormattedBTWNumber: BE-123456789
"400":
description: BadRequest
headers: {}
content:
application/json:
schema:
type: object
properties:
Entity:
type: object
properties:
Id:
type: string
User:
type: object
properties:
Id:
type: string
Code:
description: (default = null)
nullable: true
type: string
Name:
type: string
Type:
type: number
x-enum-type: IntelliTracer.Domain.ResourceType
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
description: (default = 0)
required:
- Id
- Name
Name:
type: string
RestrictToAllowedBtws:
type: boolean
Workplaces:
type: array
items: {}
Btws:
type: array
items: {}
required:
- Id
- User
- Name
ValidationResult:
type: array
items: {}
required:
- Entity
- ValidationResult
examples:
response:
value:
Entity:
Id: 00000000-0000-0000-0000-000000000000
User:
Id: 00000000-0000-0000-0000-000000000000
Code: "012345"
Name: John Doe
Type: 0
Name: John Doe
RestrictToAllowedBtws: false
Workplaces:
- Id: 00000000-0000-0000-0000-000000000000
DUC: ""
Code: "012345"
Name: GeoDynamics
Btws:
- Id: 00000000-0000-0000-0000-000000000000
Number: "123456789"
Name: GeoDynamics
Country: 0
CountryCode: BE
FormattedBTWNumber: BE-123456789
ValidationResult:
- Message: ""
SourceMemberNames: []
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Delete project lead
operationId: Delete project lead
description: |-
Deletes a project lead.
*Privilege required: `Api: Check In At Work`*
x-resource: Project leads
tags:
- Check In At Work
parameters:
- name: id
in: path
description: ""
required: true
example: 00000000-0000-0000-0000-000000000000
schema:
type: string
security:
- pat: []
/api/v2/projectlead:
put:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Data:
properties:
Id:
type: string
User:
type: object
properties:
Id:
type: string
Code:
description: (default = null)
nullable: true
type: string
Name:
type: string
Type:
type: number
x-enum-type: IntelliTracer.Domain.ResourceType
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
description: (default = 0)
required:
- Id
- Name
Name:
type: string
RestrictToAllowedBtws:
type: boolean
Workplaces:
type: array
items: {}
Btws:
type: array
items: {}
required:
- Id
- User
- Name
description: (default = null)
nullable: true
type: object
examples:
response:
value:
Data:
Id: 00000000-0000-0000-0000-000000000000
User:
Id: 00000000-0000-0000-0000-000000000000
Code: "012345"
Name: John Doe
Type: 0
Name: John Doe
RestrictToAllowedBtws: false
Workplaces:
- Id: 00000000-0000-0000-0000-000000000000
DUC: ""
Code: "012345"
Name: GeoDynamics
Btws:
- Id: 00000000-0000-0000-0000-000000000000
Number: "123456789"
Name: GeoDynamics
Country: 0
CountryCode: BE
FormattedBTWNumber: BE-123456789
"400":
description: BadRequest
headers: {}
content:
application/json:
schema:
type: object
properties:
Entity:
type: object
properties:
Id:
type: string
User:
type: object
properties:
Id:
type: string
Code:
description: (default = null)
nullable: true
type: string
Name:
type: string
Type:
type: number
x-enum-type: IntelliTracer.Domain.ResourceType
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
description: (default = 0)
required:
- Id
- Name
Name:
type: string
RestrictToAllowedBtws:
type: boolean
Workplaces:
type: array
items: {}
Btws:
type: array
items: {}
required:
- Id
- User
- Name
ValidationResult:
type: array
items: {}
required:
- Entity
- ValidationResult
examples:
response:
value:
Entity:
Id: 00000000-0000-0000-0000-000000000000
User:
Id: 00000000-0000-0000-0000-000000000000
Code: "012345"
Name: John Doe
Type: 0
Name: John Doe
RestrictToAllowedBtws: false
Workplaces:
- Id: 00000000-0000-0000-0000-000000000000
DUC: ""
Code: "012345"
Name: GeoDynamics
Btws:
- Id: 00000000-0000-0000-0000-000000000000
Number: "123456789"
Name: GeoDynamics
Country: 0
CountryCode: BE
FormattedBTWNumber: BE-123456789
ValidationResult:
- Message: ""
SourceMemberNames: []
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Create project lead
operationId: Create project lead
description: |-
Creates a new project lead.
*Privilege required: `Api: Check In At Work`*
x-resource: Project leads
tags:
- Check In At Work
requestBody:
content:
application/json:
schema:
type: object
properties:
UserId:
type: string
WorkplaceDucs:
type: array
items: {}
BtwNumbers:
type: array
items: {}
required:
- UserId
example:
UserId: 00000000-0000-0000-0000-000000000000
WorkplaceDucs:
- 1Y100001AB1CD
- 1Y100001AB1CE
BtwNumbers:
- BE-123456788
- BE-123456789
security:
- pat: []
post:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Data:
properties:
Id:
type: string
User:
type: object
properties:
Id:
type: string
Code:
description: (default = null)
nullable: true
type: string
Name:
type: string
Type:
type: number
x-enum-type: IntelliTracer.Domain.ResourceType
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
description: (default = 0)
required:
- Id
- Name
Name:
type: string
RestrictToAllowedBtws:
type: boolean
Workplaces:
type: array
items: {}
Btws:
type: array
items: {}
required:
- Id
- User
- Name
description: (default = null)
nullable: true
type: object
examples:
response:
value:
Data:
Id: 00000000-0000-0000-0000-000000000000
User:
Id: 00000000-0000-0000-0000-000000000000
Code: "012345"
Name: John Doe
Type: 0
Name: John Doe
RestrictToAllowedBtws: false
Workplaces:
- Id: 00000000-0000-0000-0000-000000000000
DUC: ""
Code: "012345"
Name: GeoDynamics
Btws:
- Id: 00000000-0000-0000-0000-000000000000
Number: "123456789"
Name: GeoDynamics
Country: 0
CountryCode: BE
FormattedBTWNumber: BE-123456789
"400":
description: BadRequest
headers: {}
content:
application/json:
schema:
type: object
properties:
Entity:
type: object
properties:
Id:
type: string
User:
type: object
properties:
Id:
type: string
Code:
description: (default = null)
nullable: true
type: string
Name:
type: string
Type:
type: number
x-enum-type: IntelliTracer.Domain.ResourceType
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
description: (default = 0)
required:
- Id
- Name
Name:
type: string
RestrictToAllowedBtws:
type: boolean
Workplaces:
type: array
items: {}
Btws:
type: array
items: {}
required:
- Id
- User
- Name
ValidationResult:
type: array
items: {}
required:
- Entity
- ValidationResult
examples:
response:
value:
Entity:
Id: 00000000-0000-0000-0000-000000000000
User:
Id: 00000000-0000-0000-0000-000000000000
Code: "012345"
Name: John Doe
Type: 0
Name: John Doe
RestrictToAllowedBtws: false
Workplaces:
- Id: 00000000-0000-0000-0000-000000000000
DUC: ""
Code: "012345"
Name: GeoDynamics
Btws:
- Id: 00000000-0000-0000-0000-000000000000
Number: "123456789"
Name: GeoDynamics
Country: 0
CountryCode: BE
FormattedBTWNumber: BE-123456789
ValidationResult:
- Message: ""
SourceMemberNames: []
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Update project lead
operationId: Update project lead
description: |-
Updates a project lead.
*Privilege required: `Api: Check In At Work`*
x-resource: Project leads
tags:
- Check In At Work
requestBody:
content:
application/json:
schema:
type: object
properties:
Id:
type: string
UserId:
type: string
WorkplaceDucs:
type: array
items: {}
BtwNumbers:
type: array
items: {}
required:
- Id
- UserId
example:
Id: 00000000-0000-0000-0000-000000000000
UserId: 00000000-0000-0000-0000-000000000000
WorkplaceDucs:
- 1Y100001AB1CD
- 1Y100001AB1CE
BtwNumbers:
- BE-123456788
- BE-123456789
security:
- pat: []
"/api/v2/projectlead/{id}/workplace?page={page}&search={search}":
get:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Data:
type: array
items: {}
required:
- Data
examples:
response:
value:
Data:
- Id: 00000000-0000-0000-0000-000000000000
DUC: ""
Code: "012345"
Name: GeoDynamics
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Get workplaces by project lead
operationId: Get workplaces by project lead
description: |-
Returns a list of all workplaces linked to a project lead.
*Privilege required: `Api: Check In At Work`*
x-resource: Project lead - Workplaces
tags:
- Check In At Work
parameters:
- name: id
in: path
description: ""
required: true
example: 00000000-0000-0000-0000-000000000000
schema:
type: string
- name: page
in: path
description: ""
required: true
example: "1"
schema:
type: number
- name: search
in: path
description: ""
required: true
example: ABC
schema:
type: string
security:
- pat: []
"/api/v2/projectlead/{id}/workplace":
put:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Data:
type: array
items: {}
required:
- Data
examples:
response:
value:
Data:
- Id: 00000000-0000-0000-0000-000000000000
DUC: ""
Code: "012345"
Name: GeoDynamics
"400":
description: BadRequest
headers: {}
content:
application/json:
schema:
type: object
properties:
Entity:
type: object
properties:
Id:
type: string
DUC:
type: string
Code:
description: (default = null)
nullable: true
type: string
Name:
description: (default = null)
nullable: true
type: string
required:
- Id
- DUC
ValidationResult:
type: array
items: {}
required:
- Entity
- ValidationResult
examples:
response:
value:
Entity:
Id: 00000000-0000-0000-0000-000000000000
DUC: ""
Code: "012345"
Name: GeoDynamics
ValidationResult:
- Message: ""
SourceMemberNames: []
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Link workplaces to project lead
operationId: Link workplaces to project lead
description: |-
Links one or more workplaces to a project lead.
*Privilege required: `Api: Check In At Work`*
x-resource: Project lead - Workplaces
tags:
- Check In At Work
parameters:
- name: id
in: path
description: ""
required: true
example: 00000000-0000-0000-0000-000000000000
schema:
type: string
requestBody:
$ref: "#/components/requestBodies/Link_workplaces_to_LimosaBody"
security:
- pat: []
"/api/v2/projectlead/{id}/workplace/delete":
post:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Data:
type: array
items: {}
required:
- Data
examples:
response:
value:
Data:
- Id: 00000000-0000-0000-0000-000000000000
DUC: ""
Code: "012345"
Name: GeoDynamics
"400":
description: BadRequest
headers: {}
content:
application/json:
schema:
type: object
properties:
Entity:
type: object
properties:
Id:
type: string
DUC:
type: string
Code:
description: (default = null)
nullable: true
type: string
Name:
description: (default = null)
nullable: true
type: string
required:
- Id
- DUC
ValidationResult:
type: array
items: {}
required:
- Entity
- ValidationResult
examples:
response:
value:
Entity:
Id: 00000000-0000-0000-0000-000000000000
DUC: ""
Code: "012345"
Name: GeoDynamics
ValidationResult:
- Message: ""
SourceMemberNames: []
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Unlink workplaces from project lead
operationId: Unlink workplaces from project lead
description: |-
Unlinks one or more workplaces from a project lead by DUC.
*Privilege required: `Api: Check In At Work`*
x-resource: Project lead - Workplaces
tags:
- Check In At Work
parameters:
- name: id
in: path
description: ""
required: true
example: 00000000-0000-0000-0000-000000000000
schema:
type: string
requestBody:
$ref: "#/components/requestBodies/Link_workplaces_to_LimosaBody"
security:
- pat: []
"/api/v2/projectlead/{id}/btw?page={page}&search={search}":
get:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Data:
type: array
items: {}
required:
- Data
examples:
response:
value:
Data:
- Id: 00000000-0000-0000-0000-000000000000
Number: "123456789"
Name: GeoDynamics
Country: 0
CountryCode: BE
FormattedBTWNumber: BE-123456789
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Get BTW numbers by project lead
operationId: Get BTW numbers by project lead
description: |-
Returns a list of all BTW numbers linked to a project lead.
*Privilege required: `Api: Check In At Work`*
x-resource: Project lead - BTWs
tags:
- Check In At Work
parameters:
- name: id
in: path
description: ""
required: true
example: 00000000-0000-0000-0000-000000000000
schema:
type: string
- name: page
in: path
description: ""
required: true
example: "1"
schema:
type: number
- name: search
in: path
description: ""
required: true
example: ABC
schema:
type: string
security:
- pat: []
"/api/v2/projectlead/{id}/btw":
put:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Data:
type: array
items: {}
required:
- Data
examples:
response:
value:
Data:
- Id: 00000000-0000-0000-0000-000000000000
Number: "123456789"
Name: GeoDynamics
Country: 0
CountryCode: BE
FormattedBTWNumber: BE-123456789
"400":
description: BadRequest
headers: {}
content:
application/json:
schema:
type: object
properties:
Entity:
type: object
properties:
Id:
type: string
Number:
type: string
Name:
type: string
Country:
type: number
x-enum-type: IntelliTracer.Domain.Country
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
- 47
- 48
- 49
- 50
- 51
- 52
- 53
- 54
- 55
- 56
- 57
- 58
- 59
- 60
- 61
- 62
- 63
- 64
- 65
- 66
- 67
- 68
- 69
- 70
- 71
- 72
- 73
- 74
- 75
- 76
- 77
- 78
- 79
- 80
- 81
- 82
- 83
- 84
- 85
- 86
- 87
- 88
- 89
- 90
- 91
- 92
- 93
- 94
- 95
- 96
- 97
- 98
- 99
- 100
- 101
- 102
- 103
- 104
- 105
- 106
- 107
- 108
- 109
- 110
- 111
- 112
- 113
- 114
- 115
- 116
- 117
- 118
- 119
- 120
- 121
- 122
- 123
- 124
- 125
- 126
- 127
- 128
- 129
- 130
- 131
- 132
- 133
- 134
- 135
- 136
- 137
- 138
- 139
- 140
- 141
- 142
- 143
- 144
- 145
- 146
- 147
- 148
- 149
- 150
- 151
- 152
- 153
- 9999
description: (default = 0)
CountryCode:
type: string
FormattedBTWNumber:
type: string
required:
- Id
- Number
- Name
- Country
- CountryCode
- FormattedBTWNumber
ValidationResult:
type: array
items: {}
required:
- Entity
- ValidationResult
examples:
response:
value:
Entity:
Id: 00000000-0000-0000-0000-000000000000
Number: "123456789"
Name: GeoDynamics
Country: 0
CountryCode: BE
FormattedBTWNumber: BE-123456789
ValidationResult:
- Message: ""
SourceMemberNames: []
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Link BTW's to project lead
operationId: Link BTW's to project lead
description: |-
Links one or more BTW numbers to a project lead.
*Privilege required: `Api: Check In At Work`*
x-resource: Project lead - BTWs
tags:
- Check In At Work
parameters:
- name: id
in: path
description: ""
required: true
example: 00000000-0000-0000-0000-000000000000
schema:
type: string
requestBody:
$ref: "#/components/requestBodies/Link_BTW_s_to_project_leadBody"
security:
- pat: []
"/api/v2/projectlead/{id}/btw/delete":
post:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Data:
type: array
items: {}
required:
- Data
examples:
response:
value:
Data:
- Id: 00000000-0000-0000-0000-000000000000
Number: "123456789"
Name: GeoDynamics
Country: 0
CountryCode: BE
FormattedBTWNumber: BE-123456789
"400":
description: BadRequest
headers: {}
content:
application/json:
schema:
type: object
properties:
Entity:
type: object
properties:
Id:
type: string
Number:
type: string
Name:
type: string
Country:
type: number
x-enum-type: IntelliTracer.Domain.Country
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
- 47
- 48
- 49
- 50
- 51
- 52
- 53
- 54
- 55
- 56
- 57
- 58
- 59
- 60
- 61
- 62
- 63
- 64
- 65
- 66
- 67
- 68
- 69
- 70
- 71
- 72
- 73
- 74
- 75
- 76
- 77
- 78
- 79
- 80
- 81
- 82
- 83
- 84
- 85
- 86
- 87
- 88
- 89
- 90
- 91
- 92
- 93
- 94
- 95
- 96
- 97
- 98
- 99
- 100
- 101
- 102
- 103
- 104
- 105
- 106
- 107
- 108
- 109
- 110
- 111
- 112
- 113
- 114
- 115
- 116
- 117
- 118
- 119
- 120
- 121
- 122
- 123
- 124
- 125
- 126
- 127
- 128
- 129
- 130
- 131
- 132
- 133
- 134
- 135
- 136
- 137
- 138
- 139
- 140
- 141
- 142
- 143
- 144
- 145
- 146
- 147
- 148
- 149
- 150
- 151
- 152
- 153
- 9999
description: (default = 0)
CountryCode:
type: string
FormattedBTWNumber:
type: string
required:
- Id
- Number
- Name
- Country
- CountryCode
- FormattedBTWNumber
ValidationResult:
type: array
items: {}
required:
- Entity
- ValidationResult
examples:
response:
value:
Entity:
Id: 00000000-0000-0000-0000-000000000000
Number: "123456789"
Name: GeoDynamics
Country: 0
CountryCode: BE
FormattedBTWNumber: BE-123456789
ValidationResult:
- Message: ""
SourceMemberNames: []
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Unlink BTW's from project lead
operationId: Unlink BTW's from project lead
description: |-
Unlinks one or more BTW numbers from a project lead.
*Privilege required: `Api: Check In At Work`*
x-resource: Project lead - BTWs
tags:
- Check In At Work
parameters:
- name: id
in: path
description: ""
required: true
example: 00000000-0000-0000-0000-000000000000
schema:
type: string
requestBody:
$ref: "#/components/requestBodies/Link_BTW_s_to_project_leadBody"
security:
- pat: []
/api/v2/registration:
get:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Data:
description: (default = null)
nullable: true
type: array
items: {}
PagingFilter:
properties:
Page:
type: number
Search:
nullable: true
type: string
PageCount:
type: number
TotalCount:
type: number
Links:
type: object
properties:
Base:
type: string
First:
type: string
Prev:
type: string
Next:
type: string
Last:
type: string
required:
- Base
required:
- Page
- PageCount
- TotalCount
- Links
description: (default = null)
nullable: true
type: object
examples:
response:
value:
Data:
- Id: 00000000-0000-0000-0000-000000000000
Person:
Id: 00000000-0000-0000-0000-000000000000
Code: "012345"
Name: John Doe
Type: 0
User:
Id: 00000000-0000-0000-0000-000000000000
Code: "012345"
Name: John Doe
Type: 0
Workplace:
Id: 00000000-0000-0000-0000-000000000000
DUC: ""
Code: "012345"
Name: GeoDynamics
RRNNumber: 79040205768
LimosaNumber: 11223344556677888
Btw:
Id: 00000000-0000-0000-0000-000000000000
Number: "123456789"
Name: GeoDynamics
Country: 0
CountryCode: BE
FormattedBTWNumber: BE-123456789
ResponseId: 10258
RegistrationDate: 2019-03-25T00:00:00
RequestTime: 2019-03-25T13:33:49+02:00
Status: "1"
CancelationReason: 0
RSZComment: []
PagingFilter:
Page: 1
Search: ABC
PageCount: 4
TotalCount: 100
Links:
Base: https://api.intellitracer.be
First: /api/v2/asset?page=1
Prev: /api/v2/asset?page=2
Next: /api/v2/asset?page=4
Last: /api/v2/asset?page=4
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Get registrations
operationId: Get registrations
description: |-
Returns a paged list of registrations within a date/time range.
*Privilege required: `Api: Check In At Work`*
x-resource: Registrations
tags:
- Check In At Work
parameters:
- name: page
in: query
description: ""
required: false
example: "1"
schema:
type: number
- name: search
in: query
description: ""
required: false
example: ABC
schema:
type: string
- name: fromDate
in: query
description: ""
required: true
example: 2019-01-25T08:00:00+02:00
schema:
type: string
- name: toDate
in: query
description: ""
required: true
example: 2019-01-25T17:00:00+02:00
schema:
type: string
security:
- pat: []
/api/v2/registration/bylimosa:
put:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Data:
properties:
Id:
type: string
Person:
properties:
Id:
type: string
Code:
description: (default = null)
nullable: true
type: string
Name:
type: string
Type:
type: number
x-enum-type: IntelliTracer.Domain.ResourceType
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
description: (default = 0)
required:
- Id
- Name
description: (default = null)
nullable: true
type: object
User:
properties:
Id:
type: string
Code:
description: (default = null)
nullable: true
type: string
Name:
type: string
Type:
type: number
x-enum-type: IntelliTracer.Domain.ResourceType
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
description: (default = 0)
required:
- Id
- Name
description: (default = null)
nullable: true
type: object
Workplace:
properties:
Id:
type: string
DUC:
type: string
Code:
description: (default = null)
nullable: true
type: string
Name:
description: (default = null)
nullable: true
type: string
required:
- Id
- DUC
description: (default = null)
nullable: true
type: object
RRNNumber:
type: number
description: (default = 0)
LimosaNumber:
type: number
description: (default = 0)
Btw:
properties:
Id:
type: string
Number:
type: string
Name:
type: string
Country:
type: number
x-enum-type: IntelliTracer.Domain.Country
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
- 47
- 48
- 49
- 50
- 51
- 52
- 53
- 54
- 55
- 56
- 57
- 58
- 59
- 60
- 61
- 62
- 63
- 64
- 65
- 66
- 67
- 68
- 69
- 70
- 71
- 72
- 73
- 74
- 75
- 76
- 77
- 78
- 79
- 80
- 81
- 82
- 83
- 84
- 85
- 86
- 87
- 88
- 89
- 90
- 91
- 92
- 93
- 94
- 95
- 96
- 97
- 98
- 99
- 100
- 101
- 102
- 103
- 104
- 105
- 106
- 107
- 108
- 109
- 110
- 111
- 112
- 113
- 114
- 115
- 116
- 117
- 118
- 119
- 120
- 121
- 122
- 123
- 124
- 125
- 126
- 127
- 128
- 129
- 130
- 131
- 132
- 133
- 134
- 135
- 136
- 137
- 138
- 139
- 140
- 141
- 142
- 143
- 144
- 145
- 146
- 147
- 148
- 149
- 150
- 151
- 152
- 153
- 9999
description: (default = 0)
CountryCode:
type: string
FormattedBTWNumber:
type: string
required:
- Id
- Number
- Name
- Country
- CountryCode
- FormattedBTWNumber
description: (default = null)
nullable: true
type: object
ResponseId:
type: number
description: (default = 0)
RegistrationDate:
type: string
RequestTime:
type: string
Status:
x-enum-type: IntelliTracer.ApiV1.RegistrationQueueStatus
anyOf:
- type: number
enum:
- 0
- 1
- 2
- 4
- 8
- 16
- 32
- 64
- 128
- 256
- 512
- 1024
- 2048
- 4096
- type: string
enum:
- "1"
description: (default = 0)
CancelationReason:
x-enum-type: IntelliTracer.ApiV1.RegistrationCancelationReason
enum:
- 0
- 1
- 2
- 3
- 4
- null
description: (default = null)
nullable: true
type: number
RSZComment:
type: array
description: (default = [])
items: {}
required:
- Id
- RegistrationDate
- RequestTime
description: (default = null)
nullable: true
type: object
examples:
response:
value:
Data:
Id: 00000000-0000-0000-0000-000000000000
Person:
Id: 00000000-0000-0000-0000-000000000000
Code: "012345"
Name: John Doe
Type: 0
User:
Id: 00000000-0000-0000-0000-000000000000
Code: "012345"
Name: John Doe
Type: 0
Workplace:
Id: 00000000-0000-0000-0000-000000000000
DUC: ""
Code: "012345"
Name: GeoDynamics
RRNNumber: 79040205768
LimosaNumber: 11223344556677888
Btw:
Id: 00000000-0000-0000-0000-000000000000
Number: "123456789"
Name: GeoDynamics
Country: 0
CountryCode: BE
FormattedBTWNumber: BE-123456789
ResponseId: 10258
RegistrationDate: 2019-03-25T00:00:00
RequestTime: 2019-03-25T13:33:49+02:00
Status: "1"
CancelationReason: 0
RSZComment: []
"400":
description: BadRequest
headers: {}
content:
application/json:
schema:
type: array
items: {}
examples:
response:
value:
- Property: Name
Message: Required
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Create registration by Limosa
operationId: Create registration by Limosa
description: |-
Creates a new registration by Limosa number.
*Privilege required: `Api: Check In At Work`*
x-resource: Registrations
tags:
- Check In At Work
requestBody:
content:
application/json:
schema:
type: object
properties:
Date:
type: string
LimosaNumber:
type: number
WorkplaceDuc:
type: string
required:
- Date
- LimosaNumber
- WorkplaceDuc
example:
Date: 2019-01-01T00:00:00
LimosaNumber: 11223344556677888
WorkplaceDuc: 1Y100001AB1CD
security:
- pat: []
/api/v2/registration/byrrnbtw:
put:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Data:
properties:
Id:
type: string
Person:
properties:
Id:
type: string
Code:
description: (default = null)
nullable: true
type: string
Name:
type: string
Type:
type: number
x-enum-type: IntelliTracer.Domain.ResourceType
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
description: (default = 0)
required:
- Id
- Name
description: (default = null)
nullable: true
type: object
User:
properties:
Id:
type: string
Code:
description: (default = null)
nullable: true
type: string
Name:
type: string
Type:
type: number
x-enum-type: IntelliTracer.Domain.ResourceType
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
description: (default = 0)
required:
- Id
- Name
description: (default = null)
nullable: true
type: object
Workplace:
properties:
Id:
type: string
DUC:
type: string
Code:
description: (default = null)
nullable: true
type: string
Name:
description: (default = null)
nullable: true
type: string
required:
- Id
- DUC
description: (default = null)
nullable: true
type: object
RRNNumber:
type: number
description: (default = 0)
LimosaNumber:
type: number
description: (default = 0)
Btw:
properties:
Id:
type: string
Number:
type: string
Name:
type: string
Country:
type: number
x-enum-type: IntelliTracer.Domain.Country
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
- 47
- 48
- 49
- 50
- 51
- 52
- 53
- 54
- 55
- 56
- 57
- 58
- 59
- 60
- 61
- 62
- 63
- 64
- 65
- 66
- 67
- 68
- 69
- 70
- 71
- 72
- 73
- 74
- 75
- 76
- 77
- 78
- 79
- 80
- 81
- 82
- 83
- 84
- 85
- 86
- 87
- 88
- 89
- 90
- 91
- 92
- 93
- 94
- 95
- 96
- 97
- 98
- 99
- 100
- 101
- 102
- 103
- 104
- 105
- 106
- 107
- 108
- 109
- 110
- 111
- 112
- 113
- 114
- 115
- 116
- 117
- 118
- 119
- 120
- 121
- 122
- 123
- 124
- 125
- 126
- 127
- 128
- 129
- 130
- 131
- 132
- 133
- 134
- 135
- 136
- 137
- 138
- 139
- 140
- 141
- 142
- 143
- 144
- 145
- 146
- 147
- 148
- 149
- 150
- 151
- 152
- 153
- 9999
description: (default = 0)
CountryCode:
type: string
FormattedBTWNumber:
type: string
required:
- Id
- Number
- Name
- Country
- CountryCode
- FormattedBTWNumber
description: (default = null)
nullable: true
type: object
ResponseId:
type: number
description: (default = 0)
RegistrationDate:
type: string
RequestTime:
type: string
Status:
x-enum-type: IntelliTracer.ApiV1.RegistrationQueueStatus
anyOf:
- type: number
enum:
- 0
- 1
- 2
- 4
- 8
- 16
- 32
- 64
- 128
- 256
- 512
- 1024
- 2048
- 4096
- type: string
enum:
- "1"
description: (default = 0)
CancelationReason:
x-enum-type: IntelliTracer.ApiV1.RegistrationCancelationReason
enum:
- 0
- 1
- 2
- 3
- 4
- null
description: (default = null)
nullable: true
type: number
RSZComment:
type: array
description: (default = [])
items: {}
required:
- Id
- RegistrationDate
- RequestTime
description: (default = null)
nullable: true
type: object
examples:
response:
value:
Data:
Id: 00000000-0000-0000-0000-000000000000
Person:
Id: 00000000-0000-0000-0000-000000000000
Code: "012345"
Name: John Doe
Type: 0
User:
Id: 00000000-0000-0000-0000-000000000000
Code: "012345"
Name: John Doe
Type: 0
Workplace:
Id: 00000000-0000-0000-0000-000000000000
DUC: ""
Code: "012345"
Name: GeoDynamics
RRNNumber: 79040205768
LimosaNumber: 11223344556677888
Btw:
Id: 00000000-0000-0000-0000-000000000000
Number: "123456789"
Name: GeoDynamics
Country: 0
CountryCode: BE
FormattedBTWNumber: BE-123456789
ResponseId: 10258
RegistrationDate: 2019-03-25T00:00:00
RequestTime: 2019-03-25T13:33:49+02:00
Status: "1"
CancelationReason: 0
RSZComment: []
"400":
description: BadRequest
headers: {}
content:
application/json:
schema:
type: array
items: {}
examples:
response:
value:
- Property: Name
Message: Required
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Create registration by RRN and BTW
operationId: Create registration by RRN and BTW
description: |-
Creates a new registration by RRN and BTW number.
*Privilege required: `Api: Check In At Work`*
x-resource: Registrations
tags:
- Check In At Work
requestBody:
content:
application/json:
schema:
type: object
properties:
Date:
type: string
RrnNumber:
type: number
BtwNumber:
type: string
WorkplaceDuc:
type: string
required:
- Date
- RrnNumber
- BtwNumber
- WorkplaceDuc
example:
Date: 2019-01-01T00:00:00
RrnNumber: 79040205768
BtwNumber: BE-0000000000
WorkplaceDuc: 1Y100001AB1CD
security:
- pat: []
/api/v2/registration/bybis:
put:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Data:
properties:
Id:
type: string
Person:
properties:
Id:
type: string
Code:
description: (default = null)
nullable: true
type: string
Name:
type: string
Type:
type: number
x-enum-type: IntelliTracer.Domain.ResourceType
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
description: (default = 0)
required:
- Id
- Name
description: (default = null)
nullable: true
type: object
User:
properties:
Id:
type: string
Code:
description: (default = null)
nullable: true
type: string
Name:
type: string
Type:
type: number
x-enum-type: IntelliTracer.Domain.ResourceType
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
description: (default = 0)
required:
- Id
- Name
description: (default = null)
nullable: true
type: object
Workplace:
properties:
Id:
type: string
DUC:
type: string
Code:
description: (default = null)
nullable: true
type: string
Name:
description: (default = null)
nullable: true
type: string
required:
- Id
- DUC
description: (default = null)
nullable: true
type: object
RRNNumber:
type: number
description: (default = 0)
LimosaNumber:
type: number
description: (default = 0)
Btw:
properties:
Id:
type: string
Number:
type: string
Name:
type: string
Country:
type: number
x-enum-type: IntelliTracer.Domain.Country
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
- 47
- 48
- 49
- 50
- 51
- 52
- 53
- 54
- 55
- 56
- 57
- 58
- 59
- 60
- 61
- 62
- 63
- 64
- 65
- 66
- 67
- 68
- 69
- 70
- 71
- 72
- 73
- 74
- 75
- 76
- 77
- 78
- 79
- 80
- 81
- 82
- 83
- 84
- 85
- 86
- 87
- 88
- 89
- 90
- 91
- 92
- 93
- 94
- 95
- 96
- 97
- 98
- 99
- 100
- 101
- 102
- 103
- 104
- 105
- 106
- 107
- 108
- 109
- 110
- 111
- 112
- 113
- 114
- 115
- 116
- 117
- 118
- 119
- 120
- 121
- 122
- 123
- 124
- 125
- 126
- 127
- 128
- 129
- 130
- 131
- 132
- 133
- 134
- 135
- 136
- 137
- 138
- 139
- 140
- 141
- 142
- 143
- 144
- 145
- 146
- 147
- 148
- 149
- 150
- 151
- 152
- 153
- 9999
description: (default = 0)
CountryCode:
type: string
FormattedBTWNumber:
type: string
required:
- Id
- Number
- Name
- Country
- CountryCode
- FormattedBTWNumber
description: (default = null)
nullable: true
type: object
ResponseId:
type: number
description: (default = 0)
RegistrationDate:
type: string
RequestTime:
type: string
Status:
x-enum-type: IntelliTracer.ApiV1.RegistrationQueueStatus
anyOf:
- type: number
enum:
- 0
- 1
- 2
- 4
- 8
- 16
- 32
- 64
- 128
- 256
- 512
- 1024
- 2048
- 4096
- type: string
enum:
- "1"
description: (default = 0)
CancelationReason:
x-enum-type: IntelliTracer.ApiV1.RegistrationCancelationReason
enum:
- 0
- 1
- 2
- 3
- 4
- null
description: (default = null)
nullable: true
type: number
RSZComment:
type: array
description: (default = [])
items: {}
required:
- Id
- RegistrationDate
- RequestTime
description: (default = null)
nullable: true
type: object
examples:
response:
value:
Data:
Id: 00000000-0000-0000-0000-000000000000
Person:
Id: 00000000-0000-0000-0000-000000000000
Code: "012345"
Name: John Doe
Type: 0
User:
Id: 00000000-0000-0000-0000-000000000000
Code: "012345"
Name: John Doe
Type: 0
Workplace:
Id: 00000000-0000-0000-0000-000000000000
DUC: ""
Code: "012345"
Name: GeoDynamics
RRNNumber: 79040205768
LimosaNumber: 11223344556677888
Btw:
Id: 00000000-0000-0000-0000-000000000000
Number: "123456789"
Name: GeoDynamics
Country: 0
CountryCode: BE
FormattedBTWNumber: BE-123456789
ResponseId: 10258
RegistrationDate: 2019-03-25T00:00:00
RequestTime: 2019-03-25T13:33:49+02:00
Status: "1"
CancelationReason: 0
RSZComment: []
"400":
description: BadRequest
headers: {}
content:
application/json:
schema:
type: array
items: {}
examples:
response:
value:
- Property: Name
Message: Required
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Create registration by BIS
operationId: Create registration by BIS
description: |-
Creates a new registration by BIS number.
*Privilege required: `Api: Check In At Work`*
x-resource: Registrations
tags:
- Check In At Work
requestBody:
content:
application/json:
schema:
type: object
properties:
Date:
type: string
BisNumber:
type: number
WorkplaceDuc:
type: string
required:
- Date
- BisNumber
- WorkplaceDuc
example:
Date: 2019-01-01T00:00:00
BisNumber: 79040205768
WorkplaceDuc: 1Y100001AB1CD
security:
- pat: []
"/api/v2/registration/{id}/cancellation":
put:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Data:
properties:
Id:
type: string
Person:
properties:
Id:
type: string
Code:
description: (default = null)
nullable: true
type: string
Name:
type: string
Type:
type: number
x-enum-type: IntelliTracer.Domain.ResourceType
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
description: (default = 0)
required:
- Id
- Name
description: (default = null)
nullable: true
type: object
User:
properties:
Id:
type: string
Code:
description: (default = null)
nullable: true
type: string
Name:
type: string
Type:
type: number
x-enum-type: IntelliTracer.Domain.ResourceType
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
description: (default = 0)
required:
- Id
- Name
description: (default = null)
nullable: true
type: object
Workplace:
properties:
Id:
type: string
DUC:
type: string
Code:
description: (default = null)
nullable: true
type: string
Name:
description: (default = null)
nullable: true
type: string
required:
- Id
- DUC
description: (default = null)
nullable: true
type: object
RRNNumber:
type: number
description: (default = 0)
LimosaNumber:
type: number
description: (default = 0)
Btw:
properties:
Id:
type: string
Number:
type: string
Name:
type: string
Country:
type: number
x-enum-type: IntelliTracer.Domain.Country
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
- 47
- 48
- 49
- 50
- 51
- 52
- 53
- 54
- 55
- 56
- 57
- 58
- 59
- 60
- 61
- 62
- 63
- 64
- 65
- 66
- 67
- 68
- 69
- 70
- 71
- 72
- 73
- 74
- 75
- 76
- 77
- 78
- 79
- 80
- 81
- 82
- 83
- 84
- 85
- 86
- 87
- 88
- 89
- 90
- 91
- 92
- 93
- 94
- 95
- 96
- 97
- 98
- 99
- 100
- 101
- 102
- 103
- 104
- 105
- 106
- 107
- 108
- 109
- 110
- 111
- 112
- 113
- 114
- 115
- 116
- 117
- 118
- 119
- 120
- 121
- 122
- 123
- 124
- 125
- 126
- 127
- 128
- 129
- 130
- 131
- 132
- 133
- 134
- 135
- 136
- 137
- 138
- 139
- 140
- 141
- 142
- 143
- 144
- 145
- 146
- 147
- 148
- 149
- 150
- 151
- 152
- 153
- 9999
description: (default = 0)
CountryCode:
type: string
FormattedBTWNumber:
type: string
required:
- Id
- Number
- Name
- Country
- CountryCode
- FormattedBTWNumber
description: (default = null)
nullable: true
type: object
ResponseId:
type: number
description: (default = 0)
RegistrationDate:
type: string
RequestTime:
type: string
Status:
x-enum-type: IntelliTracer.ApiV1.RegistrationQueueStatus
anyOf:
- type: number
enum:
- 0
- 1
- 2
- 4
- 8
- 16
- 32
- 64
- 128
- 256
- 512
- 1024
- 2048
- 4096
- type: string
enum:
- "1"
description: (default = 0)
CancelationReason:
x-enum-type: IntelliTracer.ApiV1.RegistrationCancelationReason
enum:
- 0
- 1
- 2
- 3
- 4
- null
description: (default = null)
nullable: true
type: number
RSZComment:
type: array
description: (default = [])
items: {}
required:
- Id
- RegistrationDate
- RequestTime
description: (default = null)
nullable: true
type: object
examples:
response:
value:
Data:
Id: 00000000-0000-0000-0000-000000000000
Person:
Id: 00000000-0000-0000-0000-000000000000
Code: "012345"
Name: John Doe
Type: 0
User:
Id: 00000000-0000-0000-0000-000000000000
Code: "012345"
Name: John Doe
Type: 0
Workplace:
Id: 00000000-0000-0000-0000-000000000000
DUC: ""
Code: "012345"
Name: GeoDynamics
RRNNumber: 79040205768
LimosaNumber: 11223344556677888
Btw:
Id: 00000000-0000-0000-0000-000000000000
Number: "123456789"
Name: GeoDynamics
Country: 0
CountryCode: BE
FormattedBTWNumber: BE-123456789
ResponseId: 10258
RegistrationDate: 2019-03-25T00:00:00
RequestTime: 2019-03-25T13:33:49+02:00
Status: "1"
CancelationReason: 0
RSZComment: []
"400":
description: BadRequest
headers: {}
content:
application/json:
schema:
type: array
items: {}
examples:
response:
value:
- Property: Name
Message: Required
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"404":
description: NotFound
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Cancel registration
operationId: Cancel registration
description: |-
Cancels a registration.
*Privilege required: `Api: Check In At Work`*
x-resource: Registrations
tags:
- Check In At Work
parameters:
- name: id
in: path
description: ""
required: true
example: 00000000-0000-0000-0000-000000000000
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
properties:
CancelationReason:
x-enum-type: IntelliTracer.ApiV1.RegistrationCancelationReason
enum:
- 0
- 1
- 2
- 3
- 4
- null
description: (default = null)
nullable: true
type: number
example:
CancelationReason: 0
security:
- pat: []
"/api/v2/maintenance?page={page}&search={search}":
get:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Data:
description: (default = null)
nullable: true
type: array
items: {}
PagingFilter:
properties:
Page:
type: number
Search:
nullable: true
type: string
PageCount:
type: number
TotalCount:
type: number
Links:
type: object
properties:
Base:
type: string
First:
type: string
Prev:
type: string
Next:
type: string
Last:
type: string
required:
- Base
required:
- Page
- PageCount
- TotalCount
- Links
description: (default = null)
nullable: true
type: object
examples:
response:
value:
Data:
- Vehicle:
Id: 00000000-0000-0000-0000-000000000000
Code: "012345"
Name: Vehicle 1
State: 0
Mileage: 48145
RunningHours: 774
Timestamp: 2021-01-10T11:16:51+01:00
Tasks:
- Id: 00000000-0000-0000-0000-000000000000
Name:
Id: 00000000-0000-0000-0000-000000000000
Name: Vehicle 1
Type: 0
MileageConfig:
FixedDeadline: 100000
IntervalDeadline: 50000
Warning: 1000
RunningHoursConfig:
FixedDeadline: 1000
IntervalDeadline: 500
Warning: 10
DateConfig:
FixedDeadline: 2021-06-30T00:00:00
IntervalDeadline:
Years: 1
Months: 6
Days: 30
Warning: 30
DeadlineNotificationRecurrence: 0
WarningNotificationRecurrence: 0
PagingFilter:
Page: 1
Search: ABC
PageCount: 4
TotalCount: 100
Links:
Base: https://api.intellitracer.be
First: /api/v2/asset?page=1
Prev: /api/v2/asset?page=2
Next: /api/v2/asset?page=4
Last: /api/v2/asset?page=4
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Get maintenance overview
operationId: Get maintenance overview
description: |-
Returns a paged list of maintenance tasks per vehicle.
*Privilege required: `Api: Maintenance overview`*
x-resource: Maintenance overview
tags:
- Maintenance
parameters:
- name: page
in: path
description: ""
required: true
example: "1"
schema:
type: number
- name: search
in: path
description: ""
required: true
example: ABC
schema:
type: string
security:
- pat: []
"/api/v2/maintenance/{vehicleId}/task?page={page}&search={search}":
get:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Data:
description: (default = null)
nullable: true
type: array
items: {}
PagingFilter:
properties:
Page:
type: number
Search:
nullable: true
type: string
PageCount:
type: number
TotalCount:
type: number
Links:
type: object
properties:
Base:
type: string
First:
type: string
Prev:
type: string
Next:
type: string
Last:
type: string
required:
- Base
required:
- Page
- PageCount
- TotalCount
- Links
description: (default = null)
nullable: true
type: object
examples:
response:
value:
Data:
- Id: 00000000-0000-0000-0000-000000000000
Name:
Id: 00000000-0000-0000-0000-000000000000
Name: Vehicle 1
Type: 0
MileageConfig:
FixedDeadline: 100000
IntervalDeadline: 50000
Warning: 1000
RunningHoursConfig:
FixedDeadline: 1000
IntervalDeadline: 500
Warning: 10
DateConfig:
FixedDeadline: 2021-06-30T00:00:00
IntervalDeadline:
Years: 1
Months: 6
Days: 30
Warning: 30
DeadlineNotificationRecurrence: 0
WarningNotificationRecurrence: 0
PagingFilter:
Page: 1
Search: ABC
PageCount: 4
TotalCount: 100
Links:
Base: https://api.intellitracer.be
First: /api/v2/asset?page=1
Prev: /api/v2/asset?page=2
Next: /api/v2/asset?page=4
Last: /api/v2/asset?page=4
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"404":
description: NotFound
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Get maintenance task by vehicle
operationId: Get maintenance task by vehicle
description: |-
Returns a paged list of maintenance tasks for a specific vehicle.
*Privilege required: `Api: Maintenance overview`*
x-resource: Maintenance tasks by vehicle
tags:
- Maintenance
parameters:
- name: vehicleId
in: path
description: ""
required: true
example: 00000000-0000-0000-0000-000000000000
schema:
type: string
- name: page
in: path
description: ""
required: true
example: "1"
schema:
type: number
- name: search
in: path
description: ""
required: true
example: ABC
schema:
type: string
security:
- pat: []
"/api/v2/maintenance/type?page={page}&search={search}":
get:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
$ref: "#/components/schemas/IntelliTracer.ApiV2.PagedVehicleMaintenanceLabelResponse"
examples:
response:
value:
Data:
- Id: 00000000-0000-0000-0000-000000000000
Name: Vehicle 1
PagingFilter:
Page: 1
Search: ABC
PageCount: 4
TotalCount: 100
Links:
Base: https://api.intellitracer.be
First: /api/v2/asset?page=1
Prev: /api/v2/asset?page=2
Next: /api/v2/asset?page=4
Last: /api/v2/asset?page=4
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Get maintenance types
operationId: Get maintenance types
description: |-
Returns a paged list of maintenance types.
*Privilege required: `Api: Maintenance overview`*
x-resource: Maintenance types
tags:
- Maintenance
parameters:
- name: page
in: path
description: ""
required: true
example: "1"
schema:
type: number
- name: search
in: path
description: ""
required: true
example: ABC
schema:
type: string
security:
- pat: []
"/api/v1/vehiclecounters?defaultsOnly={defaultsOnly}":
post:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/IntelliTracer.ApiV1.VehicleCounterModel"
examples:
response:
value:
- Vehicle:
Id: 00000000-0000-0000-0000-000000000000
Name: Vehicle 1
Code: "012345"
LastReportDateTime: 2019-03-19T11:45:47+01:00
VehicleCounterData:
- Id: 00000000-0000-0000-0000-000000000000
CounterName: Counter 1
CounterValue: 48145
IsDefault: false
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Get vehicle counters
operationId: Get vehicle counters
description: >-
Returns a list of vehicle counters for one or more vehicles, optionally
filtered by default template counters only.
Vehicle counters are calculated until the last tracking report.
*Privilege required: `Api: vehicle counters`*
x-resource: Vehicle counters
tags:
- Vehicle counters
parameters:
- name: defaultsOnly
in: path
description: ""
required: true
example: "true"
schema:
type: boolean
requestBody:
content:
application/json:
schema:
type: array
items:
type: string
example:
- 00000000-0000-0000-0000-000000000000
- 00000000-0000-0000-0000-000000000000
security:
- pat: []
/api/v1/eco/speedings:
post:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/IntelliTracer.ApiV1.Speeding"
examples:
response:
value:
- DateTime: 2019-03-12T11:00:51+01:00
VehicleId: 00000000-0000-0000-0000-000000000000
VehicleName: Vehicle 1
VehicleLicensePlate: 1-ABC-123
DriverId: 00000000-0000-0000-0000-000000000000
DriverName: John Doe
Speed: 121
MaxSpeed: 100
Fine: 65
Revocation: false
TooltipEn: null
TooltipFr: null
TooltipNl: null
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Get Speedings
operationId: Get Speedings
description: >-
Returns a list of all speedings by users or vehicles within a date/time
range. Provide either some user id's or vehicle id's to identify
resources.
*Privilege required: `Api: Eco speeding`*
x-resource: Eco - Speedings
tags:
- Fleet
requestBody:
content:
application/json:
schema:
type: object
properties:
From:
type: string
To:
type: string
UserIds:
description: (default = [])
nullable: true
type: array
items: {}
VehicleIds:
description: (default = [])
nullable: true
type: array
items: {}
required:
- From
- To
example:
From: 2019-01-01T00:00:00+01:00
To: 2019-01-31T23:59:59+01:00
UserIds:
- 00000000-0000-0000-0000-000000000000
- 00000000-0000-0000-0000-000000000000
VehicleIds:
- 00000000-0000-0000-0000-000000000000
- 00000000-0000-0000-0000-000000000000
security:
- pat: []
/api/v1/eco/driveridentification:
post:
responses:
"200":
description: OK
headers: {}
"400":
description: BadRequest
headers: {}
content:
application/json:
schema:
type: object
properties:
UserCode:
type: string
VehicleCode:
type: string
StartDateTime:
type: string
required:
- UserCode
- VehicleCode
- StartDateTime
examples:
response:
value:
UserCode: "012345"
VehicleCode: "012345"
StartDateTime: 2019-03-12T11:00:51+01:00
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
"500":
description: InternalServerError
headers: {}
summary: Create driver identification
operationId: Create driver identification
description: |-
Creates a new driver identification.
*Privilege required: `Api: Eco driveridentfication`*
x-resource: Eco - Driver identifications
tags:
- Fleet
requestBody:
content:
application/json:
schema:
type: object
properties:
UserCode:
type: string
VehicleCode:
type: string
StartDateTime:
type: string
required:
- UserCode
- VehicleCode
- StartDateTime
example:
UserCode: "012345"
VehicleCode: "012345"
StartDateTime: 2019-03-12T11:00:51+01:00
security:
- pat: []
/api/v1/eco/importfueltransactions:
post:
responses:
"200":
description: OK
headers: {}
"400":
description: BadRequest
headers: {}
content:
application/json:
schema:
type: array
items: {}
examples:
response:
value:
- Entity:
TrackingDeviceId: "1000000000"
TransactionNumber: "1"
Timestamp: 2019-01-23T04:56:07
Liters: 65.5
Price: 70.4
Source: "1000"
Mileage: 1245.4
ValidationResult:
- Message: ""
SourceMemberNames: []
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Import fuel transactions
operationId: Import fuel transactions
description: |-
Imports one or more fuel transactions.
*Privilege required: `Api: Eco import fuel transactions`*
x-resource: Eco - Import fuel transactions
tags:
- Fleet
requestBody:
content:
application/json:
schema:
type: object
properties:
FuelTransactions:
type: array
description: (default = [])
items: {}
example:
FuelTransactions:
- TrackingDeviceId: "1000000000"
TransactionNumber: "1"
Timestamp: 2019-01-23T04:56:07
Liters: 65.5
Price: 70.4
Source: "1000"
Mileage: 1245.4
security:
- pat: []
/api/v1/fleet/fueltransactions:
post:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/IntelliTracer.ApiV1.FuelTransaction"
examples:
response:
value:
- DateTime: 2019-01-25T08:29:37
FuelTank:
Id: 00000000-0000-0000-0000-000000000000
Name: Tank
Capacity: 1500
Limit: 1500
CurrentLevel: 1500
FuelType: 1
FuelTypeName: Diesel
FuelPump:
Id: 00000000-0000-0000-0000-000000000000
Name: Pump
Code: "1500"
FuelType: 1
FuelTypeName: Diesel
Type: 1
TypeName: VehicleCode_Info
User:
Id: 00000000-0000-0000-0000-000000000000
Name: John Doe
Code: "012345"
Vehicle:
Id: 00000000-0000-0000-0000-000000000000
Name: Vehicle 1
Code: "012345"
LicensePlate: 1-ABC-123
TransactionNumber: "00000000"
Price: 10
Liters: 10
KmVehicle: 10
KmUser: 10
KmDriven: 0
AvgConsumption: 0
Type: Bijtanken
Info: ""
VehicleIdentification: "500145"
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Get fuel transactions
operationId: Get fuel transactions
description: >-
Returns a list of fuel transactions, optionally filtered by users,
vehicles, fuel pumps and/or fuel tanks.
*Privilege required: `Api: Fleet`*
x-resource: Fleet - Fuel transactions
tags:
- Fleet
parameters:
- name: fromDate
in: query
description: ""
required: true
example: 2019-01-17T00:00:00
schema:
type: string
- name: toDate
in: query
description: ""
required: true
example: 2019-01-18T23:59:59
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
properties:
Users:
description: (default = [])
nullable: true
type: array
items: {}
Resources:
description: (default = [])
nullable: true
type: array
items: {}
Tanks:
description: (default = [])
nullable: true
type: array
items: {}
Pumps:
description: (default = [])
nullable: true
type: array
items: {}
UnlinkedTransactions:
type: boolean
description: (default = false)
example:
Users:
- 00000000-0000-0000-0000-000000000000
- 00000000-0000-0000-0000-000000000000
Resources:
- 00000000-0000-0000-0000-000000000000
- 00000000-0000-0000-0000-000000000000
Tanks:
- 00000000-0000-0000-0000-000000000000
- 00000000-0000-0000-0000-000000000000
Pumps:
- 00000000-0000-0000-0000-000000000000
- 00000000-0000-0000-0000-000000000000
UnlinkedTransactions: false
security:
- pat: []
"/api/v2/fuelsensors?page={page}&search={search}":
get:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Data:
nullable: true
type: array
items: {}
PagingFilter:
properties:
Page:
type: number
Search:
nullable: true
type: string
PageCount:
type: number
TotalCount:
type: number
Links:
type: object
properties:
Base:
type: string
First:
type: string
Prev:
type: string
Next:
type: string
Last:
type: string
required:
- Base
required:
- Page
- PageCount
- TotalCount
- Links
nullable: true
type: object
examples:
response:
value:
Data:
- Id: 00000000-0000-0000-0000-000000000000
Name: Name
FuelSensorType: 0
FuelType: 0
LatestMeasurement: 2021-07-12T08:29:37+02:00
CurrentLevel: 25
CurrentVolume: 686
MaximumVolume: 2541
Longitude: 50.45161
Latitude: 3.45161
StationName: StationName
Batterylevel: 95
Low: 210
High: 2000
PagingFilter:
Page: 1
Search: ABC
PageCount: 4
TotalCount: 100
Links:
Base: https://api.intellitracer.be
First: /api/v2/asset?page=1
Prev: /api/v2/asset?page=2
Next: /api/v2/asset?page=4
Last: /api/v2/asset?page=4
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Get fuel sensors
operationId: Get fuel sensors
description: |-
Returns a paged list of fuelsensors.
Pagination and searching is explained in [Pagination](#pagination).
*Privilege required: `Api: Fleet`*
x-resource: Fleet - Fuel sensors
tags:
- Fleet
parameters:
- name: page
in: path
description: ""
required: true
example: "1"
schema:
type: number
- name: search
in: path
description: ""
required: true
example: ABC
schema:
type: string
security:
- pat: []
/api/v1/fleet/vehicleusagegetbyuseridsdaterange:
post:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/IntelliTracer.ApiV1.VehicleUsagePerUser"
examples:
response:
value:
- User:
Id: 00000000-0000-0000-0000-000000000000
Name: John Doe
Code: "012345"
EmployerCode: "012345"
Email: john.doe@doe.com
Gsm: "+32477665544"
FreeField1: null
FreeField2: null
FreeField3: null
FreeField4: null
FreeField5: null
FreeField6: null
Notes: null
Street: Dumolinlaan
HouseNumber: "9"
City: Kortrijk
PostalCode: "8500"
Submunicipality: Kortrijk
Country: 0
Longitude: 3.245304
Latitude: 50.812939
DefaultDayProgram:
Id: 00000000-0000-0000-0000-000000000000
Name: Default
Groups:
- Id: 00000000-0000-0000-0000-000000000000
Name: Employees
Type: 0
Code: "012345"
Days:
- Date: 2019-01-17T00:00:00
VehicleUsages:
- Vehicle:
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"
MileageTotal: 236.5
TotalPowerLost: 0
Mileage: 5650.406
Clockings:
- User:
Id: 00000000-0000-0000-0000-000000000000
Name: John Doe
Code: "012345"
EmployerCode: "012345"
Email: john.doe@doe.com
Gsm: "+32477665544"
FreeField1: null
FreeField2: null
FreeField3: null
FreeField4: null
FreeField5: null
FreeField6: null
Notes: null
Street: Dumolinlaan
HouseNumber: "9"
City: Kortrijk
PostalCode: "8500"
Submunicipality: Kortrijk
Country: 0
Longitude: 3.245304
Latitude: 50.812939
DefaultDayProgram:
Id: 00000000-0000-0000-0000-000000000000
Name: Default
Groups:
- Id: 00000000-0000-0000-0000-000000000000
Name: Employees
Type: 0
Code: "012345"
DateTime: 2019-01-17T06:02:03+01:00
Stops:
- Location: Dumolinlaan 9, 8500 Kortrijk [Kortrijk], BE
Pois:
- Id: 00000000-0000-0000-0000-000000000000
Name: Work
From: 2019-01-17T06:57:53+01:00
To: 2019-01-17T08:41:43+01:00
Drivings:
- From: 2019-01-17T06:57:53+01:00
To: 2019-01-17T08:41:43+01:00
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Get vehicle usage
operationId: Get vehicle usage
description: |-
Returns a list of vehicle usages by person.
*Privilege required: `Api: Fleet`*
x-resource: Fleet - Vehicle usage
tags:
- Fleet
parameters:
- name: fromDate
in: query
description: ""
required: true
example: 2019-01-17T00:00:00+01:00
schema:
type: string
- name: toDate
in: query
description: ""
required: true
example: 2019-01-18T23:59:59+01:00
schema:
type: string
- name: includeClockings
in: query
description: ""
required: false
example: "false"
schema:
type: boolean
- name: includeStops
in: query
description: ""
required: false
example: "false"
schema:
type: boolean
- name: includeDrivings
in: query
description: ""
required: false
example: "false"
schema:
type: boolean
requestBody:
content:
application/json:
schema:
type: array
items:
type: string
example:
- 00000000-0000-0000-0000-000000000000
- 00000000-0000-0000-0000-000000000000
security:
- pat: []
/api/v1/fleet/vehiclewithdriver:
post:
responses:
"200":
description: OK
headers: {}
"400":
description: BadRequest
headers: {}
content:
application/json:
schema:
type: object
properties:
Entity:
type: object
properties:
TrackingDeviceId:
type: string
description: The unique vehicle unit id.
VehicleName:
type: string
Licenseplate:
description: (default = null)
nullable: true
type: string
Vin:
description: (default = null)
nullable: true
type: string
FuelType:
type: string
x-enumDescriptions:
"ppo": Ppo
"p": Gasoline
"lpg": LPG
"e": Electricity
"d": Diesel
"cng": Cng
enum:
- ppo
- p
- lpg
- e
- d
- cng
FuelConsumption:
type: number
description: (default = 0.0)
UserName:
type: string
UserCode:
type: string
description: The user and user group code seperated by `/`.
DriverStart:
type: string
required:
- TrackingDeviceId
- VehicleName
- FuelType
- UserName
- UserCode
- DriverStart
ValidationResult:
type: array
items: {}
required:
- Entity
- ValidationResult
examples:
response:
value:
Entity:
TrackingDeviceId: "1000000000"
VehicleName: Vehicle 1
Licenseplate: 1-ABC-123
Vin: ABCDE01234F567890
FuelType: d
FuelConsumption: 5.5
UserName: John Doe
UserCode: 012345/9876
DriverStart: 2019-01-24T17:00:00
ValidationResult:
- Message: ""
SourceMemberNames: []
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
"500":
description: InternalServerError
headers: {}
summary: Update vehicle and create driver identification
operationId: Update vehicle and create driver identification
description: >-
Updates a vehicle by tracking device unit id and creates a new driver
identification by user code.
If necessary, a new user and/or user group is created before creating a driver identification.
*Privilege required: `Api: Fleet`*
x-resource: Fleet - Vehicle with driver identification
tags:
- Fleet
requestBody:
content:
application/json:
schema:
type: object
properties:
TrackingDeviceId:
type: string
description: The unique vehicle unit id.
VehicleName:
type: string
Licenseplate:
description: (default = null)
nullable: true
type: string
Vin:
description: (default = null)
nullable: true
type: string
FuelType:
type: string
x-enumDescriptions:
"ppo": Ppo
"p": Gasoline
"lpg": LPG
"e": Electricity
"d": Diesel
"cng": Cng
enum:
- ppo
- p
- lpg
- e
- d
- cng
FuelConsumption:
type: number
description: (default = 0.0)
UserName:
type: string
UserCode:
type: string
description: The user and user group code seperated by `/`.
DriverStart:
type: string
required:
- TrackingDeviceId
- VehicleName
- FuelType
- UserName
- UserCode
- DriverStart
example:
TrackingDeviceId: "1000000000"
VehicleName: Vehicle 1
Licenseplate: 1-ABC-123
Vin: ABCDE01234F567890
FuelType: d
FuelConsumption: 5.5
UserName: John Doe
UserCode: 012345/9876
DriverStart: 2019-01-24T17:00:00
security:
- pat: []
"/api/v2/transportticketsbydate?date={date}":
get:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
Data:
description: (default = null)
nullable: true
type: array
items: {}
ValidationResult:
type: array
items: {}
required:
- ValidationResult
examples:
response:
value:
Data:
- Id: 00000000-0000-0000-0000-000000000000
TransportTicketUser:
Id: 00000000-0000-0000-0000-000000000000
Name: John Doe
UserTypes:
- 0
VehicleType:
Id: 00000000-0000-0000-0000-000000000000
Name: Vehicle Type
InternalCode: "0123456789"
Email: johndoe@company.com
PhoneNumber: "+32123456789"
TransportTicketCompany:
Id: 00000000-0000-0000-0000-000000000000
Name: John Doe
Vat: "0123456789"
Email: johndoe@company.com
Date: 2021-07-12T08:29:37
Pause:
Enabled: true
Value: 01:00:00
Remark: remark
Return:
Enabled: true
Value: 01:00:00
Remark: remark
Total: 01:00:00
TransporterInfo:
AlreadyLoaded: true
Mileage: 107
CreationTime: 2021-07-12T08:29:37
Registrations:
- Id: 00000000-0000-0000-0000-000000000000
Type: 0
Remark: remark
Arrival: 2021-07-12T08:29:37
Departure: 2021-07-12T08:29:37
SubmitTimeStamp: 2021-07-12T08:29:37
Poi:
Id: 00000000-0000-0000-0000-000000000000
Name: Work
Code: "012345"
WorkplaceNumber: "12345"
StartReference: {}
TransporterInfo:
MachineNumber: "12345"
Counter: 107
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
TransportTicketUserType: 0
ValidationResult:
- Message: ""
SourceMemberNames: []
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Get transport tickets by date
operationId: Get transport tickets by date
description: |-
Returns a list of all the tickets from the given date.
*Privilege required: `Api: Transport tickets`*
x-resource: Fleet - Transport tickets
tags:
- Fleet
parameters:
- name: date
in: path
description: ""
required: true
example: 2020-01-01
schema:
type: string
security:
- pat: []
/api/v1/mobileclocking/optionlist:
get:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/IntelliTracer.ApiV1.MobileClockingNode"
examples:
response:
value:
- 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
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Get option lists
operationId: Get option lists
description: |-
Returns a list of all option lists.
*Privilege required: `Api: Mobile Application Configs`*
x-resource: Mobile clockings - Option lists
tags:
- Smartphone
security:
- pat: []
put:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
$ref: "#/components/schemas/IntelliTracer.ApiV1.MobileClockingNode"
examples:
response:
value:
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
"400":
description: BadRequest
headers: {}
content:
application/json:
schema:
type: object
properties:
Entity:
type: object
properties:
Id:
type: string
Name_Nl:
description: (default = null)
nullable: true
type: string
Name_Fr:
description: (default = null)
nullable: true
type: string
Name_En:
description: (default = null)
nullable: true
type: string
Name_Pl:
description: (default = null)
nullable: true
type: string
Type:
type: number
x-enum-type: IntelliTracer.ApiV1.MobileClockingNodeType
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
description: >-
(default = 0)
Type of the mobile clocking node (folder or jobnumber).
FilterText:
description: >-
(default = null)
Filters the visible mobile clocking nodes based on what's in the "Filter/IVR code" field in the config of the logged in user. Only nodes in which that field matches the FilterText will be visible for that user.
nullable: true
type: string
Prefix:
description: >-
(default = null)
This prefix will automatically be added in front of the jobnumber entered by the user.
nullable: true
type: string
JobNumber:
description: >-
(default = null)
Job number used for postcalculation or activity based timeregistration
nullable: true
type: string
Regex:
description: >-
(default = null)
A jobnumber entered by the user will only be accepted if it matches this regex.
nullable: true
type: string
InputFilter:
type: number
x-enum-type: IntelliTracer.ApiV1.MobileClockingNodeInputFilter
enum:
- 0
- 1
- 2
- 3
description: >-
(default = 0)
What kind of input is allowed (free input, only numbers, or hexadecimal).
InputType:
type: number
x-enum-type: IntelliTracer.ApiV1.MenuJobInputType
enum:
- 0
- 1
- 2
description: >-
(default = 0)
What type of input is allowed (scanning, manual entry or both).
ClockingType:
x-enum-type: IntelliTracer.Domain.ClockingType
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- null
description: >-
(default = null)
Type of the clocking to be generated (see options below).
nullable: true
type: number
Children:
description: >-
(default = null)
Only for folders. Children of this mobile clocking node.
nullable: true
type: array
items: {}
PoiGroupId:
nullable: true
type: string
PoiRequired:
type: boolean
description: (default = false)
ValidatePoiCode:
type: boolean
description: (default = false)
CostCenterGroupId:
nullable: true
type: string
CostCenterRequired:
type: boolean
description: (default = false)
ValidateCostCenterCode:
type: boolean
description: (default = false)
ExternalCode:
description: (default = null)
nullable: true
type: string
ExternalType:
x-enum-type: IntelliTracer.Domain.ExternalClockingType
enum:
- 0
- 1
- 2
- null
description: (default = null)
nullable: true
type: number
_typeDescriptor:
type: string
required:
- Id
ValidationResult:
type: array
items: {}
required:
- Entity
- ValidationResult
examples:
response:
value:
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: []
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Create option list
operationId: Create option list
description: |-
Creates a new option list.
*Privilege required: `Api: Mobile Application Configs`*
x-resource: Mobile clockings - Option lists
tags:
- Smartphone
requestBody:
content:
application/json:
schema:
type: object
properties:
Name_Nl:
description: (default = null)
nullable: true
type: string
Name_Fr:
description: (default = null)
nullable: true
type: string
Name_En:
description: (default = null)
nullable: true
type: string
Name_Pl:
description: (default = null)
nullable: true
type: string
_typeDescriptor:
type: string
required:
- Name_Nl
example:
? Name_Nl
? Name_Fr
? Name_En
? Name_Pl
security:
- pat: []
post:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
$ref: "#/components/schemas/IntelliTracer.ApiV1.MobileClockingNode"
examples:
response:
value:
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
"400":
description: BadRequest
headers: {}
content:
application/json:
schema:
type: object
properties:
Entity:
type: object
properties:
Id:
type: string
Name_Nl:
description: (default = null)
nullable: true
type: string
Name_Fr:
description: (default = null)
nullable: true
type: string
Name_En:
description: (default = null)
nullable: true
type: string
Name_Pl:
description: (default = null)
nullable: true
type: string
Type:
type: number
x-enum-type: IntelliTracer.ApiV1.MobileClockingNodeType
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
description: >-
(default = 0)
Type of the mobile clocking node (folder or jobnumber).
FilterText:
description: >-
(default = null)
Filters the visible mobile clocking nodes based on what's in the "Filter/IVR code" field in the config of the logged in user. Only nodes in which that field matches the FilterText will be visible for that user.
nullable: true
type: string
Prefix:
description: >-
(default = null)
This prefix will automatically be added in front of the jobnumber entered by the user.
nullable: true
type: string
JobNumber:
description: >-
(default = null)
Job number used for postcalculation or activity based timeregistration
nullable: true
type: string
Regex:
description: >-
(default = null)
A jobnumber entered by the user will only be accepted if it matches this regex.
nullable: true
type: string
InputFilter:
type: number
x-enum-type: IntelliTracer.ApiV1.MobileClockingNodeInputFilter
enum:
- 0
- 1
- 2
- 3
description: >-
(default = 0)
What kind of input is allowed (free input, only numbers, or hexadecimal).
InputType:
type: number
x-enum-type: IntelliTracer.ApiV1.MenuJobInputType
enum:
- 0
- 1
- 2
description: >-
(default = 0)
What type of input is allowed (scanning, manual entry or both).
ClockingType:
x-enum-type: IntelliTracer.Domain.ClockingType
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- null
description: >-
(default = null)
Type of the clocking to be generated (see options below).
nullable: true
type: number
Children:
description: >-
(default = null)
Only for folders. Children of this mobile clocking node.
nullable: true
type: array
items: {}
PoiGroupId:
nullable: true
type: string
PoiRequired:
type: boolean
description: (default = false)
ValidatePoiCode:
type: boolean
description: (default = false)
CostCenterGroupId:
nullable: true
type: string
CostCenterRequired:
type: boolean
description: (default = false)
ValidateCostCenterCode:
type: boolean
description: (default = false)
ExternalCode:
description: (default = null)
nullable: true
type: string
ExternalType:
x-enum-type: IntelliTracer.Domain.ExternalClockingType
enum:
- 0
- 1
- 2
- null
description: (default = null)
nullable: true
type: number
_typeDescriptor:
type: string
required:
- Id
ValidationResult:
type: array
items: {}
required:
- Entity
- ValidationResult
examples:
response:
value:
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: []
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Update option list
operationId: Update option list
description: |-
Updates an option list and creates a new menu structure.
*Privilege required: `Api: Mobile Application Configs`*
x-resource: Mobile clockings - Option lists
tags:
- Smartphone
requestBody:
content:
application/json:
schema:
type: object
properties:
Id:
type: string
description: |-
(default = null)
Only for folders.
Name_Nl:
description: (default = null)
nullable: true
type: string
Name_Fr:
description: (default = null)
nullable: true
type: string
Name_En:
description: (default = null)
nullable: true
type: string
Name_Pl:
description: (default = null)
nullable: true
type: string
Type:
type: number
x-enum-type: IntelliTracer.ApiV1.MobileClockingNodeType
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
description: |-
(default = 0)
Type of the mobile clocking node (folder or jobnumber).
FilterText:
description: >-
(default = null)
Filters the visible mobile clocking nodes based on what's in the "Filter/IVR code" field in the config of the logged in user. Only nodes in which that field matches the FilterText will be visible for that user.
nullable: true
type: string
Prefix:
description: >-
(default = null)
This prefix will automatically be added in front of the jobnumber entered by the user.
nullable: true
type: string
JobNumber:
description: >-
(default = null)
Job number used for postcalculation or activity based timeregistration
nullable: true
type: string
Regex:
description: >-
(default = null)
A jobnumber entered by the user will only be accepted if it matches this regex.
nullable: true
type: string
InputFilter:
type: number
x-enum-type: IntelliTracer.ApiV1.MobileClockingNodeInputFilter
enum:
- 0
- 1
- 2
- 3
description: >-
(default = 0)
What kind of input is allowed (free input, only numbers, or hexadecimal).
InputType:
type: number
x-enum-type: IntelliTracer.ApiV1.MenuJobInputType
enum:
- 0
- 1
- 2
description: >-
(default = 0)
What type of input is allowed (scanning, manual entry or both).
ClockingType:
x-enum-type: IntelliTracer.Domain.ClockingType
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- null
description: |-
(default = null)
Type of the clocking to be generated (see options below).
nullable: true
type: number
Children:
description: |-
(default = null)
Only for folders. Children of this mobile clocking node.
nullable: true
type: array
items: {}
PoiGroupId:
nullable: true
type: string
PoiRequired:
type: boolean
description: (default = false)
ValidatePoiCode:
type: boolean
description: (default = false)
CostCenterGroupId:
nullable: true
type: string
CostCenterRequired:
type: boolean
description: (default = false)
ValidateCostCenterCode:
type: boolean
description: (default = false)
ExternalCode:
description: (default = null)
nullable: true
type: string
ExternalType:
x-enum-type: IntelliTracer.Domain.ExternalClockingType
enum:
- 0
- 1
- 2
- null
description: (default = null)
nullable: true
type: number
_typeDescriptor:
type: string
required:
- Id
example:
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
security:
- pat: []
"/api/v1/mobileclocking/optionlist/{id}":
get:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
$ref: "#/components/schemas/IntelliTracer.ApiV1.MobileClockingNode"
examples:
response:
value:
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
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Get option list
operationId: Get option list
description: |-
Returns an option list and its menu structure by id.
*Privilege required: `Api: Mobile Application Configs`*
x-resource: Mobile clockings - Option lists
tags:
- Smartphone
parameters:
- name: id
in: path
description: ""
required: true
example: 00000000-0000-0000-0000-000000000000
schema:
type: string
security:
- pat: []
/api/v1/mobileclocking/multijoblist:
get:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/IntelliTracer.ApiV1.MobileClockingNode"
examples:
response:
value:
- 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
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Get multi job lists
operationId: Get multi job lists
description: |-
Returns a list of all multi job lists.
*Privilege required: `Api: Mobile Application Configs`*
x-resource: Mobile clockings - Multi job lists
tags:
- Smartphone
security:
- pat: []
"/api/v1/mobileclocking/multijoblist/{id}":
get:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
$ref: "#/components/schemas/IntelliTracer.ApiV1.MobileClockingNode"
examples:
response:
value:
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
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Get multi job list
operationId: Get multi job list
description: |-
Returns a multi job list and its menu structure by id.
*Privilege required: `Api: Mobile Application Configs`*
x-resource: Mobile clockings - Multi job lists
tags:
- Smartphone
parameters:
- name: id
in: path
description: ""
required: true
example: 00000000-0000-0000-0000-000000000000
schema:
type: string
security:
- pat: []
"/api/v2/reporting/visitsperpoi?page={page}&search={search}":
post:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
$ref: "#/components/schemas/IntelliTracer.ApiV2.VisitsPerPOIResponse"
examples:
response:
value:
Data:
- Poi:
Id: 00000000-0000-0000-0000-000000000000
Name: Work
Code: "012345"
Vehicle:
Id: 00000000-0000-0000-0000-000000000000
Code: "012345"
Name: John Doe
Type: 0
User:
Id: 00000000-0000-0000-0000-000000000000
Code: "012345"
Name: John Doe
Type: 0
FromDate: 2019-01-25T00:00:00
ToDate: 2019-01-25T00:00:00
Duration: 06:43:13
Address: Dumolinlaan 9, 8500 Kortrijk, BE
Deviation: 0.08
ContactOn: 00:00:17
ContactOff: 06:42:56
AnalogInputs:
- IoName:
Id: 00000000-0000-0000-0000-000000000000
Name: Io Name
StartValue: ""
StopValue: ""
NonAnalogInputs:
- Id: 00000000-0000-0000-0000-000000000000
Name: Front door
DurationOn: 00:00:00
DurationOff: 06:43:13
PagingFilter:
Page: 1
Search: ABC
PageCount: 4
TotalCount: 100
Links:
Base: https://api.intellitracer.be
First: /api/v2/asset?page=1
Prev: /api/v2/asset?page=2
Next: /api/v2/asset?page=4
Last: /api/v2/asset?page=4
"400":
description: Bad Request
headers: {}
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Visits per POI
operationId: Visits per POI
description: >-
Returns a list of visits a resource has made to a specific point of
interest (POI).
Pagination and searching is explained in [Pagination](#pagination).
*Privilege required: `Api: Visits per POI`*
x-resource: Visits per POI
tags:
- Reporting
parameters:
- name: page
in: path
description: ""
required: true
example: "1"
schema:
type: number
- name: search
in: path
description: ""
required: true
example: ABC
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
properties:
ResourceIds:
type: array
description: (default = [])
items: {}
PoiIds:
type: array
description: (default = [])
items: {}
FromDate:
description: (default = null)
nullable: true
type: string
ToDate:
description: (default = null)
nullable: true
type: string
FromTime:
description: (default = null)
nullable: true
type: string
ToTime:
description: (default = null)
nullable: true
type: string
MinDuration:
type: number
ShowDriver:
type: boolean
description: (default = false)
required:
- ResourceIds
- PoiIds
- FromDate
- ToDate
- MinDuration
example:
ResourceIds:
- 00000000-0000-0000-0000-000000000000
- 00000000-0000-0000-0000-000000000000
PoiIds:
- 00000000-0000-0000-0000-000000000000
- 00000000-0000-0000-0000-000000000000
FromDate: 2019-01-25T00:00:00
ToDate: 2019-01-25T00:00:00
FromTime: 00:00:00
ToTime: 23:59:59
MinDuration: 5
ShowDriver: true
security:
- pat: []
"/api/v2/reporting/positionsperpoi?page={page}&search={search}":
post:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
$ref: "#/components/schemas/IntelliTracer.ApiV2.PositionsPerPOIResponse"
examples:
response:
value:
Data:
- Poi:
Id: 00000000-0000-0000-0000-000000000000
Name: Work
Code: "012345"
Vehicle:
Id: 00000000-0000-0000-0000-000000000000
Code: "012345"
Name: Vehicle 1
Date: 2019-01-25T00:00:00
Address: Dumolinlaan 9, 8500 Kortrijk, BE
Mileage: 0.08
Speed: 0.08
PagingFilter:
Page: 1
Search: ABC
PageCount: 4
TotalCount: 100
Links:
Base: https://api.intellitracer.be
First: /api/v2/asset?page=1
Prev: /api/v2/asset?page=2
Next: /api/v2/asset?page=4
Last: /api/v2/asset?page=4
"400":
description: Bad Request
headers: {}
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Positions per POI
operationId: Positions per POI
description: >-
Returns a paged list of positions of a resource at a point of interest
(POI).
Pagination and searching is explained in [Pagination](#pagination).
*Privilege required: `Api: Positions per poi`*
x-resource: Positions per POI
tags:
- Reporting
parameters:
- name: page
in: path
description: ""
required: true
example: "1"
schema:
type: number
- name: search
in: path
description: ""
required: true
example: ABC
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
properties:
ResourceIds:
type: array
description: (default = [])
items: {}
PoiIds:
type: array
description: (default = [])
items: {}
FromDate:
description: (default = null)
nullable: true
type: string
ToDate:
description: (default = null)
nullable: true
type: string
required:
- ResourceIds
- PoiIds
- FromDate
- ToDate
example:
ResourceIds:
- 00000000-0000-0000-0000-000000000000
- 00000000-0000-0000-0000-000000000000
PoiIds:
- 00000000-0000-0000-0000-000000000000
- 00000000-0000-0000-0000-000000000000
FromDate: 2019-01-25
ToDate: 2019-01-26
security:
- pat: []
"/api/v2/reporting/resourcesatpoi?page={page}&search={search}":
post:
responses:
"200":
description: OK
headers: {}
content:
application/json:
schema:
$ref: "#/components/schemas/IntelliTracer.ApiV2.ResourcesAtPOIResponse"
examples:
response:
value:
Data:
- Poi:
Id: 00000000-0000-0000-0000-000000000000
Name: Work
Code: "012345"
Resource:
Id: 00000000-0000-0000-0000-000000000000
Code: "012345"
Name: John Doe
Type: 0
Date: 2019-01-25T00:00:00
Type: 0
Mileage: 0.08
Speed: 0.08
AnalogInputs:
- IoName:
Id: 00000000-0000-0000-0000-000000000000
Name: Io Name
State: ""
NonAnalogInputs:
- IoName:
Id: 00000000-0000-0000-0000-000000000000
Name: Io Name
State: ""
Outputs:
- IoName:
Id: 00000000-0000-0000-0000-000000000000
Name: Io Name
State: ""
PagingFilter:
Page: 1
Search: ABC
PageCount: 4
TotalCount: 100
Links:
Base: https://api.intellitracer.be
First: /api/v2/asset?page=1
Prev: /api/v2/asset?page=2
Next: /api/v2/asset?page=4
Last: /api/v2/asset?page=4
"400":
description: Bad Request
headers: {}
"401":
description: Unauthorized
headers: {}
"403":
description: Forbidden
headers: {}
"417":
description: ExpectationFailed
headers: {}
"429":
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before the next request is accepted.
schema:
type: integer
summary: Resources at POI
operationId: Resources at POI
description: >-
Returns a paged list of visits a resource has made to a point of
interest (POI).
*Privilege required: `Api: Resources at poi`*
x-resource: Resources at POI
tags:
- Reporting
parameters:
- name: page
in: path
description: ""
required: true
example: "1"
schema:
type: number
- name: search
in: path
description: ""
required: true
example: ABC
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
properties:
ResourceGroupIds:
type: array
description: (default = [])
items: {}
PoiGroupIds:
type: array
description: (default = [])
items: {}
Date:
description: (default = null)
nullable: true
type: string
required:
- ResourceGroupIds
- PoiGroupIds
- Date
example:
ResourceGroupIds:
- 00000000-0000-0000-0000-000000000000
- 00000000-0000-0000-0000-000000000000
PoiGroupIds:
- 00000000-0000-0000-0000-000000000000
- 00000000-0000-0000-0000-000000000000
Date: 2019-01-25
security:
- pat: []
/:
post:
responses: {}
summary: Access log
operationId: Access log
description: ""
x-resource: Example delivery
tags:
- Webhooks
parameters:
- name: sharedsecretkey
in: header
description: e.g. a04a6229-9300-4304-9163-1b57018f11d5
required: false
example: a04a6229-9300-4304-9163-1b57018f11d5
schema:
type: string
- name: timestamp
in: header
description: e.g. 1545294527
required: false
example: "1545294527"
schema:
type: string
- name: event-type
in: header
description: e.g. webhook.assetmovement.add
required: false
example: webhook.assetmovement.add
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
properties:
DateTime:
type: string
UserId:
type: string
UserName:
type: string
LocationId:
type: string
LocationName:
type: string
RelaisId:
type: string
RelaisName:
type: string
ReaderId:
type: string
ReaderName:
type: string
Badge:
type: string
AccessGranted:
type: boolean
Reason:
type: string
example:
DateTime: 2020-01-01T08:00:00+02:00
UserId: aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa
UserName: User 1
LocationId: aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa
LocationName: Entrance
RelaisId: aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa
RelaisName: Front door
ReaderId: aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa
ReaderName: Front door
Badge: 11A11A11
AccessGranted: true
Reason: Magnetic stripe
tags:
- name: Config
- name: Location
- name: Clocking
- name: Time
- name: Assets
- name: Absences
- name: Post Calculation
description: >-
## About Post Calculation
Post Calculation allows you to export your time registration enriched with post calculation information.
## Choosing the best export mode Activity or CostCenter
Generally there are 2 methods for exporting post calculation. Activity based will export every action of the user during the day, allowing you to have reliable from/to times per cost center.
CostCenter based will group the visits by cost center, so if a user visits the same cost center twice in a day, there is only one visit hence the from/to times can no longer be used.
| Mode || Description |
|:-----------|----|----------------------|
| `Activity` | 0 | Every post calculation event is used for output |
| `CostCenter` | 1 | Post calculation events are grouped by cost center before being used for output |
## Grouping activity by cost center
When viewing the post calculation by cost center, the records are grouped by user/day/cost center. We also support second level grouping on 'activity code'.
This option is only available when the mode is set to CostCenter. If the option is true we continue grouping on user/day/cost center.
If the option is false the records are exported by user/day/cost center/activity code.
| GroupCostcenterByActivity | Description |
|:---------------|----------------------|
| `True` | Every post calculation event is used for output |
| `False` | Post calculation events are grouped by cost center before being used for output |
- name: Access Control
- name: Check In At Work
- name: Maintenance
- name: Vehicle counters
- name: Fleet
- name: Smartphone
- name: Reporting
- name: Webhooks
description: >-
Webhooks allow you to build or set up integrations, which subscribe to
certain events in IntelliTracer. When one of those events is triggered,
we'll send an HTTPS POST payload to the webhook's configured URL.
Webhooks can be used to trigger your ERP, dispatch solution.. and so many other things. You're only limited by your imagination.
Webhooks can be enabled per company. Once active, the webhook will be triggered each time one or more subscribed events occur.
## Events
| Event | Event Type | Description |
|:--------------|-|----------------------|
| Add clocking | `webhook.addclocking` | Triggered when a clocking is added. |
| Update clocking | `webhook.clocking.update` | Triggered when a clocking is updated. |
| Delete clocking | `webhook.clocking.delete` | Triggered when a clocking is deleted. |
| Add asset | `webhook.asset.add` | Triggered when an asset is added. |
| Update asset | `webhook.asset.update` | Triggered when an asset is updated. |
| Delete asset | `webhook.asset.delete` | Triggered when an asset is deleted. |
| Asset movement | `webhook.assetmovement.add` | Triggered when an asset has moved. |
| AccessLog | `webhook.accesslog` | Triggered when someone has badged for access control. |
## Payloads
Each event type has a specific payload format with the relevant event information.
## Endpoints
The customer can configure his own endpoints. All payloads are deliverd to all endpoints.
## Delivery headers
HTTP POST payloads that are delivered to your webhook's configured URL endpoint will contain several special headers.
| Header | Description |
|:---------------|----------------------|
| `sharedsecretkey` | A shared secret to verify IntelliTracer as the sender. Example value: `a46a6975-8524-4304-1547-1b57018f11d5` |
| `timestamp` | Moment of delivery of the message in Unix time. Example value: `1545294527` |
| `event-type` | The event type, as described in Events. Example value: `webhook.addclocking` |
## Limitations and rate limits
Webhooks are limited to no more than one request per second, we will group the messages in one request where possible.
A webhook is defined as sent when we get a `2xx`, `3xx` or `410` response. If we get a `4xx`, `5xx` or no respone after 5 seconds it is marked as not sent.
An event that was not sent will be retried 47 times, before each retry we wait an hour.
## Clocking sources
'New clocking' deliveries will contain a clocking source. This is an overview of possible clocking sources and their meaning.
| Clocking source | Name | Description |
|:--------------|-|----------------------|
| 0 | Automatic | Received from a vehicle's blackbox or a timeclock. |
| 1 | Manual | Manually created via our website. |
| 2 | IVR | Received via our phone API. |
| 3 | Mobile device | Created via our Time App (iOS/Android). |
| 4 | Mobile RFID scanner | Created via mobile RFID (JWM). |
- name: Link URLs
description: >-
You can generate link URLs to make them available to link from your
integrating application to clockings, vehicle positions, point-of-interest
edit, vehicle edit or user edit. For example, the link URL
https://v5.intellitracer.be/Poi/Edit?id=39f39083-1c57-4844-b3b4-fe908f99b195
takes the visitor to the Point of Interest with the id 39f39083-1c57-4844-b3b4-fe908f99b195.
To be able to visit and view the link You need to be signed in and have the correct permissions.
## Clockings per user
| Parameter | description | Example|
|:---------------|----------------------|-|
|datetime|The datetime|20180802T000000|
|userid|The unique Id from the user |00000000-0000-0000-0000-000000000000|
**Example link URL**
https://v5.intellitracer.be/time/clockingsperuser?datetime=20180802T000000&userid=00000000-0000-0000-0000-000000000000
## Clockings per resource
| Parameter | description | Example|
|:---------------|----------------------|-|
|datetime|The datetime|20180802T000000|
|vehicleid|The unique Id from the resource |00000000-0000-0000-0000-000000000000|
**Example link URL**
https://v5.intellitracer.be/time/clockingsperresource?datetime=20180802T000000&vehicleid=00000000-0000-0000-0000-000000000000
## Day Overview
| Parameter | description | Example|
|:---------------|----------------------|-|
|date|The datetime|20180802T000000|
|id|The unique Id from the resource |00000000-0000-0000-0000-000000000000|
**Example link URL**
https://v5.intellitracer.be/trackandtrace/dayoverview?date=20180605T000000&id=00000000-0000-0000-0000-000000000000
## Point-of-Interest edit
| Parameter | description | Example|
|:---------------|----------------------|-|
|id|The unique Id from the resource |00000000-0000-0000-0000-000000000000|
**Example link URL**
http://v5.intellitracer.be/poi/edit?id=00000000-0000-0000-0000-000000000000
## User edit
| Parameter | description | Example|
|:---------------|----------------------|-|
|id|The unique Id from the resource |00000000-0000-0000-0000-000000000000|
**Example link URL**
http://v5.intellitracer.be/user/edit?id=00000000-0000-0000-0000-000000000000
## Vehicle edit
| Parameter | description | Example|
|:---------------|----------------------|-|
|id|The unique Id from the resource |00000000-0000-0000-0000-000000000000|
**Example link URL**
http://v5.intellitracer.be/vehicle/edit?id=00000000-0000-0000-0000-000000000000
- name: Types
description: |-
## Resource Types
| Resource Type | Name |
|:---------------|----------------------|
| `0` | User |
| `1` | Vehicle |
| `2` | TimeClock |
| `3` | Asset |
| `4` | IvrPhoneNumber |
| `5` | CostCenter |
| `6` | Workplace |
| `7` | MobileClocking |
servers:
- url: https://api.intellitracer.be
components:
requestBodies:
Link_workplaces_to_LimosaBody:
content:
application/json:
schema:
type: object
properties:
WorkplaceDucs:
type: array
items: {}
required:
- WorkplaceDucs
example:
WorkplaceDucs:
- 1Y100001AB1CD
- 1Y100001AB1CE
Delete_point_of_interestBody:
content:
application/json:
schema:
type: object
properties:
Id:
type: string
required:
- Id
example:
Id: 00000000-0000-0000-0000-000000000000
Link_pois_to_workplaceBody:
content:
application/json:
schema:
type: object
properties:
PoiIds:
type: array
items: {}
required:
- PoiIds
example:
PoiIds:
- 00000000-0000-0000-0000-000000000000
- 00000000-0000-0000-0000-000000000000
Get_absencesBody:
content:
application/json:
schema:
type: object
properties:
FromDate:
type: string
ToDate:
type: string
UserIds:
type: array
items: {}
required:
- FromDate
- ToDate
- UserIds
example:
FromDate: 2019-01-25T08:00:00+02:00
ToDate: 2019-01-25T17:00:00+02:00
UserIds:
- 00000000-0000-0000-0000-000000000000
- 00000000-0000-0000-0000-000000000000
Remove_resources_from_resource_groupBody:
content:
application/json:
schema:
type: object
properties:
Items:
description: (default = [])
nullable: true
type: array
items: {}
DeleteAll:
type: boolean
description: (default = false)
SearchString:
description: (default = null)
nullable: true
type: string
example:
Items:
- 00000000-0000-0000-0000-000000000000
- 00000000-0000-0000-0000-000000000000
DeleteAll: false
SearchString: null
Link_groups_to_access_control_scheduleBody:
content:
application/json:
schema:
type: object
properties:
GroupIds:
description: (default = [])
nullable: true
type: array
items: {}
example:
GroupIds:
- 00000000-0000-0000-0000-000000000000
- 00000000-0000-0000-0000-000000000000
Create_LimosaBody:
content:
application/json:
schema:
type: object
properties:
LimosaNumber:
type: number
EndDate:
description: (default = null)
nullable: true
type: string
WorkplaceDucs:
type: array
description: (default = [])
items: {}
required:
- LimosaNumber
example:
LimosaNumber: 11223344556677888
EndDate: 2020-10-30T00:00:00+01:00
WorkplaceDucs:
- 1Y100001AB1CD
- 1Y100001AB1CE
Add_resources_to_resource_groupBody:
content:
application/json:
schema:
type: object
properties:
Items:
description: (default = [])
nullable: true
type: array
items: {}
AddAll:
type: boolean
description: (default = false)
SearchString:
description: (default = null)
nullable: true
type: string
example:
Items:
- 00000000-0000-0000-0000-000000000000
- 00000000-0000-0000-0000-000000000000
AddAll: false
SearchString: null
Link_validators_to_cost_centerBody:
content:
application/json:
schema:
type: object
properties:
ValidatorIds:
type: array
items: {}
required:
- ValidatorIds
example:
ValidatorIds:
- 00000000-0000-0000-0000-000000000000
- 00000000-0000-0000-0000-000000000000
Link_users_to_access_groupBody:
content:
application/json:
schema:
type: object
properties:
UserIds:
description: (default = [])
nullable: true
type: array
items: {}
example:
UserIds:
- 00000000-0000-0000-0000-000000000000
- 00000000-0000-0000-0000-000000000000
Add_persons_to_person_groupBody:
content:
application/json:
schema:
type: object
properties:
PersonIds:
description: (default = [])
nullable: true
type: array
items: {}
example:
PersonIds:
- 00000000-0000-0000-0000-000000000000
- 00000000-0000-0000-0000-000000000000
Link_BTW_s_to_project_leadBody:
content:
application/json:
schema:
type: object
properties:
BtwNumbers:
type: array
items: {}
required:
- BtwNumbers
example:
BtwNumbers:
- BE-0000000000
- BE-0000000000
securitySchemes:
pat:
type: http
scheme: bearer
description: >-
Company-level Personal Access Token. Create one in IntelliTracer under
Public API tokens, then send it as `Authorization: Bearer itr_pat_...`.
A token only carries the API scopes granted on its Privileges page.
schemas:
"6":
type: object
description: Anonymous type from apib conversion
"7":
type: object
description: Anonymous type from apib conversion
Vehicles: {}
Timeclocks: {}
Pois: {}
Smartphones: {}
Users: {}
Clockings: {}
Plannings: {}
Assets: {}
Absences: {}
Export: {}
Badges: {}
Persons: {}
Workplaces: {}
Registrations: {}
IntelliTracer.Domain.Country:
type: number
x-enumDescriptions:
"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
"9999": Unknown
"153": Mauritania
enum:
- null
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
- 47
- 48
- 49
- 50
- 51
- 52
- 53
- 54
- 55
- 56
- 57
- 58
- 59
- 60
- 61
- 62
- 63
- 64
- 65
- 66
- 67
- 68
- 69
- 70
- 71
- 72
- 73
- 74
- 75
- 76
- 77
- 78
- 79
- 80
- 81
- 82
- 83
- 84
- 85
- 86
- 87
- 88
- 89
- 90
- 91
- 92
- 93
- 94
- 95
- 96
- 97
- 98
- 99
- 100
- 101
- 102
- 103
- 104
- 105
- 106
- 107
- 108
- 109
- 110
- 111
- 112
- 113
- 114
- 115
- 116
- 117
- 118
- 119
- 120
- 121
- 122
- 123
- 124
- 125
- 126
- 127
- 128
- 129
- 130
- 131
- 132
- 133
- 134
- 135
- 136
- 137
- 138
- 139
- 140
- 141
- 142
- 143
- 144
- 145
- 146
- 147
- 148
- 149
- 150
- 151
- 152
- 153
- 9999
IntelliTracer.Domain.PersonType:
type: number
x-enumDescriptions:
"0": RRN
"1": Limosa
enum:
- null
- 0
- 1
IntelliTracer.Domain.BadgeType:
type: number
x-enumDescriptions:
"0": Unknown
"1": MF7
"2": ConstruBadge
"3": EId
"4": Barcode_QR
enum:
- null
- 0
- 1
- 2
- 3
- 4
IntelliTracer.Domain.ResourceType:
type: number
x-enumDescriptions:
"0": User
"1": Vehicle
"2": Timeclock
"3": Asset
"4": Ivr phone number
"5": Cost center
"6": Work place
"7": Mobile clocking
enum:
- null
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
IntelliTracer.Domain.TrackingReportType:
type: number
x-enumDescriptions:
"1": Position
"21": Serial port 21
"23": Serial port 23
"24": Serial port 24
"100": Input acc on
"101": Input acc off
"200": Input 01 high
"201": Input 01 low
"202": Input 02 high
"203": Input 02 low
"204": Input 03 high
"205": Input 03 low
"206": Input 04 high
"207": Input 04 low
"208": Input 05 high
"209": Input 05 low
"210": Input 06 high
"211": Input 06 low
"212": Input 07 high
"213": Input 07 low
"214": Input 08 high
"215": Input 08 low
"300": Analog input 1
"301": Analog input 2
"400": Speeding start
"401": Speeding stop
"500": VT idle start
"501": VT idle end
"1000": Power low
"1001": Power lost
"1002": Backup battery low
"1003": Gps destroyed
"1004": Power low recover
"1005": Power lost recover
"1006": Backup battery low recover
"2000": Custom 000
"2001": Custom 001
"2002": Custom 002
"2003": Custom 003
"2004": Custom 004
"2005": Custom 005
"2006": Custom 006
"2007": Custom 007
"2008": Custom 008
"2009": Custom 009
"2010": Custom 010
"2011": Custom 011
"2012": Custom 012
"2013": Custom 013
"2014": Custom 014
"2015": Custom 015
"2016": Custom 016
"2017": Custom 017
"2018": Custom 018
"2019": Custom 019
"2020": Custom 020
"2021": Custom 021
"2022": Custom 022
"2023": Custom 023
"2024": Custom 024
"2025": Custom 025
"2026": Custom 026
"2027": Custom 027
"2028": Custom 028
"2029": Custom 029
"2030": Custom 030
"2031": Custom 031
"2032": Custom 032
"2033": Custom 033
"2034": Custom 034
"2035": Custom 035
"2036": Custom 036
"2037": Custom 037
"2038": Custom 038
"2039": Custom 039
"2040": Custom 040
"2041": Custom 041
"2042": Custom 042
"2043": Custom 043
"2044": Custom 044
"2045": Custom 045
"2046": Custom 046
"2047": Custom 047
"2048": Custom 048
"2049": Custom 049
"2050": Custom 050
"2051": Custom 051
"2052": Custom 052
"2053": Custom 053
"2054": Custom 054
"2055": Custom 055
"2056": Custom 056
"2057": Custom 057
"2058": Custom 058
"2059": Custom 059
"2060": Custom 060
"2061": Custom 061
"2062": Custom 062
"2063": Custom 063
"2064": Custom 064
"2065": Custom 065
"2066": Custom 066
"2067": Custom 067
"2068": Custom 068
"2069": Custom 069
"2070": Custom 070
"2071": Custom 071
"2072": Custom 072
"2073": Custom 073
"2074": Custom 074
"2075": Custom 075
"2076": Custom 076
"2077": Custom 077
"2078": Custom 078
"2079": Custom 079
"2080": Custom 080
"2081": Custom 081
"2082": Custom 082
"2083": Custom 083
"2084": Custom 084
"2085": Custom 085
"2086": Custom 086
"2087": Custom 087
"2088": Custom 088
"2089": Custom 089
"2090": Custom 090
"2091": Custom 091
"2092": Custom 092
"2093": Custom 093
"2094": Custom 094
"2095": Custom 095
"2096": Custom 096
"2097": Custom 097
"2098": Custom 098
"2099": Custom 099
"2100": Custom 100
"3000": Master fence enabled
"3001": Master fence disabled
"4001": Fuel transaction
"5000": Idle end
"5001": Idle start
"5003": Sleep idle
"5004": Sleep battery low
"5005": Wake up - Power down duration
"5006": Wake up - Movement detected
"5007": Wake up - Power connected
"5008": Sleep timer
"6000": Sleep start
"6001": Wake up
"7000": Vicking access granted - Mag stripe
"7001": Vicking access granted
"7002": Vicking access granted - Pin
"7003": Vicking access denied - No per
"7004": Vicking access denied - No lst
"7005": Vicking access denied - Unknown badge
"7006": Vicking access denied - Not in time zone
"7007": Vicking clocking
"8000": Harsh acceleration
"8001": Harsh braking
"8002": Before crash
"8003": After crash
"9000": Location update clocking
"10000": ATrack AT5 FMI Connected status
"10001": ATrack AT5 FMI Message to server
"10002": ATrack AT5 FMI Message response
"10003": ATrack AT5 FMI Message status
"10004": ATrack AT5 FMI Stop status
"10005": ATrack AT5 FMI ETA
"10006": ATrack AT5 FMI Driver ID
"10007": ATrack AT5 FMI Driver status
"11000": SysTech CAREU UCAN OBD report
"11001": SysTech CAREU UCAN DTC alert
"11002": SysTech CAREU UCAN Over revving alert
"11003": SysTech CAREU UCAN Over heated alert
"11004": SysTech CAREU UCAN Over pedaling alert
"12000": ATrack AX5 OBD Connected
"12001": ATrack AX5 OBD Disconnected
"12002": ATrack AX5 Engine load alert
"12003": ATrack AX5 MIL alert
"12004": ATrack AX5 Throttle position alert
"12005": ATrack AX5 Engine coolant temperature alert
"12006": ATrack AX5 Fuel used alert
"12007": ATrack AX5 RPM Alert
"13000": SysTech Careu U1 Garmin Connect
"13001": SysTech Careu U1 Garmin Disconnect
"13500": Io extensionInput01High
"13501": Io extension Input 01 low
"13502": Io extension Input 02 high
"13503": Io extension Input 02 low
"13504": Io extension Input 03 high
"13505": Io extension Input 03 low
"13506": Io extension Input 04 high
"13507": Io extension Input 04 low
"13508": Io extension Input 05 high
"13509": Io extension Input 05 low
"13510": Io extension Input 06 high
"13511": Io extension Input 06 low
"13512": Io extension Input 07 high
"13513": Io extension Input 07 low
"13514": Io extension Input 08 high
"13515": Io extension Input 08 low
"13516": Io extension Input 09 high
"13517": Io extension Input 09 low
"13518": Io extension Input 10 high
"13519": Io extension Input 10 low
"13520": Io extension Input 11 high
"13521": Io extension Input 11 low
"13522": Io extension Input 12 high
"13523": Io extension Input 12 low
"13524": Io extension Input 13 high
"13525": Io extension Input 13 low
"13526": Io extension Input 14 high
"13527": Io extension Input 14 low
"13528": Io extension Input 15 high
"13529": Io extension Input 15 low
"13530": Io extension Input 16 high
"13531": Io extension Input 16 low
"14000": Wondeproud M7 Detach
"14500": Sigfox Position
"14501": Sigfox Battery low
"14502": Sigfox Daily report
"14503": Sigfox Missing position
"15000": JWM Data
"15002": JWM Manual alarm
"17000": Queclink Antenna Changed
"17001": Queclink Power On
"17002": Queclink Connect Main Power
"17003": Queclink Reboot
"17004": Queclink Start Movement Detected
"17005": Queclink Stop Movement Detected
"17006": Queclink SOS
"17007": Queclink Unit Switch Off
"17008": Queclink Unit Switch On
"18000": Escort BLE Working
"18001": Escort BLE Not Working
"-9999": Unknown
"-9000": Invalid Data
"-2000": Command to unit
"-1003": Error
"-1002": Disconnect
"-1001": Sync
"-1000": Connect
"-3000": Canbus data
"250": Output 01 high
"251": Output 01 low
"252": Output 02 high
"253": Output 02 low
"254": Output 03 high
"255": Output 03 low
"256": Output 04 high
"257": Output 04 low
"17009": Queclink FOTA update confirmed
"17010": Queclink FOTA update refused
"17011": Queclink FOTA update canceled by server
"17012": Queclink FOTA update refused battery low
"17013": Queclink FOTA download started
"17014": Queclink FOTA download finished
"17015": Queclink FOTA download failed
"17016": Queclink FOTA update started
"17017": Queclink FOTA update finished
"17018": Queclink FOTA update failed
"17019": Queclink FOTA update not started battery low
"17020": Queclink normal power on
"17021": Queclink FOTA reboot
"17022": Queclink RTO reboot
"17023": Queclink watchdog reboot
"17024": Queclink config upgrade reboot
"19000": Oyster low battery
enum:
- null
- 1
- 21
- 23
- 24
- 100
- 101
- 200
- 201
- 202
- 203
- 204
- 205
- 206
- 207
- 208
- 209
- 210
- 211
- 212
- 213
- 214
- 215
- 250
- 251
- 252
- 253
- 254
- 255
- 256
- 257
- 300
- 301
- 400
- 401
- 500
- 501
- 1000
- 1001
- 1002
- 1003
- 1004
- 1005
- 1006
- 2000
- 2001
- 2002
- 2003
- 2004
- 2005
- 2006
- 2007
- 2008
- 2009
- 2010
- 2011
- 2012
- 2013
- 2014
- 2015
- 2016
- 2017
- 2018
- 2019
- 2020
- 2021
- 2022
- 2023
- 2024
- 2025
- 2026
- 2027
- 2028
- 2029
- 2030
- 2031
- 2032
- 2033
- 2034
- 2035
- 2036
- 2037
- 2038
- 2039
- 2040
- 2041
- 2042
- 2043
- 2044
- 2045
- 2046
- 2047
- 2048
- 2049
- 2050
- 2051
- 2052
- 2053
- 2054
- 2055
- 2056
- 2057
- 2058
- 2059
- 2060
- 2061
- 2062
- 2063
- 2064
- 2065
- 2066
- 2067
- 2068
- 2069
- 2070
- 2071
- 2072
- 2073
- 2074
- 2075
- 2076
- 2077
- 2078
- 2079
- 2080
- 2081
- 2082
- 2083
- 2084
- 2085
- 2086
- 2087
- 2088
- 2089
- 2090
- 2091
- 2092
- 2093
- 2094
- 2095
- 2096
- 2097
- 2098
- 2099
- 2100
- 3000
- 3001
- 4001
- 5000
- 5001
- 5003
- 5004
- 5005
- 5006
- 5007
- 5008
- 6000
- 6001
- 7000
- 7001
- 7002
- 7003
- 7004
- 7005
- 7006
- 7007
- 8000
- 8001
- 8002
- 8003
- 9000
- 10000
- 10001
- 10002
- 10003
- 10004
- 10005
- 10006
- 10007
- 11000
- 11001
- 11002
- 11003
- 11004
- 12000
- 12001
- 12002
- 12003
- 12004
- 12005
- 12006
- 12007
- 13000
- 13001
- 13500
- 13501
- 13502
- 13503
- 13504
- 13505
- 13506
- 13507
- 13508
- 13509
- 13510
- 13511
- 13512
- 13513
- 13514
- 13515
- 13516
- 13517
- 13518
- 13519
- 13520
- 13521
- 13522
- 13523
- 13524
- 13525
- 13526
- 13527
- 13528
- 13529
- 13530
- 13531
- 14000
- 14500
- 14501
- 14502
- 14503
- 15000
- 15002
- 17000
- 17001
- 17002
- 17003
- 17004
- 17005
- 17006
- 17007
- 17008
- 17009
- 17010
- 17011
- 17012
- 17013
- 17014
- 17015
- 17016
- 17017
- 17018
- 17019
- 17020
- 17021
- 17022
- 17023
- 17024
- 18000
- 18001
- 19000
- -9999
- -9000
- -3000
- -2000
- -1003
- -1002
- -1001
- -1000
IntelliTracer.Domain.StaffType:
type: number
x-enumDescriptions:
"0": Own staff
"1": Other staff
enum:
- null
- 0
- 1
IntelliTracer.Domain.VehicleCategory:
type: number
x-enumDescriptions:
"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)
enum:
- null
- 0
- 1
- 2
- 3
- 4
- 5
- 6
IntelliTracer.Domain.VehicleFuelType:
type: number
x-enumDescriptions:
"0": Gasoline
"1": Diesel
"2": LPG
"3": Electricity
"4": Red Diesel
"5": Ppo
"6": Cng
"7": Hybrid
"8": Plug-in hybrid
enum:
- null
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
IntelliTracer.Domain.VehicleEuropeanEmissionStandard:
type: number
x-enumDescriptions:
"0": Unknown
"100": Euro1
"200": Euro2
"300": Euro3
"400": Euro4
"500": Euro5
"600": Euro6
enum:
- null
- 0
- 100
- 200
- 300
- 400
- 500
- 600
IntelliTracer.Domain.ClockingType:
type: number
x-enumDescriptions:
"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
enum:
- null
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
IntelliTracer.Domain.IoNameType:
type: number
x-enumDescriptions:
"0": Input
"1": Analog input temperature
"2": Analog input voltage
"3": Output
"4": Acc
"5": Privacy
"6": Vito input
"7": Privacy Off/On acc
"8": Driver
"9": Passenger
"10": No clockings
"11": SPW contact input
"12": SPW driving input
"13": SPW shovel input
"14": SPW salt scatter input
"15": BeMobile Crash Cushion
"16": BeMobile Arrow Left
"17": BeMobile Arrow Right
"18": BeMobile Cross
"19": Analog input fuel
"20": No clockings output
"21": Output with status
"22": Work kilometers
"23": Private kilometers
enum:
- null
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
IntelliTracer.Domain.VehicleIoType:
type: number
x-enumDescriptions:
"0": Input 01
"1": Input 02
"2": Input 03
"3": Input 04
"4": Input 05
"5": Input 06
"6": Input 07
"7": Input 08
"50": Io extension input 01
"51": Io extension input 02
"52": Io extension input 03
"53": Io extension input 04
"54": Io extension input 05
"55": Io extension input 06
"56": Io extension input 07
"57": Io extension input 08
"58": Io extension input 09
"59": Io extension input 10
"60": Io extension input 11
"61": Io extension input 12
"62": Io extension input 13
"63": Io extension input 14
"64": Io extension input 15
"65": Io extension input 16
"100": Analog input 01
"101": Analog input 02
"150": Io extension analog input 01
"151": Io extension analog input 02
"200": Output 01
"201": Output 02
"202": Output 03
"203": Output 04
"204": Output 05
"205": Output 06
"206": Output 07
"207": Output 08
"250": Io extension output 01
"251": Io extension output 02
"252": Io extension output 03
"253": Io extension output 04
"254": Io extension output 05
"255": Io extension output 06
enum:
- null
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 50
- 51
- 52
- 53
- 54
- 55
- 56
- 57
- 58
- 59
- 60
- 61
- 62
- 63
- 64
- 65
- 100
- 101
- 150
- 151
- 200
- 201
- 202
- 203
- 204
- 205
- 206
- 207
- 250
- 251
- 252
- 253
- 254
- 255
IntelliTracer.Domain.IoState:
type: object
properties:
ContactName:
example: Contact
description: |-
(default = null)
Name of the IO.
nullable: true
type: string
StateName:
example: Off
description: |-
(default = null)
Current state of the input/output.
nullable: true
type: string
IoNameType:
allOf:
- $ref: "#/components/schemas/IntelliTracer.Domain.IoNameType"
- type: object
properties: {}
description: |-
(default = 0)
Type of the IO state.
VehicleIoType:
allOf:
- $ref: "#/components/schemas/IntelliTracer.Domain.VehicleIoType"
- type: object
properties: {}
description: |-
(default = 0)
IO port number.
IntelliTracer.Domain.AssetIdentificationType:
type: number
x-enumDescriptions:
"0": Active
"1": Passive
"2": Personalized
"-1": Active/passive RFID
enum:
- null
- -1
- 0
- 1
- 2
IntelliTracer.Domain.ExternalClockingType:
type: number
x-enumDescriptions:
"0": Log Moment
"1": Custom
"2": Mobility
enum:
- null
- 0
- 1
- 2
IntelliTracer.Domain.ResourceTypeString:
type: string
x-enumDescriptions:
"user": User
"vehicle": Vehicle
"timeclock": Timeclock
"asset": Asset
"ivrphonenumber": Ivr phone number
"costcenter": Cost center
"workplace": Work place
"mobileclocking": Mobile clocking
enum:
- null
- user
- vehicle
- timeclock
- asset
- ivrphonenumber
- costcenter
- workplace
- mobileclocking
IntelliTracer.Domain.ClockingTypeString:
type: string
x-enumDescriptions:
"default": Default
"work.start": Start work
"work.stop": Stop work
"activity.start": Start activity
"activity.stop": Stop activity
"activity.stop.break": Stop activity break
"activity.switch": Switch activity
"activity.finish": Finish activity
"break.start": Start break
"break.stop": Stop break
"absence.start": Start absence
"absence.stop": Stop absence
"movement.start.driver": Start movement driver
"movement.start.passenger": Start movement passenger
"movement.stop": Stop movement
"external.start": Start external
"external.stop": Stop external
"travel.start": Start travel time
"travel.stop": Stop travel time
enum:
- null
- default
- work.start
- work.stop
- activity.start
- activity.stop
- activity.stop.break
- activity.switch
- activity.finish
- break.start
- break.stop
- absence.start
- absence.stop
- movement.start.driver
- movement.start.passenger
- movement.stop
- external.start
- external.stop
- travel.start
- travel.stop
IntelliTracer.Domain.ExternalClockingTypeString:
type: string
x-enumDescriptions:
"logmoment": Log Moment
"custom": Custom
"mobility": Mobility
enum:
- null
- logmoment
- custom
- mobility
IntelliTracer.Domain.CountryString:
type: string
x-enumDescriptions:
"belgium": Belgium
"france": France
"netherlands": Netherlands
"luxembourg": Luxembourg
"italy": Italy
"norway": Norway
"denmark": Denmark
"sweden": Sweden
"sanmarino": San Marino
"andorra": Andorra
"germany": Germany
"unitedkingdom": United Kingdom
"spain": Spain
"portugal": Portugal
"switzerland": Switzerland
"austria": Austria
"hungary": Hungary
"czechia": Czechia
"greece": Greece
"poland": Poland
"slovakia": Slovakia
"turkey": Turkey
"albania": Albania
"bulgaria": Bulgaria
"bosniaherzegovina": Bosnia Herzegovina
"belarus": Belarus
"moldova": Moldova
"macedonia": Macedonia
"montenegro": Montenegro
"romania": Romania
"serbia": Serbia
"ukraine": Ukraine
"finland": Finland
"ireland": Ireland
"malta": Malta
"estland": Estonia
"croatia": Croatia
"lithuania": Lithuania
"latvia": Latvia
"slovenia": Slovenia
"armenia": Armenia
"azerbaijan": Azerbaijan
"cyprus": Cyprus
"faroeislands": Faroe Islands
"georgia": Georgia
"gibraltar": Gibraltar
"iceland": Iceland
"monaco": Monaco
"russia": Russia
"vatican": Vatican
"kosovo": Kosovo
"unitedarabemirates": United Arab Emirates
"afghanistan": Afghanistan
"argentina": Argentina
"australia": Australia
"bangladesh": Bangladesh
"bahrain": Bahrain
"brunei": Brunei
"bolivia": Bolivia
"brazil": Brazil
"bhutan": Bhutan
"botswana": Botswana
"belize": Belize
"canada": Canada
"congo": Congo
"cotedivoire": Cote d'Ivoire
"chile": Chile
"cameroon": Cameroon
"china": China
"colombia": Colombia
"costarica": Costa Rica
"cuba": Cuba
"dominicanrepublic": Dominican Republic
"algeria": Algeria
"ecuador": Ecuador
"egypt": Egypt
"eritrea": Eritrea
"ethiopia": Ethiopia
"greenland": Greenland
"guatemala": Guatemala
"honduras": Honduras
"haiti": Haiti
"indonesia": Indonesia
"israel": Israel
"india": India
"iraq": Iraq
"iran": Iran
"jamaica": Jamaica
"jordan": Jordan
"japan": Japan
"kenya": Kenya
"kyrgyzstan": Kyrgyzstan
"cambodia": Cambodia
"korea": Korea
"kuwait": Kuwait
"kazakhstan": Kazakhstan
"laos": Laos
"lebanon": Lebanon
"liechtenstein": Liechtenstein
"srilanka": Sri Lanka
"libya": Libya
"morocco": Morocco
"mali": Mali
"myanmar": Myanmar
"mongolia": Mongolia
"macaosar": Macao SAR
"maldives": Maldives
"mexico": Mexico
"malaysia": Malaysia
"nigeria": Nigeria
"nicaragua": Nicaragua
"nepal": Nepal
"newzealand": New Zealand
"oman": Oman
"panama": Panama
"peru": Peru
"philippines": Philippines
"pakistan": Pakistan
"puertorico": Puerto Rico
"paraguay": Paraguay
"qatar": Qatar
"reunion": Reunion
"rwanda": Rwanda
"saudiarabia": Saudi Arabia
"singapore": Singapore
"senegal": Senegal
"somalia": Somalia
"elsalvador": El Salvador
"syria": Syria
"thailand": Thailand
"tajikistan": Tajikistan
"turkmenistan": Turkmenistan
"tunisia": Tunisia
"trinidadandtobago": Trinidad and Tobago
"taiwan": Taiwan
"unitedstates": United States
"uruguay": Uruguay
"uzbekistan": Uzbekistan
"venezuela": Venezuela
"vietnam": Vietnam
"yemen": Yemen
"southafrica": South Africa
"zimbabwe": Zimbabwe
"guineabissau": Guinea-Bissau
"angola": Angola
"caboverde": Cabo Verde
"saotomeandprincipe": Sao Tome and Principe
"mozambique": Mozambique
"guinea": Guinea
"unknown": Unknown
"mauritania": Mauritania
enum:
- null
- belgium
- france
- netherlands
- luxembourg
- italy
- norway
- denmark
- sweden
- sanmarino
- andorra
- germany
- unitedkingdom
- spain
- portugal
- switzerland
- austria
- hungary
- czechia
- greece
- poland
- slovakia
- turkey
- albania
- bulgaria
- bosniaherzegovina
- belarus
- moldova
- macedonia
- montenegro
- romania
- serbia
- ukraine
- finland
- ireland
- malta
- estland
- croatia
- lithuania
- latvia
- slovenia
- armenia
- azerbaijan
- cyprus
- faroeislands
- georgia
- gibraltar
- iceland
- monaco
- russia
- vatican
- kosovo
- unitedarabemirates
- afghanistan
- argentina
- australia
- bangladesh
- bahrain
- brunei
- bolivia
- brazil
- bhutan
- botswana
- belize
- canada
- congo
- cotedivoire
- chile
- cameroon
- china
- colombia
- costarica
- cuba
- dominicanrepublic
- algeria
- ecuador
- egypt
- eritrea
- ethiopia
- greenland
- guatemala
- honduras
- haiti
- indonesia
- israel
- india
- iraq
- iran
- jamaica
- jordan
- japan
- kenya
- kyrgyzstan
- cambodia
- korea
- kuwait
- kazakhstan
- laos
- lebanon
- liechtenstein
- srilanka
- libya
- morocco
- mali
- myanmar
- mongolia
- macaosar
- maldives
- mexico
- malaysia
- nigeria
- nicaragua
- nepal
- newzealand
- oman
- panama
- peru
- philippines
- pakistan
- puertorico
- paraguay
- qatar
- reunion
- rwanda
- saudiarabia
- singapore
- senegal
- somalia
- elsalvador
- syria
- thailand
- tajikistan
- turkmenistan
- tunisia
- trinidadandtobago
- taiwan
- unitedstates
- uruguay
- uzbekistan
- venezuela
- vietnam
- yemen
- southafrica
- zimbabwe
- guineabissau
- angola
- caboverde
- saotomeandprincipe
- mozambique
- guinea
- mauritania
- unknown
IntelliTracer.Domain.AbsenceRequestTypeString:
type: string
x-enumDescriptions:
"none": None
"request": Request
"cancellation": Cancellation
enum:
- null
- none
- request
- cancellation
IntelliTracer.Domain.AbsenceTypeTimeslotTypeString:
type: string
x-enumDescriptions:
"none": None
"day.morning": Morning
"day.afternoon": Afternoon
"day.full": Full day
"hours.working": Working hours
"hours.specific": Specific hours
enum:
- null
- none
- day.morning
- day.afternoon
- day.full
- hours.working
- hours.specific
IntelliTracer.Domain.AbsenceRequestStatusString:
type: string
x-enumDescriptions:
"pending": Pending
"approved": Approved
"refused": Refused
"canceled": Canceled
"invalid": Invalid
enum:
- null
- pending
- approved
- refused
- canceled
- invalid
GeoDynamics.WebApi.DeleteListItems:
type: object
properties:
Items:
items:
anyOf:
- type: string
example: 00000000-0000-0000-0000-000000000000
- type: string
example: 00000000-0000-0000-0000-000000000000
description: (default = [])
nullable: true
type: array
DeleteAll:
type: boolean
description: (default = false)
SearchString:
description: (default = null)
nullable: true
type: string
GeoDynamics.WebApi.AddListItems:
type: object
properties:
Items:
items:
anyOf:
- type: string
example: 00000000-0000-0000-0000-000000000000
- type: string
example: 00000000-0000-0000-0000-000000000000
description: (default = [])
nullable: true
type: array
AddAll:
type: boolean
description: (default = false)
SearchString:
description: (default = null)
nullable: true
type: string
GeoDynamics.WebApi.Exceptions.ErrorMessage:
type: object
required:
- Property
- Message
properties:
Property:
type: string
example: Name
Message:
type: string
example: Required
IntelliTracer.Api.ValidationResult:
type: object
properties:
Message:
type: string
SourceMemberNames:
type: array
items: {}
IntelliTracer.Api.PagingFilter:
type: object
required:
- Page
- PageCount
- TotalCount
- Links
properties:
Page:
type: number
example: 1
Search:
example: ABC
nullable: true
type: string
PageCount:
type: number
example: 4
TotalCount:
type: number
example: 100
Links:
$ref: "#/components/schemas/IntelliTracer.Api.PagingLinks"
IntelliTracer.Api.PagingLinks:
type: object
required:
- Base
properties:
Base:
type: string
example: https://api.intellitracer.be
First:
type: string
example: /api/v2/asset?page=1
Prev:
type: string
example: /api/v2/asset?page=2
Next:
type: string
example: /api/v2/asset?page=4
Last:
type: string
example: /api/v2/asset?page=4
IntelliTracer.Api.Id:
type: object
required:
- Id
properties:
Id:
type: string
example: 00000000-0000-0000-0000-000000000000
IntelliTracer.ApiV1.Resource:
type: object
required:
- Id
- Name
properties:
Id:
type: string
example: 00000000-0000-0000-0000-000000000000
Name:
type: string
example: John Doe
Code:
example: "012345"
description: (default = null)
nullable: true
type: string
Type:
$ref: "#/components/schemas/IntelliTracer.ApiV1.ResourceType"
IntelliTracer.ApiV2.Resource:
type: object
required:
- Id
- Name
properties:
Id:
type: string
example: 00000000-0000-0000-0000-000000000000
Code:
example: "012345"
description: (default = null)
nullable: true
type: string
Name:
type: string
example: John Doe
Type:
$ref: "#/components/schemas/IntelliTracer.Domain.ResourceType"
IntelliTracer.ApiV3.Resource:
type: object
required:
- Id
- Name
properties:
Id:
type: string
example: 00000000-0000-0000-0000-000000000000
Code:
example: "012345"
description: (default = null)
nullable: true
type: string
Name:
type: string
example: John Doe
Type:
$ref: "#/components/schemas/IntelliTracer.Domain.ResourceType"
IntelliTracer.ApiV3.ResourceWithStringType:
type: object
required:
- Id
- Name
properties:
Id:
type: string
example: 00000000-0000-0000-0000-000000000000
Code:
example: "012345"
description: (default = null)
nullable: true
type: string
Name:
type: string
example: John Doe
Type:
$ref: "#/components/schemas/IntelliTracer.Domain.ResourceTypeString"
IntelliTracer.ApiV3.ResourceGroupWithStringType:
type: object
required:
- Id
- Name
properties:
Id:
type: string
example: 00000000-0000-0000-0000-000000000000
Code:
example: "012345"
description: (default = null)
nullable: true
type: string
Name:
type: string
example: John Doe
Type:
$ref: "#/components/schemas/IntelliTracer.Domain.ResourceTypeString"
IntelliTracer.ApiV1.ResourceType:
type: number
x-enumDescriptions:
"0": User
"1": Vehicle
"2": Timeclock
"3": Asset
"4": Ivr phone number
"5": Cost center
"6": Work place
"7": Mobile clocking
enum:
- null
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
IntelliTracer.ApiV1.PersonType:
type: number
x-enumDescriptions:
"0": Belgian
"1": Foreigner
enum:
- null
- 0
- 1
IntelliTracer.ApiV1.LocationTypeEntity:
type: number
x-enumDescriptions:
"1": Position
"21": Serial port 21
"23": Serial port 23
"24": Serial port 24
"100": Input acc on
"101": Input acc off
"200": Input 01 high
"201": Input 01 low
"202": Input 02 high
"203": Input 02 low
"204": Input 03 high
"205": Input 03 low
"206": Input 04 high
"207": Input 04 low
"208": Input 05 high
"209": Input 05 low
"210": Input 06 high
"211": Input 06 low
"212": Input 07 high
"213": Input 07 low
"214": Input 08 high
"215": Input 08 low
"300": Analog input 1
"301": Analog input 2
"1000": Power low
"1001": Power lost
"1002": Backup battery low
"1003": Gps destroyed
"1004": Power low recover
"1005": Power lost recover
"1006": Backup battery low recover
"2000": Custom 000
"2001": Custom 001
"2002": Custom 002
"2003": Custom 003
"2004": Custom 004
"2005": Custom 005
"2006": Custom 006
"2007": Custom 007
"2008": Custom 008
"2009": Custom 009
"2010": Custom 010
"2011": Custom 011
"2012": Custom 012
"2013": Custom 013
"2014": Custom 014
"2015": Custom 015
"2016": Custom 016
"2017": Custom 017
"2018": Custom 018
"2019": Custom 019
"2020": Custom 020
"2021": Custom 021
"3000": Master fence enabled
"3001": Master fence disabled
"4001": Fuel transaction
"5000": Idle end
"5001": Idle start
"5003": Sleep idle
"5004": Sleep battery low
"5005": Wake up - Power down duration
"5006": Wake up - Movement detected
"5007": Wake up - Power connected
"5008": Sleep timer
"6000": Sleep start
"6001": Wake up
"7000": Vicking access granted - Mag stripe
"7001": Vicking access granted
"7002": Vicking access granted - Pin
"7003": Vicking access denied - No per
"7004": Vicking access denied - No lst
"7005": Vicking access denied - Unknown badge
"7006": Vicking access denied - Not in time zone
"7007": Vicking clocking
"-9999": Unknown
"-1002": Disconnect
"-1001": Sync
"-1000": Connect
enum:
- null
- 1
- 21
- 23
- 24
- 100
- 101
- 200
- 201
- 202
- 203
- 204
- 205
- 206
- 207
- 208
- 209
- 210
- 211
- 212
- 213
- 214
- 215
- 300
- 301
- 1000
- 1001
- 1002
- 1003
- 1004
- 1005
- 1006
- 2000
- 2001
- 2002
- 2003
- 2004
- 2005
- 2006
- 2007
- 2008
- 2009
- 2010
- 2011
- 2012
- 2013
- 2014
- 2015
- 2016
- 2017
- 2018
- 2019
- 2020
- 2021
- 3000
- 3001
- 4001
- 5000
- 5001
- 5003
- 5004
- 5005
- 5006
- 5007
- 5008
- 6000
- 6001
- 7000
- 7001
- 7002
- 7003
- 7004
- 7005
- 7006
- 7007
- -9999
- -1002
- -1001
- -1000
IntelliTracer.ApiV1.PoiPriority:
type: string
x-enumDescriptions:
"-": 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)
enum:
- null
- "-"
- "0"
- "1"
- "2"
- "3"
- "4"
- "5"
- "6"
- "7"
- "8"
- "9"
IntelliTracer.ApiV1.MobileClockingNodeType:
type: number
x-enumDescriptions:
"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
enum:
- null
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
IntelliTracer.ApiV1.MenuJobInputType:
type: number
x-enumDescriptions:
"0": Scan and input
"1": Input only
"2": Scan only
enum:
- null
- 0
- 1
- 2
IntelliTracer.ApiV1.MobileClockingNodeInputFilter:
type: number
x-enumDescriptions:
"0": Free field
"1": Numeric only
"2": Hexadecimal only
"3": Numeric and Symbols only
enum:
- null
- 0
- 1
- 2
- 3
IntelliTracer.ApiV1.AddressLite:
type: object
properties:
Street:
example: Dumolinlaan
description: (default = null)
nullable: true
type: string
HouseNumber:
example: "9"
description: (default = null)
nullable: true
type: string
PostalCode:
example: "8500"
description: (default = null)
nullable: true
type: string
City:
example: Kortrijk
description: (default = null)
nullable: true
type: string
Submunicipality:
example: Kortrijk
description: (default = null)
nullable: true
type: string
Country:
$ref: "#/components/schemas/IntelliTracer.Domain.Country"
_typeDescriptor:
type: string
IntelliTracer.ApiV1.Address:
type: object
properties:
CountryName:
example: Belgium
description: (default = null)
nullable: true
type: string
AddressLine:
example: Dumolinlaan 9, 8500 Kortrijk, BE
description: (default = null)
nullable: true
type: string
PoiList:
items:
anyOf:
- type: string
example: 00000000-0000-0000-0000-000000000000
- type: string
example: 00000000-0000-0000-0000-000000000000
description: |-
(default = null)
List of point-of-interests, the unique id only.
nullable: true
type: array
City:
example: Kortrijk
description: (default = null)
nullable: true
type: string
CityLine:
example: 8500 Kortrijk, BE
description: |-
(default = null)
The postalnumber, city and country as a text line.
nullable: true
type: string
CountryCode:
$ref: "#/components/schemas/IntelliTracer.Domain.Country"
HouseNumber:
example: "9"
description: (default = null)
nullable: true
type: string
Latitude:
example: 50.812939
description: >-
(default = null)
Geographic coordinate that specifies the north–south position of a point on the Earth's surface.
nullable: true
type: number
Longitude:
example: 3.245304
description: >-
(default = null)
Geographic coordinate that specifies the east–west position of a point on the Earth's surface.
nullable: true
type: number
PostalCode:
example: "8500"
nullable: true
type: string
ShortAddressLine:
example: Dumolinlaan 9, Kortrijk, BE
description: (default = null)
nullable: true
type: string
Street:
example: Dumolinlaan
description: (default = null)
nullable: true
type: string
StreetLine:
example: Dumolinlaan 9
description: (default = null)
nullable: true
type: string
Submunicipality:
example: Kortrijk
description: (default = null)
nullable: true
type: string
_typeDescriptor:
type: string
IntelliTracer.ApiV2.Address:
type: object
properties:
CountryName:
example: Belgium
description: (default = null)
nullable: true
type: string
AddressLine:
example: Dumolinlaan 9, 8500 Kortrijk, BE
description: (default = null)
nullable: true
type: string
PoiList:
items:
anyOf:
- type: string
example: 00000000-0000-0000-0000-000000000000
- type: string
example: 00000000-0000-0000-0000-000000000000
description: |-
(default = null)
List of point-of-interests, the unique id only.
nullable: true
type: array
City:
example: Kortrijk
description: (default = null)
nullable: true
type: string
CityLine:
example: 8500 Kortrijk, BE
description: |-
(default = null)
The postalnumber, city and country as a text line.
nullable: true
type: string
CountryCode:
$ref: "#/components/schemas/IntelliTracer.Domain.Country"
HouseNumber:
example: "9"
description: (default = null)
nullable: true
type: string
Latitude:
example: 50.812939
description: >-
(default = null)
Geographic coordinate that specifies the north–south position of a point on the Earth's surface.
nullable: true
type: number
Longitude:
example: 3.245304
description: >-
(default = null)
Geographic coordinate that specifies the east–west position of a point on the Earth's surface.
nullable: true
type: number
PostalCode:
example: "8500"
nullable: true
type: string
ShortAddressLine:
example: Dumolinlaan 9, Kortrijk, BE
description: (default = null)
nullable: true
type: string
Street:
example: Dumolinlaan
description: (default = null)
nullable: true
type: string
StreetLine:
example: Dumolinlaan 9
description: (default = null)
nullable: true
type: string
Submunicipality:
example: Kortrijk
description: (default = null)
nullable: true
type: string
_typeDescriptor:
type: string
IntelliTracer.ApiV1.GeoCodeLite:
type: object
properties:
Address:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV1.AddressLite"
- nullable: true
Longitude:
type: number
example: 3.245304
description: >-
(default = 0.0)
Geographic coordinate that specifies the east–west position of a point on the Earth's surface.
Latitude:
type: number
example: 50.812939
description: >-
(default = 0.0)
Geographic coordinate that specifies the north–south position of a point on the Earth's surface.
_typeDescriptor:
type: string
IntelliTracer.ApiV1.VehicleLite:
type: object
required:
- Id
- Name
properties:
Id:
type: string
example: 00000000-0000-0000-0000-000000000000
Code:
example: "012345"
description: (default = null)
nullable: true
type: string
Name:
type: string
example: Vehicle 1
IntelliTracer.ApiV1.CostCenter:
type: object
required:
- Id
- Name
properties:
Id:
type: string
example: 00000000-0000-0000-0000-000000000000
Name:
type: string
example: Workplace 1
Code:
example: "012345"
description: (default = null)
nullable: true
type: string
Poi:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV1.Poi"
- nullable: true
_typeDescriptor:
type: string
IntelliTracer.ApiV1.MobileClockingNodeValidationResult:
type: object
required:
- Entity
- ValidationResult
properties:
Entity:
$ref: "#/components/schemas/IntelliTracer.ApiV1.MobileClockingNode"
ValidationResult:
type: array
items: {}
IntelliTracer.ApiV2.WorkplaceInfo:
type: object
required:
- Id
- DUC
properties:
Id:
type: string
example: 00000000-0000-0000-0000-000000000000
DUC:
type: string
Code:
example: "012345"
description: (default = null)
nullable: true
type: string
Name:
example: GeoDynamics
description: (default = null)
nullable: true
type: string
IntelliTracer.ApiV2.PoiInfo:
type: object
required:
- Id
- Name
properties:
Id:
type: string
example: 00000000-0000-0000-0000-000000000000
Name:
type: string
example: Home
Code:
example: "012345"
description: "(default = null) "
nullable: true
type: string
IntelliTracer.ApiV2.GSM:
type: object
required:
- Id
- Number
properties:
Id:
type: string
example: 00000000-0000-0000-0000-000000000000
Number:
type: string
example: "+32478123456"
IntelliTracer.ApiV2.AbsenceType:
type: object
required:
- Name
- AbsenceCode
properties:
Name:
example: Sickness
description: (default = null)
nullable: true
type: string
AbsenceCode:
example: "100"
description: (default = null)
nullable: true
type: string
Paid:
type: boolean
description: (default = false)
TemporaryUnemployment:
type: boolean
description: (default = false)
Color:
example: "#000000"
description: (default = null)
nullable: true
type: string
IncludeInExport:
type: boolean
example: true
description: >-
(default = true)
Determines whether absences of this type will be included in exports to social secretaries created through specific Excel exports generated via our website.
IntelliTracer.ApiV1.Poi:
type: object
required:
- Id
- Name
properties:
Id:
type: string
example: 00000000-0000-0000-0000-000000000000
Name:
type: string
example: Work
Code:
example: "012345"
description: (default = null)
nullable: true
type: string
PoiType:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV1.PoiType"
- nullable: true
IsAssetLocation:
type: boolean
description: (default = false)
Street:
example: Dumolinlaan
description: (default = null)
nullable: true
type: string
HouseNumber:
example: "9"
description: (default = null)
nullable: true
type: string
City:
example: Kortrijk
description: (default = null)
nullable: true
type: string
Submunicipality:
example: Kortrijk
description: (default = null)
nullable: true
type: string
PostalCode:
example: "8500"
description: (default = null)
nullable: true
type: string
Country:
$ref: "#/components/schemas/IntelliTracer.Domain.Country"
Priority:
allOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV1.PoiPriority"
- type: object
properties: {}
description: >-
(default = null)
Determines which POI will be displayed on top in IntelliTracer (in case of overlapping POIs).
nullable: true
Description:
example: Work
description: (default = null)
nullable: true
type: string
GeographyWkt:
example: POLYGON ((3.145219 50.81309, 3.244998 50.81309, 3.244998 50.91806,
3.145219 50.91806, 3.145219 50.81309))
description: |-
(default = null)
The coordinates of all points that define the shape of the POI.
nullable: true
type: string
LonMin:
type: number
example: 3.145219
description: |-
(default = 0.0)
Lowest longitude coordinate of the shape of the POI.
LonMax:
type: number
example: 3.244998
description: |-
(default = 0.0)
Highest longitude coordinate of the shape of the POI.
LatMin:
type: number
example: 50.81309
description: |-
(default = 0.0)
Lowest latitude coordinate of the shape of the POI.
LatMax:
type: number
example: 50.91806
description: |-
(default = 0.0)
Highest latitude coordinate of the shape of the POI.
MarkerLon:
example: 3.145219
description: |-
(default = null)
Longitude coordinate of the marker.
nullable: true
type: number
MarkerLat:
example: 50.81309
description: |-
(default = null)
Latitude coordinate of the marker.
nullable: true
type: number
IsLambert72:
type: boolean
description: >-
(default = false)
Different geological projection system often used by Belgian governmental institutes.
Radius:
example: 0.03
description: >-
(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).
nullable: true
type: number
ReverseGeocoding:
description: >-
(default = false)
Indicates whether location will be determined by position or address.
nullable: true
type: boolean
Groups:
items:
$ref: "#/components/schemas/IntelliTracer.ApiV1.PoiGroup"
description: (default = null)
nullable: true
type: array
_typeDescriptor:
type: string
IntelliTracer.ApiV1.PoiType:
type: object
required:
- Id
- Name
properties:
Id:
type: string
example: 00000000-0000-0000-0000-000000000000
Name:
type: string
example: Work place
Color:
example: "#00FF2F"
description: |-
(default = null)
Color to be used for POIs of this type in IntelliTracer.
nullable: true
type: string
_typeDescriptor:
type: string
IntelliTracer.ApiV1.PoiGroup:
type: object
required:
- Id
- Name
properties:
Id:
type: string
example: 00000000-0000-0000-0000-000000000000
Name:
type: string
example: Work places
Pois:
items:
$ref: "#/components/schemas/IntelliTracer.ApiV1.Poi"
description: (default = [])
nullable: true
type: array
NumberOfPois:
type: number
example: 1
description: (default = 0)
_typeDescriptor:
type: string
IntelliTracer.ApiV1.PoiLiteWithCode:
type: object
required:
- Id
- Name
properties:
Id:
type: string
example: 00000000-0000-0000-0000-000000000000
Name:
type: string
example: Work
Code:
example: "012345"
description: (default = null)
nullable: true
type: string
IntelliTracer.ApiV1.User:
type: object
required:
- Id
- Name
properties:
Id:
type: string
example: 00000000-0000-0000-0000-000000000000
Name:
type: string
example: John Doe
Code:
example: "012345"
description: (default = null)
nullable: true
type: string
EmployerCode:
example: "012345"
description: (default = null)
nullable: true
type: string
Email:
example: john.doe@doe.com
description: (default = null)
nullable: true
type: string
Gsm:
example: "+32477665544"
description: (default = null)
nullable: true
type: string
FreeField1:
description: (default = null)
nullable: true
type: string
FreeField2:
description: (default = null)
nullable: true
type: string
FreeField3:
description: (default = null)
nullable: true
type: string
FreeField4:
description: (default = null)
nullable: true
type: string
FreeField5:
description: (default = null)
nullable: true
type: string
FreeField6:
description: "(default = null) "
nullable: true
type: string
Notes:
description: (default = null)
nullable: true
type: string
Street:
example: Dumolinlaan
description: (default = null)
nullable: true
type: string
HouseNumber:
example: "9"
description: (default = null)
nullable: true
type: string
City:
example: Kortrijk
description: (default = null)
nullable: true
type: string
PostalCode:
example: "8500"
description: (default = null)
nullable: true
type: string
Submunicipality:
example: Kortrijk
description: (default = null)
nullable: true
type: string
Country:
$ref: "#/components/schemas/IntelliTracer.Domain.Country"
Longitude:
example: 3.245304
description: >-
(default = null)
Geographic coordinate that specifies the east–west position of a point on the Earth's surface.
nullable: true
type: number
Latitude:
example: 50.812939
description: >-
(default = null)
Geographic coordinate that specifies the north–south position of a point on the Earth's surface.
nullable: true
type: number
DefaultDayProgram:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV1.DayProgramLite"
- nullable: true
Groups:
items:
$ref: "#/components/schemas/IntelliTracer.ApiV1.ResourceGroup"
description: (default = null)
nullable: true
type: array
_typeDescriptor:
type: string
IntelliTracer.ApiV1.Vehicle:
type: object
required:
- Id
- Name
properties:
Id:
type: string
example: 00000000-0000-0000-0000-000000000000
Name:
type: string
example: Vehicle 1
IvrCode:
description: >-
(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.
nullable: true
type: number
Code:
example: "012345"
description: (default = null)
nullable: true
type: string
Category:
$ref: "#/components/schemas/IntelliTracer.Domain.VehicleCategory"
FuelType:
allOf:
- $ref: "#/components/schemas/IntelliTracer.Domain.VehicleFuelType"
- type: object
properties: {}
description: (default = 0)
Co2Emission:
example: 80
description: >-
(default = null)
Average C02 emission for this vehicle in grams per kilometer. Only used in IntelliTracer V3.
nullable: true
type: number
RowOfSeatsCount:
example: 2
description: |-
(default = null)
Amount of seat rows in the vehicle. Only used in IntelliTracer V3.
nullable: true
type: number
SeatsCount:
example: 5
description: |-
(default = null)
Amount of seats in the vehicle. Only used in IntelliTracer V3.
nullable: true
type: number
LicensePlate:
example: 1-ABC-123
description: (default = null)
nullable: true
type: string
VinNumber:
example: ABCDE01234F567890
description: |-
(default = null)
Vehicle identification number.
nullable: true
type: string
HasTrackingData:
type: boolean
description: (default = false)
LastReportDate:
example: 2019-03-19T11:45:47+01:00
description: >-
(default = null)
Date and time of the most recent tracking report we have received from this vehicle.
nullable: true
type: string
LastSyncDate:
example: 2019-03-19T11:45:47+01:00
description: >-
(default = null)
Date and time of the most recent sync report we have received from this vehicle.
nullable: true
type: string
UserNotes:
description: |-
(default = null)
Any additional information of your choice can be entered here.
nullable: true
type: string
Weight:
type: number
example: 600
description: |-
(default = 0)
Weight of this vehicle in kilograms.
EmissionStandard:
allOf:
- $ref: "#/components/schemas/IntelliTracer.Domain.VehicleEuropeanEmissionStandar\
d"
- type: object
properties: {}
description: |-
(default = 0)
European emission standard for this vehicle.
MaximumSpeed:
example: 220
description: (default = null)
nullable: true
type: number
NominalConsumption:
type: number
example: 5.5
description: |-
(default = 0.0)
Fuel consumption of this vehicle in liters per 100km.
CostCenter:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV1.CostCenter"
- nullable: true
Groups:
items:
$ref: "#/components/schemas/IntelliTracer.ApiV1.ResourceGroup"
description: "(default = null) "
nullable: true
type: array
_typeDescriptor:
type: string
IntelliTracer.ApiV1.ResourceGroup:
type: object
required:
- Id
- Name
properties:
Id:
type: string
example: 00000000-0000-0000-0000-000000000000
Name:
type: string
example: Employees
Type:
$ref: "#/components/schemas/IntelliTracer.ApiV1.ResourceType"
Code:
example: "012345"
description: (default = null)
nullable: true
type: string
_typeDescriptor:
type: string
IntelliTracer.ApiV1.DayProgramLite:
type: object
required:
- Id
- Name
properties:
Id:
type: string
example: 00000000-0000-0000-0000-000000000000
Name:
type: string
example: Default
_typeDescriptor:
type: string
IntelliTracer.ApiV1.MobileClockingNode:
type: object
required:
- Id
properties:
Id:
type: string
example: 00000000-0000-0000-0000-000000000000
Name_Nl:
description: (default = null)
nullable: true
type: string
Name_Fr:
description: (default = null)
nullable: true
type: string
Name_En:
description: (default = null)
nullable: true
type: string
Name_Pl:
description: (default = null)
nullable: true
type: string
Type:
$ref: "#/components/schemas/IntelliTracer.ApiV1.MobileClockingNodeType"
FilterText:
description: >-
(default = null)
Filters the visible mobile clocking nodes based on what's in the "Filter/IVR code" field in the config of the logged in user. Only nodes in which that field matches the FilterText will be visible for that user.
nullable: true
type: string
Prefix:
description: >-
(default = null)
This prefix will automatically be added in front of the jobnumber entered by the user.
nullable: true
type: string
JobNumber:
example: 1575-7577-4
description: >-
(default = null)
Job number used for postcalculation or activity based timeregistration
nullable: true
type: string
Regex:
description: >-
(default = null)
A jobnumber entered by the user will only be accepted if it matches this regex.
nullable: true
type: string
InputFilter:
$ref: "#/components/schemas/IntelliTracer.ApiV1.MobileClockingNodeInputFilter"
InputType:
$ref: "#/components/schemas/IntelliTracer.ApiV1.MenuJobInputType"
ClockingType:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.Domain.ClockingType"
- nullable: true
Children:
items:
$ref: "#/components/schemas/IntelliTracer.ApiV1.MobileClockingNodeChild"
description: |-
(default = null)
Only for folders. Children of this mobile clocking node.
nullable: true
type: array
PoiGroupId:
example: 00000000-0000-0000-0000-000000000000
nullable: true
type: string
PoiRequired:
type: boolean
description: (default = false)
ValidatePoiCode:
type: boolean
description: (default = false)
CostCenterGroupId:
example: 00000000-0000-0000-0000-000000000000
nullable: true
type: string
CostCenterRequired:
type: boolean
description: (default = false)
ValidateCostCenterCode:
type: boolean
description: (default = false)
ExternalCode:
description: (default = null)
nullable: true
type: string
ExternalType:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.Domain.ExternalClockingType"
- nullable: true
_typeDescriptor:
type: string
IntelliTracer.ApiV1.MobileClockingNodeChild:
$ref: "#/components/schemas/IntelliTracer.ApiV1.MobileClockingNode"
IntelliTracer.ApiV3.PoiLiteWithCode:
type: object
required:
- Id
- Name
properties:
Id:
type: string
example: 00000000-0000-0000-0000-000000000000
Name:
type: string
example: Work
Code:
example: "012345"
description: (default = null)
nullable: true
type: string
IntelliTracer.ApiV3.Address:
type: object
properties:
Street:
example: Dumolinlaan
description: (default = null)
nullable: true
type: string
HouseNumber:
example: "9"
description: (default = null)
nullable: true
type: string
City:
example: Kortrijk
description: (default = null)
nullable: true
type: string
Submunicipality:
example: Kortrijk
description: (default = null)
nullable: true
type: string
PostalCode:
example: "8500"
description: (default = null)
nullable: true
type: string
Country:
$ref: "#/components/schemas/IntelliTracer.Domain.CountryString"
Latitude:
example: 50.81293
description: (default = null)
nullable: true
type: number
Longitude:
example: 3.2453
description: (default = null)
nullable: true
type: number
IntelliTracer.ApiV3.Location:
type: object
properties:
Address:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV3.Address"
- nullable: true
Pois:
items:
$ref: "#/components/schemas/IntelliTracer.ApiV3.PoiLiteWithCode"
description: (default = null)
nullable: true
type: array
Longitude:
example: 3.2453
description: (default = null)
nullable: true
type: number
Latitude:
example: 50.81293
description: (default = null)
nullable: true
type: number
IntelliTracer.ApiV3.AbsenceType:
type: object
required:
- Id
- Name
- Code
- Paid
- TemporaryUnemployed
- Color
- IncludeInExport
properties:
Id:
type: string
example: 00000000-0000-0000-0000-000000000000
Name:
type: string
example: Sick leave
Code:
type: string
example: SICKNESS
Paid:
type: boolean
example: true
TemporaryUnemployed:
type: boolean
Color:
type: string
example: "#FF0000"
IncludeInExport:
type: boolean
example: true
IntelliTracer.ApiV1.PoiCreate:
type: object
required:
- Name
- PoiType
- Priority
properties:
Name:
type: string
example: Work
description: max length = 50
Code:
example: "012345"
description: |-
default = null
max length = 500
nullable: true
type: string
PoiType:
$ref: "#/components/schemas/IntelliTracer.Api.Id"
IsAssetLocation:
type: boolean
description: (default = false)
Street:
example: Dumolinlaan
description: |-
default = null
max length = 70
nullable: true
type: string
HouseNumber:
example: "9"
description: |-
default = null
max length = 10
nullable: true
type: string
City:
example: Kortrijk
description: |-
default = null
max length = 70
nullable: true
type: string
Submunicipality:
example: Kortrijk
description: |-
default = null
max length = 70
nullable: true
type: string
PostalCode:
example: "8500"
description: |-
default = null
max length = 10
nullable: true
type: string
Country:
$ref: "#/components/schemas/IntelliTracer.Domain.Country"
Priority:
allOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV1.PoiPriority"
- type: object
properties: {}
description: >-
(default = -)
Determines which POI will be displayed on top in IntelliTracer (in case of overlapping POIs).
Description:
example: Work
description: (default = null)
nullable: true
type: string
MarkerLon:
example: 3.145219
description: |-
(default = null)
Longitude coordinate
nullable: true
type: number
MarkerLat:
example: 50.81309
description: |-
(default = null)
Latitude coordinate
nullable: true
type: number
IsLambert72:
type: boolean
description: >-
(default = false)
Different geological projection system often used by Belgian governmental institutes.
Radius:
example: 0.03
description: >-
(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).
nullable: true
type: number
ReverseGeocoding:
description: >-
(default = false)
Indicates whether location will be determined by position or address.
nullable: true
type: boolean
IntelliTracer.ApiV1.ResourceGroupValidationResult:
type: object
required:
- Entity
- ValidationResult
properties:
Entity:
$ref: "#/components/schemas/IntelliTracer.ApiV1.ResourceGroup"
ValidationResult:
type: array
items: {}
IntelliTracer.ApiV1.VehicleValidationResult:
type: object
required:
- Entity
- ValidationResult
properties:
Entity:
$ref: "#/components/schemas/IntelliTracer.ApiV1.Vehicle"
ValidationResult:
type: array
items: {}
IntelliTracer.ApiV1.VehicleCreate:
type: object
required:
- Name
properties:
Name:
type: string
example: Vehicle 1
IvrCode:
description: >-
(default = null)
Code field that can be used for IVR based identification and app based filtering.
nullable: true
type: string
Code:
example: "012345"
description: (default = null)
nullable: true
type: string
Category:
$ref: "#/components/schemas/IntelliTracer.Domain.VehicleCategory"
FuelType:
allOf:
- $ref: "#/components/schemas/IntelliTracer.Domain.VehicleFuelType"
- type: object
properties: {}
description: (default = 0)
Co2Emission:
example: 80
description: (default = null)
nullable: true
type: number
RowOfSeatsCount:
example: 2
description: |-
(default = null)
Number of seat rows
nullable: true
type: number
SeatsCount:
example: 5
description: |-
(default = null)
Number of seats
nullable: true
type: number
LicensePlate:
example: 1-ABC-123
description: (default = null)
nullable: true
type: string
VinNumber:
example: ABCDE01234F567890
description: |-
(default = null)
Vehicle Identification Number
nullable: true
type: string
HasTrackingData:
type: boolean
description: (default = false)
LastReportDate:
example: 2019-03-19T11:45:47+01:00
description: |-
(default = null)
Datetime of the most recent report.
nullable: true
type: string
LastSyncDate:
example: 2019-03-19T11:45:47+01:00
description: |-
(default = null)
Datetime of the most recent server synchronization.
nullable: true
type: string
UserNotes:
description: |-
(default = null)
User notes
nullable: true
type: string
Weight:
type: number
example: 600
description: |-
(default = 0)
Weight for viapass.
EmissionStandard:
allOf:
- $ref: "#/components/schemas/IntelliTracer.Domain.VehicleEuropeanEmissionStandar\
d"
- type: object
properties: {}
description: |-
(default = 0)
Emission standard for viapass
MaximumSpeed:
example: 220
description: (default = null)
nullable: true
type: number
NominalConsumption:
type: number
example: 5.5
description: |-
(default = 0.0)
Normal consumption for Fleet Eco
CostCenter:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.Api.Id"
- nullable: true
IntelliTracer.ApiV1.VehicleUpdate:
type: object
required:
- Id
- Name
properties:
Id:
type: string
example: 00000000-0000-0000-0000-000000000000
Name:
type: string
example: Vehicle 1
IvrCode:
description: >-
(default = null)
Code field that can be used for IVR based identification and app based filtering.
nullable: true
type: string
Code:
example: "012345"
description: (default = null)
nullable: true
type: string
Category:
$ref: "#/components/schemas/IntelliTracer.Domain.VehicleCategory"
FuelType:
allOf:
- $ref: "#/components/schemas/IntelliTracer.Domain.VehicleFuelType"
- type: object
properties: {}
description: (default = 0)
Co2Emission:
example: 80
description: (default = null)
nullable: true
type: number
RowOfSeatsCount:
example: 2
description: |-
(default = null)
Number of seat rows
nullable: true
type: number
SeatsCount:
example: 5
description: |-
(default = null)
Number of seats
nullable: true
type: number
LicensePlate:
example: 1-ABC-123
description: (default = null)
nullable: true
type: string
VinNumber:
example: ABCDE01234F567890
description: |-
(default = null)
Vehicle Identification Number
nullable: true
type: string
HasTrackingData:
type: boolean
description: (default = false)
LastReportDate:
example: 2019-03-19T11:45:47+01:00
description: |-
(default = null)
Datetime of the most recent report.
nullable: true
type: string
LastSyncDate:
example: 2019-03-19T11:45:47+01:00
description: |-
(default = null)
Datetime of the most recent server synchronization.
nullable: true
type: string
UserNotes:
description: |-
(default = null)
User notes
nullable: true
type: string
Weight:
type: number
example: 600
description: |-
(default = 0)
Weight for viapass.
EmissionStandard:
allOf:
- $ref: "#/components/schemas/IntelliTracer.Domain.VehicleEuropeanEmissionStandar\
d"
- type: object
properties: {}
description: |-
(default = 0)
Emission standard for viapass
MaximumSpeed:
example: 220
description: (default = null)
nullable: true
type: number
NominalConsumption:
type: number
example: 5.5
description: |-
(default = 0.0)
Normal consumption for Fleet Eco
CostCenter:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.Api.Id"
- nullable: true
IntelliTracer.ApiV2.TimeClockReaderType:
type: number
x-enumDescriptions:
"0": MF7
"1": GP20
"2": MF7 Construbadge
"3": RF4 5
enum:
- null
- 0
- 1
- 2
- 3
IntelliTracer.ApiV2.TimeClockType:
type: number
x-enumDescriptions:
"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
enum:
- null
- 0
- 2
- 3
- 4
- 5
- 6
- 7
IntelliTracer.ApiV2.TimeClockFirmwareVersion:
type: number
x-enumDescriptions:
"0": v1_2
"1": v1_3
"2": v2_1
enum:
- null
- 0
- 1
- 2
IntelliTracer.ApiV2.PagedTimeClockResponse:
type: object
properties:
Data:
items:
$ref: "#/components/schemas/IntelliTracer.ApiV2.TimeClock"
description: (default = null)
nullable: true
type: array
PagingFilter:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.Api.PagingFilter"
- nullable: true
IntelliTracer.ApiV2.TimeClockResponse:
type: object
properties:
Data:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV2.TimeClock"
- nullable: true
IntelliTracer.ApiV2.TimeClock:
type: object
required:
- Id
- Name
- UnitId
- ReaderType
- TimeClockType
- FirmwareVersion
properties:
Id:
type: string
example: 00000000-0000-0000-0000-000000000000
Name:
type: string
example: Work
Code:
example: "012345"
description: (default = null)
nullable: true
type: string
UnitId:
type: number
example: 123456
SerialNumber:
example: "012345"
description: (default = null)
nullable: true
type: string
ReaderType:
allOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV2.TimeClockReaderType"
- type: object
properties: {}
description: (default = 0)
TimeClockType:
allOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV2.TimeClockType"
- type: object
properties: {}
description: (default = 0)
FirmwareVersion:
allOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV2.TimeClockFirmwareVersion"
- type: object
properties: {}
description: (default = 0)
Address:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV2.Address"
- nullable: true
Latitude:
example: 50.812939
description: >-
(default = null)
Geographic coordinate that specifies the north–south position of a point on the Earth's surface.
nullable: true
type: number
Longitude:
example: 3.245304
description: >-
(default = null)
Geographic coordinate that specifies the east–west position of a point on the Earth's surface.
nullable: true
type: number
CostCenter:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV2.Resource"
- nullable: true
LastReadDateLocal:
example: 2019-01-25T08:29:37
description: (default = null)
nullable: true
type: string
LastReadDateUtc:
example: 2019-01-25T07:29:37
description: (default = null)
nullable: true
type: string
LastWriteDateLocal:
example: 2019-01-25T08:29:37
description: (default = null)
nullable: true
type: string
LastWriteDateUtc:
example: 2019-01-25T07:29:37
description: (default = null)
nullable: true
type: string
IntelliTracer.ApiV2.TimeValidationVerification:
type: object
required:
- DateUtc
- DateLocal
- UserIds
properties:
DateUtc:
type: string
example: 2019-01-25T07:00:00
DateLocal:
type: string
example: 2019-01-25T08:00:00
UserIds:
type: array
items: {}
IntelliTracer.ApiV2.TimeValidationVerificationResponse:
type: object
properties:
Data:
items:
$ref: "#/components/schemas/IntelliTracer.ApiV2.TimeValidationVerification"
description: (default = null)
nullable: true
type: array
IntelliTracer.ApiV1.PoiTypeLevel:
type: number
x-enumDescriptions:
"0": Street
"1": Suburb
"2": City
"3": District
"4": Province
"5": Region
"6": Country
"7": Continent
enum:
- null
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
IntelliTracer.ApiV1.PoiTypeValidationResult:
type: object
required:
- Entity
- ValidationResult
properties:
Entity:
$ref: "#/components/schemas/IntelliTracer.ApiV1.PoiType"
ValidationResult:
type: array
items: {}
IntelliTracer.ApiV2.PagedPoiResponse:
type: object
properties:
Data:
items:
$ref: "#/components/schemas/IntelliTracer.ApiV2.Poi"
nullable: true
type: array
PagingFilter:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.Api.PagingFilter"
- nullable: true
IntelliTracer.ApiV2.ListPoiResponse:
type: object
properties:
Data:
items:
$ref: "#/components/schemas/IntelliTracer.ApiV2.Poi"
nullable: true
type: array
IntelliTracer.ApiV2.PoiResponse:
type: object
properties:
Data:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV2.Poi"
- nullable: true
IntelliTracer.ApiV1.PoiValidationResult:
type: object
required:
- Entity
- ValidationResult
properties:
Entity:
$ref: "#/components/schemas/IntelliTracer.ApiV1.Poi"
ValidationResult:
type: array
items: {}
IntelliTracer.ApiV2.PoiValidationResult:
type: object
required:
- Entity
- ValidationResult
properties:
Entity:
$ref: "#/components/schemas/IntelliTracer.ApiV2.Poi"
ValidationResult:
type: array
items: {}
IntelliTracer.ApiV2.PoiLiteValidationResult:
type: object
required:
- Entity
- ValidationResult
properties:
Entity:
$ref: "#/components/schemas/IntelliTracer.ApiV2.PoiLiteRequest"
ValidationResult:
type: array
items: {}
IntelliTracer.ApiV1.PoiGroupCreate:
type: object
required:
- Name
properties:
Name:
type: string
example: Work places
IntelliTracer.ApiV1.PoiGroupUpdate:
allOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV1.PoiGroupCreate"
- type: object
required:
- Id
properties:
Id:
type: string
example: 00000000-0000-0000-0000-000000000000
IntelliTracer.ApiV1.PoiGroupValidationResult:
type: object
required:
- Entity
- ValidationResult
properties:
Entity:
$ref: "#/components/schemas/IntelliTracer.ApiV1.PoiGroup"
ValidationResult:
type: array
items: {}
IntelliTracer.ApiV1.PoiTypeCreate:
type: object
required:
- Name
properties:
Name:
type: string
example: Work place
Color:
example: "#00FF2F"
description: |-
(default = null)
Color to be used for POIs of this type in IntelliTracer.
nullable: true
type: string
IntelliTracer.ApiV1.PoiTypeUpdate:
allOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV1.PoiTypeCreate"
- type: object
required:
- Id
properties:
Id:
type: string
example: 00000000-0000-0000-0000-000000000000
IntelliTracer.ApiV2.PoiLiteRequest:
type: object
required:
- Id
- Name
- PoiTypeId
- Priority
properties:
Id:
type: string
example: 00000000-0000-0000-0000-000000000000
Name:
type: string
example: Work
Code:
example: "012345"
description: (default = null)
nullable: true
type: string
PoiTypeId:
type: string
example: 00000000-0000-0000-0000-000000000000
IsAssetLocation:
type: boolean
description: (default = false)
Priority:
allOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV1.PoiPriority"
- type: object
properties: {}
description: (default = -)
Description:
example: Work
description: (default = null)
nullable: true
type: string
IntelliTracer.ApiV1.PoiUpdate:
allOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV1.PoiCreate"
- type: object
required:
- Id
properties:
Id:
type: string
example: 00000000-0000-0000-0000-000000000000
IntelliTracer.ApiV1.PoiLite:
type: object
required:
- Id
- Name
properties:
Id:
type: string
example: 00000000-0000-0000-0000-000000000000
Name:
type: string
example: Work
IntelliTracer.ApiV2.Poi:
type: object
required:
- Id
- Name
- IsAssetLocation
properties:
Id:
type: string
example: 00000000-0000-0000-0000-000000000000
Code:
example: "012345"
description: (default = null)
nullable: true
type: string
Name:
type: string
example: Work
Street:
example: Dumolinlaan
description: (default = null)
nullable: true
type: string
HouseNumber:
example: "9"
description: (default = null)
nullable: true
type: string
City:
example: Kortrijk
description: (default = null)
nullable: true
type: string
Submunicipality:
example: Kortrijk
description: (default = null)
nullable: true
type: string
PostalCode:
example: "8500"
description: (default = null)
nullable: true
type: string
Country:
$ref: "#/components/schemas/IntelliTracer.Domain.Country"
Priority:
allOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV1.PoiPriority"
- type: object
properties: {}
description: (default = null)
nullable: true
Description:
example: Work
description: (default = null)
nullable: true
type: string
GeographyWkt:
example: POLYGON ((3.145219 50.81309, 3.244998 50.81309, 3.244998 50.91806,
3.145219 50.91806, 3.145219 50.81309))
description: (default = null)
nullable: true
type: string
LonMin:
type: number
example: 3.145219
description: (default = 0.0)
LonMax:
type: number
example: 3.244998
description: (default = 0.0)
LatMin:
type: number
example: 50.81309
description: (default = 0.0)
LatMax:
type: number
example: 50.91806
description: (default = 0.0)
MarkerLon:
example: 3.145219
description: (default = null)P
nullable: true
type: number
MarkerLat:
example: 50.81309
description: (default = null)
nullable: true
type: number
IsAssetLocation:
type: boolean
description: (default = false)
Type:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV2.PoiType"
- nullable: true
Groups:
items:
$ref: "#/components/schemas/IntelliTracer.ApiV2.PoiGroup"
description: (default = null)
nullable: true
type: array
IntelliTracer.ApiV2.PoiLiteWithCode:
type: object
required:
- Id
- Name
properties:
Id:
type: string
example: 00000000-0000-0000-0000-000000000000
Name:
type: string
example: Work
Code:
example: "012345"
description: (default = null)
nullable: true
type: string
IntelliTracer.ApiV2.PoiType:
type: object
required:
- Id
- Name
properties:
Id:
type: string
example: 00000000-0000-0000-0000-000000000000
Name:
type: string
example: Work place
Level:
$ref: "#/components/schemas/IntelliTracer.ApiV1.PoiTypeLevel"
Color:
example: "#00FF2F"
description: (default = null)
nullable: true
type: string
IntelliTracer.ApiV2.PoiGroup:
type: object
required:
- Id
- Name
properties:
Id:
type: string
example: 00000000-0000-0000-0000-000000000000
Name:
type: string
example: Work places
IntelliTracer.ApiV2.RFIDTagType:
type: number
x-enumDescriptions:
"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
enum:
- null
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
IntelliTracer.ApiV2.RFIDTagPagedDataResponse:
type: object
properties:
Data:
items:
$ref: "#/components/schemas/IntelliTracer.ApiV2.RFIDTagResponse"
nullable: true
type: array
PagingFilter:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.Api.PagingFilter"
- nullable: true
IntelliTracer.ApiV2.RFIDTagRequestValidationResult:
type: object
required:
- Entity
- ValidationResult
properties:
Entity:
$ref: "#/components/schemas/IntelliTracer.ApiV2.RFIDTagBase"
ValidationResult:
type: array
items: {}
IntelliTracer.ApiV2.RFIDTagBase:
type: object
required:
- InternalNumber
- Type
properties:
Id:
type: string
example: 00000000-0000-0000-0000-000000000000
InternalNumber:
type: string
example: 00AA11BB
ExternalNumber:
type: string
example: "12345678"
description: (default = null)
Type:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV2.RFIDTagType"
- nullable: true
BeaconRateSeconds:
example: "15.0"
description: (default = null)
nullable: true
type: string
SiteCode:
example: "1234"
description: >-
(default = null)
This field is required for types 'Active Tag Ingecom', 'Active RFID Tag Wavetrend', 'Active/Passive Wavetrend', 'BLE', 'BLE IET10' and 'BLE ELA'.
nullable: true
type: string
PassiveTagNumber:
example: "123456789"
description: |-
(default = null)
This field is required for type 'Active/Passive Wavetrend'.
nullable: true
type: string
MacAddress:
example: AABBCCDDEEFF
description: |-
(default = null)
This field is required for type 'BLE IET10' and 'BLE ELA'.
nullable: true
type: string
IntelliTracer.ApiV2.RFIDTagRequestCreate:
allOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV2.RFIDTagBase"
- type: object
properties:
Id:
type: string
example: 00000000-0000-0000-0000-000000000000
IntelliTracer.ApiV2.RFIDTagRequestUpdate:
allOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV2.RFIDTagBase"
- type: object
required:
- Id
properties:
Id:
type: string
example: 00000000-0000-0000-0000-000000000000
IntelliTracer.ApiV2.RFIDTagResponse:
allOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV2.RFIDTagBase"
- type: object
properties:
User:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV2.Resource"
- nullable: true
IntelliTracer.ApiV2.RFIDTagDataResponse:
type: object
properties:
Data:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV2.RFIDTagResponse"
- nullable: true
IntelliTracer.ApiV2.RFIDTagListDataResponse:
type: object
properties:
Data:
items:
$ref: "#/components/schemas/IntelliTracer.ApiV2.RFIDTagResponse"
nullable: true
type: array
IntelliTracer.ApiV2.PutUserRFIDTagRequest:
type: object
required:
- OverrideExistingUser
properties:
BadgeId:
type: string
example: 00000000-0000-0000-0000-000000000000
InternalNumber:
type: string
example: 00AA11BB
OverrideExistingUser:
type: boolean
IntelliTracer.ApiV2.DeleteUserRFIDTagRequest:
type: object
properties:
BadgeId:
type: string
example: 00000000-0000-0000-0000-000000000000
InternalNumber:
type: string
example: 00AA11BB
IntelliTracer.ApiV2.RFIDTagValidationResult:
type: object
required:
- Entity
- ValidationResult
properties:
Entity:
$ref: "#/components/schemas/IntelliTracer.ApiV2.RFIDTagBase"
ValidationResult:
type: array
items: {}
IntelliTracer.ApiV1.MobileRFIDScanner:
type: object
required:
- Id
properties:
Id:
type: string
example: 00000000-0000-0000-0000-000000000000
UnitId:
type: string
example: "0000000000"
User:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV1.UserLite"
- nullable: true
CostCenter:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV1.CostCenterLite"
- nullable: true
IntelliTracer.ApiV1.MobileRFIDScannersWithPaging:
type: object
properties:
Data:
items:
$ref: "#/components/schemas/IntelliTracer.ApiV1.MobileRFIDScanner"
nullable: true
type: array
PagingFilter:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.Api.PagingFilter"
- nullable: true
IntelliTracer.ApiV1.MobileRFIDScannerUpdate:
type: object
required:
- Id
properties:
Id:
type: string
example: 00000000-0000-0000-0000-000000000000
CurrentUserId:
type: string
example: 00000000-0000-0000-0000-000000000000
CostCenterId:
type: string
example: 00000000-0000-0000-0000-000000000000
IntelliTracer.ApiV1.UserLite:
type: object
required:
- Id
- Name
properties:
Id:
type: string
example: 00000000-0000-0000-0000-000000000000
Name:
type: string
example: John Doe
Code:
example: "012345"
description: (default = null)
nullable: true
type: string
IntelliTracer.ApiV1.CostCenterLite:
type: object
required:
- Id
- Name
properties:
Id:
type: string
example: 00000000-0000-0000-0000-000000000000
Name:
type: string
example: Workplace 1
Code:
example: "012345"
description: (default = null)
nullable: true
type: string
IntelliTracer.ApiV2.SmartphoneType:
type: number
x-enumDescriptions:
"0": Android
"1": iOS
enum:
- null
- 0
- 1
IntelliTracer.ApiV2.SmartphoneOrientation:
type: number
x-enumDescriptions:
"0": Use default
"1": Portrait
"2": Landscape
"3": Landscape (reversed)
enum:
- null
- 0
- 1
- 2
- 3
IntelliTracer.ApiV2.SmartphoneUserIdentification:
type: number
x-enumDescriptions:
"0": Use default
"1": Fixed user
"2": User identification
enum:
- null
- 0
- 1
- 2
IntelliTracer.ApiV2.SmartphoneResourceDetection:
type: number
x-enumDescriptions:
"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
enum:
- null
- 0
- 1
- 2
- 3
- 4
- 5
IntelliTracer.ApiV2.SmartphonePositioning:
type: number
x-enumDescriptions:
"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
enum:
- null
- 0
- 1
- 2
- 3
- 4
IntelliTracer.ApiV2.SmartphoneTeam:
type: number
x-enumDescriptions:
"0": Use default
"1": User only
"2": All available users
enum:
- null
- 0
- 1
- 2
IntelliTracer.ApiV2.SmartphoneTimeRegistration:
type: number
x-enumDescriptions:
"0": Use default
"1": Use menu
"2": Use default clocking
enum:
- null
- 0
- 1
- 2
IntelliTracer.ApiV2.PagedSmartphoneResponse:
type: object
properties:
Data:
items:
$ref: "#/components/schemas/IntelliTracer.ApiV2.SmartphoneResponse"
description: (default = null)
nullable: true
type: array
PagingFilter:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.Api.PagingFilter"
- nullable: true
IntelliTracer.ApiV2.SmartphoneValidationResult:
type: object
required:
- Entity
- ValidationResult
properties:
Entity:
$ref: "#/components/schemas/IntelliTracer.ApiV2.Smartphone"
ValidationResult:
type: array
items: {}
IntelliTracer.ApiV2.SmartphoneBase:
type: object
required:
- Id
- Name
- UId
properties:
Id:
type: string
example: 00000000-0000-0000-0000-000000000000
Name:
type: string
example: Samsung S8
UId:
type: string
example: "000000000"
Active:
type: boolean
example: true
description: (default = true)
Type:
$ref: "#/components/schemas/IntelliTracer.ApiV2.SmartphoneType"
Orientation:
$ref: "#/components/schemas/IntelliTracer.ApiV2.SmartphoneOrientation"
FilterMenusByUserFilter:
type: boolean
description: (default = false)
UserIdentification:
$ref: "#/components/schemas/IntelliTracer.ApiV2.SmartphoneUserIdentification"
UserIdentificationConfig:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV2.SmartphoneUserIdentificationCon\
fig"
- nullable: true
ResourceDetection:
$ref: "#/components/schemas/IntelliTracer.ApiV2.SmartphoneResourceDetection"
ResourceDetectionConfig:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV2.SmartphoneResourceDetectionConf\
ig"
- nullable: true
Positioning:
$ref: "#/components/schemas/IntelliTracer.ApiV2.SmartphonePositioning"
PositioningConfig:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV2.SmartphonePositioningConfig"
- nullable: true
Team:
$ref: "#/components/schemas/IntelliTracer.ApiV2.SmartphoneTeam"
TeamConfig:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV2.SmartphoneTeamConfig"
- nullable: true
TimeRegistration:
$ref: "#/components/schemas/IntelliTracer.ApiV2.SmartphoneTimeRegistration"
TimeRegistrationConfig:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV2.SmartphoneTimeRegistrationConfi\
g"
- nullable: true
IntelliTracer.ApiV2.Smartphone:
allOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV2.SmartphoneBase"
- type: object
properties:
CostCenterId:
example: 00000000-0000-0000-0000-000000000000
nullable: true
type: string
IntelliTracer.ApiV2.SmartphoneCreate:
allOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV2.Smartphone"
- type: object
properties:
Id:
type: string
example: 00000000-0000-0000-0000-000000000000
IntelliTracer.ApiV2.SmartphoneResponse:
allOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV2.SmartphoneBase"
- type: object
properties:
UserIdentificationConfig:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV2.SmartphoneUserIdentificationCon\
figResponse"
- nullable: true
ResourceDetectionConfig:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV2.SmartphoneResourceDetectionConf\
igResponse"
- nullable: true
PositioningConfig:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV2.SmartphonePositioningConfigResp\
onse"
- nullable: true
TimeRegistrationConfig:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV2.SmartphoneTimeRegistrationConfi\
gResponse"
- nullable: true
CostCenter:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV2.Resource"
- nullable: true
IntelliTracer.ApiV2.SmartphoneUserIdentificationConfigBase:
type: object
properties:
ByBadge:
type: boolean
description: (default = false)
ByUserCode:
type: boolean
description: (default = false)
ByCiawCode:
type: boolean
description: (default = false)
IntelliTracer.ApiV2.SmartphoneUserIdentificationConfig:
allOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV2.SmartphoneUserIdentificationCon\
figBase"
- type: object
properties:
FixedUserId:
example: 00000000-0000-0000-0000-000000000000
description: (default = null)
nullable: true
type: string
CiawWorkplaceId:
example: 00000000-0000-0000-0000-000000000000
description: (default = null)
nullable: true
type: string
IntelliTracer.ApiV2.SmartphoneUserIdentificationConfigResponse:
allOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV2.SmartphoneUserIdentificationCon\
figBase"
- type: object
properties:
FixedUser:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV2.Resource"
- nullable: true
CiawWorkplace:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV2.WorkplaceInfo"
- nullable: true
IntelliTracer.ApiV2.SmartphoneResourceDetectionConfig:
type: object
properties:
FixedVehicleId:
example: 00000000-0000-0000-0000-000000000000
description: (default = null)
nullable: true
type: string
VehicleIds:
items:
anyOf:
- type: string
example: 00000000-0000-0000-0000-000000000000
- type: string
example: 00000000-0000-0000-0000-000000000000
description: (default = [])
nullable: true
type: array
IntelliTracer.ApiV2.SmartphoneResourceDetectionConfigResponse:
type: object
properties:
FixedVehicle:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV2.Resource"
- nullable: true
Vehicles:
items:
$ref: "#/components/schemas/IntelliTracer.ApiV2.Resource"
description: (default = [])
nullable: true
type: array
IntelliTracer.ApiV2.SmartphonePositioningConfig:
type: object
properties:
FixedPoiId:
example: 00000000-0000-0000-0000-000000000000
description: (default = null)
nullable: true
type: string
IntelliTracer.ApiV2.SmartphonePositioningConfigResponse:
type: object
properties:
FixedPoi:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV2.PoiInfo"
- nullable: true
IntelliTracer.ApiV2.SmartphoneTeamConfig:
type: object
properties:
GroupUsersByVehicle:
type: boolean
description: (default = false)
IntelliTracer.ApiV2.SmartphoneTimeRegistrationConfig:
type: object
properties:
MenuId:
example: 00000000-0000-0000-0000-000000000000
description: (default = null)
nullable: true
type: string
IntelliTracer.ApiV2.SmartphoneTimeRegistrationConfigResponse:
type: object
properties:
Menu:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV2.MenuNodeInfo"
- nullable: true
IntelliTracer.ApiV2.MenuNodeInfo:
type: object
required:
- Id
- Name
properties:
Id:
type: string
example: 00000000-0000-0000-0000-000000000000
Name:
type: string
IntelliTracer.ApiV2.UserMobilityRule:
type: number
x-enumDescriptions:
"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
enum:
- null
- 0
- 1
- 2
- 5
- 6
- 7
- 8
- 9
- 10
- 12
IntelliTracer.ApiV1.UserValidationResult:
type: object
required:
- Entity
- ValidationResult
properties:
Entity:
$ref: "#/components/schemas/IntelliTracer.ApiV1.User"
ValidationResult:
type: array
items: {}
IntelliTracer.ApiV2.UserCreate:
type: object
required:
- Name
properties:
Name:
type: string
example: John Doe
Code:
example: "012345"
description: (default = null)
nullable: true
type: string
EmployerCode:
example: "012345"
description: (default = null)
nullable: true
type: string
Email:
example: john.doe@doe.com
description: (default = null)
nullable: true
type: string
Gsm:
example: "+32477665544"
description: (default = null)
nullable: true
type: string
FreeField1:
description: (default = null)
nullable: true
type: string
FreeField2:
description: (default = null)
nullable: true
type: string
FreeField3:
description: (default = null)
nullable: true
type: string
FreeField4:
description: (default = null)
nullable: true
type: string
FreeField5:
description: (default = null)
nullable: true
type: string
FreeField6:
description: "(default = null) "
nullable: true
type: string
Notes:
description: (default = null)
nullable: true
type: string
Street:
example: Dumolinlaan
description: (default = null)
nullable: true
type: string
HouseNumber:
example: "9"
description: (default = null)
nullable: true
type: string
City:
example: Kortrijk
description: (default = null)
nullable: true
type: string
PostalCode:
example: "8500"
description: (default = null)
nullable: true
type: string
Submunicipality:
example: Kortrijk
description: (default = null)
nullable: true
type: string
Country:
$ref: "#/components/schemas/IntelliTracer.Domain.Country"
Longitude:
example: 3.245304
description: >-
(default = null)
Geographic coordinate that specifies the east–west position of a point on the Earth's surface.
nullable: true
type: number
Latitude:
example: 50.812939
description: >-
(default = null)
Geographic coordinate that specifies the north–south position of a point on the Earth's surface.
nullable: true
type: number
DefaultDayProgram:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV2.DayProgram"
- nullable: true
MobilityRule:
$ref: "#/components/schemas/IntelliTracer.ApiV2.UserMobilityRule"
OvertimeConfigId:
type: string
example: 00000000-0000-0000-0000-000000000000
description: (default = null)
IntelliTracer.ApiV2.User:
type: object
required:
- Id
- Name
properties:
Id:
type: string
example: 00000000-0000-0000-0000-000000000000
Name:
type: string
example: John Doe
Code:
example: "012345"
description: (default = null)
nullable: true
type: string
EmployerCode:
example: "012345"
description: (default = null)
nullable: true
type: string
Email:
example: john.doe@doe.com
description: (default = null)
nullable: true
type: string
Gsm:
example: "+32477665544"
description: (default = null)
nullable: true
type: string
FreeField1:
description: (default = null)
nullable: true
type: string
FreeField2:
description: (default = null)
nullable: true
type: string
FreeField3:
description: (default = null)
nullable: true
type: string
FreeField4:
description: (default = null)
nullable: true
type: string
FreeField5:
description: (default = null)
nullable: true
type: string
FreeField6:
description: "(default = null) "
nullable: true
type: string
Notes:
description: (default = null)
nullable: true
type: string
Street:
example: Dumolinlaan
description: (default = null)
nullable: true
type: string
HouseNumber:
example: "9"
description: (default = null)
nullable: true
type: string
City:
example: Kortrijk
description: (default = null)
nullable: true
type: string
PostalCode:
example: "8500"
description: (default = null)
nullable: true
type: string
Submunicipality:
example: Kortrijk
description: (default = null)
nullable: true
type: string
Country:
$ref: "#/components/schemas/IntelliTracer.Domain.Country"
Longitude:
example: 3.245304
description: >-
(default = null)
Geographic coordinate that specifies the east–west position of a point on the Earth's surface.
nullable: true
type: number
Latitude:
example: 50.812939
description: >-
(default = null)
Geographic coordinate that specifies the north–south position of a point on the Earth's surface.
nullable: true
type: number
DefaultDayProgram:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV2.DayProgram"
- nullable: true
MobilityRule:
$ref: "#/components/schemas/IntelliTracer.ApiV2.UserMobilityRule"
OvertimeConfig:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV2.OvertimeConfig"
- nullable: true
Groups:
items:
$ref: "#/components/schemas/IntelliTracer.ApiV2.ResourceGroup"
description: (default = null)
nullable: true
type: array
FilterIvrCode:
example: "0123456789"
description: (default = null)
nullable: true
type: string
IntelliTracer.ApiV2.UserEdit:
type: object
required:
- Id
- Name
properties:
Id:
type: string
example: 00000000-0000-0000-0000-000000000000
Name:
type: string
example: John Doe
Code:
example: "012345"
description: (default = null)
nullable: true
type: string
EmployerCode:
example: "012345"
description: (default = null)
nullable: true
type: string
Email:
example: john.doe@doe.com
description: (default = null)
nullable: true
type: string
Gsm:
example: "+32477665544"
description: (default = null)
nullable: true
type: string
FreeField1:
description: (default = null)
nullable: true
type: string
FreeField2:
description: (default = null)
nullable: true
type: string
FreeField3:
description: (default = null)
nullable: true
type: string
FreeField4:
description: (default = null)
nullable: true
type: string
FreeField5:
description: (default = null)
nullable: true
type: string
FreeField6:
description: "(default = null) "
nullable: true
type: string
Notes:
description: (default = null)
nullable: true
type: string
Street:
example: Dumolinlaan
description: (default = null)
nullable: true
type: string
HouseNumber:
example: "9"
description: (default = null)
nullable: true
type: string
City:
example: Kortrijk
description: (default = null)
nullable: true
type: string
PostalCode:
example: "8500"
description: (default = null)
nullable: true
type: string
Submunicipality:
example: Kortrijk
description: (default = null)
nullable: true
type: string
Country:
$ref: "#/components/schemas/IntelliTracer.Domain.Country"
Longitude:
example: 3.245304
description: >-
(default = null)
Geographic coordinate that specifies the east–west position of a point on the Earth's surface.
nullable: true
type: number
Latitude:
example: 50.812939
description: >-
(default = null)
Geographic coordinate that specifies the north–south position of a point on the Earth's surface.
nullable: true
type: number
DefaultDayProgram:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV2.DayProgram"
- nullable: true
MobilityRule:
$ref: "#/components/schemas/IntelliTracer.ApiV2.UserMobilityRule"
OvertimeConfigId:
type: string
example: 00000000-0000-0000-0000-000000000000
description: (default = null)
IntelliTracer.ApiV3.User:
type: object
required:
- Id
- Name
properties:
Id:
type: string
example: 00000000-0000-0000-0000-000000000000
Name:
type: string
example: John Doe
Code:
example: "012345"
description: (default = null)
nullable: true
type: string
EmployerCode:
example: "012345"
description: (default = null)
nullable: true
type: string
Email:
example: john.doe@doe.com
description: (default = null)
nullable: true
type: string
Gsm:
example: "+32477665544"
description: (default = null)
nullable: true
type: string
FreeField1:
description: (default = null)
nullable: true
type: string
FreeField2:
description: (default = null)
nullable: true
type: string
FreeField3:
description: (default = null)
nullable: true
type: string
FreeField4:
description: (default = null)
nullable: true
type: string
FreeField5:
description: (default = null)
nullable: true
type: string
FreeField6:
description: "(default = null) "
nullable: true
type: string
Notes:
description: (default = null)
nullable: true
type: string
Street:
example: Dumolinlaan
description: (default = null)
nullable: true
type: string
HouseNumber:
example: "9"
description: (default = null)
nullable: true
type: string
City:
example: Kortrijk
description: (default = null)
nullable: true
type: string
PostalCode:
example: "8500"
description: (default = null)
nullable: true
type: string
Submunicipality:
example: Kortrijk
description: (default = null)
nullable: true
type: string
Country:
$ref: "#/components/schemas/IntelliTracer.Domain.Country"
Longitude:
example: 3.245304
description: >-
(default = null)
Geographic coordinate that specifies the east–west position of a point on the Earth's surface.
nullable: true
type: number
Latitude:
example: 50.812939
description: >-
(default = null)
Geographic coordinate that specifies the north–south position of a point on the Earth's surface.
nullable: true
type: number
MobilityRule:
$ref: "#/components/schemas/IntelliTracer.ApiV2.UserMobilityRule"
FilterIvrCode:
type: string
example: "0123456789"
description: (default = null)
IntelliTracer.ApiV3.UserRequest:
allOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV3.User"
- type: object
properties:
Id:
type: string
example: 00000000-0000-0000-0000-000000000000
DefaultDayProgramId:
type: string
example: 00000000-0000-0000-0000-000000000000
description: (default = null)
OvertimeConfigId:
type: string
example: 00000000-0000-0000-0000-000000000000
description: (default = null)
IntelliTracer.ApiV3.UserRequestEdit:
allOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV3.UserRequest"
- type: object
required:
- Id
properties:
Id:
type: string
example: 00000000-0000-0000-0000-000000000000
IntelliTracer.ApiV3.UserResponseObject:
allOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV3.User"
- type: object
properties:
DefaultDayProgram:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV2.DayProgram"
- nullable: true
OvertimeConfig:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV2.OvertimeConfig"
- nullable: true
Groups:
items:
$ref: "#/components/schemas/IntelliTracer.ApiV2.ResourceGroup"
description: (default = null)
nullable: true
type: array
IntelliTracer.ApiV2.DayProgram:
type: object
required:
- Id
- Name
properties:
Id:
type: string
example: 00000000-0000-0000-0000-000000000000
Name:
type: string
IntelliTracer.ApiV2.PagedUserResponse:
type: object
properties:
Data:
items:
$ref: "#/components/schemas/IntelliTracer.ApiV2.User"
description: (default = null)
nullable: true
type: array
PagingFilter:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.Api.PagingFilter"
- nullable: true
IntelliTracer.ApiV2.UserResponse:
type: object
properties:
Data:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV2.User"
- nullable: true
IntelliTracer.ApiV3.UserResponse:
type: object
properties:
Data:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV3.UserResponseObject"
- nullable: true
IntelliTracer.ApiV2.UserValidationResult:
type: object
required:
- Entity
- ValidationResult
properties:
Entity:
$ref: "#/components/schemas/IntelliTracer.ApiV2.User"
ValidationResult:
type: array
items: {}
IntelliTracer.ApiV3.UserValidationResult:
type: object
required:
- Entity
- ValidationResult
properties:
Entity:
$ref: "#/components/schemas/IntelliTracer.ApiV3.User"
ValidationResult:
type: array
items: {}
IntelliTracer.ApiV2.ResourceGroup:
type: object
required:
- Id
- Name
properties:
Id:
type: string
example: 00000000-0000-0000-0000-000000000000
Code:
example: "012345"
description: (default = null)
nullable: true
type: string
Name:
type: string
Type:
$ref: "#/components/schemas/IntelliTracer.ApiV1.ResourceType"
IntelliTracer.ApiV3.PagedResourceGroupResponse:
type: object
properties:
Data:
items:
$ref: "#/components/schemas/IntelliTracer.ApiV3.ResourceGroupWithStringType"
description: (default = null)
nullable: true
type: array
PagingFilter:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.Api.PagingFilter"
- nullable: true
IntelliTracer.ApiV3.UserPermittedResourceGroupsRequest:
type: object
required:
- GroupIds
- Type
properties:
GroupIds:
type: array
items: {}
Type:
$ref: "#/components/schemas/IntelliTracer.Domain.ResourceTypeString"
IntelliTracer.ApiV3.DayProgramUser:
type: object
required:
- Id
- Name
properties:
Id:
type: string
example: 00000000-0000-0000-0000-000000000000
Name:
type: string
example: John Doe
IntelliTracer.ApiV3.DayProgram:
type: object
required:
- Id
- Name
properties:
Id:
type: string
example: 00000000-0000-0000-0000-000000000000
Name:
type: string
example: Default
IntelliTracer.ApiV3.UserDayProgram:
type: object
required:
- User
- DayProgram
- DateLocal
- IsDefault
properties:
User:
$ref: "#/components/schemas/IntelliTracer.ApiV3.DayProgramUser"
DayProgram:
$ref: "#/components/schemas/IntelliTracer.ApiV3.DayProgram"
DateLocal:
type: string
example: 2019-01-25
IsDefault:
type: boolean
IntelliTracer.ApiV3.AddUserDayProgramRequest:
type: object
required:
- DayProgramId
- FromDate
- ToDate
properties:
DayProgramId:
type: string
example: 00000000-0000-0000-0000-000000000000
FromDate:
type: string
example: 2019-01-25
ToDate:
type: string
example: 2019-01-27
IntelliTracer.ApiV2.PagedOvertimeConfigResponse:
type: object
properties:
Data:
items:
$ref: "#/components/schemas/IntelliTracer.ApiV2.OvertimeConfig"
nullable: true
type: array
PagingFilter:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.Api.PagingFilter"
- nullable: true
IntelliTracer.ApiV2.OvertimeConfigResponse:
type: object
properties:
Data:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV2.OvertimeConfig"
- nullable: true
IntelliTracer.ApiV2.OvertimeConfig:
type: object
required:
- Id
- Name
- HoursType
properties:
Id:
type: string
example: 00000000-0000-0000-0000-000000000000
Name:
type: string
FirstHourCode:
type: string
example: "001"
FirstHourDescription:
type: string
ExtraHoursCode:
type: string
example: "002"
ExtraHoursDescription:
type: string
SaturdayHoursCode:
type: string
example: SA01
SaturdayOvertimeCode:
type: string
example: SA02
SundayHoursCode:
type: string
example: SU01
SundayOvertimeCode:
type: string
example: SU02
HoursType:
type: string
example: 01:00:00
IntelliTracer.ApiV1.Location:
type: object
required:
- Id
- RtcDateTime
- GpsDateTime
- ResourceId
properties:
Id:
type: string
example: 00000000-0000-0000-0000-000000000000
MileageToday:
example: 1.02
description: |-
(default = null)
Total mileage driven today.
nullable: true
type: number
MileageTotal:
example: 11245.02
description: |-
(default = null)
Total mileage driven ever.
nullable: true
type: number
Type:
allOf:
- $ref: "#/components/schemas/IntelliTracer.Domain.TrackingReportType"
- type: object
properties: {}
description: |-
(default = -9999)
Type of this tracking report.
TypeName:
example: Position
description: |-
(default = null)
Type name of this tracking report.
nullable: true
type: string
RtcDateTime:
type: string
example: 2019-01-09T11:16:51+01:00
description: Assumed datetime of the location.
GpsDateTime:
type: string
example: 2019-01-09T11:16:51+01:00
description: GPS datetime of the location.
Speed:
example: 50
description: |-
(default = null)
Current measured speed.
nullable: true
type: number
AllowedSpeed:
example: 50
description: |-
(default = null)
Allowed speed at this location.
nullable: true
type: number
Heading:
example: 189
description: |-
(default = null)
Direction the car is driving in in degrees (0 = north).
nullable: true
type: number
Latitude:
example: 50.812939
description: >-
(default = null)
Geographic coordinate that specifies the north–south position of a point on the Earth's surface.
nullable: true
type: number
Longitude:
example: 3.245304
description: >-
(default = null)
Geographic coordinate that specifies the east–west position of a point on the Earth's surface.
nullable: true
type: number
Satellites:
type: number
example: 9
description: >-
(default = 0)
Amount of satellites within range and used to determine the current location.
Pois:
items:
anyOf:
- type: string
example: 00000000-0000-0000-0000-000000000000
- type: string
example: 00000000-0000-0000-0000-000000000000
description: |-
(default = [])
Point(s) of interest located at this position.
nullable: true
type: array
IoStates:
items:
$ref: "#/components/schemas/IntelliTracer.Domain.IoState"
description: |-
(default = [])
State of the vehicle's inputs and outputs.
nullable: true
type: array
StatusInfo:
example: Contact off
description: |-
(default = null)
Status of the vehicle.
nullable: true
type: string
Address:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV1.Address"
- nullable: true
BadgeNr:
example: 00AA11BB
description: |-
(default = null)
Number of the badge that was used
nullable: true
type: string
BadgeUser:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV1.User"
- nullable: true
ResourceId:
type: string
example: 00000000-0000-0000-0000-000000000000
description: ID of the resource currently at this location.
_typeDescriptor:
type: string
IntelliTracer.ApiV2.lastpositionType:
type: number
x-enumDescriptions:
"0": Vehicle
"1": Asset
enum:
- null
- 0
- 1
IntelliTracer.ApiV2.PagedlastpositionResponse:
type: object
properties:
Data:
items:
$ref: "#/components/schemas/IntelliTracer.ApiV2.lastposition"
description: (default = null)
nullable: true
type: array
PagingFilter:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.Api.PagingFilter"
- nullable: true
IntelliTracer.ApiV2.lastposition:
type: object
required:
- Id
- Name
- Type
properties:
Id:
type: string
example: 00000000-0000-0000-0000-000000000000
Name:
type: string
example: Vehicle 1
Code:
example: "12345"
description: (default = null)
nullable: true
type: string
UnitId:
example: "1234567890"
description: (default = null)
nullable: true
type: string
Type:
$ref: "#/components/schemas/IntelliTracer.ApiV2.lastpositionType"
Counter:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV2.lastpositionCounter"
- nullable: true
Location:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV2.lastpositionLocation"
- nullable: true
DetectedBy:
items:
$ref: "#/components/schemas/IntelliTracer.ApiV2.lastpositionDetectedBy"
description: (default = null)
nullable: true
type: array
IntelliTracer.ApiV2.lastpositionCounter:
type: object
required:
- Mileage
- RunningHours
- DateTimeLocal
- DateTimeUtc
properties:
Mileage:
type: number
example: 48145
RunningHours:
type: number
example: 774
DateTimeLocal:
type: string
example: 2021-07-12T08:29:37
DateTimeUtc:
type: string
example: 2021-07-12T06:29:37
IntelliTracer.ApiV2.lastpositionLocation:
type: object
required:
- Latitude
- Longitude
- DateTimeLocal
- DateTimeUtc
properties:
Address:
example: Dumolinlaan 9, 8500 Kortrijk, BE
description: (default = null)
nullable: true
type: string
Latitude:
type: number
example: 50.812939
Longitude:
type: number
example: 3.245304
description: (default = null)
DateTimeLocal:
type: string
example: 2021-07-12T08:29:37
DateTimeUtc:
type: string
example: 2021-07-12T06:29:37
IntelliTracer.ApiV2.lastpositionDetectedBy:
type: object
required:
- Id
- Name
properties:
Id:
type: string
example: 00000000-0000-0000-0000-000000000000
Name:
type: string
example: Vehicle 1
IntelliTracer.ApiV1.ResourceLocations:
type: object
required:
- ResourceId
properties:
ResourceId:
type: string
example: 00000000-0000-0000-0000-000000000000
Positions:
items:
$ref: "#/components/schemas/IntelliTracer.ApiV1.Location"
description: |-
(default = null)
Positions of this vehicle.
nullable: true
type: array
_typeDescriptor:
type: string
IntelliTracer.ApiV1.ResourceLocationStatuses:
type: object
required:
- ResourceId
properties:
ResourceId:
type: string
example: 00000000-0000-0000-0000-000000000000
StatusResults:
items:
$ref: "#/components/schemas/IntelliTracer.ApiV1.LocationStatus"
description: |-
(default = [])
Time registration bars for this vehicle.
nullable: true
type: array
_typeDescriptor:
type: string
IntelliTracer.ApiV1.LocationStatus:
type: object
required:
- ResourceId
- FromDate
- ToDate
properties:
ResourceId:
type: string
example: 00000000-0000-0000-0000-000000000000
ResourceName:
example: Vehicle 1
description: (default = null)
nullable: true
type: string
FromDate:
type: string
example: 2019-01-25T08:00:00+01:00
description: From date
ToDate:
type: string
example: 2019-01-25T17:00:00+01:00
description: To date
Bars:
items:
$ref: "#/components/schemas/IntelliTracer.ApiV1.LocationStatusBar"
description: |-
(default = [])
Time registration bars for this vehicle during this timeframe.
nullable: true
type: array
_typeDescriptor:
type: string
IntelliTracer.ApiV1.LocationStatusBar:
type: object
required:
- StateName
- Start
- Stop
properties:
StateName:
type: string
example: Driving
Start:
type: string
example: 2019-01-25T08:00:00+01:00
Stop:
type: string
example: 2019-01-25T08:51:22+01:00
Duration:
type: string
example: 00:51:22
description: |-
(default = 00:00:00)
Total duration of this location status.
MileageBirdFlight:
type: number
example: 108.23
description: >-
(default = 0.0)
Distance between the start and stop locations, measured in a straight line (as the crow flies).
MileageDriven:
type: number
example: 111.85
description: |-
(default = 0.0)
Actual distance driven between the start and stop locations.
DriverId:
example: 00000000-0000-0000-0000-000000000000
description: |-
(default = null)
UserID of the driver.
nullable: true
type: string
DriverName:
type: string
example: John Doe
description: |-
(default = null)
Name of the driver.
StartLocation:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV1.Location"
- nullable: true
StopLocation:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV1.Location"
- nullable: true
_typeDescriptor:
type: string
IntelliTracer.ApiV2.ClockingType:
type: number
x-enumDescriptions:
"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
enum:
- null
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
IntelliTracer.ApiV1.AnalogInputType:
type: number
x-enumDescriptions:
"0": Temperature 24V
"1": Temperature 12V
"2": Voltage
"3": Delta Ohm 12V
"4": Delta Ohm 24V
"5": TRH301
"6": Omnicomm Vepamon Lls Af 20310
"7": MI3
enum:
- null
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
IntelliTracer.ApiV2.ExternalClockingType:
type: number
x-enumDescriptions:
"0": Log moment
"1": Custom
"2": Mobility
enum:
- null
- 0
- 1
- 2
IntelliTracer.ApiV1.Clocking:
type: object
required:
- Id
- DateTimeUtc
- DateTimeLocal
properties:
Id:
type: string
example: 00000000-0000-0000-0000-000000000000
DateTimeUtc:
type: string
example: 2019-01-25T07:29:37
DateTimeLocal:
type: string
example: 2019-01-25T08:29:37
User:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV1.ClockingUser"
- nullable: true
Vehicle:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV1.ClockingVehicle"
- nullable: true
Type:
$ref: "#/components/schemas/IntelliTracer.Domain.ClockingType"
Location:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV1.GeoCodeLite"
- nullable: true
Pois:
items:
anyOf:
- type: string
example: 00000000-0000-0000-0000-000000000000
- type: string
example: 00000000-0000-0000-0000-000000000000
description: >-
(default = null)
Point(s) of interest located at the position where this clocking was created.
nullable: true
type: array
IsManual:
type: boolean
description: >-
(default = false)
Indicates whether this clocking was created manually via the IntelliTracer website, rather than through usual means such as badging or using the smartphone app.
Description:
description: |-
(default = null)
Optional description that can be added to a clocking.
nullable: true
type: string
AbsenceCode:
description: >-
(default = null)
In case of a clocking of the type "Start absence", the absence code can be linked to indicate the type of absence (Illness, public holiday...).
nullable: true
type: string
JobNumber:
example: 1575-7577-4
description: >-
(default = null)
Job number used for postcalculation or activity based timeregistration.
nullable: true
type: string
Note:
example: clocking note
description: |-
(default = null)
Note that can be added to a clocking.
nullable: true
type: string
_typeDescriptor:
type: string
IntelliTracer.ApiV1.ClockingUser:
type: object
required:
- Id
- Name
properties:
Id:
type: string
example: 00000000-0000-0000-0000-000000000000
Code:
example: "012345"
description: (default = null)
nullable: true
type: string
EmployerCode:
example: "012345"
description: (default = null)
nullable: true
type: string
Name:
type: string
example: John Doe
Badge:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV1.ClockingUserBadge"
- nullable: true
DayProgramId:
example: 00000000-0000-0000-0000-000000000000
description: (default = null)
nullable: true
type: string
_typeDescriptor:
type: string
IntelliTracer.ApiV1.ClockingUserBadge:
type: object
required:
- Id
- InternalNumber
properties:
Id:
type: string
example: 00000000-0000-0000-0000-000000000000
InternalNumber:
type: string
example: 00AA11BB
ExternalNumber:
type: string
example: "12345678"
description: |-
(default = null)
The external number of this badge.
_typeDescriptor:
type: string
IntelliTracer.ApiV1.ClockingVehicle:
type: object
required:
- Id
- Name
properties:
Id:
type: string
example: 00000000-0000-0000-0000-000000000000
Code:
example: "012345"
description: (default = null)
nullable: true
type: string
Name:
type: string
example: Vehicle 1
VehicleTypeId:
example: 00000000-0000-0000-0000-000000000000
description: |-
(default = null)
ID of the type of this vehicle.
nullable: true
type: string
LastSyncDateUtc:
example: 2019-01-25T07:29:37
description: >-
(default = null)
The date and time when this vehicle has most recently synced with our servers.
nullable: true
type: string
LastPosition:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV1.ClockingVehicleLocation"
- nullable: true
_typeDescriptor:
type: string
IntelliTracer.ApiV1.ClockingVehicleLocation:
type: object
required:
- ReportDateLocal
- ReportDateUtc
properties:
AnalogExportList:
type: array
items: {}
description: |-
(default = [])
List of the analog inputs of this vehicle.
InputExportList:
type: array
items: {}
description: |-
(default = [])
List of the inputs of this vehicle.
IsPrivate:
type: boolean
description: >-
(default = false)
Whether this vehicle was driving with privacy mode enabled at this time.
BadgeUser:
example: John Doe
description: |-
(default = null)
Name of the user that badged in this vehicle.
nullable: true
type: string
BadgeNr:
example: 00AA11BB
description: |-
(default = null)
Number of the badge used to badge in this vehicle.
nullable: true
type: string
TypeText:
example: Position
description: |-
(default = null)
Text displayed next to this position on the day overview.
nullable: true
type: string
Type:
allOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV1.LocationTypeEntity"
- type: object
properties: {}
description: |-
(default = 0)
Type of this tracking report.
VehicleId:
example: 00000000-0000-0000-0000-000000000000
description: |-
(default = null)
ID of the vehicle linked to this clocking.
nullable: true
type: string
InputAcc:
description: |-
(default = null)
Contact on (hardware switch).
nullable: true
type: boolean
Heading:
example: 10
description: |-
(default = null)
The direction this vehicle is driving in in degrees (0 = north).
nullable: true
type: number
Speed:
example: 50
description: |-
(default = null)
Speed this vehicle was driving at (km/h).
nullable: true
type: number
Altitude:
description: |-
(default = null)
Vehicle's altitude compared to sea level.
nullable: true
type: number
Latitude:
example: 50.812939
description: >-
(default = null)
Geographic coordinate that specifies the north–south position of a point on the Earth's surface.
nullable: true
type: number
Longitude:
example: 3.245304
description: >-
(default = null)
Geographic coordinate that specifies the east–west position of a point on the Earth's surface.
nullable: true
type: number
AddressExport:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV1.AddressLite"
- nullable: true
ReportDateLocal:
type: string
example: 2019-01-25T08:29:37
description: Date and timestamp for this tracking report, in local time.
ReportDateUtc:
type: string
example: 2019-01-25T07:29:37
description: Date and timestamp for this tracking report, in UTC time.
GpsDateUtc:
example: 2019-01-25T07:29:37
description: >-
(default = null)
Date and timestamp for this tracking report, according to the vehicle's GPS.
nullable: true
type: string
OutputExportList:
type: array
items: {}
description: |-
(default = [])
List of this vehicle's outputs.
Pois:
type: array
items: {}
description: >-
(default = [])
Point(s) of interest located at the position where this clocking was created.
_typeDescriptor:
type: string
IntelliTracer.ApiV2.Clocking:
type: object
required:
- Id
- DateTimeUtc
- DateTimeLocal
properties:
Id:
type: string
example: 00000000-0000-0000-0000-000000000000
DateTimeUtc:
type: string
example: 2021-11-25T07:00:00
DateTimeLocal:
type: string
example: 2021-11-25T08:00:00
ClockingType:
$ref: "#/components/schemas/IntelliTracer.ApiV2.ClockingType"
Description:
description: (default = null)
nullable: true
type: string
JobNumber:
example: 1575-7577-4
description: (default = null)
nullable: true
type: string
ExternalType:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV2.ExternalClockingType"
- nullable: true
ExternalCode:
description: (default = null)
nullable: true
type: string
IsManual:
type: boolean
description: (default = false)
User:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV2.Resource"
- nullable: true
Vehicle:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV2.Resource"
- nullable: true
Location:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV2.ClockingLocation"
- nullable: true
AbsenceType:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV2.AbsenceType"
- nullable: true
IntelliTracer.ApiV2.ClockingLocation:
type: object
properties:
Address:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV2.Address"
- nullable: true
Pois:
type: array
items: {}
description: (default = [])
Latitude:
example: 50.812939
description: >-
(default = null)
Geographic coordinate that specifies the north–south position of a point on the Earth's surface.
nullable: true
type: number
Longitude:
example: 3.245304
description: (default = null)
nullable: true
type: number
IntelliTracer.ApiV1.InputOutput:
type: object
properties:
Number:
type: number
description: (default = 0)
Name:
description: (default = null)
nullable: true
type: string
Status:
description: (default = null)
nullable: true
type: boolean
StatusName:
description: (default = null)
nullable: true
type: string
IntelliTracer.ApiV1.AnalogInput:
type: object
properties:
Number:
type: number
description: (default = 0)
Name:
description: (default = null)
nullable: true
type: string
StatusName:
description: (default = null)
nullable: true
type: string
AnalogInputType:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV1.AnalogInputType"
- nullable: true
IntelliTracer.ApiV2.ClockingTypeEdit:
type: number
x-enumDescriptions:
"1": Start work
"3": Start activity
"17": Start external
"18": Stop external
enum:
- null
- 1
- 3
- 17
- 18
IntelliTracer.ApiV2.ClockingRequest:
type: object
required:
- ClockingType
- UserCode
properties:
ClockingType:
allOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV2.ClockingTypeEdit"
- type: object
properties: {}
description: (default = 1)
Description:
description: (default = null)
nullable: true
type: string
JobNumber:
example: 1575-7577-4
description: (default = null)
nullable: true
type: string
ExternalType:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV2.ExternalClockingType"
- nullable: true
ExternalCode:
description: (default = null)
nullable: true
type: string
DateTimeUtc:
example: 2021-11-25T07:00:00
description: (default = null)
nullable: true
type: string
UserCode:
type: string
VehicleCode:
nullable: true
type: string
IntelliTracer.ApiV2.ClockingResponse:
type: object
properties:
Data:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV2.Clocking"
- nullable: true
IntelliTracer.ApiV2.ClockingValidationResult:
type: object
required:
- Entity
- ValidationResult
properties:
Entity:
$ref: "#/components/schemas/IntelliTracer.ApiV2.Clocking"
ValidationResult:
type: array
items: {}
IntelliTracer.ApiV3.ClockingType:
type: number
x-enumDescriptions:
"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
enum:
- null
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
IntelliTracer.ApiV3.ExternalClockingType:
type: number
x-enumDescriptions:
"0": Log moment
"1": Custom
"2": Mobility
enum:
- null
- 0
- 1
- 2
IntelliTracer.ApiV3.ClockingRequest:
type: object
required:
- ClockingType
- UserCode
properties:
DateTimeUtc:
example: 2021-11-25T07:00:00
description: (default = null)
nullable: true
type: string
ClockingType:
$ref: "#/components/schemas/IntelliTracer.Domain.ClockingTypeString"
UserCode:
type: string
VehicleCode:
description: (default = null)
nullable: true
type: string
Description:
description: (default = null)
nullable: true
type: string
JobNumber:
example: 1575-7577-4
description: (default = null)
nullable: true
type: string
ExternalType:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.Domain.ExternalClockingTypeString"
- nullable: true
ExternalCode:
description: (default = null)
nullable: true
type: string
AbsenceTypeId:
example: 00000000-0000-0000-0000-000000000000
description: (default = null)
nullable: true
type: string
IntelliTracer.ApiV3.Clocking:
type: object
required:
- Id
- DateTimeUtc
- DateTimeLocal
- ClockingType
- IsManual
- User
properties:
Id:
type: string
example: 00000000-0000-0000-0000-000000000000
DateTimeUtc:
type: string
example: 2021-11-25T07:00:00
DateTimeLocal:
type: string
example: 2021-11-25T08:00:00
ClockingType:
$ref: "#/components/schemas/IntelliTracer.Domain.ClockingTypeString"
IsManual:
type: boolean
example: true
User:
$ref: "#/components/schemas/IntelliTracer.ApiV3.ResourceWithStringType"
Vehicle:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV3.ResourceWithStringType"
- nullable: true
Location:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV3.Location"
- nullable: true
AbsenceType:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV3.AbsenceType"
- nullable: true
Description:
description: (default = null)
nullable: true
type: string
JobNumber:
description: (default = null)
nullable: true
type: string
ExternalType:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.Domain.ExternalClockingTypeString"
- nullable: true
ExternalCode:
description: (default = null)
nullable: true
type: string
IntelliTracer.ApiV3.ClockingResponse:
type: object
properties:
Data:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV3.Clocking"
- nullable: true
IntelliTracer.ApiV3.ClockingValidationResult:
type: object
required:
- Entity
- ValidationResult
properties:
Entity:
$ref: "#/components/schemas/IntelliTracer.ApiV3.Clocking"
ValidationResult:
type: array
items: {}
IntelliTracer.ApiV1.ClockingIDWithJobnumber:
type: object
properties:
JobNumber:
example: 1575-7577-4
description: (default = null)
nullable: true
type: string
IntelliTracer.ApiV2.PagedCostCenterResponse:
type: object
properties:
Data:
items:
$ref: "#/components/schemas/IntelliTracer.ApiV2.CostCenterResponseObject"
description: (default = null)
nullable: true
type: array
PagingFilter:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.Api.PagingFilter"
- nullable: true
IntelliTracer.ApiV2.CostCenterResponse:
type: object
properties:
Data:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV2.CostCenterResponseObject"
- nullable: true
IntelliTracer.ApiV2.CostCenterResponseObject:
type: object
required:
- Id
- Name
- AutoCreate
- CreationDate
properties:
Id:
type: string
example: 00000000-0000-0000-0000-000000000000
Name:
type: string
example: Workplace 1
Code:
example: "012345"
description: (default = null)
nullable: true
type: string
ExpirationDate:
example: 2022-08-24T17:00:00+01:00
description: "(default = null) "
nullable: true
type: string
Poi:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV2.PoiInfo"
- nullable: true
AutoCreate:
type: boolean
description: (default = false)
CreationDate:
type: string
example: 2021-08-24T17:00:00+01:00
description: (default = null)
IntelliTracer.ApiV2.CostCenterRequest:
type: object
required:
- Name
- Code
properties:
Name:
type: string
example: Workplace 1
Code:
type: string
example: "012345"
description: (default = null)
ExpirationDate:
example: 2021-08-24T17:00:00+01:00
description: (default = null)
nullable: true
type: string
PoiId:
example: 00000000-0000-0000-0000-000000000000
description: (default = null)
nullable: true
type: string
ValidatorIds:
items:
anyOf:
- type: string
example: 00000000-0000-0000-0000-000000000000
- type: string
example: 00000000-0000-0000-0000-000000000000
description: (default = [])
nullable: true
type: array
IntelliTracer.ApiV1.CostCenterValidationResult:
type: object
required:
- Entity
- ValidationResult
properties:
Entity:
$ref: "#/components/schemas/IntelliTracer.ApiV1.CostCenter"
ValidationResult:
type: array
items: {}
IntelliTracer.ApiV2.CostCenterValidationResult:
type: object
required:
- Entity
- ValidationResult
properties:
Entity:
$ref: "#/components/schemas/IntelliTracer.ApiV2.CostCenterRequest"
ValidationResult:
type: array
items: {}
IntelliTracer.ApiV2.PagedCostCenterValidatorResponse:
type: object
properties:
Data:
items:
$ref: "#/components/schemas/IntelliTracer.ApiV2.CostCenterValidator"
description: (default = null)
nullable: true
type: array
PagingFilter:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.Api.PagingFilter"
- nullable: true
IntelliTracer.ApiV2.CostCenterListResponse:
type: object
properties:
Data:
items:
$ref: "#/components/schemas/IntelliTracer.ApiV2.CostCenterValidator"
description: (default = null)
nullable: true
type: array
IntelliTracer.ApiV2.CostCenterValidator:
type: object
required:
- Id
- Name
properties:
Id:
type: string
example: 00000000-0000-0000-0000-000000000000
Name:
type: string
example: Workplace 1
Code:
example: "012345"
description: (default = null)
nullable: true
type: string
IntelliTracer.ApiV2.CostCenterValidatorList:
type: object
required:
- ValidatorIds
properties:
ValidatorIds:
type: array
items: {}
IntelliTracer.ApiV2.CostCenterValidatorValidationResult:
type: object
required:
- Entity
- ValidationResult
properties:
Entity:
$ref: "#/components/schemas/IntelliTracer.ApiV2.CostCenterValidatorList"
ValidationResult:
type: array
items: {}
IntelliTracer.ApiV1.DayProgram:
type: object
required:
- Id
- Name
properties:
Id:
type: string
example: 00000000-0000-0000-0000-000000000000
Name:
type: string
example: Default
Code:
type: string
example: "012345"
description: (default = null)
DayStartBoundary:
type: string
example: 00:00:00
description: |-
(default = 00:00:00)
Time of the day at which this day program starts.
DayDuration:
type: string
example: 24:00:00
description: >-
(default = 00:00:00)
Duration of a "day" according to this dayprogram (counted from the DayStartBoundary).
Break1StartRelativeToDayBoundary:
type: string
example: 00:00:00
description: >-
(default = 00:00:00)
Start time of the first break, if any. Calculated relative to the DayStartBoundary.
Break1StopRelativeToDayBoundary:
type: string
example: 00:00:00
description: >-
(default = 00:00:00)
Stop time of the first break, if any. Calculated relative to the DayStartBoundary.
Break2StartRelativeToDayBoundary:
type: string
example: 00:00:00
description: >-
(default = 00:00:00)
Start time of the second break, if any. Calculated relative to the DayStartBoundary.
Break2StopRelativeToDayBoundary:
type: string
example: 00:00:00
description: >-
(default = 00:00:00)
Stop time of the second break, if any. Calculated relative to the DayStartBoundary.
Break3StartRelativeToDayBoundary:
type: string
example: 00:00:00
description: >-
(default = 00:00:00)
Start time of the third break, if any. Calculated relative to the DayStartBoundary.
Break3StopRelativeToDayBoundary:
type: string
example: 00:00:00
description: >-
(default = 00:00:00)
Stop time of the third break, if any. Calculated relative to the DayStartBoundary.
MondayWorkingStartRelativeToDayBoundary:
type: string
example: 00:00:00
description: >-
(default = 00:00:00)
Expected start time of the working hours on Mondays. Calculated relative to the DayStartBoundary.
MondayWorkingStopRelativeToDayBoundary:
type: string
example: 00:00:00
description: >-
(default = 00:00:00)
Expected stop time of the working hours on Mondays. Calculated relative to the DayStartBoundary.
TuesdayWorkingStartRelativeToDayBoundary:
type: string
example: 00:00:00
description: >-
(default = 00:00:00)
Expected start time of the working hours on Tuesdays. Calculated relative to the DayStartBoundary.
TuesdayWorkingStopRelativeToDayBoundary:
type: string
example: 00:00:00
description: >-
(default = 00:00:00)
Expected stop time of the working hours on Tuesdays. Calculated relative to the DayStartBoundary.
WednesdayWorkingStartRelativeToDayBoundary:
type: string
example: 00:00:00
description: >-
(default = 00:00:00)
Expected start time of the working hours on Wednesdays. Calculated relative to the DayStartBoundary.
WednesdayWorkingStopRelativeToDayBoundary:
type: string
example: 00:00:00
description: >-
(default = 00:00:00)
Expected stop time of the working hours on Wednesdays. Calculated relative to the DayStartBoundary.
ThursdayWorkingStartRelativeToDayBoundary:
type: string
example: 00:00:00
description: >-
(default = 00:00:00)
Expected start time of the working hours on Thursdays. Calculated relative to the DayStartBoundary.
ThursdayWorkingStopRelativeToDayBoundary:
type: string
example: 00:00:00
description: >-
(default = 00:00:00)
Expected stop time of the working hours on Thursdays. Calculated relative to the DayStartBoundary.
FridayWorkingStartRelativeToDayBoundary:
type: string
example: 00:00:00
description: >-
(default = 00:00:00)
Expected start time of the working hours on Fridays. Calculated relative to the DayStartBoundary.
FridayWorkingStopRelativeToDayBoundary:
type: string
example: 00:00:00
description: >-
(default = 00:00:00)
Expected stop time of the working hours on Fridays. Calculated relative to the DayStartBoundary.
SaturdayWorkingStartRelativeToDayBoundary:
type: string
example: 00:00:00
description: >-
(default = 00:00:00)
Expected start time of the working hours on Saturdays. Calculated relative to the DayStartBoundary.
SaturdayWorkingStopRelativeToDayBoundary:
type: string
example: 00:00:00
description: >-
(default = 00:00:00)
Expected stop time of the working hours on Saturdays. Calculated relative to the DayStartBoundary.
SundayWorkingStartRelativeToDayBoundary:
type: string
example: 00:00:00
description: >-
(default = 00:00:00)
Expected start time of the working hours on Sundays. Calculated relative to the DayStartBoundary.
SundayWorkingStopRelativeToDayBoundary:
type: string
example: 00:00:00
description: >-
(default = 00:00:00)
Expected stop time of the working hours on Sundays. Calculated relative to the DayStartBoundary.
Users:
items:
$ref: "#/components/schemas/IntelliTracer.ApiV1.DayProgramUser"
description: |-
(default = [])
Users that use this day program as their default day program.
nullable: true
type: array
_typeDescriptor:
type: string
IntelliTracer.ApiV1.DayProgramUser:
type: object
required:
- Id
- Name
properties:
Id:
type: string
example: 00000000-0000-0000-0000-000000000000
Name:
type: string
example: John Doe
_typeDescriptor:
type: string
IntelliTracer.ApiV1.Planning:
type: object
required:
- Id
- User
- FromDate
- ToDate
- Poi
properties:
Id:
type: string
example: 00000000-0000-0000-0000-000000000000
User:
$ref: "#/components/schemas/IntelliTracer.ApiV1.User"
Resource:
$ref: "#/components/schemas/IntelliTracer.ApiV1.Resource"
FromDate:
type: string
example: 2019-01-24T08:00:00
description: The start time of this planning in UTC timezone.
ToDate:
type: string
example: 2019-01-24T17:00:00
description: The end time of this planning in UTC timezone.
BreakTime:
type: string
example: 01:00:00
description: >-
(default = null)
The duration of the break that will be taken during this planned work.
Description:
example: "012345"
description: (default = null)
nullable: true
type: string
ActivityNumber:
example: "012345"
description: (default = null)
nullable: true
type: string
Poi:
$ref: "#/components/schemas/IntelliTracer.ApiV1.PoiLiteWithCode"
_typeDescriptor:
type: string
IntelliTracer.ApiV2.Planning:
type: object
required:
- Id
- User
- FromDateLocal
- FromDateUtc
- ToDateLocal
- ToDateUtc
properties:
Id:
type: string
example: 00000000-0000-0000-0000-000000000000
User:
$ref: "#/components/schemas/IntelliTracer.ApiV2.Resource"
Resource:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV2.Resource"
- nullable: true
FromDateLocal:
type: string
example: 2019-01-25T10:00:00
FromDateUtc:
type: string
example: 2019-01-25T08:00:00
ToDateLocal:
type: string
example: 2019-01-25T10:00:00
ToDateUtc:
type: string
example: 2019-01-25T08:00:00
BreakTime:
type: string
example: 01:00:00
description: (default = null)
Description:
example: "012345"
description: (default = null)
nullable: true
type: string
Poi:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV2.PoiLiteWithCode"
- nullable: true
IntelliTracer.ApiV2.PlanningResponse:
type: object
properties:
Data:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV2.Planning"
- nullable: true
IntelliTracer.ApiV2.PlanningValidationResult:
type: object
required:
- Entity
- ValidationResult
properties:
Entity:
$ref: "#/components/schemas/IntelliTracer.ApiV2.Planning"
ValidationResult:
type: array
items: {}
IntelliTracer.ApiV3.Planning:
type: object
required:
- Id
- User
- FromDateUtc
- ToDateUtc
properties:
Id:
type: string
example: 00000000-0000-0000-0000-000000000000
User:
$ref: "#/components/schemas/IntelliTracer.ApiV3.Resource"
Resource:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV3.Resource"
- nullable: true
FromDateUtc:
type: string
example: 2019-01-25T08:00:00
ToDateUtc:
type: string
example: 2019-01-25T08:00:00
BreakTime:
type: string
example: 01:00:00
description: (default = null)
Description:
example: "012345"
description: (default = null)
nullable: true
type: string
ActivityNumber:
example: 2023/0017
description: (default = null)
nullable: true
type: string
Poi:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV3.PoiLiteWithCode"
- nullable: true
IntelliTracer.ApiV3.PlanningRequest:
type: object
required:
- Id
- UserId
- FromDateUtc
- ToDateUtc
properties:
Id:
type: string
example: 00000000-0000-0000-0000-000000000000
UserId:
type: string
example: 00000000-0000-0000-0000-000000000000
ResourceId:
example: 00000000-0000-0000-0000-000000000000
description: (default = null)
nullable: true
type: string
FromDateUtc:
type: string
example: 2019-01-25T08:00:00
ToDateUtc:
type: string
example: 2019-01-25T08:00:00
BreakTime:
type: string
example: 01:00:00
description: (default = null)
Description:
example: "012345"
description: (default = null)
nullable: true
type: string
ActivityNumber:
example: 2023/0017
description: (default = null)
nullable: true
type: string
PoiId:
example: 00000000-0000-0000-0000-000000000000
description: (default = null)
nullable: true
type: string
IntelliTracer.ApiV3.PlanningRequestCreate:
allOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV3.PlanningRequest"
- type: object
properties:
Id:
type: string
example: 00000000-0000-0000-0000-000000000000
IntelliTracer.ApiV3.PlanningRequestUpdate:
allOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV3.PlanningRequest"
- type: object
required:
- Id
properties:
Id:
type: string
example: 00000000-0000-0000-0000-000000000000
IntelliTracer.ApiV3.PlanningResponse:
type: object
properties:
Data:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV3.Planning"
- nullable: true
IntelliTracer.ApiV3.PlanningValidationResult:
type: object
required:
- Entity
- ValidationResult
properties:
Entity:
$ref: "#/components/schemas/IntelliTracer.ApiV2.Planning"
ValidationResult:
type: array
items: {}
IntelliTracer.ApiV1.PlanningAnomalies:
type: object
properties:
AnomalyTypes:
items:
$ref: "#/components/schemas/IntelliTracer.ApiV1.PlanningAnomalyType"
description: (default = null)
nullable: true
type: array
WorkedHours:
example: 01:00:00
description: (default = null)
nullable: true
type: string
PlannedHours:
example: 08:00:00
description: (default = null)
nullable: true
type: string
WorkedFrom:
example: 2019-01-24T08:00:00+01:00
description: (default = null)
nullable: true
type: string
WorkedTo:
example: 2019-01-24T09:00:00+01:00
description: (default = null)
nullable: true
type: string
_typeDescriptor:
type: string
IntelliTracer.ApiV1.PlanningAnomalyType:
type: number
x-enumDescriptions:
"6": Started too late
"7": Stopped too early
"8": Worked too less
enum:
- null
- 6
- 7
- 8
IntelliTracer.ApiV1.InspectionResponsible:
type: number
x-enumDescriptions:
"0": Internal
"1": External
enum:
- null
- 0
- 1
IntelliTracer.ApiV1.AssetCategory:
type: number
x-enumDescriptions:
"0": Unique
"1": Collection
enum:
- null
- 0
- 1
IntelliTracer.ApiV1.AssetInspectionType:
type: object
required:
- Id
- Name
properties:
Id:
type: string
example: 00000000-0000-0000-0000-000000000000
Name:
example: Inspection
description: (default = null)
nullable: true
type: string
Description:
example: Description
description: (default = null)
nullable: true
type: string
Responsible:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV1.InspectionResponsible"
- nullable: true
WarningThresholdDays:
description: (default = null)
nullable: true
type: number
IntervalYears:
description: (default = null)
nullable: true
type: number
IntervalMonths:
example: 6
description: (default = null)
nullable: true
type: number
IntervalDays:
description: (default = null)
nullable: true
type: number
IntelliTracer.ApiV2.AssetMutationValidationResult:
type: object
required:
- Entity
- ValidationResult
properties:
Entity:
$ref: "#/components/schemas/IntelliTracer.ApiV2.AssetMutation"
ValidationResult:
type: array
items: {}
IntelliTracer.ApiV2.PagedAssetMutationResponse:
type: object
properties:
Data:
items:
$ref: "#/components/schemas/IntelliTracer.ApiV2.AssetMutation"
description: (default = null)
nullable: true
type: array
PagingFilter:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.Api.PagingFilter"
- nullable: true
IntelliTracer.ApiV2.AssetMutation:
type: object
required:
- TimeStamp
- Asset
- FromLocation
- ToLocation
- Quantity
- By
properties:
TimeStamp:
type: string
example: 2019-01-25T08:06:45+01:00
Asset:
$ref: "#/components/schemas/IntelliTracer.ApiV2.Asset"
FromLocation:
$ref: "#/components/schemas/IntelliTracer.ApiV2.AssetLocation"
ToLocation:
$ref: "#/components/schemas/IntelliTracer.ApiV2.AssetLocation"
Quantity:
type: number
example: 1
description: (default = `1`)
By:
$ref: "#/components/schemas/IntelliTracer.ApiV2.Resource"
IntelliTracer.ApiV2.Asset:
type: object
required:
- Id
properties:
Id:
type: string
example: 00000000-0000-0000-0000-000000000000
Name:
type: string
example: Work
Code:
example: "012345"
description: (default = null)
nullable: true
type: string
Type:
example: "012345"
description: (default = null)
nullable: true
type: string
Brand:
example: "012345"
description: (default = null)
nullable: true
type: string
TypeNumber:
example: "012345"
description: (default = null)
nullable: true
type: string
SerialNumber:
example: "012345"
description: (default = null)
nullable: true
type: string
Description:
example: "012345"
description: (default = null)
nullable: true
type: string
Quantity:
example: 1
description: (default = `1`)
nullable: true
type: number
CommissioningDate:
example: 2019-01-25T07:29:37
description: (default = null)
nullable: true
type: string
Category:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV1.AssetCategory"
- nullable: true
AdministrativeLocations:
items:
$ref: "#/components/schemas/IntelliTracer.ApiV2.AdminLocation"
description: "(default = null) "
nullable: true
type: array
LastSeen:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV2.AssetPosition"
- nullable: true
Picture:
example: https://prodassetmanagement.blob.core.windows.net/geodynamics-899192c530d46fde13b9164f2ea1253d/assets/3022e805-e786-4564-b561-0685920de8dd.jpg
description: (default = null)
nullable: true
type: string
Responsible:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV2.Resource"
- nullable: true
CreatedOn:
example: 2019-01-25T08:29:37+02:00
nullable: true
type: string
IntelliTracer.ApiV2.AssetLocation:
type: object
required:
- Id
- Name
- Country
properties:
Id:
type: string
example: 00000000-0000-0000-0000-000000000000
Name:
type: string
example: Work
Code:
example: "012345"
description: (default = null)
nullable: true
type: string
Country:
$ref: "#/components/schemas/IntelliTracer.Domain.Country"
Description:
example: Work
description: (default = null)
nullable: true
type: string
GeographyWkt:
example: POLYGON ((3.145219 50.81309, 3.244998 50.81309, 3.244998 50.91806,
3.145219 50.91806, 3.145219 50.81309))
description: >-
(default = null)
The coordinates of all points that define the shape of the asset location.
nullable: true
type: string
HouseNumber:
example: "9"
description: (default = null)
nullable: true
type: string
LonMin:
type: number
example: 3.145219
description: (default = 0.0)
LonMax:
type: number
example: 3.244998
description: (default = 0.0)
LatMin:
type: number
example: 50.81309
description: (default = 0.0)
LatMax:
type: number
example: 50.91806
description: (default = 0.0)
MarkerLon:
example: 3.145219
description: (default = null)
nullable: true
type: number
MarkerLat:
example: 50.81309
description: (default = null)
nullable: true
type: number
IsAssetLocation:
type: boolean
description: (default = false)
PostalCode:
example: "8500"
description: (default = null)
nullable: true
type: string
Street:
example: Dumolinlaan
description: (default = null)
nullable: true
type: string
Submunicipality:
example: Kortrijk
description: (default = null)
nullable: true
type: string
City:
example: Kortrijk
description: (default = null)
nullable: true
type: string
IntelliTracer.ApiV2.AssetResponse:
type: object
properties:
Data:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV2.Asset"
- nullable: true
IntelliTracer.ApiV2.AssetPosition:
type: object
required:
- Address
- DateTime
- DetectedBy
properties:
Address:
type: string
example: Dumolinlaan 9, 8500 Kortrijk, BE
DateTime:
type: string
example: 2019-01-25T08:29:37+02:00
DetectedBy:
type: string
example: Vehicle 1
IntelliTracer.ApiV2.AdminLocation:
type: object
properties:
Location:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV2.AssetLocation"
- nullable: true
Quantity:
example: 1
description: (default = 1)
nullable: true
type: number
IntelliTracer.ApiV1.AssetsWithPaging:
type: object
properties:
Data:
items:
$ref: "#/components/schemas/IntelliTracer.ApiV2.Asset"
nullable: true
type: array
PagingFilter:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.Api.PagingFilter"
- nullable: true
IntelliTracer.ApiV1.AssetCreate:
type: object
required:
- Name
properties:
Name:
type: string
example: Work
Code:
example: "012345"
description: (default = null)
nullable: true
type: string
Type:
example: "012345"
description: (default = null)
nullable: true
type: string
Brand:
example: "012345"
description: (default = null)
nullable: true
type: string
TypeNumber:
example: "012345"
description: (default = null)
nullable: true
type: string
SerialNumber:
example: "012345"
description: (default = null)
nullable: true
type: string
Description:
example: "012345"
description: (default = null)
nullable: true
type: string
Category:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV1.AssetCategory"
- nullable: true
Quantity:
example: 1
description: (default = `1`)
nullable: true
type: number
CommissioningDate:
example: 2019-01-25T07:29:37
description: (default = null)
nullable: true
type: string
_typeDescriptor:
type: string
IntelliTracer.ApiV1.AssetUpdate:
type: object
required:
- Id
properties:
Id:
type: string
example: 00000000-0000-0000-0000-000000000000
Name:
type: string
example: Work
Code:
example: "012345"
description: (default = null)
nullable: true
type: string
Type:
example: "012345"
description: (default = null)
nullable: true
type: string
Brand:
example: "012345"
description: (default = null)
nullable: true
type: string
Type number:
example: "012345"
description: (default = null)
nullable: true
type: string
Serial number:
example: "012345"
description: (default = null)
nullable: true
type: string
Description:
example: "012345"
description: (default = null)
nullable: true
type: string
Category:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV1.AssetCategory"
- nullable: true
Quantity:
example: 1
description: (default = `1`)
nullable: true
type: number
CommissioningDate:
example: 2019-01-25T07:29:37
description: (default = null)
nullable: true
type: string
_typeDescriptor:
type: string
IntelliTracer.ApiV2.PagedAssetResponse:
type: object
properties:
Data:
items:
$ref: "#/components/schemas/IntelliTracer.ApiV2.Asset"
description: (default = null)
nullable: true
type: array
PagingFilter:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.Api.PagingFilter"
- nullable: true
IntelliTracer.ApiV2.AssetValidationResult:
type: object
required:
- Entity
- ValidationResult
properties:
Entity:
$ref: "#/components/schemas/IntelliTracer.ApiV2.Asset"
ValidationResult:
type: array
items: {}
IntelliTracer.ApiV2.AssetMutationResponse:
type: object
properties:
Data:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV2.AssetMutation"
- nullable: true
IntelliTracer.ApiV2.AssetMutationCreateFromAsset:
type: object
required:
- FromLocationId
- ToLocationId
properties:
FromLocationId:
type: string
example: 00000000-0000-0000-0000-000000000000
ToLocationId:
type: string
example: 00000000-0000-0000-0000-000000000000
Quantity:
type: number
example: 1
description: (default = `1`)
IntelliTracer.ApiV1.AssetLocationsWithPaging:
type: object
properties:
Data:
items:
$ref: "#/components/schemas/IntelliTracer.ApiV1.AssetLocation"
nullable: true
type: array
PagingFilter:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.Api.PagingFilter"
- nullable: true
IntelliTracer.ApiV1.AssetLocation:
type: object
required:
- Id
- Name
properties:
Id:
type: string
example: 00000000-0000-0000-0000-000000000000
Name:
type: string
example: Work
Code:
example: "012345"
description: (default = null)
nullable: true
type: string
Country:
$ref: "#/components/schemas/IntelliTracer.Domain.Country"
Description:
example: Work
description: (default = null)
nullable: true
type: string
GeographyWkt:
example: POLYGON ((3.145219 50.81309, 3.244998 50.81309, 3.244998 50.91806,
3.145219 50.91806, 3.145219 50.81309))
description: |-
(default = null)
The coordinates of all points that define the shape of the POI.
nullable: true
type: string
HouseNumber:
example: "9"
description: (default = null)
nullable: true
type: string
LonMin:
type: number
example: 3.145219
description: |-
(default = 0.0)
Lowest longitude coordinate of the shape of the POI.
LonMax:
type: number
example: 3.244998
description: |-
(default = 0.0)
Highest longitude coordinate of the shape of the POI.
LatMin:
type: number
example: 50.81309
description: |-
(default = 0.0)
Lowest latitude coordinate of the shape of the POI.
LatMax:
type: number
example: 50.91806
description: |-
(default = 0.0)
Highest latitude coordinate of the shape of the POI.
MarkerLon:
example: 3.145219
description: |-
(default = null)
Longitude coordinate of the marker.
nullable: true
type: number
MarkerLat:
example: 50.81309
description: |-
(default = null)
Latitude coordinate of the marker.
nullable: true
type: number
IsAssetLocation:
type: boolean
PostalCode:
example: "8500"
description: (default = null)
nullable: true
type: string
Street:
example: Dumolinlaan
description: (default = null)
nullable: true
type: string
Submunicipality:
example: Kortrijk
description: (default = null)
nullable: true
type: string
City:
example: Kortrijk
description: (default = null)
nullable: true
type: string
_typeDescriptor:
type: string
IntelliTracer.ApiV2.AssetMutationCreateFromLocation:
type: object
required:
- AssetQuantities
- ToLocationId
properties:
AssetQuantities:
type: array
items: {}
description: (default = null)
ToLocationId:
type: string
example: 00000000-0000-0000-0000-000000000000
IntelliTracer.ApiV2.AssetQuantityCreate:
type: object
required:
- AssetId
properties:
AssetId:
type: string
example: 00000000-0000-0000-0000-000000000000
Quantity:
type: number
example: 1
description: (default = `1`)
IntelliTracer.ApiV2.AssetMutationListResponse:
type: object
properties:
Data:
items:
$ref: "#/components/schemas/IntelliTracer.ApiV2.AssetMutation"
description: (default = null)
nullable: true
type: array
IntelliTracer.ApiV2.AssetMutationValidationResultList:
type: object
properties:
Data:
items:
$ref: "#/components/schemas/IntelliTracer.ApiV2.AssetMutationValidationResult"
description: (default = null)
nullable: true
type: array
IntelliTracer.ApiV2.AdminLocations:
type: object
properties:
Data:
items:
$ref: "#/components/schemas/IntelliTracer.ApiV2.AdminLocationSimple"
description: (default = null)
nullable: true
type: array
IntelliTracer.ApiV2.AdminLocationSimple:
type: object
required:
- LocationId
properties:
LocationId:
type: string
example: 00000000-0000-0000-0000-000000000000
Quantity:
example: 1
description: (default = 1)
nullable: true
type: number
IntelliTracer.ApiV1.AssetInspectionTypeWithPaging:
type: object
properties:
Data:
items:
$ref: "#/components/schemas/IntelliTracer.ApiV1.AssetInspectionType"
nullable: true
type: array
Meta:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV1.Paging"
- nullable: true
IntelliTracer.ApiV1.AssetInspectionTypeCreate:
type: object
required:
- Name
properties:
Name:
example: Inspection
description: (default = null)
nullable: true
type: string
Description:
example: Description
description: (default = null)
nullable: true
type: string
Responsible:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV1.InspectionResponsible"
- nullable: true
WarningThresholdDays:
description: (default = null)
nullable: true
type: number
IntervalYears:
description: (default = null)
nullable: true
type: number
IntervalMonths:
example: 6
description: (default = null)
nullable: true
type: number
IntervalDays:
description: (default = null)
nullable: true
type: number
IntelliTracer.ApiV1.Paging:
type: object
properties:
Filter:
type: string
example: ABCD123
Page:
type: number
example: 1
Per_Page:
type: number
example: 10
IntelliTracer.ApiV1.AssetInspectionState:
type: number
x-enumDescriptions:
"0": Approved No Remark
"1": Approved With Remark
"2": Rejected
enum:
- null
- 0
- 1
- 2
IntelliTracer.ApiV1.AssetInspectionCreate:
type: object
required:
- AssetId
- TypeId
properties:
AssetId:
type: string
example: 00000000-0000-0000-0000-000000000000
TypeId:
type: string
example: 00000000-0000-0000-0000-000000000000
Status:
$ref: "#/components/schemas/IntelliTracer.ApiV1.AssetInspectionState"
Comments:
example: Comments
description: (default = null)
nullable: true
type: string
DateCompleted:
example: 2019-09-10
description: (default = null)
nullable: true
type: string
Picture:
example: https://prodassetmanagement.blob.core.windows.net/geodynamics-899192c530d46fde13b9164f2ea1253d/assets/3022e805-e786-4564-b561-0685920de8dd.jpg
description: (default = null)
nullable: true
type: string
IntelliTracer.ApiV1.AssetInspection:
type: object
required:
- Id
- AssetId
- Type
properties:
Id:
type: string
example: 00000000-0000-0000-0000-000000000000
AssetId:
type: string
example: 00000000-0000-0000-0000-000000000000
Type:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV1.AssetInspectionType"
- nullable: true
Status:
$ref: "#/components/schemas/IntelliTracer.ApiV1.AssetInspectionState"
Comments:
example: Comments
description: (default = null)
nullable: true
type: string
DateCompleted:
example: 2019-09-10
description: (default = null)
nullable: true
type: string
Picture:
example: https://prodassetmanagement.blob.core.windows.net/geodynamics-899192c530d46fde13b9164f2ea1253d/assets/3022e805-e786-4564-b561-0685920de8dd.jpg
description: (default = null)
nullable: true
type: string
IntelliTracer.ApiV1.AssetInspectionUpdate:
type: object
required:
- Id
- AssetId
properties:
Id:
type: string
example: 00000000-0000-0000-0000-000000000000
AssetId:
type: string
example: 00000000-0000-0000-0000-000000000000
TypeId:
type: string
example: 00000000-0000-0000-0000-000000000000
Status:
$ref: "#/components/schemas/IntelliTracer.ApiV1.AssetInspectionState"
Comments:
example: Comments
description: (default = null)
nullable: true
type: string
DateCompleted:
example: 2019-09-10
description: (default = null)
nullable: true
type: string
Picture:
example: https://prodassetmanagement.blob.core.windows.net/geodynamics-899192c530d46fde13b9164f2ea1253d/assets/3022e805-e786-4564-b561-0685920de8dd.jpg
description: (default = null)
nullable: true
type: string
IntelliTracer.ApiV3.AssetIdentification:
type: object
required:
- Id
- Type
properties:
Id:
type: string
example: 00000000-0000-0000-0000-000000000000
BadgeId:
example: 00000000-0000-0000-0000-000000000000
description: (default = null)
nullable: true
type: string
Value:
example: 123ABC
description: (default = null)
nullable: true
type: string
Type:
$ref: "#/components/schemas/IntelliTracer.Domain.AssetIdentificationType"
IntelliTracer.ApiV3.AssetIdentificationPagedDataResponse:
type: object
properties:
Data:
items:
$ref: "#/components/schemas/IntelliTracer.ApiV3.AssetIdentification"
description: (default = null)
nullable: true
type: array
PagingFilter:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.Api.PagingFilter"
- nullable: true
IntelliTracer.ApiV3.AssetIdentificationDataResponse:
type: object
properties:
Data:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV3.AssetIdentification"
- nullable: true
IntelliTracer.ApiV3.AssetIdentificationListDataResponse:
type: object
properties:
Data:
items:
$ref: "#/components/schemas/IntelliTracer.ApiV3.AssetIdentification"
description: (default = null)
nullable: true
type: array
IntelliTracer.ApiV3.AssetIdentificationRequestCreateByBadge:
type: object
required:
- BadgeId
properties:
BadgeId:
type: string
example: 00000000-0000-0000-0000-000000000000
IntelliTracer.ApiV3.AssetIdentificationRequestCreateByCustomValue:
type: object
required:
- Value
properties:
Value:
type: string
example: 123ABC
IntelliTracer.ApiV3.AssetIdentificationRequestUpdateByCustomValue:
type: object
required:
- Id
- Value
properties:
Id:
type: string
example: 00000000-0000-0000-0000-000000000000
Value:
type: string
example: 123ABC
IntelliTracer.ApiV2.PagedAbsenceTypeResponse:
type: object
properties:
Data:
items:
$ref: "#/components/schemas/IntelliTracer.ApiV2.AbsenceTypeResponseObject"
description: (default = null)
nullable: true
type: array
PagingFilter:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.Api.PagingFilter"
- nullable: true
IntelliTracer.ApiV1.AbsenceTypeCreate:
type: object
required:
- Name
- AbsenceCode
properties:
Name:
example: Sickness
description: (default = null)
nullable: true
type: string
AbsenceCode:
example: "100"
description: (default = null)
nullable: true
type: string
Paid:
type: boolean
description: (default = false)
TemporaryUnemployment:
type: boolean
description: (default = false)
Color:
example: "#000000"
description: (default = null)
nullable: true
type: string
IncludeInExport:
type: boolean
example: true
description: >-
(default = true)
Determines whether absences of this type will be included in exports to social secretaries created through specific Excel exports generated via our website.
If unsure, don't include this boolean in your request or leave it on 'true'.
IntelliTracer.ApiV2.AbsenceTypeResponseObject:
allOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV2.AbsenceType"
- type: object
required:
- Id
properties:
Id:
type: string
example: 00000000-0000-0000-0000-000000000000
IntelliTracer.ApiV2.AbsenceTypeResponse:
type: object
properties:
Data:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV2.AbsenceTypeResponseObject"
- nullable: true
IntelliTracer.ApiV2.AbsencePerUserRequest:
type: object
required:
- FromDate
- ToDate
- UserIds
properties:
FromDate:
type: string
example: 2019-01-25T08:00:00+02:00
ToDate:
type: string
example: 2019-01-25T17:00:00+02:00
UserIds:
type: array
items: {}
IntelliTracer.ApiV2.PagedAbsencePerUserResponse:
type: object
properties:
Data:
items:
$ref: "#/components/schemas/IntelliTracer.ApiV2.AbsencePerUser"
description: (default = null)
nullable: true
type: array
PagingFilter:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.Api.PagingFilter"
- nullable: true
IntelliTracer.ApiV2.AbsenceBulkByUserRequest:
type: object
required:
- UserId
- Absences
properties:
UserId:
type: string
example: 00000000-0000-0000-0000-000000000000
Absences:
type: array
items: {}
IntelliTracer.ApiV2.AbsencePerUserListResponse:
type: object
properties:
Data:
items:
$ref: "#/components/schemas/IntelliTracer.ApiV2.AbsencePerUser"
description: (default = null)
nullable: true
type: array
IntelliTracer.ApiV2.AbsenceValidationResultList:
type: object
properties:
Data:
items:
$ref: "#/components/schemas/IntelliTracer.ApiV2.AbsenceValidationResult"
description: (default = null)
nullable: true
type: array
IntelliTracer.ApiV2.AbsenceBulkByDateRequest:
type: object
required:
- Date
- Absences
properties:
Date:
type: string
example: 2019-01-24
Absences:
type: array
items: {}
IntelliTracer.ApiV2.AbsencePerUser:
type: object
required:
- User
properties:
User:
$ref: "#/components/schemas/IntelliTracer.ApiV2.Resource"
Absences:
items:
$ref: "#/components/schemas/IntelliTracer.ApiV2.AbsenceWithNotes"
description: (default = [])
nullable: true
type: array
IntelliTracer.ApiV2.DateAbsenceBulk:
type: object
required:
- Date
properties:
Date:
type: string
example: 2019-01-24
Absence:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV2.AbsenceBulk"
- nullable: true
IntelliTracer.ApiV2.Absence:
type: object
required:
- Id
- Date
- AbsenceType
- Start
properties:
Id:
type: string
example: 00000000-0000-0000-0000-000000000000
Date:
type: string
example: 2019-01-24
AbsenceType:
$ref: "#/components/schemas/IntelliTracer.ApiV2.AbsenceType"
Start:
type: string
example: 2019-01-24T07:00:00+01:00
Stop:
type: string
example: 2019-01-24T15:00:00+01:00
Duration:
type: string
example: 08:00:00
description: (default = 00:00:00)
Notes:
example: Notes
nullable: true
type: string
IntelliTracer.ApiV2.AbsenceWithNotes:
type: object
required:
- Id
- Date
- AbsenceType
- Start
properties:
Id:
type: string
example: 00000000-0000-0000-0000-000000000000
Date:
type: string
example: 2019-01-24
AbsenceType:
$ref: "#/components/schemas/IntelliTracer.ApiV2.AbsenceType"
Start:
type: string
example: 2019-01-24T07:00:00+01:00
Stop:
type: string
example: 2019-01-24T15:00:00+01:00
Duration:
type: string
example: 08:00:00
description: (default = 00:00:00)
Notes:
example: Notes
nullable: true
type: string
IntelliTracer.ApiV2.UserAbsenceBulk:
type: object
required:
- UserId
properties:
UserId:
type: string
example: 00000000-0000-0000-0000-000000000000
Absence:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV2.AbsenceBulk"
- nullable: true
IntelliTracer.ApiV2.AbsenceBulk:
type: object
required:
- AbsenceCode
- Start
- Stop
properties:
AbsenceCode:
type: string
example: SICKNESS
Start:
type: string
example: 07:00:00
Stop:
type: string
example: 15:00:00
IntelliTracer.ApiV2.AbsenceValidationResult:
type: object
required:
- Entity
- ValidationResult
properties:
Entity:
$ref: "#/components/schemas/IntelliTracer.ApiV2.Absence"
ValidationResult:
type: array
items: {}
IntelliTracer.ApiV3.AbsenceRequestsPerUserRequest:
type: object
required:
- FromDate
- ToDate
- UserIds
properties:
FromDate:
type: string
example: 2019-01-25T08:00:00+02:00
ToDate:
type: string
example: 2019-01-25T17:00:00+02:00
UserIds:
type: array
items: {}
IntelliTracer.ApiV3.AbsenceRequestPerUser:
type: object
required:
- User
properties:
User:
$ref: "#/components/schemas/IntelliTracer.ApiV3.ResourceWithStringType"
AbsenceRequests:
items:
$ref: "#/components/schemas/IntelliTracer.ApiV3.AbsenceRequest"
description: (default = [])
nullable: true
type: array
IntelliTracer.ApiV3.PagedAbsenceRequestsPerUserResponse:
type: object
properties:
Data:
items:
$ref: "#/components/schemas/IntelliTracer.ApiV3.AbsenceRequestPerUser"
description: (default = null)
nullable: true
type: array
PagingFilter:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.Api.PagingFilter"
- nullable: true
IntelliTracer.ApiV3.AbsenceRequest:
type: object
required:
- Id
- RequestDateTime
- Type
- AbsenceType
- Date
- TimeslotType
- Status
properties:
Id:
type: string
example: 00000000-0000-0000-0000-000000000000
RequestDateTime:
type: string
example: 2019-01-24T07:00:00+01:00
Type:
$ref: "#/components/schemas/IntelliTracer.Domain.AbsenceRequestTypeString"
AbsenceType:
$ref: "#/components/schemas/IntelliTracer.ApiV3.AbsenceType"
Date:
type: string
example: 2019-01-24
TimeslotType:
$ref: "#/components/schemas/IntelliTracer.Domain.AbsenceTypeTimeslotTypeString"
Status:
$ref: "#/components/schemas/IntelliTracer.Domain.AbsenceRequestStatusString"
Hours:
example: 4
nullable: true
type: number
IntelliTracer.ApiV3.RefuseAbsenceRequestRequest:
type: object
required:
- Notes
properties:
Notes:
type: string
example: I'm sorry, but I can't approve this request.
IntelliTracer.ApiV2.PostCalculationExportType:
type: number
x-enumDescriptions:
"0": Activity
"1": CostCenter
enum:
- null
- 0
- 1
IntelliTracer.ApiV2.TimesheetEventType:
type: number
x-enumDescriptions:
"0": Absence
"1": Activity
"2": Allowance
"3": Break
"4": Movement
"5": Work
"6": Error
"7": Unpaid
"8": TravelTime
"9": External
enum:
- null
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
IntelliTracer.ApiV2.PostCalculationTimesheetEventType:
type: number
x-enumDescriptions:
"0": Absence paid
"1": Absence unpaid
"2": Activity
"3": Break
"4": Movement driver
"5": Movement passenger
"6": Movement single driver
"7": Work
"8": Load/Unload
"9": Travel time
"10": External
"11": Unpaid
"12": Allowance
"13": Error
enum:
- null
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
IntelliTracer.ApiV2.PostCalculationIndirectEventType:
type: number
x-enumDescriptions:
"0": Work
"1": Travel Time
enum:
- null
- 0
- 1
IntelliTracer.ApiV2.PostCalculationExportQuery:
type: object
required:
- DateUtc
properties:
UserIds:
items:
anyOf:
- type: string
example: 00000000-0000-0000-0000-000000000000
- type: string
example: 00000000-0000-0000-0000-000000000000
description: (default = null)
nullable: true
type: array
AllUsers:
type: boolean
description: (default = false)
Mode:
$ref: "#/components/schemas/IntelliTracer.ApiV2.PostCalculationExportType"
GroupCostcenterByActivity:
type: boolean
description: |-
(default = false)
Group postcalculation by activity?
DateUtc:
type: string
example: 2019-01-18T00:00:00
Filter:
description: |-
(default = null)
Filter on cost center.
nullable: true
type: string
IncludeTimesheet:
type: boolean
description: (default = false)
IncludeTimesheetEvents:
type: boolean
description: >-
(default = false)
Include an overview of every event this day. This is similar to the bar graphs you can find on the 'Overview per user per day' screen in IntelliTracer.
IncludeTimeValidation:
type: boolean
description: (default = false)
IncludePostCalculationLog:
type: boolean
description: (default = false)
IncludeLossCostcenter:
type: boolean
description: (default = false)
IntelliTracer.ApiV2.PostCalculationExport:
type: object
required:
- DateUtc
- DateLocal
properties:
User:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV2.PostCalculationUser"
- nullable: true
DateUtc:
type: string
example: 2019-01-18T00:00:00
description: The date and time of this postcalculation in UTC timezone.
DateLocal:
type: string
example: 2019-01-18T00:00:00
description: The date and time of this postcalculation in local timezone.
TimeSheet:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV2.PostCalculationTimeSheet"
- nullable: true
TimesheetEvents:
items:
$ref: "#/components/schemas/IntelliTracer.ApiV2.PostCalculationTimeSheetEvent"
description: |-
(default = null)
PostCalculation details.
nullable: true
type: array
PostCalculationEvents:
items:
$ref: "#/components/schemas/IntelliTracer.ApiV2.PostCalculationEvent"
description: (default = null)
nullable: true
type: array
PostCalculationLog:
items:
$ref: "#/components/schemas/IntelliTracer.ApiV2.PostCalculationLogEntry"
description: (default = null)
nullable: true
type: array
Verified:
nullable: true
type: boolean
VerifiedDateUtc:
example: 2019-01-18T00:00:00
nullable: true
type: string
VerifiedDateLocal:
example: 2019-01-18T00:00:00
nullable: true
type: string
_typeDescriptor:
type: string
IntelliTracer.ApiV2.PostCalculationUser:
type: object
required:
- Id
- Name
properties:
Id:
type: string
example: 00000000-0000-0000-0000-000000000000
Name:
type: string
example: John Doe
Code:
example: "012345"
description: (default = null)
nullable: true
type: string
EmployerCode:
example: ReplaceWithEncodedAuthentication
description: (default = null)
nullable: true
type: string
FreeField1:
description: (default = null)
nullable: true
type: string
FreeField2:
description: (default = null)
nullable: true
type: string
FreeField3:
description: (default = null)
nullable: true
type: string
FreeField4:
description: (default = null)
nullable: true
type: string
FreeField5:
description: (default = null)
nullable: true
type: string
FreeField6:
description: "(default = null) "
nullable: true
type: string
_typeDescriptor:
type: string
IntelliTracer.ApiV2.PostCalculationTimeSheet:
type: object
properties:
NormalHours:
type: number
example: 7.6
description: |-
(default = 0.0)
Hours that need to be worked.
WorkedHours:
type: number
example: 7.6
description: |-
(default = 0.0)
Hours that have been worked.
NormalWorkedHours:
type: number
example: 7.6
description: |-
(default = 0.0)
Hours that have been worked, not including overtime.
Pause:
type: number
example: 0.3
description: |-
(default = 0.0)
Pause.
LoadUnload:
type: number
example: 7.6
description: |-
(default = 0.0)
Load & Unload.
OvertimePositive:
type: number
example: 7.6
description: |-
(default = 0.0)
Positive overtime.
OvertimeNegative:
type: number
example: 7.6
description: |-
(default = 0.0)
Negative overtime.
OvertimeFirstHour:
type: number
example: 7.6
description: |-
(default = 0.0)
First overtime hour of the day.
OvertimeExtraHours:
type: number
example: 7.6
description: |-
(default = 0.0)
Extra overtime hours of the day.
OvertimeFirstHourCode:
example: "`123'"
description: |-
(default = null)
Code of the first overtime hour.
nullable: true
type: string
OvertimeExtraHoursCode:
example: "`123'"
description: |-
(default = null)
Code of the extra overtime hours.
nullable: true
type: string
PoiCodeStart:
example: "`012345'"
description: |-
(default = null)
Code of the point of interest at the start.
nullable: true
type: string
PoiNameStart:
example: "`Poi 1'"
description: |-
(default = null)
Name of the point of interest at the start.
nullable: true
type: string
VehicleNameStart:
example: "`Vehicle 1'"
description: |-
(default = null)
Name of the vehicle at the start
nullable: true
type: string
PoiCodeStop:
example: "`012345'"
description: |-
(default = null)
Code of the point of interest at the end.
nullable: true
type: string
PoiNameStop:
example: "`Poi 1'"
description: |-
(default = null)
Name of the point of interest at the end.
nullable: true
type: string
VehicleNameStop:
example: "`Vehicle 1'"
description: |-
(default = null)
Name of the vehicle at the end.
nullable: true
type: string
Mobility:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV2.Mobility"
- nullable: true
Absence:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV2.PostCalculationTimeSheetAbsence"
- nullable: true
StartMovementUtc:
type: string
example: 07:03:55
description: (default = null)
StartMovementLocal:
type: string
example: 07:03:55
description: "(default = null) "
StartWorkUtc:
type: string
example: 07:03:55
description: (default = null)
StartWorkLocal:
type: string
example: 07:03:55
description: (default = null)
StopWorkUtc:
type: string
example: 07:03:55
description: (default = null)
StopWorkLocal:
type: string
example: 07:03:55
description: (default = null)
StopMovementUtc:
type: string
example: 07:03:55
description: (default = null)
StopMovementLocal:
type: string
example: 07:03:55
description: (default = null)
_typeDescriptor:
type: string
IntelliTracer.ApiV2.PostCalculationTimeSheetAbsence:
type: object
properties:
Duration:
type: number
example: 7.6
description: |-
(default = 0.0)
Hours absence.
Code:
example: SICKNESS
description: |-
(default = null)
Code of the absence.
nullable: true
type: string
_typeDescriptor:
type: string
IntelliTracer.ApiV2.PostCalculationEvent:
type: object
required:
- TimeFromLocal
- TimeFromUtc
- TimeToLocal
- TimeToUtc
properties:
CostCenter:
example: Workplace 1
description: |-
(default = null)
Cost center
nullable: true
type: string
CostCenterFullCode:
example: Workplace 1
description: (default = null)
nullable: true
type: string
ActivityCode:
example: "001"
description: |-
(default = null)
Activity code (job number)
nullable: true
type: string
ActivityContext1:
example: Context 1
description: >-
(default = null)
Activity Context 1. Can be used in case more information is needed aside from just the activity code.
nullable: true
type: string
ActivityContext2:
example: Context2
description: >-
(default = null)
Activity Context 2. Can be used in case more information is needed aside from just the activity code.
nullable: true
type: string
ActivityContext3:
example: Context3
description: >-
(default = null)
Activity Context 3. Can be used in case more information is needed aside from just the activity code.
nullable: true
type: string
Duration:
type: number
example: 7.6
description: |-
(default = 0.0)
Direct assigned time.
TimeFromLocal:
type: string
example: 2019-01-18T05:54:15
description: The from datetime in the local (customer) timezone, actual event
time in `Activity` Mode, first event time in `CostCenter` Mode
[PostCalculation](#info-postcalculation).
TimeFromUtc:
type: string
example: 2019-01-18T06:54:15
description: The from datetime in UTC timezone, actual event time in `Activity`
Mode, first event time in `CostCenter` Mode
[PostCalculation](#info-postcalculation).
TimeToLocal:
type: string
example: 2019-01-18T05:58:16
description: The to datetime in the local (customer) timezone, actual event time
in `Activity` Mode, last event time in `CostCenter` Mode
[PostCalculation](#info-postcalculation).
TimeToUtc:
type: string
example: 2019-01-18T06:58:16
description: The to datetime in UTC timezone, actual event time in `Activity`
Mode, last event time in `CostCenter` Mode
[PostCalculation](#info-postcalculation).
Mobility:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV2.Mobility"
- nullable: true
Resource:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV2.Resource"
- nullable: true
Details:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV2.PostCalculationEventDetails"
- nullable: true
TimeValidation:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV2.PostCalculationTimeValidation"
- nullable: true
_typeDescriptor:
type: string
IntelliTracer.ApiV2.PostCalculationEventDetails:
type: object
properties:
DirectAssignedWorkTime:
type: number
example: 7.6
description: |-
(default = 0.0)
Direct assigned work time.
IndirectAssignedWorkTime:
type: number
example: 7.6
description: |-
(default = 0.0)
Indirect assigned work time.
IndirectAssignedMobilityBeforeTime:
type: number
example: 7.6
description: |-
(default = 0.0)
Indirect assigned mobility before time.
IndirectAssignedMobilityAfterTime:
type: number
example: 7.6
description: |-
(default = 0.0)
Indirect assigned mobility after time.
IndirectAssignedMobilityTotalTime:
type: number
example: 7.6
description: |-
(default = 0.0)
Indirect assigned mobility total time.
IndirectAssignedLoadUnloadTime:
type: number
example: 7.6
description: |-
(default = 0.0)
Indirect assigned mobility load & unload time.
IndirectAssignedTravelTime:
type: number
example: 7.6
description: |-
(default = 0.0)
Indirect assigned travel paid time.
IndirectAssignedAbsencePaidTime:
type: number
example: 7.6
description: |-
(default = 0.0)
Indirect assigned mobility paid time.
IndirectAssignedAbsenceUnpaidTime:
type: number
example: 7.6
description: |-
(default = 0.0)
Indirect assigned mobility unpaid time.
DirectAssignedWorkDistance:
type: number
example: 7.6
description: |-
(default = 0.0)
Direct assigned work distance.
IndirectAssignedWorkDistance:
type: number
example: 7.6
description: |-
(default = 0.0)
Indirect assigned work distance.
IndirectAssignedMobilityBeforeDistance:
type: number
example: 7.6
description: |-
(default = 0.0)
Indirect assigned work distance.
IndirectAssignedMobilityAfterDistance:
type: number
example: 7.6
description: |-
(default = 0.0)
Indirect assigned work distance.
IndirectAssignedMobilityTotalDistance:
type: number
example: 7.6
description: |-
(default = 0.0)
Indirect assigned work distance.
IndirectAssignedLoadUnloadDistance:
type: number
example: 7.6
description: |-
(default = 0.0)
Indirect assigned work distance.
IndirectAssignedTravelDistance:
type: number
example: 7.6
description: |-
(default = 0.0)
Indirect assigned travel distance.
TotalAssignedTime:
type: number
example: 7.6
description: |-
(default = 0.0)
Total assigned time.
TotalAssignedDistance:
type: number
example: 7.6
description: |-
(default = 0.0)
Total assigned distance.
NormalWorkedHours:
type: number
example: 7.6
description: |-
(default = 0.0)
Normal worked hours.
FirstOvertimeHour:
type: number
example: 7.6
description: |-
(default = 0.0)
First overtime hour.
ExtraOvertimeHours:
type: number
example: 7.6
description: |-
(default = 0.0)
Extra overtime hours.
IndirectEvents:
type: array
items: {}
_typeDescriptor:
type: string
IntelliTracer.ApiV2.Mobility:
type: object
properties:
KmDriver:
type: number
example: 100.2
description: |-
(default = 0.0)
Distance mobility as driver in kilometers.
KmPassenger:
type: number
example: 100.2
description: |-
(default = 0.0)
Distance mobility as passenger in kilometers.
KmSingleDriver:
type: number
example: 12.4
description: |-
(default = 0.0)
Distance mobility as single driver in kilometers.
KmHomeWork:
type: number
example: 100.2
description: |-
(default = 0.0)
Distance home-work in kilometers.
KmHomeSite:
type: number
example: 100.2
description: |-
(default = 0.0)
Distance home-site in kilometers ( PC149 tarif A).
KmHomeOther:
type: number
example: 100.2
description: |-
(default = 0.0)
Distance home-other in kilometers (PC149 tarif B).
EurDriver:
type: number
example: 9.53
description: |-
(default = 0.0)
Payment mobility as driver in EURO.
EurPassenger:
type: number
example: 9.53
description: |-
(default = 0.0)
Payment mobility as passenger in EURO.
EurSingleDriver:
type: number
example: 6.53
description: |-
(default = 0.0)
Payment mobility as single driver in EURO.
EurHomeWork:
type: number
example: 9.53
description: |-
(default = 0.0)
Payment home-work in EURO.
EurHomeSite:
type: number
example: 9.53
description: |-
(default = 0.0)
Payment home-site in EURO (PC149 tarif A).
EurHomeOther:
type: number
example: 9.53
description: |-
(default = 0.0)
Payment home-other in EURO (PC149 tarif B).
EurMobility:
type: number
example: 9.53
description: |-
(default = 0.0)
Payment mobility & home-work/site/other total in EURO.
_typeDescriptor:
type: string
IntelliTracer.ApiV2.PostCalculationTimeSheetEvent:
type: object
required:
- Type
- EventType
- StartDateTimeLocal
- StartDateTimeUtc
- StopDateTimeLocal
- StopDateTimeUtc
- Duration
- JobNumber
properties:
Type:
$ref: "#/components/schemas/IntelliTracer.ApiV2.TimesheetEventType"
EventType:
$ref: "#/components/schemas/IntelliTracer.ApiV2.PostCalculationTimesheetEventTy\
pe"
StartDateTimeLocal:
type: string
example: 2019-03-12T11:01:51
StartDateTimeUtc:
type: string
example: 2019-03-12T11:00:51
StopDateTimeLocal:
type: string
example: 2019-03-12T11:01:51
StopDateTimeUtc:
type: string
example: 2019-03-12T11:00:51
StartResource:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV2.Resource"
- nullable: true
StopResource:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV2.Resource"
- nullable: true
StartLocation:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV2.Address"
- nullable: true
StopLocation:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV2.Address"
- nullable: true
Duration:
type: string
example: 00:37:54
description: (default = 0.0)
Mileage:
example: 1245.4
description: (default = null)
nullable: true
type: number
MileageBirdflight:
example: 1100.5
description: (default = null)
nullable: true
type: number
JobNumber:
type: string
example: "12345"
IntelliTracer.ApiV2.PostCalculationVehiclePerCostcenterQuery:
type: object
required:
- ResourceIds
- FromDate
- ToDate
properties:
PoiIds:
type: array
items: {}
description: "If no PoiIds are provided, the results will be for all Points of
Interest. "
ResourceIds:
type: array
items: {}
FromDate:
type: string
example: 2019-01-18T00:00:00
ToDate:
type: string
example: 2019-01-20T00:00:00
MinimumDuration:
type: number
example: 5
description: |-
(default = 0.0)
Minimum duration in minutes.
IntelliTracer.ApiV2.PostCalculationVehiclePerCostcenterExport:
type: object
required:
- Poi
- Date
- Vehicle
- TimeFrom
- TimeTo
- TimeDuration
- DrivingToMileage
- DrivingToDuration
- DrivingAtMileage
- DrivingAtDuration
- DurationContactOn
properties:
Poi:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV2.PoiInfo"
- nullable: true
Date:
type: string
example: 2019-01-18
Vehicle:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV2.Resource"
- nullable: true
TimeFrom:
type: string
example: 00:00:00
TimeTo:
type: string
example: 00:00:00
TimeDuration:
type: string
example: 00:00:00
DrivingToMileage:
type: string
example: "100"
DrivingToDuration:
type: string
example: 00:00:00
DrivingAtMileage:
type: string
example: "100"
DrivingAtDuration:
type: string
example: 00:00:00
DurationContactOn:
type: string
example: 00:00:00
IntelliTracer.ApiV2.PostCalculationLogEntry:
type: object
required:
- Data
- Entries
properties:
Data:
type: string
Entries:
type: array
items: {}
IntelliTracer.ApiV2.PostCalculationIndirectEvent:
type: object
properties:
Type:
$ref: "#/components/schemas/IntelliTracer.ApiV2.PostCalculationIndirectEventTyp\
e"
Duration:
type: number
example: 9.53
description: (default = 0.0)
Resource:
$ref: "#/components/schemas/IntelliTracer.ApiV2.Resource"
JobNumber:
type: string
example: "12345"
IntelliTracer.ApiV2.PostCalculationTimeValidation:
type: object
required:
- Approvals
- Disapprovals
properties:
Approvals:
type: array
items: {}
Disapprovals:
type: array
items: {}
IntelliTracer.ApiV2.PostCalculationTimeValidationApproval:
type: object
required:
- Approver
properties:
Approver:
$ref: "#/components/schemas/IntelliTracer.ApiV2.Resource"
IntelliTracer.ApiV2.PostCalculationTimeValidationDisapproval:
type: object
required:
- Disapprover
- Reason
properties:
Disapprover:
$ref: "#/components/schemas/IntelliTracer.ApiV2.Resource"
Reason:
$ref: "#/components/schemas/IntelliTracer.ApiV2.PostCalculationTimeValidationAp\
provalReason"
Comment:
type: string
IntelliTracer.ApiV2.PostCalculationTimeValidationApprovalReason:
type: object
properties:
En:
type: string
example: Bad
Nl:
type: string
example: Slecht
Fr:
type: string
example: Pas bien
IntelliTracer.ApiV1.AccessLocationUserAccessResult:
type: object
required:
- Success
properties:
Success:
type: boolean
Message:
description: (default = null)
nullable: true
type: string
IntelliTracer.ApiV2.AccessLocationAccessControlScheduleResponse:
type: object
properties:
Data:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV2.AccessLocationAccessControlSche\
dule"
- nullable: true
IntelliTracer.ApiV2.AccessLocationAccessControlScheduleValidationResult:
type: object
required:
- Entity
- ValidationResult
properties:
Entity:
$ref: "#/components/schemas/IntelliTracer.ApiV2.AccessLocationAccessControlSche\
dule"
ValidationResult:
type: array
items: {}
IntelliTracer.ApiV2.AccessLocationAccessControlSchedule:
type: object
required:
- Schedule
- Groups
properties:
Schedule:
$ref: "#/components/schemas/IntelliTracer.ApiV2.AccessScheduleInfo"
Groups:
type: array
items: {}
IntelliTracer.ApiV2.AccessScheduleInfo:
type: object
required:
- Id
- Name
properties:
Id:
type: string
example: 00000000-0000-0000-0000-000000000000
Name:
type: string
example: Office hours
IntelliTracer.ApiV2.AccessGroupInfo:
type: object
required:
- Id
- Name
properties:
Id:
type: string
example: 00000000-0000-0000-0000-000000000000
Name:
type: string
example: Everyone
IntelliTracer.ApiV1.AccessScheduleLite:
type: object
required:
- Id
- Name
properties:
Id:
type: string
example: 00000000-0000-0000-0000-000000000000
Name:
type: string
example: Office hours
_typeDescriptor:
type: string
IntelliTracer.ApiV1.AccessScheduleException:
type: object
required:
- Id
- Name
- TimeClockIds
- Dates
properties:
Id:
type: string
example: 00000000-0000-0000-0000-000000000000
Name:
type: string
example: Office hours
TimeClockIds:
type: array
items: {}
Dates:
type: array
items: {}
AccessControl:
type: boolean
description: (default = false)
ConstantRelais:
type: boolean
description: (default = false)
Pulse:
type: boolean
description: (default = false)
_typeDescriptor:
type: string
IntelliTracer.ApiV1.AccessScheduleExceptionCreate:
type: object
required:
- Name
- TimeClockIds
- Dates
properties:
Name:
type: string
example: Office hours
TimeClockIds:
type: array
items: {}
Dates:
type: array
items: {}
AccessControl:
type: boolean
description: (default = false)
ConstantRelais:
type: boolean
description: (default = false)
Pulse:
type: boolean
description: (default = false)
_typeDescriptor:
type: string
IntelliTracer.ApiV1.AccessScheduleExceptionUpdate:
type: object
required:
- Id
properties:
Id:
type: string
example: 00000000-0000-0000-0000-000000000000
Name:
type: string
example: Office hours
TimeClockIds:
type: array
items: {}
Dates:
type: array
items: {}
AccessControl:
type: boolean
description: (default = false)
ConstantRelais:
type: boolean
description: (default = false)
Pulse:
type: boolean
description: (default = false)
_typeDescriptor:
type: string
IntelliTracer.ApiV2.PagedAccessGroupResponse:
type: object
properties:
Data:
items:
$ref: "#/components/schemas/IntelliTracer.ApiV2.AccessGroup"
description: (default = null)
nullable: true
type: array
PagingFilter:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.Api.PagingFilter"
- nullable: true
IntelliTracer.ApiV2.AccessGroup:
type: object
required:
- Id
- Name
properties:
Id:
type: string
example: 00000000-0000-0000-0000-000000000000
Name:
type: string
example: Everyone
Users:
items:
$ref: "#/components/schemas/IntelliTracer.ApiV2.Resource"
description: (default = [])
nullable: true
type: array
IntelliTracer.ApiV2.AccessGroupCreate:
type: object
required:
- Name
properties:
Name:
type: string
example: Everyone
UserIds:
items:
anyOf:
- type: string
example: 00000000-0000-0000-0000-000000000000
- type: string
example: 00000000-0000-0000-0000-000000000000
description: (default = [])
nullable: true
type: array
IntelliTracer.ApiV2.AccessGroupResponse:
type: object
properties:
Data:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV2.AccessGroup"
- nullable: true
IntelliTracer.ApiV2.AccessGroupValidationResult:
type: object
required:
- Entity
- ValidationResult
properties:
Entity:
$ref: "#/components/schemas/IntelliTracer.ApiV2.AccessGroup"
ValidationResult:
type: array
items: {}
IntelliTracer.ApiV2.AccessGroupEdit:
type: object
required:
- Id
- Name
properties:
Id:
type: string
example: 00000000-0000-0000-0000-000000000000
Name:
type: string
example: Everyone
UserIds:
items:
anyOf:
- type: string
example: 00000000-0000-0000-0000-000000000000
- type: string
example: 00000000-0000-0000-0000-000000000000
description: (default = [])
nullable: true
type: array
IntelliTracer.ApiV2.AccessGroupUserList:
type: object
properties:
UserIds:
items:
anyOf:
- type: string
example: 00000000-0000-0000-0000-000000000000
- type: string
example: 00000000-0000-0000-0000-000000000000
description: (default = [])
nullable: true
type: array
IntelliTracer.ApiV1.AccessLocationLite:
type: object
required:
- Id
- Name
properties:
Id:
type: string
example: 00000000-0000-0000-0000-000000000000
Name:
type: string
example: Entrance
Readers:
items:
$ref: "#/components/schemas/IntelliTracer.ApiV1.AccessLocationReader"
description: (default = null)
nullable: true
type: array
Relais:
items:
$ref: "#/components/schemas/IntelliTracer.ApiV1.AccessLocationRelais"
description: (default = null)
nullable: true
type: array
_typeDescriptor:
type: string
IntelliTracer.ApiV1.AccessLocationReader:
type: object
required:
- ReaderId
- ReaderName
properties:
ReaderId:
type: string
example: 00000000-0000-0000-0000-000000000000
ReaderName:
type: string
example: Entrance
_typeDescriptor:
type: string
IntelliTracer.ApiV1.AccessLocationRelais:
type: object
required:
- RelaisId
- RelaisName
properties:
RelaisId:
type: string
example: 00000000-0000-0000-0000-000000000000
RelaisName:
type: string
example: Entrance
_typeDescriptor:
type: string
IntelliTracer.ApiV1.AccessLocationUserAccess:
type: object
required:
- UserId
- ScheduleId
properties:
PersonId:
type: string
example: 00000000-0000-0000-0000-000000000000
description: |-
(default = null)
ID of the person who was granted access.
UserId:
type: string
example: 00000000-0000-0000-0000-000000000000
ScheduleId:
type: string
example: 00000000-0000-0000-0000-000000000000
IsMaster:
type: boolean
description: |-
(default = false)
Whether this user is a master user (= will always be granted entry).
Relais:
type: string
description: |-
(default = null)
Relais that was accessed.
_typeDescriptor:
type: string
IntelliTracer.ApiV1.AccessLocationUserAccessGrant:
type: object
required:
- AccessScheduleId
properties:
PersonId:
type: string
example: 00000000-0000-0000-0000-000000000000
description: |-
(default = null)
ID of the person that was granted entry.
UserId:
type: string
example: 00000000-0000-0000-0000-000000000000
description: |-
(default = null)
ID of the user that was denied entry.
AccessScheduleId:
type: string
example: 00000000-0000-0000-0000-000000000000
description: |-
(default = null)
ID of the linked access schedule.
IntelliTracer.ApiV1.AccessLocationUserAccessDeny:
type: object
properties:
PersonId:
type: string
example: 00000000-0000-0000-0000-000000000000
description: |-
(default = null)
ID of the person that was denied entry.
UserId:
type: string
example: 00000000-0000-0000-0000-000000000000
description: |-
(default = null)
ID of the user that was denied entry.
IntelliTracer.ApiV1.AccessLocationCiawAccessGrant:
type: object
required:
- Name
- BadgeNumber
- OwnStaff
- AddToGroup
- AccessScheduleId
properties:
LimosaNumber:
type: number
example: 11223344556677888
description: |-
(default = 0)
Limosa number, used for foreign employees.
RrnNumber:
type: number
example: 79040205768
description: |-
(default = 0)
Rijksregisternummer, used for Belgian employees.
Name:
type: string
example: John Doe
description: Name of the person who was granted access
BtwNumber:
type: string
example: "1122334455"
description: |-
(default = null)
VAT number
BadgeNumber:
type: string
example: 00AA11BB
description: Badge number used for this registration
LimosaExpirationDate:
type: string
example: 2019-01-24T17:00:00+01:00
description: (default = null)
A1ExpirationDate:
example: 2019-01-25T08:00:00+02:00
description: (default = null)
nullable: true
type: string
VisaExpirationDate:
example: 2019-01-25T08:00:00+02:00
description: |-
(default = null)
Date this person's Limosa number expires.
nullable: true
type: string
OwnStaff:
type: boolean
description: >-
(default = false)
Whether this employee works for the current company or for a different one.
AddToGroup:
type: string
example: Employees
description: Add this user to an access group.
AccessScheduleId:
type: string
example: 00000000-0000-0000-0000-000000000000
description: ID of the linked access schedule.
IntelliTracer.ApiV1.AccessLocationCiawAccessResult:
allOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV1.AccessLocationUserAccessResult"
- type: object
required:
- UserId
- PersonId
properties:
UserId:
type: string
example: 00000000-0000-0000-0000-000000000000
PersonId:
type: string
example: 00000000-0000-0000-0000-000000000000
IntelliTracer.ApiV2.AccessLocationAccessControlScheduleListResponse:
type: object
properties:
Data:
items:
$ref: "#/components/schemas/IntelliTracer.ApiV2.AccessLocationAccessControlSche\
dule"
nullable: true
type: array
IntelliTracer.ApiV2.AccessLocationAccessControlScheduleEdit:
type: object
required:
- ScheduleId
properties:
ScheduleId:
type: string
example: 00000000-0000-0000-0000-000000000000
GroupIds:
items:
anyOf:
- type: string
example: 00000000-0000-0000-0000-000000000000
- type: string
example: 00000000-0000-0000-0000-000000000000
description: (default = [])
nullable: true
type: array
IntelliTracer.ApiV2.AccessLocationAccessControlScheduleGroupList:
type: object
properties:
GroupIds:
items:
anyOf:
- type: string
example: 00000000-0000-0000-0000-000000000000
- type: string
example: 00000000-0000-0000-0000-000000000000
description: (default = [])
nullable: true
type: array
IntelliTracer.ApiV1.AccessLog:
type: object
required:
- TimeStamp
properties:
TimeStamp:
type: string
example: 2019-01-25T08:06:45+01:00
UserName:
example: John Doe
description: (default = null)
nullable: true
type: string
UserId:
example: 00000000-0000-0000-0000-000000000000
description: (default = null)
nullable: true
type: string
LocationName:
example: Entrance
description: |-
(default = null)
Name of the location that was accessed.
nullable: true
type: string
LocationId:
example: 00000000-0000-0000-0000-000000000000
description: |-
(default = null)
ID of the location that was accessed.
nullable: true
type: string
RelaisName:
example: Front
description: |-
(default = null)
Name of the relais that was accessed.
nullable: true
type: string
ReaderName:
example: Front
description: |-
(default = null)
Name of the Reader that was accessed.
nullable: true
type: string
AccessGranted:
type: boolean
example: true
description: (default = false)
Type:
example: AccessGranted_MagStripe
description: (default = null)
nullable: true
type: string
BadgeNumber:
example: "00000000"
description: (default = null)
nullable: true
type: string
_typeDescriptor:
type: string
IntelliTracer.ApiV2.Badge:
type: object
required:
- Id
- Number
- Type
- ExternalNumber
properties:
Id:
type: string
example: 00000000-0000-0000-0000-000000000000
Number:
type: string
example: 00BB4E6F
Type:
$ref: "#/components/schemas/IntelliTracer.Domain.BadgeType"
ExternalNumber:
type: string
example: 00BB4E6F
IntelliTracer.ApiV2.BTW:
type: object
required:
- Id
- Number
- Name
- Country
- CountryCode
- FormattedBTWNumber
properties:
Id:
type: string
example: 00000000-0000-0000-0000-000000000000
Number:
type: string
example: "123456789"
Name:
type: string
example: GeoDynamics
Country:
$ref: "#/components/schemas/IntelliTracer.Domain.Country"
CountryCode:
type: string
example: BE
FormattedBTWNumber:
type: string
example: BE-123456789
IntelliTracer.ApiV3.LimosaDataResponse:
type: object
properties:
Data:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV3.Limosa"
- nullable: true
IntelliTracer.ApiV3.Limosa:
type: object
required:
- Id
- LimosaNumber
properties:
Id:
type: string
example: 00000000-0000-0000-0000-000000000000
LimosaNumber:
type: number
example: 11223344556677888
IsDefault:
type: boolean
description: (default = false)
EndDate:
example: 2020-10-30T00:00:00+01:00
description: (default = null)
nullable: true
type: string
Workplaces:
items:
$ref: "#/components/schemas/IntelliTracer.ApiV3.WorkplaceInfo"
description: (default = [])
nullable: true
type: array
IntelliTracer.ApiV3.WorkplaceInfo:
type: object
required:
- Id
- DUC
properties:
Id:
type: string
example: 00000000-0000-0000-0000-000000000000
DUC:
type: string
example: 1Y100001AB1CD
Code:
example: "012345"
description: (default = null)
nullable: true
type: string
Name:
example: GeoDynamics
description: (default = null)
nullable: true
type: string
IntelliTracer.ApiV3.LimosaValidationResult:
type: object
required:
- Entity
- ValidationResult
properties:
Entity:
$ref: "#/components/schemas/IntelliTracer.ApiV3.Limosa"
ValidationResult:
type: array
items: {}
IntelliTracer.ApiV2.PersonResponse:
type: object
properties:
Data:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV2.Person"
- nullable: true
IntelliTracer.ApiV2.Person:
type: object
required:
- Id
- ShortCode
- Type
properties:
Id:
type: string
example: 00000000-0000-0000-0000-000000000000
ShortCode:
type: number
example: 123456789
Code:
example: "12345"
description: (default = null)
nullable: true
type: string
Type:
$ref: "#/components/schemas/IntelliTracer.ApiV2.PersonType"
RRNNumber:
type: number
example: 79040205768
description: (default = null)
FormattedRRNNumber:
example: 79.04.02-057.68
description: (default = null)
nullable: true
type: string
LimosaNumber:
type: number
example: 11223344556677888
description: (default = null)
BTW:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV2.BTW"
- nullable: true
Notes:
example: John Doe
description: (default = null)
nullable: true
type: string
Badges:
items:
$ref: "#/components/schemas/IntelliTracer.ApiV2.Badge"
description: (default = [])
nullable: true
type: array
FeedbackGSM:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV2.GSM"
- nullable: true
RegisterGSM:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV2.GSM"
- nullable: true
LimosaEndDate:
example: 2019-01-25T08:00:00+02:00
description: (default = null)
nullable: true
type: string
CreationTimeStamp:
example: 2019-01-25T08:00:00+02:00
description: (default = null)
nullable: true
type: string
BirthDate:
example: 2019-01-25
description: (default = null)
nullable: true
type: string
ReceiveFeedback:
type: boolean
description: (default = false)
ApproveRegistration:
type: boolean
description: (default = false)
User:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV2.Resource"
- nullable: true
BadgeTimeStamp:
example: 2019-01-25T08:00:00+02:00
description: "(default = null) "
nullable: true
type: string
Inactive:
type: boolean
description: (default = false)
InactivityTimestamp:
example: 2019-01-25T08:00:00+02:00
description: (default = null)
nullable: true
type: string
A1ExpirationDate:
example: 2019-01-25T08:00:00+02:00
description: (default = null)
nullable: true
type: string
VisaExpirationDate:
example: 2019-01-25T08:00:00+02:00
description: (default = null)
nullable: true
type: string
Limosas:
items:
$ref: "#/components/schemas/IntelliTracer.ApiV2.Limosa"
description: (default = null)
nullable: true
type: array
QrUrl:
example: https://api.intellitracer.be/qrcode.pdf
description: (default = null)
nullable: true
type: string
Info:
type: string
example: Person info
LimosaStartDate:
example: 2019-01-25T08:00:00
description: (default = null)
nullable: true
type: string
BISNumber:
type: number
example: 79040205768
description: (default = null)
FormattedBISNumber:
example: 79.04.02-057.68
description: (default = null)
nullable: true
type: string
IntelliTracer.ApiV2.Limosa:
type: object
required:
- Id
- LimosaNumber
properties:
Id:
type: string
example: 00000000-0000-0000-0000-000000000000
LimosaNumber:
type: number
example: 11223344556677888
IsDefault:
type: boolean
description: (default = false)
EndDate:
example: 2020-10-30T00:00:00+01:00
description: (default = null)
nullable: true
type: string
Workplaces:
items:
$ref: "#/components/schemas/IntelliTracer.ApiV2.WorkplaceInfo"
description: (default = [])
nullable: true
type: array
IntelliTracer.ApiV2.PagedBadgeResponse:
type: object
properties:
Data:
items:
$ref: "#/components/schemas/IntelliTracer.ApiV2.Badge"
description: (default = null)
nullable: true
type: array
PagingFilter:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.Api.PagingFilter"
- nullable: true
IntelliTracer.ApiV2.BadgeResponse:
type: object
properties:
Data:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV2.Badge"
- nullable: true
IntelliTracer.ApiV2.BadgeCreate:
type: object
required:
- Number
- Type
properties:
Number:
type: string
example: 00BB4E6F
Type:
$ref: "#/components/schemas/IntelliTracer.Domain.BadgeType"
ExternalNumber:
type: string
example: "12345678"
description: (default = null)
IntelliTracer.ApiV2.PagedBTWResponse:
type: object
properties:
Data:
items:
$ref: "#/components/schemas/IntelliTracer.ApiV2.BTW"
description: (default = null)
nullable: true
type: array
PagingFilter:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.Api.PagingFilter"
- nullable: true
IntelliTracer.ApiV1.UserWithPerson:
type: object
required:
- User
- Person
properties:
User:
$ref: "#/components/schemas/IntelliTracer.ApiV1.UserCreate"
Person:
$ref: "#/components/schemas/IntelliTracer.ApiV1.PersonCreate"
_typeDescriptor:
type: string
IntelliTracer.ApiV1.UserCreate:
type: object
required:
- Name
properties:
Name:
type: string
example: John Doe
Code:
example: "012345"
description: (default = null)
nullable: true
type: string
EmployerCode:
example: "012345"
description: (default = null)
nullable: true
type: string
Email:
example: john.doe@doe.com
description: (default = null)
nullable: true
type: string
Gsm:
example: "+32477665544"
description: (default = null)
nullable: true
type: string
FreeField1:
description: (default = null)
nullable: true
type: string
FreeField2:
description: (default = null)
nullable: true
type: string
FreeField3:
description: (default = null)
nullable: true
type: string
FreeField4:
description: (default = null)
nullable: true
type: string
FreeField5:
description: (default = null)
nullable: true
type: string
FreeField6:
description: "(default = null) "
nullable: true
type: string
Notes:
description: |-
(default = null)
Notes for this user.
nullable: true
type: string
Street:
example: Dumolinlaan
description: (default = null)
nullable: true
type: string
HouseNumber:
example: "9"
description: (default = null)
nullable: true
type: string
City:
example: Kortrijk
description: (default = null)
nullable: true
type: string
PostalCode:
example: "8500"
description: (default = null)
nullable: true
type: string
Submunicipality:
example: Kortrijk
description: (default = null)
nullable: true
type: string
Country:
$ref: "#/components/schemas/IntelliTracer.Domain.Country"
Longitude:
example: 3.245304
description: >-
(default = null)
Geographic coordinate that specifies the east–west position of a point on the Earth's surface.
nullable: true
type: number
Latitude:
example: 50.812939
description: >-
(default = null)
Geographic coordinate that specifies the north–south position of a point on the Earth's surface.
nullable: true
type: number
DefaultDayProgram:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.Api.Id"
- nullable: true
IntelliTracer.ApiV1.PersonCreate:
type: object
properties:
ShortCode:
type: number
example: 100
description: |-
(default = 0)
ShortCode for this person.
Code:
example: "012345"
description: |-
(default = null)
Code for this person.
nullable: true
type: string
Notes:
example: Name
description: |-
(default = null)
Notes for this person.
nullable: true
type: string
Type:
$ref: "#/components/schemas/IntelliTracer.ApiV1.PersonType"
RRNNumber:
type: number
example: 79040205768
description: |-
(default = 0)
Rijksregisternummer, used for Belgian employees.
LimosaNumber:
type: number
example: 11223344556677888
description: >-
(default = 0)
Limosa number, used for foreign employees instead of a rijksregisternummer.
BisNumber:
type: number
example: 79040205768
BTW:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV1.PersonBTWCreate"
- nullable: true
Badges:
items:
$ref: "#/components/schemas/IntelliTracer.Api.Id"
description: |-
(default = null)
List of badges linked to this person.
nullable: true
type: array
FeedbackGSM:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.Api.Id"
- nullable: true
RegisterGSM:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.Api.Id"
- nullable: true
LimosaEndDate:
example: 2015-10-30T00:00:00+01:00
description: (default = null)
nullable: true
type: string
A1ExpirationDate:
example: 2019-01-25T08:00:00+02:00
description: (default = null)
nullable: true
type: string
VisaExpirationDate:
example: 2019-01-25T08:00:00+02:00
description: |-
(default = null)
The date this person's Limosa number expires.
nullable: true
type: string
BirthDate:
example: 1979-04-02T00:00:00
description: |-
(default = null)
Birth date for this person.
nullable: true
type: string
ReceiveFeedback:
type: boolean
description: >-
(default = false)
Whether this person should receive feedback text messages or emails when registrations are created.
ApproveRegistration:
type: boolean
description: >-
(default = false)
Whether CheckInAtWork registrations from this person need to be manually approved before they are sent to the RSZ.
Inactive:
type: boolean
description: (default = false)
StaffType:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.Domain.StaffType"
- nullable: true
IntelliTracer.ApiV1.PersonBTWCreate:
allOf:
- $ref: "#/components/schemas/IntelliTracer.Api.Id"
- type: object
required:
- Number
properties:
Number:
type: string
example: "1122334455"
Country:
$ref: "#/components/schemas/IntelliTracer.Domain.Country"
IntelliTracer.ApiV1.UserWithPersonResult:
type: object
required:
- Success
- UserId
- PersonId
properties:
Success:
type: boolean
ErrorMessage:
description: (default = null)
nullable: true
type: string
UserId:
type: string
PersonId:
type: string
IntelliTracer.ApiV2.PersonType:
type: number
x-enumDescriptions:
"0": RRN
"1": Limosa
enum:
- null
- 0
- 1
IntelliTracer.ApiV1.Person:
type: object
required:
- StaffType
properties:
Id:
type: string
example: 00000000-0000-0000-0000-000000000000
UserId:
example: 00000000-0000-0000-0000-000000000000
description: |-
(default = null)
Unique ID for this person.
nullable: true
type: string
Label:
example: John Doe
description: |-
(default = null)
Name of this person.
nullable: true
type: string
ShortCode:
type: number
example: 100
description: |-
(default = 0)
ShortCode for this person.
Code:
example: "012345"
description: |-
(default = null)
Code for this person.
nullable: true
type: string
Type:
$ref: "#/components/schemas/IntelliTracer.ApiV1.PersonType"
RRNNumber:
type: number
example: 79040205768
description: |-
(default = 0)
Rijksregisternummer, used for Belgian employees.
FormattedRRNNumber:
example: 79.04.02-057.68
description: |-
(default = null)
Rijksregisternummer, used for Belgian employees. Formatted.
nullable: true
type: string
LimosaNumber:
type: number
example: 11223344556677888
description: (default = 0)
BisNumber:
type: number
example: 79040205768
description: (default = null)
FormattedBisNumber:
example: 79.04.02-057.68
description: >-
(default = null)
Limosa number, used for foreign employees instead of a rijksregisternummer.
nullable: true
type: string
BTW:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV1.BTW"
- nullable: true
Notes:
description: |-
(default = null)
Notes for this person.
nullable: true
type: string
Badges:
items:
$ref: "#/components/schemas/IntelliTracer.ApiV1.PersonBadge"
description: |-
(default = null)
List of badges linked to this person.
nullable: true
type: array
FeedbackGSM:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV1.GSM"
- nullable: true
RegisterGSM:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV1.GSM"
- nullable: true
LimosaEndDate:
example: 2015-10-30T00:00:00+01:00
description: |-
(default = null)
The expiry date for this person's Limosa document.
nullable: true
type: string
CreationTimeStamp:
example: 2015-09-21T22:01:20+02:00
description: |-
(default = null)
Date and time that this person was created in our system.
nullable: true
type: string
BirthDate:
example: 1979-04-02T00:00:00
description: |-
(default = null)
Birth date of this CIAW user.
nullable: true
type: string
ReceiveFeedback:
type: boolean
description: >-
(default = false)
Whether this person should receive feedback texts or emails when registrations are created.
ApproveRegistration:
type: boolean
description: (default = false)
Inactive:
type: boolean
description: (default = false)
InactivityTimestamp:
example: 2019-01-25T08:00:00+02:00
description: (default = null)
nullable: true
type: string
QrUrl:
example: https://api.intellitracer.be/qrcode.pdf
description: >-
(default = null)
Link to a PDF file that contains a scannable QR code for this Person.
nullable: true
type: string
Limosas:
items:
$ref: "#/components/schemas/IntelliTracer.ApiV1.Limosa"
description: (default = null)
nullable: true
type: array
StaffType:
$ref: "#/components/schemas/IntelliTracer.Domain.StaffType"
_typeDescriptor:
type: string
IntelliTracer.ApiV2.PutPersonRequest:
type: object
properties:
Code:
example: "12345"
description: (default = null)
nullable: true
type: string
Name:
example: John Doe
description: (default = null)
nullable: true
type: string
BTWNumber:
example: BE-0000000000
description: (default = null)
nullable: true
type: string
FeedbackGSMNumber:
example: "+32478123456"
description: (default = null)
nullable: true
type: string
RegisterGSMNumber:
example: "+32478123456"
description: (default = null)
nullable: true
type: string
OwnStaff:
type: boolean
description: "(default = false) "
BadgeNumber:
example: 00BB4E6F
description: "(default = null) "
nullable: true
type: string
ReceiveFeedback:
type: boolean
description: (default = false)
IntelliTracer.ApiV2.PutPersonByLimosaRequest:
allOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV2.PutPersonRequest"
- type: object
required:
- LimosaNumber
properties:
LimosaNumber:
type: number
example: 11223344556677888
BirthDate:
example: 2019-01-25
description: (default = null)
nullable: true
type: string
ExpirationDate:
example: 2019-01-25T08:00:00+02:00
description: (default = null)
nullable: true
type: string
BisNumber:
example: 79040205768
nullable: true
type: number
IntelliTracer.ApiV2.PersonListResponse:
type: object
properties:
Data:
items:
$ref: "#/components/schemas/IntelliTracer.ApiV2.Person"
description: (default = null)
nullable: true
type: array
IntelliTracer.ApiV2.PutPersonByRrnAndBtwRequest:
allOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV2.PutPersonRequest"
- type: object
required:
- RRNNumber
- BTWNumber
properties:
RRNNumber:
type: number
example: 79040205768
BTWNumber:
type: string
example: BE-0000000000
IntelliTracer.ApiV2.PutPersonByBisRequest:
allOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV2.PutPersonRequest"
- type: object
required:
- BisNumber
properties:
BisNumber:
type: number
example: 79040205768
LimosaNumber:
example: 11223344556677888
nullable: true
type: number
StartDate:
example: 2019-01-25T08:00:00+02:00
description: (default = null)
nullable: true
type: string
BirthDate:
example: 2019-01-25
description: (default = null)
nullable: true
type: string
ExpirationDate:
example: 2019-01-25T08:00:00+02:00
description: (default = null)
nullable: true
type: string
IntelliTracer.ApiV1.PersonBadge:
type: object
required:
- Id
- Number
properties:
Id:
type: string
example: 00000000-0000-0000-0000-000000000000
Number:
type: string
example: 00AA11BB
_typeDescriptor:
type: string
IntelliTracer.ApiV1.Limosa:
type: object
required:
- Id
- LimosaNumber
properties:
Id:
type: string
example: 00000000-0000-0000-0000-000000000000
LimosaNumber:
type: number
example: 11223344556677888
IsDefault:
type: boolean
description: (default = false)
EndDate:
example: 2020-10-30T00:00:00+01:00
description: (default = null)
nullable: true
type: string
Workplaces:
items:
$ref: "#/components/schemas/IntelliTracer.ApiV1.Workplace"
description: (default = [])
nullable: true
type: array
IntelliTracer.ApiV1.Workplace:
type: object
required:
- Id
- DUC
properties:
Id:
type: string
example: 00000000-0000-0000-0000-000000000000
DUC:
type: string
example: 1Y100001AB1CD
Code:
example: "012345"
description: (default = null)
nullable: true
type: string
Name:
example: GeoDynamics
description: (default = null)
nullable: true
type: string
IntelliTracer.ApiV1.BTW:
type: object
required:
- Id
- Number
- Name
properties:
Id:
type: string
example: 00000000-0000-0000-0000-000000000000
Number:
type: string
example: "1122334455"
Name:
type: string
example: Geodynamics
Country:
$ref: "#/components/schemas/IntelliTracer.Domain.Country"
FormattedBTWNumber:
example: BE-1122334455
description: (default = null)
nullable: true
type: string
_typeDescriptor:
type: string
IntelliTracer.ApiV1.GSM:
type: object
required:
- Id
- GSMNumber
properties:
Id:
type: string
example: 00000000-0000-0000-0000-000000000000
GSMNumber:
type: string
example: "+32498465432"
_typeDescriptor:
type: string
IntelliTracer.ApiV3.LimosaPagedDataResponse:
type: object
properties:
Data:
items:
$ref: "#/components/schemas/IntelliTracer.ApiV3.Limosa"
description: (default = null)
nullable: true
type: array
PagingFilter:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.Api.PagingFilter"
- nullable: true
IntelliTracer.ApiV3.LimosaRequest:
type: object
required:
- LimosaNumber
properties:
LimosaNumber:
type: number
example: 11223344556677888
EndDate:
example: 2020-10-30T00:00:00+01:00
description: (default = null)
nullable: true
type: string
WorkplaceDucs:
type: array
items: {}
description: (default = [])
IntelliTracer.ApiV3.LimosaWorkplaceList:
type: object
required:
- WorkplaceDucs
properties:
WorkplaceDucs:
type: array
items: {}
IntelliTracer.ApiV2.PostPersonLimosaRequest:
type: object
required:
- LimosaNumber
- ExpirationDate
- StartDate
properties:
LimosaNumber:
type: number
example: 11223344556677888
description: (default = 0)
ExpirationDate:
example: 2019-01-25T08:00:00+02:00
description: (default = null)
nullable: true
type: string
StartDate:
example: 2019-01-25T08:00:00+02:00
description: (default = null)
nullable: true
type: string
IntelliTracer.ApiV2.PostPersonBTWRequest:
type: object
required:
- BtwNumber
properties:
BtwNumber:
type: string
example: BE-0000000000
IntelliTracer.ApiV2.PostPersonActivityRequest:
type: object
required:
- Inactive
properties:
Inactive:
type: boolean
IntelliTracer.ApiV2.PostPersonBadgeRequest:
type: object
required:
- BadgeNumber
- BadgeType
properties:
BadgeNumber:
type: string
example: 00BB4E6F
BadgeType:
$ref: "#/components/schemas/IntelliTracer.Domain.BadgeType"
IntelliTracer.ApiV2.PostPersonUserRequest:
type: object
required:
- UserId
properties:
UserId:
type: string
example: 00000000-0000-0000-0000-000000000000
IntelliTracer.ApiV2.PostPersonByRrnAndBtwRequest:
type: object
required:
- Btw
- INSZ
properties:
Btw:
type: string
example: BE-0000000000
INSZ:
type: string
example: "79040205768"
IntelliTracer.ApiV2.PagedPersonGroupResponse:
type: object
properties:
Data:
items:
$ref: "#/components/schemas/IntelliTracer.ApiV2.PersonGroup"
description: (default = null)
nullable: true
type: array
PagingFilter:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.Api.PagingFilter"
- nullable: true
IntelliTracer.ApiV2.PersonGroup:
type: object
required:
- Id
- Name
properties:
Id:
type: string
example: 00000000-0000-0000-0000-000000000000
Name:
type: string
example: Group 1
Persons:
items:
$ref: "#/components/schemas/IntelliTracer.ApiV2.Person"
description: (default = [])
nullable: true
type: array
IntelliTracer.ApiV2.PersonGroupCreate:
type: object
required:
- Name
properties:
Name:
type: string
example: Group 1
PersonIds:
items:
anyOf:
- type: string
example: 00000000-0000-0000-0000-000000000000
- type: string
example: 00000000-0000-0000-0000-000000000000
description: (default = [])
nullable: true
type: array
IntelliTracer.ApiV2.PersonGroupUpdate:
type: object
required:
- Id
- Name
properties:
Id:
type: string
example: 00000000-0000-0000-0000-000000000000
Name:
type: string
example: Group 1
PersonIds:
items:
anyOf:
- type: string
example: 00000000-0000-0000-0000-000000000000
- type: string
example: 00000000-0000-0000-0000-000000000000
description: (default = [])
nullable: true
type: array
IntelliTracer.ApiV2.PersonGroupAddRemovePersons:
type: object
properties:
PersonIds:
items:
anyOf:
- type: string
example: 00000000-0000-0000-0000-000000000000
- type: string
example: 00000000-0000-0000-0000-000000000000
description: (default = [])
nullable: true
type: array
IntelliTracer.ApiV2.ValidateWorkplacesRequest:
type: object
required:
- WorkplaceDucs
properties:
WorkplaceDucs:
type: array
items: {}
IntelliTracer.ApiV2.ValidateWorkplacesResponse:
type: object
required:
- Workplaces
properties:
Workplaces:
type: array
items: {}
IntelliTracer.ApiV2.WorkplaceValidation:
type: object
required:
- DUC
- IsValid
properties:
DUC:
type: string
example: 1Y100001AB1CD
IsValid:
type: boolean
IntelliTracer.ApiV2.PagedWorkplaceResponse:
type: object
properties:
Data:
items:
$ref: "#/components/schemas/IntelliTracer.ApiV2.Workplace"
description: (default = null)
nullable: true
type: array
PagingFilter:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.Api.PagingFilter"
- nullable: true
IntelliTracer.ApiV2.WorkplaceResponse:
type: object
properties:
Data:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV2.Workplace"
- nullable: true
IntelliTracer.ApiV2.Workplace:
type: object
required:
- DUC
properties:
Id:
type: string
example: 00000000-0000-0000-0000-000000000000
description: (default = `00000000-0000-0000-0000-000000000000`)
DUC:
type: string
example: 1Y100001AB1CD
Code:
example: "012345"
description: (default = null)
nullable: true
type: string
Owner:
example: GeoDynamics
description: (default = null)
nullable: true
type: string
Type:
example: Werken in onroerende staat
description: (default = null)
nullable: true
type: string
Address:
example: Dumolinlaan 9, 8530 Kortrijk
description: (default = null)
nullable: true
type: string
Notes:
example: GeoDynamics
description: (default = null)
nullable: true
type: string
IsNotifiable:
type: boolean
description: (default = false)
IsClosed:
type: boolean
description: (default = false)
EmailFeedback:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV2.WorkplaceEmailFeedback"
- nullable: true
EndDate:
example: 2015-09-21T22:01:20+02:00
description: (default = null)
nullable: true
type: string
StartDate:
example: 2015-09-21T22:01:20+02:00
description: (default = null)
nullable: true
type: string
Name:
example: GeoDynamics
description: (default = null)
nullable: true
type: string
CreationTimestamp:
example: 2015-09-21T22:01:20+02:00
description: (default = null)
nullable: true
type: string
BTW:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV2.BTW"
- nullable: true
SmsFeedback:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV2.WorkplaceSmsFeedback"
- nullable: true
ShortCode:
type: number
example: 100
description: (default = 0)
QrUrl:
example: https://api.intellitracer.be/qrcode.pdf
description: (default = null)
nullable: true
type: string
IntelliTracer.ApiV2.WorkplaceCreate:
type: object
required:
- DUC
properties:
DUC:
type: string
example: 1Y100001AB1CD
description: ID unique site number (as known by the RSZ in case validateRsz=true).
Code:
example: "012345"
description: >-
(default = null)
Multiple codes are supported, split them with a semicolon (1;2;3)
If there is an existing point of interest with the same code, it will automatically be linked to the workplace if ‘syncPoisByCode’ is set to true.
nullable: true
type: string
Owner:
example: GeoDynamics
description: (default = null)
nullable: true
type: string
Type:
example: Werken in onroerende staat
description: (default = null)
nullable: true
type: string
Address:
example: Dumolinlaan 9, 8530 Kortrijk
description: (default = null)
nullable: true
type: string
Notes:
example: GeoDynamics
description: (default = null)
nullable: true
type: string
IsNotifiable:
type: boolean
description: |-
(default = false)
CheckInAtWork registrations will be sent to the Rsz if true.
IsClosed:
type: boolean
description: |-
(default = false)
Should be true in case work at this workplace has been completed.
EmailFeedback:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV2.WorkplaceEmailFeedback"
- nullable: true
SmsFeedback:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV2.WorkplaceSmsFeedbackEdit"
- nullable: true
BTWNumber:
example: BE-0000000000
description: "(default = null) "
nullable: true
type: string
EndDate:
example: 2015-09-21T22:01:20+02:00
description: |-
(default = null)
Date on which the work at this workplace is planned to finish.
nullable: true
type: string
StartDate:
example: 2015-09-21T22:01:20+02:00
description: |-
(default = null)
Date on which the work at this workplace is planned to start.
nullable: true
type: string
IntelliTracer.ApiV2.WorkplaceEdit:
type: object
required:
- Id
- DUC
properties:
Id:
type: string
example: 00000000-0000-0000-0000-000000000000
description: (default = `00000000-0000-0000-0000-000000000000`)
DUC:
type: string
example: 1Y100001AB1CD
description: ID unique site number (as known by the RSZ in case validateRsz=true).
Code:
example: "012345"
description: >-
(default = null)
Multiple codes are supported, split them with a semicolon (1;2;3)
If there is an existing point of interest with the same code, it will automatically be linked to the workplace if ‘syncPoisByCode’ is set to true.
nullable: true
type: string
Owner:
example: GeoDynamics
description: (default = null)
nullable: true
type: string
Type:
example: Werken in onroerende staat
description: (default = null)
nullable: true
type: string
Address:
example: Dumolinlaan 9, 8530 Kortrijk
description: (default = null)
nullable: true
type: string
Notes:
example: GeoDynamics
description: (default = null)
nullable: true
type: string
IsNotifiable:
type: boolean
description: |-
(default = false)
CheckInAtWork registrations will be sent to the Rsz if true.
IsClosed:
type: boolean
description: |-
(default = false)
Should be true in case work at this workplace has been completed.
EmailFeedback:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV2.WorkplaceEmailFeedback"
- nullable: true
SmsFeedback:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV2.WorkplaceSmsFeedbackEdit"
- nullable: true
BTWNumber:
example: BE-0000000000
description: "(default = null) "
nullable: true
type: string
EndDate:
example: 2015-09-21T22:01:20+02:00
description: |-
(default = null)
Date on which the work at this workplace is planned to finish.
nullable: true
type: string
StartDate:
example: 2015-09-21T22:01:20+02:00
description: |-
(default = null)
Date on which the work at this workplace is planned to start.
nullable: true
type: string
IntelliTracer.ApiV2.WorkplaceEmailFeedback:
type: object
required:
- Enabled
properties:
Enabled:
type: boolean
EmailAddress:
description: (default = null)
nullable: true
type: string
IntelliTracer.ApiV2.WorkplaceSmsFeedback:
type: object
required:
- Enabled
properties:
Enabled:
type: boolean
GSMs:
items:
$ref: "#/components/schemas/IntelliTracer.ApiV2.GSM"
description: (default = null)
nullable: true
type: array
IntelliTracer.ApiV2.WorkplaceSmsFeedbackEdit:
type: object
required:
- Enabled
properties:
Enabled:
type: boolean
"GSMIds `00000000-0000-0000-0000-000000000000`,`00000000-0000-0000-0000-000000000000`":
items:
type: string
description: (default = null)
nullable: true
type: array
IntelliTracer.ApiV2.WorkplacePoiList:
type: object
required:
- PoiIds
properties:
PoiIds:
type: array
items: {}
IntelliTracer.ApiV2.WorkplacePoiValidationResult:
type: object
required:
- Entity
- ValidationResult
properties:
Entity:
$ref: "#/components/schemas/IntelliTracer.ApiV2.PoiInfo"
ValidationResult:
type: array
items: {}
IntelliTracer.ApiV1.WorkplaceOverview:
type: object
required:
- Date
properties:
Amount:
type: number
example: 1
description: >-
(default = 0)
Amount of CheckInAtWork registrations made at this workplace on this date.
VAT:
example: BE-1122334455
description: |-
(default = null)
VAT number linked to this workplace.
nullable: true
type: string
Workplace:
example: 1Y100001AB1CD
nullable: true
type: string
Date:
type: string
example: 2019-03-27T00:00:00
IntelliTracer.ApiV2.PagedProjectLeadResponse:
type: object
properties:
Data:
items:
$ref: "#/components/schemas/IntelliTracer.ApiV2.ProjectLead"
description: (default = null)
nullable: true
type: array
PagingFilter:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.Api.PagingFilter"
- nullable: true
IntelliTracer.ApiV2.ProjectLeadResponse:
type: object
properties:
Data:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV2.ProjectLead"
- nullable: true
IntelliTracer.ApiV2.ProjectLeadValidationResult:
type: object
required:
- Entity
- ValidationResult
properties:
Entity:
$ref: "#/components/schemas/IntelliTracer.ApiV2.ProjectLead"
ValidationResult:
type: array
items: {}
IntelliTracer.ApiV2.ProjectLeadCreate:
type: object
required:
- UserId
properties:
UserId:
type: string
example: 00000000-0000-0000-0000-000000000000
WorkplaceDucs:
type: array
items: {}
BtwNumbers:
type: array
items: {}
IntelliTracer.ApiV2.ProjectLeadUpdate:
type: object
required:
- Id
- UserId
properties:
Id:
type: string
example: 00000000-0000-0000-0000-000000000000
UserId:
type: string
example: 00000000-0000-0000-0000-000000000000
WorkplaceDucs:
type: array
items: {}
BtwNumbers:
type: array
items: {}
IntelliTracer.ApiV2.ProjectLead:
type: object
required:
- Id
- User
- Name
properties:
Id:
type: string
example: 00000000-0000-0000-0000-000000000000
User:
$ref: "#/components/schemas/IntelliTracer.ApiV2.Resource"
Name:
type: string
example: John Doe
RestrictToAllowedBtws:
type: boolean
Workplaces:
type: array
items: {}
Btws:
type: array
items: {}
IntelliTracer.ApiV2.ProjectLeadWorkplaceResponse:
type: object
required:
- Data
properties:
Data:
type: array
items: {}
IntelliTracer.ApiV2.ProjectLeadWorkplaceList:
type: object
required:
- WorkplaceDucs
properties:
WorkplaceDucs:
type: array
items: {}
IntelliTracer.ApiV2.ProjectLeadWorkplaceValidationResult:
type: object
required:
- Entity
- ValidationResult
properties:
Entity:
$ref: "#/components/schemas/IntelliTracer.ApiV2.WorkplaceInfo"
ValidationResult:
type: array
items: {}
IntelliTracer.ApiV2.ProjectLeadBtwResponse:
type: object
required:
- Data
properties:
Data:
type: array
items: {}
IntelliTracer.ApiV2.ProjectLeadBtwValidationResult:
type: object
required:
- Entity
- ValidationResult
properties:
Entity:
$ref: "#/components/schemas/IntelliTracer.ApiV2.BTW"
ValidationResult:
type: array
items: {}
IntelliTracer.ApiV2.ProjectLeadBtwList:
type: object
required:
- BtwNumbers
properties:
BtwNumbers:
type: array
items: {}
IntelliTracer.ApiV1.RegistrationQueueStatus:
type: number
x-enumDescriptions:
"0": None
"1": Valid
"2": Invalid person
"4": Invalid workplace
"8": Not approved
"16": Rejected
"32": Error
"64": Invalid BTW
"128": Inactive person
"256": Invalid code
"512": BTW not reported
"1024": Awaiting ToBeLisa
"2048": Unknown time registration
"4096": No Limosa for workplace
enum:
- null
- 0
- 1
- 2
- 4
- 8
- 16
- 32
- 64
- 128
- 256
- 512
- 1024
- 2048
- 4096
IntelliTracer.ApiV1.RegistrationCancelationReason:
type: number
x-enumDescriptions:
"0": Holiday
"1": Disease
"2": C32A
"3": Planning
"4": Unknown
enum:
- null
- 0
- 1
- 2
- 3
- 4
IntelliTracer.ApiV2.PagedRegistrationResponse:
type: object
properties:
Data:
items:
$ref: "#/components/schemas/IntelliTracer.ApiV2.Registration"
description: (default = null)
nullable: true
type: array
PagingFilter:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.Api.PagingFilter"
- nullable: true
IntelliTracer.ApiV2.LimosaRegistration:
type: object
required:
- Date
- LimosaNumber
- WorkplaceDuc
properties:
Date:
type: string
example: 2019-01-01T00:00:00
LimosaNumber:
type: number
example: 11223344556677888
WorkplaceDuc:
type: string
example: 1Y100001AB1CD
IntelliTracer.ApiV2.RegistrationResponse:
type: object
properties:
Data:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV2.Registration"
- nullable: true
IntelliTracer.ApiV2.RrnBtwRegistration:
type: object
required:
- Date
- RrnNumber
- BtwNumber
- WorkplaceDuc
properties:
Date:
type: string
example: 2019-01-01T00:00:00
RrnNumber:
type: number
example: 79040205768
BtwNumber:
type: string
example: BE-0000000000
WorkplaceDuc:
type: string
example: 1Y100001AB1CD
IntelliTracer.ApiV2.BisRegistration:
type: object
required:
- Date
- BisNumber
- WorkplaceDuc
properties:
Date:
type: string
example: 2019-01-01T00:00:00
BisNumber:
type: number
example: 79040205768
WorkplaceDuc:
type: string
example: 1Y100001AB1CD
IntelliTracer.ApiV2.RegistrationCancelation:
type: object
properties:
CancelationReason:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV1.RegistrationCancelationReason"
- nullable: true
IntelliTracer.ApiV2.Registration:
type: object
required:
- Id
- RegistrationDate
- RequestTime
properties:
Id:
type: string
example: 00000000-0000-0000-0000-000000000000
Person:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV2.Resource"
- nullable: true
User:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV2.Resource"
- nullable: true
Workplace:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV2.WorkplaceInfo"
- nullable: true
RRNNumber:
type: number
example: 79040205768
description: (default = 0)
LimosaNumber:
type: number
example: 11223344556677888
description: (default = 0)
Btw:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV2.BTW"
- nullable: true
ResponseId:
type: number
example: 10258
description: (default = 0)
RegistrationDate:
type: string
example: 2019-03-25T00:00:00
RequestTime:
type: string
example: 2019-03-25T13:33:49+02:00
Status:
allOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV1.RegistrationQueueStatus"
- type: object
properties: {}
description: (default = 0)
CancelationReason:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV1.RegistrationCancelationReason"
- nullable: true
RSZComment:
type: array
items: {}
description: (default = [])
IntelliTracer.ApiV2.VehicleMaintenanceTaskType:
type: number
x-enumDescriptions:
"0": Fixed
"1": Interval
enum:
- null
- 0
- 1
IntelliTracer.ApiV2.VehicleMaintenanceTaskNotificationRecurrence:
type: number
x-enumDescriptions:
"0": None
"1": Once
"2": Daily
enum:
- null
- 0
- 1
- 2
IntelliTracer.ApiV2.VehicleMaintenanceState:
type: number
x-enumDescriptions:
"0": No maintenance tasks active
"1": Vehicle OK
"2": Warning reached
"3": Deadline reached
enum:
- null
- 0
- 1
- 2
- 3
IntelliTracer.ApiV2.PagedVehicleMaintenanceResponse:
type: object
properties:
Data:
items:
$ref: "#/components/schemas/IntelliTracer.ApiV2.VehicleMaintenance"
description: (default = null)
nullable: true
type: array
PagingFilter:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.Api.PagingFilter"
- nullable: true
IntelliTracer.ApiV2.PagedVehicleMaintenanceTaskResponse:
type: object
properties:
Data:
items:
$ref: "#/components/schemas/IntelliTracer.ApiV2.VehicleMaintenanceTask"
description: (default = null)
nullable: true
type: array
PagingFilter:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.Api.PagingFilter"
- nullable: true
IntelliTracer.ApiV2.PagedVehicleMaintenanceLabelResponse:
type: object
properties:
Data:
items:
$ref: "#/components/schemas/IntelliTracer.ApiV2.VehicleMaintenanceLabel"
description: (default = null)
nullable: true
type: array
PagingFilter:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.Api.PagingFilter"
- nullable: true
IntelliTracer.ApiV2.VehicleMaintenance:
type: object
required:
- Vehicle
- State
properties:
Vehicle:
$ref: "#/components/schemas/IntelliTracer.ApiV2.Vehicle"
State:
$ref: "#/components/schemas/IntelliTracer.ApiV2.VehicleMaintenanceState"
Mileage:
example: 48145
description: (default = null)
nullable: true
type: number
RunningHours:
example: 774
description: (default = null)
nullable: true
type: number
Timestamp:
example: 2021-01-10T11:16:51+01:00
nullable: true
type: string
Tasks:
items:
$ref: "#/components/schemas/IntelliTracer.ApiV2.VehicleMaintenanceTask"
nullable: true
type: array
IntelliTracer.ApiV2.VehicleMaintenanceTask:
type: object
required:
- Id
- Name
- Type
- DeadlineNotificationRecurrence
- WarningNotificationRecurrence
properties:
Id:
type: string
example: 00000000-0000-0000-0000-000000000000
Name:
$ref: "#/components/schemas/IntelliTracer.ApiV2.VehicleMaintenanceLabel"
Type:
$ref: "#/components/schemas/IntelliTracer.ApiV2.VehicleMaintenanceTaskType"
MileageConfig:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV2.VehicleMaintenanceTaskMileageCo\
nfig"
- nullable: true
RunningHoursConfig:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV2.VehicleMaintenanceTaskRunningHo\
ursConfig"
- nullable: true
DateConfig:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV2.VehicleMaintenanceTaskDateConfi\
g"
- nullable: true
DeadlineNotificationRecurrence:
$ref: "#/components/schemas/IntelliTracer.ApiV2.VehicleMaintenanceTaskNotificat\
ionRecurrence"
WarningNotificationRecurrence:
$ref: "#/components/schemas/IntelliTracer.ApiV2.VehicleMaintenanceTaskNotificat\
ionRecurrence"
IntelliTracer.ApiV2.VehicleMaintenanceLabel:
type: object
required:
- Id
- Name
properties:
Id:
type: string
example: 00000000-0000-0000-0000-000000000000
Name:
type: string
example: Vehicle 1
IntelliTracer.ApiV2.VehicleMaintenanceTaskMileageConfig:
type: object
properties:
FixedDeadline:
example: 100000
description: (default = null)
nullable: true
type: number
IntervalDeadline:
example: 50000
description: "(default = null) "
nullable: true
type: number
Warning:
example: 1000
description: (default = null)
nullable: true
type: number
IntelliTracer.ApiV2.VehicleMaintenanceTaskRunningHoursConfig:
type: object
properties:
FixedDeadline:
example: 1000
description: (default = null)
nullable: true
type: number
IntervalDeadline:
example: 500
description: (default = null)
nullable: true
type: number
Warning:
example: 10
description: (default = null)
nullable: true
type: number
IntelliTracer.ApiV2.VehicleMaintenanceTaskDateConfig:
type: object
properties:
FixedDeadline:
example: 2021-06-30T00:00:00
description: (default = null)
nullable: true
type: string
IntervalDeadline:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV2.Interval"
- nullable: true
Warning:
example: 30
description: (default = null)
nullable: true
type: number
IntelliTracer.ApiV2.Interval:
type: object
properties:
Years:
type: number
example: 1
description: (default = 0)
Months:
type: number
example: 6
description: (default = 0)
Days:
type: number
example: 30
description: (default = 0)
IntelliTracer.ApiV2.Vehicle:
type: object
required:
- Id
- Name
properties:
Id:
type: string
example: 00000000-0000-0000-0000-000000000000
Code:
example: "012345"
description: (default = null)
nullable: true
type: string
Name:
type: string
example: Vehicle 1
IntelliTracer.ApiV1.VehicleCounterModel:
type: object
required:
- Vehicle
properties:
Vehicle:
$ref: "#/components/schemas/IntelliTracer.ApiV1.VehicleCounterVehicle"
VehicleCounterData:
type: array
items: {}
IntelliTracer.ApiV1.VehicleCounterVehicle:
type: object
required:
- Id
- Name
properties:
Id:
type: string
example: 00000000-0000-0000-0000-000000000000
Name:
type: string
example: Vehicle 1
Code:
example: "012345"
description: (default = null)
nullable: true
type: string
LastReportDateTime:
example: 2019-03-19T11:45:47+01:00
description: (default = null)
nullable: true
type: string
IntelliTracer.ApiV1.VehicleCounterData:
type: object
required:
- Id
- CounterName
- CounterValue
- IsDefault
properties:
Id:
type: string
example: 00000000-0000-0000-0000-000000000000
CounterName:
type: string
example: Counter 1
CounterValue:
type: number
example: 48145
IsDefault:
type: boolean
IntelliTracer.ApiV1.SpeedingQuery:
type: object
required:
- From
- To
properties:
From:
type: string
example: 2019-01-01T00:00:00+01:00
To:
type: string
example: 2019-01-31T23:59:59+01:00
UserIds:
items:
anyOf:
- type: string
example: 00000000-0000-0000-0000-000000000000
- type: string
example: 00000000-0000-0000-0000-000000000000
description: (default = [])
nullable: true
type: array
VehicleIds:
items:
anyOf:
- type: string
example: 00000000-0000-0000-0000-000000000000
- type: string
example: 00000000-0000-0000-0000-000000000000
description: (default = [])
nullable: true
type: array
IntelliTracer.ApiV1.Speeding:
type: object
required:
- DateTime
- VehicleId
- DriverId
- Speed
properties:
DateTime:
type: string
example: 2019-03-12T11:00:51+01:00
VehicleId:
type: string
example: 00000000-0000-0000-0000-000000000000
VehicleName:
example: Vehicle 1
description: (default = null)
nullable: true
type: string
VehicleLicensePlate:
example: 1-ABC-123
description: (default = null)
nullable: true
type: string
DriverId:
type: string
example: 00000000-0000-0000-0000-000000000000
DriverName:
example: John Doe
description: (default = null)
nullable: true
type: string
Speed:
type: number
example: 121
MaxSpeed:
type: number
example: 100
description: (default = 0)
Fine:
type: number
example: 65
description: (default = 0)
Revocation:
type: boolean
description: >-
(default = false)
Indicates whether the infraction is severe enough that the driving license would be revoked if caught by the police.
TooltipEn:
description: (default = null)
nullable: true
type: string
TooltipFr:
description: (default = null)
nullable: true
type: string
TooltipNl:
description: (default = null)
nullable: true
type: string
IntelliTracer.ApiV1.DriverIdentificationCreate:
type: object
required:
- UserCode
- VehicleCode
- StartDateTime
properties:
UserCode:
type: string
example: "012345"
VehicleCode:
type: string
example: "012345"
StartDateTime:
type: string
example: 2019-03-12T11:00:51+01:00
IntelliTracer.ApiV1.FuelTransactionsImport:
type: object
properties:
FuelTransactions:
type: array
items: {}
description: (default = [])
IntelliTracer.ApiV1.FuelTransactionImport:
type: object
required:
- TrackingDeviceId
- Timestamp
- Liters
- Price
- Source
properties:
TrackingDeviceId:
type: string
example: "1000000000"
description: The unique vehicle unit id.
TransactionNumber:
example: "1"
description: |-
(default = null)
The external transaction number.
nullable: true
type: string
Timestamp:
type: string
example: 2019-01-23T04:56:07
Liters:
type: number
example: 65.5
Price:
type: number
example: 70.4
Source:
type: string
example: "1000"
description: Location where the fuel transaction took place.
Mileage:
example: 1245.4
description: (default = null)
nullable: true
type: number
IntelliTracer.ApiV1.FuelTransactionValidationResult:
type: object
required:
- Entity
- ValidationResult
properties:
Entity:
$ref: "#/components/schemas/IntelliTracer.ApiV1.FuelTransactionImport"
ValidationResult:
type: array
items: {}
IntelliTracer.ApiV2.TransportTicketUserType:
type: number
x-enumDescriptions:
"0": Transporter
"1": Engineer
"2": Other
enum:
- null
- 0
- 1
- 2
IntelliTracer.ApiV2.TransportTicketRegistrationType:
type: number
x-enumDescriptions:
"0": Start Day
"1": Load
"2": Unload
"3": End Day
"4": Defect
"5": Start Work
"6": Stop Work
"7": Waiting Time
"8": Stand Still
enum:
- null
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
IntelliTracer.ApiV2.TransportTicketRegistrationQuantityType:
type: number
x-enumDescriptions:
"0": Cubic
"1": Pcs
"2": Kgs
enum:
- null
- 0
- 1
- 2
IntelliTracer.ApiV1.FuelTransactionQuery:
type: object
properties:
Users:
items:
anyOf:
- type: string
example: 00000000-0000-0000-0000-000000000000
- type: string
example: 00000000-0000-0000-0000-000000000000
description: (default = [])
nullable: true
type: array
Resources:
items:
anyOf:
- type: string
example: 00000000-0000-0000-0000-000000000000
- type: string
example: 00000000-0000-0000-0000-000000000000
description: (default = [])
nullable: true
type: array
Tanks:
items:
anyOf:
- type: string
example: 00000000-0000-0000-0000-000000000000
- type: string
example: 00000000-0000-0000-0000-000000000000
description: (default = [])
nullable: true
type: array
Pumps:
items:
anyOf:
- type: string
example: 00000000-0000-0000-0000-000000000000
- type: string
example: 00000000-0000-0000-0000-000000000000
description: (default = [])
nullable: true
type: array
UnlinkedTransactions:
type: boolean
description: (default = false)
IntelliTracer.ApiV1.FuelTransaction:
type: object
required:
- DateTime
- Liters
- KmVehicle
- KmUser
- KmDriven
- AvgConsumption
- Type
- Info
- VehicleIdentification
properties:
DateTime:
type: string
example: 2019-01-25T08:29:37
description: Date and time the fuel transaction occurred.
FuelTank:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV1.FuelTank"
- nullable: true
FuelPump:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV1.FuelPump"
- nullable: true
User:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV1.FuelTransactionUser"
- nullable: true
Vehicle:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV1.FuelTransactionVehicle"
- nullable: true
TransactionNumber:
type: string
example: "00000000"
description: External transaction number linked to this fuel transaction.
Price:
type: number
example: 10
description: Total cost of the fuel transaction.
Liters:
type: number
example: 10
description: Total amount of liters refueled.
KmVehicle:
type: number
example: 10
description: Current total mileage of the vehicle. Automatically calculated
using track and trace data.
KmUser:
type: number
example: 10
description: Mileage as entered by the user while refueling.
KmDriven:
type: number
description: Mileage manually entered by the user while refueling the vehicle.
AvgConsumption:
type: number
description: >-
Average fuel consumption since the last time the vehicle was
refuelled.
We assume the fuel tank was completely filled up in order to calculate this. Partial fill-ups will not return relevant data.
Type:
type: string
example: Bijtanken
description: Type of fuel transaction. This will vary depending on whether a
vehicle was refuelled or whether the fuel tank itself has been
refilled.
Info:
type: string
description: Additional info of fuel transaction.
VehicleIdentification:
type: string
example: "500145"
description: Identification of vehicle.
IntelliTracer.ApiV1.FuelTank:
type: object
required:
- Id
- Name
properties:
Id:
type: string
example: 00000000-0000-0000-0000-000000000000
Name:
type: string
example: Tank
Capacity:
type: number
example: 1500
Limit:
type: number
example: 1500
CurrentLevel:
type: number
example: 1500
FuelType:
type: number
example: 1
FuelTypeName:
type: string
example: Diesel
IntelliTracer.ApiV1.FuelPump:
type: object
required:
- Id
- Name
properties:
Id:
type: string
example: 00000000-0000-0000-0000-000000000000
Name:
type: string
example: Pump
Code:
type: string
example: "1500"
FuelType:
type: number
example: 1
FuelTypeName:
type: string
example: Diesel
Type:
type: number
example: 1
TypeName:
type: string
example: VehicleCode_Info
IntelliTracer.ApiV1.FuelTransactionVehicle:
type: object
required:
- Id
- Name
properties:
Id:
type: string
example: 00000000-0000-0000-0000-000000000000
Name:
type: string
example: Vehicle 1
Code:
example: "012345"
description: (default = null)
nullable: true
type: string
LicensePlate:
example: 1-ABC-123
description: (default = null)
nullable: true
type: string
IntelliTracer.ApiV1.FuelTransactionUser:
type: object
required:
- Id
- Name
properties:
Id:
type: string
example: 00000000-0000-0000-0000-000000000000
Name:
type: string
example: John Doe
Code:
example: "012345"
description: (default = null)
nullable: true
type: string
IntelliTracer.ApiV1.VehicleUsagePerUser:
type: object
required:
- User
properties:
User:
$ref: "#/components/schemas/IntelliTracer.ApiV1.User"
Days:
items:
$ref: "#/components/schemas/IntelliTracer.ApiV1.VehicleUsagePerDay"
description: (default = [])
nullable: true
type: array
IntelliTracer.ApiV1.VehicleUsagePerDay:
type: object
required:
- Date
properties:
Date:
type: string
example: 2019-01-17T00:00:00
VehicleUsages:
items:
$ref: "#/components/schemas/IntelliTracer.ApiV1.VehicleUsage"
description: (default = [])
nullable: true
type: array
IntelliTracer.ApiV1.VehicleUsage:
type: object
required:
- Vehicle
properties:
Vehicle:
$ref: "#/components/schemas/IntelliTracer.ApiV1.Vehicle"
MileageTotal:
type: number
example: 236.5
description: (default = 0.0)
TotalPowerLost:
type: number
description: |-
(default = 0)
Amount of power lost events for this vehicle.
Mileage:
type: number
example: 5650.406
description: (default = 0)
Clockings:
items:
$ref: "#/components/schemas/IntelliTracer.ApiV1.VehicleUsageClocking"
description: |-
(default = [])
Clockings in this vehicle.
nullable: true
type: array
Stops:
items:
$ref: "#/components/schemas/IntelliTracer.ApiV1.VehicleUsageStop"
description: |-
(default = [])
Amount of standstills for this vehicle.
nullable: true
type: array
Drivings:
items:
$ref: "#/components/schemas/IntelliTracer.ApiV1.VehicleUsageDriving"
description: |-
(default = [])
Drivings for this vehicle.
nullable: true
type: array
IntelliTracer.ApiV1.VehicleUsageClocking:
type: object
required:
- User
- DateTime
properties:
User:
$ref: "#/components/schemas/IntelliTracer.ApiV1.User"
DateTime:
type: string
example: 2019-01-17T06:02:03+01:00
IntelliTracer.ApiV1.VehicleUsageStop:
type: object
properties:
Location:
example: Dumolinlaan 9, 8500 Kortrijk [Kortrijk], BE
description: (default = null)
nullable: true
type: string
Pois:
items:
$ref: "#/components/schemas/IntelliTracer.ApiV1.VehicleUsagePoi"
description: (default = [])
nullable: true
type: array
From:
example: 2019-01-17T06:57:53+01:00
description: (default = null)
nullable: true
type: string
To:
example: 2019-01-17T08:41:43+01:00
description: (default = null)
nullable: true
type: string
IntelliTracer.ApiV1.VehicleUsagePoi:
type: object
required:
- Id
- Name
properties:
Id:
type: string
example: 00000000-0000-0000-0000-000000000000
Name:
type: string
example: Work
IntelliTracer.ApiV1.VehicleUsageDriving:
type: object
required:
- From
- To
properties:
From:
type: string
example: 2019-01-17T06:57:53+01:00
description: (default = null)
To:
type: string
example: 2019-01-17T08:41:43+01:00
description: (default = null)
IntelliTracer.ApiV1.VehicleUpdateWithDriverIdentification:
type: object
required:
- TrackingDeviceId
- VehicleName
- FuelType
- UserName
- UserCode
- DriverStart
properties:
TrackingDeviceId:
type: string
example: "1000000000"
description: The unique vehicle unit id.
VehicleName:
type: string
example: Vehicle 1
Licenseplate:
example: 1-ABC-123
description: (default = null)
nullable: true
type: string
Vin:
example: ABCDE01234F567890
description: (default = null)
nullable: true
type: string
FuelType:
type: string
x-enumDescriptions:
"ppo": Ppo
"p": Gasoline
"lpg": LPG
"e": Electricity
"d": Diesel
"cng": Cng
enum:
- ppo
- p
- lpg
- e
- d
- cng
FuelConsumption:
type: number
example: 5.5
description: (default = 0.0)
UserName:
type: string
example: John Doe
UserCode:
type: string
example: 012345/9876
description: The user and user group code seperated by `/`.
DriverStart:
type: string
example: 2019-01-24T17:00:00
IntelliTracer.ApiV1.VehicleWithDriverIdentificationValidationResult:
type: object
required:
- Entity
- ValidationResult
properties:
Entity:
$ref: "#/components/schemas/IntelliTracer.ApiV1.VehicleUpdateWithDriverIdentifi\
cation"
ValidationResult:
type: array
items: {}
IntelliTracer.ApiV2.TransportTicketResponse:
type: object
required:
- ValidationResult
properties:
Data:
items:
$ref: "#/components/schemas/IntelliTracer.ApiV2.TransportTicket"
description: (default = null)
nullable: true
type: array
ValidationResult:
type: array
items: {}
IntelliTracer.ApiV2.TransportTicket:
type: object
properties:
Id:
type: string
example: 00000000-0000-0000-0000-000000000000
TransportTicketUser:
$ref: "#/components/schemas/IntelliTracer.ApiV2.TransportTicketUser"
TransportTicketCompany:
$ref: "#/components/schemas/IntelliTracer.ApiV2.TransportTicketCompany"
Date:
type: string
example: 2021-07-12T08:29:37
Pause:
$ref: "#/components/schemas/IntelliTracer.ApiV2.TransportTicketSummaryLine"
Return:
$ref: "#/components/schemas/IntelliTracer.ApiV2.TransportTicketSummaryLine"
Total:
type: string
example: 01:00:00
TransporterInfo:
$ref: "#/components/schemas/IntelliTracer.ApiV2.TransportTicketTransporterInfo"
CreationTime:
type: string
example: 2021-07-12T08:29:37
Registrations:
type: array
items: {}
description: (default = [])
TransportTicketUserType:
$ref: "#/components/schemas/IntelliTracer.ApiV2.TransportTicketUserType"
IntelliTracer.ApiV2.TransportTicketUser:
type: object
properties:
Id:
type: string
example: 00000000-0000-0000-0000-000000000000
Name:
type: string
example: John Doe
UserTypes:
type: array
items: {}
description: (default = [])
VehicleType:
$ref: "#/components/schemas/IntelliTracer.ApiV2.TransportTicketUserVehicleType"
InternalCode:
type: string
example: "0123456789"
Email:
type: string
example: johndoe@company.com
PhoneNumber:
type: string
example: "+32123456789"
IntelliTracer.ApiV2.TransportTicketCompany:
type: object
properties:
Id:
type: string
example: 00000000-0000-0000-0000-000000000000
Name:
type: string
example: John Doe
Vat:
type: string
example: "0123456789"
Email:
type: string
example: johndoe@company.com
IntelliTracer.ApiV2.TransportTicketSummaryLine:
type: object
properties:
Enabled:
type: boolean
example: true
Value:
type: string
example: 01:00:00
Remark:
type: string
example: remark
IntelliTracer.ApiV2.TransportTicketTransporterInfo:
type: object
required:
- Mileage
properties:
AlreadyLoaded:
type: boolean
example: true
Mileage:
type: number
example: 107
IntelliTracer.ApiV2.TransportTicketRegistration:
type: object
properties:
Id:
type: string
example: 00000000-0000-0000-0000-000000000000
Type:
$ref: "#/components/schemas/IntelliTracer.ApiV2.TransportTicketRegistrationType"
Remark:
type: string
example: remark
Arrival:
type: string
example: 2021-07-12T08:29:37
Departure:
type: string
example: 2021-07-12T08:29:37
SubmitTimeStamp:
type: string
example: 2021-07-12T08:29:37
Poi:
$ref: "#/components/schemas/IntelliTracer.ApiV1.PoiLiteWithCode"
WorkplaceNumber:
type: string
example: "12345"
StartReference:
$ref: "#/components/schemas/IntelliTracer.ApiV2.TransportTicketRegistration"
Attachment:
type: object
properties: {}
TransporterInfo:
$ref: "#/components/schemas/IntelliTracer.ApiV2.TransportTicketRegistrationMach\
inistInfo"
Address:
$ref: "#/components/schemas/IntelliTracer.ApiV2.Address"
IntelliTracer.ApiV2.TransportTicketUserVehicleType:
type: object
properties:
Id:
type: string
example: 00000000-0000-0000-0000-000000000000
Name:
type: string
example: Vehicle Type
IntelliTracer.ApiV2.TransportTicketRegistrationTransporterInfo:
type: object
properties:
Freight:
example: 107
nullable: true
type: number
TicketNumber:
type: string
example: "12345"
Quantity:
type: number
example: 15.45
TransportTicketRegistrationQuantityType:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV2.TransportTicketRegistrationQuan\
tityType"
- nullable: true
Description:
type: string
example: description
IntelliTracer.ApiV2.TransportTicketRegistrationMachinistInfo:
type: object
properties:
MachineNumber:
type: string
example: "12345"
Counter:
example: 107
nullable: true
type: number
IntelliTracer.ApiV2.FuelSensorType:
type: number
x-enumDescriptions:
"0": None
"1": TEK811
"2": SpoTTbox
enum:
- null
- 0
- 1
- 2
IntelliTracer.ApiV2.FuelType:
type: number
x-enumDescriptions:
"0": Unknown
"1": Gasoline
"2": Gasoline 95
"3": Gasoline 98
"4": Diesel
"5": White diesel
"6": Red diesel
"7": LPG
"8": LNG
enum:
- null
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
IntelliTracer.ApiV2.PagedFuelSensorResponse:
type: object
properties:
Data:
items:
$ref: "#/components/schemas/IntelliTracer.ApiV2.FuelSensor"
nullable: true
type: array
PagingFilter:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.Api.PagingFilter"
- nullable: true
IntelliTracer.ApiV2.FuelSensor:
type: object
properties:
Id:
type: string
example: 00000000-0000-0000-0000-000000000000
Name:
type: string
example: Name
FuelSensorType:
$ref: "#/components/schemas/IntelliTracer.ApiV2.FuelSensorType"
FuelType:
$ref: "#/components/schemas/IntelliTracer.ApiV2.FuelType"
LatestMeasurement:
type: string
example: 2021-07-12T08:29:37+02:00
CurrentLevel:
type: number
example: 25
CurrentVolume:
type: number
example: 686
MaximumVolume:
type: number
example: 2541
Longitude:
type: number
example: 50.45161
Latitude:
type: number
example: 3.45161
StationName:
type: string
example: StationName
Batterylevel:
type: number
example: 95
Low:
type: number
example: 210
LowLow:
type: number
High:
type: number
example: 2000
HighHigh:
type: number
IntelliTracer.ApiV1.MobileClockingOptionListCreate:
type: object
required:
- Name_Nl
properties:
Name_Nl:
description: (default = null)
nullable: true
type: string
Name_Fr:
description: (default = null)
nullable: true
type: string
Name_En:
description: (default = null)
nullable: true
type: string
Name_Pl:
description: (default = null)
nullable: true
type: string
_typeDescriptor:
type: string
IntelliTracer.ApiV1.MobileClockingNodeUpdate:
allOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV1.MobileClockingNode"
- type: object
required:
- Id
properties:
Id:
type: string
example: 00000000-0000-0000-0000-000000000000
description: |-
(default = null)
Only for folders.
IntelliTracer.ApiV2.VisitsPerPOIRequest:
type: object
required:
- ResourceIds
- PoiIds
- FromDate
- ToDate
- MinDuration
properties:
ResourceIds:
type: array
items: {}
description: (default = [])
PoiIds:
type: array
items: {}
description: (default = [])
FromDate:
example: 2019-01-25T00:00:00
description: (default = null)
nullable: true
type: string
ToDate:
example: 2019-01-25T00:00:00
description: (default = null)
nullable: true
type: string
FromTime:
example: 00:00:00
description: (default = null)
nullable: true
type: string
ToTime:
example: 23:59:59
description: (default = null)
nullable: true
type: string
MinDuration:
type: number
example: 5
ShowDriver:
type: boolean
example: true
description: (default = false)
IntelliTracer.ApiV2.VisitsPerPOIResponse:
type: object
properties:
Data:
items:
$ref: "#/components/schemas/IntelliTracer.ApiV2.POIVisit"
nullable: true
type: array
PagingFilter:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.Api.PagingFilter"
- nullable: true
IntelliTracer.ApiV2.POIVisit:
type: object
required:
- Poi
- Vehicle
- User
- FromDate
- ToDate
- Address
properties:
Poi:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV1.PoiLiteWithCode"
- nullable: true
Vehicle:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV2.Resource"
- nullable: true
User:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV2.Resource"
- nullable: true
FromDate:
example: 2019-01-25T00:00:00
description: (default = null)
nullable: true
type: string
ToDate:
example: 2019-01-25T00:00:00
description: (default = null)
nullable: true
type: string
Duration:
example: 06:43:13
description: (default = null)
nullable: true
type: string
Address:
type: string
example: Dumolinlaan 9, 8500 Kortrijk, BE
Deviation:
example: 0.08
nullable: true
type: number
ContactOn:
example: 00:00:17
description: (default = null)
nullable: true
type: string
ContactOff:
example: 06:42:56
description: (default = null)
nullable: true
type: string
AnalogInputs:
items:
$ref: "#/components/schemas/IntelliTracer.ApiV1.AnalogInputLite"
nullable: true
type: array
NonAnalogInputs:
items:
$ref: "#/components/schemas/IntelliTracer.ApiV1.NonAnalogInput"
nullable: true
type: array
IntelliTracer.ApiV1.AnalogInputLite:
type: object
required:
- IoName
- StartValue
- StopValue
properties:
IoName:
$ref: "#/components/schemas/IntelliTracer.ApiV1.AnalogInputIoName"
StartValue:
type: string
description: (default = null)
StopValue:
type: string
description: (default = null)
IntelliTracer.ApiV1.NonAnalogInput:
type: object
required:
- Id
- Name
properties:
Id:
type: string
example: 00000000-0000-0000-0000-000000000000
Name:
type: string
example: Front door
DurationOn:
example: 00:00:00
description: (default = null)
nullable: true
type: string
DurationOff:
example: 06:43:13
description: (default = null)
nullable: true
type: string
IntelliTracer.ApiV1.IoNameState:
type: object
required:
- IoName
- State
properties:
IoName:
$ref: "#/components/schemas/IntelliTracer.ApiV1.AnalogInputIoName"
State:
type: string
description: (default = null)
IntelliTracer.ApiV1.AnalogInputIoName:
type: object
required:
- Id
- Name
properties:
Id:
type: string
example: 00000000-0000-0000-0000-000000000000
Name:
type: string
example: Io Name
IntelliTracer.ApiV2.PositionsPerPOIRequest:
type: object
required:
- ResourceIds
- PoiIds
- FromDate
- ToDate
properties:
ResourceIds:
type: array
items: {}
description: (default = [])
PoiIds:
type: array
items: {}
description: (default = [])
FromDate:
example: 2019-01-25
description: (default = null)
nullable: true
type: string
ToDate:
example: 2019-01-26
description: (default = null)
nullable: true
type: string
IntelliTracer.ApiV2.PositionsPerPOIResponse:
type: object
properties:
Data:
items:
$ref: "#/components/schemas/IntelliTracer.ApiV2.PositionPerPOI"
nullable: true
type: array
PagingFilter:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.Api.PagingFilter"
- nullable: true
IntelliTracer.ApiV2.PositionPerPOI:
type: object
required:
- Poi
- Vehicle
- Date
- Address
properties:
Poi:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV1.PoiLiteWithCode"
- nullable: true
Vehicle:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV1.VehicleLite"
- nullable: true
Date:
example: 2019-01-25T00:00:00
description: (default = null)
nullable: true
type: string
Address:
type: string
example: Dumolinlaan 9, 8500 Kortrijk, BE
Mileage:
example: 0.08
nullable: true
type: number
Speed:
example: 0.08
nullable: true
type: number
IntelliTracer.ApiV2.ResourcesAtPOIRequest:
type: object
required:
- ResourceGroupIds
- PoiGroupIds
- Date
properties:
ResourceGroupIds:
type: array
items: {}
description: (default = [])
PoiGroupIds:
type: array
items: {}
description: (default = [])
Date:
example: 2019-01-25
description: (default = null)
nullable: true
type: string
IntelliTracer.ApiV2.ResourcesAtPOIResponse:
type: object
properties:
Data:
items:
$ref: "#/components/schemas/IntelliTracer.ApiV2.ResourceAtPOI"
nullable: true
type: array
PagingFilter:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.Api.PagingFilter"
- nullable: true
IntelliTracer.ApiV2.ResourceAtPOI:
type: object
required:
- Poi
- Resource
- Date
properties:
Poi:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV1.PoiLiteWithCode"
- nullable: true
Resource:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.ApiV2.Resource"
- nullable: true
Date:
example: 2019-01-25T00:00:00
description: (default = null)
nullable: true
type: string
Type:
oneOf:
- $ref: "#/components/schemas/IntelliTracer.Domain.TrackingReportType"
- nullable: true
Mileage:
example: 0.08
nullable: true
type: number
Speed:
example: 0.08
nullable: true
type: number
AnalogInputs:
items:
$ref: "#/components/schemas/IntelliTracer.ApiV1.IoNameState"
nullable: true
type: array
NonAnalogInputs:
items:
$ref: "#/components/schemas/IntelliTracer.ApiV1.IoNameState"
nullable: true
type: array
Outputs:
items:
$ref: "#/components/schemas/IntelliTracer.ApiV1.IoNameState"
nullable: true
type: array
Resource_groups: {}
Resource_group_-_Resources: {}
Time_Validation: {}
Poi_groups: {}
Poi_group_-_Pois: {}
Poi_types: {}
RFID_tags: {}
RFID_tags_-_User: {}
RFID_scanners: {}
Users_-_Permitted_Resource_Groups: {}
Users_-_Day_Programs: {}
Overtime_configurations: {}
Last_positions: {}
Positions_by_resource: {}
Statuses_by_resource: {}
Clockings_by_user: {}
Manual_clockings_by_user: {}
Edit_jobnumber_by_Clocking_ID: {}
Cost_centers: {}
Cost_center_-_Validators: {}
Day_programs: {}
Planning_anomalies: {}
Asset_-_Link_Unlink_responsible: {}
Asset_-_Mutations: {}
Asset_locations: {}
Asset_location_-_Assets: {}
Asset_location_-_Mutations: {}
Administrative_location: {}
Asset_inspection_types: {}
Asset_inspections: {}
Asset_identifications: {}
Absence_types: {}
Absence_Requests: {}
Vehicle_per_costcenter: {}
Access_schedules: {}
Access_schedule_exceptions: {}
Access_groups: {}
Access_group_-_Users: {}
Access_locations: {}
Access_location_-_User_access: {}
Access_location_-_Remove_schedules: {}
Access_location_-_Access_control_schedules: {}
Access_location_-_Access_control_schedule_groups: {}
Access_log: {}
BTW_numbers: {}
User_with_person: {}
Person_-_Limosas: {}
Person_-_Default_Limosa: {}
Person_-_Limosa_workplaces: {}
Person_-_Limosa: {}
Person_-_BTW: {}
Person_-_Activity: {}
Person_-_RRN_and_BTW: {}
Person_-_Badges: {}
Person_-_User: {}
Person_groups: {}
Person_group_-_Persons: {}
Validate_DUC: {}
Validate_workplaces: {}
Workplace_by_DUC: {}
Workplace_-_Pois: {}
Workplace_by_DUC_-_Pois: {}
Workplace_-_Overview: {}
Project_leads: {}
Project_lead_-_Workplaces: {}
Project_lead_-_BTWs: {}
Maintenance_overview: {}
Maintenance_tasks_by_vehicle: {}
Maintenance_types: {}
Vehicle_counters: {}
Eco_-_Speedings: {}
Eco_-_Driver_identifications: {}
Eco_-_Import_fuel_transactions: {}
Fleet_-_Fuel_transactions: {}
Fleet_-_Fuel_sensors: {}
Fleet_-_Vehicle_usage: {}
Fleet_-_Vehicle_with_driver_identification: {}
Fleet_-_Transport_tickets: {}
Mobile_clockings_-_Option_lists: {}
Mobile_clockings_-_Multi_job_lists: {}
Visits_per_POI: {}
Positions_per_POI: {}
Resources_at_POI: {}
Example_delivery: {}