Skip to content

AccessApi

HTTP request Description
GET /access/organization/{organizationId}/anonymous/{exitTokens} Returns all the anonymous accesses in an organization registered of the user owning the exitTokens (exitTokens are separated by commas).
GET /access/place/{placeId}/anonymous/{exitTokens} Returns all the anonymous accesses in a place registered of the user owning the exitTokens (exitTokens are separated by commas).
GET /access/organization/{organizationId}/authenticated/{orgAuthServerIds} Returns all the authenticated accesses in an organization registered of one or more users (orgAuthServerIds are separated by commas).
GET /access/place/{placeId}/authenticated/{orgAuthServerIds} Returns all the authenticated accesses in a place registered of one or more users (orgAuthServerIds are separated by commas).

GET /access/organization/{organizationId}/anonymous/{exitTokens}

Returns all the anonymous accesses in an organization registered of the user owning the exitTokens (exitTokens are separated by commas) that are fully registered. Fully registered means that there are both the entrance and the exit timestamp. Only app users can access this end-point.

Parameters

Name Type Description
exitTokens String array One or more exitTokens.
organizationId Long ID of an organization.

Responses

200
List of anonymous accesses in an organization gets returned successfully. List

204
List of anonymous accesses in an organization were not found. Nothing gets returned.

401
The user is not authenticated. Nothing gets returned.

403
Administrators cannot have accesses. Nothing gets returned.

Authorization

bearerAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

GET /access/place/{placeId}/anonymous/{exitTokens}

Returns all the anonymous accesses in a place registered of the user owning the exitTokens (exitTokens are separated by commas) that are fully registered. Fully registered means that there are both the entrance and the exit timestamp. Only app users can access this end-point.

Parameters

Name Type Description
exitTokens String array One or more exitTokens.
placeId Long ID of a place.

Responses

200
List of anonymous accesses in a place gets returned successfully. List

204
List of anonymous accesses in a place were not found. Nothing gets returned.

401 The user is not authenticated. Nothing gets returned.

403
Administrators cannot have accesses. Nothing gets returned.

Authorization

bearerAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

GET /access/organization/{organizationId}/authenticated/{orgAuthServerIds}

Returns all the authenticated accesses in an organization registered of one or more users (orgAuthServerIds are separated by commas) that are fully registered. Fully registered means that there are both the entrance and the exit timestamp. Both app users and web-app administrators can access this end-point.

Parameters

Name Type Description
orgAuthServerIds String array One or more orgAuthServerIds. If it is called by the app user, the orgAuthServerIds parameter can only consist in one identifier. Otherwise it can be more than one identifier.
organizationId Long ID of an organization

Responses

200
List of authenticated accesses in an organization gets returned successfully. List

204
List of authenticated accesses in an organization were not found. Nothing gets returned.

401
The administrator or the user is not authenticated. Nothing gets returned.

403
Users can only retrieve their accesses. Nothing gets returned.

Authorization

bearerAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

GET /access/place/{placeId}/authenticated/{orgAuthServerIds}

Returns all the authenticated accesses in a place registered of one or more users (orgAuthServerIds are separated by commas) that are fully registered. Fully registered means that there are both the entrance and the exit timestamp. Both app users and web-app administrators can access this end-point.

Parameters

Name Type Description
orgAuthServerIds String array One or more orgAuthServerIds. If it is called by the app user, the orgAuthServerIds parameter can only consist in one identifier. Otherwise it can be more than one identifier.
placeId Long ID of a place.

Responses

200
List of authenticated accesses in a place gets returned successfully. List

204
List of authenticated accesses in a place were not found. Nothing gets returned.

401
The administrator or the user is not authenticated. Nothing gets returned.

403
Users can only retrieve their accesses. Nothing gets returned.

Authorization

bearerAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json