V1 deprecated
Mapiq V1 is deprecated, please refer to https://developer.mapiq.com for V2 and more information on the possibilities.
For more (technical) information and to start using the API, please see the Mapiq API developer page
Via Mapiq's API is possible to retrieve bookings within a machine readable format (JSON) allowing other services to use the data generated within Mapiq's application. An example is an access control system basing user access on bookings made in Mapiq.
GET shifts
https://api.mapiq.com/shifts/registrations
Query parameters
An API call requires at least a startDate parameter and the data in return will contain all bookings from that day. With additional parameters the returned data can be specified further
| Parameter | Required | Description |
|---|---|---|
| startDate | Yes | The start of the date range. |
| endDate | No | The end of the date range. If not provided it will equal startDate. |
| userId | No | Identifier of the user (GUID) as received from the GET users API |
| buildingId | No | Identifier of the building (GUID) as received from the GET buildings API |
Returned data
The API returns an array of booking objects matching the query parameters, with the objects in the list having the following properties.
| Id | Identifier for the registration (GUID) |
| userId | Internal Mapiq identifier (GUID) |
| userExternalId | External identifier, as used by the customer. For more information see below |
| firstName | First name of the user. |
| lastName | Last name of the user |
| Email address of the user. | |
| date | On which date the registration is valid. |
| nodeId | Identifier of the location (GUID) of the registration, can be areaId, floorId or buildingId. |
| deskId | Idenfier of the booked desk (GUID) . Can be null depending on what level the registration is made. |
| areaId | Identifier for the area (GUID) the registration is in. Can be null depending on what level the registration is made. |
| floorId | Identifier for which floor (GUID) the registration is in. Can be null depending on what level the registration is made. |
| floorHasMap | Whether the floor has a map |
| floorNumber | The floornumber |
| buildingId | Identifier for which building (GUID) the registration is in. |
| buildingName | The name of the building the registration is in. |
| floorName | The name of the floor. |
| areaName | The name of the area. |
| deskName | The name of the desk |
| createdBy | Object with the original creator of the booking |
| lastModifiedBy | Object with the last editor of the booking |
| checkedIn | Whether the user has checked in for this shift |
GET buildings
https://api.mapiq.com/shifts/buildings
Query parameters
None
Returned data
The API returns an array of building objects, with the objects in the list having the following properties.
| id | Identifier of the building (GUID) | ||||||||||||||||||||
| name | Name of the building | ||||||||||||||||||||
| ianaTimezone | Timezone of the building | ||||||||||||||||||||
| capacity | Total capacity | ||||||||||||||||||||
| version | Version number | ||||||||||||||||||||
| floors | A list of floor objects
| ||||||||||||||||||||
| openingDays | A list of the days that the building is open |
GET users
https://api.mapiq.com/shifts/users
Query parameters
| Parameter | Required | Description |
|---|---|---|
| UseCount | No | |
| Filters | No | |
| Sorts | No | |
| Page | No | |
| PageSize | No |
Returned data
The API returns an object in which an array of user objects can be found. These objects have the following properties.
| totalCount | Number of user objects returned | ||||||||||||||||||||||||||
| data | Array with user objects
|
POST checkin
https://api.mapiq.com/localization/admin/checkin
Query parameters
| Parameter | Required | Description |
|---|---|---|
| buildingId | Yes | Identifier of the building (GUID) as received from the GET building API |
| userId | Yes | Identifier of the user (GUID) as received from the GET users API |
| eventType | Yes | One of the following values (STRING):
|
| source | Yes | One of the following values (STRING):
|
Returned data
Status code 200 OK
Authentication
The Mapiq API supports OAuth 2.0 Resource Owner Password Credential (ROPC) flow in order to retrieve a token that can be used to authenticate yourself against the public API. Mapiq will create a service account and provide the necessary information that you need to connect successfully.
External Id
When connecting another service to the API it may be that this service requires a different user identifier than the user's email address. It is possible to share an additional claim containing an additional employee id via Single Sign On. This external Id is not used within the Mapiq application and its only purpose is to be shared within the output of the API. The following claim namespace and claim name is supported:
| Protocol | Expected claim namespace and name |
|---|---|
| SAML2.0 | http://schemas.xmlsoap.org/ws/2005/05/identity/claims/externalid |
| OpenId Connect | external_id * |
* this claim needs to be included in one of the following scopes: openid, email, or profile
Please read more about sharing claims in the articles on Configuring Single Sign On