Mapiq API

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.


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

ParameterRequiredDescription
startDateYesThe start of the date range.
endDateNoThe end of the date range. If not provided it will equal startDate.
userIdNoThe identifier used by Mapiq, if provided we will retrieve the registrations for that specific user.
buildingIdNoThe identifier used by Mapiq, if provided we will retrieve the registrations for that specific 

Returned data

The API returns a list of bookings matching the query parameters, with the items in the list having the following properties.

IdIdentifier for the registration.
userIdInternal Mapiq identifier.
userExternalIdExternal identifier, as used by the customer. For more information see below
firstNameFirst name of the user.
lastNameLast name of the user
emailEmail address of the user.
dateOn which date the registration is valid.
nodeIdIdentifier of the location of the registration, can be areaId, floorId or buildingId.
deskIdIdenfier of the booked desk. Can be null depending on what level the registration is made.
areaIdIdentifier for the area the registration is in. Can be null depending on what level the registration is made.
floorIdIdentifier for which floor the registration is in. Can be null depending on what level the registration is made.
floorHasMapWhether the floor has a map
floorNumberThe floornumber
buildingIdIdentifier for which building the registration is in.
buildingNameThe name of the building the registration is in.
floorNameThe name of the floor.
areaNameThe name of the area.
deskNameThe name of the desk
createdByThe original creator of the booking
lastModifiedByThe last editor of the booking

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 Office Shifts application and its only purpose is to be shared within the output of the API. The following claim namespace and claim name is supported:

ProtocolExpected claim namespace and name
SAML2.0http://schemas.xmlsoap.org/ws/2005/05/identity/claims/externalid
OpenId Connectexternal_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 


D
Daan is the author of this solution article.

Did you find it helpful? Yes No

Send feedback
Sorry we couldn't be helpful. Help us improve this article with your feedback.