API Reference

Instant Suite API

API Version: v1

Versions
API version 1

Content type
The API is exclusively meant to work with JSON application/json Content-Type, with
UTF-8 charset.This applies to both requests and responses.Any non-compliant request will fail
with a 400 Bad Request status code.

Permissions
By default, here are the rights applied to all end-points:

read (get): cloud-user

create (post): cloud-admin + cloud-poweruser
update (put): cloud-admin + cloud-poweruser + owner of the object + delegation
delete (delete): cloud-admin + owner of the object

These rights can be changed in each end-points. In this case, the documentation will indicate it.

Throttling
Throttling is enabled by default, with limits by scopes.Default throttles:

addresses: 120/min
agenda-access: 120/min
badges: 120/min
bookings: 120/min
clouds: 120/min
cloud-events: 120/min
cloud-properties: 120/min
events: 120/min

1 of 352
 files: 120/min
folds: 120/min
issues: 60/min
idm: 120/min
itv-statistics: 20/min
languages: 120/min
presence-declarations: 120/min
presence-rules: 120/min
resource-types: 120/min
resources: 120/min
sensors: 120/min
users: 120/min
services: 120/min
teams: 120/min
translations: 120/min
typical-weeks: 120/min
user-agendas: 120/min

Status codes and error messages

Status code Description
200 OK The request was successfully handled and there's data available
204 No Content The request was successfully handled and there's no relevant data to
show
400 Bad Request The request contains invalid parameters
401 Unauthorized The request is unauthorized, meaning you did not provide any
authentication credentials, or it was invalid
403 Forbidden The request is forbidden, meaning the authentication was successful, but
you don't have the rights to do this action
404 Not Found The requested resource was not found
500 Internal Server There was a problem on our side
Error

Note that any error status codes (>= 400) will have an error reason in its body:

Example:

{ "error": "Authentication not provided" }

CONTACT

EMAIL: [email protected]
Terms of service: https://www.sharingcloud.com/policies/terms/

2 of 352
INDEX
1. ADDRESSES 10
1.1 GET /addresses/ 10
1.2 GET /addresses/current-locations/ 11
1.3 GET /addresses/next-locations/ 11
1.4 GET /addresses/{id}/ 12

2. AGENDA-ACCESS 14
2.1 GET /agenda-access/ 14
2.2 POST /agenda-access/ 15
2.3 POST /agenda-access/bulk/ 16
2.4 PUT /agenda-access/update-pending/ 17
2.5 PUT /agenda-access/{id}/ 18
2.6 DELETE /agenda-access/{id}/ 19

3. BADGES 20
3.1 GET /badges/standard/ 20
3.2 POST /badges/standard/ 22
3.3 GET /badges/standard/{badge}/ 22
3.4 PUT /badges/standard/{badge}/ 24
3.5 DELETE /badges/standard/{badge}/ 25
3.6 PATCH /badges/standard/{badge}/ 25
3.7 PUT /badges/standard/{badge}/toggle_active/ 25
3.8 POST /badges/temporary/ 29
3.9 GET /badges/temporary/{ref}/ 32
3.10 PUT /badges/temporary/{ref}/ 35

4. BOOKINGS 40
4.1 GET /bookings/ 40
4.2 POST /bookings/ 47
4.3 GET /bookings/all/ 54
4.4 GET /bookings/default-time-slots/ 62
4.5 GET /bookings/progress-status/ 62
4.6 GET /bookings/recurrences/ 63
4.7 GET /bookings/recurrences/{conf_rec_id}/ 70
4.8 GET /bookings/{conf_id}/ 77
4.9 PUT /bookings/{conf_id}/ 83
4.10 DELETE /bookings/{conf_id}/ 90
4.11 PUT /bookings/{conf_id}/confirm/{resource_id}/ 90
4.12 PUT /bookings/{conf_id}/extend/{duration}/ 91
4.13 PUT /bookings/{conf_id}/release/{resource_id}/ 98

5. EVENTS 105
5.1 GET /events/ 105

3 of 352
5.2 GET /events/types/ 105

6. FOLDS 107
6.1 POST /folds/ 107
6.2 GET /folds/{ref}/ 111
6.3 PUT /folds/{ref}/ 116

7. GROUPS 122
7.1 GET /groups/ 122
7.2 POST /groups/ 122
7.3 GET /groups/{id}/ 123
7.4 PUT /groups/{id}/add-user/{user_id}/ 124

8. GUEST-LISTS 125
8.1 GET /guest-lists/ 125
8.2 POST /guest-lists/ 129
8.3 GET /guest-lists/{id}/ 133
8.4 PUT /guest-lists/{id}/ 137
8.5 DELETE /guest-lists/{id}/ 141
8.6 PUT /guest-lists/{id}/checkin/{guest_member_id}/{status}/ 141

9. GUEST-MEMBERS 143
9.1 GET /guest-members/ 143
9.2 POST /guest-members/export/ 147
9.3 GET /guest-members/search/ 148
9.4 GET /guest-members/{id}/ 149
9.5 PUT /guest-members/{id}/ 150
9.6 DELETE /guest-members/{id}/ 151
9.7 GET /guest-members/{id}/print-badge/ 151
9.8 POST /guest-members/{id}/set-print/ 152
9.9 POST /guest-members/{id}/set-visibility/ 152

10. GUEST-POINTS 154

10.1 GET /guest-points/ 154
10.2 GET /guest-points/ids/ 155
10.3 GET /guest-points/{id}/ 156
10.4 GET /guest-points/{id}/import-guests/ 157
10.5 POST /guest-points/{id}/import-guests/ 157

11. I18N 159

11.1 GET /i18n/languages/ 159
11.2 GET /i18n/timezones/ 159
11.3 GET /i18n/timezones/compare/ 159
11.4 POST /i18n/translations/ 160

12. IDM 162

4 of 352
12.1 GET /idm/devices/ 162
12.2 GET /idm/devices/authentication-code/ 164
12.3 POST /idm/devices/device-bookmark/ 164
12.4 POST /idm/devices/info-export/ 165
12.5 GET /idm/devices/{uuid}/ 165
12.6 PUT /idm/devices/{uuid}/associate-resource/ 167
12.7 PUT /idm/devices/{uuid}/heartbeat/ 168
12.8 PUT /idm/devices/{uuid}/information/ 169
12.9 GET /idm/devices/{uuid}/resource/ 171
12.10 POST /idm/devices/{uuid}/supervision-toggle/ 174
12.11 GET /idm/devices/{uuid}/url-to-display/ 175
12.12 GET /idm/instant-tasks/{id}/file/ 175
12.13 POST /idm/instant-tasks/{id}/file/ 176
12.14 GET /idm/registration/ 176
12.15 GET /idm/tasks/ 177
12.16 POST /idm/tasks/log/ 178
12.17 PUT /idm/tasks/reports/ 179

13. ISSUES 180

13.1 GET /issues/ 180
13.2 GET /issues/menus/ 185
13.3 POST /issues/report/{resource_id}/ 189
13.4 GET /issues/{id}/ 194

14. MEDIA 199

14.1 GET /media/statistics/channels/ 199
14.2 GET /media/statistics/videos/ 200

15. NOTIFICATIONS 202

15.1 GET /notifications/ 202
15.2 POST /notifications/ 202
15.3 POST /notifications/estimate-audience-rate/ 203
15.4 GET /notifications/search-audience/ 203
15.5 GET /notifications/{id}/ 204
15.6 PUT /notifications/{id}/ 205
15.7 DELETE /notifications/{id}/ 205
15.8 PATCH /notifications/{id}/ 205

16. ORGANIZATION 207

16.1 GET /organization/teams/ 207
16.2 POST /organization/teams/ 208
16.3 DELETE /organization/teams/delete-all-shared/{user_id}/ 209
16.4 DELETE /organization/teams/remove-from-all/{user_id}/ 209
16.5 PUT /organization/teams/{id}/ 210
16.6 DELETE /organization/teams/{id}/ 211

5 of 352
16.7 PUT /organization/users/{user}/ 211

17. PRESENCE-DECLARATIONS 213

17.1 GET /presence-declarations/ 213
17.2 POST /presence-declarations/ 214
17.3 POST /presence-declarations/export/ 216
17.4 GET /presence-declarations/notes/ 216
17.5 POST /presence-declarations/unlink-booking/ 217
17.6 GET /presence-declarations/{id}/ 218

18. PRESENCE-RULES 220

18.1 GET /presence-rules/ 220
18.2 POST /presence-rules/ 221
18.3 POST /presence-rules/export/ 222
18.4 POST /presence-rules/import/ 222

19. RESOURCE-STATES 224

19.1 PUT /resource-states/{id}/ 224
19.2 DELETE /resource-states/{id}/ 224

20. RESOURCE-TYPES 226

20.1 GET /resource-types/ 226

21. RESOURCES 228

21.1 POST /resources/ 228
21.2 GET /resources/bookings/ 231
21.3 GET /resources/favorites/ 234
21.4 GET /resources/favorites/ids/ 239
21.5 GET /resources/search/ 239
21.6 GET /resources/state-messages/ 244
21.7 GET /resources/{id}/ 245
21.8 PUT /resources/{id}/ 248
21.9 DELETE /resources/{id}/ 252
21.10 POST /resources/{id}/book-for-time/{duration}/ 252
21.11 GET /resources/{id}/device-info/ 259
21.12 GET /resources/{id}/digital-signage/ 260
21.13 GET /resources/{id}/maintenance-state/ 260
21.14 GET /resources/{id}/roompad/ 261
21.15 POST /resources/{id}/toggle-favorite/ 268

22. SENSORS 269

22.1 POST /sensors/data/ 269
22.2 POST /sensors/pairing/ 269
22.3 DELETE /sensors/pairing/ 270

23. SIGNAGE 272

6 of 352
23.1 GET /signage/{id}/file/ 272

24. STATS 273

24.1 GET /stats/occupation-rate/ 273
24.2 GET /stats/realtime/resources/ 274

25. TYPICAL-WEEKS 275

25.1 POST /typical-weeks/ 275
25.2 GET /typical-weeks/{id}/ 279
25.3 PUT /typical-weeks/{id}/ 284
25.4 POST /typical-weeks/{id}/apply/ 289
25.5 PATCH /typical-weeks/{id}/day/ 290
25.6 POST /typical-weeks/{id}/reset-weekend/ 295

26. USER-AGENDAS 301

26.1 GET /user-agendas/ 301
26.2 GET /user-agendas/current/ 303
26.3 GET /user-agendas/current/default-week/ 304
26.4 PUT /user-agendas/current/default-week/ 309
26.5 PATCH /user-agendas/current/default-week/ 314
26.6 POST /user-agendas/disable/{user_id}/ 319
26.7 POST /user-agendas/enable/{user_id}/ 320
26.8 GET /user-agendas/enabled-for-me/ 320
26.9 GET /user-agendas/search/ 320
26.10 PUT /user-agendas/{id}/ 321

27. USERS 323

27.1 POST /users/ 323
27.2 GET /users/current/ 324
27.3 GET /users/import-model-file/ 325
27.4 PUT /users/profile-generic-properties/ 325
27.5 DELETE /users/profile-generic-properties/ 326
27.6 GET /users/profile/ 326
27.7 PUT /users/profile/ 329
27.8 GET /users/search-users/ 335
27.9 GET /users/search/ 336
27.10 GET /users/wide_search/ 336
27.11 PUT /users/{id}/profile-generic-properties/ 340
27.12 DELETE /users/{uuid}/delete/ 341
27.13 PUT /users/{uuid}/edit/ 342

28. WIFI-GUEST 347

28.1 GET /wifi-guest/access/ 347
28.2 POST /wifi-guest/access/ 348
28.3 GET /wifi-guest/access/{access_request_id}/ 349
28.4 DELETE /wifi-guest/access/{access_request_id}/ 350

7 of 352
28.5 GET /wifi-guest/provider-specs/ 350
28.6 POST /wifi-guest/provider/ 351
28.7 PUT /wifi-guest/provider/{provider_id}/ 351
28.8 DELETE /wifi-guest/provider/{provider_id}/ 351
28.9 GET /wifi-guest/search-provider/ 352

8 of 352
 Security and Authentication
SECURITY SCHEMES

KEY TYPE DESCRIPTION

Basic http, basic

9 of 352
API
1. ADDRESSES

1.1 GET /addresses/

List addresses.

REQUEST
QUERY PARAMETERS
NAME TYPE DESCRIPTION

page integer A page number within the paginated result set.

page_size integer Number of results to return per page.

RESPONSE

STATUS CODE - 200:

RESPONSE MODEL - application/json

{
pagination* {
total_results integer
results_per_page integer
total_pages integer
current_page integer
previous_page integer
next_page integer
}
results* [{
Array of object:

company* string 1 to 100 chars

country* string max:100 chars
city* string max:100 chars
site* string 1 to 100 chars
division string 1 to 100 chars
departement string max:50 chars
corporation string max:100 chars
building string max:50 chars
floor string max:50 chars
door string max:50 chars
number string max:30 chars
street_line1 string max:100 chars
street_line2 string max:100 chars
zipcode string max:5 chars
state string max:100 chars
cedex string max:100 chars
postal_box string max:20 chars
}]
}

STATUS CODE - 400: Invalid parameters.

10 of 352
 STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

1.2 GET /addresses/current-locations/

Fetch current locations for initial values.

Fetch current locations for initial values.

This is useful for the treeview, and it is used in Instant Mobile.

REQUEST
QUERY PARAMETERS
NAME TYPE DESCRIPTION

location string Location value <i>(e.g. SharingCloud/France)</i>

min:1 chars
location_filter string Location filter <i>(e.g. company,country)</i>
min:1 chars
<i>Available values</i> : company, division, site, departement,
corporation, building, floor, door, number, street_line1,
street_line2, zipcode, city, state, cedex, postal_box, country</i>
*data_type enum Data type
ALLOWED:
studio,
guestpoint
exclude_not_bookable boolean
exclude_no_resources boolean Exclude locations with no visible resources

RESPONSE

STATUS CODE - 200:

RESPONSE MODEL - application/json

{
depth* integer Location depth
filter_values* [enum] ALLOWED:company,
division, site, departement,
corporation, building, floor, door, number,
street_line1, street_line2, zipcode, city, state,
cedex, postal_box, country
Filter value
values_dict* {
Values dict

}
}

STATUS CODE - 400: Invalid parameters.

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

1.3 GET /addresses/next-locations/

11 of 352
Fetch next locations for initial values.

Fetch next locations for initial values.

This is useful for the treeview, and it is used in Instant Mobile.

REQUEST
QUERY PARAMETERS
NAME TYPE DESCRIPTION

location string Location value <i>(e.g. SharingCloud/France)</i>

min:1 chars
location_filter string Location filter <i>(e.g. company,country)</i>
min:1 chars
<i>Available values</i> : company, division, site, departement,
corporation, building, floor, door, number, street_line1,
street_line2, zipcode, city, state, cedex, postal_box, country</i>
*data_type enum Data type
ALLOWED:
studio,
guestpoint
exclude_not_bookable boolean
exclude_no_resources boolean Exclude locations with no visible resources

RESPONSE

STATUS CODE - 200:

RESPONSE MODEL - application/json

{
depth* integer Location depth
filter_value* enum ALLOWED:company,
division, site, departement,
corporation, building, floor, door, number,
street_line1, street_line2, zipcode, city,
state, cedex, postal_box, country
Filter value
values* [string] min:1 chars
Value
exclude_not_bookable boolean
exclude_no_resources boolean DEFAULT:true
Exclude locations with no visible resources
}

STATUS CODE - 400: Invalid parameters.

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

1.4 GET /addresses/{id}/

Get a specific address.

Get a specific address from an address ID.

12 of 352
REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*id string A unique integer value identifying this address.

RESPONSE

STATUS CODE - 200:

RESPONSE MODEL - application/json

{
company* string 1 to 100 chars
country* string max:100 chars
city* string max:100 chars
site* string 1 to 100 chars
division string 1 to 100 chars
departement string max:50 chars
corporation string max:100 chars
building string max:50 chars
floor string max:50 chars
door string max:50 chars
number string max:30 chars
street_line1 string max:100 chars
street_line2 string max:100 chars
zipcode string max:5 chars
state string max:100 chars
cedex string max:100 chars
postal_box string max:20 chars
}

STATUS CODE - 400: Invalid parameters.

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

STATUS CODE - 404: Address not found

13 of 352
2. AGENDA-ACCESS

2.1 GET /agenda-access/

Retrieve agenda access requests.

With agenda_ids set you can get incoming access requests to your agenda (your co-workers ->
you).With viewer_ids set you can get access requests you have made (you -> your co-workers).

To use this endpoint as a standard user, either agenda_ids or viewer_ids have to be set to your
agenda/user ID.Otherwise, you have to be at least CLOUD_POWERUSER to see requests not
linked to you.

REQUEST
QUERY PARAMETERS
NAME TYPE DESCRIPTION

page integer A page number within the paginated result set.

page_size integer Number of results to return per page.
viewer_ids string IDs of users requesting or having access to your agenda (Comma-separated list
min:1 of numbers, e.g. `1,2,3`)
chars
agenda_ids string IDs of the agendas you can view or have requested to view (Comma-separated list
min:1 of numbers, e.g. `1,2,3`)
chars
query string Name filter query
min:1
chars
status string Values for 'status' are:
min:1 Pending: 0
chars Denied: 1
Accepted: 2 (Comma-separated list of numbers, e.g. `1,2,3`)

RESPONSE

STATUS CODE - 200:

RESPONSE MODEL - application/json

{
id integer READ-ONLY
viewer* {
User who requested the access

id* integer User ID

first_name* string min:1 chars
First name
last_name* string min:1 chars
Last name
picture string READ-ONLY
Profile picture URI
agenda_id integer READ-ONLY
ID of the viewer's agenda

14 of 352
 }
agenda* {
Agenda requested

id integer READ-ONLY
user* {
User who requested the access

id* integer User ID

first_name* string min:1 chars
First name
last_name* string min:1 chars
Last name
picture string READ-ONLY
Profile picture URI
agenda_id integer READ-ONLY
ID of the viewer's agenda
}
enabled boolean
}
status enum ALLOWED:0, 1, 2
}

STATUS CODE - 400: Invalid parameters.

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: You can only filter by your agenda or you as a viewer

2.2 POST /agenda-access/

Request access to a UserAgenda.

Create an access request or return the existing one if it already exists for the given parameters.If
created, the status will be pending or accepted depending on the targeted user's settings.You can
target a UserAgenda directly or a User if they do not have an agenda yet, by using eitheragenda_id or
user_id.

REQUEST
REQUEST BODY - application/json
{
agenda_id integer ID of the agenda to view (cannot be given along with user_id)
user_id integer ID of the user (cannot be given along with agenda_id)
}

RESPONSE

STATUS CODE - 200:

RESPONSE MODEL - application/json

{
id integer READ-ONLY
viewer* {
User who requested the access

id* integer User ID

first_name* string min:1 chars
First name
last_name* string min:1 chars

15 of 352
 Last name
picture string READ-ONLY
Profile picture URI
agenda_id integer READ-ONLY
ID of the viewer's agenda
}
agenda* {
Agenda requested

id integer READ-ONLY
user* {
User who requested the access

id* integer User ID

first_name* string min:1 chars
First name
last_name* string min:1 chars
Last name
picture string READ-ONLY
Profile picture URI
agenda_id integer READ-ONLY
ID of the viewer's agenda
}
enabled boolean
}
status enum ALLOWED:0, 1, 2
}

STATUS CODE - 400: Invalid parameters.

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

STATUS CODE - 404: UserAgenda not found

2.3 POST /agenda-access/bulk/

Request access to many UserAgenda at once.

Each set of parameters must be given in a list.Go to POST /agenda-access/ documentation to see how
AgendaAccess work.

REQUEST
REQUEST BODY - application/json
[{
Array of object:

agenda_id integer ID of the agenda to view (cannot be given along with user_id)
user_id integer ID of the user (cannot be given along with agenda_id)
}]

RESPONSE

STATUS CODE - 207:

RESPONSE MODEL - application/json

[{
Array of object:

status* integer HTTP Status Code

16 of 352
 data* {
Result

}
}]

STATUS CODE - 400: Invalid parameters.

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

2.4 PUT /agenda-access/update-pending/

Update all pending AgendaAccess requests to the id's user agenda

Use this endpoint to update all pending requests to an user agenda.An agenda_id have to be pass as a
field.A status have to be pass as a field.

REQUEST
REQUEST BODY - application/json
{
agenda_id* integer ID of agenda to be view
viewer_ids [integer]
status* enum ALLOWED:0, 1, 2
Values for 'status' are:
Pending: 0
Denied: 1
Accepted: 2
}

RESPONSE

STATUS CODE - 200:

RESPONSE MODEL - application/json

{
id integer READ-ONLY
viewer* {
User who requested the access

id* integer User ID

first_name* string min:1 chars
First name
last_name* string min:1 chars
Last name
picture string READ-ONLY
Profile picture URI
agenda_id integer READ-ONLY
ID of the viewer's agenda
}
agenda* {
Agenda requested

id integer READ-ONLY
user* {
User who requested the access

id* integer User ID

first_name* string min:1 chars
First name

17 of 352
 last_name* string min:1 chars
Last name
picture string READ-ONLY
Profile picture URI
agenda_id integer READ-ONLY
ID of the viewer's agenda
}
enabled boolean
}
status enum ALLOWED:0, 1, 2
}

STATUS CODE - 400: Invalid parameters.

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

STATUS CODE - 404: AgendaAccess not found

2.5 PUT /agenda-access/{id}/

Changes the status of an AgendaAccess.

Use this endpoint to accept or deny an agenda access request.

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*id string A unique integer value identifying this agenda access.

REQUEST BODY - application/json

{
status* enum ALLOWED:0, 1, 2
Values for 'status' are:
Pending: 0
Denied: 1
Accepted: 2
}

RESPONSE

STATUS CODE - 200:

RESPONSE MODEL - application/json

{
id integer READ-ONLY
viewer* {
User who requested the access

id* integer User ID

first_name* string min:1 chars
First name
last_name* string min:1 chars
Last name
picture string READ-ONLY
Profile picture URI

18 of 352
 agenda_id integer READ-ONLY
ID of the viewer's agenda
}
agenda* {
Agenda requested

id integer READ-ONLY
user* {
User who requested the access

id* integer User ID

first_name* string min:1 chars
First name
last_name* string min:1 chars
Last name
picture string READ-ONLY
Profile picture URI
agenda_id integer READ-ONLY
ID of the viewer's agenda
}
enabled boolean
}
status enum ALLOWED:0, 1, 2
}

STATUS CODE - 400: Invalid parameters.

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

STATUS CODE - 404: AgendaAccess not found

2.6 DELETE /agenda-access/{id}/

Delete an AgendaAccess.

Cancel a request you made (regardless its status) to view an agenda

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*id string A unique integer value identifying this agenda access.

RESPONSE

STATUS CODE - 204: Success

STATUS CODE - 400: Invalid parameters.

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

STATUS CODE - 404: AgendaAccess not found

19 of 352
3. BADGES

3.1 GET /badges/standard/

List all standard-badges.

REQUEST
QUERY PARAMETERS
NAME TYPE DESCRIPTION

is_active string
badge_type string
creator_id string
user_id string
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
user_email string Can filter by user_email.

RESPONSE

STATUS CODE - 200:

RESPONSE MODEL - application/json

{
pagination* {
total_results integer
results_per_page integer
total_pages integer
current_page integer
previous_page integer
next_page integer
}
results* [{
Array of object:

id integer READ-ONLY
badge* string 1 to 2048 chars
badge_type* enum ALLOWED:0, 1
is_active boolean
comment string
user {
id integer READ-ONLY
uuid string READ-ONLY
first_name string max:150 chars
last_name string max:150 chars
email string max:254 chars
username* string 1 to 150 chars
PATTERN:^[\w.@+-]+$
Required. 150 characters or fewer. Letters, digits and @/./
+/-/_ only.
full_name* string min:1 chars

20 of 352
 account_type string READ-ONLY
standard, service_with_impersonation,
service_without_impersonation, device
cloud_space_right {
instant_social* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_tv* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_booking* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_signage* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_metrics* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_device_manager* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
}
}
user_id* integer
creator {
id integer READ-ONLY
uuid string READ-ONLY
first_name string max:150 chars
last_name string max:150 chars
email string max:254 chars
username* string 1 to 150 chars
PATTERN:^[\w.@+-]+$
Required. 150 characters or fewer. Letters, digits and @/./
+/-/_ only.
full_name* string min:1 chars
account_type string READ-ONLY
standard, service_with_impersonation,
service_without_impersonation, device
cloud_space_right {
instant_social* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_tv* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_booking* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_signage* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_metrics* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_device_manager* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
}

21 of 352
 }
creator_id* integer
date_pub_added string READ-ONLY
date_pub_lastmodified string READ-ONLY
}]
}

STATUS CODE - 400: Invalid parameters.

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

3.2 POST /badges/standard/

Create standard-badge.

REQUEST

RESPONSE

STATUS CODE - 201:

RESPONSE MODEL - application/json

{
badge* string 1 to 2048 chars
badge_type* enum ALLOWED:0, 1
is_active boolean
comment string
user_id* integer
}

STATUS CODE - 400: Invalid parameters.

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

3.3 GET /badges/standard/{badge}/

Retrieve standard-badge from its badge field.

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*badge string

RESPONSE

STATUS CODE - 200:

RESPONSE MODEL - application/json

{
id integer READ-ONLY

22 of 352
badge* string 1 to 2048 chars
badge_type* enum ALLOWED:0, 1
is_active boolean
comment string
user {
id integer READ-ONLY
uuid string READ-ONLY
first_name string max:150 chars
last_name string max:150 chars
email string max:254 chars
username* string 1 to 150 chars
PATTERN:^[\w.@+-]+$
Required. 150 characters or fewer. Letters, digits and @/./+/-/_
only.
full_name* string min:1 chars
account_type string READ-ONLY
standard, service_with_impersonation,
service_without_impersonation, device
cloud_space_right {
instant_social* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_tv* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_booking* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_signage* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_metrics* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_device_manager* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
}
}
user_id* integer
creator {
id integer READ-ONLY
uuid string READ-ONLY
first_name string max:150 chars
last_name string max:150 chars
email string max:254 chars
username* string 1 to 150 chars
PATTERN:^[\w.@+-]+$
Required. 150 characters or fewer. Letters, digits and @/./+/-/_
only.
full_name* string min:1 chars
account_type string READ-ONLY
standard, service_with_impersonation,
service_without_impersonation, device
cloud_space_right {
instant_social* enum ALLOWED:CLOUD_GUEST,
CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_tv* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,

23 of 352
 CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_booking* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_signage* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_metrics* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_device_manager* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
}
}
creator_id* integer
date_pub_added string READ-ONLY
date_pub_lastmodified string READ-ONLY
}

STATUS CODE - 400: Invalid parameters.

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

3.4 PUT /badges/standard/{badge}/

Update standard-badge.

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*badge string

RESPONSE

STATUS CODE - 200:

RESPONSE MODEL - application/json

{
badge* string 1 to 2048 chars
badge_type* enum ALLOWED:0, 1
is_active boolean
comment string
user_id* integer
}

STATUS CODE - 400: Invalid parameters.

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

24 of 352
3.5 DELETE /badges/standard/{badge}/

Delete standard-badge.

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*badge string

RESPONSE

STATUS CODE - 204:

STATUS CODE - 400: Invalid parameters.

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

3.6 PATCH /badges/standard/{badge}/

Update standard-badge.

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*badge string

RESPONSE

STATUS CODE - 200:

RESPONSE MODEL - application/json

{
badge* string 1 to 2048 chars
badge_type* enum ALLOWED:0, 1
is_active boolean
comment string
user_id* integer
}

STATUS CODE - 400: Invalid parameters.

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

3.7 PUT /badges/standard/{badge}/toggle_active/

Toggle switch of is_active. Activate or deactivate the standard-badge.

25 of 352
REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*badge string

REQUEST BODY - application/json

{
id integer READ-ONLY
badge* string 1 to 2048 chars
badge_type* enum ALLOWED:0, 1
is_active boolean
comment string
user {
id integer READ-ONLY
uuid string READ-ONLY
first_name string max:150 chars
last_name string max:150 chars
email string max:254 chars
username* string 1 to 150 chars
PATTERN:^[\w.@+-]+$
Required. 150 characters or fewer. Letters, digits and @/./+/-/_
only.
full_name* string min:1 chars
account_type string READ-ONLY
standard, service_with_impersonation,
service_without_impersonation, device
cloud_space_right {
instant_social* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_tv* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_booking* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_signage* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_metrics* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_device_manager* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
}
}
user_id* integer
creator {
id integer READ-ONLY
uuid string READ-ONLY
first_name string max:150 chars
last_name string max:150 chars
email string max:254 chars
username* string 1 to 150 chars
PATTERN:^[\w.@+-]+$

26 of 352
 Required. 150 characters or fewer. Letters, digits and @/./+/-/_
only.
full_name* string min:1 chars
account_type string READ-ONLY
standard, service_with_impersonation,
service_without_impersonation, device
cloud_space_right {
instant_social* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_tv* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_booking* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_signage* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_metrics* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_device_manager* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
}
}
creator_id* integer
date_pub_added string READ-ONLY
date_pub_lastmodified string READ-ONLY
}

RESPONSE

STATUS CODE - 200:

RESPONSE MODEL - application/json

{
id integer READ-ONLY
badge* string 1 to 2048 chars
badge_type* enum ALLOWED:0, 1
is_active boolean
comment string
user {
id integer READ-ONLY
uuid string READ-ONLY
first_name string max:150 chars
last_name string max:150 chars
email string max:254 chars
username* string 1 to 150 chars
PATTERN:^[\w.@+-]+$
Required. 150 characters or fewer. Letters, digits and @/./+/-/
_ only.
full_name* string min:1 chars
account_type string READ-ONLY
standard, service_with_impersonation,
service_without_impersonation, device
cloud_space_right {
instant_social* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,

27 of 352
 CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_tv* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_booking* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_signage* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_metrics* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_device_manager* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
}
}
user_id* integer
creator {
id integer READ-ONLY
uuid string READ-ONLY
first_name string max:150 chars
last_name string max:150 chars
email string max:254 chars
username* string 1 to 150 chars
PATTERN:^[\w.@+-]+$
Required. 150 characters or fewer. Letters, digits and @/./+/-/
_ only.
full_name* string min:1 chars
account_type string READ-ONLY
standard, service_with_impersonation,
service_without_impersonation, device
cloud_space_right {
instant_social* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_tv* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_booking* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_signage* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_metrics* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_device_manager* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
}
}
creator_id* integer
date_pub_added string READ-ONLY
date_pub_lastmodified string READ-ONLY

28 of 352
 }

STATUS CODE - 400: Invalid parameters.

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

STATUS CODE - 404: badge not found

3.8 POST /badges/temporary/

Create temporary badge.

REQUEST

RESPONSE

STATUS CODE - 200:

RESPONSE MODEL - application/json

{
reference string READ-ONLY
min:1 chars
owner {
id integer READ-ONLY
uuid string READ-ONLY
first_name string max:150 chars
last_name string max:150 chars
email string max:254 chars
username* string 1 to 150 chars
PATTERN:^[\w.@+-]+$
Required. 150 characters or fewer. Letters, digits and @/./+/-/_
only.
full_name* string min:1 chars
account_type string READ-ONLY
standard, service_with_impersonation,
service_without_impersonation, device
cloud_space_right {
instant_social* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_tv* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_booking* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_signage* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_metrics* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_device_manager* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
}

29 of 352
}
badge* string 1 to 512 chars
delivered_user {
id integer READ-ONLY
uuid string READ-ONLY
first_name string max:150 chars
last_name string max:150 chars
email string max:254 chars
username* string 1 to 150 chars
PATTERN:^[\w.@+-]+$
Required. 150 characters or fewer. Letters, digits and @/./+/-/_
only.
full_name* string min:1 chars
account_type string READ-ONLY
standard, service_with_impersonation,
service_without_impersonation, device
cloud_space_right {
instant_social* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_tv* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_booking* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_signage* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_metrics* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_device_manager* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
}
}
delivered_name* string 1 to 512 chars
delivered_date string
has_identity_card boolean
identity_card* string 1 to 512 chars
comments string min:1 chars
entity* string 1 to 512 chars
returned_user {
id integer READ-ONLY
uuid string READ-ONLY
first_name string max:150 chars
last_name string max:150 chars
email string max:254 chars
username* string 1 to 150 chars
PATTERN:^[\w.@+-]+$
Required. 150 characters or fewer. Letters, digits and @/./+/-/_
only.
full_name* string min:1 chars
account_type string READ-ONLY
standard, service_with_impersonation,
service_without_impersonation, device
cloud_space_right {
instant_social* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,

30 of 352
 CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_tv* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_booking* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_signage* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_metrics* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_device_manager* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
}
}
returned_name* string 1 to 512 chars
returned_date string
returned boolean
guest_point {
id integer READ-ONLY
title* string 1 to 512 chars
display_name* string 1 to 512 chars
default_name string READ-ONLY
min:1 chars
Display name or technical name
address {
company* string 1 to 100 chars
country* string max:100 chars
city* string max:100 chars
site* string 1 to 100 chars
division string 1 to 100 chars
departement string max:50 chars
corporation string max:100 chars
building string max:50 chars
floor string max:50 chars
door string max:50 chars
number string max:30 chars
street_line1 string max:100 chars
street_line2 string max:100 chars
zipcode string max:5 chars
state string max:100 chars
cedex string max:100 chars
postal_box string max:20 chars
}
owner integer
email string max:254 chars
phone string max:512 chars
description string
mail_bundles* [{
Array of object:

bundle {
id integer READ-ONLY
key* string 1 to 1024 chars

31 of 352
 display_name* string 1 to 1024 chars
is_default boolean
is_system boolean
}
content_type {
id integer READ-ONLY
app_label* string 1 to 100 chars
model* string 1 to 100 chars
}
object_id integer between 0 and 2147483647
}]
add_guest_list_iframe_url string READ-ONLY
guest_point_url_badges string READ-ONLY
guest_point_url_folds string READ-ONLY
has_local_admin_right boolean READ-ONLY
guest_badge_display* integer Usage rules for badges.0 - Do not display or use badges.1 - Display badges but
don't require them for checkin.2 - Badges are also required for check-in.
enable_folds_view boolean READ-ONLY
enable_temp_badge_view boolean READ-ONLY
}
date_pub_added string READ-ONLY
date_pub_lastmodified string READ-ONLY
}

STATUS CODE - 400: Invalid parameters.

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

3.9 GET /badges/temporary/{ref}/

Retrieve temporary badge from its ID.

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*ref string Temporary badge ID (BT00001)

RESPONSE

STATUS CODE - 200:

RESPONSE MODEL - application/json

{
reference string READ-ONLY
min:1 chars
owner {
id integer READ-ONLY
uuid string READ-ONLY
first_name string max:150 chars
last_name string max:150 chars
email string max:254 chars
username* string 1 to 150 chars
PATTERN:^[\w.@+-]+$

32 of 352
 Required. 150 characters or fewer. Letters, digits and @/./+/-/_
only.
full_name* string min:1 chars
account_type string READ-ONLY
standard, service_with_impersonation,
service_without_impersonation, device
cloud_space_right {
instant_social* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_tv* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_booking* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_signage* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_metrics* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_device_manager* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
}
}
badge* string 1 to 512 chars
delivered_user {
id integer READ-ONLY
uuid string READ-ONLY
first_name string max:150 chars
last_name string max:150 chars
email string max:254 chars
username* string 1 to 150 chars
PATTERN:^[\w.@+-]+$
Required. 150 characters or fewer. Letters, digits and @/./+/-/_
only.
full_name* string min:1 chars
account_type string READ-ONLY
standard, service_with_impersonation,
service_without_impersonation, device
cloud_space_right {
instant_social* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_tv* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_booking* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_signage* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_metrics* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_device_manager* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,

33 of 352
 CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
}
}
delivered_name* string 1 to 512 chars
delivered_date string
has_identity_card boolean
identity_card* string 1 to 512 chars
comments string min:1 chars
entity* string 1 to 512 chars
returned_user {
id integer READ-ONLY
uuid string READ-ONLY
first_name string max:150 chars
last_name string max:150 chars
email string max:254 chars
username* string 1 to 150 chars
PATTERN:^[\w.@+-]+$
Required. 150 characters or fewer. Letters, digits and @/./+/-/_
only.
full_name* string min:1 chars
account_type string READ-ONLY
standard, service_with_impersonation,
service_without_impersonation, device
cloud_space_right {
instant_social* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_tv* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_booking* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_signage* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_metrics* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_device_manager* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
}
}
returned_name* string 1 to 512 chars
returned_date string
returned boolean
guest_point {
id integer READ-ONLY
title* string 1 to 512 chars
display_name* string 1 to 512 chars
default_name string READ-ONLY
min:1 chars
Display name or technical name
address {
company* string 1 to 100 chars
country* string max:100 chars

34 of 352
 city* string max:100 chars
site* string 1 to 100 chars
division string 1 to 100 chars
departement string max:50 chars
corporation string max:100 chars
building string max:50 chars
floor string max:50 chars
door string max:50 chars
number string max:30 chars
street_line1 string max:100 chars
street_line2 string max:100 chars
zipcode string max:5 chars
state string max:100 chars
cedex string max:100 chars
postal_box string max:20 chars
}
owner integer
email string max:254 chars
phone string max:512 chars
description string
mail_bundles* [{
Array of object:

bundle {
id integer READ-ONLY
key* string 1 to 1024 chars
display_name* string 1 to 1024 chars
is_default boolean
is_system boolean
}
content_type {
id integer READ-ONLY
app_label* string 1 to 100 chars
model* string 1 to 100 chars
}
object_id integer between 0 and 2147483647
}]
add_guest_list_iframe_url string READ-ONLY
guest_point_url_badges string READ-ONLY
guest_point_url_folds string READ-ONLY
has_local_admin_right boolean READ-ONLY
guest_badge_display* integer Usage rules for badges.0 - Do not display or use badges.1 - Display badges but
don't require them for checkin.2 - Badges are also required for check-in.
enable_folds_view boolean READ-ONLY
enable_temp_badge_view boolean READ-ONLY
}
date_pub_added string READ-ONLY
date_pub_lastmodified string READ-ONLY
}

STATUS CODE - 400: Invalid parameters.

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

3.10 PUT /badges/temporary/{ref}/

Update temporary badge.

35 of 352
REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*ref string Temporary badge ID (BT00001)

RESPONSE

STATUS CODE - 200:

RESPONSE MODEL - application/json

{
reference string READ-ONLY
min:1 chars
owner {
id integer READ-ONLY
uuid string READ-ONLY
first_name string max:150 chars
last_name string max:150 chars
email string max:254 chars
username* string 1 to 150 chars
PATTERN:^[\w.@+-]+$
Required. 150 characters or fewer. Letters, digits and @/./+/-/_
only.
full_name* string min:1 chars
account_type string READ-ONLY
standard, service_with_impersonation,
service_without_impersonation, device
cloud_space_right {
instant_social* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_tv* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_booking* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_signage* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_metrics* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_device_manager* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
}
}
badge* string 1 to 512 chars
delivered_user {
id integer READ-ONLY
uuid string READ-ONLY
first_name string max:150 chars
last_name string max:150 chars
email string max:254 chars

36 of 352
 username* string 1 to 150 chars
PATTERN:^[\w.@+-]+$
Required. 150 characters or fewer. Letters, digits and @/./+/-/_
only.
full_name* string min:1 chars
account_type string READ-ONLY
standard, service_with_impersonation,
service_without_impersonation, device
cloud_space_right {
instant_social* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_tv* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_booking* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_signage* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_metrics* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_device_manager* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
}
}
delivered_name* string 1 to 512 chars
delivered_date string
has_identity_card boolean
identity_card* string 1 to 512 chars
comments string min:1 chars
entity* string 1 to 512 chars
returned_user {
id integer READ-ONLY
uuid string READ-ONLY
first_name string max:150 chars
last_name string max:150 chars
email string max:254 chars
username* string 1 to 150 chars
PATTERN:^[\w.@+-]+$
Required. 150 characters or fewer. Letters, digits and @/./+/-/_
only.
full_name* string min:1 chars
account_type string READ-ONLY
standard, service_with_impersonation,
service_without_impersonation, device
cloud_space_right {
instant_social* enum ALLOWED:CLOUD_GUEST,
CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_tv* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_booking* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN

37 of 352
 instant_signage* enum ALLOWED:CLOUD_GUEST,
CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_metrics* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_device_manager* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
}
}
returned_name* string 1 to 512 chars
returned_date string
returned boolean
guest_point {
id integer READ-ONLY
title* string 1 to 512 chars
display_name* string 1 to 512 chars
default_name string READ-ONLY
min:1 chars
Display name or technical name
address {
company* string 1 to 100 chars
country* string max:100 chars
city* string max:100 chars
site* string 1 to 100 chars
division string 1 to 100 chars
departement string max:50 chars
corporation string max:100 chars
building string max:50 chars
floor string max:50 chars
door string max:50 chars
number string max:30 chars
street_line1 string max:100 chars
street_line2 string max:100 chars
zipcode string max:5 chars
state string max:100 chars
cedex string max:100 chars
postal_box string max:20 chars
}
owner integer
email string max:254 chars
phone string max:512 chars
description string
mail_bundles* [{
Array of object:

bundle {
id integer READ-ONLY
key* string 1 to 1024 chars
display_name* string 1 to 1024 chars
is_default boolean
is_system boolean
}
content_type {
id integer READ-ONLY
app_label* string 1 to 100 chars
model* string 1 to 100 chars

38 of 352
 }
object_id integer between 0 and 2147483647
}]
add_guest_list_iframe_url string READ-ONLY
guest_point_url_badges string READ-ONLY
guest_point_url_folds string READ-ONLY
has_local_admin_right boolean READ-ONLY
guest_badge_display* integer Usage rules for badges.0 - Do not display or use badges.1 - Display badges but
don't require them for checkin.2 - Badges are also required for check-in.
enable_folds_view boolean READ-ONLY
enable_temp_badge_view boolean READ-ONLY
}
date_pub_added string READ-ONLY
date_pub_lastmodified string READ-ONLY
}

STATUS CODE - 400: Invalid parameters.

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

39 of 352
4. BOOKINGS

4.1 GET /bookings/

List and filter your bookings.

List and filter bookings where you are the owner.

You can filter using a booking filter:

all: All bookings,

past: Only past bookings,
upcoming: Only upcoming bookings,
progress: Only bookings in progress.

You can filter by resource types, using comma-separated IDs,You can filter by resource IDs,You can
filter by date.You can filter your own bookings.You can filter by resource location using a JSON

Bookings contains resource information through an object called ResourceManager.A

ResourceManager contains data by resource, like the status (finished, confirmed, released, etc.)

Warning: If enabled, the videoonline_booking_grid_info_display_low_security cloud propertywill allow

the display of non-private booking information, even if the authenticated user has no righton the
booking.

REQUEST
QUERY PARAMETERS
NAME TYPE DESCRIPTION

page integer A page number within the paginated result set.

page_size integer Number of results to return per page.
resource_types string Comma-separated list of numbers, e.g. `1,2,3`
min:1 chars
filter enum Booking filter
ALLOWED: all,
upcoming, progress,
upcoming_and_progress, past
resource_ids string Resource IDs (Comma-separated list of numbers, e.g.
min:1 chars `1,2,3`)
start_time date-time Start datetime (ISO-8601 : 1977-04-22T06:00:00Z)
end_time date-time End datetime (ISO-8601 : 1977-04-22T06:00:00Z)
resource_location string Filter on the location of the booked resources (JSON)

JSON format e.g. {"city": "Paris", "site": "Boulogne"}

Valid keys are: company, division, site, departement,
corporation, building, floor, door, number, street_line1,
street_line2, zipcode, city, state, cedex, postal_box,
country
include_delegation boolean Include the reservation I made for other or other made
for me

40 of 352
RESPONSE

STATUS CODE - 200:

RESPONSE MODEL - application/json

{
pagination* {
total_results integer
results_per_page integer
total_pages integer
current_page integer
previous_page integer
next_page integer
}
results* [{
Array of object:

id integer READ-ONLY
conf_id* string min:1 chars
start* string
end* string
last_update* string
duration* integer
title* string 1 to 512 chars
is_valid* boolean
description string
comment string READ-ONLY
min:1 chars
from_application enum ALLOWED:0, 1, 2, 3, 4,
5, 6, 7, 8, 9, 10,
11, 12, 13, 14, 15,
16, 17
owner* {
id integer READ-ONLY
uuid string READ-ONLY
first_name string max:150 chars
last_name string max:150 chars
email string max:254 chars
username* string 1 to 150 chars
PATTERN:^[\w.@+-]+$
Required. 150 characters or fewer. Letters, digits and @/./
+/-/_ only.
full_name* string min:1 chars
account_type string READ-ONLY
standard, service_with_impersonation,
service_without_impersonation, device
cloud_space_right {
instant_social* enum ALLOWED:CLOUD_GUEST,
CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_tv* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_booking* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_signage* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN

41 of 352
 instant_metrics* enum ALLOWED:CLOUD_GUEST,
CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_device_manager* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
}
}
creator* {
id integer READ-ONLY
uuid string READ-ONLY
first_name string max:150 chars
last_name string max:150 chars
email string max:254 chars
username* string 1 to 150 chars
PATTERN:^[\w.@+-]+$
Required. 150 characters or fewer. Letters, digits and @/./
+/-/_ only.
full_name* string min:1 chars
account_type string READ-ONLY
standard, service_with_impersonation,
service_without_impersonation, device
cloud_space_right {
instant_social* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_tv* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_booking* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_signage* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_metrics* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_device_manager* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
}
}
organizer* string min:1 chars
organizer_target* {
id integer READ-ONLY
uuid string READ-ONLY
first_name string max:150 chars
last_name string max:150 chars
email string max:254 chars
username* string 1 to 150 chars
PATTERN:^[\w.@+-]+$
Required. 150 characters or fewer. Letters, digits and @/./
+/-/_ only.
full_name* string min:1 chars
account_type string READ-ONLY
standard, service_with_impersonation,
service_without_impersonation, device
cloud_space_right {

42 of 352
 instant_social* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_tv* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_booking* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_signage* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_metrics* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_device_manager* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
}
}
private* boolean
imputation_code string max:512 chars
is_recurring* boolean
conference_type_id string READ-ONLY
sensitivity enum ALLOWED:0, 1, 2, 3
has_moderation string READ-ONLY
demand_status* integer
logo string READ-ONLY
in_progress* boolean
teams_meeting_requested boolean READ-ONLY
visio_infos {
teams* {
Teams meeting join URLs

web_url* string min:1 chars

Web browser join URL
desktop_url* string min:1 chars
Desktop app join URL
deeplink_scheme* string min:1 chars
Deeplink scheme to join using a mobile app
}
zoom* {
Teams meeting join URLs

web_url* string min:1 chars

Web browser join URL
desktop_url* string min:1 chars
Desktop app join URL
deeplink_scheme* string min:1 chars
Deeplink scheme to join using a mobile app
}
webex* {
Teams meeting join URLs

web_url* string min:1 chars

Web browser join URL
desktop_url* string min:1 chars
Desktop app join URL
deeplink_scheme* string min:1 chars
Deeplink scheme to join using a mobile app
}

43 of 352
}
confirmed boolean READ-ONLY
finished* boolean
resourcemanagers* [{
Array of object:

resource* {
id integer READ-ONLY
name* string 1 to 512 chars
resource_allowed_reservation enum DEFAULT:1
ALLOWED:1, 5, 2, 3,
4
resource_type enum DEFAULT:1
ALLOWED:6, 7, 8, 9,
15, 34, 38, 39, 40,
41, 1, 2, 3, 11, 4,
5, 20, 23, 24, 25,
26, 29, 31, 32, 33,
35, 36, 12, 13, 19,
27, 10, 18, 21, 16,
17, 22, 14, 30, 28,
37, 42, 43, 44, 45,
46, 48, 49, 50, 51,
52, 53, 54, 55, 56,
57
capacity* integer >=0
address* {
company* string 1 to 100 chars
country* string max:100 chars
city* string max:100 chars
site* string 1 to 100 chars
division string 1 to 100 chars
departement string max:50 chars
corporation string max:100 chars
building string max:50 chars
floor string max:50 chars
door string max:50 chars
number string max:30 chars
street_line1 string max:100 chars
street_line2 string max:100 chars
zipcode string max:5 chars
state string max:100 chars
cedex string max:100 chars
postal_box string max:20 chars
}
display_name string max:512 chars
alternate_room_name string max:512 chars
description string
contact_phone string max:100 chars
contact_email string max:254 chars
contact string max:512 chars
custom_contact_info string max:512 chars
sip_uri string min:1 chars
ip_address string min:1 chars
is_visible boolean
is_internal boolean
nb_participants_required boolean
is_custom_contact_info boolean

44 of 352
bms_zone string max:512 chars
site_code string max:512 chars
is_moderated boolean
book_horizon integer between 0 and
2147483647
DEFAULT:0
imputation_code boolean
imputation_code_label string max:512 chars
imputation_code_required boolean
requisitionable boolean
requisitionable_label string max:512 chars
vmr_num string max:512 chars
not_prm boolean
is_blind boolean
not_projector boolean
help_button_url string max:200 chars
min_booking_duration integer
max_booking_duration integer
isdn_number string min:1 chars
e164_number string min:1 chars
h323id string min:1 chars
room_phone_number string min:1 chars
status integer READ-ONLY
bookable boolean READ-ONLY
photo string READ-ONLY
photo_uuid string READ-ONLY
qrcode_url string READ-ONLY
QRCode URL pointing to Instant
Mobile resource page
qrcode_report_url string READ-ONLY
QRCode URL pointing to Instant
Mobile issue reporting page
calendar_processing {
instant_booking_mode enum ALLOWED:0, 1,
2
instant_booking_duration_1 integer between
-2147483648
and
2147483647
instant_booking_duration_2 integer between
-2147483648
and
2147483647
instant_booking_duration_step enum ALLOWED:5, 10,
15, 30, 45,
60
instant_booking_confirmation_required boolean
instant_booking_auth_required boolean
meeting_ack boolean
meeting_ack_start_time enum ALLOWED:0, 5,
10, 15, 30,
45, 60, 75,
90, 105,
120, 135,
150, 165,
180, 195,
210, 225,
240

45 of 352
 meeting_ack_end_time enum ALLOWED:0,5,
10, 15, 30,
45, 60, 75,
90, 105,
120, 135,
150, 165,
180, 195,
210, 225,
240
meeting_ack_confirmation_required boolean
meeting_ack_auth_required boolean
meeting_ack_auth_required_private_meetings boolean
meeting_ack_release boolean
meeting_ack_reminder boolean
extendable_meeting boolean
extendable_meeting_mode enum ALLOWED:0, 1
extend_meeting_duration_1 integer between
-2147483648
and
2147483647
extend_meeting_duration_2 integer between
-2147483648
and
2147483647
extend_meeting_duration_step enum ALLOWED:5, 10,
15, 30, 45,
60
meeting_ack_release_auth_required boolean
meeting_ack_release_auth_required_private_meetings boolean
time_before_sensor_auto_release enum ALLOWED:4, 6,
8, 10, 12,
16, 20
apply_rights_book boolean
apply_rights_release boolean
apply_rights_confirm boolean
auto_release_force boolean
}
max_date_from_now string READ-ONLY
min:1 chars
max_resa_hours string READ-ONLY
min:1 chars
available boolean READ-ONLY
compounds integer READ-ONLY
default_name string READ-ONLY
min:1 chars
Display name or technical name
interop_calendaring_email string READ-ONLY
min:1 chars
interop_videoconferencing_email string READ-ONLY
min:1 chars
teams_meeting_enabled boolean READ-ONLY
first_linked_map {
First map where this resource is shown

id integer READ-ONLY
title string 1 to 512 chars
display_name string 1 to 512 chars
description string min:1 chars
floor_top integer

46 of 352
 floor_bottom integer
display_type integer between -2147483648 and 2147483647
legend_display_type integer between -2147483648 and 2147483647
}
ordered_photos [string] min:1 chars
resource_tags [string]
service_offers [{
Array of object:

id* integer ID of the service offer

name* string min:1 chars
Name of the service offer
availability* enum ALLOWED:AVAILABLE, DISABLED, TOO_SHORT_NOTICE
Availability of this service based on the requested delivery time - Values:
`AVAILABLE` (This service offer is available), `DISABLED` (This service offer has
been disabled and is not currently available), `TOO_SHORT_NOTICE` (This service
offer requires a notice period and the requested delivery time is too close)
css_icon* string min:1 chars
CSS class of an icon symbolizing this service
}]
}
confirmed boolean
finished boolean
released boolean
release_reminded boolean
is_shadow boolean
answer enum ALLOWED:0, 1, 2, 3
nb_participants integer between -2147483648 and
2147483647
moderation enum ALLOWED:0, 1, 2
}]
dial string READ-ONLY
org_pin string READ-ONLY
part_pin string READ-ONLY
}]
}

STATUS CODE - 400: Invalid parameters.

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

4.2 POST /bookings/

Create a booking.

Create a booking.

You can also book on multiple days if you declare multiple comma-separated start and end times.For
example:

start: 2020-04-17T08:10:00.000Z,2020-04-20T08:10:00.000Z
end: 2020-04-17T08:25:00.000Z,2020-04-20T08:25:00.000Z

You can use this end-point as cloud-user.

REQUEST

47 of 352
RESPONSE

STATUS CODE - 200:

RESPONSE MODEL - application/json

{
creation_status* enum ALLOWED:CREATED, IN_PROGRESS
Creation status
progress [string] min:1 chars
Progress ID
booking {
id integer READ-ONLY
conf_id* string min:1 chars
start* string
end* string
last_update* string
duration* integer
title* string 1 to 512 chars
is_valid* boolean
description string
comment string READ-ONLY
min:1 chars
from_application enum ALLOWED:0, 1, 2, 3, 4,
5, 6, 7, 8, 9, 10,
11, 12, 13, 14, 15,
16, 17
owner* {
id integer READ-ONLY
uuid string READ-ONLY
first_name string max:150 chars
last_name string max:150 chars
email string max:254 chars
username* string 1 to 150 chars
PATTERN:^[\w.@+-]+$
Required. 150 characters or fewer. Letters, digits and @/./
+/-/_ only.
full_name* string min:1 chars
account_type string READ-ONLY
standard, service_with_impersonation,
service_without_impersonation, device
cloud_space_right {
instant_social* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_tv* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_booking* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_signage* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_metrics* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_device_manager* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,

48 of 352
 CLOUD_POWERUSER, CLOUD_ADMIN
}
}
creator* {
id integer READ-ONLY
uuid string READ-ONLY
first_name string max:150 chars
last_name string max:150 chars
email string max:254 chars
username* string 1 to 150 chars
PATTERN:^[\w.@+-]+$
Required. 150 characters or fewer. Letters, digits and @/./
+/-/_ only.
full_name* string min:1 chars
account_type string READ-ONLY
standard, service_with_impersonation,
service_without_impersonation, device
cloud_space_right {
instant_social* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_tv* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_booking* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_signage* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_metrics* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_device_manager* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
}
}
organizer* string min:1 chars
organizer_target* {
id integer READ-ONLY
uuid string READ-ONLY
first_name string max:150 chars
last_name string max:150 chars
email string max:254 chars
username* string 1 to 150 chars
PATTERN:^[\w.@+-]+$
Required. 150 characters or fewer. Letters, digits and @/./
+/-/_ only.
full_name* string min:1 chars
account_type string READ-ONLY
standard, service_with_impersonation,
service_without_impersonation, device
cloud_space_right {
instant_social* enum ALLOWED:CLOUD_GUEST,
CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_tv* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,

49 of 352
 CLOUD_POWERUSER, CLOUD_ADMIN
instant_booking* enum
ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_signage* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_metrics* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_device_manager* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
}
}
private* boolean
imputation_code string max:512 chars
is_recurring* boolean
conference_type_id string READ-ONLY
sensitivity enum ALLOWED:0, 1, 2, 3
has_moderation string READ-ONLY
demand_status* integer
logo string READ-ONLY
in_progress* boolean
teams_meeting_requested boolean READ-ONLY
visio_infos {
teams* {
Teams meeting join URLs

web_url* string min:1 chars

Web browser join URL
desktop_url* string min:1 chars
Desktop app join URL
deeplink_scheme* string min:1 chars
Deeplink scheme to join using a mobile app
}
zoom* {
Teams meeting join URLs

web_url* string min:1 chars

Web browser join URL
desktop_url* string min:1 chars
Desktop app join URL
deeplink_scheme* string min:1 chars
Deeplink scheme to join using a mobile app
}
webex* {
Teams meeting join URLs

web_url* string min:1 chars

Web browser join URL
desktop_url* string min:1 chars
Desktop app join URL
deeplink_scheme* string min:1 chars
Deeplink scheme to join using a mobile app
}
}
confirmed boolean READ-ONLY
finished* boolean
resourcemanagers* [{
Array of object:

50 of 352
resource* {
id integer READ-ONLY
name* string 1 to 512 chars
resource_allowed_reservation enum DEFAULT:1
ALLOWED:1, 5, 2, 3,
4
resource_type enum DEFAULT:1
ALLOWED:6, 7, 8, 9,
15, 34, 38, 39, 40,
41, 1, 2, 3, 11, 4,
5, 20, 23, 24, 25,
26, 29, 31, 32, 33,
35, 36, 12, 13, 19,
27, 10, 18, 21, 16,
17, 22, 14, 30, 28,
37, 42, 43, 44, 45,
46, 48, 49, 50, 51,
52, 53, 54, 55, 56,
57
capacity* integer >=0
address* {
company* string 1 to 100 chars
country* string max:100 chars
city* string max:100 chars
site* string 1 to 100 chars
division string 1 to 100 chars
departement string max:50 chars
corporation string max:100 chars
building string max:50 chars
floor string max:50 chars
door string max:50 chars
number string max:30 chars
street_line1 string max:100 chars
street_line2 string max:100 chars
zipcode string max:5 chars
state string max:100 chars
cedex string max:100 chars
postal_box string max:20 chars
}
display_name string max:512 chars
alternate_room_name string max:512 chars
description string
contact_phone string max:100 chars
contact_email string max:254 chars
contact string max:512 chars
custom_contact_info string max:512 chars
sip_uri string min:1 chars
ip_address string min:1 chars
is_visible boolean
is_internal boolean
nb_participants_required boolean
is_custom_contact_info boolean
bms_zone string max:512 chars
site_code string max:512 chars
is_moderated boolean
book_horizon integer between 0 and
2147483647

51 of 352
 DEFAULT:0
imputation_code boolean
imputation_code_label string max:512 chars
imputation_code_required boolean
requisitionable boolean
requisitionable_label string max:512 chars
vmr_num string max:512 chars
not_prm boolean
is_blind boolean
not_projector boolean
help_button_url string max:200 chars
min_booking_duration integer
max_booking_duration integer
isdn_number string min:1 chars
e164_number string min:1 chars
h323id string min:1 chars
room_phone_number string min:1 chars
status integer READ-ONLY
bookable boolean READ-ONLY
photo string READ-ONLY
photo_uuid string READ-ONLY
qrcode_url string READ-ONLY
QRCode URL pointing to Instant
Mobile resource page
qrcode_report_url string READ-ONLY
QRCode URL pointing to Instant
Mobile issue reporting page
calendar_processing {
instant_booking_mode enum ALLOWED:0,
1,
2
instant_booking_duration_1 integer between
-2147483648
and
2147483647
instant_booking_duration_2 integer between
-2147483648
and
2147483647
instant_booking_duration_step enum ALLOWED:5, 10,
15, 30, 45,
60
instant_booking_confirmation_required boolean
instant_booking_auth_required boolean
meeting_ack boolean
meeting_ack_start_time enum ALLOWED:0, 5,
10, 15, 30,
45, 60, 75,
90, 105,
120, 135,
150, 165,
180, 195,
210, 225,
240
meeting_ack_end_time enum ALLOWED:0, 5,
10, 15, 30,
45, 60, 75,
90, 105,
120, 135,

52 of 352
 150, 165,
180, 195,
210, 225,
240
meeting_ack_confirmation_required boolean
meeting_ack_auth_required boolean
meeting_ack_auth_required_private_meetings boolean
meeting_ack_release boolean
meeting_ack_reminder boolean
extendable_meeting boolean
extendable_meeting_mode enum ALLOWED:0, 1
extend_meeting_duration_1 integer between
-2147483648
and
2147483647
extend_meeting_duration_2 integer between
-2147483648
and
2147483647
extend_meeting_duration_step enum ALLOWED:5, 10,
15, 30, 45,
60
meeting_ack_release_auth_required boolean
meeting_ack_release_auth_required_private_meetings boolean
time_before_sensor_auto_release enum ALLOWED:4, 6,
8, 10, 12,
16, 20
apply_rights_book boolean
apply_rights_release boolean
apply_rights_confirm boolean
auto_release_force boolean
}
max_date_from_now string READ-ONLY
min:1 chars
max_resa_hours string READ-ONLY
min:1 chars
available boolean READ-ONLY
compounds integer READ-ONLY
default_name string READ-ONLY
min:1 chars
Display name or technical name
interop_calendaring_email string READ-ONLY
min:1 chars
interop_videoconferencing_email string READ-ONLY
min:1 chars
teams_meeting_enabled boolean READ-ONLY
first_linked_map {
First map where this resource is shown

id integer READ-ONLY
title string 1 to 512 chars
display_name string 1 to 512 chars
description string min:1 chars
floor_top integer
floor_bottom integer
display_type integer between -2147483648 and 2147483647
legend_display_type integer between -2147483648 and 2147483647
}
ordered_photos [string] min:1 chars

53 of 352
 resource_tags [string]
service_offers [{
Array of object:

id* integer ID of the service offer

name* string min:1 chars
Name of the service offer
availability* enum ALLOWED:AVAILABLE, DISABLED, TOO_SHORT_NOTICE
Availability of this service based on the requested delivery time - Values:
`AVAILABLE` (This service offer is available), `DISABLED` (This service offer has
been disabled and is not currently available), `TOO_SHORT_NOTICE` (This service
offer requires a notice period and the requested delivery time is too close)
css_icon* string min:1 chars
CSS class of an icon symbolizing this service
}]
}
confirmed boolean
finished boolean
released boolean
release_reminded boolean
is_shadow boolean
answer enum ALLOWED:0, 1, 2, 3
nb_participants integer between -2147483648 and
2147483647
moderation enum ALLOWED:0, 1, 2
}]
dial string READ-ONLY
org_pin string READ-ONLY
part_pin string READ-ONLY
}
}

STATUS CODE - 400: Invalid parameters.

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

4.3 GET /bookings/all/

Get bookings for all users.

You can filter bookings by temporality filter:

all: All bookings,

past: Only past bookings,
upcoming: Only upcoming bookings,
progress: Only bookings in progress.

You can filter by resource types, using comma-separated IDs,You can filter by resource IDs,You can
filter by date.

Private bookings will have their 'owner' and 'creator' set to null,and text fields set to a localized
'PRIVATE' label.

Bookings contains resource information through an object called ResourceManager.A

ResourceManager contains data by resource, like the status (finished, confirmed, released, etc.)

Warning: If enabled, the videoonline_booking_grid_info_display_low_security cloud propertywill allow

54 of 352
the display of non-private booking information, even if the authenticated user has no righton the
booking.

REQUEST
QUERY PARAMETERS
NAME TYPE DESCRIPTION

page integer A page number within the paginated result set.

page_size integer Number of results to return per page.
resource_types string Comma-separated list of numbers, e.g. `1,2,3`
min:1 chars
filter enum Booking filter
ALLOWED: all,
upcoming, progress,
upcoming_and_progress, past
resource_ids string Resource IDs (Comma-separated list of numbers, e.g.
min:1 chars `1,2,3`)
start_time date-time Start datetime (ISO-8601 : 1977-04-22T06:00:00Z)
end_time date-time End datetime (ISO-8601 : 1977-04-22T06:00:00Z)
resource_location string Filter on the location of the booked resources (JSON)

JSON format e.g. {"city": "Paris", "site": "Boulogne"}

Valid keys are: company, division, site, departement,
corporation, building, floor, door, number, street_line1,
street_line2, zipcode, city, state, cedex, postal_box,
country

RESPONSE

STATUS CODE - 200:

RESPONSE MODEL - application/json

{
pagination* {
total_results integer
results_per_page integer
total_pages integer
current_page integer
previous_page integer
next_page integer
}
results* [{
Array of object:

id integer READ-ONLY
conf_id* string min:1 chars
start* string
end* string
last_update* string
duration* integer
title* string 1 to 512 chars
is_valid* boolean
description string
comment string READ-ONLY
min:1 chars
from_application enum ALLOWED:0, 1, 2, 3, 4,

55 of 352
 5, 6, 7, 8, 9, 10,
11, 12, 13, 14, 15,
16, 17
owner* {
id integer READ-ONLY
uuid string READ-ONLY
first_name string max:150 chars
last_name string max:150 chars
email string max:254 chars
username* string 1 to 150 chars
PATTERN:^[\w.@+-]+$
Required. 150 characters or fewer. Letters, digits and @/./
+/-/_ only.
full_name* string min:1 chars
account_type string READ-ONLY
standard, service_with_impersonation,
service_without_impersonation, device
cloud_space_right {
instant_social* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_tv* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_booking* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_signage* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_metrics* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_device_manager* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
}
}
creator* {
id integer READ-ONLY
uuid string READ-ONLY
first_name string max:150 chars
last_name string max:150 chars
email string max:254 chars
username* string 1 to 150 chars
PATTERN:^[\w.@+-]+$
Required. 150 characters or fewer. Letters, digits and @/./
+/-/_ only.
full_name* string min:1 chars
account_type string READ-ONLY
standard, service_with_impersonation,
service_without_impersonation, device
cloud_space_right {
instant_social* enum ALLOWED:CLOUD_GUEST,
CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_tv* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN

56 of 352
 instant_booking* enum ALLOWED:CLOUD_GUEST,
CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_signage* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_metrics* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_device_manager* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
}
}
organizer* string min:1 chars
organizer_target* {
id integer READ-ONLY
uuid string READ-ONLY
first_name string max:150 chars
last_name string max:150 chars
email string max:254 chars
username* string 1 to 150 chars
PATTERN:^[\w.@+-]+$
Required. 150 characters or fewer. Letters, digits and @/./
+/-/_ only.
full_name* string min:1 chars
account_type string READ-ONLY
standard, service_with_impersonation,
service_without_impersonation, device
cloud_space_right {
instant_social* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_tv* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_booking* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_signage* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_metrics* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_device_manager* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
}
}
private* boolean
imputation_code string max:512 chars
is_recurring* boolean
conference_type_id string READ-ONLY
sensitivity enum ALLOWED:0, 1, 2, 3
has_moderation string READ-ONLY
demand_status* integer
logo string READ-ONLY

57 of 352
in_progress* boolean
teams_meeting_requested boolean READ-ONLY
visio_infos {
teams* {
Teams meeting join URLs

web_url* string min:1 chars

Web browser join URL
desktop_url* string min:1 chars
Desktop app join URL
deeplink_scheme* string min:1 chars
Deeplink scheme to join using a mobile app
}
zoom* {
Teams meeting join URLs

web_url* string min:1 chars

Web browser join URL
desktop_url* string min:1 chars
Desktop app join URL
deeplink_scheme* string min:1 chars
Deeplink scheme to join using a mobile app
}
webex* {
Teams meeting join URLs

web_url* string min:1 chars

Web browser join URL
desktop_url* string min:1 chars
Desktop app join URL
deeplink_scheme* string min:1 chars
Deeplink scheme to join using a mobile app
}
}
confirmed boolean READ-ONLY
finished* boolean
resourcemanagers* [{
Array of object:

resource* {
id integer READ-ONLY
name* string 1 to 512 chars
resource_allowed_reservation enum DEFAULT:1
ALLOWED:1, 5, 2, 3,
4
resource_type enum DEFAULT:1
ALLOWED:6, 7, 8, 9,
15, 34, 38, 39, 40,
41, 1, 2, 3, 11, 4,
5, 20, 23, 24, 25,
26, 29, 31, 32, 33,
35, 36, 12, 13, 19,
27, 10, 18, 21, 16,
17, 22, 14, 30, 28,
37, 42, 43, 44, 45,
46, 48, 49, 50, 51,
52, 53, 54, 55, 56,
57
capacity* integer >=0
address* {
company* string 1 to 100 chars
country* string max:100 chars

58 of 352
 city* string max:100 chars
site* string 1 to 100 chars
division string 1 to 100 chars
departement string max:50 chars
corporation string max:100 chars
building string max:50 chars
floor string max:50 chars
door string max:50 chars
number string max:30 chars
street_line1 string max:100 chars
street_line2 string max:100 chars
zipcode string max:5 chars
state string max:100 chars
cedex string max:100 chars
postal_box string max:20 chars
}
display_name string max:512 chars
alternate_room_name string max:512 chars
description string
contact_phone string max:100 chars
contact_email string max:254 chars
contact string max:512 chars
custom_contact_info string max:512 chars
sip_uri string min:1 chars
ip_address string min:1 chars
is_visible boolean
is_internal boolean
nb_participants_required boolean
is_custom_contact_info boolean
bms_zone string max:512 chars
site_code string max:512 chars
is_moderated boolean
book_horizon integer between 0 and
2147483647
DEFAULT:0
imputation_code boolean
imputation_code_label string max:512 chars
imputation_code_required boolean
requisitionable boolean
requisitionable_label string max:512 chars
vmr_num string max:512 chars
not_prm boolean
is_blind boolean
not_projector boolean
help_button_url string max:200 chars
min_booking_duration integer
max_booking_duration integer
isdn_number string min:1 chars
e164_number string min:1 chars
h323id string min:1 chars
room_phone_number string min:1 chars
status integer READ-ONLY
bookable boolean READ-ONLY
photo string READ-ONLY
photo_uuid string READ-ONLY
qrcode_url string READ-ONLY
QRCode URL pointing to Instant
Mobile resource page

59 of 352
qrcode_report_url string READ-ONLY
QRCode URL pointing to Instant
Mobile issue reporting page
calendar_processing {
instant_booking_mode enum ALLOWED:0,
1,
2
instant_booking_duration_1 integer between
-2147483648
and
2147483647
instant_booking_duration_2 integer between
-2147483648
and
2147483647
instant_booking_duration_step enum ALLOWED:5, 10,
15, 30, 45,
60
instant_booking_confirmation_required boolean
instant_booking_auth_required boolean
meeting_ack boolean
meeting_ack_start_time enum ALLOWED:0, 5,
10, 15, 30,
45, 60, 75,
90, 105,
120, 135,
150, 165,
180, 195,
210, 225,
240
meeting_ack_end_time enum ALLOWED:0, 5,
10, 15, 30,
45, 60, 75,
90, 105,
120, 135,
150, 165,
180, 195,
210, 225,
240
meeting_ack_confirmation_required boolean
meeting_ack_auth_required boolean
meeting_ack_auth_required_private_meetings boolean
meeting_ack_release boolean
meeting_ack_reminder boolean
extendable_meeting boolean
extendable_meeting_mode enum ALLOWED:0, 1
extend_meeting_duration_1 integer between
-2147483648
and
2147483647
extend_meeting_duration_2 integer between
-2147483648
and
2147483647
extend_meeting_duration_step enum ALLOWED:5, 10,
15, 30, 45,
60
meeting_ack_release_auth_required boolean
meeting_ack_release_auth_required_private_meetings boolean

60 of 352
 time_before_sensor_auto_release enum ALLOWED:4,
6,
8, 10, 12,
16, 20
apply_rights_book boolean
apply_rights_release boolean
apply_rights_confirm boolean
auto_release_force boolean
}
max_date_from_now string READ-ONLY
min:1 chars
max_resa_hours string READ-ONLY
min:1 chars
available boolean READ-ONLY
compounds integer READ-ONLY
default_name string READ-ONLY
min:1 chars
Display name or technical name
interop_calendaring_email string READ-ONLY
min:1 chars
interop_videoconferencing_email string READ-ONLY
min:1 chars
teams_meeting_enabled boolean READ-ONLY
first_linked_map {
First map where this resource is shown

id integer READ-ONLY
title string 1 to 512 chars
display_name string 1 to 512 chars
description string min:1 chars
floor_top integer
floor_bottom integer
display_type integer between -2147483648 and 2147483647
legend_display_type integer between -2147483648 and 2147483647
}
ordered_photos [string] min:1 chars
resource_tags [string]
service_offers [{
Array of object:

id* integer ID of the service offer

name* string min:1 chars
Name of the service offer
availability* enum ALLOWED:AVAILABLE, DISABLED, TOO_SHORT_NOTICE
Availability of this service based on the requested delivery time - Values:
`AVAILABLE` (This service offer is available), `DISABLED` (This service offer has
been disabled and is not currently available), `TOO_SHORT_NOTICE` (This service
offer requires a notice period and the requested delivery time is too close)
css_icon* string min:1 chars
CSS class of an icon symbolizing this service
}]
}
confirmed boolean
finished boolean
released boolean
release_reminded boolean
is_shadow boolean
answer enum ALLOWED:0, 1, 2, 3
nb_participants integer between -2147483648 and
2147483647
moderation enum ALLOWED:0, 1, 2
}]

61 of 352
 dial string READ-ONLY

org_pin string READ-ONLY

part_pin string READ-ONLY
}]
}

STATUS CODE - 400: Invalid parameters.

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

4.4 GET /bookings/default-time-slots/

Get suggested datetime ranges

REQUEST
No request parameters

RESPONSE

STATUS CODE - 200:

RESPONSE MODEL - application/json

{
nearest_slot* {
Nearest datetime range suited for the default meeting duration

start_datetime* string Start datetime

end_datetime* string End datetime
}
all_day* {
Nearest datetime range suited for the default meeting duration

start_datetime* string Start datetime

end_datetime* string End datetime
}
morning* {
Nearest datetime range suited for the default meeting duration

start_datetime* string Start datetime

end_datetime* string End datetime
}
afternoon* {
Nearest datetime range suited for the default meeting duration

start_datetime* string Start datetime

end_datetime* string End datetime
}
}

STATUS CODE - 400: Invalid parameters.

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

4.5 GET /bookings/progress-status/

Get booking progress status.

62 of 352
Get booking progress status.

This is needed when you create a simple booking on multiple days.As the creation is asynchronous,
you can query the booking creation status using comma-separated keys, gathered from the
booking creation endpoint.

REQUEST
QUERY PARAMETERS
NAME TYPE DESCRIPTION

page integer A page number within the paginated result set.

page_size integer Number of results to return per page.
*keys string Progress IDs
min:1 chars

RESPONSE

STATUS CODE - 200:

RESPONSE MODEL - application/json

{
keys* {
Progress IDs

}
}

STATUS CODE - 400: Invalid parameters.

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

4.6 GET /bookings/recurrences/

List and filter booking recurrences.

List and filter booking recurrences.

You can filter using a booking filter:

all: All bookings,

past: Only past bookings,
upcoming: Only upcoming bookings,
progress: Only bookings in progress.

You can filter by resource types, using comma-separated IDs,You can filter by resource IDs,You can
filter by date.You can filter your own bookings.

Private bookings will have their 'owner' and 'creator' set to null,and text fields set to a localized
'PRIVATE' label.

Bookings contains resource information through an object called ResourceManager.A

ResourceManager contains data by resource, like the status (finished, confirmed, released, etc.)

63 of 352
Warning: If enabled, the videoonline_booking_grid_info_display_low_security cloud propertywill allow
the display of non-private booking information, even if the authenticated user has no righton the
booking.

REQUEST
QUERY PARAMETERS
NAME TYPE DESCRIPTION

page integer A page number within the paginated result set.

page_size integer Number of results to return per page.
resource_types string Comma-separated list of numbers, e.g. `1,2,3`
min:1 chars
filter enum Booking filter
ALLOWED: all,
upcoming, progress,
upcoming_and_progress, past
resource_ids string Resource IDs (Comma-separated list of numbers, e.g.
min:1 chars `1,2,3`)
start_time date-time Start datetime (ISO-8601 : 1977-04-22T06:00:00Z)
end_time date-time End datetime (ISO-8601 : 1977-04-22T06:00:00Z)
resource_location string Filter on the location of the booked resources (JSON)

JSON format e.g. {"city": "Paris", "site": "Boulogne"}

Valid keys are: company, division, site, departement,
corporation, building, floor, door, number, street_line1,
street_line2, zipcode, city, state, cedex, postal_box,
country
include_delegation boolean Include the reservation I made for other or other made
for me

RESPONSE

STATUS CODE - 200:

RESPONSE MODEL - application/json

{
pagination* {
total_results integer
results_per_page integer
total_pages integer
current_page integer
previous_page integer
next_page integer
}
results* [{
Array of object:

id integer READ-ONLY
conf_id* string min:1 chars
start* string
end* string
last_update* string
duration* integer
title string 1 to 512 chars
is_valid* boolean

64 of 352
description string min:1 chars
comment string READ-ONLY
min:1 chars
from_application enum ALLOWED:0, 1, 2, 3, 4,
5, 6, 7, 8, 9, 10,
11, 12, 13, 14, 15,
16, 17
owner* {
id integer READ-ONLY
uuid string READ-ONLY
first_name string max:150 chars
last_name string max:150 chars
email string max:254 chars
username* string 1 to 150 chars
PATTERN:^[\w.@+-]+$
Required. 150 characters or fewer. Letters, digits and @/./
+/-/_ only.
full_name* string min:1 chars
account_type string READ-ONLY
standard, service_with_impersonation,
service_without_impersonation, device
cloud_space_right {
instant_social* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_tv* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_booking* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_signage* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_metrics* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_device_manager* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
}
}
creator* {
id integer READ-ONLY
uuid string READ-ONLY
first_name string max:150 chars
last_name string max:150 chars
email string max:254 chars
username* string 1 to 150 chars
PATTERN:^[\w.@+-]+$
Required. 150 characters or fewer. Letters, digits and @/./
+/-/_ only.
full_name* string min:1 chars
account_type string READ-ONLY
standard, service_with_impersonation,
service_without_impersonation, device
cloud_space_right {
instant_social* enum ALLOWED:CLOUD_GUEST,
CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,

65 of 352
 CLOUD_POWERUSER, CLOUD_ADMIN
instant_tv* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_booking* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_signage* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_metrics* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_device_manager* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
}
}
organizer* string min:1 chars
organizer_target* {
id integer READ-ONLY
uuid string READ-ONLY
first_name string max:150 chars
last_name string max:150 chars
email string max:254 chars
username* string 1 to 150 chars
PATTERN:^[\w.@+-]+$
Required. 150 characters or fewer. Letters, digits and @/./
+/-/_ only.
full_name* string min:1 chars
account_type string READ-ONLY
standard, service_with_impersonation,
service_without_impersonation, device
cloud_space_right {
instant_social* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_tv* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_booking* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_signage* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_metrics* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_device_manager* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
}
}
private* boolean
imputation_code string max:512 chars
is_recurring* boolean
conference_type_id string READ-ONLY

66 of 352
sensitivity enum ALLOWED:0, 1, 2, 3
has_moderation string READ-ONLY
demand_status* integer
logo string READ-ONLY
in_progress* boolean
teams_meeting_requested boolean READ-ONLY
visio_infos {
teams* {
Teams meeting join URLs

web_url* string min:1 chars

Web browser join URL
desktop_url* string min:1 chars
Desktop app join URL
deeplink_scheme* string min:1 chars
Deeplink scheme to join using a mobile app
}
zoom* {
Teams meeting join URLs

web_url* string min:1 chars

Web browser join URL
desktop_url* string min:1 chars
Desktop app join URL
deeplink_scheme* string min:1 chars
Deeplink scheme to join using a mobile app
}
webex* {
Teams meeting join URLs

web_url* string min:1 chars

Web browser join URL
desktop_url* string min:1 chars
Desktop app join URL
deeplink_scheme* string min:1 chars
Deeplink scheme to join using a mobile app
}
}
occurences_total_count* integer
occurences_remaining_count* integer
resources* [{
Array of object:

id integer READ-ONLY
name* string 1 to 512 chars
resource_allowed_reservation enum DEFAULT:1
ALLOWED:1, 5, 2, 3, 4
resource_type enum DEFAULT:1
ALLOWED:6, 7, 8, 9, 15,
34, 38, 39, 40, 41, 1,
2, 3, 11, 4, 5, 20,
23, 24, 25, 26, 29,
31, 32, 33, 35, 36,
12, 13, 19, 27, 10,
18, 21, 16, 17, 22,
14, 30, 28, 37, 42,
43, 44, 45, 46, 48,
49, 50, 51, 52, 53,
54, 55, 56, 57
capacity* integer >=0
address* {
company* string 1 to 100 chars

67 of 352
 country* string max:100 chars
city* string max:100 chars
site* string 1 to 100 chars
division string 1 to 100 chars
departement string max:50 chars
corporation string max:100 chars
building string max:50 chars
floor string max:50 chars
door string max:50 chars
number string max:30 chars
street_line1 string max:100 chars
street_line2 string max:100 chars
zipcode string max:5 chars
state string max:100 chars
cedex string max:100 chars
postal_box string max:20 chars
}
display_name string max:512 chars
alternate_room_name string max:512 chars
description string
contact_phone string max:100 chars
contact_email string max:254 chars
contact string max:512 chars
custom_contact_info string max:512 chars
sip_uri string min:1 chars
ip_address string min:1 chars
is_visible boolean
is_internal boolean
nb_participants_required boolean
is_custom_contact_info boolean
bms_zone string max:512 chars
site_code string max:512 chars
is_moderated boolean
book_horizon integer between 0 and
2147483647
DEFAULT:0
imputation_code boolean
imputation_code_label string max:512 chars
imputation_code_required boolean
requisitionable boolean
requisitionable_label string max:512 chars
vmr_num string max:512 chars
not_prm boolean
is_blind boolean
not_projector boolean
help_button_url string max:200 chars
min_booking_duration integer
max_booking_duration integer
isdn_number string min:1 chars
e164_number string min:1 chars
h323id string min:1 chars
room_phone_number string min:1 chars
status integer READ-ONLY
bookable boolean READ-ONLY
photo string READ-ONLY
photo_uuid string READ-ONLY
qrcode_url string READ-ONLY

68 of 352
 QRCode URL pointing to Instant
Mobile resource page
qrcode_report_url string READ-ONLY
QRCode URL pointing to Instant
Mobile issue reporting page
calendar_processing {
instant_booking_mode enum ALLOWED:0, 1, 2
instant_booking_duration_1 integer between
-2147483648 and
2147483647
instant_booking_duration_2 integer between
-2147483648 and
2147483647
instant_booking_duration_step enum ALLOWED:5, 10,
15, 30, 45, 60
instant_booking_confirmation_required boolean
instant_booking_auth_required boolean
meeting_ack boolean
meeting_ack_start_time enum ALLOWED:0, 5, 10,
15, 30, 45, 60,
75, 90, 105,
120, 135, 150,
165, 180, 195,
210, 225, 240
meeting_ack_end_time enum ALLOWED:0, 5, 10,
15, 30, 45, 60,
75, 90, 105,
120, 135, 150,
165, 180, 195,
210, 225, 240
meeting_ack_confirmation_required boolean
meeting_ack_auth_required boolean
meeting_ack_auth_required_private_meetings boolean
meeting_ack_release boolean
meeting_ack_reminder boolean
extendable_meeting boolean
extendable_meeting_mode enum ALLOWED:0, 1
extend_meeting_duration_1 integer between
-2147483648 and
2147483647
extend_meeting_duration_2 integer between
-2147483648 and
2147483647
extend_meeting_duration_step enum ALLOWED:5, 10,
15, 30, 45, 60
meeting_ack_release_auth_required boolean
meeting_ack_release_auth_required_private_meetings boolean
time_before_sensor_auto_release enum ALLOWED:4, 6, 8,
10, 12, 16, 20
apply_rights_book boolean
apply_rights_release boolean
apply_rights_confirm boolean
auto_release_force boolean
}
max_date_from_now string READ-ONLY
min:1 chars
max_resa_hours string READ-ONLY
min:1 chars

69 of 352
 available boolean READ-ONLY

compounds integer READ-ONLY

default_name string READ-ONLY
min:1 chars
Display name or technical name
interop_calendaring_email string READ-ONLY
min:1 chars
interop_videoconferencing_email string READ-ONLY
min:1 chars
teams_meeting_enabled boolean READ-ONLY
first_linked_map {
First map where this resource is shown

id integer READ-ONLY
title string 1 to 512 chars
display_name string 1 to 512 chars
description string min:1 chars
floor_top integer
floor_bottom integer
display_type integer between -2147483648 and 2147483647
legend_display_type integer between -2147483648 and 2147483647
}
ordered_photos [string] min:1 chars
resource_tags [string]
service_offers [{
Array of object:

id* integer ID of the service offer

name* string min:1 chars
Name of the service offer
availability* enum ALLOWED:AVAILABLE, DISABLED, TOO_SHORT_NOTICE
Availability of this service based on the requested delivery time - Values: `AVAILABLE`
(This service offer is available), `DISABLED` (This service offer has been disabled and is
not currently available), `TOO_SHORT_NOTICE` (This service offer requires a notice period
and the requested delivery time is too close)
css_icon* string min:1 chars
CSS class of an icon symbolizing this service
}]
}]
}]
}

STATUS CODE - 400: Invalid parameters.

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

4.7 GET /bookings/recurrences/{conf_rec_id}/

Get a single booking recurrence.

Get a booking recurrence from its ID.

Private bookings will have their 'owner' and 'creator' set to null,and text fields set to a localized
'PRIVATE' label.

Warning: If enabled, the videoonline_booking_grid_info_display_low_security cloud propertywill allow

the display of non-private booking information, even if the authenticated user has no righton the
booking.

70 of 352
REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*conf_rec_id string Booking Recurrence ID (e.g. IBr00001)

RESPONSE

STATUS CODE - 200:

RESPONSE MODEL - application/json

[{
Array of object:

id integer READ-ONLY
conf_id* string min:1 chars
start* string
end* string
last_update* string
duration* integer
title string 1 to 512 chars
is_valid* boolean
description string min:1 chars
comment string READ-ONLY
min:1 chars
from_application enum ALLOWED:0, 1, 2, 3, 4,
5, 6, 7, 8, 9, 10, 11,
12, 13, 14, 15, 16, 17
owner* {
id integer READ-ONLY
uuid string READ-ONLY
first_name string max:150 chars
last_name string max:150 chars
email string max:254 chars
username* string 1 to 150 chars
PATTERN:^[\w.@+-]+$
Required. 150 characters or fewer. Letters, digits and @/./+/-/_
only.
full_name* string min:1 chars
account_type string READ-ONLY
standard, service_with_impersonation,
service_without_impersonation, device
cloud_space_right {
instant_social* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_tv* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_booking* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_signage* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_metrics* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,

71 of 352
 CLOUD_POWERUSER, CLOUD_ADMIN
instant_device_manager* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
}
}
creator* {
id integer READ-ONLY
uuid string READ-ONLY
first_name string max:150 chars
last_name string max:150 chars
email string max:254 chars
username* string 1 to 150 chars
PATTERN:^[\w.@+-]+$
Required. 150 characters or fewer. Letters, digits and @/./+/-/_
only.
full_name* string min:1 chars
account_type string READ-ONLY
standard, service_with_impersonation,
service_without_impersonation, device
cloud_space_right {
instant_social* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_tv* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_booking* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_signage* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_metrics* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_device_manager* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
}
}
organizer* string min:1 chars
organizer_target* {
id integer READ-ONLY
uuid string READ-ONLY
first_name string max:150 chars
last_name string max:150 chars
email string max:254 chars
username* string 1 to 150 chars
PATTERN:^[\w.@+-]+$
Required. 150 characters or fewer. Letters, digits and @/./+/-/_
only.
full_name* string min:1 chars
account_type string READ-ONLY
standard, service_with_impersonation,
service_without_impersonation, device
cloud_space_right {
instant_social* enum ALLOWED:CLOUD_GUEST,
CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,

72 of 352
 CLOUD_POWERUSER, CLOUD_ADMIN
instant_tv* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_booking* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_signage* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_metrics* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_device_manager* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
}
}
private* boolean
imputation_code string max:512 chars
is_recurring* boolean
conference_type_id string READ-ONLY
sensitivity enum ALLOWED:0, 1, 2, 3
has_moderation string READ-ONLY
demand_status* integer
logo string READ-ONLY
in_progress* boolean
teams_meeting_requested boolean READ-ONLY
visio_infos {
teams* {
Teams meeting join URLs

web_url* string min:1 chars

Web browser join URL
desktop_url* string min:1 chars
Desktop app join URL
deeplink_scheme* string min:1 chars
Deeplink scheme to join using a mobile app
}
zoom* {
Teams meeting join URLs

web_url* string min:1 chars

Web browser join URL
desktop_url* string min:1 chars
Desktop app join URL
deeplink_scheme* string min:1 chars
Deeplink scheme to join using a mobile app
}
webex* {
Teams meeting join URLs

web_url* string min:1 chars

Web browser join URL
desktop_url* string min:1 chars
Desktop app join URL
deeplink_scheme* string min:1 chars
Deeplink scheme to join using a mobile app
}
}
occurences_total_count* integer

73 of 352
occurences_remaining_count* integer
resources* [{
Array of object:

id integer READ-ONLY
name* string 1 to 512 chars
resource_allowed_reservation enum DEFAULT:1
ALLOWED:1, 5, 2, 3, 4
resource_type enum DEFAULT:1
ALLOWED:6, 7, 8, 9, 15, 34,
38, 39, 40, 41, 1, 2, 3,
11, 4, 5, 20, 23, 24, 25,
26, 29, 31, 32, 33, 35,
36, 12, 13, 19, 27, 10,
18, 21, 16, 17, 22, 14,
30, 28, 37, 42, 43, 44,
45, 46, 48, 49, 50, 51,
52, 53, 54, 55, 56, 57
capacity* integer >=0
address* {
company* string 1 to 100 chars
country* string max:100 chars
city* string max:100 chars
site* string 1 to 100 chars
division string 1 to 100 chars
departement string max:50 chars
corporation string max:100 chars
building string max:50 chars
floor string max:50 chars
door string max:50 chars
number string max:30 chars
street_line1 string max:100 chars
street_line2 string max:100 chars
zipcode string max:5 chars
state string max:100 chars
cedex string max:100 chars
postal_box string max:20 chars
}
display_name string max:512 chars
alternate_room_name string max:512 chars
description string
contact_phone string max:100 chars
contact_email string max:254 chars
contact string max:512 chars
custom_contact_info string max:512 chars
sip_uri string min:1 chars
ip_address string min:1 chars
is_visible boolean
is_internal boolean
nb_participants_required boolean
is_custom_contact_info boolean
bms_zone string max:512 chars
site_code string max:512 chars
is_moderated boolean
book_horizon integer between 0 and 2147483647
DEFAULT:0
imputation_code boolean
imputation_code_label string max:512 chars

74 of 352
imputation_code_required boolean
requisitionable boolean
requisitionable_label string max:512 chars
vmr_num string max:512 chars
not_prm boolean
is_blind boolean
not_projector boolean
help_button_url string max:200 chars
min_booking_duration integer
max_booking_duration integer
isdn_number string min:1 chars
e164_number string min:1 chars
h323id string min:1 chars
room_phone_number string min:1 chars
status integer READ-ONLY
bookable boolean READ-ONLY
photo string READ-ONLY
photo_uuid string READ-ONLY
qrcode_url string READ-ONLY
QRCode URL pointing to Instant Mobile
resource page
qrcode_report_url string READ-ONLY
QRCode URL pointing to Instant Mobile
issue reporting page
calendar_processing {
instant_booking_mode enum ALLOWED:0, 1, 2
instant_booking_duration_1 integer between
-2147483648 and
2147483647
instant_booking_duration_2 integer between
-2147483648 and
2147483647
instant_booking_duration_step enum ALLOWED:5, 10, 15,
30, 45, 60
instant_booking_confirmation_required boolean
instant_booking_auth_required boolean
meeting_ack boolean
meeting_ack_start_time enum ALLOWED:0, 5, 10,
15, 30, 45, 60,
75, 90, 105, 120,
135, 150, 165,
180, 195, 210,
225, 240
meeting_ack_end_time enum ALLOWED:0, 5, 10,
15, 30, 45, 60,
75, 90, 105, 120,
135, 150, 165,
180, 195, 210,
225, 240
meeting_ack_confirmation_required boolean
meeting_ack_auth_required boolean
meeting_ack_auth_required_private_meetings boolean
meeting_ack_release boolean
meeting_ack_reminder boolean
extendable_meeting boolean
extendable_meeting_mode enum ALLOWED:0, 1
extend_meeting_duration_1 integer between
-2147483648 and

75 of 352
 2147483647
extend_meeting_duration_2 integer between
-2147483648 and
2147483647
extend_meeting_duration_step enum ALLOWED:5, 10, 15,
30, 45, 60
meeting_ack_release_auth_required boolean
meeting_ack_release_auth_required_private_meetings boolean
time_before_sensor_auto_release enum ALLOWED:4, 6, 8, 10,
12, 16, 20
apply_rights_book boolean
apply_rights_release boolean
apply_rights_confirm boolean
auto_release_force boolean
}
max_date_from_now string READ-ONLY
min:1 chars
max_resa_hours string READ-ONLY
min:1 chars
available boolean READ-ONLY
compounds integer READ-ONLY
default_name string READ-ONLY
min:1 chars
Display name or technical name
interop_calendaring_email string READ-ONLY
min:1 chars
interop_videoconferencing_email string READ-ONLY
min:1 chars
teams_meeting_enabled boolean READ-ONLY
first_linked_map {
First map where this resource is shown

id integer READ-ONLY
title string 1 to 512 chars
display_name string 1 to 512 chars
description string min:1 chars
floor_top integer
floor_bottom integer
display_type integer between -2147483648 and 2147483647
legend_display_type integer between -2147483648 and 2147483647
}
ordered_photos [string] min:1 chars
resource_tags [string]
service_offers [{
Array of object:

id* integer ID of the service offer

name* string min:1 chars
Name of the service offer
availability* enum ALLOWED:AVAILABLE, DISABLED, TOO_SHORT_NOTICE
Availability of this service based on the requested delivery time - Values: `AVAILABLE` (This
service offer is available), `DISABLED` (This service offer has been disabled and is not
currently available), `TOO_SHORT_NOTICE` (This service offer requires a notice period and the
requested delivery time is too close)
css_icon* string min:1 chars
CSS class of an icon symbolizing this service
}]
}]
}]

STATUS CODE - 400: Invalid parameters.

76 of 352
 STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

4.8 GET /bookings/{conf_id}/

Get a single booking.

Get a booking from its ID.

Private bookings will have their 'owner' and 'creator' set to null,and text fields set to a localized
'PRIVATE' label.

Warning: If enabled, the videoonline_booking_grid_info_display_low_security cloud propertywill allow

the display of non-private booking information, even if the authenticated user has no righton the
booking.

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*conf_id string Booking ID (e.g. IB00001)

RESPONSE

STATUS CODE - 200:

RESPONSE MODEL - application/json

{
id integer READ-ONLY
conf_id* string min:1 chars
start* string
end* string
last_update* string
duration* integer
title* string 1 to 512 chars
is_valid* boolean
description string
comment string READ-ONLY
min:1 chars
from_application enum ALLOWED:0, 1, 2, 3, 4,
5, 6, 7, 8, 9, 10, 11,
12, 13, 14, 15, 16, 17
owner* {
id integer READ-ONLY
uuid string READ-ONLY
first_name string max:150 chars
last_name string max:150 chars
email string max:254 chars
username* string 1 to 150 chars
PATTERN:^[\w.@+-]+$
Required. 150 characters or fewer. Letters, digits and @/./+/-/_
only.
full_name* string min:1 chars

77 of 352
 account_type string READ-ONLY
standard, service_with_impersonation,
service_without_impersonation, device
cloud_space_right {
instant_social* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_tv* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_booking* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_signage* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_metrics* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_device_manager* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
}
}
creator* {
id integer READ-ONLY
uuid string READ-ONLY
first_name string max:150 chars
last_name string max:150 chars
email string max:254 chars
username* string 1 to 150 chars
PATTERN:^[\w.@+-]+$
Required. 150 characters or fewer. Letters, digits and @/./+/-/_
only.
full_name* string min:1 chars
account_type string READ-ONLY
standard, service_with_impersonation,
service_without_impersonation, device
cloud_space_right {
instant_social* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_tv* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_booking* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_signage* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_metrics* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_device_manager* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
}
}

78 of 352
organizer* string min:1 chars
organizer_target* {
id integer READ-ONLY
uuid string READ-ONLY
first_name string max:150 chars
last_name string max:150 chars
email string max:254 chars
username* string 1 to 150 chars
PATTERN:^[\w.@+-]+$
Required. 150 characters or fewer. Letters, digits and @/./+/-/_
only.
full_name* string min:1 chars
account_type string READ-ONLY
standard, service_with_impersonation,
service_without_impersonation, device
cloud_space_right {
instant_social* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_tv* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_booking* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_signage* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_metrics* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_device_manager* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
}
}
private* boolean
imputation_code string max:512 chars
is_recurring* boolean
conference_type_id string READ-ONLY
sensitivity enum ALLOWED:0, 1, 2, 3
has_moderation string READ-ONLY
demand_status* integer
logo string READ-ONLY
in_progress* boolean
teams_meeting_requested boolean READ-ONLY
visio_infos {
teams* {
Teams meeting join URLs

web_url* string min:1 chars

Web browser join URL
desktop_url* string min:1 chars
Desktop app join URL
deeplink_scheme* string min:1 chars
Deeplink scheme to join using a mobile app
}
zoom* {
Teams meeting join URLs

79 of 352
 web_url* string min:1 chars
Web browser join URL
desktop_url* string min:1 chars
Desktop app join URL
deeplink_scheme* string min:1 chars
Deeplink scheme to join using a mobile app
}
webex* {
Teams meeting join URLs

web_url* string min:1 chars

Web browser join URL
desktop_url* string min:1 chars
Desktop app join URL
deeplink_scheme* string min:1 chars
Deeplink scheme to join using a mobile app
}
}
confirmed boolean READ-ONLY
finished* boolean
resourcemanagers* [{
Array of object:

resource* {
id integer READ-ONLY
name* string 1 to 512 chars
resource_allowed_reservation enum DEFAULT:1
ALLOWED:1, 5, 2, 3, 4
resource_type enum DEFAULT:1
ALLOWED:6, 7, 8, 9, 15,
34, 38, 39, 40, 41, 1,
2, 3, 11, 4, 5, 20,
23, 24, 25, 26, 29,
31, 32, 33, 35, 36,
12, 13, 19, 27, 10,
18, 21, 16, 17, 22,
14, 30, 28, 37, 42,
43, 44, 45, 46, 48,
49, 50, 51, 52, 53,
54, 55, 56, 57
capacity* integer >=0
address* {
company* string 1 to 100 chars
country* string max:100 chars
city* string max:100 chars
site* string 1 to 100 chars
division string 1 to 100 chars
departement string max:50 chars
corporation string max:100 chars
building string max:50 chars
floor string max:50 chars
door string max:50 chars
number string max:30 chars
street_line1 string max:100 chars
street_line2 string max:100 chars
zipcode string max:5 chars
state string max:100 chars
cedex string max:100 chars
postal_box string max:20 chars
}

80 of 352
display_name string max:512 chars
alternate_room_name string max:512 chars
description string
contact_phone string max:100 chars
contact_email string max:254 chars
contact string max:512 chars
custom_contact_info string max:512 chars
sip_uri string min:1 chars
ip_address string min:1 chars
is_visible boolean
is_internal boolean
nb_participants_required boolean
is_custom_contact_info boolean
bms_zone string max:512 chars
site_code string max:512 chars
is_moderated boolean
book_horizon integer between 0 and
2147483647
DEFAULT:0
imputation_code boolean
imputation_code_label string max:512 chars
imputation_code_required boolean
requisitionable boolean
requisitionable_label string max:512 chars
vmr_num string max:512 chars
not_prm boolean
is_blind boolean
not_projector boolean
help_button_url string max:200 chars
min_booking_duration integer
max_booking_duration integer
isdn_number string min:1 chars
e164_number string min:1 chars
h323id string min:1 chars
room_phone_number string min:1 chars
status integer READ-ONLY
bookable boolean READ-ONLY
photo string READ-ONLY
photo_uuid string READ-ONLY
qrcode_url string READ-ONLY
QRCode URL pointing to Instant
Mobile resource page
qrcode_report_url string READ-ONLY
QRCode URL pointing to Instant
Mobile issue reporting page
calendar_processing {
instant_booking_mode enum ALLOWED:0, 1, 2
instant_booking_duration_1 integer between
-2147483648 and
2147483647
instant_booking_duration_2 integer between
-2147483648 and
2147483647
instant_booking_duration_step enum ALLOWED:5, 10,
15, 30, 45, 60
instant_booking_confirmation_required boolean
instant_booking_auth_required boolean
meeting_ack boolean

81 of 352
 meeting_ack_start_time enum ALLOWED:0, 5, 10,
15, 30, 45, 60,
75, 90, 105,
120, 135, 150,
165, 180, 195,
210, 225, 240
meeting_ack_end_time enum ALLOWED:0, 5, 10,
15, 30, 45, 60,
75, 90, 105,
120, 135, 150,
165, 180, 195,
210, 225, 240
meeting_ack_confirmation_required boolean
meeting_ack_auth_required boolean
meeting_ack_auth_required_private_meetings boolean
meeting_ack_release boolean
meeting_ack_reminder boolean
extendable_meeting boolean
extendable_meeting_mode enum ALLOWED:0, 1
extend_meeting_duration_1 integer between
-2147483648 and
2147483647
extend_meeting_duration_2 integer between
-2147483648 and
2147483647
extend_meeting_duration_step enum ALLOWED:5, 10,
15, 30, 45, 60
meeting_ack_release_auth_required boolean
meeting_ack_release_auth_required_private_meetings boolean
time_before_sensor_auto_release enum ALLOWED:4, 6, 8,
10, 12, 16, 20
apply_rights_book boolean
apply_rights_release boolean
apply_rights_confirm boolean
auto_release_force boolean
}
max_date_from_now string READ-ONLY
min:1 chars
max_resa_hours string READ-ONLY
min:1 chars
available boolean READ-ONLY
compounds integer READ-ONLY
default_name string READ-ONLY
min:1 chars
Display name or technical name
interop_calendaring_email string READ-ONLY
min:1 chars
interop_videoconferencing_email string READ-ONLY
min:1 chars
teams_meeting_enabled boolean READ-ONLY
first_linked_map {
First map where this resource is shown

id integer READ-ONLY
title string 1 to 512 chars
display_name string 1 to 512 chars
description string min:1 chars
floor_top integer
floor_bottom integer

82 of 352
 display_type integer between -2147483648 and 2147483647
legend_display_type integer between -2147483648 and 2147483647
}
ordered_photos [string] min:1 chars
resource_tags [string]
service_offers [{
Array of object:

id* integer ID of the service offer

name* string min:1 chars
Name of the service offer
availability* enum ALLOWED:AVAILABLE, DISABLED, TOO_SHORT_NOTICE
Availability of this service based on the requested delivery time - Values: `AVAILABLE`
(This service offer is available), `DISABLED` (This service offer has been disabled and is
not currently available), `TOO_SHORT_NOTICE` (This service offer requires a notice period
and the requested delivery time is too close)
css_icon* string min:1 chars
CSS class of an icon symbolizing this service
}]
}
confirmed boolean
finished boolean
released boolean
release_reminded boolean
is_shadow boolean
answer enum ALLOWED:0, 1, 2, 3
nb_participants integer between -2147483648 and
2147483647
moderation enum ALLOWED:0, 1, 2
}]
dial string READ-ONLY
org_pin string READ-ONLY
part_pin string READ-ONLY
}

STATUS CODE - 400: Invalid parameters.

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

STATUS CODE - 404: Booking not found

4.9 PUT /bookings/{conf_id}/

Update a specific booking.

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*conf_id string Booking ID (e.g. IB00001)

RESPONSE

STATUS CODE - 200:

RESPONSE MODEL - application/json

83 of 352
{
creation_status* enum ALLOWED:CREATED, IN_PROGRESS
Creation status
progress [string] min:1 chars
Progress ID
booking {
id integer READ-ONLY
conf_id* string min:1 chars
start* string
end* string
last_update* string
duration* integer
title* string 1 to 512 chars
is_valid* boolean
description string
comment string READ-ONLY
min:1 chars
from_application enum ALLOWED:0, 1, 2, 3, 4,
5, 6, 7, 8, 9, 10,
11, 12, 13, 14, 15,
16, 17
owner* {
id integer READ-ONLY
uuid string READ-ONLY
first_name string max:150 chars
last_name string max:150 chars
email string max:254 chars
username* string 1 to 150 chars
PATTERN:^[\w.@+-]+$
Required. 150 characters or fewer. Letters, digits and @/./
+/-/_ only.
full_name* string min:1 chars
account_type string READ-ONLY
standard, service_with_impersonation,
service_without_impersonation, device
cloud_space_right {
instant_social* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_tv* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_booking* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_signage* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_metrics* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_device_manager* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
}
}
creator* {
id integer READ-ONLY

84 of 352
 uuid string READ-ONLY

first_name string max:150 chars

last_name string max:150 chars
email string max:254 chars
username* string 1 to 150 chars
PATTERN:^[\w.@+-]+$
Required. 150 characters or fewer. Letters, digits and @/./
+/-/_ only.
full_name* string min:1 chars
account_type string READ-ONLY
standard, service_with_impersonation,
service_without_impersonation, device
cloud_space_right {
instant_social* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_tv* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_booking* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_signage* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_metrics* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_device_manager* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
}
}
organizer* string min:1 chars
organizer_target* {
id integer READ-ONLY
uuid string READ-ONLY
first_name string max:150 chars
last_name string max:150 chars
email string max:254 chars
username* string 1 to 150 chars
PATTERN:^[\w.@+-]+$
Required. 150 characters or fewer. Letters, digits and @/./
+/-/_ only.
full_name* string min:1 chars
account_type string READ-ONLY
standard, service_with_impersonation,
service_without_impersonation, device
cloud_space_right {
instant_social* enum ALLOWED:CLOUD_GUEST,
CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_tv* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_booking* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_signage* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,

85 of 352
 CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_metrics* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_device_manager* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
}
}
private* boolean
imputation_code string max:512 chars
is_recurring* boolean
conference_type_id string READ-ONLY
sensitivity enum ALLOWED:0, 1, 2, 3
has_moderation string READ-ONLY
demand_status* integer
logo string READ-ONLY
in_progress* boolean
teams_meeting_requested boolean READ-ONLY
visio_infos {
teams* {
Teams meeting join URLs

web_url* string min:1 chars

Web browser join URL
desktop_url* string min:1 chars
Desktop app join URL
deeplink_scheme* string min:1 chars
Deeplink scheme to join using a mobile app
}
zoom* {
Teams meeting join URLs

web_url* string min:1 chars

Web browser join URL
desktop_url* string min:1 chars
Desktop app join URL
deeplink_scheme* string min:1 chars
Deeplink scheme to join using a mobile app
}
webex* {
Teams meeting join URLs

web_url* string min:1 chars

Web browser join URL
desktop_url* string min:1 chars
Desktop app join URL
deeplink_scheme* string min:1 chars
Deeplink scheme to join using a mobile app
}
}
confirmed boolean READ-ONLY
finished* boolean
resourcemanagers* [{
Array of object:

resource* {
id integer READ-ONLY
name* string 1 to 512 chars
resource_allowed_reservation enum DEFAULT:1
ALLOWED:1, 5, 2, 3,

86 of 352
 4
resource_type enum DEFAULT:1
ALLOWED:6,
7, 8, 9,
15, 34, 38, 39, 40,
41, 1, 2, 3, 11, 4,
5, 20, 23, 24, 25,
26, 29, 31, 32, 33,
35, 36, 12, 13, 19,
27, 10, 18, 21, 16,
17, 22, 14, 30, 28,
37, 42, 43, 44, 45,
46, 48, 49, 50, 51,
52, 53, 54, 55, 56,
57
capacity* integer >=0
address* {
company* string 1 to 100 chars
country* string max:100 chars
city* string max:100 chars
site* string 1 to 100 chars
division string 1 to 100 chars
departement string max:50 chars
corporation string max:100 chars
building string max:50 chars
floor string max:50 chars
door string max:50 chars
number string max:30 chars
street_line1 string max:100 chars
street_line2 string max:100 chars
zipcode string max:5 chars
state string max:100 chars
cedex string max:100 chars
postal_box string max:20 chars
}
display_name string max:512 chars
alternate_room_name string max:512 chars
description string
contact_phone string max:100 chars
contact_email string max:254 chars
contact string max:512 chars
custom_contact_info string max:512 chars
sip_uri string min:1 chars
ip_address string min:1 chars
is_visible boolean
is_internal boolean
nb_participants_required boolean
is_custom_contact_info boolean
bms_zone string max:512 chars
site_code string max:512 chars
is_moderated boolean
book_horizon integer between 0 and
2147483647
DEFAULT:0
imputation_code boolean
imputation_code_label string max:512 chars
imputation_code_required boolean
requisitionable boolean

87 of 352
requisitionable_label string max:512 chars
vmr_num string max:512 chars
not_prm boolean
is_blind boolean
not_projector boolean
help_button_url string max:200 chars
min_booking_duration integer
max_booking_duration integer
isdn_number string min:1 chars
e164_number string min:1 chars
h323id string min:1 chars
room_phone_number string min:1 chars
status integer READ-ONLY
bookable boolean READ-ONLY
photo string READ-ONLY
photo_uuid string READ-ONLY
qrcode_url string READ-ONLY
QRCode URL pointing to Instant
Mobile resource page
qrcode_report_url string READ-ONLY
QRCode URL pointing to Instant
Mobile issue reporting page
calendar_processing {
instant_booking_mode enum ALLOWED:0, 1,
2
instant_booking_duration_1 integer between
-2147483648
and
2147483647
instant_booking_duration_2 integer between
-2147483648
and
2147483647
instant_booking_duration_step enum ALLOWED:5, 10,
15, 30, 45,
60
instant_booking_confirmation_required boolean
instant_booking_auth_required boolean
meeting_ack boolean
meeting_ack_start_time enum ALLOWED:0, 5,
10, 15, 30,
45, 60, 75,
90, 105,
120, 135,
150, 165,
180, 195,
210, 225,
240
meeting_ack_end_time enum ALLOWED:0, 5,
10, 15, 30,
45, 60, 75,
90, 105,
120, 135,
150, 165,
180, 195,
210, 225,
240
meeting_ack_confirmation_required boolean

88 of 352
 meeting_ack_auth_required boolean
meeting_ack_auth_required_private_meetings boolean
meeting_ack_release boolean
meeting_ack_reminder boolean
extendable_meeting boolean
extendable_meeting_mode enum ALLOWED:0, 1
extend_meeting_duration_1 integer between
-2147483648
and
2147483647
extend_meeting_duration_2 integer between
-2147483648
and
2147483647
extend_meeting_duration_step enum ALLOWED:5, 10,
15, 30, 45,
60
meeting_ack_release_auth_required boolean
meeting_ack_release_auth_required_private_meetings boolean
time_before_sensor_auto_release enum ALLOWED:4, 6,
8, 10, 12,
16, 20
apply_rights_book boolean
apply_rights_release boolean
apply_rights_confirm boolean
auto_release_force boolean
}
max_date_from_now string READ-ONLY
min:1 chars
max_resa_hours string READ-ONLY
min:1 chars
available boolean READ-ONLY
compounds integer READ-ONLY
default_name string READ-ONLY
min:1 chars
Display name or technical name
interop_calendaring_email string READ-ONLY
min:1 chars
interop_videoconferencing_email string READ-ONLY
min:1 chars
teams_meeting_enabled boolean READ-ONLY
first_linked_map {
First map where this resource is shown

id integer READ-ONLY
title string 1 to 512 chars
display_name string 1 to 512 chars
description string min:1 chars
floor_top integer
floor_bottom integer
display_type integer between -2147483648 and 2147483647
legend_display_type integer between -2147483648 and 2147483647
}
ordered_photos [string] min:1 chars
resource_tags [string]
service_offers [{
Array of object:

id* integer ID of the service offer

name* string min:1 chars

89 of 352
 Name of the service offer
availability* enum ALLOWED:AVAILABLE, DISABLED, TOO_SHORT_NOTICE
Availability of this service based on the requested delivery time - Values:
`AVAILABLE` (This service offer is available), `DISABLED` (This service offer has
been disabled and is not currently available), `TOO_SHORT_NOTICE` (This service
offer requires a notice period and the requested delivery time is too close)
css_icon* string min:1 chars
CSS class of an icon symbolizing this service
}]
}
confirmed boolean
finished boolean
released boolean
release_reminded boolean
is_shadow boolean
answer enum ALLOWED:0, 1, 2, 3
nb_participants integer between -2147483648 and
2147483647
moderation enum ALLOWED:0, 1, 2
}]
dial string READ-ONLY
org_pin string READ-ONLY
part_pin string READ-ONLY
}
}

STATUS CODE - 400: Invalid parameters.

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

4.10 DELETE /bookings/{conf_id}/

Cancel a specific booking.

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*conf_id string Booking ID (e.g. IB00001)

RESPONSE

STATUS CODE - 204: Success

STATUS CODE - 400: Invalid parameters.

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

STATUS CODE - 404: Booking not found

4.11 PUT /bookings/{conf_id}/confirm/{resource_id}/

Confirm a specific meeting for a specific resource.

90 of 352
REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*conf_id string Booking ID (e.g. IB00001)

*resource_id integer Resource ID (e.g. 1)

QUERY PARAMETERS
NAME TYPE DESCRIPTION

user_token string Delegation token

min:1 chars

RESPONSE

STATUS CODE - 204: Success

STATUS CODE - 400: Invalid parameters.

STATUS CODE - 401: Delegation authentication required from a device

STATUS CODE - 403: Reservation is private

STATUS CODE - 404: Booking not found

STATUS CODE - 400 (code invalid_confirmation): Confirmation error

4.12 PUT /bookings/{conf_id}/extend/{duration}/

Extend a specific meeting.

Extend a specific meeting. Note that service and device accounts have the right to extend any
meeting,standard accounts can only extend they have created.

The duration is in minutes.

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*conf_id string Booking ID (e.g. IB00001)

*duration integer Duration in minutes (e.g. 15)

RESPONSE

STATUS CODE - 200:

RESPONSE MODEL - application/json

{
id integer READ-ONLY
conf_id* string min:1 chars
start* string

91 of 352
end* string
last_update* string
duration* integer
title* string 1 to 512 chars
is_valid* boolean
description string
comment string READ-ONLY
min:1 chars
from_application enum ALLOWED:0, 1, 2, 3, 4,
5, 6, 7, 8, 9, 10, 11,
12, 13, 14, 15, 16, 17
owner* {
id integer READ-ONLY
uuid string READ-ONLY
first_name string max:150 chars
last_name string max:150 chars
email string max:254 chars
username* string 1 to 150 chars
PATTERN:^[\w.@+-]+$
Required. 150 characters or fewer. Letters, digits and @/./+/-/_
only.
full_name* string min:1 chars
account_type string READ-ONLY
standard, service_with_impersonation,
service_without_impersonation, device
cloud_space_right {
instant_social* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_tv* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_booking* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_signage* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_metrics* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_device_manager* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
}
}
creator* {
id integer READ-ONLY
uuid string READ-ONLY
first_name string max:150 chars
last_name string max:150 chars
email string max:254 chars
username* string 1 to 150 chars
PATTERN:^[\w.@+-]+$
Required. 150 characters or fewer. Letters, digits and @/./+/-/_
only.
full_name* string min:1 chars
account_type string READ-ONLY
standard, service_with_impersonation,

92 of 352
 service_without_impersonation, device
cloud_space_right {
instant_social* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_tv* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_booking* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_signage* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_metrics* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_device_manager* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
}
}
organizer* string min:1 chars
organizer_target* {
id integer READ-ONLY
uuid string READ-ONLY
first_name string max:150 chars
last_name string max:150 chars
email string max:254 chars
username* string 1 to 150 chars
PATTERN:^[\w.@+-]+$
Required. 150 characters or fewer. Letters, digits and @/./+/-/_
only.
full_name* string min:1 chars
account_type string READ-ONLY
standard, service_with_impersonation,
service_without_impersonation, device
cloud_space_right {
instant_social* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_tv* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_booking* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_signage* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_metrics* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_device_manager* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
}
}

93 of 352
private* boolean
imputation_code string max:512 chars
is_recurring* boolean
conference_type_id string READ-ONLY
sensitivity enum ALLOWED:0, 1, 2, 3
has_moderation string READ-ONLY
demand_status* integer
logo string READ-ONLY
in_progress* boolean
teams_meeting_requested boolean READ-ONLY
visio_infos {
teams* {
Teams meeting join URLs

web_url* string min:1 chars

Web browser join URL
desktop_url* string min:1 chars
Desktop app join URL
deeplink_scheme* string min:1 chars
Deeplink scheme to join using a mobile app
}
zoom* {
Teams meeting join URLs

web_url* string min:1 chars

Web browser join URL
desktop_url* string min:1 chars
Desktop app join URL
deeplink_scheme* string min:1 chars
Deeplink scheme to join using a mobile app
}
webex* {
Teams meeting join URLs

web_url* string min:1 chars

Web browser join URL
desktop_url* string min:1 chars
Desktop app join URL
deeplink_scheme* string min:1 chars
Deeplink scheme to join using a mobile app
}
}
confirmed boolean READ-ONLY
finished* boolean
resourcemanagers* [{
Array of object:

resource* {
id integer READ-ONLY
name* string 1 to 512 chars
resource_allowed_reservation enum DEFAULT:1
ALLOWED:1, 5, 2, 3, 4
resource_type enum DEFAULT:1
ALLOWED:6, 7, 8, 9, 15,
34, 38, 39, 40, 41, 1,
2, 3, 11, 4, 5, 20,
23, 24, 25, 26, 29,
31, 32, 33, 35, 36,
12, 13, 19, 27, 10,
18, 21, 16, 17, 22,
14, 30, 28, 37, 42,
43, 44, 45, 46, 48,

94 of 352
 49, 50, 51, 52, 53,
54, 55, 56, 57
capacity* integer >=0
address* {
company* string 1 to 100 chars
country* string max:100 chars
city* string max:100 chars
site* string 1 to 100 chars
division string 1 to 100 chars
departement string max:50 chars
corporation string max:100 chars
building string max:50 chars
floor string max:50 chars
door string max:50 chars
number string max:30 chars
street_line1 string max:100 chars
street_line2 string max:100 chars
zipcode string max:5 chars
state string max:100 chars
cedex string max:100 chars
postal_box string max:20 chars
}
display_name string max:512 chars
alternate_room_name string max:512 chars
description string
contact_phone string max:100 chars
contact_email string max:254 chars
contact string max:512 chars
custom_contact_info string max:512 chars
sip_uri string min:1 chars
ip_address string min:1 chars
is_visible boolean
is_internal boolean
nb_participants_required boolean
is_custom_contact_info boolean
bms_zone string max:512 chars
site_code string max:512 chars
is_moderated boolean
book_horizon integer between 0 and
2147483647
DEFAULT:0
imputation_code boolean
imputation_code_label string max:512 chars
imputation_code_required boolean
requisitionable boolean
requisitionable_label string max:512 chars
vmr_num string max:512 chars
not_prm boolean
is_blind boolean
not_projector boolean
help_button_url string max:200 chars
min_booking_duration integer
max_booking_duration integer
isdn_number string min:1 chars
e164_number string min:1 chars
h323id string min:1 chars
room_phone_number string min:1 chars

95 of 352
status integer READ-ONLY

bookable boolean READ-ONLY

photo string READ-ONLY
photo_uuid string READ-ONLY
qrcode_url string READ-ONLY
QRCode URL pointing to Instant
Mobile resource page
qrcode_report_url string READ-ONLY
QRCode URL pointing to Instant
Mobile issue reporting page
calendar_processing {
instant_booking_mode enum ALLOWED:0, 1, 2
instant_booking_duration_1 integer between
-2147483648 and
2147483647
instant_booking_duration_2 integer between
-2147483648 and
2147483647
instant_booking_duration_step enum ALLOWED:5, 10,
15, 30, 45, 60
instant_booking_confirmation_required boolean
instant_booking_auth_required boolean
meeting_ack boolean
meeting_ack_start_time enum ALLOWED:0, 5, 10,
15, 30, 45, 60,
75, 90, 105,
120, 135, 150,
165, 180, 195,
210, 225, 240
meeting_ack_end_time enum ALLOWED:0, 5, 10,
15, 30, 45, 60,
75, 90, 105,
120, 135, 150,
165, 180, 195,
210, 225, 240
meeting_ack_confirmation_required boolean
meeting_ack_auth_required boolean
meeting_ack_auth_required_private_meetings boolean
meeting_ack_release boolean
meeting_ack_reminder boolean
extendable_meeting boolean
extendable_meeting_mode enum ALLOWED:0, 1
extend_meeting_duration_1 integer between
-2147483648 and
2147483647
extend_meeting_duration_2 integer between
-2147483648 and
2147483647
extend_meeting_duration_step enum ALLOWED:5, 10,
15, 30, 45, 60
meeting_ack_release_auth_required boolean
meeting_ack_release_auth_required_private_meetings boolean
time_before_sensor_auto_release enum ALLOWED:4, 6, 8,
10, 12, 16, 20
apply_rights_book boolean
apply_rights_release boolean
apply_rights_confirm boolean
auto_release_force boolean

96 of 352
 }
max_date_from_now string READ-ONLY
min:1 chars
max_resa_hours string READ-ONLY
min:1 chars
available boolean READ-ONLY
compounds integer READ-ONLY
default_name string READ-ONLY
min:1 chars
Display name or technical name
interop_calendaring_email string READ-ONLY
min:1 chars
interop_videoconferencing_email string READ-ONLY
min:1 chars
teams_meeting_enabled boolean READ-ONLY
first_linked_map {
First map where this resource is shown

id integer READ-ONLY
title string 1 to 512 chars
display_name string 1 to 512 chars
description string min:1 chars
floor_top integer
floor_bottom integer
display_type integer between -2147483648 and 2147483647
legend_display_type integer between -2147483648 and 2147483647
}
ordered_photos [string] min:1 chars
resource_tags [string]
service_offers [{
Array of object:

id* integer ID of the service offer

name* string min:1 chars
Name of the service offer
availability* enum ALLOWED:AVAILABLE, DISABLED, TOO_SHORT_NOTICE
Availability of this service based on the requested delivery time - Values: `AVAILABLE`
(This service offer is available), `DISABLED` (This service offer has been disabled and is
not currently available), `TOO_SHORT_NOTICE` (This service offer requires a notice period
and the requested delivery time is too close)
css_icon* string min:1 chars
CSS class of an icon symbolizing this service
}]
}
confirmed boolean
finished boolean
released boolean
release_reminded boolean
is_shadow boolean
answer enum ALLOWED:0, 1, 2, 3
nb_participants integer between -2147483648 and
2147483647
moderation enum ALLOWED:0, 1, 2
}]
dial string READ-ONLY
org_pin string READ-ONLY
part_pin string READ-ONLY
}

STATUS CODE - 400: Invalid parameters.

97 of 352
 STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

STATUS CODE - 404: Booking not found

4.13 PUT /bookings/{conf_id}/release/{resource_id}/

Release a specific resource from a specific booking.

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*conf_id string Booking ID (e.g. IB00001)

*resource_id integer Resource ID (e.g. 1)

QUERY PARAMETERS
NAME TYPE DESCRIPTION

user_token string Delegation token

min:1 chars

RESPONSE

STATUS CODE - 200:

RESPONSE MODEL - application/json

{
id integer READ-ONLY
conf_id* string min:1 chars
start* string
end* string
last_update* string
duration* integer
title* string 1 to 512 chars
is_valid* boolean
description string
comment string READ-ONLY
min:1 chars
from_application enum ALLOWED:0, 1, 2, 3, 4,
5, 6, 7, 8, 9, 10, 11,
12, 13, 14, 15, 16, 17
owner* {
id integer READ-ONLY
uuid string READ-ONLY
first_name string max:150 chars
last_name string max:150 chars
email string max:254 chars
username* string 1 to 150 chars
PATTERN:^[\w.@+-]+$
Required. 150 characters or fewer. Letters, digits and @/./+/-/_
only.
full_name* string min:1 chars

98 of 352
 account_type string READ-ONLY
standard, service_with_impersonation,
service_without_impersonation, device
cloud_space_right {
instant_social* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_tv* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_booking* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_signage* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_metrics* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_device_manager* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
}
}
creator* {
id integer READ-ONLY
uuid string READ-ONLY
first_name string max:150 chars
last_name string max:150 chars
email string max:254 chars
username* string 1 to 150 chars
PATTERN:^[\w.@+-]+$
Required. 150 characters or fewer. Letters, digits and @/./+/-/_
only.
full_name* string min:1 chars
account_type string READ-ONLY
standard, service_with_impersonation,
service_without_impersonation, device
cloud_space_right {
instant_social* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_tv* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_booking* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_signage* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_metrics* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_device_manager* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
}
}

99 of 352
organizer* string min:1 chars
organizer_target* {
id integer READ-ONLY
uuid string READ-ONLY
first_name string max:150 chars
last_name string max:150 chars
email string max:254 chars
username* string 1 to 150 chars
PATTERN:^[\w.@+-]+$
Required. 150 characters or fewer. Letters, digits and @/./+/-/_
only.
full_name* string min:1 chars
account_type string READ-ONLY
standard, service_with_impersonation,
service_without_impersonation, device
cloud_space_right {
instant_social* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_tv* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_booking* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_signage* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_metrics* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_device_manager* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
}
}
private* boolean
imputation_code string max:512 chars
is_recurring* boolean
conference_type_id string READ-ONLY
sensitivity enum ALLOWED:0, 1, 2, 3
has_moderation string READ-ONLY
demand_status* integer
logo string READ-ONLY
in_progress* boolean
teams_meeting_requested boolean READ-ONLY
visio_infos {
teams* {
Teams meeting join URLs

web_url* string min:1 chars

Web browser join URL
desktop_url* string min:1 chars
Desktop app join URL
deeplink_scheme* string min:1 chars
Deeplink scheme to join using a mobile app
}
zoom* {
Teams meeting join URLs

100 of 352
 web_url* string min:1 chars
Web browser join URL
desktop_url* string min:1 chars
Desktop app join URL
deeplink_scheme* string min:1 chars
Deeplink scheme to join using a mobile app
}
webex* {
Teams meeting join URLs

web_url* string min:1 chars

Web browser join URL
desktop_url* string min:1 chars
Desktop app join URL
deeplink_scheme* string min:1 chars
Deeplink scheme to join using a mobile app
}
}
confirmed boolean READ-ONLY
finished* boolean
resourcemanagers* [{
Array of object:

resource* {
id integer READ-ONLY
name* string 1 to 512 chars
resource_allowed_reservation enum DEFAULT:1
ALLOWED:1, 5, 2, 3, 4
resource_type enum DEFAULT:1
ALLOWED:6, 7, 8, 9, 15,
34, 38, 39, 40, 41, 1,
2, 3, 11, 4, 5, 20,
23, 24, 25, 26, 29,
31, 32, 33, 35, 36,
12, 13, 19, 27, 10,
18, 21, 16, 17, 22,
14, 30, 28, 37, 42,
43, 44, 45, 46, 48,
49, 50, 51, 52, 53,
54, 55, 56, 57
capacity* integer >=0
address* {
company* string 1 to 100 chars
country* string max:100 chars
city* string max:100 chars
site* string 1 to 100 chars
division string 1 to 100 chars
departement string max:50 chars
corporation string max:100 chars
building string max:50 chars
floor string max:50 chars
door string max:50 chars
number string max:30 chars
street_line1 string max:100 chars
street_line2 string max:100 chars
zipcode string max:5 chars
state string max:100 chars
cedex string max:100 chars
postal_box string max:20 chars
}

101 of 352
display_name string max:512 chars
alternate_room_name string max:512 chars
description string
contact_phone string max:100 chars
contact_email string max:254 chars
contact string max:512 chars
custom_contact_info string max:512 chars
sip_uri string min:1 chars
ip_address string min:1 chars
is_visible boolean
is_internal boolean
nb_participants_required boolean
is_custom_contact_info boolean
bms_zone string max:512 chars
site_code string max:512 chars
is_moderated boolean
book_horizon integer between 0 and
2147483647
DEFAULT:0
imputation_code boolean
imputation_code_label string max:512 chars
imputation_code_required boolean
requisitionable boolean
requisitionable_label string max:512 chars
vmr_num string max:512 chars
not_prm boolean
is_blind boolean
not_projector boolean
help_button_url string max:200 chars
min_booking_duration integer
max_booking_duration integer
isdn_number string min:1 chars
e164_number string min:1 chars
h323id string min:1 chars
room_phone_number string min:1 chars
status integer READ-ONLY
bookable boolean READ-ONLY
photo string READ-ONLY
photo_uuid string READ-ONLY
qrcode_url string READ-ONLY
QRCode URL pointing to Instant
Mobile resource page
qrcode_report_url string READ-ONLY
QRCode URL pointing to Instant
Mobile issue reporting page
calendar_processing {
instant_booking_mode enum ALLOWED:0, 1, 2
instant_booking_duration_1 integer between
-2147483648 and
2147483647
instant_booking_duration_2 integer between
-2147483648 and
2147483647
instant_booking_duration_step enum ALLOWED:5, 10,
15, 30, 45, 60
instant_booking_confirmation_required boolean
instant_booking_auth_required boolean
meeting_ack boolean

102 of 352
 meeting_ack_start_time enum ALLOWED:0, 5, 10,
15, 30, 45, 60,
75, 90, 105,
120, 135, 150,
165, 180, 195,
210, 225, 240
meeting_ack_end_time enum ALLOWED:0, 5, 10,
15, 30, 45, 60,
75, 90, 105,
120, 135, 150,
165, 180, 195,
210, 225, 240
meeting_ack_confirmation_required boolean
meeting_ack_auth_required boolean
meeting_ack_auth_required_private_meetings boolean
meeting_ack_release boolean
meeting_ack_reminder boolean
extendable_meeting boolean
extendable_meeting_mode enum ALLOWED:0, 1
extend_meeting_duration_1 integer between
-2147483648 and
2147483647
extend_meeting_duration_2 integer between
-2147483648 and
2147483647
extend_meeting_duration_step enum ALLOWED:5, 10,
15, 30, 45, 60
meeting_ack_release_auth_required boolean
meeting_ack_release_auth_required_private_meetings boolean
time_before_sensor_auto_release enum ALLOWED:4, 6, 8,
10, 12, 16, 20
apply_rights_book boolean
apply_rights_release boolean
apply_rights_confirm boolean
auto_release_force boolean
}
max_date_from_now string READ-ONLY
min:1 chars
max_resa_hours string READ-ONLY
min:1 chars
available boolean READ-ONLY
compounds integer READ-ONLY
default_name string READ-ONLY
min:1 chars
Display name or technical name
interop_calendaring_email string READ-ONLY
min:1 chars
interop_videoconferencing_email string READ-ONLY
min:1 chars
teams_meeting_enabled boolean READ-ONLY
first_linked_map {
First map where this resource is shown

id integer READ-ONLY
title string 1 to 512 chars
display_name string 1 to 512 chars
description string min:1 chars
floor_top integer
floor_bottom integer

103 of 352
 display_type integer between -2147483648 and 2147483647
legend_display_type integer between -2147483648 and 2147483647
}
ordered_photos [string] min:1 chars
resource_tags [string]
service_offers [{
Array of object:

id* integer ID of the service offer

name* string min:1 chars
Name of the service offer
availability* enum ALLOWED:AVAILABLE, DISABLED, TOO_SHORT_NOTICE
Availability of this service based on the requested delivery time - Values: `AVAILABLE`
(This service offer is available), `DISABLED` (This service offer has been disabled and is
not currently available), `TOO_SHORT_NOTICE` (This service offer requires a notice period
and the requested delivery time is too close)
css_icon* string min:1 chars
CSS class of an icon symbolizing this service
}]
}
confirmed boolean
finished boolean
released boolean
release_reminded boolean
is_shadow boolean
answer enum ALLOWED:0, 1, 2, 3
nb_participants integer between -2147483648 and
2147483647
moderation enum ALLOWED:0, 1, 2
}]
dial string READ-ONLY
org_pin string READ-ONLY
part_pin string READ-ONLY
}

STATUS CODE - 400: Invalid parameters.

STATUS CODE - 401: Delegation authentication required from a device

STATUS CODE - 403: Reservation is private

STATUS CODE - 404: Booking not found

104 of 352
5. EVENTS

5.1 GET /events/

List cloud events.

List cloud events when configured to be stored in database

This endpoint needs a privileged access and can be used to query event information for reporting.

REQUEST
QUERY PARAMETERS
NAME TYPE DESCRIPTION

page integer A page number within the paginated result set.

page_size integer Number of results to return per page.

RESPONSE

STATUS CODE - 200:

RESPONSE MODEL - application/json

{
pagination* {
total_results integer
results_per_page integer
total_pages integer
current_page integer
previous_page integer
next_page integer
}
results* [{
Array of object:

id* string Event UUID

type* string 1 to 255 chars
Event Type
source* string min:1 chars
Event Source
time* string Event Time
data* {
Event Data

}
}]
}

5.2 GET /events/types/

List cloud event types.

List cloud event types available.

105 of 352
This endpoint needs a privileged access and can be used to query event information for reporting.

REQUEST
No request parameters

RESPONSE

STATUS CODE - 200:

RESPONSE MODEL - application/json

[{
Array of object:

name* string min:1 chars

Event type name
description* string min:1 chars
Event type description
}]

STATUS CODE - 400: Invalid parameters.

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

106 of 352
6. FOLDS

6.1 POST /folds/

Create fold.

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*ref string Fold ID (e.g. PC00001)

RESPONSE

STATUS CODE - 200:

RESPONSE MODEL - application/json

{
reference string READ-ONLY
min:1 chars
owner {
id integer READ-ONLY
uuid string READ-ONLY
first_name string max:150 chars
last_name string max:150 chars
email string max:254 chars
username* string 1 to 150 chars
PATTERN:^[\w.@+-]+$
Required. 150 characters or fewer. Letters, digits and @/./+/-/_
only.
full_name* string min:1 chars
account_type string READ-ONLY
standard, service_with_impersonation,
service_without_impersonation, device
cloud_space_right {
instant_social* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_tv* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_booking* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_signage* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_metrics* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_device_manager* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN

107 of 352
 }
}
type enum ALLOWED:0, 1
action enum ALLOWED:0, 1
sender_user {
id integer READ-ONLY
uuid string READ-ONLY
first_name string max:150 chars
last_name string max:150 chars
email string max:254 chars
username* string 1 to 150 chars
PATTERN:^[\w.@+-]+$
Required. 150 characters or fewer. Letters, digits and @/./+/-/_
only.
full_name* string min:1 chars
account_type string READ-ONLY
standard, service_with_impersonation,
service_without_impersonation, device
cloud_space_right {
instant_social* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_tv* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_booking* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_signage* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_metrics* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_device_manager* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
}
}
sender* string 1 to 512 chars
sender_addr* string 1 to 512 chars
recipient_user {
id integer READ-ONLY
uuid string READ-ONLY
first_name string max:150 chars
last_name string max:150 chars
email string max:254 chars
username* string 1 to 150 chars
PATTERN:^[\w.@+-]+$
Required. 150 characters or fewer. Letters, digits and @/./+/-/_
only.
full_name* string min:1 chars
account_type string READ-ONLY
standard, service_with_impersonation,
service_without_impersonation, device
cloud_space_right {
instant_social* enum ALLOWED:CLOUD_GUEST,
CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN

108 of 352
 instant_tv* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_booking* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_signage* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_metrics* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_device_manager* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
}
}
recipient* string 1 to 512 chars
recipient_addr* string 1 to 512 chars
in_charge_user {
id integer READ-ONLY
uuid string READ-ONLY
first_name string max:150 chars
last_name string max:150 chars
email string max:254 chars
username* string 1 to 150 chars
PATTERN:^[\w.@+-]+$
Required. 150 characters or fewer. Letters, digits and @/./+/-/_
only.
full_name* string min:1 chars
account_type string READ-ONLY
standard, service_with_impersonation,
service_without_impersonation, device
cloud_space_right {
instant_social* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_tv* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_booking* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_signage* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_metrics* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_device_manager* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
}
}
in_charge* string 1 to 512 chars
in_charge_date string
comments string min:1 chars
entity* string 1 to 512 chars

109 of 352
delivered_user {
id integer READ-ONLY
uuid string READ-ONLY
first_name string max:150 chars
last_name string max:150 chars
email string max:254 chars
username* string 1 to 150 chars
PATTERN:^[\w.@+-]+$
Required. 150 characters or fewer. Letters, digits and @/./+/-/_
only.
full_name* string min:1 chars
account_type string READ-ONLY
standard, service_with_impersonation,
service_without_impersonation, device
cloud_space_right {
instant_social* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_tv* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_booking* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_signage* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_metrics* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_device_manager* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
}
}
delivered_date string
delivered boolean
guest_point {
id integer READ-ONLY
title* string 1 to 512 chars
display_name* string 1 to 512 chars
default_name string READ-ONLY
min:1 chars
Display name or technical name
address {
company* string 1 to 100 chars
country* string max:100 chars
city* string max:100 chars
site* string 1 to 100 chars
division string 1 to 100 chars
departement string max:50 chars
corporation string max:100 chars
building string max:50 chars
floor string max:50 chars
door string max:50 chars
number string max:30 chars
street_line1 string max:100 chars
street_line2 string max:100 chars

110 of 352
 zipcode string max:5 chars
state string max:100 chars
cedex string max:100 chars
postal_box string max:20 chars
}
owner integer
email string max:254 chars
phone string max:512 chars
description string
mail_bundles* [{
Array of object:

bundle {
id integer READ-ONLY
key* string 1 to 1024 chars
display_name* string 1 to 1024 chars
is_default boolean
is_system boolean
}
content_type {
id integer READ-ONLY
app_label* string 1 to 100 chars
model* string 1 to 100 chars
}
object_id integer between 0 and 2147483647
}]
add_guest_list_iframe_url string READ-ONLY
guest_point_url_badges string READ-ONLY
guest_point_url_folds string READ-ONLY
has_local_admin_right boolean READ-ONLY
guest_badge_display* integer Usage rules for badges.0 - Do not display or use badges.1 - Display badges but
don't require them for checkin.2 - Badges are also required for check-in.
enable_folds_view boolean READ-ONLY
enable_temp_badge_view boolean READ-ONLY
}
date_pub_added string READ-ONLY
date_pub_lastmodified string READ-ONLY
}

STATUS CODE - 400: Invalid parameters.

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

6.2 GET /folds/{ref}/

Retrieve fold from its ID.

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*ref string Fold ID (e.g. PC00001)

RESPONSE

111 of 352
STATUS CODE - 200:

RESPONSE MODEL - application/json

{
reference string READ-ONLY
min:1 chars
owner {
id integer READ-ONLY
uuid string READ-ONLY
first_name string max:150 chars
last_name string max:150 chars
email string max:254 chars
username* string 1 to 150 chars
PATTERN:^[\w.@+-]+$
Required. 150 characters or fewer. Letters, digits and @/./+/-/_
only.
full_name* string min:1 chars
account_type string READ-ONLY
standard, service_with_impersonation,
service_without_impersonation, device
cloud_space_right {
instant_social* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_tv* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_booking* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_signage* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_metrics* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_device_manager* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
}
}
type enum ALLOWED:0, 1
action enum ALLOWED:0, 1
sender_user {
id integer READ-ONLY
uuid string READ-ONLY
first_name string max:150 chars
last_name string max:150 chars
email string max:254 chars
username* string 1 to 150 chars
PATTERN:^[\w.@+-]+$
Required. 150 characters or fewer. Letters, digits and @/./+/-/_
only.
full_name* string min:1 chars
account_type string READ-ONLY
standard, service_with_impersonation,
service_without_impersonation, device
cloud_space_right {
instant_social* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,

112 of 352
 CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_tv* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_booking* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_signage* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_metrics* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_device_manager* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
}
}
sender* string 1 to 512 chars
sender_addr* string 1 to 512 chars
recipient_user {
id integer READ-ONLY
uuid string READ-ONLY
first_name string max:150 chars
last_name string max:150 chars
email string max:254 chars
username* string 1 to 150 chars
PATTERN:^[\w.@+-]+$
Required. 150 characters or fewer. Letters, digits and @/./+/-/_
only.
full_name* string min:1 chars
account_type string READ-ONLY
standard, service_with_impersonation,
service_without_impersonation, device
cloud_space_right {
instant_social* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_tv* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_booking* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_signage* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_metrics* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_device_manager* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
}
}
recipient* string 1 to 512 chars
recipient_addr* string 1 to 512 chars

113 of 352
in_charge_user {
id integer READ-ONLY
uuid string READ-ONLY
first_name string max:150 chars
last_name string max:150 chars
email string max:254 chars
username* string 1 to 150 chars
PATTERN:^[\w.@+-]+$
Required. 150 characters or fewer. Letters, digits and @/./+/-/_
only.
full_name* string min:1 chars
account_type string READ-ONLY
standard, service_with_impersonation,
service_without_impersonation, device
cloud_space_right {
instant_social* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_tv* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_booking* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_signage* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_metrics* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_device_manager* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
}
}
in_charge* string 1 to 512 chars
in_charge_date string
comments string min:1 chars
entity* string 1 to 512 chars
delivered_user {
id integer READ-ONLY
uuid string READ-ONLY
first_name string max:150 chars
last_name string max:150 chars
email string max:254 chars
username* string 1 to 150 chars
PATTERN:^[\w.@+-]+$
Required. 150 characters or fewer. Letters, digits and @/./+/-/_
only.
full_name* string min:1 chars
account_type string READ-ONLY
standard, service_with_impersonation,
service_without_impersonation, device
cloud_space_right {
instant_social* enum ALLOWED:CLOUD_GUEST,
CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_tv* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,

114 of 352
 CLOUD_POWERUSER, CLOUD_ADMIN
instant_booking* enum
ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_signage* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_metrics* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_device_manager* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
}
}
delivered_date string
delivered boolean
guest_point {
id integer READ-ONLY
title* string 1 to 512 chars
display_name* string 1 to 512 chars
default_name string READ-ONLY
min:1 chars
Display name or technical name
address {
company* string 1 to 100 chars
country* string max:100 chars
city* string max:100 chars
site* string 1 to 100 chars
division string 1 to 100 chars
departement string max:50 chars
corporation string max:100 chars
building string max:50 chars
floor string max:50 chars
door string max:50 chars
number string max:30 chars
street_line1 string max:100 chars
street_line2 string max:100 chars
zipcode string max:5 chars
state string max:100 chars
cedex string max:100 chars
postal_box string max:20 chars
}
owner integer
email string max:254 chars
phone string max:512 chars
description string
mail_bundles* [{
Array of object:

bundle {
id integer READ-ONLY
key* string 1 to 1024 chars
display_name* string 1 to 1024 chars
is_default boolean
is_system boolean
}
content_type {

115 of 352
 id integer READ-ONLY
app_label* string 1 to 100 chars
model* string 1 to 100 chars
}
object_id integer between 0 and 2147483647
}]
add_guest_list_iframe_url string READ-ONLY
guest_point_url_badges string READ-ONLY
guest_point_url_folds string READ-ONLY
has_local_admin_right boolean READ-ONLY
guest_badge_display* integer Usage rules for badges.0 - Do not display or use badges.1 - Display badges but
don't require them for checkin.2 - Badges are also required for check-in.
enable_folds_view boolean READ-ONLY
enable_temp_badge_view boolean READ-ONLY
}
date_pub_added string READ-ONLY
date_pub_lastmodified string READ-ONLY
}

STATUS CODE - 400: Invalid parameters.

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

6.3 PUT /folds/{ref}/

Update fold.

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*ref string Fold ID (e.g. PC00001)

RESPONSE

STATUS CODE - 200:

RESPONSE MODEL - application/json

{
reference string READ-ONLY
min:1 chars
owner {
id integer READ-ONLY
uuid string READ-ONLY
first_name string max:150 chars
last_name string max:150 chars
email string max:254 chars
username* string 1 to 150 chars
PATTERN:^[\w.@+-]+$
Required. 150 characters or fewer. Letters, digits and @/./+/-/_
only.
full_name* string min:1 chars
account_type string READ-ONLY
standard, service_with_impersonation,

116 of 352
 service_without_impersonation, device
cloud_space_right {
instant_social* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_tv* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_booking* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_signage* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_metrics* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_device_manager* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
}
}
type enum ALLOWED:0, 1
action enum ALLOWED:0, 1
sender_user {
id integer READ-ONLY
uuid string READ-ONLY
first_name string max:150 chars
last_name string max:150 chars
email string max:254 chars
username* string 1 to 150 chars
PATTERN:^[\w.@+-]+$
Required. 150 characters or fewer. Letters, digits and @/./+/-/_
only.
full_name* string min:1 chars
account_type string READ-ONLY
standard, service_with_impersonation,
service_without_impersonation, device
cloud_space_right {
instant_social* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_tv* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_booking* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_signage* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_metrics* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_device_manager* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
}

117 of 352
}
sender* string 1 to 512 chars
sender_addr* string 1 to 512 chars
recipient_user {
id integer READ-ONLY
uuid string READ-ONLY
first_name string max:150 chars
last_name string max:150 chars
email string max:254 chars
username* string 1 to 150 chars
PATTERN:^[\w.@+-]+$
Required. 150 characters or fewer. Letters, digits and @/./+/-/_
only.
full_name* string min:1 chars
account_type string READ-ONLY
standard, service_with_impersonation,
service_without_impersonation, device
cloud_space_right {
instant_social* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_tv* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_booking* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_signage* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_metrics* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_device_manager* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
}
}
recipient* string 1 to 512 chars
recipient_addr* string 1 to 512 chars
in_charge_user {
id integer READ-ONLY
uuid string READ-ONLY
first_name string max:150 chars
last_name string max:150 chars
email string max:254 chars
username* string 1 to 150 chars
PATTERN:^[\w.@+-]+$
Required. 150 characters or fewer. Letters, digits and @/./+/-/_
only.
full_name* string min:1 chars
account_type string READ-ONLY
standard, service_with_impersonation,
service_without_impersonation, device
cloud_space_right {
instant_social* enum ALLOWED:CLOUD_GUEST,
CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_tv* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,

118 of 352
 CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_booking* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_signage* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_metrics* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_device_manager* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
}
}
in_charge* string 1 to 512 chars
in_charge_date string
comments string min:1 chars
entity* string 1 to 512 chars
delivered_user {
id integer READ-ONLY
uuid string READ-ONLY
first_name string max:150 chars
last_name string max:150 chars
email string max:254 chars
username* string 1 to 150 chars
PATTERN:^[\w.@+-]+$
Required. 150 characters or fewer. Letters, digits and @/./+/-/_
only.
full_name* string min:1 chars
account_type string READ-ONLY
standard, service_with_impersonation,
service_without_impersonation, device
cloud_space_right {
instant_social* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_tv* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_booking* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_signage* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_metrics* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_device_manager* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
}
}
delivered_date string
delivered boolean
guest_point {

119 of 352
 id integer READ-ONLY
title* string 1 to 512 chars
display_name* string 1 to 512 chars
default_name string READ-ONLY
min:1 chars
Display name or technical name
address {
company* string 1 to 100 chars
country* string max:100 chars
city* string max:100 chars
site* string 1 to 100 chars
division string 1 to 100 chars
departement string max:50 chars
corporation string max:100 chars
building string max:50 chars
floor string max:50 chars
door string max:50 chars
number string max:30 chars
street_line1 string max:100 chars
street_line2 string max:100 chars
zipcode string max:5 chars
state string max:100 chars
cedex string max:100 chars
postal_box string max:20 chars
}
owner integer
email string max:254 chars
phone string max:512 chars
description string
mail_bundles* [{
Array of object:

bundle {
id integer READ-ONLY
key* string 1 to 1024 chars
display_name* string 1 to 1024 chars
is_default boolean
is_system boolean
}
content_type {
id integer READ-ONLY
app_label* string 1 to 100 chars
model* string 1 to 100 chars
}
object_id integer between 0 and 2147483647
}]
add_guest_list_iframe_url string READ-ONLY
guest_point_url_badges string READ-ONLY
guest_point_url_folds string READ-ONLY
has_local_admin_right boolean READ-ONLY
guest_badge_display* integer Usage rules for badges.0 - Do not display or use badges.1 - Display badges but
don't require them for checkin.2 - Badges are also required for check-in.
enable_folds_view boolean READ-ONLY
enable_temp_badge_view boolean READ-ONLY
}
date_pub_added string READ-ONLY
date_pub_lastmodified string READ-ONLY
}

120 of 352
STATUS CODE - 400: Invalid parameters.

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

121 of 352
7. GROUPS

7.1 GET /groups/

List the activated groups in IB.

This end-point is restricted to cloud_user, cloud_admin and cloud_poweruser usage.Cloud_user can

only list his own groups.

REQUEST
QUERY PARAMETERS
NAME TYPE DESCRIPTION

query string
min:1 chars
exclude_ids string Comma-separated list of numbers, e.g. `1,2,3`
min:1 chars
only_mine boolean For cloud_poweruser and cloud_admin only.
If true, only return the groups of the current user.
tag_name string
min:1 chars

RESPONSE

STATUS CODE - 200:

RESPONSE MODEL - application/json

[{
Array of object:

id* integer
name* string min:1 chars
slug_name* string min:1 chars
tags* [{
Array of object:

id integer
label string min:1 chars
}]
}]

STATUS CODE - 400: Invalid parameters.

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

7.2 POST /groups/

Create a new group in IB.

This end-point is restricted to cloud_admin and cloud_poweruser usage.

122 of 352
REQUEST
REQUEST BODY - application/json
{
name* string min:1 chars
tags* [string] min:1 chars
}

RESPONSE

STATUS CODE - 200:

RESPONSE MODEL - application/json

{
id* integer
name* string min:1 chars
slug_name* string min:1 chars
tags* [{
Array of object:

id integer
label string min:1 chars
}]
}

STATUS CODE - 400: Invalid parameters.

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

STATUS CODE - 409: Group already exisit

7.3 GET /groups/{id}/

Get a single group.

Get a group from its ID.

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*id integer Group ID (e.g. 4)

RESPONSE

STATUS CODE - 200:

RESPONSE MODEL - application/json

{
id* integer
name* string min:1 chars
slug_name string READ-ONLY
min:1 chars
PATTERN:^[-a-zA-Z0-9_]+$
tags* [string] min:1 chars

123 of 352
 users* [{
Array of object:

id integer READ-ONLY
first_name string max:150 chars
last_name string max:150 chars
email string max:254 chars
full_name* string min:1 chars
}]
}

STATUS CODE - 400: Invalid parameters.

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

STATUS CODE - 404: Group not found

7.4 PUT /groups/{id}/add-user/{user_id}/

Add a user to the specified group.

This end-point is restricted to cloud_admin and cloud_poweruser usage.

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*id integer Group ID (e.g. 4)

*user_id string

RESPONSE

STATUS CODE - 200: User added

STATUS CODE - 400: Invalid parameters.

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

STATUS CODE - 404: Group or User not found

124 of 352
8. GUEST-LISTS

8.1 GET /guest-lists/

List and filter your guest lists.

List and filter guest lists where you are the owner.

You can filter using a guest list filter:

all: All guest lists,

past: Only past guest lists,
current: Upcoming guest lists and guest lists in progress.

REQUEST
QUERY PARAMETERS
NAME TYPE DESCRIPTION

page integer A page number within the paginated result set.

page_size integer Number of results to return per page.
filter_type enum Filter type
ALLOWED: all, current,
past
ordering enum
ALLOWED:
created_on, -
created_on, start, -
start
guest_point_id integer Guest point ID to filter guest lists
guest_point_location string Filter on the location of the guest point

JSON format e.g. {"city": "Paris", "site": "Boulogne"}

Valid keys are: company, division, site, departement,
corporation, building, floor, door, number, street_line1,
street_line2, zipcode, city, state, cedex, postal_box, country
include_referrer_filter boolean Set to true to get the guest list where I am only a referrer
start_time date-time Start datetime (ISO-8601 : 1977-04-22T06:00:00Z). It will not
be used if filter_type is set.
end_time date-time End datetime (ISO-8601 : 1977-04-22T06:00:00Z). It will not
be used if filter_type is set.
guest_member_id integer Filter guest list that contains a given member

RESPONSE

STATUS CODE - 200:

RESPONSE MODEL - application/json

{
pagination* {
total_results integer

125 of 352
 results_per_page integer
total_pages integer
current_page integer
previous_page integer
next_page integer
}
results* [{
Array of object:

id integer READ-ONLY
reference string READ-ONLY
min:1 chars
title* string 1 to 512 chars
owner {
id integer READ-ONLY
uuid string READ-ONLY
first_name string max:150 chars
last_name string max:150 chars
email string max:254 chars
username* string 1 to 150 chars
PATTERN:^[\w.@+-]+$
Required. 150 characters or fewer. Letters, digits and @/./
+/-/_ only.
full_name* string min:1 chars
account_type string READ-ONLY
standard, service_with_impersonation,
service_without_impersonation, device
cloud_space_right {
instant_social* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_tv* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_booking* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_signage* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_metrics* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_device_manager* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
}
}
guest_point {
id integer READ-ONLY
title* string 1 to 512 chars
display_name* string 1 to 512 chars
default_name string READ-ONLY
min:1 chars
Display name or technical name
address {
company* string 1 to 100 chars
country* string max:100 chars
city* string max:100 chars

126 of 352
 site* string 1 to 100 chars
division string 1 to 100 chars
departement string max:50 chars
corporation string max:100 chars
building string max:50 chars
floor string max:50 chars
door string max:50 chars
number string max:30 chars
street_line1 string max:100 chars
street_line2 string max:100 chars
zipcode string max:5 chars
state string max:100 chars
cedex string max:100 chars
postal_box string max:20 chars
}
owner integer
email string max:254 chars
phone string max:512 chars
description string
mail_bundles* [{
Array of object:

bundle {
id integer READ-ONLY
key* string 1 to 1024 chars
display_name* string 1 to 1024 chars
is_default boolean
is_system boolean
}
content_type {
id integer READ-ONLY
app_label* string 1 to 100 chars
model* string 1 to 100 chars
}
object_id integer between 0 and 2147483647
}]
add_guest_list_iframe_url string READ-ONLY
guest_point_url_badges string READ-ONLY
guest_point_url_folds string READ-ONLY
has_local_admin_right boolean READ-ONLY
guest_badge_display* integer Usage rules for badges.0 - Do not display or use badges.1 - Display
badges but don't require them for checkin.2 - Badges are also required for
check-in.
enable_folds_view boolean READ-ONLY
enable_temp_badge_view boolean READ-ONLY
}
start string READ-ONLY
end string READ-ONLY
members [{
Array of object:

id integer READ-ONLY
first_name* string 1 to 150 chars
last_name* string 1 to 150 chars
full_name string READ-ONLY
email string max:254 chars
phone string max:150 chars
company string max:150 chars
guest_type enum ALLOWED:0, 1
type string READ-ONLY

127 of 352
 min:1 chars
visibility enum ALLOWED:0, 1
status enum ALLOWED:0, 1, 2, 3
declaration_origin enum ALLOWED:0, 1, 2
badge_free* string 1 to 512 chars
date_checkin string
date_checkout string
observations string
}]
description string
nb_members integer between -2147483648 and
2147483647
primary_referrer* {
user {
id integer READ-ONLY
uuid string READ-ONLY
first_name string max:150 chars
last_name string max:150 chars
email string max:254 chars
username* string 1 to 150 chars
PATTERN:^[\w.@+-]+$
Required. 150 characters or fewer. Letters, digits and @/./
+/-/_ only.
full_name* string min:1 chars
account_type string READ-ONLY
standard, service_with_impersonation,
service_without_impersonation, device
cloud_space_right {
instant_social* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_tv* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_booking* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_signage* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_metrics* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_device_manager* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
}
}
main* boolean
contacted* boolean
date_contacted* string
}
secondary_referrer* [{
Array of object:

user {
id integer READ-ONLY
uuid string READ-ONLY
first_name string max:150 chars

128 of 352
 last_name string max:150 chars
email string max:254 chars
username* string 1 to 150 chars
PATTERN:^[\w.@+-]+$
Required. 150 characters or fewer. Letters, digits and @/./
+/-/_ only.
full_name* string min:1 chars
account_type string READ-ONLY
standard, service_with_impersonation,
service_without_impersonation, device
cloud_space_right {
instant_social* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_tv* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_booking* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_signage* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_metrics* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_device_manager* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
}
}
main* boolean
contacted* boolean
date_contacted* string
}]
update_guest_list_iframe_url string READ-ONLY
}]
}

STATUS CODE - 400: Invalid parameters.

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

8.2 POST /guest-lists/

Create a new guest list.

Create a new guest list.

To use this end-point, you have to be cloud-user.

REQUEST

RESPONSE

129 of 352
STATUS CODE - 200:

RESPONSE MODEL - application/json

{
id integer READ-ONLY
reference string READ-ONLY
min:1 chars
title* string 1 to 512 chars
owner {
id integer READ-ONLY
uuid string READ-ONLY
first_name string max:150 chars
last_name string max:150 chars
email string max:254 chars
username* string 1 to 150 chars
PATTERN:^[\w.@+-]+$
Required. 150 characters or fewer. Letters, digits and @/./+/-/_
only.
full_name* string min:1 chars
account_type string READ-ONLY
standard, service_with_impersonation,
service_without_impersonation, device
cloud_space_right {
instant_social* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_tv* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_booking* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_signage* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_metrics* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_device_manager* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
}
}
guest_point {
id integer READ-ONLY
title* string 1 to 512 chars
display_name* string 1 to 512 chars
default_name string READ-ONLY
min:1 chars
Display name or technical name
address {
company* string 1 to 100 chars
country* string max:100 chars
city* string max:100 chars
site* string 1 to 100 chars
division string 1 to 100 chars
departement string max:50 chars
corporation string max:100 chars

130 of 352
 building string max:50 chars
floor string max:50 chars
door string max:50 chars
number string max:30 chars
street_line1 string max:100 chars
street_line2 string max:100 chars
zipcode string max:5 chars
state string max:100 chars
cedex string max:100 chars
postal_box string max:20 chars
}
owner integer
email string max:254 chars
phone string max:512 chars
description string
mail_bundles* [{
Array of object:

bundle {
id integer READ-ONLY
key* string 1 to 1024 chars
display_name* string 1 to 1024 chars
is_default boolean
is_system boolean
}
content_type {
id integer READ-ONLY
app_label* string 1 to 100 chars
model* string 1 to 100 chars
}
object_id integer between 0 and 2147483647
}]
add_guest_list_iframe_url string READ-ONLY
guest_point_url_badges string READ-ONLY
guest_point_url_folds string READ-ONLY
has_local_admin_right boolean READ-ONLY
guest_badge_display* integer Usage rules for badges.0 - Do not display or use badges.1 - Display badges but
don't require them for checkin.2 - Badges are also required for check-in.
enable_folds_view boolean READ-ONLY
enable_temp_badge_view boolean READ-ONLY
}
start string READ-ONLY
end string READ-ONLY
members [{
Array of object:

id integer READ-ONLY
first_name* string 1 to 150 chars
last_name* string 1 to 150 chars
full_name string READ-ONLY
email string max:254 chars
phone string max:150 chars
company string max:150 chars
guest_type enum ALLOWED:0, 1
type string READ-ONLY
min:1 chars
visibility enum ALLOWED:0, 1
status enum ALLOWED:0, 1, 2, 3
declaration_origin enum ALLOWED:0, 1, 2
badge_free* string 1 to 512 chars

131 of 352
 date_checkin string
date_checkout string
observations string
}]
description string
nb_members integer between -2147483648 and
2147483647
primary_referrer* {
user {
id integer READ-ONLY
uuid string READ-ONLY
first_name string max:150 chars
last_name string max:150 chars
email string max:254 chars
username* string 1 to 150 chars
PATTERN:^[\w.@+-]+$
Required. 150 characters or fewer. Letters, digits and @/./
+/-/_ only.
full_name* string min:1 chars
account_type string READ-ONLY
standard, service_with_impersonation,
service_without_impersonation, device
cloud_space_right {
instant_social* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_tv* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_booking* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_signage* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_metrics* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_device_manager* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
}
}
main* boolean
contacted* boolean
date_contacted* string
}
secondary_referrer* [{
Array of object:

user {
id integer READ-ONLY
uuid string READ-ONLY
first_name string max:150 chars
last_name string max:150 chars
email string max:254 chars
username* string 1 to 150 chars
PATTERN:^[\w.@+-]+$
Required. 150 characters or fewer. Letters, digits and @/./

132 of 352
 +/-/_ only.
full_name* string min:1 chars
account_type string READ-ONLY
standard, service_with_impersonation,
service_without_impersonation, device
cloud_space_right {
instant_social* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_tv* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_booking* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_signage* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_metrics* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_device_manager* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
}
}
main* boolean
contacted* boolean
date_contacted* string
}]
update_guest_list_iframe_url string READ-ONLY
}

STATUS CODE - 400: Invalid parameters.

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

8.3 GET /guest-lists/{id}/

Get a single guest list.

Get a guest list from its ID.

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*id integer Guest List ID (e.g. 4)

RESPONSE

STATUS CODE - 200:

RESPONSE MODEL - application/json

133 of 352
{
id integer READ-ONLY
reference string READ-ONLY
min:1 chars
title* string 1 to 512 chars
owner {
id integer READ-ONLY
uuid string READ-ONLY
first_name string max:150 chars
last_name string max:150 chars
email string max:254 chars
username* string 1 to 150 chars
PATTERN:^[\w.@+-]+$
Required. 150 characters or fewer. Letters, digits and @/./+/-/_
only.
full_name* string min:1 chars
account_type string READ-ONLY
standard, service_with_impersonation,
service_without_impersonation, device
cloud_space_right {
instant_social* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_tv* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_booking* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_signage* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_metrics* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_device_manager* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
}
}
guest_point {
id integer READ-ONLY
title* string 1 to 512 chars
display_name* string 1 to 512 chars
default_name string READ-ONLY
min:1 chars
Display name or technical name
address {
company* string 1 to 100 chars
country* string max:100 chars
city* string max:100 chars
site* string 1 to 100 chars
division string 1 to 100 chars
departement string max:50 chars
corporation string max:100 chars
building string max:50 chars
floor string max:50 chars
door string max:50 chars

134 of 352
 number string max:30 chars
street_line1 string max:100 chars
street_line2 string max:100 chars
zipcode string max:5 chars
state string max:100 chars
cedex string max:100 chars
postal_box string max:20 chars
}
owner integer
email string max:254 chars
phone string max:512 chars
description string
mail_bundles* [{
Array of object:

bundle {
id integer READ-ONLY
key* string 1 to 1024 chars
display_name* string 1 to 1024 chars
is_default boolean
is_system boolean
}
content_type {
id integer READ-ONLY
app_label* string 1 to 100 chars
model* string 1 to 100 chars
}
object_id integer between 0 and 2147483647
}]
add_guest_list_iframe_url string READ-ONLY
guest_point_url_badges string READ-ONLY
guest_point_url_folds string READ-ONLY
has_local_admin_right boolean READ-ONLY
guest_badge_display* integer Usage rules for badges.0 - Do not display or use badges.1 - Display badges but
don't require them for checkin.2 - Badges are also required for check-in.
enable_folds_view boolean READ-ONLY
enable_temp_badge_view boolean READ-ONLY
}
start string READ-ONLY
end string READ-ONLY
members [{
Array of object:

id integer READ-ONLY
first_name* string 1 to 150 chars
last_name* string 1 to 150 chars
full_name string READ-ONLY
email string max:254 chars
phone string max:150 chars
company string max:150 chars
guest_type enum ALLOWED:0, 1
type string READ-ONLY
min:1 chars
visibility enum ALLOWED:0, 1
status enum ALLOWED:0, 1, 2, 3
declaration_origin enum ALLOWED:0, 1, 2
badge_free* string 1 to 512 chars
date_checkin string
date_checkout string
observations string

135 of 352
}]
description string
nb_members integer between -2147483648 and
2147483647
primary_referrer* {
user {
id integer READ-ONLY
uuid string READ-ONLY
first_name string max:150 chars
last_name string max:150 chars
email string max:254 chars
username* string 1 to 150 chars
PATTERN:^[\w.@+-]+$
Required. 150 characters or fewer. Letters, digits and @/./
+/-/_ only.
full_name* string min:1 chars
account_type string READ-ONLY
standard, service_with_impersonation,
service_without_impersonation, device
cloud_space_right {
instant_social* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_tv* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_booking* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_signage* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_metrics* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_device_manager* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
}
}
main* boolean
contacted* boolean
date_contacted* string
}
secondary_referrer* [{
Array of object:

user {
id integer READ-ONLY
uuid string READ-ONLY
first_name string max:150 chars
last_name string max:150 chars
email string max:254 chars
username* string 1 to 150 chars
PATTERN:^[\w.@+-]+$
Required. 150 characters or fewer. Letters, digits and @/./
+/-/_ only.
full_name* string min:1 chars
account_type string READ-ONLY

136 of 352
 standard, service_with_impersonation,
service_without_impersonation, device
cloud_space_right {
instant_social* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_tv* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_booking* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_signage* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_metrics* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_device_manager* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
}
}
main* boolean
contacted* boolean
date_contacted* string
}]
update_guest_list_iframe_url string READ-ONLY
}

STATUS CODE - 400: Invalid parameters.

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

STATUS CODE - 404: Guest list not found

8.4 PUT /guest-lists/{id}/

Update an existing guest list.

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*id string A unique integer value identifying this guest list.

RESPONSE

STATUS CODE - 200:

RESPONSE MODEL - application/json

{
id integer READ-ONLY
reference string READ-ONLY

137 of 352
 min:1 chars
title* string 1 to 512 chars
owner {
id integer READ-ONLY
uuid string READ-ONLY
first_name string max:150 chars
last_name string max:150 chars
email string max:254 chars
username* string 1 to 150 chars
PATTERN:^[\w.@+-]+$
Required. 150 characters or fewer. Letters, digits and @/./+/-/_
only.
full_name* string min:1 chars
account_type string READ-ONLY
standard, service_with_impersonation,
service_without_impersonation, device
cloud_space_right {
instant_social* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_tv* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_booking* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_signage* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_metrics* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_device_manager* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
}
}
guest_point {
id integer READ-ONLY
title* string 1 to 512 chars
display_name* string 1 to 512 chars
default_name string READ-ONLY
min:1 chars
Display name or technical name
address {
company* string 1 to 100 chars
country* string max:100 chars
city* string max:100 chars
site* string 1 to 100 chars
division string 1 to 100 chars
departement string max:50 chars
corporation string max:100 chars
building string max:50 chars
floor string max:50 chars
door string max:50 chars
number string max:30 chars
street_line1 string max:100 chars
street_line2 string max:100 chars

138 of 352
 zipcode string max:5 chars
state string max:100 chars
cedex string max:100 chars
postal_box string max:20 chars
}
owner integer
email string max:254 chars
phone string max:512 chars
description string
mail_bundles* [{
Array of object:

bundle {
id integer READ-ONLY
key* string 1 to 1024 chars
display_name* string 1 to 1024 chars
is_default boolean
is_system boolean
}
content_type {
id integer READ-ONLY
app_label* string 1 to 100 chars
model* string 1 to 100 chars
}
object_id integer between 0 and 2147483647
}]
add_guest_list_iframe_url string READ-ONLY
guest_point_url_badges string READ-ONLY
guest_point_url_folds string READ-ONLY
has_local_admin_right boolean READ-ONLY
guest_badge_display* integer Usage rules for badges.0 - Do not display or use badges.1 - Display badges but
don't require them for checkin.2 - Badges are also required for check-in.
enable_folds_view boolean READ-ONLY
enable_temp_badge_view boolean READ-ONLY
}
start string READ-ONLY
end string READ-ONLY
members [{
Array of object:

id integer READ-ONLY
first_name* string 1 to 150 chars
last_name* string 1 to 150 chars
full_name string READ-ONLY
email string max:254 chars
phone string max:150 chars
company string max:150 chars
guest_type enum ALLOWED:0, 1
type string READ-ONLY
min:1 chars
visibility enum ALLOWED:0, 1
status enum ALLOWED:0, 1, 2, 3
declaration_origin enum ALLOWED:0, 1, 2
badge_free* string 1 to 512 chars
date_checkin string
date_checkout string
observations string
}]
description string
nb_members integer between -2147483648 and

139 of 352
 2147483647
primary_referrer* {
user {
id integer READ-ONLY
uuid string READ-ONLY
first_name string max:150 chars
last_name string max:150 chars
email string max:254 chars
username* string 1 to 150 chars
PATTERN:^[\w.@+-]+$
Required. 150 characters or fewer. Letters, digits and @/./
+/-/_ only.
full_name* string min:1 chars
account_type string READ-ONLY
standard, service_with_impersonation,
service_without_impersonation, device
cloud_space_right {
instant_social* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_tv* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_booking* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_signage* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_metrics* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_device_manager* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
}
}
main* boolean
contacted* boolean
date_contacted* string
}
secondary_referrer* [{
Array of object:

user {
id integer READ-ONLY
uuid string READ-ONLY
first_name string max:150 chars
last_name string max:150 chars
email string max:254 chars
username* string 1 to 150 chars
PATTERN:^[\w.@+-]+$
Required. 150 characters or fewer. Letters, digits and @/./
+/-/_ only.
full_name* string min:1 chars
account_type string READ-ONLY
standard, service_with_impersonation,
service_without_impersonation, device
cloud_space_right {
instant_social* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,

140 of 352
 CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_tv* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_booking* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_signage* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_metrics* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_device_manager* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
}
}
main* boolean
contacted* boolean
date_contacted* string
}]
update_guest_list_iframe_url string READ-ONLY
}

STATUS CODE - 400: Invalid parameters.

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

8.5 DELETE /guest-lists/{id}/

Delete an existing guest list.

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*id integer Guest List ID (e.g. 4)

RESPONSE

STATUS CODE - 204: Success

STATUS CODE - 400: Invalid parameters.

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

STATUS CODE - 404: Guest list not found

8.6 PUT /guest-lists/{id}/checkin/{guest_member_id}/{status}/

141 of 352
Change the arrival status of a guest in a guest list.

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*id integer Guest List ID (e.g. 4)

*guest_member_id integer Guest_Member ID who change status (e.g. 4)
*status integer The new status of the guest_member : 2 for checkin, 3 for checkout

RESPONSE

STATUS CODE - 204: Success

STATUS CODE - 400: Invalid parameters.

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

STATUS CODE - 404: Guest list not found

142 of 352
9. GUEST-MEMBERS

9.1 GET /guest-members/

Paginated list of guest-members.

REQUEST
QUERY PARAMETERS
NAME TYPE DESCRIPTION

page integer A page number within the

paginated result set.
page_size integer Number of results to return
per page.
query string Search guest members by
min:1 chars email, name or company
guest_point_id integer
>=0
guest_list_id integer
>=0
from_date date-time filter visits with expected
check-in date after this date
to_date date-time filter visits with expected
check-in date before this
date
status array of integer Guest member status
ALLOWED: 0, 1, 2, 3

include_hidden_guests boolean When you mark a guest as

hidden, it won't come back in
API results unless you set
this parameter to True.
ordering enum sort results
ALLOWED: expected_checkin_date, -
expected_checkin_date, expected_checkout_date, -
expected_checkout_date, company, -company, subject,
-subject, guest_full_name, -guest_full_name

RESPONSE

STATUS CODE - 200:

RESPONSE MODEL - application/json

{
id integer READ-ONLY
first_name* string 1 to 150 chars
last_name* string 1 to 150 chars
full_name string READ-ONLY
email string max:254 chars
phone string max:150 chars
company string max:150 chars
guest_type enum ALLOWED:0, 1

143 of 352
type string READ-ONLY
min:1 chars
visibility enum ALLOWED:0, 1
status enum ALLOWED:0, 1, 2, 3
declaration_origin enum ALLOWED:0, 1, 2
badge_free* string 1 to 512 chars
date_checkin string
date_checkout string
observations string
guest_list* {
start string READ-ONLY
end string READ-ONLY
owner {
id* integer
email* string min:1 chars
title string max:250 chars
department string max:250 chars
service string max:250 chars
building string max:250 chars
office string max:250 chars
first_name* string min:1 chars
last_name* string min:1 chars
full_name* string min:1 chars
phone string max:20 chars
cell string max:20 chars
fax string max:20 chars
other_email string max:254 chars
direction string max:250 chars
team string max:250 chars
timezone enum ALLOWED:Africa/Abidjan, Africa/Accra, Africa/Bamako,
Africa/Banjul, Africa/Bissau, Africa/Conakry, Africa/
Dakar, Africa/Freetown, Africa/Lome, Africa/Monrovia,
Africa/Nouakchott, Africa/Ouagadougou, Africa/Sao_Tome,
America/Danmarkshavn, America/Scoresbysund, Atlantic/
Azores, Atlantic/Reykjavik, Atlantic/St_Helena, GMT, UTC,
Africa/Algiers, Africa/Bangui, Africa/Brazzaville,
Africa/Casablanca, Africa/Douala, Africa/El_Aaiun,
Africa/Kinshasa, Africa/Lagos, Africa/Libreville, Africa/
Luanda, Africa/Malabo, Africa/Ndjamena, Africa/Niamey,
Africa/Porto-Novo, Africa/Tunis, Atlantic/Canary,
Atlantic/Faroe, Atlantic/Madeira, Europe/Dublin, Europe/
Guernsey, Europe/Isle_of_Man, Europe/Jersey, Europe/
Lisbon, Europe/London, Africa/Blantyre, Africa/Bujumbura,
Africa/Cairo, Africa/Ceuta, Africa/Gaborone, Africa/
Harare, Africa/Johannesburg, Africa/Juba, Africa/
Khartoum, Africa/Kigali, Africa/Lubumbashi, Africa/
Lusaka, Africa/Maputo, Africa/Maseru, Africa/Mbabane,
Africa/Tripoli, Africa/Windhoek, Antarctica/Troll,
Arctic/Longyearbyen, Europe/Amsterdam, Europe/Andorra,
Europe/Belgrade, Europe/Berlin, Europe/Bratislava,
Europe/Brussels, Europe/Budapest, Europe/Busingen,
Europe/Copenhagen, Europe/Gibraltar, Europe/Kaliningrad,
Europe/Ljubljana, Europe/Luxembourg, Europe/Madrid,
Europe/Malta, Europe/Monaco, Europe/Oslo, Europe/Paris,
Europe/Podgorica, Europe/Prague, Europe/Rome, Europe/
San_Marino, Europe/Sarajevo, Europe/Skopje, Europe/
Stockholm, Europe/Tirane, Europe/Vaduz, Europe/Vatican,
Europe/Vienna, Europe/Warsaw, Europe/Zagreb, Europe/

144 of 352
Zurich, Africa/Addis_Ababa, Africa/Asmara, Africa/
Dar_es_Salaam, Africa/Djibouti, Africa/Kampala, Africa/
Mogadishu, Africa/Nairobi, Antarctica/Syowa, Asia/Aden,
Asia/Amman, Asia/Baghdad, Asia/Bahrain, Asia/Beirut,
Asia/Damascus, Asia/Famagusta, Asia/Gaza, Asia/Hebron,
Asia/Jerusalem, Asia/Kuwait, Asia/Nicosia, Asia/Qatar,
Asia/Riyadh, Europe/Athens, Europe/Bucharest, Europe/
Chisinau, Europe/Helsinki, Europe/Istanbul, Europe/Kiev,
Europe/Kirov, Europe/Mariehamn, Europe/Minsk, Europe/
Moscow, Europe/Riga, Europe/Simferopol, Europe/Sofia,
Europe/Tallinn, Europe/Uzhgorod, Europe/Vilnius, Europe/
Volgograd, Europe/Zaporozhye, Indian/Antananarivo,
Indian/Comoro, Indian/Mayotte, Asia/Baku, Asia/Dubai,
Asia/Muscat, Asia/Tbilisi, Asia/Yerevan, Europe/
Astrakhan, Europe/Samara, Europe/Saratov, Europe/
Ulyanovsk, Indian/Mahe, Indian/Mauritius, Indian/Reunion,
Asia/Kabul, Asia/Tehran, Antarctica/Mawson, Asia/Aqtau,
Asia/Aqtobe, Asia/Ashgabat, Asia/Atyrau, Asia/Dushanbe,
Asia/Karachi, Asia/Oral, Asia/Qyzylorda, Asia/Samarkand,
Asia/Tashkent, Asia/Yekaterinburg, Indian/Kerguelen,
Indian/Maldives, Asia/Colombo, Asia/Kolkata, Asia/
Kathmandu, Antarctica/Vostok, Asia/Almaty, Asia/Bishkek,
Asia/Dhaka, Asia/Omsk, Asia/Qostanay, Asia/Thimphu, Asia/
Urumqi, Indian/Chagos, Asia/Yangon, Indian/Cocos,
Antarctica/Davis, Asia/Bangkok, Asia/Barnaul, Asia/
Ho_Chi_Minh, Asia/Hovd, Asia/Jakarta, Asia/Krasnoyarsk,
Asia/Novokuznetsk, Asia/Novosibirsk, Asia/Phnom_Penh,
Asia/Pontianak, Asia/Tomsk, Asia/Vientiane, Indian/
Christmas, Asia/Brunei, Asia/Choibalsan, Asia/Hong_Kong,
Asia/Irkutsk, Asia/Kuala_Lumpur, Asia/Kuching, Asia/
Macau, Asia/Makassar, Asia/Manila, Asia/Shanghai, Asia/
Singapore, Asia/Taipei, Asia/Ulaanbaatar, Australia/
Perth, Australia/Eucla, Asia/Chita, Asia/Dili, Asia/
Jayapura, Asia/Khandyga, Asia/Pyongyang, Asia/Seoul,
Asia/Tokyo, Asia/Yakutsk, Pacific/Palau, Australia/
Adelaide, Australia/Broken_Hill, Australia/Darwin,
Antarctica/DumontDUrville, Antarctica/Macquarie, Asia/
Ust-Nera, Asia/Vladivostok, Australia/Brisbane,
Australia/Hobart, Australia/Lindeman, Australia/
Melbourne, Australia/Sydney, Pacific/Chuuk, Pacific/Guam,
Pacific/Port_Moresby, Pacific/Saipan, Australia/
Lord_Howe, Antarctica/Casey, Asia/Magadan, Asia/Sakhalin,
Asia/Srednekolymsk, Pacific/Bougainville, Pacific/Efate,
Pacific/Guadalcanal, Pacific/Kosrae, Pacific/Norfolk,
Pacific/Noumea, Pacific/Pohnpei, Antarctica/McMurdo,
Asia/Anadyr, Asia/Kamchatka, Pacific/Auckland, Pacific/
Fiji, Pacific/Funafuti, Pacific/Kwajalein, Pacific/
Majuro, Pacific/Nauru, Pacific/Tarawa, Pacific/Wake,
Pacific/Wallis, Pacific/Chatham, Pacific/Apia, Pacific/
Enderbury, Pacific/Fakaofo, Pacific/Tongatapu, Pacific/
Kiritimati, Atlantic/Cape_Verde, America/Miquelon,
America/Noronha, America/Nuuk, Atlantic/South_Georgia,
America/St_Johns, Canada/Newfoundland, America/Araguaina,
America/Argentina/Buenos_Aires, America/Argentina/
Catamarca, America/Argentina/Cordoba, America/Argentina/
Jujuy, America/Argentina/La_Rioja, America/Argentina/
Mendoza, America/Argentina/Rio_Gallegos, America/

145 of 352
Argentina/Salta, America/Argentina/San_Juan, America/
Argentina/San_Luis, America/Argentina/Tucuman, America/
Argentina/Ushuaia, America/Bahia, America/Belem, America/
Cayenne, America/Fortaleza, America/Glace_Bay, America/
Goose_Bay, America/Halifax, America/Maceio, America/
Moncton, America/Montevideo, America/Paramaribo, America/
Punta_Arenas, America/Recife, America/Santarem, America/
Santiago, America/Sao_Paulo, America/Thule, Antarctica/
Palmer, Antarctica/Rothera, Atlantic/Bermuda, Atlantic/
Stanley, Canada/Atlantic, America/Anguilla, America/
Antigua, America/Aruba, America/Asuncion, America/
Barbados, America/Blanc-Sablon, America/Boa_Vista,
America/Campo_Grande, America/Caracas, America/Cuiaba,
America/Curacao, America/Detroit, America/Dominica,
America/Grand_Turk, America/Grenada, America/Guadeloupe,
America/Guyana, America/Havana, America/Indiana/
Indianapolis, America/Indiana/Marengo, America/Indiana/
Petersburg, America/Indiana/Vevay, America/Indiana/
Vincennes, America/Indiana/Winamac, America/Iqaluit,
America/Kentucky/Louisville, America/Kentucky/Monticello,
America/Kralendijk, America/La_Paz, America/
Lower_Princes, America/Manaus, America/Marigot, America/
Martinique, America/Montserrat, America/Nassau, America/
New_York, America/Nipigon, America/Pangnirtung, America/
Port-au-Prince, America/Port_of_Spain, America/
Porto_Velho, America/Puerto_Rico, America/Santo_Domingo,
America/St_Barthelemy, America/St_Kitts, America/
St_Lucia, America/St_Thomas, America/St_Vincent, America/
Thunder_Bay, America/Toronto, America/Tortola, Canada/
Eastern, US/Eastern, America/Atikokan, America/
Bahia_Banderas, America/Bogota, America/Cancun, America/
Cayman, America/Chicago, America/Eirunepe, America/
Guayaquil, America/Indiana/Knox, America/Indiana/
Tell_City, America/Jamaica, America/Lima, America/
Matamoros, America/Menominee, America/Merida, America/
Mexico_City, America/Monterrey, America/North_Dakota/
Beulah, America/North_Dakota/Center, America/
North_Dakota/New_Salem, America/Panama, America/
Rainy_River, America/Rankin_Inlet, America/Resolute,
America/Rio_Branco, America/Winnipeg, Canada/Central,
Pacific/Easter, US/Central, America/Belize, America/
Boise, America/Cambridge_Bay, America/Chihuahua, America/
Costa_Rica, America/Denver, America/Edmonton, America/
El_Salvador, America/Guatemala, America/Inuvik, America/
Managua, America/Mazatlan, America/Ojinaga, America/
Regina, America/Swift_Current, America/Tegucigalpa,
America/Yellowknife, Canada/Mountain, Pacific/Galapagos,
US/Mountain, America/Creston, America/Dawson, America/
Dawson_Creek, America/Fort_Nelson, America/Hermosillo,
America/Los_Angeles, America/Phoenix, America/Tijuana,
America/Vancouver, America/Whitehorse, Canada/Pacific,
US/Arizona, US/Pacific, America/Anchorage, America/
Juneau, America/Metlakatla, America/Nome, America/Sitka,
America/Yakutat, Pacific/Pitcairn, US/Alaska, America/
Adak, Pacific/Gambier, Pacific/Marquesas, Pacific/
Honolulu, Pacific/Rarotonga, Pacific/Tahiti, US/Hawaii,
Pacific/Midway, Pacific/Niue, Pacific/Pago_Pago

146 of 352
 }
reference string READ-ONLY
min:1 chars
title string READ-ONLY
description string READ-ONLY
id integer READ-ONLY
referrers [{
Array of object:

id integer READ-ONLY
main boolean READ-ONLY
user_id integer READ-ONLY
first_name string READ-ONLY
1 to 150 chars
last_name string READ-ONLY
1 to 150 chars
full_name string READ-ONLY
1 to 254 chars
email string READ-ONLY
min:1 chars
username string READ-ONLY
1 to 100 chars
}]
}
hidden_for_me boolean READ-ONLY
printed boolean READ-ONLY
}

STATUS CODE - 400: Invalid query parameter value

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied or service not enabled.

9.2 POST /guest-members/export/

Request an export of guest member. The export result will be send by email.

REQUEST
REQUEST BODY - application/json
{
query string min:1 chars
Search guest members by email, name or company
guest_point_id integer >=0
guest_list_id integer >=0
from_date string filter visits with expected check-in date after this date
to_date string filter visits with expected check-in date before this date
status [enum] ALLOWED:0, 1, 2, 3
include_hidden_guests boolean When you mark a guest as hidden, it won't come back in API results unless you set this
parameter to True.
ordering enum DEFAULT:expected_checkin_date
ALLOWED:expected_checkin_date,
-expected_checkin_date,
expected_checkout_date, -expected_checkout_date,
company, -company, subject, -subject, guest_full_name,
-guest_full_name
sort results
}

147 of 352
RESPONSE

STATUS CODE - 201: Export created.

STATUS CODE - 400: Invalid parameters.

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

STATUS CODE - 429: Export already ongoing.

9.3 GET /guest-members/search/

Search guests and users.

REQUEST
QUERY PARAMETERS
NAME TYPE DESCRIPTION

page integer A page number within the paginated result set.

page_size integer Number of results to return per page.
*query string Query to search in last name, first name, email, and company
min:1 chars
show_only_guests_i_know boolean Show only guests member I know from last visits

RESPONSE

STATUS CODE - 200:

RESPONSE MODEL - application/json

{
pagination* {
total_results integer
results_per_page integer
total_pages integer
current_page integer
previous_page integer
next_page integer
}
results* [{
Array of object:

users* [{
Array of object:

id integer READ-ONLY
first_name string max:150 chars
last_name string max:150 chars
email string max:254 chars
full_name* string min:1 chars
}]
guests* [{
Array of object:

id integer READ-ONLY
first_name* string 1 to 150 chars

148 of 352
 last_name* string 1 to 150 chars
full_name string READ-ONLY
email string max:254 chars
phone string max:150 chars
company string max:150 chars
guest_type enum ALLOWED:0, 1
type string READ-ONLY
min:1 chars
visibility enum ALLOWED:0, 1
status enum ALLOWED:0, 1, 2, 3
declaration_origin enum ALLOWED:0, 1, 2
badge_free* string 1 to 512 chars
date_checkin string
date_checkout string
observations string
}]
}]
}

STATUS CODE - 400: Invalid parameters.

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

9.4 GET /guest-members/{id}/

Get a single guest member.

Get a guest member from its ID.

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*id string A unique integer value identifying this guest member.

RESPONSE

STATUS CODE - 200:

RESPONSE MODEL - application/json

{
id integer READ-ONLY
first_name* string 1 to 150 chars
last_name* string 1 to 150 chars
full_name string READ-ONLY
email string max:254 chars
phone string max:150 chars
company string max:150 chars
guest_type enum ALLOWED:0, 1
type string READ-ONLY
min:1 chars
visibility enum ALLOWED:0, 1
status enum ALLOWED:0, 1, 2, 3

149 of 352
 declaration_origin enum ALLOWED:0,
1, 2
badge_free* string 1 to 512 chars
date_checkin string
date_checkout string
observations string
}

STATUS CODE - 400: Invalid parameters.

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

STATUS CODE - 404: Guest member not found

9.5 PUT /guest-members/{id}/

Update an existing guest member.

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*id string A unique integer value identifying this guest member.

REQUEST BODY - application/json

{
id integer READ-ONLY
first_name* string 1 to 150 chars
last_name* string 1 to 150 chars
email string max:254 chars
phone string max:150 chars
company string max:150 chars
guest_type enum ALLOWED:0, 1
visibility enum ALLOWED:0, 1
observations string
badge_free string max:511 chars
type string 1 to 20 chars
}

RESPONSE

STATUS CODE - 200:

RESPONSE MODEL - application/json

{
id integer READ-ONLY
first_name* string 1 to 150 chars
last_name* string 1 to 150 chars
email string max:254 chars
phone string max:150 chars
company string max:150 chars
guest_type enum ALLOWED:0, 1
visibility enum ALLOWED:0, 1
observations string
badge_free string max:511 chars

150 of 352
 type string 1 to 20 chars
}

STATUS CODE - 400: Invalid parameters.

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

9.6 DELETE /guest-members/{id}/

Un-invite a guest-member from its guest_list.

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*id string A unique integer value identifying this guest member.

RESPONSE

STATUS CODE - 204: Guest member removed from guest_list.

STATUS CODE - 400: Invalid parameters.

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied or service not enabled.

9.7 GET /guest-members/{id}/print-badge/

Get the badge content of the given gest member. You can print the html directly.

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*id string A unique integer value identifying this guest member.

RESPONSE

STATUS CODE - 200:

RESPONSE MODEL - application/json

{
badge* string min:1 chars
}

STATUS CODE - 400: Invalid parameters.

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

151 of 352
 STATUS CODE - 404: Guest member not found

9.8 POST /guest-members/{id}/set-print/

Note you have printed a guest member badge just for you.

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*id string A unique integer value identifying this guest member.

REQUEST BODY - application/json

{
printed* boolean
}

RESPONSE

STATUS CODE - 204: Print status updated

STATUS CODE - 400: Invalid parameters.

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

STATUS CODE - 404: Guest member not found

9.9 POST /guest-members/{id}/set-visibility/

Hide a guest member from API calls just for you.

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*id string A unique integer value identifying this guest member.

REQUEST BODY - application/json

{
visibility* enum ALLOWED:hidden, visible
}

RESPONSE

STATUS CODE - 204: Visibility updated

STATUS CODE - 400: Invalid parameters.

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

STATUS CODE - 404: Guest member not found

152 of 352
153 of 352
10. GUEST-POINTS

10.1 GET /guest-points/

Filter guest points.

REQUEST
QUERY PARAMETERS
NAME TYPE DESCRIPTION

page integer A page number within the paginated result set.

page_size integer Number of results to return per page.

RESPONSE

STATUS CODE - 200:

RESPONSE MODEL - application/json

{
pagination* {
total_results integer
results_per_page integer
total_pages integer
current_page integer
previous_page integer
next_page integer
}
results* [{
Array of object:

id integer READ-ONLY
title* string 1 to 512 chars
display_name* string 1 to 512 chars
default_name string READ-ONLY
min:1 chars
Display name or technical name
address {
company* string 1 to 100 chars
country* string max:100 chars
city* string max:100 chars
site* string 1 to 100 chars
division string 1 to 100 chars
departement string max:50 chars
corporation string max:100 chars
building string max:50 chars
floor string max:50 chars
door string max:50 chars
number string max:30 chars
street_line1 string max:100 chars
street_line2 string max:100 chars
zipcode string max:5 chars
state string max:100 chars
cedex string max:100 chars

154 of 352
 postal_box string max:20 chars
}
owner integer
email string max:254 chars
phone string max:512 chars
description string
mail_bundles* [{
Array of object:

bundle {
id integer READ-ONLY
key* string 1 to 1024 chars
display_name* string 1 to 1024 chars
is_default boolean
is_system boolean
}
content_type {
id integer READ-ONLY
app_label* string 1 to 100 chars
model* string 1 to 100 chars
}
object_id integer between 0 and 2147483647
}]
add_guest_list_iframe_url string READ-ONLY
guest_point_url_badges string READ-ONLY
guest_point_url_folds string READ-ONLY
has_local_admin_right boolean READ-ONLY
guest_badge_display* integer Usage rules for badges.0 - Do not display or use badges.1 - Display badges but
don't require them for checkin.2 - Badges are also required for check-in.
enable_folds_view boolean READ-ONLY
enable_temp_badge_view boolean READ-ONLY
}]
}

STATUS CODE - 400: Invalid parameters.

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

10.2 GET /guest-points/ids/

List IDs of filtered guest points.

List IDs of filtered guest points

REQUEST
QUERY PARAMETERS
NAME TYPE DESCRIPTION

page integer A page number within the paginated result set.

page_size integer Number of results to return per page.

RESPONSE

STATUS CODE - 200:

155 of 352
 RESPONSE MODEL - application/json
{
guestpoint_ids* [integer]
}

STATUS CODE - 400: Invalid parameters.

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

10.3 GET /guest-points/{id}/

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*id string A unique integer value identifying this guest point.

RESPONSE

STATUS CODE - 200:

RESPONSE MODEL - application/json

{
id integer READ-ONLY
title* string 1 to 512 chars
display_name* string 1 to 512 chars
default_name string READ-ONLY
min:1 chars
Display name or technical name
address {
company* string 1 to 100 chars
country* string max:100 chars
city* string max:100 chars
site* string 1 to 100 chars
division string 1 to 100 chars
departement string max:50 chars
corporation string max:100 chars
building string max:50 chars
floor string max:50 chars
door string max:50 chars
number string max:30 chars
street_line1 string max:100 chars
street_line2 string max:100 chars
zipcode string max:5 chars
state string max:100 chars
cedex string max:100 chars
postal_box string max:20 chars
}
owner integer
email string max:254 chars
phone string max:512 chars
description string
mail_bundles* [{
Array of object:

156 of 352
 bundle {
id integer READ-ONLY
key* string 1 to 1024 chars
display_name* string 1 to 1024 chars
is_default boolean
is_system boolean
}
content_type {
id integer READ-ONLY
app_label* string 1 to 100 chars
model* string 1 to 100 chars
}
object_id integer between 0 and 2147483647
}]
add_guest_list_iframe_url string READ-ONLY
guest_point_url_badges string READ-ONLY
guest_point_url_folds string READ-ONLY
has_local_admin_right boolean READ-ONLY
guest_badge_display* integer Usage rules for badges.0 - Do not display or use badges.1 - Display badges but don't
require them for checkin.2 - Badges are also required for check-in.
enable_folds_view boolean READ-ONLY
enable_temp_badge_view boolean READ-ONLY
}

STATUS CODE - 400: Invalid parameters.

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

10.4 GET /guest-points/{id}/import-guests/

Get the model file for the import

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*id string A unique integer value identifying this guest point.

RESPONSE

STATUS CODE - 200:

RESPONSE MODEL - application/json

string

STATUS CODE - 400: Invalid parameters.

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

STATUS CODE - 404: Guest point not found.

10.5 POST /guest-points/{id}/import-guests/

157 of 352
Imports several guest with one file.

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*id string A unique integer value identifying this guest point.

FORM DATA PARAMETERS

NAME TYPE DESCRIPTION

file string(binary)

RESPONSE

STATUS CODE - 204: Import will start.

STATUS CODE - 400: File is not in the expected format.

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

STATUS CODE - 404: Guest point not found.

158 of 352
11. I18N

11.1 GET /i18n/languages/

List available languages.

REQUEST
No request parameters

RESPONSE

STATUS CODE - 200:

RESPONSE MODEL - application/json

[{
Array of object:

code* string min:1 chars

Language code (e.g. EN)
name* string min:1 chars
Language name (e.g. English (UK))
flag* string min:1 chars
Country flag code (e.g. us)
}]

11.2 GET /i18n/timezones/

List available timezones.

REQUEST
No request parameters

RESPONSE

STATUS CODE - 200:

RESPONSE MODEL - application/json

[{
Array of object:

rank* integer Rank

name* string min:1 chars
Name
full_name* string min:1 chars
Name with offset
current* boolean Is current?
}]

11.3 GET /i18n/timezones/compare/

Get request timezone data from server.

REQUEST
159 of 352
 No request parameters

RESPONSE

STATUS CODE - 200:

RESPONSE MODEL - application/json

{
current_year* string min:1 chars
Year value
current_month* string min:1 chars
Month value
current_day* string min:1 chars
Day value
current_hour* string min:1 chars
Hour value
current_minute* string min:1 chars
Minute value
current_second* string min:1 chars
Second value
current_tz* string min:1 chars
Timezone name
}

STATUS CODE - 400: Invalid parameters.

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

11.4 POST /i18n/translations/

Post a translations listing request.

This will get you i18n data.

Note: The translations and hash fields returned are use internally by SharingCloud products.You're
probably only interested by the language_code field.

To use this end-point, you have to be cloud-user.

REQUEST
REQUEST BODY - application/json
{
hash string min:1 chars
Hash value to compare
message_ids [string] min:1 chars
language string min:1 chars
Language code
}

RESPONSE

STATUS CODE - 200:

RESPONSE MODEL - application/json

160 of 352
 [{
Array of object:

language_code* string min:1 chars

Language code
hash* string min:1 chars
Hash value
translations* {
Translation values

}
}]

STATUS CODE - 204: No changes

STATUS CODE - 400: Invalid parameters.

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

161 of 352
12. IDM

12.1 GET /idm/devices/

List devices.

List devices and their informations.

REQUEST
QUERY PARAMETERS
NAME TYPE DESCRIPTION

page integer A page number within the paginated result set.

page_size integer Number of results to return per page.

RESPONSE

STATUS CODE - 200:

RESPONSE MODEL - application/json

{
pagination* {
total_results integer
results_per_page integer
total_pages integer
current_page integer
previous_page integer
next_page integer
}
results* [{
Array of object:

uuid string READ-ONLY

min:1 chars
serial_number string max:32 chars
lan_mac_address string max:17 chars
wlan_mac_address string max:17 chars
devicemodel string max:64 chars
description string
user_email string READ-ONLY
min:1 chars
status string READ-ONLY
min:1 chars
last_beat string READ-ONLY
resource string READ-ONLY
min:1 chars
address {
company* string 1 to 100 chars
country* string max:100 chars
city* string max:100 chars
site* string 1 to 100 chars
division string 1 to 100 chars
departement string max:50 chars

162 of 352
 corporation string max:100 chars
building string max:50 chars
floor string max:50 chars
door string max:50 chars
number string max:30 chars
street_line1 string max:100 chars
street_line2 string max:100 chars
zipcode string max:5 chars
state string max:100 chars
cedex string max:100 chars
postal_box string max:20 chars
}
information {
packages [{
Array of object:

name* string 1 to 255 chars

package string max:255 chars
version_name* string 1 to 255 chars
version_code* integer between -2147483648 and 2147483647
}]
admin_url string max:64 chars
airplay boolean
android_version string max:64 chars
ap_channel string max:64 chars
ap_enabled boolean
ap_password_display string max:64 chars
ap_security_mode string max:64 chars
ap_ssid string max:64 chars
brand string max:64 chars
firmware string max:64 chars
internet_network string max:64 chars
lan_enabled boolean
lan_dns string max:64 chars
lan_ip string max:64 chars
lan_ipv4 string max:64 chars
miracast boolean
name string max:64 chars
network_type string max:64 chars
ntp string max:255 chars
proxy string max:64 chars
ram string max:64 chars
reboot_time string max:64 chars
resolution string max:64 chars
hdmi_management enum ALLOWED:0, 1, 2
server_access string max:64 chars
server_subomain string max:64 chars
storage string max:64 chars
uptime string
wlan_enabled boolean
wlan_ip string max:64 chars
wlan_security_mode string max:64 chars
wlan_ssid string max:64 chars
camera_enabled boolean
microphone_enabled boolean
nfc_enabled boolean
nfc_frequency string max:255 chars
boot_url string max:255 chars

163 of 352
 webview_version string max:64 chars
starter_version string max:64 chars
}
}]
}

STATUS CODE - 400: Invalid parameters.

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

12.2 GET /idm/devices/authentication-code/

Generate and return an authentication code for the given device.

Search device by its serial number, then generate its authentication code.

REQUEST
QUERY PARAMETERS
NAME TYPE DESCRIPTION

*serial_number string Device Serial Number

min:1 chars
*lan_mac_address string Device LAN Mac Address
min:1 chars
*wlan_mac_address string Device WLAN Mac Address
min:1 chars

RESPONSE

STATUS CODE - 200:

RESPONSE MODEL - application/json

{
auth_code* string min:1 chars
Device Authentication Code
}

STATUS CODE - 400: Input data missing or incorrect

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

STATUS CODE - 404: Device not found

STATUS CODE - 500: Authentication code generation error

12.3 POST /idm/devices/device-bookmark/

Bookmark or unbookmark a device

REQUEST

164 of 352
 REQUEST BODY - application/json
{
device_id* integer Device Id
bookmark* boolean Bookmark/Unbookmark command
}

RESPONSE

STATUS CODE - 204: Success

STATUS CODE - 400: Input data missing or incorrect

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

STATUS CODE - 404: Device not found

STATUS CODE - 500: Device bookmark error

12.4 POST /idm/devices/info-export/

Request an export of devices info. The export result will be send by email.

REQUEST
No request parameters

RESPONSE

STATUS CODE - 201: Export created.

STATUS CODE - 400: Invalid parameters.

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

STATUS CODE - 429: Export already ongoing.

12.5 GET /idm/devices/{uuid}/

Get a specific device.

Get a specific device and its information.

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*uuid string

RESPONSE

STATUS CODE - 200:

RESPONSE MODEL - application/json

165 of 352
{
uuid string READ-ONLY
min:1 chars
serial_number string max:32 chars
lan_mac_address string max:17 chars
wlan_mac_address string max:17 chars
devicemodel string max:64 chars
description string
user_email string READ-ONLY
min:1 chars
status string READ-ONLY
min:1 chars
last_beat string READ-ONLY
resource string READ-ONLY
min:1 chars
address {
company* string 1 to 100 chars
country* string max:100 chars
city* string max:100 chars
site* string 1 to 100 chars
division string 1 to 100 chars
departement string max:50 chars
corporation string max:100 chars
building string max:50 chars
floor string max:50 chars
door string max:50 chars
number string max:30 chars
street_line1 string max:100 chars
street_line2 string max:100 chars
zipcode string max:5 chars
state string max:100 chars
cedex string max:100 chars
postal_box string max:20 chars
}
information {
packages [{
Array of object:

name* string 1 to 255 chars

package string max:255 chars
version_name* string 1 to 255 chars
version_code* integer between -2147483648 and 2147483647
}]
admin_url string max:64 chars
airplay boolean
android_version string max:64 chars
ap_channel string max:64 chars
ap_enabled boolean
ap_password_display string max:64 chars
ap_security_mode string max:64 chars
ap_ssid string max:64 chars
brand string max:64 chars
firmware string max:64 chars
internet_network string max:64 chars
lan_enabled boolean
lan_dns string max:64 chars
lan_ip string max:64 chars
lan_ipv4 string max:64 chars
miracast boolean

166 of 352
 name string max:64 chars
network_type string max:64 chars
ntp string max:255 chars
proxy string max:64 chars
ram string max:64 chars
reboot_time string max:64 chars
resolution string max:64 chars
hdmi_management enum ALLOWED:0, 1, 2
server_access string max:64 chars
server_subomain string max:64 chars
storage string max:64 chars
uptime string
wlan_enabled boolean
wlan_ip string max:64 chars
wlan_security_mode string max:64 chars
wlan_ssid string max:64 chars
camera_enabled boolean
microphone_enabled boolean
nfc_enabled boolean
nfc_frequency string max:255 chars
boot_url string max:255 chars
webview_version string max:64 chars
starter_version string max:64 chars
}
}

STATUS CODE - 400: Invalid parameters.

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

STATUS CODE - 404: Device not found

12.6 PUT /idm/devices/{uuid}/associate-resource/

Associate a device to a resource.

Returns a json response with a bearer token and the url to display for the device.

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*uuid string

REQUEST BODY - application/json

{
association_code* integer Device Association Code
dry_run* boolean Should simulate device association ?
}

RESPONSE

STATUS CODE - 200:

167 of 352
 RESPONSE MODEL - application/json
{
bearer_token string min:1 chars
Device bearer token
url string min:1 chars
Next URL to display
device_id integer The id of the associated resource
device_name string Associated device name
}

STATUS CODE - 400: Input data missing or incorrect

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

STATUS CODE - 404: Device or resource not found

STATUS CODE - 500: Device association failed

12.7 PUT /idm/devices/{uuid}/heartbeat/

Stores a heartbeat.

Heartbeat has two attributes: the device uptime and its the current time.

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*uuid string

REQUEST BODY - application/json

{
uptime* integer Device uptime (timestamp)
time* integer Device current time (timestamp)
}

RESPONSE

STATUS CODE - 201:

RESPONSE MODEL - application/json

{
uptime* integer Device uptime (timestamp)
time* integer Device current time (timestamp)
}

STATUS CODE - 400: Input data missing or incorrect

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

STATUS CODE - 404: Device not found

168 of 352
12.8 PUT /idm/devices/{uuid}/information/

Send device informations.

Send several information about the device: hardware informations, settings and installed APK.

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*uuid string

REQUEST BODY - application/json

{
packages [{
Array of object:

name* string 1 to 255 chars

package string max:255 chars
version_name* string 1 to 255 chars
version_code* integer between -2147483648 and 2147483647
}]
admin_url string max:64 chars
airplay boolean
android_version string max:64 chars
ap_channel string max:64 chars
ap_enabled boolean
ap_password_display string max:64 chars
ap_security_mode string max:64 chars
ap_ssid string max:64 chars
brand string max:64 chars
firmware string max:64 chars
internet_network string max:64 chars
lan_enabled boolean
lan_dns string max:64 chars
lan_ip string max:64 chars
lan_ipv4 string max:64 chars
miracast boolean
name string max:64 chars
network_type string max:64 chars
ntp string max:255 chars
proxy string max:64 chars
ram string max:64 chars
reboot_time string max:64 chars
resolution string max:64 chars
hdmi_management enum ALLOWED:0, 1, 2
server_access string max:64 chars
server_subomain string max:64 chars
storage string max:64 chars
uptime string
wlan_enabled boolean
wlan_ip string max:64 chars
wlan_security_mode string max:64 chars
wlan_ssid string max:64 chars
camera_enabled boolean
microphone_enabled boolean

169 of 352
 nfc_enabled boolean
nfc_frequency string max:255 chars
boot_url string max:255 chars
webview_version string max:64 chars
starter_version string max:64 chars
}

RESPONSE

STATUS CODE - 200:

RESPONSE MODEL - application/json

{
packages [{
Array of object:

name* string 1 to 255 chars

package string max:255 chars
version_name* string 1 to 255 chars
version_code* integer between -2147483648 and 2147483647
}]
admin_url string max:64 chars
airplay boolean
android_version string max:64 chars
ap_channel string max:64 chars
ap_enabled boolean
ap_password_display string max:64 chars
ap_security_mode string max:64 chars
ap_ssid string max:64 chars
brand string max:64 chars
firmware string max:64 chars
internet_network string max:64 chars
lan_enabled boolean
lan_dns string max:64 chars
lan_ip string max:64 chars
lan_ipv4 string max:64 chars
miracast boolean
name string max:64 chars
network_type string max:64 chars
ntp string max:255 chars
proxy string max:64 chars
ram string max:64 chars
reboot_time string max:64 chars
resolution string max:64 chars
hdmi_management enum ALLOWED:0, 1, 2
server_access string max:64 chars
server_subomain string max:64 chars
storage string max:64 chars
uptime string
wlan_enabled boolean
wlan_ip string max:64 chars
wlan_security_mode string max:64 chars
wlan_ssid string max:64 chars
camera_enabled boolean
microphone_enabled boolean
nfc_enabled boolean
nfc_frequency string max:255 chars
boot_url string max:255 chars

170 of 352
 webview_version string max:64 chars
starter_version string max:64 chars
}

STATUS CODE - 400: Wrong data

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

12.9 GET /idm/devices/{uuid}/resource/

Get the device associated resource.

Get the Instant Booking resource associated to this IDM device.

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*uuid string

RESPONSE

STATUS CODE - 200:

RESPONSE MODEL - application/json

{
id integer READ-ONLY
name* string 1 to 512 chars
resource_allowed_reservation enum DEFAULT:1
ALLOWED:1, 5, 2, 3, 4
resource_type enum DEFAULT:1
ALLOWED:6, 7, 8, 9, 15, 34,
38, 39, 40, 41, 1, 2, 3, 11,
4, 5, 20, 23, 24, 25, 26, 29,
31, 32, 33, 35, 36, 12, 13,
19, 27, 10, 18, 21, 16, 17,
22, 14, 30, 28, 37, 42, 43,
44, 45, 46, 48, 49, 50, 51,
52, 53, 54, 55, 56, 57
capacity* integer >=0
address* {
company* string 1 to 100 chars
country* string max:100 chars
city* string max:100 chars
site* string 1 to 100 chars
division string 1 to 100 chars
departement string max:50 chars
corporation string max:100 chars
building string max:50 chars
floor string max:50 chars
door string max:50 chars
number string max:30 chars
street_line1 string max:100 chars

171 of 352
 street_line2 string max:100 chars
zipcode string max:5 chars
state string max:100 chars
cedex string max:100 chars
postal_box string max:20 chars
}
display_name string max:512 chars
alternate_room_name string max:512 chars
description string
contact_phone string max:100 chars
contact_email string max:254 chars
contact string max:512 chars
custom_contact_info string max:512 chars
sip_uri string min:1 chars
ip_address string min:1 chars
is_visible boolean
is_internal boolean
nb_participants_required boolean
is_custom_contact_info boolean
bms_zone string max:512 chars
site_code string max:512 chars
is_moderated boolean
book_horizon integer between 0 and 2147483647
DEFAULT:0
imputation_code boolean
imputation_code_label string max:512 chars
imputation_code_required boolean
requisitionable boolean
requisitionable_label string max:512 chars
vmr_num string max:512 chars
not_prm boolean
is_blind boolean
not_projector boolean
help_button_url string max:200 chars
min_booking_duration integer
max_booking_duration integer
isdn_number string min:1 chars
e164_number string min:1 chars
h323id string min:1 chars
room_phone_number string min:1 chars
status integer READ-ONLY
bookable boolean READ-ONLY
photo string READ-ONLY
photo_uuid string READ-ONLY
qrcode_url string READ-ONLY
QRCode URL pointing to Instant Mobile resource
page
qrcode_report_url string READ-ONLY
QRCode URL pointing to Instant Mobile issue
reporting page
calendar_processing {
instant_booking_mode enum ALLOWED:0, 1, 2
instant_booking_duration_1 integer between -2147483648
and 2147483647
instant_booking_duration_2 integer between -2147483648
and 2147483647
instant_booking_duration_step enum ALLOWED:5, 10, 15, 30,
45, 60

172 of 352
 instant_booking_confirmation_required boolean
instant_booking_auth_required boolean
meeting_ack boolean
meeting_ack_start_time enum ALLOWED:0, 5, 10, 15,
30, 45, 60, 75, 90,
105, 120, 135, 150,
165, 180, 195, 210,
225, 240
meeting_ack_end_time enum ALLOWED:0, 5, 10, 15,
30, 45, 60, 75, 90,
105, 120, 135, 150,
165, 180, 195, 210,
225, 240
meeting_ack_confirmation_required boolean
meeting_ack_auth_required boolean
meeting_ack_auth_required_private_meetings boolean
meeting_ack_release boolean
meeting_ack_reminder boolean
extendable_meeting boolean
extendable_meeting_mode enum ALLOWED:0, 1
extend_meeting_duration_1 integer between -2147483648
and 2147483647
extend_meeting_duration_2 integer between -2147483648
and 2147483647
extend_meeting_duration_step enum ALLOWED:5, 10, 15, 30,
45, 60
meeting_ack_release_auth_required boolean
meeting_ack_release_auth_required_private_meetings boolean
time_before_sensor_auto_release enum ALLOWED:4, 6, 8, 10,
12, 16, 20
apply_rights_book boolean
apply_rights_release boolean
apply_rights_confirm boolean
auto_release_force boolean
}
max_date_from_now string READ-ONLY
min:1 chars
max_resa_hours string READ-ONLY
min:1 chars
available boolean READ-ONLY
compounds integer READ-ONLY
default_name string READ-ONLY
min:1 chars
Display name or technical name
interop_calendaring_email string READ-ONLY
min:1 chars
interop_videoconferencing_email string READ-ONLY
min:1 chars
teams_meeting_enabled boolean READ-ONLY
first_linked_map {
First map where this resource is shown

id integer READ-ONLY
title string 1 to 512 chars
display_name string 1 to 512 chars
description string min:1 chars
floor_top integer
floor_bottom integer
display_type integer between -2147483648 and 2147483647

173 of 352
 legend_display_type integer between -2147483648 and 2147483647
}
ordered_photos [string] min:1 chars
resource_tags [string]
service_offers [{
Array of object:

id* integer ID of the service offer

name* string min:1 chars
Name of the service offer
availability* enum ALLOWED:AVAILABLE, DISABLED, TOO_SHORT_NOTICE
Availability of this service based on the requested delivery time - Values: `AVAILABLE` (This service
offer is available), `DISABLED` (This service offer has been disabled and is not currently available),
`TOO_SHORT_NOTICE` (This service offer requires a notice period and the requested delivery time
is too close)
css_icon* string min:1 chars
CSS class of an icon symbolizing this service
}]
}

STATUS CODE - 400: Invalid parameters.

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

STATUS CODE - 404: Device not found or no resource associated to the device

12.10 POST /idm/devices/{uuid}/supervision-toggle/

Toggle the supervision emails status.

This enables or disables heartbeat email notifications for a specific device.

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*uuid string

REQUEST BODY - application/json

{
enable* boolean Enable/disable email command
}

RESPONSE

STATUS CODE - 204: Success

STATUS CODE - 400: Input data missing or incorrect

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

STATUS CODE - 404: Device not found

STATUS CODE - 500: Device supervision toggle error

174 of 352
12.11 GET /idm/devices/{uuid}/url-to-display/

Get url-to-display for a specific device.

Get url-to-display for a specific device using the uuid in get query parameters.

Returns a json response with a bearer token and the url to display for the device.
if device uuid is unknown, returns a 404 not found
returns a 401 if not authenticated

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*uuid string

RESPONSE

STATUS CODE - 200:

RESPONSE MODEL - application/json

{
bearer_token* string min:1 chars
Device bearer token
url* string min:1 chars
Next Url to display
}

STATUS CODE - 400: Invalid parameters.

STATUS CODE - 401: Not authorized

STATUS CODE - 403: Forbidden. Access denied.

STATUS CODE - 404: Device not found

12.12 GET /idm/instant-tasks/{id}/file/

Get the file associated to the instant task.

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*id string A unique integer value identifying this instant task.

RESPONSE

STATUS CODE - 200: The binary file

STATUS CODE - 400: Invalid parameters.

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

175 of 352
 STATUS CODE - 404: Task or file not found

12.13 POST /idm/instant-tasks/{id}/file/

Upload a file for an instant task.

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*id string A unique integer value identifying this instant task.

FORM DATA PARAMETERS

NAME TYPE DESCRIPTION

data_file string(binary) Task data file

RESPONSE

STATUS CODE - 204: File saved successfully

STATUS CODE - 400: Input data missing or incorrect

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

STATUS CODE - 500: File upload failed

12.14 GET /idm/registration/

Get registration data.

Get the base API URL, the authentication server URL and the websocket server URL for this cloud.

REQUEST
No request parameters

RESPONSE

STATUS CODE - 200:

RESPONSE MODEL - application/json

{
base_api_url* string min:1 chars
Base API URL
authority_url* string min:1 chars
Authentication server URL
websocket_url string Websocket server URL
}

STATUS CODE - 400: Invalid parameters.

STATUS CODE - 401: Unauthorized. Authentication needed.

176 of 352
 STATUS CODE - 403: Forbidden. Access denied.

12.15 GET /idm/tasks/

Get tasks list.

Get all tasks available for this device that are enabled and compatible.

parameters structure is depending of the task type.

REQUEST
QUERY PARAMETERS
NAME TYPE DESCRIPTION

page integer A page number within the paginated result set.

page_size integer Number of results to return per page.
*device_uuid string Device UUID
min:1 chars
manager boolean Filter on 'Manager update' tasks

RESPONSE

STATUS CODE - 200:

RESPONSE MODEL - application/json

{
pagination* {
total_results integer
results_per_page integer
total_pages integer
current_page integer
previous_page integer
next_page integer
}
results* [{
Array of object:

name* string 1 to 255 chars

Task name
uuid string READ-ONLY
min:1 chars
Task identifier
task_type enum ALLOWED:0, 1, 99, 98, 4
Task type
type_name* string min:1 chars
Type name
parameters {
Task parameters: the structure is depending of the task type.
<code>
"task_type": 0, # APK update
"parameters": {
&nbsp; "url": "str: file url, NAPI endpoint",
&nbsp; "hash": "str: file md5 hash",
&nbsp; "version": "str: APK version name",
&nbsp; "package": "str: package name"
}
</code>

177 of 352
 <code>
"task_type": 1, # Firmware update
"parameters": {
&nbsp; "url": "str: file url, NAPI endpoint",
&nbsp; "hash": "str: file md5 hash",
&nbsp; "version": "str: firmware version"
}
</code>
<code>
"task_type": 4, # Reboot
"parameters": {
}
</code
<code>
"task_type": 99, # Retrieve logs
"parameters": {
&nbsp; "filter": "str: log filter"
}
</code>
<code>
"task_type": 98, # Apply settings
"parameters": {
&nbsp; "ntp": "str: ntp server url",
&nbsp; "timezone": "str: device timezone",
&nbsp; "time_format": "str: device time format (12h / 24h)",
&nbsp; "locale": "str: device locale",
&nbsp; "screen_orientation": "str: device screen orientation (degrees)",
&nbsp; "hdmi_management": "str: hdmi management type (cec, video, rs232)",
&nbsp; "nfc_enabled": "bool: device nfc on or off",
&nbsp; "nfc_frequency": "str: device nfc frequency"
&nbsp; "remote_port_enabled": "bool: QBIC remote debugging port is enabled or not"
&nbsp; "password": "str: device local password, null to remove it"
}
</code>

}
}]
}

STATUS CODE - 400: Invalid parameters.

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

12.16 POST /idm/tasks/log/

Upload a device log file.

Upload a device log file. Logs are related to a 'retrieve logs' task.

REQUEST
FORM DATA PARAMETERS
NAME TYPE DESCRIPTION

device_uuid string Device UUID

task_uuid string Task UUID
log_file string(binary) Device log file. should be named task-<uuid>.zip

RESPONSE

STATUS CODE - 200: Logs saved successfully

STATUS CODE - 400: Input data missing or incorrect

178 of 352
 STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

STATUS CODE - 404: Device not found

STATUS CODE - 500: Log upload failed

12.17 PUT /idm/tasks/reports/

Send a task report.

Send a report about a device task with execution information: status, execution date, potential errors
causes.

REQUEST
REQUEST BODY - application/json
{
device_uuid* string min:1 chars
Device UUID
task_uuid* string min:1 chars
Task identifier
status* integer The task execution status. 1=In progress, 2=Success, 3=Error
content string min:1 chars
Important task execution information, usually error causes
execution_date* integer Timestamp of task execution date & time
}

RESPONSE

STATUS CODE - 200:

RESPONSE MODEL - application/json

{
status* integer The task execution status. 1=In progress, 2=Success, 3=Error
content string min:1 chars
Important task execution information, usually error causes
execution_date* integer Timestamp of task execution date & time
}

STATUS CODE - 400: Input data missing or incorrect

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

STATUS CODE - 404: Device or task not found

179 of 352
13. ISSUES

13.1 GET /issues/

Filter issues.

Filter issues.

You can filter by resource.

REQUEST
QUERY PARAMETERS
NAME TYPE DESCRIPTION

page integer A page number within the paginated result set.

page_size integer Number of results to return per page.
resource integer Resource ID
show_only_mine boolean

RESPONSE

STATUS CODE - 200:

RESPONSE MODEL - application/json

{
pagination* {
total_results integer
results_per_page integer
total_pages integer
current_page integer
previous_page integer
next_page integer
}
results* [{
Array of object:

id integer READ-ONLY
resource {
id integer READ-ONLY
name* string 1 to 512 chars
resource_allowed_reservation enum DEFAULT:1
ALLOWED:1, 5, 2, 3, 4
resource_type enum DEFAULT:1
ALLOWED:6, 7, 8, 9, 15,
34, 38, 39, 40, 41, 1,
2, 3, 11, 4, 5, 20,
23, 24, 25, 26, 29,
31, 32, 33, 35, 36,
12, 13, 19, 27, 10,
18, 21, 16, 17, 22,
14, 30, 28, 37, 42,
43, 44, 45, 46, 48,

180 of 352
 49, 50, 51, 52, 53,
54, 55, 56, 57
capacity* integer >=0
address* {
company* string 1 to 100 chars
country* string max:100 chars
city* string max:100 chars
site* string 1 to 100 chars
division string 1 to 100 chars
departement string max:50 chars
corporation string max:100 chars
building string max:50 chars
floor string max:50 chars
door string max:50 chars
number string max:30 chars
street_line1 string max:100 chars
street_line2 string max:100 chars
zipcode string max:5 chars
state string max:100 chars
cedex string max:100 chars
postal_box string max:20 chars
}
display_name string max:512 chars
alternate_room_name string max:512 chars
description string
contact_phone string max:100 chars
contact_email string max:254 chars
contact string max:512 chars
custom_contact_info string max:512 chars
sip_uri string min:1 chars
ip_address string min:1 chars
is_visible boolean
is_internal boolean
nb_participants_required boolean
is_custom_contact_info boolean
bms_zone string max:512 chars
site_code string max:512 chars
is_moderated boolean
book_horizon integer between 0 and
2147483647
DEFAULT:0
imputation_code boolean
imputation_code_label string max:512 chars
imputation_code_required boolean
requisitionable boolean
requisitionable_label string max:512 chars
vmr_num string max:512 chars
not_prm boolean
is_blind boolean
not_projector boolean
help_button_url string max:200 chars
min_booking_duration integer
max_booking_duration integer
isdn_number string min:1 chars
e164_number string min:1 chars
h323id string min:1 chars
room_phone_number string min:1 chars

181 of 352
status integer READ-ONLY

bookable boolean READ-ONLY

photo string READ-ONLY
photo_uuid string READ-ONLY
qrcode_url string READ-ONLY
QRCode URL pointing to Instant
Mobile resource page
qrcode_report_url string READ-ONLY
QRCode URL pointing to Instant
Mobile issue reporting page
calendar_processing {
instant_booking_mode enum ALLOWED:0, 1, 2
instant_booking_duration_1 integer between
-2147483648 and
2147483647
instant_booking_duration_2 integer between
-2147483648 and
2147483647
instant_booking_duration_step enum ALLOWED:5, 10,
15, 30, 45, 60
instant_booking_confirmation_required boolean
instant_booking_auth_required boolean
meeting_ack boolean
meeting_ack_start_time enum ALLOWED:0, 5, 10,
15, 30, 45, 60,
75, 90, 105,
120, 135, 150,
165, 180, 195,
210, 225, 240
meeting_ack_end_time enum ALLOWED:0, 5, 10,
15, 30, 45, 60,
75, 90, 105,
120, 135, 150,
165, 180, 195,
210, 225, 240
meeting_ack_confirmation_required boolean
meeting_ack_auth_required boolean
meeting_ack_auth_required_private_meetings boolean
meeting_ack_release boolean
meeting_ack_reminder boolean
extendable_meeting boolean
extendable_meeting_mode enum ALLOWED:0, 1
extend_meeting_duration_1 integer between
-2147483648 and
2147483647
extend_meeting_duration_2 integer between
-2147483648 and
2147483647
extend_meeting_duration_step enum ALLOWED:5, 10,
15, 30, 45, 60
meeting_ack_release_auth_required boolean
meeting_ack_release_auth_required_private_meetings boolean
time_before_sensor_auto_release enum ALLOWED:4, 6, 8,
10, 12, 16, 20
apply_rights_book boolean
apply_rights_release boolean
apply_rights_confirm boolean
auto_release_force boolean

182 of 352
 }
max_date_from_now string READ-ONLY
min:1 chars
max_resa_hours string READ-ONLY
min:1 chars
available boolean READ-ONLY
compounds integer READ-ONLY
default_name string READ-ONLY
min:1 chars
Display name or technical name
interop_calendaring_email string READ-ONLY
min:1 chars
interop_videoconferencing_email string READ-ONLY
min:1 chars
teams_meeting_enabled boolean READ-ONLY
first_linked_map {
First map where this resource is shown

id integer READ-ONLY
title string 1 to 512 chars
display_name string 1 to 512 chars
description string min:1 chars
floor_top integer
floor_bottom integer
display_type integer between -2147483648 and 2147483647
legend_display_type integer between -2147483648 and 2147483647
}
ordered_photos [string] min:1 chars
resource_tags [string]
service_offers [{
Array of object:

id* integer ID of the service offer

name* string min:1 chars
Name of the service offer
availability* enum ALLOWED:AVAILABLE, DISABLED, TOO_SHORT_NOTICE
Availability of this service based on the requested delivery time - Values: `AVAILABLE`
(This service offer is available), `DISABLED` (This service offer has been disabled and is
not currently available), `TOO_SHORT_NOTICE` (This service offer requires a notice period
and the requested delivery time is too close)
css_icon* string min:1 chars
CSS class of an icon symbolizing this service
}]
}
owner {
id integer READ-ONLY
uuid string READ-ONLY
first_name string max:150 chars
last_name string max:150 chars
email string max:254 chars
username* string 1 to 150 chars
PATTERN:^[\w.@+-]+$
Required. 150 characters or fewer. Letters, digits and @/./
+/-/_ only.
full_name* string min:1 chars
account_type string READ-ONLY
standard, service_with_impersonation,
service_without_impersonation, device
cloud_space_right {
instant_social* enum ALLOWED:CLOUD_GUEST,
CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,

183 of 352
 CLOUD_POWERUSER, CLOUD_ADMIN
instant_tv* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_booking* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_signage* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_metrics* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_device_manager* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
}
}
description string min:1 chars
severity integer between -2147483648 and
2147483647
coordinates string 1 to 512 chars
alertdetail {
id integer READ-ONLY
target_icon enum ALLOWED:0, 1, 2, 3, 4, 5, 6,
7, 8
title string 1 to 512 chars
display_name string 1 to 512 chars
owner {
id integer READ-ONLY
uuid string READ-ONLY
first_name string max:150 chars
last_name string max:150 chars
email string max:254 chars
username* string 1 to 150 chars
PATTERN:^[\w.@+-]+$
Required. 150 characters or fewer. Letters, digits and @/./
+/-/_ only.
full_name* string min:1 chars
account_type string READ-ONLY
standard, service_with_impersonation,
service_without_impersonation, device
cloud_space_right {
instant_social* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_tv* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_booking* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_signage* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_metrics* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN

184 of 352
 instant_device_manager* enum ALLOWED:CLOUD_GUEST,
CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
}
}
description string
description_displayed string
nb_menu integer between -2147483648 and
2147483647
fm_code string max:512 chars
class_icon string 1 to 512 chars
target_email string
cc_email string
cci_email string
mandatory_comment boolean
notify_user boolean
notify_user_choice enum ALLOWED:0,
1, 2
custom_subject string 1 to 1024 chars
addon_email string
}
report_id string READ-ONLY
min:1 chars
date_pub_added string READ-ONLY
}]
}

STATUS CODE - 400: Invalid parameters.

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

13.2 GET /issues/menus/

Filter report menus.

Filter report menus.

You can filter by resource.

REQUEST
QUERY PARAMETERS
NAME TYPE DESCRIPTION

page integer A page number within the paginated result set.

page_size integer Number of results to return per page.
resource integer Resource ID

RESPONSE

STATUS CODE - 200:

RESPONSE MODEL - application/json

{

185 of 352
id integer READ-ONLY

menu_alert_detail {
id integer READ-ONLY
title* string 1 to 512 chars
owner {
id integer READ-ONLY
uuid string READ-ONLY
first_name string max:150 chars
last_name string max:150 chars
email string max:254 chars
username* string 1 to 150 chars
PATTERN:^[\w.@+-]+$
Required. 150 characters or fewer. Letters, digits and @/./
+/-/_ only.
full_name* string min:1 chars
account_type string READ-ONLY
standard, service_with_impersonation,
service_without_impersonation, device
cloud_space_right {
instant_social* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_tv* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_booking* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_signage* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_metrics* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_device_manager* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
}
}
description string
hide_severity boolean
hide_comments boolean
report_menu [{
Array of object:

id integer READ-ONLY
alertdetail {
id integer READ-ONLY
target_icon enum ALLOWED:0,
1, 2, 3, 4, 5,
6, 7, 8
title string 1 to 512 chars
display_name string 1 to 512 chars
owner {
id integer READ-ONLY
uuid string READ-ONLY
first_name string max:150 chars
last_name string max:150 chars
email string max:254 chars
username* string 1 to 150 chars

186 of 352
 PATTERN:^[\w.@+-]+$
Required. 150 characters or fewer. Letters, digits and
@/./+/-/_ only.
full_name* string min:1 chars
account_type string READ-ONLY
standard, service_with_impersonation,
service_without_impersonation, device
cloud_space_right {
instant_social* enum ALLOWED:CLOUD_GUEST,
CLOUD_RESTRICTEDACCESS, CLOUD_LEARNER,
CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_tv* enum ALLOWED:CLOUD_GUEST,
CLOUD_RESTRICTEDACCESS, CLOUD_LEARNER,
CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_booking* enum ALLOWED:CLOUD_GUEST,
CLOUD_RESTRICTEDACCESS, CLOUD_LEARNER,
CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_signage* enum ALLOWED:CLOUD_GUEST,
CLOUD_RESTRICTEDACCESS, CLOUD_LEARNER,
CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_metrics* enum ALLOWED:CLOUD_GUEST,
CLOUD_RESTRICTEDACCESS, CLOUD_LEARNER,
CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_device_manager* enum ALLOWED:CLOUD_GUEST,
CLOUD_RESTRICTEDACCESS, CLOUD_LEARNER,
CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
}
}
description string
description_displayed string
nb_menu integer between -2147483648 and
2147483647
fm_code string max:512 chars
class_icon string 1 to 512 chars
target_email string
cc_email string
cci_email string
mandatory_comment boolean
notify_user boolean
notify_user_choice enum ALLOWED:0,
1, 2
custom_subject string 1 to 1024 chars
addon_email string
}
has_sub boolean
order integer between -2147483648 and
2147483647
report_sub_menu [{
Array of object:

id integer READ-ONLY
alertdetail {
id integer READ-ONLY
target_icon enum ALLOWED:0, 1, 2, 3, 4, 5,

187 of 352
 6, 7, 8
title string 1 to 512 chars
display_name string 1 to 512 chars
owner {
id integer READ-ONLY
uuid string READ-ONLY
first_name string max:150 chars
last_name string max:150 chars
email string max:254 chars
username* string 1 to 150 chars
PATTERN:^[\w.@+-]+$
Required. 150 characters or fewer. Letters, digits and
@/./+/-/_ only.
full_name* string min:1 chars
account_type string READ-ONLY
standard, service_with_impersonation,
service_without_impersonation, device
cloud_space_right {
instant_social* enum ALLOWED:CLOUD_GUEST,
CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER,
CLOUD_USER, CLOUD_POWERUSER,
CLOUD_ADMIN
instant_tv* enum ALLOWED:CLOUD_GUEST,
CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER,
CLOUD_USER, CLOUD_POWERUSER,
CLOUD_ADMIN
instant_booking* enum ALLOWED:CLOUD_GUEST,
CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER,
CLOUD_USER, CLOUD_POWERUSER,
CLOUD_ADMIN
instant_signage* enum ALLOWED:CLOUD_GUEST,
CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER,
CLOUD_USER, CLOUD_POWERUSER,
CLOUD_ADMIN
instant_metrics* enum ALLOWED:CLOUD_GUEST,
CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER,
CLOUD_USER, CLOUD_POWERUSER,
CLOUD_ADMIN
instant_device_manager* enum ALLOWED:CLOUD_GUEST,
CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER,
CLOUD_USER, CLOUD_POWERUSER,
CLOUD_ADMIN
}
}
description string
description_displayed string
nb_menu integer between -2147483648 and
2147483647
fm_code string max:512 chars
class_icon string 1 to 512 chars
target_email string
cc_email string

188 of 352
 cci_email string
mandatory_comment boolean
notify_user boolean
notify_user_choice enum ALLOWED:0,
1, 2
custom_subject string 1 to 1024 chars
addon_email string
}
order integer between -2147483648 and
2147483647
}]
}]
}
resource* integer
}

STATUS CODE - 400: Invalid parameters.

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

13.3 POST /issues/report/{resource_id}/

Report an issue for a resource.

Report an issue for a resource.

To use this end-point, you have to be cloud-user.

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*resource_id string

REQUEST BODY - application/json

{
username string min:1 chars
password string min:1 chars
badge string min:1 chars
pin integer
pin_email string min:1 chars
type* integer Alert Detail ID
severity enum DEFAULT:1
ALLOWED:1, 2, 3
comment string
localisation string min:1 chars
map_w integer DEFAULT:0
map_h integer DEFAULT:0
notify_user_choice boolean DEFAULT:true
map_id integer DEFAULT:0
use_user_credentials boolean
}

RESPONSE

189 of 352
STATUS CODE - 200:

RESPONSE MODEL - application/json

{
id integer READ-ONLY
resource {
id integer READ-ONLY
name* string 1 to 512 chars
resource_allowed_reservation enum DEFAULT:1
ALLOWED:1, 5, 2, 3, 4
resource_type enum DEFAULT:1
ALLOWED:6, 7, 8, 9, 15, 34,
38, 39, 40, 41, 1, 2, 3,
11, 4, 5, 20, 23, 24, 25,
26, 29, 31, 32, 33, 35,
36, 12, 13, 19, 27, 10,
18, 21, 16, 17, 22, 14,
30, 28, 37, 42, 43, 44,
45, 46, 48, 49, 50, 51,
52, 53, 54, 55, 56, 57
capacity* integer >=0
address* {
company* string 1 to 100 chars
country* string max:100 chars
city* string max:100 chars
site* string 1 to 100 chars
division string 1 to 100 chars
departement string max:50 chars
corporation string max:100 chars
building string max:50 chars
floor string max:50 chars
door string max:50 chars
number string max:30 chars
street_line1 string max:100 chars
street_line2 string max:100 chars
zipcode string max:5 chars
state string max:100 chars
cedex string max:100 chars
postal_box string max:20 chars
}
display_name string max:512 chars
alternate_room_name string max:512 chars
description string
contact_phone string max:100 chars
contact_email string max:254 chars
contact string max:512 chars
custom_contact_info string max:512 chars
sip_uri string min:1 chars
ip_address string min:1 chars
is_visible boolean
is_internal boolean
nb_participants_required boolean
is_custom_contact_info boolean
bms_zone string max:512 chars
site_code string max:512 chars
is_moderated boolean
book_horizon integer between 0 and 2147483647

190 of 352
 DEFAULT:0
imputation_code boolean
imputation_code_label string max:512 chars
imputation_code_required boolean
requisitionable boolean
requisitionable_label string max:512 chars
vmr_num string max:512 chars
not_prm boolean
is_blind boolean
not_projector boolean
help_button_url string max:200 chars
min_booking_duration integer
max_booking_duration integer
isdn_number string min:1 chars
e164_number string min:1 chars
h323id string min:1 chars
room_phone_number string min:1 chars
status integer READ-ONLY
bookable boolean READ-ONLY
photo string READ-ONLY
photo_uuid string READ-ONLY
qrcode_url string READ-ONLY
QRCode URL pointing to Instant Mobile
resource page
qrcode_report_url string READ-ONLY
QRCode URL pointing to Instant Mobile
issue reporting page
calendar_processing {
instant_booking_mode enum ALLOWED:0, 1, 2
instant_booking_duration_1 integer between
-2147483648 and
2147483647
instant_booking_duration_2 integer between
-2147483648 and
2147483647
instant_booking_duration_step enum ALLOWED:5, 10, 15,
30, 45, 60
instant_booking_confirmation_required boolean
instant_booking_auth_required boolean
meeting_ack boolean
meeting_ack_start_time enum ALLOWED:0, 5, 10,
15, 30, 45, 60,
75, 90, 105, 120,
135, 150, 165,
180, 195, 210,
225, 240
meeting_ack_end_time enum ALLOWED:0, 5, 10,
15, 30, 45, 60,
75, 90, 105, 120,
135, 150, 165,
180, 195, 210,
225, 240
meeting_ack_confirmation_required boolean
meeting_ack_auth_required boolean
meeting_ack_auth_required_private_meetings boolean
meeting_ack_release boolean
meeting_ack_reminder boolean
extendable_meeting boolean

191 of 352
 extendable_meeting_mode enum ALLOWED:0, 1
extend_meeting_duration_1 integer between
-2147483648 and
2147483647
extend_meeting_duration_2 integer between
-2147483648 and
2147483647
extend_meeting_duration_step enum ALLOWED:5, 10, 15,
30, 45, 60
meeting_ack_release_auth_required boolean
meeting_ack_release_auth_required_private_meetings boolean
time_before_sensor_auto_release enum ALLOWED:4, 6, 8, 10,
12, 16, 20
apply_rights_book boolean
apply_rights_release boolean
apply_rights_confirm boolean
auto_release_force boolean
}
max_date_from_now string READ-ONLY
min:1 chars
max_resa_hours string READ-ONLY
min:1 chars
available boolean READ-ONLY
compounds integer READ-ONLY
default_name string READ-ONLY
min:1 chars
Display name or technical name
interop_calendaring_email string READ-ONLY
min:1 chars
interop_videoconferencing_email string READ-ONLY
min:1 chars
teams_meeting_enabled boolean READ-ONLY
first_linked_map {
First map where this resource is shown

id integer READ-ONLY
title string 1 to 512 chars
display_name string 1 to 512 chars
description string min:1 chars
floor_top integer
floor_bottom integer
display_type integer between -2147483648 and 2147483647
legend_display_type integer between -2147483648 and 2147483647
}
ordered_photos [string] min:1 chars
resource_tags [string]
service_offers [{
Array of object:

id* integer ID of the service offer

name* string min:1 chars
Name of the service offer
availability* enum ALLOWED:AVAILABLE, DISABLED, TOO_SHORT_NOTICE
Availability of this service based on the requested delivery time - Values: `AVAILABLE` (This
service offer is available), `DISABLED` (This service offer has been disabled and is not
currently available), `TOO_SHORT_NOTICE` (This service offer requires a notice period and the
requested delivery time is too close)
css_icon* string min:1 chars
CSS class of an icon symbolizing this service
}]
}

192 of 352
owner {
id integer READ-ONLY
uuid string READ-ONLY
first_name string max:150 chars
last_name string max:150 chars
email string max:254 chars
username* string 1 to 150 chars
PATTERN:^[\w.@+-]+$
Required. 150 characters or fewer. Letters, digits and @/./+/-/_
only.
full_name* string min:1 chars
account_type string READ-ONLY
standard, service_with_impersonation,
service_without_impersonation, device
cloud_space_right {
instant_social* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_tv* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_booking* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_signage* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_metrics* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_device_manager* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
}
}
description string min:1 chars
severity integer between -2147483648 and
2147483647
coordinates string 1 to 512 chars
alertdetail {
id integer READ-ONLY
target_icon enum ALLOWED:0,
1, 2, 3, 4, 5, 6,
7, 8
title string 1 to 512 chars
display_name string 1 to 512 chars
owner {
id integer READ-ONLY
uuid string READ-ONLY
first_name string max:150 chars
last_name string max:150 chars
email string max:254 chars
username* string 1 to 150 chars
PATTERN:^[\w.@+-]+$
Required. 150 characters or fewer. Letters, digits and @/./
+/-/_ only.
full_name* string min:1 chars
account_type string READ-ONLY
standard, service_with_impersonation,
service_without_impersonation, device

193 of 352
 cloud_space_right {
instant_social* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_tv* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_booking* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_signage* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_metrics* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_device_manager* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
}
}
description string
description_displayed string
nb_menu integer between -2147483648 and
2147483647
fm_code string max:512 chars
class_icon string 1 to 512 chars
target_email string
cc_email string
cci_email string
mandatory_comment boolean
notify_user boolean
notify_user_choice enum ALLOWED:0,
1, 2
custom_subject string 1 to 1024 chars
addon_email string
}
report_id string READ-ONLY
min:1 chars
date_pub_added string READ-ONLY
}

STATUS CODE - 400: The issue id (type) sent does not exist

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Login failed with provided parameters

13.4 GET /issues/{id}/

Get a single ResourceMenuAlertDetailManager.

Get a ResourceMenuAlertDetailManager from its ID.

REQUEST
PATH PARAMETERS

194 of 352
 NAME TYPE DESCRIPTION

*id integer Resource Menu Alert Detail Manager ID (e.g. 4)

RESPONSE

STATUS CODE - 200:

RESPONSE MODEL - application/json

{
id integer READ-ONLY
menu_alert_detail {
id integer READ-ONLY
title* string 1 to 512 chars
owner {
id integer READ-ONLY
uuid string READ-ONLY
first_name string max:150 chars
last_name string max:150 chars
email string max:254 chars
username* string 1 to 150 chars
PATTERN:^[\w.@+-]+$
Required. 150 characters or fewer. Letters, digits and @/./
+/-/_ only.
full_name* string min:1 chars
account_type string READ-ONLY
standard, service_with_impersonation,
service_without_impersonation, device
cloud_space_right {
instant_social* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_tv* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_booking* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_signage* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_metrics* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_device_manager* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
}
}
description string
hide_severity boolean
hide_comments boolean
report_menu [{
Array of object:

id integer READ-ONLY
alertdetail {
id integer READ-ONLY

195 of 352
target_icon enum ALLOWED:0,
1, 2, 3, 4, 5,
6, 7, 8
title string 1 to 512 chars
display_name string 1 to 512 chars
owner {
id integer READ-ONLY
uuid string READ-ONLY
first_name string max:150 chars
last_name string max:150 chars
email string max:254 chars
username* string 1 to 150 chars
PATTERN:^[\w.@+-]+$
Required. 150 characters or fewer. Letters, digits and
@/./+/-/_ only.
full_name* string min:1 chars
account_type string READ-ONLY
standard, service_with_impersonation,
service_without_impersonation, device
cloud_space_right {
instant_social* enum ALLOWED:CLOUD_GUEST,
CLOUD_RESTRICTEDACCESS, CLOUD_LEARNER,
CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_tv* enum ALLOWED:CLOUD_GUEST,
CLOUD_RESTRICTEDACCESS, CLOUD_LEARNER,
CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_booking* enum ALLOWED:CLOUD_GUEST,
CLOUD_RESTRICTEDACCESS, CLOUD_LEARNER,
CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_signage* enum ALLOWED:CLOUD_GUEST,
CLOUD_RESTRICTEDACCESS, CLOUD_LEARNER,
CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_metrics* enum ALLOWED:CLOUD_GUEST,
CLOUD_RESTRICTEDACCESS, CLOUD_LEARNER,
CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_device_manager* enum ALLOWED:CLOUD_GUEST,
CLOUD_RESTRICTEDACCESS, CLOUD_LEARNER,
CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
}
}
description string
description_displayed string
nb_menu integer between -2147483648 and
2147483647
fm_code string max:512 chars
class_icon string 1 to 512 chars
target_email string
cc_email string
cci_email string
mandatory_comment boolean
notify_user boolean
notify_user_choice enum ALLOWED:0,
1, 2
custom_subject string 1 to 1024 chars

196 of 352
 addon_email string
}
has_sub boolean
order integer between -2147483648 and
2147483647
report_sub_menu [{
Array of object:

id integer READ-ONLY
alertdetail {
id integer READ-ONLY
target_icon enum ALLOWED:0,
1, 2, 3, 4, 5,
6, 7, 8
title string 1 to 512 chars
display_name string 1 to 512 chars
owner {
id integer READ-ONLY
uuid string READ-ONLY
first_name string max:150 chars
last_name string max:150 chars
email string max:254 chars
username* string 1 to 150 chars
PATTERN:^[\w.@+-]+$
Required. 150 characters or fewer. Letters, digits and
@/./+/-/_ only.
full_name* string min:1 chars
account_type string READ-ONLY
standard, service_with_impersonation,
service_without_impersonation, device
cloud_space_right {
instant_social* enum ALLOWED:CLOUD_GUEST,
CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER,
CLOUD_USER, CLOUD_POWERUSER,
CLOUD_ADMIN
instant_tv* enum ALLOWED:CLOUD_GUEST,
CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER,
CLOUD_USER, CLOUD_POWERUSER,
CLOUD_ADMIN
instant_booking* enum ALLOWED:CLOUD_GUEST,
CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER,
CLOUD_USER, CLOUD_POWERUSER,
CLOUD_ADMIN
instant_signage* enum ALLOWED:CLOUD_GUEST,
CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER,
CLOUD_USER, CLOUD_POWERUSER,
CLOUD_ADMIN
instant_metrics* enum ALLOWED:CLOUD_GUEST,
CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER,
CLOUD_USER, CLOUD_POWERUSER,
CLOUD_ADMIN
instant_device_manager* enum ALLOWED:CLOUD_GUEST,
CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER,
CLOUD_USER, CLOUD_POWERUSER,

197 of 352
 CLOUD_ADMIN
}
}
description string
description_displayed string
nb_menu integer between -2147483648 and
2147483647
fm_code string max:512 chars
class_icon string 1 to 512 chars
target_email string
cc_email string
cci_email string
mandatory_comment boolean
notify_user boolean
notify_user_choice enum ALLOWED:0,
1, 2
custom_subject string 1 to 1024 chars
addon_email string
}
order integer between -2147483648 and
2147483647
}]
}]
}
resource* integer
}

STATUS CODE - 400: Invalid parameters.

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

STATUS CODE - 404: Resource Menu Issue not found

198 of 352
14. MEDIA

14.1 GET /media/statistics/channels/

List filtered and ordered Instant TV channels viewable by current user.

Expectable error codes:

"ITV.BAD_ORDERING" Requested ordering is invalid or unavailable at the moment

REQUEST
QUERY PARAMETERS
NAME TYPE DESCRIPTION

page integer A page number

within the
paginated result
set.
page_size integer Number of results
to return per page.
search string
min:1 chars
from_date date
to_date date
ordering enum
ALLOWED: id, -id, title, -title, last_publication_date, -last_publication_date,
last_view_date, -last_view_date, videos_count, -videos_count, views_count, -
views_count, likes_count, -likes_count, unique_views_count, -unique_views_count,
unique_viewers_count, -unique_viewers_count, qualified_views_count, -
qualified_views_count

RESPONSE

STATUS CODE - 200:

RESPONSE MODEL - application/json

{
id integer READ-ONLY
>=0
title* string min:1 chars
last_publication_date* string
last_view_date* string
videos_count integer READ-ONLY
>=0
views_count integer READ-ONLY
>=0
likes_count integer READ-ONLY
>=0
unique_views_count integer READ-ONLY
>=0
unique_viewers_count integer READ-ONLY
>=0

199 of 352
 qualified_views_count integer READ-ONLY
>=0
channel_url string READ-ONLY
channel_admins [string]
channel_contributors [string]
cloud_slug_name string READ-ONLY
total_size_megabytes number READ-ONLY
}

STATUS CODE - 400: Invalid parameters.

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: You can only filter by your agenda or you as a viewer

14.2 GET /media/statistics/videos/

List filtered and ordered Instant TV videos viewable by current user.

Expectable error codes:

"ITV.BAD_ORDERING" Requested ordering is invalid or unavailable at the moment

REQUEST
QUERY PARAMETERS
NAME TYPE DESCRIPTION

page integer A page number

within the
paginated result
set.
page_size integer Number of
results to return
per page.
channel integer
like boolean
search string
min:1 chars
from_date date
to_date date
ordering enum
ALLOWED: id, -id, title, -title, channel, -channel, owner_display_name, -
owner_display_name, duration, -duration, created_on, -created_on, last_updated, -
last_updated, last_view_date, -last_view_date, view_count, -view_count,
average_view_time, -average_view_time, unique_views_count, -unique_views_count,
unique_viewers_count, -unique_viewers_count, qualified_views_count, -
qualified_views_count, likes_count, -likes_count

RESPONSE

STATUS CODE - 200:

RESPONSE MODEL - application/json

{
id integer READ-ONLY

200 of 352
 >=0
Video ID
title* string min:1 chars
Video title
duration number READ-ONLY
>=0
Total duration in seconds
channel {
Publication channel details

id integer READ-ONLY
title* string 1 to 512 chars
}
created_on* string Upload date
last_updated* string Last publication settings update
owner_display_name string READ-ONLY
Video owner identity
view_count integer READ-ONLY
>=0
Number of times wideo has been opened
average_view_time number READ-ONLY
>=0
Average watch time
unique_views_count integer READ-ONLY
>=0
Number of times the video has been played
unique_viewers_count integer READ-ONLY
>=0
Number of accounts that have watched this video - Only works with private videos
qualified_views_count integer READ-ONLY
>=0
Number of times viewers have watched at least 50% of the video
last_view_date string READ-ONLY
Last time someone viewed the video
likes_count integer READ-ONLY
>=0
number of likes
play_url string READ-ONLY
URL to play the video in instant-tv
publish_start_date string READ-ONLY
Publication start date
publish_end_date string READ-ONLY
Publication end date
total_file_size string READ-ONLY
Total video file size in kilo bytes
}

STATUS CODE - 400: Invalid parameters.

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: You can only filter by your agenda or you as a viewer

201 of 352
15. NOTIFICATIONS

15.1 GET /notifications/

Viewset for push notifications

REQUEST
QUERY PARAMETERS
NAME TYPE DESCRIPTION

ordering string Which field to use when ordering the results.

page integer A page number within the paginated result set.
page_size integer Number of results to return per page.

RESPONSE

STATUS CODE - 200:

RESPONSE MODEL - application/json

{
pagination* {
total_results integer
results_per_page integer
total_pages integer
current_page integer
previous_page integer
next_page integer
}
results* [{
Array of object:

title* string 1 to 255 chars

description string max:1024 chars
target_url string max:200 chars
send_on string
datetime_sent string READ-ONLY
id integer READ-ONLY
status string READ-ONLY
min:1 chars
audience [{
Array of object:

type* string min:1 chars

value* string min:1 chars
name* string min:1 chars
}]
author_display string READ-ONLY
min:1 chars
}]
}

15.2 POST /notifications/

202 of 352
Send a notification.

You can send notification to all users. Notification has a

title: Notification main text

description: Notification sub-text
datetime: Date when the notification is scheduled to be sent
audience: List of audience identifiers or [] for all. Defaults to all if missing

To use this end-point, you have to be cloud-admin.

REQUEST

RESPONSE

STATUS CODE - 201: Notification created and/or sent.

STATUS CODE - 400: Request is invalid.

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied or service not enabled.

STATUS CODE - 503: The server we use to send notifications is unavailable at the moment.

15.3 POST /notifications/estimate-audience-rate/

Viewset for push notifications

REQUEST
REQUEST BODY - application/json
{
audience* [{
Array of object:

type* string min:1 chars

value* string min:1 chars
name* string min:1 chars
}]
}

RESPONSE

STATUS CODE - 200: Audience reaching statistics.

STATUS CODE - 400: Request is invalid.

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied or service not enabled.

15.4 GET /notifications/search-audience/

Look for audience using input query string to find matching group names or user names.

Look for audience using input query string to find matching group names or user names.Returns 10
first matching items of each kind (users and groups)

203 of 352
 query: Look for users or groups which name contain query

REQUEST
QUERY PARAMETERS
NAME TYPE DESCRIPTION

ordering string Which field to use when ordering the results.

page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
*query string User of group name contains
1 to 30 chars

RESPONSE

STATUS CODE - 200: List of audiences matching query

STATUS CODE - 400: Invalid parameters.

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

15.5 GET /notifications/{id}/

Viewset for push notifications

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*id string A unique integer value identifying this notification.

RESPONSE

STATUS CODE - 200:

RESPONSE MODEL - application/json

{
title* string 1 to 255 chars
description string max:1024 chars
target_url string max:200 chars
send_on string
datetime_sent string READ-ONLY
id integer READ-ONLY
status string READ-ONLY
min:1 chars
audience [{
Array of object:

type* string min:1 chars

value* string min:1 chars
name* string min:1 chars
}]

204 of 352
 author_display string READ-ONLY
min:1 chars
}

15.6 PUT /notifications/{id}/

Modify a scheduled notification.

Modify a scheduled notification.When removing the "send_on" attribute, you're asking to send the
notification right-now.

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*id string A unique integer value identifying this notification.

RESPONSE

STATUS CODE - 200: Notification updated.

STATUS CODE - 400: Request is invalid.

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied or service not enabled.

STATUS CODE - 503: The server we use to send notifications is unavailable at the moment.

15.7 DELETE /notifications/{id}/

Cancel the emission of a scheduled notification

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*id string A unique integer value identifying this notification.

RESPONSE

STATUS CODE - 204: Notification cancelled.

STATUS CODE - 400: Request is invalid.

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied or service not enabled.

15.8 PATCH /notifications/{id}/

Viewset for push notifications

205 of 352
REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*id string A unique integer value identifying this notification.

REQUEST BODY - application/json

{
title* string 1 to 255 chars
description string max:1024 chars
target_url string max:200 chars
send_on string
datetime_sent string READ-ONLY
id integer READ-ONLY
status string READ-ONLY
min:1 chars
audience [{
Array of object:

type* string min:1 chars

value* string min:1 chars
name* string min:1 chars
}]
author_display string READ-ONLY
min:1 chars
}

RESPONSE

STATUS CODE - 200:

RESPONSE MODEL - application/json

{
title* string 1 to 255 chars
description string max:1024 chars
target_url string max:200 chars
send_on string
datetime_sent string READ-ONLY
id integer READ-ONLY
status string READ-ONLY
min:1 chars
audience [{
Array of object:

type* string min:1 chars

value* string min:1 chars
name* string min:1 chars
}]
author_display string READ-ONLY
min:1 chars
}

206 of 352
16. ORGANIZATION

16.1 GET /organization/teams/

List and filter teams.

List teams with their members.You can filter on the team id, name, type and members (user ids)

REQUEST
QUERY PARAMETERS
NAME TYPE DESCRIPTION

page integer A page number within the paginated result set.

page_size integer Number of results to return per page.
team_ids string Team IDs (Comma-separated list of numbers, e.g. `1,2,3`)
min:1 chars
name string Team name
min:1 chars
type enum 0: Personal (Visible by the owner only)
ALLOWED: 0, 1: Shared (Visible by members)
1
member_ids string Member user IDs (Comma-separated list of numbers, e.g. `1,2,3`)
min:1 chars
owner_ids string Owner user IDs (Comma-separated list of numbers, e.g. `1,2,3`)
min:1 chars
exclude_ids string Exclude some teams from the results (Comma-separated list of numbers, e.g. `1,2,3`)
min:1 chars
show_all boolean Show shared teams you don't belong to nor own (you need to be at least
CLOUD_POWERUSER)

RESPONSE

STATUS CODE - 200:

RESPONSE MODEL - application/json

{
id integer READ-ONLY
owner* {
User who requested the access

id* integer User ID

first_name* string min:1 chars
First name
last_name* string min:1 chars
Last name
picture string READ-ONLY
Profile picture URI
agenda_id integer READ-ONLY
ID of the viewer's agenda
}
name* string min:1 chars

207 of 352
 Team name
type enum ALLOWED:0, 1
members* [{
Array of object: Members

user* {
User who requested the access

id* integer User ID

first_name* string min:1 chars
First name
last_name* string min:1 chars
Last name
picture string READ-ONLY
Profile picture URI
agenda_id integer READ-ONLY
ID of the viewer's agenda
}
}]
}

STATUS CODE - 400: Invalid parameters.

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

16.2 POST /organization/teams/

Create a personal or shared team of people.

A personal team is a group only visible by the owner.A shared team is visible by its members (e.g. a
project team).

REQUEST

RESPONSE

STATUS CODE - 201:

RESPONSE MODEL - application/json

{
id integer READ-ONLY
owner* {
User who requested the access

id* integer User ID

first_name* string min:1 chars
First name
last_name* string min:1 chars
Last name
picture string READ-ONLY
Profile picture URI
agenda_id integer READ-ONLY
ID of the viewer's agenda
}
name* string min:1 chars
Team name
type enum ALLOWED:0, 1
members* [{
Array of object: Members

208 of 352
 user* {
User who requested the access

id* integer User ID

first_name* string min:1 chars
First name
last_name* string min:1 chars
Last name
picture string READ-ONLY
Profile picture URI
agenda_id integer READ-ONLY
ID of the viewer's agenda
}
}]
}

STATUS CODE - 400: Invalid parameters.

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

16.3 DELETE /organization/teams/delete-all-shared/{user_id}/

Remove all shared teams owned by a user.

Remove all shared teams owned by a specific user. Their personal teams won't be deleted.You have be
at least CLOUD_POWERUSER.

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*user_id integer User ID

RESPONSE

STATUS CODE - 204: Success

STATUS CODE - 400: Invalid parameters.

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

16.4 DELETE /organization/teams/remove-from-all/{user_id}/

Remove a user from all your personal teams.

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*user_id integer User ID

209 of 352
RESPONSE

STATUS CODE - 204: Success

STATUS CODE - 400: Invalid parameters.

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

16.5 PUT /organization/teams/{id}/

Update a specific team.

You have to be the owner of the team.

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*id string A unique integer value identifying this team.

RESPONSE

STATUS CODE - 200:

RESPONSE MODEL - application/json

{
id integer READ-ONLY
owner* {
User who requested the access

id* integer User ID

first_name* string min:1 chars
First name
last_name* string min:1 chars
Last name
picture string READ-ONLY
Profile picture URI
agenda_id integer READ-ONLY
ID of the viewer's agenda
}
name* string min:1 chars
Team name
type enum ALLOWED:0, 1
members* [{
Array of object: Members

user* {
User who requested the access

id* integer User ID

first_name* string min:1 chars
First name
last_name* string min:1 chars
Last name
picture string READ-ONLY
Profile picture URI
agenda_id integer READ-ONLY

210 of 352
 ID of the viewer's agenda
}
}]
}

STATUS CODE - 400: Invalid parameters.

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

16.6 DELETE /organization/teams/{id}/

Delete a specific team.

You have to be the owner of the team.

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*id string A unique integer value identifying this team.

RESPONSE

STATUS CODE - 204: Success

STATUS CODE - 400: Invalid parameters.

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

16.7 PUT /organization/users/{user}/

Allow a user to create shared teams in your organization.

You have to be POWERUSER.

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*user string A unique value identifying this org user.

REQUEST BODY - application/json

{
can_manage_shared_teams boolean
}

RESPONSE

STATUS CODE - 200:

211 of 352
 RESPONSE MODEL - application/json
{
user_id string READ-ONLY
can_manage_shared_teams boolean
}

STATUS CODE - 400: Invalid parameters.

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

212 of 352
17. PRESENCE-DECLARATIONS

17.1 GET /presence-declarations/

List and filter presence declarations.

List and filter presence declarations.If no agenda_ids are given, fetch your own declarations.If no
range_start nor range_end are given, use last monday and next sunday respectively by default.If you do
not have reading rights (c.f. AgendaAccess) on the given agenda, it won't be shown.

REQUEST
QUERY PARAMETERS
NAME TYPE DESCRIPTION

page integer A page number within the paginated result set.

page_size integer Number of results to return per page.
*agenda_ids string Ids of the agendas (Comma-separated list of numbers, e.g. `1,2,3`)
min:1 chars
range_start date Filter from this date
range_end date Filter until this date

RESPONSE

STATUS CODE - 200:

RESPONSE MODEL - application/json

{
pagination* {
total_results integer
results_per_page integer
total_pages integer
current_page integer
previous_page integer
next_page integer
}
results* [{
Array of object:

id integer READ-ONLY
agenda_id integer
date string
morning* {
Morning (or all day) info

status* enum ALLOWED:0, 1, 2, 3, 4

The presence_status type:
Not set: 0
Office: 1
Remote: 2
Off site: 3
Off: 4
location {
Location in the resource address referential, as a JSON, "
"e.g. `{"country": "France", "site": "Paris", "floor": "1"}`

213 of 352
 }
note string max:512 chars
conf_id string 1 to 100 chars
}
afternoon {
Morning (or all day) info

status* enum ALLOWED:0, 1, 2, 3, 4

The presence_status type:
Not set: 0
Office: 1
Remote: 2
Off site: 3
Off: 4
location {
Location in the resource address referential, as a JSON, "
"e.g. `{"country": "France", "site": "Paris", "floor": "1"}`

}
note string max:512 chars
conf_id string 1 to 100 chars
}
is_all_day boolean READ-ONLY
author_id string READ-ONLY
}]
}

STATUS CODE - 400: Invalid parameters.

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

17.2 POST /presence-declarations/

Declare your presence status.

You can make an all-day declaration by omitting the afternoon parameter (NB: doing so will erase any
existing"afternoon" information. Consider using a NOT_SET status to avoid this).

REQUEST
REQUEST BODY - application/json
{
id integer READ-ONLY
agenda_id integer
date string
morning* {
Morning (or all day) info

status* enum ALLOWED:0, 1, 2, 3, 4

The presence_status type:
Not set: 0
Office: 1
Remote: 2
Off site: 3
Off: 4
location {
Location in the resource address referential, as a JSON, "
"e.g. `{"country": "France", "site": "Paris", "floor": "1"}`

}
note string max:512 chars
conf_id string 1 to 100 chars

214 of 352
 }
afternoon {
Morning (or all day) info

status* enum ALLOWED:0, 1, 2, 3, 4

The presence_status type:
Not set: 0
Office: 1
Remote: 2
Off site: 3
Off: 4
location {
Location in the resource address referential, as a JSON, "
"e.g. `{"country": "France", "site": "Paris", "floor": "1"}`

}
note string max:512 chars
conf_id string 1 to 100 chars
}
is_all_day boolean READ-ONLY
author_id string READ-ONLY
}

RESPONSE

STATUS CODE - 200:

RESPONSE MODEL - application/json

{
id integer READ-ONLY
agenda_id integer
date string
morning* {
Morning (or all day) info

status* enum ALLOWED:0, 1, 2, 3, 4

The presence_status type:
Not set: 0
Office: 1
Remote: 2
Off site: 3
Off: 4
location {
Location in the resource address referential, as a JSON, "
"e.g. `{"country": "France", "site": "Paris", "floor": "1"}`

}
note string max:512 chars
conf_id string 1 to 100 chars
}
afternoon {
Morning (or all day) info

status* enum ALLOWED:0, 1, 2, 3, 4

The presence_status type:
Not set: 0
Office: 1
Remote: 2
Off site: 3
Off: 4
location {
Location in the resource address referential, as a JSON, "
"e.g. `{"country": "France", "site": "Paris", "floor": "1"}`

}
note string max:512 chars
conf_id string 1 to 100 chars
}
is_all_day boolean READ-ONLY

215 of 352
 author_id string READ-ONLY

STATUS CODE - 400: Invalid parameters.

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

17.3 POST /presence-declarations/export/

Request an export of currently active PresenceDeclarations instances

Request an export of currently active PresenceDeclarations instances.The resulting file will be sent by
email.You have to be cloud-poweruser.

REQUEST
REQUEST BODY - application/json
{
user_ids string min:1 chars
Ids of the users (Comma-separated list of numbers, e.g. `1,2,3`)
anonymous boolean Make user infos anonymous
range_start* string Filter from this date
range_end* string Filter until this date
}

RESPONSE

STATUS CODE - 200: Export requested.

STATUS CODE - 400: Invalid parameters.

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

17.4 GET /presence-declarations/notes/

Get list of latest declaration notes.

REQUEST
QUERY PARAMETERS
NAME TYPE DESCRIPTION

page integer A page number within the paginated result set.

page_size integer Number of results to return per page.
query string Search text
min:1 chars
number integer Number of notes to return (max. 40)

RESPONSE

STATUS CODE - 200:

216 of 352
 RESPONSE MODEL - application/json
{
pagination* {
total_results integer
results_per_page integer
total_pages integer
current_page integer
previous_page integer
next_page integer
}
results* [{
Array of object:

id integer READ-ONLY
agenda_id integer
date string
morning* {
Morning (or all day) info

status* enum ALLOWED:0, 1, 2, 3, 4

The presence_status type:
Not set: 0
Office: 1
Remote: 2
Off site: 3
Off: 4
location {
Location in the resource address referential, as a JSON, "
"e.g. `{"country": "France", "site": "Paris", "floor": "1"}`

}
note string max:512 chars
conf_id string 1 to 100 chars
}
afternoon {
Morning (or all day) info

status* enum ALLOWED:0, 1, 2, 3, 4

The presence_status type:
Not set: 0
Office: 1
Remote: 2
Off site: 3
Off: 4
location {
Location in the resource address referential, as a JSON, "
"e.g. `{"country": "France", "site": "Paris", "floor": "1"}`

}
note string max:512 chars
conf_id string 1 to 100 chars
}
is_all_day boolean READ-ONLY
author_id string READ-ONLY
}]
}

STATUS CODE - 400: Invalid parameters.

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

17.5 POST /presence-declarations/unlink-booking/

Unlink a booking from a declaration

217 of 352
Unlink the given confID if it is linked to a declaration

REQUEST
REQUEST BODY - application/json
{
conf_id* string min:1 chars
Booking confID
}

RESPONSE

STATUS CODE - 204: Booking unlinked

STATUS CODE - 400: Invalid parameters.

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

17.6 GET /presence-declarations/{id}/

Get a single presence declaration.

Get a single presence declaration from its ID.

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*id string A unique integer value identifying this presence declaration.

RESPONSE

STATUS CODE - 200:

RESPONSE MODEL - application/json

{
id integer READ-ONLY
agenda_id integer
date string
morning* {
Morning (or all day) info

status* enum ALLOWED:0, 1, 2, 3, 4

The presence_status type:
Not set: 0
Office: 1
Remote: 2
Off site: 3
Off: 4
location {
Location in the resource address referential, as a JSON, "
"e.g. `{"country": "France", "site": "Paris", "floor": "1"}`

}
note string max:512 chars
conf_id string 1 to 100 chars
}

218 of 352
 afternoon {
Morning (or all day) info

status* enum ALLOWED:0, 1, 2, 3, 4

The presence_status type:
Not set: 0
Office: 1
Remote: 2
Off site: 3
Off: 4
location {
Location in the resource address referential, as a JSON, "
"e.g. `{"country": "France", "site": "Paris", "floor": "1"}`

}
note string max:512 chars
conf_id string 1 to 100 chars
}
is_all_day boolean READ-ONLY
author_id string READ-ONLY
}

STATUS CODE - 400: Invalid parameters.

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

STATUS CODE - 404: Presence declaration not found.

219 of 352
18. PRESENCE-RULES

18.1 GET /presence-rules/

List and filter presence rules grouped by user.

List and filter presence rules grouped by user.You have to be cloud-poweruser.

REQUEST
QUERY PARAMETERS
NAME TYPE DESCRIPTION

ordering string Which field to use when ordering the results.

search string A search term.
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
user_ids string Ids of the users (Comma-separated list of numbers, e.g. `1,2,3`)
min:1 chars
range_start date Filter from this date
range_end date Filter until this date

RESPONSE

STATUS CODE - 200:

RESPONSE MODEL - application/json

{
id integer READ-ONLY
first_name string max:150 chars
last_name string max:150 chars
profile* {
title string max:250 chars
company string max:100 chars
direction string max:250 chars
department string max:250 chars
service string max:250 chars
team string max:250 chars
building string max:250 chars
office string max:250 chars
picture string READ-ONLY
Profile picture URI
}
presence_rules* [{
Array of object:

id integer READ-ONLY
user* integer
creator {
id integer READ-ONLY
first_name string max:150 chars
last_name string max:150 chars

220 of 352
 email string max:254 chars
full_name* string min:1 chars
}
date_pub_added string READ-ONLY
valid_from* string
valid_until string
home_min_days number between 0 and 7
home_max_days number between 0 and 7
office_min_days number between 0 and 7
office_max_days number between 0 and 7
}]
office_presence_enabled string READ-ONLY
Allowed to use office presence module
can_manage_shared_teams string READ-ONLY
Allowed to create teams shared with their members (i.e. manager profile)
}

STATUS CODE - 400: Invalid parameters.

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

18.2 POST /presence-rules/

Declare one or many presence rules.

Declare a presence rule. The body can be an array to create many at once.

REQUEST
REQUEST BODY - application/json
{
id integer READ-ONLY
user* integer
creator {
id integer READ-ONLY
first_name string max:150 chars
last_name string max:150 chars
email string max:254 chars
full_name* string min:1 chars
}
date_pub_added string READ-ONLY
valid_from* string
valid_until string
home_min_days number between 0 and 7
home_max_days number between 0 and 7
office_min_days number between 0 and 7
office_max_days number between 0 and 7
}

RESPONSE

STATUS CODE - 201:

RESPONSE MODEL - application/json

{

221 of 352
 id integer READ-ONLY
user* integer
creator {
id integer READ-ONLY
first_name string max:150 chars
last_name string max:150 chars
email string max:254 chars
full_name* string min:1 chars
}
date_pub_added string READ-ONLY
valid_from* string
valid_until string
home_min_days number between 0 and 7
home_max_days number between 0 and 7
office_min_days number between 0 and 7
office_max_days number between 0 and 7
}

STATUS CODE - 400: Invalid parameters.

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

18.3 POST /presence-rules/export/

Request an export of currently active PresenceRule instances

Request an export of currently active PresenceRule instances.The resulting file will be sent by
email.You have to be cloud-poweruser.

REQUEST
REQUEST BODY - application/json
{
user_ids string min:1 chars
Ids of the users (Comma-separated list of numbers, e.g. `1,2,3`)
}

RESPONSE

STATUS CODE - 200: Export requested.

STATUS CODE - 400: Invalid parameters.

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

18.4 POST /presence-rules/import/

Request an import of presence rules from excel.

Request an import of presence rules from an excel file. Use the file generated from the export
endpointas a template. A report file will be sent by email.

222 of 352
REQUEST
FORM DATA PARAMETERS
NAME TYPE DESCRIPTION

file string(binary) Presence rules XLSX file

RESPONSE

STATUS CODE - 200: Import requested.

STATUS CODE - 400: Invalid parameters.

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

223 of 352
19. RESOURCE-STATES

19.1 PUT /resource-states/{id}/

Update a specific state message

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*id string A unique integer value identifying this resource state message.

REQUEST BODY - application/json

{
resource* integer
user integer
bookable boolean
status enum ALLOWED:0, 1, 2, 3, 4
comment string
start_date string
back_to_service_expected_on string
actual_end_date string
back_to_service_auto boolean
}

RESPONSE

STATUS CODE - 200:

RESPONSE MODEL - application/json

{
resource* integer
user integer
bookable boolean
status enum ALLOWED:0, 1, 2, 3, 4
comment string
start_date string
back_to_service_expected_on string
actual_end_date string
back_to_service_auto boolean
}

STATUS CODE - 400: Invalid parameters.

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

19.2 DELETE /resource-states/{id}/

Delete a specific state message.

224 of 352
Delete a specific state message.

Admin & local admin can delete the state message

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*id string A unique integer value identifying this resource state message.

RESPONSE

STATUS CODE - 204: Success

STATUS CODE - 400: Invalid parameters.

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

STATUS CODE - 404: State message not found

225 of 352
20. RESOURCE-TYPES

20.1 GET /resource-types/

Filter resource types.

Filter resource types.

You can filter types with:

all: All resources and devices,

resources: Only resources,
bookable: Only bookable resources,
devices: Only devices.

You can also use other filters:

use "only_available" to only show resource types used in your cloud,

use "already_booked" to only show resource types you already booked,
use "location" to filter by location (if you specify a location, "only_available" is automatically on).

REQUEST
QUERY PARAMETERS
NAME TYPE DESCRIPTION

filter enum Resource type filter

ALLOWED: all,
resources, bookable,
devices
location string Location value <i>(e.g. SharingCloud/France)</i>
min:1 chars
location_filter string Location filter <i>(e.g. company,country)</i>
min:1 chars
<i>Available values</i> : company, division, site, departement,
corporation, building, floor, door, number, street_line1, street_line2,
zipcode, city, state, cedex, postal_box, country</i>
already_booked boolean Only show already booked resource types
only_available boolean Only show used resource types

RESPONSE

STATUS CODE - 200:

RESPONSE MODEL - application/json

[{
Array of object:

type_id* integer Resource type ID

name* string min:1 chars
Resource type name
icon* string min:1 chars
Resource icon name
category string min:1 chars

226 of 352
 Resource type category
}]

STATUS CODE - 400: Invalid parameters.

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

227 of 352
21. RESOURCES

21.1 POST /resources/

Create a resource.

REQUEST

RESPONSE

STATUS CODE - 200:

RESPONSE MODEL - application/json

{
id integer READ-ONLY
name* string 1 to 512 chars
resource_allowed_reservation enum DEFAULT:1
ALLOWED:1, 5, 2, 3, 4
resource_type enum DEFAULT:1
ALLOWED:6, 7, 8, 9, 15, 34,
38, 39, 40, 41, 1, 2, 3, 11,
4, 5, 20, 23, 24, 25, 26, 29,
31, 32, 33, 35, 36, 12, 13,
19, 27, 10, 18, 21, 16, 17,
22, 14, 30, 28, 37, 42, 43,
44, 45, 46, 48, 49, 50, 51,
52, 53, 54, 55, 56, 57
capacity* integer >=0
address* {
company* string 1 to 100 chars
country* string max:100 chars
city* string max:100 chars
site* string 1 to 100 chars
division string 1 to 100 chars
departement string max:50 chars
corporation string max:100 chars
building string max:50 chars
floor string max:50 chars
door string max:50 chars
number string max:30 chars
street_line1 string max:100 chars
street_line2 string max:100 chars
zipcode string max:5 chars
state string max:100 chars
cedex string max:100 chars
postal_box string max:20 chars
}
display_name string max:512 chars
alternate_room_name string max:512 chars
description string
contact_phone string max:100 chars
contact_email string max:254 chars
contact string max:512 chars
custom_contact_info string max:512 chars

228 of 352
sip_uri string min:1 chars
ip_address string min:1 chars
is_visible boolean
is_internal boolean
nb_participants_required boolean
is_custom_contact_info boolean
bms_zone string max:512 chars
site_code string max:512 chars
is_moderated boolean
book_horizon integer between 0 and 2147483647
DEFAULT:0
imputation_code boolean
imputation_code_label string max:512 chars
imputation_code_required boolean
requisitionable boolean
requisitionable_label string max:512 chars
vmr_num string max:512 chars
not_prm boolean
is_blind boolean
not_projector boolean
help_button_url string max:200 chars
min_booking_duration integer
max_booking_duration integer
isdn_number string min:1 chars
e164_number string min:1 chars
h323id string min:1 chars
room_phone_number string min:1 chars
status integer READ-ONLY
bookable boolean READ-ONLY
photo string READ-ONLY
photo_uuid string READ-ONLY
qrcode_url string READ-ONLY
QRCode URL pointing to Instant Mobile resource
page
qrcode_report_url string READ-ONLY
QRCode URL pointing to Instant Mobile issue
reporting page
calendar_processing {
instant_booking_mode enum ALLOWED:0, 1, 2
instant_booking_duration_1 integer between -2147483648
and 2147483647
instant_booking_duration_2 integer between -2147483648
and 2147483647
instant_booking_duration_step enum ALLOWED:5, 10, 15, 30,
45, 60
instant_booking_confirmation_required boolean
instant_booking_auth_required boolean
meeting_ack boolean
meeting_ack_start_time enum ALLOWED:0, 5, 10, 15,
30, 45, 60, 75, 90,
105, 120, 135, 150,
165, 180, 195, 210,
225, 240
meeting_ack_end_time enum ALLOWED:0, 5, 10, 15,
30, 45, 60, 75, 90,
105, 120, 135, 150,
165, 180, 195, 210,
225, 240

229 of 352
 meeting_ack_confirmation_required boolean
meeting_ack_auth_required boolean
meeting_ack_auth_required_private_meetings boolean
meeting_ack_release boolean
meeting_ack_reminder boolean
extendable_meeting boolean
extendable_meeting_mode enum ALLOWED:0, 1
extend_meeting_duration_1 integer between -2147483648
and 2147483647
extend_meeting_duration_2 integer between -2147483648
and 2147483647
extend_meeting_duration_step enum ALLOWED:5, 10, 15, 30,
45, 60
meeting_ack_release_auth_required boolean
meeting_ack_release_auth_required_private_meetings boolean
time_before_sensor_auto_release enum ALLOWED:4, 6, 8, 10,
12, 16, 20
apply_rights_book boolean
apply_rights_release boolean
apply_rights_confirm boolean
auto_release_force boolean
}
max_date_from_now string READ-ONLY
min:1 chars
max_resa_hours string READ-ONLY
min:1 chars
available boolean READ-ONLY
compounds integer READ-ONLY
default_name string READ-ONLY
min:1 chars
Display name or technical name
interop_calendaring_email string READ-ONLY
min:1 chars
interop_videoconferencing_email string READ-ONLY
min:1 chars
teams_meeting_enabled boolean READ-ONLY
first_linked_map {
First map where this resource is shown

id integer READ-ONLY
title string 1 to 512 chars
display_name string 1 to 512 chars
description string min:1 chars
floor_top integer
floor_bottom integer
display_type integer between -2147483648 and 2147483647
legend_display_type integer between -2147483648 and 2147483647
}
ordered_photos [string] min:1 chars
resource_tags [string]
service_offers [{
Array of object:

id* integer ID of the service offer

name* string min:1 chars
Name of the service offer
availability* enum ALLOWED:AVAILABLE, DISABLED, TOO_SHORT_NOTICE
Availability of this service based on the requested delivery time - Values: `AVAILABLE` (This service
offer is available), `DISABLED` (This service offer has been disabled and is not currently available),
`TOO_SHORT_NOTICE` (This service offer requires a notice period and the requested delivery time
is too close)

230 of 352
 css_icon* string min:1 chars
CSS class of an icon symbolizing this service
}]
}

STATUS CODE - 400: Invalid parameters.

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

21.2 GET /resources/bookings/

Return upcoming bookings for filtered resources.

You can use multiple filters:

By start datetime (default is now),

By end datetime (default is now + 2 days),
Maximum time range is 2 days
By including only some resources with include_resources,
By limiting the number of upcoming bookings returned with nb_bookings (default is 1 and
maximum is 100),

Private bookings will have their 'owner' and 'creator' set to null,and text fields set to a localized
'PRIVATE' label.

Warning: If enabled, the videoonline_booking_grid_info_display_low_security cloud propertywill allow

the display of non-private booking information, even if the authenticated user has no righton the
booking.

REQUEST
QUERY PARAMETERS
NAME TYPE DESCRIPTION

page integer A page number within the paginated result set.

page_size integer Number of results to return per page.
start date-time Start datetime
end date-time End datetime
include_resources string Resource IDs to include (e.g. 1,2,3) (Comma-separated list of numbers,
min:1 chars e.g. `1,2,3`)
nb_bookings integer Number of upcoming bookings to return
between 1 and
100

RESPONSE

STATUS CODE - 200:

RESPONSE MODEL - application/json

[{
Array of object:

resource_id* integer Resource ID

231 of 352
bookings* [{
Array of object:

id integer READ-ONLY
conf_id* string min:1 chars
start* string
end* string
last_update* string
duration* integer
title* string 1 to 512 chars
is_valid* boolean
description string
comment string READ-ONLY
min:1 chars
from_application enum ALLOWED:0, 1, 2, 3, 4, 5, 6, 7,
8, 9, 10, 11, 12, 13, 14, 15,
16, 17
owner* {
id integer READ-ONLY
uuid string READ-ONLY
first_name string max:150 chars
last_name string max:150 chars
email string max:254 chars
username* string 1 to 150 chars
PATTERN:^[\w.@+-]+$
Required. 150 characters or fewer. Letters, digits and @/./
+/-/_ only.
full_name* string min:1 chars
account_type string READ-ONLY
standard, service_with_impersonation,
service_without_impersonation, device
cloud_space_right {
instant_social* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_tv* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_booking* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_signage* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_metrics* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_device_manager* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
}
}
creator* {
id integer READ-ONLY
uuid string READ-ONLY
first_name string max:150 chars
last_name string max:150 chars
email string max:254 chars
username* string 1 to 150 chars

232 of 352
 PATTERN:^[\w.@+-]+$
Required. 150 characters or fewer. Letters, digits and @/./
+/-/_ only.
full_name* string min:1 chars
account_type string READ-ONLY
standard, service_with_impersonation,
service_without_impersonation, device
cloud_space_right {
instant_social* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_tv* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_booking* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_signage* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_metrics* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_device_manager* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
}
}
organizer* string min:1 chars
organizer_target* {
id integer READ-ONLY
uuid string READ-ONLY
first_name string max:150 chars
last_name string max:150 chars
email string max:254 chars
username* string 1 to 150 chars
PATTERN:^[\w.@+-]+$
Required. 150 characters or fewer. Letters, digits and @/./
+/-/_ only.
full_name* string min:1 chars
account_type string READ-ONLY
standard, service_with_impersonation,
service_without_impersonation, device
cloud_space_right {
instant_social* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_tv* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_booking* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_signage* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_metrics* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN

233 of 352
 instant_device_manager* enum ALLOWED:CLOUD_GUEST,
CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
}
}
private* boolean
imputation_code string max:512 chars
is_recurring* boolean
conference_type_id string READ-ONLY
sensitivity enum ALLOWED:0, 1, 2, 3
has_moderation string READ-ONLY
demand_status* integer
logo string READ-ONLY
in_progress* boolean
teams_meeting_requested boolean READ-ONLY
visio_infos {
teams* {
Teams meeting join URLs

web_url* string min:1 chars

Web browser join URL
desktop_url* string min:1 chars
Desktop app join URL
deeplink_scheme* string min:1 chars
Deeplink scheme to join using a mobile app
}
zoom* {
Teams meeting join URLs

web_url* string min:1 chars

Web browser join URL
desktop_url* string min:1 chars
Desktop app join URL
deeplink_scheme* string min:1 chars
Deeplink scheme to join using a mobile app
}
webex* {
Teams meeting join URLs

web_url* string min:1 chars

Web browser join URL
desktop_url* string min:1 chars
Desktop app join URL
deeplink_scheme* string min:1 chars
Deeplink scheme to join using a mobile app
}
}
}]
}]

STATUS CODE - 400: Invalid parameters.

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

21.3 GET /resources/favorites/

Get list of user favorites resources.

234 of 352
REQUEST
QUERY PARAMETERS
NAME TYPE DESCRIPTION

page integer A page number within the paginated result set.

page_size integer Number of results to return per page.

RESPONSE

STATUS CODE - 200:

RESPONSE MODEL - application/json

{
pagination* {
total_results integer
results_per_page integer
total_pages integer
current_page integer
previous_page integer
next_page integer
}
results* [{
Array of object:

date_pub_added string READ-ONLY

date_pub_lastmodified string READ-ONLY
user {
id integer READ-ONLY
uuid string READ-ONLY
first_name string max:150 chars
last_name string max:150 chars
email string max:254 chars
username* string 1 to 150 chars
PATTERN:^[\w.@+-]+$
Required. 150 characters or fewer. Letters, digits and @/./
+/-/_ only.
full_name* string min:1 chars
account_type string READ-ONLY
standard, service_with_impersonation,
service_without_impersonation, device
cloud_space_right {
instant_social* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_tv* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_booking* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_signage* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_metrics* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_device_manager* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,

235 of 352
 CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
}
}
resource {
id integer READ-ONLY
name* string 1 to 512 chars
resource_allowed_reservation enum DEFAULT:1
ALLOWED:1, 5, 2, 3, 4
resource_type enum DEFAULT:1
ALLOWED:6, 7, 8, 9, 15,
34, 38, 39, 40, 41, 1,
2, 3, 11, 4, 5, 20,
23, 24, 25, 26, 29,
31, 32, 33, 35, 36,
12, 13, 19, 27, 10,
18, 21, 16, 17, 22,
14, 30, 28, 37, 42,
43, 44, 45, 46, 48,
49, 50, 51, 52, 53,
54, 55, 56, 57
capacity* integer >=0
address* {
company* string 1 to 100 chars
country* string max:100 chars
city* string max:100 chars
site* string 1 to 100 chars
division string 1 to 100 chars
departement string max:50 chars
corporation string max:100 chars
building string max:50 chars
floor string max:50 chars
door string max:50 chars
number string max:30 chars
street_line1 string max:100 chars
street_line2 string max:100 chars
zipcode string max:5 chars
state string max:100 chars
cedex string max:100 chars
postal_box string max:20 chars
}
display_name string max:512 chars
alternate_room_name string max:512 chars
description string
contact_phone string max:100 chars
contact_email string max:254 chars
contact string max:512 chars
custom_contact_info string max:512 chars
sip_uri string min:1 chars
ip_address string min:1 chars
is_visible boolean
is_internal boolean
nb_participants_required boolean
is_custom_contact_info boolean
bms_zone string max:512 chars
site_code string max:512 chars
is_moderated boolean

236 of 352
book_horizon integer between 0 and
2147483647
DEFAULT:0
imputation_code boolean
imputation_code_label string max:512 chars
imputation_code_required boolean
requisitionable boolean
requisitionable_label string max:512 chars
vmr_num string max:512 chars
not_prm boolean
is_blind boolean
not_projector boolean
help_button_url string max:200 chars
min_booking_duration integer
max_booking_duration integer
isdn_number string min:1 chars
e164_number string min:1 chars
h323id string min:1 chars
room_phone_number string min:1 chars
status integer READ-ONLY
bookable boolean READ-ONLY
photo string READ-ONLY
photo_uuid string READ-ONLY
qrcode_url string READ-ONLY
QRCode URL pointing to Instant
Mobile resource page
qrcode_report_url string READ-ONLY
QRCode URL pointing to Instant
Mobile issue reporting page
calendar_processing {
instant_booking_mode enum ALLOWED:0, 1, 2
instant_booking_duration_1 integer between
-2147483648 and
2147483647
instant_booking_duration_2 integer between
-2147483648 and
2147483647
instant_booking_duration_step enum ALLOWED:5, 10,
15, 30, 45, 60
instant_booking_confirmation_required boolean
instant_booking_auth_required boolean
meeting_ack boolean
meeting_ack_start_time enum ALLOWED:0, 5, 10,
15, 30, 45, 60,
75, 90, 105,
120, 135, 150,
165, 180, 195,
210, 225, 240
meeting_ack_end_time enum ALLOWED:0, 5, 10,
15, 30, 45, 60,
75, 90, 105,
120, 135, 150,
165, 180, 195,
210, 225, 240
meeting_ack_confirmation_required boolean
meeting_ack_auth_required boolean
meeting_ack_auth_required_private_meetings boolean
meeting_ack_release boolean

237 of 352
 meeting_ack_reminder boolean
extendable_meeting boolean
extendable_meeting_mode enum ALLOWED:0, 1
extend_meeting_duration_1 integer between
-2147483648 and
2147483647
extend_meeting_duration_2 integer between
-2147483648 and
2147483647
extend_meeting_duration_step enum ALLOWED:5, 10,
15, 30, 45, 60
meeting_ack_release_auth_required boolean
meeting_ack_release_auth_required_private_meetings boolean
time_before_sensor_auto_release enum ALLOWED:4, 6, 8,
10, 12, 16, 20
apply_rights_book boolean
apply_rights_release boolean
apply_rights_confirm boolean
auto_release_force boolean
}
max_date_from_now string READ-ONLY
min:1 chars
max_resa_hours string READ-ONLY
min:1 chars
available boolean READ-ONLY
compounds integer READ-ONLY
default_name string READ-ONLY
min:1 chars
Display name or technical name
interop_calendaring_email string READ-ONLY
min:1 chars
interop_videoconferencing_email string READ-ONLY
min:1 chars
teams_meeting_enabled boolean READ-ONLY
first_linked_map {
First map where this resource is shown

id integer READ-ONLY
title string 1 to 512 chars
display_name string 1 to 512 chars
description string min:1 chars
floor_top integer
floor_bottom integer
display_type integer between -2147483648 and 2147483647
legend_display_type integer between -2147483648 and 2147483647
}
ordered_photos [string] min:1 chars
resource_tags [string]
service_offers [{
Array of object:

id* integer ID of the service offer

name* string min:1 chars
Name of the service offer
availability* enum ALLOWED:AVAILABLE, DISABLED, TOO_SHORT_NOTICE
Availability of this service based on the requested delivery time - Values: `AVAILABLE`
(This service offer is available), `DISABLED` (This service offer has been disabled and is
not currently available), `TOO_SHORT_NOTICE` (This service offer requires a notice period
and the requested delivery time is too close)
css_icon* string min:1 chars
CSS class of an icon symbolizing this service

238 of 352
 }]
}
is_favourite boolean
}]
}

STATUS CODE - 400: Invalid parameters.

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

21.4 GET /resources/favorites/ids/

Get list of user favorites resources as a flat list of ids.

REQUEST
QUERY PARAMETERS
NAME TYPE DESCRIPTION

page integer A page number within the paginated result set.

page_size integer Number of results to return per page.

RESPONSE

STATUS CODE - 200:

RESPONSE MODEL - application/json

{
resource_fav_ids* [integer]
}

STATUS CODE - 400: Invalid parameters.

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

21.5 GET /resources/search/

Filter resources.

Filter resources.

You can use multiple filters:

By location,
By resource types,
By capacity,
By name query,
By excluding busy resources with start and end time,
By ignoring compound resources.
By skipping booking duration check.
By skipping booking horizon check.

239 of 352
 By interop type availability
By proximity to your workplace

Resources are then ordered:

By favourite,
By availability (only when skipping booking duration check),
By capacity,
Then by title.

REQUEST
QUERY PARAMETERS
NAME TYPE DESCRIPTION

page integer A page number within the paginated result set.

page_size integer Number of results to return per page.
location string Location value <i>(e.g. SharingCloud/France)</i>
min:1
chars
location_filter string Location filter <i>(e.g. company,country)</i>
min:1
chars <i>Available values</i> : company, division, site, departement,
corporation, building, floor, door, number, street_line1,
street_line2, zipcode, city, state, cedex, postal_box, country</
i>
only_near_me boolean Set true to get only resources located near you at the
requested time. This will use the location of your presence
status or your default workplace as a filter.This filter prevails
the 'location' filter.
resource_types string Comma-separated list of numbers, e.g. `1,2,3`
min:1
chars
capacity string Capacity (e.g. 4,-1 for a resource for at least 4 people)
min:1
chars
query string Name query
min:1
chars
start string Start datetime(s)
min:1
chars
end string End datetime(s)
min:1
chars
availability enum Free or busy resources (only if time range is given)
ALLOWED:
free, busy
ignore_compound boolean Ignore compound resources
skip_booking_duration_check boolean Don't exclude resources when requested start and end-date
don't comply with booking limits.
skip_booking_horizon_check boolean Don't exclude resources when requested start date is more
distant in time than their `book_horizon`
external_email string Identifier for the resource on an external system (e.g.
min:1 Exchange, Google, ...)
chars

240 of 352
 NAME TYPE DESCRIPTION

only_calendaring_interop boolean Only resources linked to an external calendaring system

only_videoconferencing_interop boolean Only resources linked to an external videoconferencing
system
show_hidden boolean Show hidden resources (You need to be at least
CLOUD_POWERUSER).
Defaults to true.
Forces to false if you are not at least CLOUD_POWERUSER.
need_projector boolean Set true if you need a resource with a projector
need_window boolean Set true if you need a resource with a window
need_pmr_access boolean Set true if you need a resource with a pmr access
not_requisitionable boolean Set true if you need a resource not requisitionable
not_moderated boolean Set true if you need a resource without moderation
nb_participants_not_required boolean Set true if you need a resource without setting number of
participants
imputation_code_not_required boolean Set true if you need a resource without setting the imputation
code

RESPONSE

STATUS CODE - 200:

RESPONSE MODEL - application/json

{
pagination* {
total_results integer
results_per_page integer
total_pages integer
current_page integer
previous_page integer
next_page integer
}
results* [{
Array of object:

id integer READ-ONLY
name* string 1 to 512 chars
resource_allowed_reservation enum DEFAULT:1
ALLOWED:1, 5, 2, 3, 4
resource_type enum DEFAULT:1
ALLOWED:6, 7, 8, 9, 15, 34,
38, 39, 40, 41, 1, 2, 3,
11, 4, 5, 20, 23, 24, 25,
26, 29, 31, 32, 33, 35,
36, 12, 13, 19, 27, 10,
18, 21, 16, 17, 22, 14,
30, 28, 37, 42, 43, 44,
45, 46, 48, 49, 50, 51,
52, 53, 54, 55, 56, 57
capacity* integer >=0
address* {
company* string 1 to 100 chars
country* string max:100 chars
city* string max:100 chars

241 of 352
 site* string 1 to 100 chars
division string 1 to 100 chars
departement string max:50 chars
corporation string max:100 chars
building string max:50 chars
floor string max:50 chars
door string max:50 chars
number string max:30 chars
street_line1 string max:100 chars
street_line2 string max:100 chars
zipcode string max:5 chars
state string max:100 chars
cedex string max:100 chars
postal_box string max:20 chars
}
display_name string max:512 chars
alternate_room_name string max:512 chars
description string
contact_phone string max:100 chars
contact_email string max:254 chars
contact string max:512 chars
custom_contact_info string max:512 chars
sip_uri string min:1 chars
ip_address string min:1 chars
is_visible boolean
is_internal boolean
nb_participants_required boolean
is_custom_contact_info boolean
bms_zone string max:512 chars
site_code string max:512 chars
is_moderated boolean
book_horizon integer between 0 and 2147483647
DEFAULT:0
imputation_code boolean
imputation_code_label string max:512 chars
imputation_code_required boolean
requisitionable boolean
requisitionable_label string max:512 chars
vmr_num string max:512 chars
not_prm boolean
is_blind boolean
not_projector boolean
help_button_url string max:200 chars
min_booking_duration integer
max_booking_duration integer
isdn_number string min:1 chars
e164_number string min:1 chars
h323id string min:1 chars
room_phone_number string min:1 chars
status integer READ-ONLY
bookable boolean READ-ONLY
photo string READ-ONLY
photo_uuid string READ-ONLY
qrcode_url string READ-ONLY
QRCode URL pointing to Instant Mobile
resource page
qrcode_report_url string READ-ONLY
QRCode URL pointing to Instant Mobile

242 of 352
 issue reporting page
calendar_processing {
instant_booking_mode enum ALLOWED:0, 1, 2
instant_booking_duration_1 integer between
-2147483648 and
2147483647
instant_booking_duration_2 integer between
-2147483648 and
2147483647
instant_booking_duration_step enum ALLOWED:5, 10, 15,
30, 45, 60
instant_booking_confirmation_required boolean
instant_booking_auth_required boolean
meeting_ack boolean
meeting_ack_start_time enum ALLOWED:0, 5, 10,
15, 30, 45, 60,
75, 90, 105, 120,
135, 150, 165,
180, 195, 210,
225, 240
meeting_ack_end_time enum ALLOWED:0, 5, 10,
15, 30, 45, 60,
75, 90, 105, 120,
135, 150, 165,
180, 195, 210,
225, 240
meeting_ack_confirmation_required boolean
meeting_ack_auth_required boolean
meeting_ack_auth_required_private_meetings boolean
meeting_ack_release boolean
meeting_ack_reminder boolean
extendable_meeting boolean
extendable_meeting_mode enum ALLOWED:0, 1
extend_meeting_duration_1 integer between
-2147483648 and
2147483647
extend_meeting_duration_2 integer between
-2147483648 and
2147483647
extend_meeting_duration_step enum ALLOWED:5, 10, 15,
30, 45, 60
meeting_ack_release_auth_required boolean
meeting_ack_release_auth_required_private_meetings boolean
time_before_sensor_auto_release enum ALLOWED:4, 6, 8, 10,
12, 16, 20
apply_rights_book boolean
apply_rights_release boolean
apply_rights_confirm boolean
auto_release_force boolean
}
max_date_from_now string READ-ONLY
min:1 chars
max_resa_hours string READ-ONLY
min:1 chars
available boolean READ-ONLY
compounds integer READ-ONLY
default_name string READ-ONLY
min:1 chars

243 of 352
 Display name or technical name
interop_calendaring_email string READ-ONLY
min:1 chars
interop_videoconferencing_email string READ-ONLY
min:1 chars
teams_meeting_enabled boolean READ-ONLY
first_linked_map {
First map where this resource is shown

id integer READ-ONLY
title string 1 to 512 chars
display_name string 1 to 512 chars
description string min:1 chars
floor_top integer
floor_bottom integer
display_type integer between -2147483648 and 2147483647
legend_display_type integer between -2147483648 and 2147483647
}
ordered_photos [string] min:1 chars
resource_tags [string]
service_offers [{
Array of object:

id* integer ID of the service offer

name* string min:1 chars
Name of the service offer
availability* enum ALLOWED:AVAILABLE, DISABLED, TOO_SHORT_NOTICE
Availability of this service based on the requested delivery time - Values: `AVAILABLE` (This
service offer is available), `DISABLED` (This service offer has been disabled and is not
currently available), `TOO_SHORT_NOTICE` (This service offer requires a notice period and the
requested delivery time is too close)
css_icon* string min:1 chars
CSS class of an icon symbolizing this service
}]
}]
}

STATUS CODE - 400: Invalid parameters.

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

21.6 GET /resources/state-messages/

Return a filtered list of resource state messages.

REQUEST
QUERY PARAMETERS
NAME TYPE DESCRIPTION

page integer A page number within the paginated result set.

page_size integer Number of results to return per page.
bookable boolean Bookable/non bookable (or both) resources
include_resources string Resource IDs to include (e.g. 1,2,3) (Comma-separated list of numbers, e.g.
min:1 chars `1,2,3`)
range_start date- Range start datetime
time

244 of 352
 NAME TYPE DESCRIPTION

range_end date- Range end datetime

time

RESPONSE

STATUS CODE - 200:

RESPONSE MODEL - application/json

{
resource* integer
user integer
bookable boolean
status enum ALLOWED:0, 1, 2, 3, 4
comment string
start_date string
back_to_service_expected_on string
actual_end_date string
back_to_service_auto boolean
}

STATUS CODE - 400: Invalid parameters.

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

21.7 GET /resources/{id}/

Get a specific resource.

Get a specific resource from ID.

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*id string A unique integer value identifying this Resource.

RESPONSE

STATUS CODE - 200:

RESPONSE MODEL - application/json

{
id integer READ-ONLY
name* string 1 to 512 chars
resource_allowed_reservation enum DEFAULT:1
ALLOWED:1, 5, 2, 3, 4
resource_type enum DEFAULT:1
ALLOWED:6, 7, 8, 9, 15, 34,
38, 39, 40, 41, 1, 2, 3, 11,
4, 5, 20, 23, 24, 25, 26, 29,

245 of 352
 31, 32, 33, 35, 36, 12, 13,
19, 27, 10, 18, 21, 16, 17,
22, 14, 30, 28, 37, 42, 43,
44, 45, 46, 48, 49, 50, 51,
52, 53, 54, 55, 56, 57
capacity* integer >=0
address* {
company* string 1 to 100 chars
country* string max:100 chars
city* string max:100 chars
site* string 1 to 100 chars
division string 1 to 100 chars
departement string max:50 chars
corporation string max:100 chars
building string max:50 chars
floor string max:50 chars
door string max:50 chars
number string max:30 chars
street_line1 string max:100 chars
street_line2 string max:100 chars
zipcode string max:5 chars
state string max:100 chars
cedex string max:100 chars
postal_box string max:20 chars
}
display_name string max:512 chars
alternate_room_name string max:512 chars
description string
contact_phone string max:100 chars
contact_email string max:254 chars
contact string max:512 chars
custom_contact_info string max:512 chars
sip_uri string min:1 chars
ip_address string min:1 chars
is_visible boolean
is_internal boolean
nb_participants_required boolean
is_custom_contact_info boolean
bms_zone string max:512 chars
site_code string max:512 chars
is_moderated boolean
book_horizon integer between 0 and 2147483647
DEFAULT:0
imputation_code boolean
imputation_code_label string max:512 chars
imputation_code_required boolean
requisitionable boolean
requisitionable_label string max:512 chars
vmr_num string max:512 chars
not_prm boolean
is_blind boolean
not_projector boolean
help_button_url string max:200 chars
min_booking_duration integer
max_booking_duration integer
isdn_number string min:1 chars
e164_number string min:1 chars

246 of 352
h323id string min:1 chars
room_phone_number string min:1 chars
status integer READ-ONLY
bookable boolean READ-ONLY
photo string READ-ONLY
photo_uuid string READ-ONLY
qrcode_url string READ-ONLY
QRCode URL pointing to Instant Mobile resource
page
qrcode_report_url string READ-ONLY
QRCode URL pointing to Instant Mobile issue
reporting page
calendar_processing {
instant_booking_mode enum ALLOWED:0, 1, 2
instant_booking_duration_1 integer between -2147483648
and 2147483647
instant_booking_duration_2 integer between -2147483648
and 2147483647
instant_booking_duration_step enum ALLOWED:5, 10, 15, 30,
45, 60
instant_booking_confirmation_required boolean
instant_booking_auth_required boolean
meeting_ack boolean
meeting_ack_start_time enum ALLOWED:0, 5, 10, 15,
30, 45, 60, 75, 90,
105, 120, 135, 150,
165, 180, 195, 210,
225, 240
meeting_ack_end_time enum ALLOWED:0, 5, 10, 15,
30, 45, 60, 75, 90,
105, 120, 135, 150,
165, 180, 195, 210,
225, 240
meeting_ack_confirmation_required boolean
meeting_ack_auth_required boolean
meeting_ack_auth_required_private_meetings boolean
meeting_ack_release boolean
meeting_ack_reminder boolean
extendable_meeting boolean
extendable_meeting_mode enum ALLOWED:0, 1
extend_meeting_duration_1 integer between -2147483648
and 2147483647
extend_meeting_duration_2 integer between -2147483648
and 2147483647
extend_meeting_duration_step enum ALLOWED:5, 10, 15, 30,
45, 60
meeting_ack_release_auth_required boolean
meeting_ack_release_auth_required_private_meetings boolean
time_before_sensor_auto_release enum ALLOWED:4, 6, 8, 10,
12, 16, 20
apply_rights_book boolean
apply_rights_release boolean
apply_rights_confirm boolean
auto_release_force boolean
}
max_date_from_now string READ-ONLY
min:1 chars
max_resa_hours string READ-ONLY

247 of 352
 min:1 chars
available boolean READ-ONLY
compounds integer READ-ONLY
default_name string READ-ONLY
min:1 chars
Display name or technical name
interop_calendaring_email string READ-ONLY
min:1 chars
interop_videoconferencing_email string READ-ONLY
min:1 chars
teams_meeting_enabled boolean READ-ONLY
first_linked_map {
First map where this resource is shown

id integer READ-ONLY
title string 1 to 512 chars
display_name string 1 to 512 chars
description string min:1 chars
floor_top integer
floor_bottom integer
display_type integer between -2147483648 and 2147483647
legend_display_type integer between -2147483648 and 2147483647
}
ordered_photos [string] min:1 chars
resource_tags [string]
service_offers [{
Array of object:

id* integer ID of the service offer

name* string min:1 chars
Name of the service offer
availability* enum ALLOWED:AVAILABLE, DISABLED, TOO_SHORT_NOTICE
Availability of this service based on the requested delivery time - Values: `AVAILABLE` (This service
offer is available), `DISABLED` (This service offer has been disabled and is not currently available),
`TOO_SHORT_NOTICE` (This service offer requires a notice period and the requested delivery time
is too close)
css_icon* string min:1 chars
CSS class of an icon symbolizing this service
}]
}

STATUS CODE - 400: Invalid parameters.

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

STATUS CODE - 404: Resource not found

21.8 PUT /resources/{id}/

Update a specific resource.

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*id string A unique integer value identifying this Resource.

248 of 352
RESPONSE

STATUS CODE - 200:

RESPONSE MODEL - application/json

{
id integer READ-ONLY
name* string 1 to 512 chars
resource_allowed_reservation enum DEFAULT:1
ALLOWED:1, 5, 2, 3, 4
resource_type enum DEFAULT:1
ALLOWED:6, 7, 8, 9, 15, 34,
38, 39, 40, 41, 1, 2, 3, 11,
4, 5, 20, 23, 24, 25, 26, 29,
31, 32, 33, 35, 36, 12, 13,
19, 27, 10, 18, 21, 16, 17,
22, 14, 30, 28, 37, 42, 43,
44, 45, 46, 48, 49, 50, 51,
52, 53, 54, 55, 56, 57
capacity* integer >=0
address* {
company* string 1 to 100 chars
country* string max:100 chars
city* string max:100 chars
site* string 1 to 100 chars
division string 1 to 100 chars
departement string max:50 chars
corporation string max:100 chars
building string max:50 chars
floor string max:50 chars
door string max:50 chars
number string max:30 chars
street_line1 string max:100 chars
street_line2 string max:100 chars
zipcode string max:5 chars
state string max:100 chars
cedex string max:100 chars
postal_box string max:20 chars
}
display_name string max:512 chars
alternate_room_name string max:512 chars
description string
contact_phone string max:100 chars
contact_email string max:254 chars
contact string max:512 chars
custom_contact_info string max:512 chars
sip_uri string min:1 chars
ip_address string min:1 chars
is_visible boolean
is_internal boolean
nb_participants_required boolean
is_custom_contact_info boolean
bms_zone string max:512 chars
site_code string max:512 chars
is_moderated boolean
book_horizon integer between 0 and 2147483647
DEFAULT:0

249 of 352
imputation_code boolean
imputation_code_label string max:512 chars
imputation_code_required boolean
requisitionable boolean
requisitionable_label string max:512 chars
vmr_num string max:512 chars
not_prm boolean
is_blind boolean
not_projector boolean
help_button_url string max:200 chars
min_booking_duration integer
max_booking_duration integer
isdn_number string min:1 chars
e164_number string min:1 chars
h323id string min:1 chars
room_phone_number string min:1 chars
status integer READ-ONLY
bookable boolean READ-ONLY
photo string READ-ONLY
photo_uuid string READ-ONLY
qrcode_url string READ-ONLY
QRCode URL pointing to Instant Mobile resource
page
qrcode_report_url string READ-ONLY
QRCode URL pointing to Instant Mobile issue
reporting page
calendar_processing {
instant_booking_mode enum ALLOWED:0, 1, 2
instant_booking_duration_1 integer between -2147483648
and 2147483647
instant_booking_duration_2 integer between -2147483648
and 2147483647
instant_booking_duration_step enum ALLOWED:5, 10, 15, 30,
45, 60
instant_booking_confirmation_required boolean
instant_booking_auth_required boolean
meeting_ack boolean
meeting_ack_start_time enum ALLOWED:0, 5, 10, 15,
30, 45, 60, 75, 90,
105, 120, 135, 150,
165, 180, 195, 210,
225, 240
meeting_ack_end_time enum ALLOWED:0, 5, 10, 15,
30, 45, 60, 75, 90,
105, 120, 135, 150,
165, 180, 195, 210,
225, 240
meeting_ack_confirmation_required boolean
meeting_ack_auth_required boolean
meeting_ack_auth_required_private_meetings boolean
meeting_ack_release boolean
meeting_ack_reminder boolean
extendable_meeting boolean
extendable_meeting_mode enum ALLOWED:0, 1
extend_meeting_duration_1 integer between -2147483648
and 2147483647
extend_meeting_duration_2 integer between -2147483648
and 2147483647

250 of 352
 extend_meeting_duration_step enum ALLOWED:5, 10, 15, 30,
45, 60
meeting_ack_release_auth_required boolean
meeting_ack_release_auth_required_private_meetings boolean
time_before_sensor_auto_release enum ALLOWED:4,
6, 8, 10,
12, 16, 20
apply_rights_book boolean
apply_rights_release boolean
apply_rights_confirm boolean
auto_release_force boolean
}
max_date_from_now string READ-ONLY
min:1 chars
max_resa_hours string READ-ONLY
min:1 chars
available boolean READ-ONLY
compounds integer READ-ONLY
default_name string READ-ONLY
min:1 chars
Display name or technical name
interop_calendaring_email string READ-ONLY
min:1 chars
interop_videoconferencing_email string READ-ONLY
min:1 chars
teams_meeting_enabled boolean READ-ONLY
first_linked_map {
First map where this resource is shown

id integer READ-ONLY
title string 1 to 512 chars
display_name string 1 to 512 chars
description string min:1 chars
floor_top integer
floor_bottom integer
display_type integer between -2147483648 and 2147483647
legend_display_type integer between -2147483648 and 2147483647
}
ordered_photos [string] min:1 chars
resource_tags [string]
service_offers [{
Array of object:

id* integer ID of the service offer

name* string min:1 chars
Name of the service offer
availability* enum ALLOWED:AVAILABLE, DISABLED, TOO_SHORT_NOTICE
Availability of this service based on the requested delivery time - Values: `AVAILABLE` (This service
offer is available), `DISABLED` (This service offer has been disabled and is not currently available),
`TOO_SHORT_NOTICE` (This service offer requires a notice period and the requested delivery time
is too close)
css_icon* string min:1 chars
CSS class of an icon symbolizing this service
}]
}

STATUS CODE - 400: Invalid parameters.

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

251 of 352
21.9 DELETE /resources/{id}/

Delete a specific resource.

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*id string A unique integer value identifying this Resource.

RESPONSE

STATUS CODE - 204: Success

STATUS CODE - 400: Invalid parameters.

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

STATUS CODE - 404: Resource not found

21.10 POST /resources/{id}/book-for-time/{duration}/

Book a resource for time in minutes.

Book a resource for time in minutes.

To use this end-point, you have to be cloud-user.

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*duration integer Duration in minutes (e.g. 15)

*id string A unique integer value identifying this Resource.

QUERY PARAMETERS
NAME TYPE DESCRIPTION

user_token string Delegation token

min:1 chars

RESPONSE

STATUS CODE - 200:

RESPONSE MODEL - application/json

{
id integer READ-ONLY
conf_id* string min:1 chars
start* string

252 of 352
end* string
last_update* string
duration* integer
title* string 1 to 512 chars
is_valid* boolean
description string
comment string READ-ONLY
min:1 chars
from_application enum ALLOWED:0, 1, 2, 3, 4,
5, 6, 7, 8, 9, 10, 11,
12, 13, 14, 15, 16, 17
owner* {
id integer READ-ONLY
uuid string READ-ONLY
first_name string max:150 chars
last_name string max:150 chars
email string max:254 chars
username* string 1 to 150 chars
PATTERN:^[\w.@+-]+$
Required. 150 characters or fewer. Letters, digits and @/./+/-/_
only.
full_name* string min:1 chars
account_type string READ-ONLY
standard, service_with_impersonation,
service_without_impersonation, device
cloud_space_right {
instant_social* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_tv* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_booking* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_signage* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_metrics* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_device_manager* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
}
}
creator* {
id integer READ-ONLY
uuid string READ-ONLY
first_name string max:150 chars
last_name string max:150 chars
email string max:254 chars
username* string 1 to 150 chars
PATTERN:^[\w.@+-]+$
Required. 150 characters or fewer. Letters, digits and @/./+/-/_
only.
full_name* string min:1 chars
account_type string READ-ONLY
standard, service_with_impersonation,

253 of 352
 service_without_impersonation, device
cloud_space_right {
instant_social* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_tv* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_booking* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_signage* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_metrics* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_device_manager* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
}
}
organizer* string min:1 chars
organizer_target* {
id integer READ-ONLY
uuid string READ-ONLY
first_name string max:150 chars
last_name string max:150 chars
email string max:254 chars
username* string 1 to 150 chars
PATTERN:^[\w.@+-]+$
Required. 150 characters or fewer. Letters, digits and @/./+/-/_
only.
full_name* string min:1 chars
account_type string READ-ONLY
standard, service_with_impersonation,
service_without_impersonation, device
cloud_space_right {
instant_social* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_tv* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_booking* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_signage* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_metrics* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_device_manager* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
}
}

254 of 352
private* boolean
imputation_code string max:512 chars
is_recurring* boolean
conference_type_id string READ-ONLY
sensitivity enum ALLOWED:0, 1, 2, 3
has_moderation string READ-ONLY
demand_status* integer
logo string READ-ONLY
in_progress* boolean
teams_meeting_requested boolean READ-ONLY
visio_infos {
teams* {
Teams meeting join URLs

web_url* string min:1 chars

Web browser join URL
desktop_url* string min:1 chars
Desktop app join URL
deeplink_scheme* string min:1 chars
Deeplink scheme to join using a mobile app
}
zoom* {
Teams meeting join URLs

web_url* string min:1 chars

Web browser join URL
desktop_url* string min:1 chars
Desktop app join URL
deeplink_scheme* string min:1 chars
Deeplink scheme to join using a mobile app
}
webex* {
Teams meeting join URLs

web_url* string min:1 chars

Web browser join URL
desktop_url* string min:1 chars
Desktop app join URL
deeplink_scheme* string min:1 chars
Deeplink scheme to join using a mobile app
}
}
confirmed boolean READ-ONLY
finished* boolean
resourcemanagers* [{
Array of object:

resource* {
id integer READ-ONLY
name* string 1 to 512 chars
resource_allowed_reservation enum DEFAULT:1
ALLOWED:1, 5, 2, 3, 4
resource_type enum DEFAULT:1
ALLOWED:6, 7, 8, 9, 15,
34, 38, 39, 40, 41, 1,
2, 3, 11, 4, 5, 20,
23, 24, 25, 26, 29,
31, 32, 33, 35, 36,
12, 13, 19, 27, 10,
18, 21, 16, 17, 22,
14, 30, 28, 37, 42,
43, 44, 45, 46, 48,

255 of 352
 49, 50, 51, 52, 53,
54, 55, 56, 57
capacity* integer >=0
address* {
company* string 1 to 100 chars
country* string max:100 chars
city* string max:100 chars
site* string 1 to 100 chars
division string 1 to 100 chars
departement string max:50 chars
corporation string max:100 chars
building string max:50 chars
floor string max:50 chars
door string max:50 chars
number string max:30 chars
street_line1 string max:100 chars
street_line2 string max:100 chars
zipcode string max:5 chars
state string max:100 chars
cedex string max:100 chars
postal_box string max:20 chars
}
display_name string max:512 chars
alternate_room_name string max:512 chars
description string
contact_phone string max:100 chars
contact_email string max:254 chars
contact string max:512 chars
custom_contact_info string max:512 chars
sip_uri string min:1 chars
ip_address string min:1 chars
is_visible boolean
is_internal boolean
nb_participants_required boolean
is_custom_contact_info boolean
bms_zone string max:512 chars
site_code string max:512 chars
is_moderated boolean
book_horizon integer between 0 and
2147483647
DEFAULT:0
imputation_code boolean
imputation_code_label string max:512 chars
imputation_code_required boolean
requisitionable boolean
requisitionable_label string max:512 chars
vmr_num string max:512 chars
not_prm boolean
is_blind boolean
not_projector boolean
help_button_url string max:200 chars
min_booking_duration integer
max_booking_duration integer
isdn_number string min:1 chars
e164_number string min:1 chars
h323id string min:1 chars
room_phone_number string min:1 chars

256 of 352
status integer READ-ONLY

bookable boolean READ-ONLY

photo string READ-ONLY
photo_uuid string READ-ONLY
qrcode_url string READ-ONLY
QRCode URL pointing to Instant
Mobile resource page
qrcode_report_url string READ-ONLY
QRCode URL pointing to Instant
Mobile issue reporting page
calendar_processing {
instant_booking_mode enum ALLOWED:0, 1, 2
instant_booking_duration_1 integer between
-2147483648 and
2147483647
instant_booking_duration_2 integer between
-2147483648 and
2147483647
instant_booking_duration_step enum ALLOWED:5, 10,
15, 30, 45, 60
instant_booking_confirmation_required boolean
instant_booking_auth_required boolean
meeting_ack boolean
meeting_ack_start_time enum ALLOWED:0, 5, 10,
15, 30, 45, 60,
75, 90, 105,
120, 135, 150,
165, 180, 195,
210, 225, 240
meeting_ack_end_time enum ALLOWED:0, 5, 10,
15, 30, 45, 60,
75, 90, 105,
120, 135, 150,
165, 180, 195,
210, 225, 240
meeting_ack_confirmation_required boolean
meeting_ack_auth_required boolean
meeting_ack_auth_required_private_meetings boolean
meeting_ack_release boolean
meeting_ack_reminder boolean
extendable_meeting boolean
extendable_meeting_mode enum ALLOWED:0, 1
extend_meeting_duration_1 integer between
-2147483648 and
2147483647
extend_meeting_duration_2 integer between
-2147483648 and
2147483647
extend_meeting_duration_step enum ALLOWED:5, 10,
15, 30, 45, 60
meeting_ack_release_auth_required boolean
meeting_ack_release_auth_required_private_meetings boolean
time_before_sensor_auto_release enum ALLOWED:4, 6, 8,
10, 12, 16, 20
apply_rights_book boolean
apply_rights_release boolean
apply_rights_confirm boolean
auto_release_force boolean

257 of 352
 }
max_date_from_now string READ-ONLY
min:1 chars
max_resa_hours string READ-ONLY
min:1 chars
available boolean READ-ONLY
compounds integer READ-ONLY
default_name string READ-ONLY
min:1 chars
Display name or technical name
interop_calendaring_email string READ-ONLY
min:1 chars
interop_videoconferencing_email string READ-ONLY
min:1 chars
teams_meeting_enabled boolean READ-ONLY
first_linked_map {
First map where this resource is shown

id integer READ-ONLY
title string 1 to 512 chars
display_name string 1 to 512 chars
description string min:1 chars
floor_top integer
floor_bottom integer
display_type integer between -2147483648 and 2147483647
legend_display_type integer between -2147483648 and 2147483647
}
ordered_photos [string] min:1 chars
resource_tags [string]
service_offers [{
Array of object:

id* integer ID of the service offer

name* string min:1 chars
Name of the service offer
availability* enum ALLOWED:AVAILABLE, DISABLED, TOO_SHORT_NOTICE
Availability of this service based on the requested delivery time - Values: `AVAILABLE`
(This service offer is available), `DISABLED` (This service offer has been disabled and is
not currently available), `TOO_SHORT_NOTICE` (This service offer requires a notice period
and the requested delivery time is too close)
css_icon* string min:1 chars
CSS class of an icon symbolizing this service
}]
}
confirmed boolean
finished boolean
released boolean
release_reminded boolean
is_shadow boolean
answer enum ALLOWED:0, 1, 2, 3
nb_participants integer between -2147483648 and
2147483647
moderation enum ALLOWED:0, 1, 2
}]
dial string READ-ONLY
org_pin string READ-ONLY
part_pin string READ-ONLY
}

STATUS CODE - 400: Invalid parameters.

258 of 352
 STATUS CODE - 401: Delegation authentication required from a device

STATUS CODE - 403: Forbidden. Access denied.

21.11 GET /resources/{id}/device-info/

Retrieve the device info for a resource.

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*id string A unique integer value identifying this Resource.

RESPONSE

STATUS CODE - 200:

RESPONSE MODEL - application/json

{
language string READ-ONLY
min:1 chars
Device Preferred Language
display_am_pm boolean READ-ONLY
Timeformat Display
cloud_properties {
Cloud Properties

}
generic_properties {
Generic Properties

}
has_associated_sensors boolean READ-ONLY
Resource Associated Sensors
calendar_processing {
Calendar Processing

}
resource_name string READ-ONLY
min:1 chars
Resource Name
resource_id integer READ-ONLY
Resource ID
resource_type string READ-ONLY
min:1 chars
Resource Type
resource_allowed_reservation string READ-ONLY
min:1 chars
Resource Allowed Reservation
}

STATUS CODE - 400: Invalid parameters.

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

STATUS CODE - 404: Resource not found

259 of 352
21.12 GET /resources/{id}/digital-signage/

Retrieve the digital signage manifest for a resource.

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*id string A unique integer value identifying this Resource.

RESPONSE

STATUS CODE - 200:

RESPONSE MODEL - application/json

{
manifest {
Signage content manifest

}
last_updated string READ-ONLY
Date of last update
}

STATUS CODE - 400: Invalid parameters.

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

STATUS CODE - 404: Resource not found

21.13 GET /resources/{id}/maintenance-state/

Returns the ongoing maintenance if there is one.

Return the ongoing maintenance if there is one.

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*id string A unique integer value identifying this Resource.

RESPONSE

STATUS CODE - 200:

RESPONSE MODEL - application/json

{
resource* integer
user integer
bookable boolean
status enum ALLOWED:0, 1, 2, 3, 4

260 of 352
 comment string
start_date string
back_to_service_expected_on string
actual_end_date string
back_to_service_auto boolean
}

STATUS CODE - 204: No ongoing maintenance for this resource

STATUS CODE - 400: Invalid parameters.

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

STATUS CODE - 404: Resource not found

21.14 GET /resources/{id}/roompad/

Get a specific RoomPad from a resource.

Get a specific RoomPad from resource ID.

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*id string A unique integer value identifying this Resource.

RESPONSE

STATUS CODE - 200:

RESPONSE MODEL - application/json

{
mode enum ALLOWED:0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10,
11
send_email_alert boolean
anonymous_report_issue boolean
layout_mode integer between -2147483648 and 2147483647
current_meeting_title boolean
current_meeting_organizer boolean
current_meeting_participants boolean
popup_auto_close_timing enum ALLOWED:2, 4, 6, 8, 10, 15, 20, 25, 30,
35, 40, 45, 50, 55, 60, 65, 70, 75, 80,
85, 90, 95, 100, 105, 110, 115, 120
skin integer
current_meeting_comments boolean
hide_closest_free_rooms boolean
show_qrcode boolean
next_meeting_infos boolean
next_meeting_title boolean
next_meeting_organizer boolean
auth_badge boolean
auth_pin_code_association boolean
auth_pin_code_authentication boolean

261 of 352
auth_manual_user boolean
timeline_start_hour enum ALLOWED:0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10,
11, 12, 13, 14, 15, 16, 17, 18, 19, 20,
21, 22, 23
timeline_end_hour enum ALLOWED:0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10,
11, 12, 13, 14, 15, 16, 17, 18, 19, 20,
21, 22, 23
timeline_booking boolean
timeline_booking_auth_required boolean
timeline_booking_duration enum ALLOWED:15, 30, 45, 60, 75, 90, 105, 120,
135, 150, 165, 180, 195, 210, 225, 240,
255, 270, 285, 300, 315, 330, 345, 360,
375, 390, 405, 420, 435, 450, 465, 480,
495, 510, 525, 540, 555, 570, 585, 600
digital_signage_start_delay enum ALLOWED:2, 4, 6, 8, 10, 15, 20, 25, 30,
35, 40, 45, 50, 55, 60, 65, 70, 75, 80,
85, 90, 95, 100, 105, 110, 115, 120
digital_signage_transition_interval enum ALLOWED:2, 4, 6, 8, 10, 15, 20, 25, 30,
35, 40, 45, 50, 55, 60, 65, 70, 75, 80,
85, 90, 95, 100, 105, 110, 115, 120
digital_signage_nav_arrows boolean
timezone enum ALLOWED:Africa/Abidjan,
Africa/Accra,
Africa/Bamako, Africa/Banjul, Africa/
Bissau, Africa/Conakry, Africa/Dakar,
Africa/Freetown, Africa/Lome, Africa/
Monrovia, Africa/Nouakchott, Africa/
Ouagadougou, Africa/Sao_Tome, America/
Danmarkshavn, America/Scoresbysund,
Atlantic/Azores, Atlantic/Reykjavik,
Atlantic/St_Helena, GMT, UTC, Africa/
Algiers, Africa/Bangui, Africa/
Brazzaville, Africa/Casablanca, Africa/
Douala, Africa/El_Aaiun, Africa/
Kinshasa, Africa/Lagos, Africa/
Libreville, Africa/Luanda, Africa/
Malabo, Africa/Ndjamena, Africa/Niamey,
Africa/Porto-Novo, Africa/Tunis,
Atlantic/Canary, Atlantic/Faroe,
Atlantic/Madeira, Europe/Dublin,
Europe/Guernsey, Europe/Isle_of_Man,
Europe/Jersey, Europe/Lisbon, Europe/
London, Africa/Blantyre, Africa/
Bujumbura, Africa/Cairo, Africa/Ceuta,
Africa/Gaborone, Africa/Harare, Africa/
Johannesburg, Africa/Juba, Africa/
Khartoum, Africa/Kigali, Africa/
Lubumbashi, Africa/Lusaka, Africa/
Maputo, Africa/Maseru, Africa/Mbabane,
Africa/Tripoli, Africa/Windhoek,
Antarctica/Troll, Arctic/Longyearbyen,
Europe/Amsterdam, Europe/Andorra,
Europe/Belgrade, Europe/Berlin, Europe/
Bratislava, Europe/Brussels, Europe/
Budapest, Europe/Busingen, Europe/
Copenhagen, Europe/Gibraltar, Europe/
Kaliningrad, Europe/Ljubljana, Europe/
Luxembourg, Europe/Madrid, Europe/

262 of 352
Malta, Europe/Monaco, Europe/Oslo,
Europe/Paris, Europe/Podgorica, Europe/
Prague, Europe/Rome, Europe/San_Marino,
Europe/Sarajevo, Europe/Skopje, Europe/
Stockholm, Europe/Tirane, Europe/Vaduz,
Europe/Vatican, Europe/Vienna, Europe/
Warsaw, Europe/Zagreb, Europe/Zurich,
Africa/Addis_Ababa, Africa/Asmara,
Africa/Dar_es_Salaam, Africa/Djibouti,
Africa/Kampala, Africa/Mogadishu,
Africa/Nairobi, Antarctica/Syowa, Asia/
Aden, Asia/Amman, Asia/Baghdad, Asia/
Bahrain, Asia/Beirut, Asia/Damascus,
Asia/Famagusta, Asia/Gaza, Asia/Hebron,
Asia/Jerusalem, Asia/Kuwait, Asia/
Nicosia, Asia/Qatar, Asia/Riyadh,
Europe/Athens, Europe/Bucharest,
Europe/Chisinau, Europe/Helsinki,
Europe/Istanbul, Europe/Kiev, Europe/
Kirov, Europe/Mariehamn, Europe/Minsk,
Europe/Moscow, Europe/Riga, Europe/
Simferopol, Europe/Sofia, Europe/
Tallinn, Europe/Uzhgorod, Europe/
Vilnius, Europe/Volgograd, Europe/
Zaporozhye, Indian/Antananarivo,
Indian/Comoro, Indian/Mayotte, Asia/
Baku, Asia/Dubai, Asia/Muscat, Asia/
Tbilisi, Asia/Yerevan, Europe/
Astrakhan, Europe/Samara, Europe/
Saratov, Europe/Ulyanovsk, Indian/Mahe,
Indian/Mauritius, Indian/Reunion, Asia/
Kabul, Asia/Tehran, Antarctica/Mawson,
Asia/Aqtau, Asia/Aqtobe, Asia/Ashgabat,
Asia/Atyrau, Asia/Dushanbe, Asia/
Karachi, Asia/Oral, Asia/Qyzylorda,
Asia/Samarkand, Asia/Tashkent, Asia/
Yekaterinburg, Indian/Kerguelen,
Indian/Maldives, Asia/Colombo, Asia/
Kolkata, Asia/Kathmandu, Antarctica/
Vostok, Asia/Almaty, Asia/Bishkek,
Asia/Dhaka, Asia/Omsk, Asia/Qostanay,
Asia/Thimphu, Asia/Urumqi, Indian/
Chagos, Asia/Yangon, Indian/Cocos,
Antarctica/Davis, Asia/Bangkok, Asia/
Barnaul, Asia/Ho_Chi_Minh, Asia/Hovd,
Asia/Jakarta, Asia/Krasnoyarsk, Asia/
Novokuznetsk, Asia/Novosibirsk, Asia/
Phnom_Penh, Asia/Pontianak, Asia/Tomsk,
Asia/Vientiane, Indian/Christmas, Asia/
Brunei, Asia/Choibalsan, Asia/
Hong_Kong, Asia/Irkutsk, Asia/
Kuala_Lumpur, Asia/Kuching, Asia/Macau,
Asia/Makassar, Asia/Manila, Asia/
Shanghai, Asia/Singapore, Asia/Taipei,
Asia/Ulaanbaatar, Australia/Perth,
Australia/Eucla, Asia/Chita, Asia/Dili,
Asia/Jayapura, Asia/Khandyga, Asia/

263 of 352
Pyongyang, Asia/Seoul, Asia/Tokyo,
Asia/Yakutsk, Pacific/Palau, Australia/
Adelaide, Australia/Broken_Hill,
Australia/Darwin, Antarctica/
DumontDUrville, Antarctica/Macquarie,
Asia/Ust-Nera, Asia/Vladivostok,
Australia/Brisbane, Australia/Hobart,
Australia/Lindeman, Australia/
Melbourne, Australia/Sydney, Pacific/
Chuuk, Pacific/Guam, Pacific/
Port_Moresby, Pacific/Saipan,
Australia/Lord_Howe, Antarctica/Casey,
Asia/Magadan, Asia/Sakhalin, Asia/
Srednekolymsk, Pacific/Bougainville,
Pacific/Efate, Pacific/Guadalcanal,
Pacific/Kosrae, Pacific/Norfolk,
Pacific/Noumea, Pacific/Pohnpei,
Antarctica/McMurdo, Asia/Anadyr, Asia/
Kamchatka, Pacific/Auckland, Pacific/
Fiji, Pacific/Funafuti, Pacific/
Kwajalein, Pacific/Majuro, Pacific/
Nauru, Pacific/Tarawa, Pacific/Wake,
Pacific/Wallis, Pacific/Chatham,
Pacific/Apia, Pacific/Enderbury,
Pacific/Fakaofo, Pacific/Tongatapu,
Pacific/Kiritimati, Atlantic/
Cape_Verde, America/Miquelon, America/
Noronha, America/Nuuk, Atlantic/
South_Georgia, America/St_Johns,
Canada/Newfoundland, America/Araguaina,
America/Argentina/Buenos_Aires,
America/Argentina/Catamarca, America/
Argentina/Cordoba, America/Argentina/
Jujuy, America/Argentina/La_Rioja,
America/Argentina/Mendoza, America/
Argentina/Rio_Gallegos, America/
Argentina/Salta, America/Argentina/
San_Juan, America/Argentina/San_Luis,
America/Argentina/Tucuman, America/
Argentina/Ushuaia, America/Bahia,
America/Belem, America/Cayenne,
America/Fortaleza, America/Glace_Bay,
America/Goose_Bay, America/Halifax,
America/Maceio, America/Moncton,
America/Montevideo, America/Paramaribo,
America/Punta_Arenas, America/Recife,
America/Santarem, America/Santiago,
America/Sao_Paulo, America/Thule,
Antarctica/Palmer, Antarctica/Rothera,
Atlantic/Bermuda, Atlantic/Stanley,
Canada/Atlantic, America/Anguilla,
America/Antigua, America/Aruba,
America/Asuncion, America/Barbados,
America/Blanc-Sablon, America/
Boa_Vista, America/Campo_Grande,
America/Caracas, America/Cuiaba,
America/Curacao, America/Detroit,

264 of 352
America/Dominica, America/Grand_Turk,
America/Grenada, America/Guadeloupe,
America/Guyana, America/Havana,
America/Indiana/Indianapolis, America/
Indiana/Marengo, America/Indiana/
Petersburg, America/Indiana/Vevay,
America/Indiana/Vincennes, America/
Indiana/Winamac, America/Iqaluit,
America/Kentucky/Louisville, America/
Kentucky/Monticello, America/
Kralendijk, America/La_Paz, America/
Lower_Princes, America/Manaus, America/
Marigot, America/Martinique, America/
Montserrat, America/Nassau, America/
New_York, America/Nipigon, America/
Pangnirtung, America/Port-au-Prince,
America/Port_of_Spain, America/
Porto_Velho, America/Puerto_Rico,
America/Santo_Domingo, America/
St_Barthelemy, America/St_Kitts,
America/St_Lucia, America/St_Thomas,
America/St_Vincent, America/
Thunder_Bay, America/Toronto, America/
Tortola, Canada/Eastern, US/Eastern,
America/Atikokan, America/
Bahia_Banderas, America/Bogota,
America/Cancun, America/Cayman,
America/Chicago, America/Eirunepe,
America/Guayaquil, America/Indiana/
Knox, America/Indiana/Tell_City,
America/Jamaica, America/Lima, America/
Matamoros, America/Menominee, America/
Merida, America/Mexico_City, America/
Monterrey, America/North_Dakota/Beulah,
America/North_Dakota/Center, America/
North_Dakota/New_Salem, America/Panama,
America/Rainy_River, America/
Rankin_Inlet, America/Resolute,
America/Rio_Branco, America/Winnipeg,
Canada/Central, Pacific/Easter, US/
Central, America/Belize, America/Boise,
America/Cambridge_Bay, America/
Chihuahua, America/Costa_Rica, America/
Denver, America/Edmonton, America/
El_Salvador, America/Guatemala,
America/Inuvik, America/Managua,
America/Mazatlan, America/Ojinaga,
America/Regina, America/Swift_Current,
America/Tegucigalpa, America/
Yellowknife, Canada/Mountain, Pacific/
Galapagos, US/Mountain, America/
Creston, America/Dawson, America/
Dawson_Creek, America/Fort_Nelson,
America/Hermosillo, America/
Los_Angeles, America/Phoenix, America/
Tijuana, America/Vancouver, America/
Whitehorse, Canada/Pacific, US/Arizona,

265 of 352
 US/Pacific, America/Anchorage, America/
Juneau, America/Metlakatla, America/
Nome, America/Sitka, America/Yakutat,
Pacific/Pitcairn, US/Alaska, America/
Adak, Pacific/Gambier, Pacific/
Marquesas, Pacific/Honolulu, Pacific/
Rarotonga, Pacific/Tahiti, US/Hawaii,
Pacific/Midway, Pacific/Niue, Pacific/
Pago_Pago
screen_saver_0_always_on boolean
screen_saver_0_always_off boolean
screen_saver_0_on_time enum ALLOWED:0:0, 0:30, 60, 90, 120, 150, 180,
210, 240, 270, 300, 330, 360, 390, 420,
450, 480, 510, 540, 570, 600, 630, 660,
690, 720, 750, 780, 810, 840, 870, 900,
930, 960, 990, 1020, 1050, 1080, 1110,
1140, 1170, 1200, 1230, 1260, 1290,
1320, 1350, 1380
screen_saver_0_off_time enum ALLOWED:0:30, 60, 90, 120, 150, 180, 210,
240, 270, 300, 330, 360, 390, 420, 450,
480, 510, 540, 570, 600, 630, 660, 690,
720, 750, 780, 810, 840, 870, 900, 930,
960, 990, 1020, 1050, 1080, 1110, 1140,
1170, 1200, 1230, 1260, 1290, 1320,
1350, 1380, 1410
screen_saver_1_always_on boolean
screen_saver_1_always_off boolean
screen_saver_1_on_time enum ALLOWED:0:0, 0:30, 60, 90, 120, 150, 180,
210, 240, 270, 300, 330, 360, 390, 420,
450, 480, 510, 540, 570, 600, 630, 660,
690, 720, 750, 780, 810, 840, 870, 900,
930, 960, 990, 1020, 1050, 1080, 1110,
1140, 1170, 1200, 1230, 1260, 1290,
1320, 1350, 1380
screen_saver_1_off_time enum ALLOWED:0:30, 60, 90, 120, 150, 180, 210,
240, 270, 300, 330, 360, 390, 420, 450,
480, 510, 540, 570, 600, 630, 660, 690,
720, 750, 780, 810, 840, 870, 900, 930,
960, 990, 1020, 1050, 1080, 1110, 1140,
1170, 1200, 1230, 1260, 1290, 1320,
1350, 1380, 1410
screen_saver_2_always_on boolean
screen_saver_2_always_off boolean
screen_saver_2_on_time enum ALLOWED:0:0, 0:30, 60, 90, 120, 150, 180,
210, 240, 270, 300, 330, 360, 390, 420,
450, 480, 510, 540, 570, 600, 630, 660,
690, 720, 750, 780, 810, 840, 870, 900,
930, 960, 990, 1020, 1050, 1080, 1110,
1140, 1170, 1200, 1230, 1260, 1290,
1320, 1350, 1380
screen_saver_2_off_time enum ALLOWED:0:30, 60, 90, 120, 150, 180, 210,
240, 270, 300, 330, 360, 390, 420, 450,
480, 510, 540, 570, 600, 630, 660, 690,
720, 750, 780, 810, 840, 870, 900, 930,
960, 990, 1020, 1050, 1080, 1110, 1140,
1170, 1200, 1230, 1260, 1290, 1320,
1350, 1380, 1410

266 of 352
screen_saver_3_always_on boolean
screen_saver_3_always_off boolean
screen_saver_3_on_time enum ALLOWED:0:0, 0:30, 60, 90, 120, 150, 180,
210, 240, 270, 300, 330, 360, 390, 420,
450, 480, 510, 540, 570, 600, 630, 660,
690, 720, 750, 780, 810, 840, 870, 900,
930, 960, 990, 1020, 1050, 1080, 1110,
1140, 1170, 1200, 1230, 1260, 1290,
1320, 1350, 1380
screen_saver_3_off_time enum ALLOWED:0:30, 60, 90, 120, 150, 180, 210,
240, 270, 300, 330, 360, 390, 420, 450,
480, 510, 540, 570, 600, 630, 660, 690,
720, 750, 780, 810, 840, 870, 900, 930,
960, 990, 1020, 1050, 1080, 1110, 1140,
1170, 1200, 1230, 1260, 1290, 1320,
1350, 1380, 1410
screen_saver_4_always_on boolean
screen_saver_4_always_off boolean
screen_saver_4_on_time enum ALLOWED:0:0, 0:30, 60, 90, 120, 150, 180,
210, 240, 270, 300, 330, 360, 390, 420,
450, 480, 510, 540, 570, 600, 630, 660,
690, 720, 750, 780, 810, 840, 870, 900,
930, 960, 990, 1020, 1050, 1080, 1110,
1140, 1170, 1200, 1230, 1260, 1290,
1320, 1350, 1380
screen_saver_4_off_time enum ALLOWED:0:30, 60, 90, 120, 150, 180, 210,
240, 270, 300, 330, 360, 390, 420, 450,
480, 510, 540, 570, 600, 630, 660, 690,
720, 750, 780, 810, 840, 870, 900, 930,
960, 990, 1020, 1050, 1080, 1110, 1140,
1170, 1200, 1230, 1260, 1290, 1320,
1350, 1380, 1410
screen_saver_5_always_on boolean
screen_saver_5_always_off boolean
screen_saver_5_on_time enum ALLOWED:0:0, 0:30, 60, 90, 120, 150, 180,
210, 240, 270, 300, 330, 360, 390, 420,
450, 480, 510, 540, 570, 600, 630, 660,
690, 720, 750, 780, 810, 840, 870, 900,
930, 960, 990, 1020, 1050, 1080, 1110,
1140, 1170, 1200, 1230, 1260, 1290,
1320, 1350, 1380
screen_saver_5_off_time enum ALLOWED:0:30, 60, 90, 120, 150, 180, 210,
240, 270, 300, 330, 360, 390, 420, 450,
480, 510, 540, 570, 600, 630, 660, 690,
720, 750, 780, 810, 840, 870, 900, 930,
960, 990, 1020, 1050, 1080, 1110, 1140,
1170, 1200, 1230, 1260, 1290, 1320,
1350, 1380, 1410
screen_saver_6_always_on boolean
screen_saver_6_always_off boolean
screen_saver_6_on_time enum ALLOWED:0:0,
0:30, 60, 90, 120, 150, 180,
210, 240, 270, 300, 330, 360, 390, 420,
450, 480, 510, 540, 570, 600, 630, 660,
690, 720, 750, 780, 810, 840, 870, 900,
930, 960, 990, 1020, 1050, 1080, 1110,
1140, 1170, 1200, 1230, 1260, 1290,
1320, 1350, 1380

267 of 352
 screen_saver_6_off_time enum ALLOWED:0:30,
60, 90, 120, 150, 180, 210,
240, 270, 300, 330, 360, 390, 420, 450,
480, 510, 540, 570, 600, 630, 660, 690,
720, 750, 780, 810, 840, 870, 900, 930,
960, 990, 1020, 1050, 1080, 1110, 1140,
1170, 1200, 1230, 1260, 1290, 1320,
1350, 1380, 1410
}

STATUS CODE - 400: Invalid parameters.

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

STATUS CODE - 404: Resource not found

21.15 POST /resources/{id}/toggle-favorite/

Add a resource to your favorites.

Add a resource to your favorites.

To use this end-point, you have to be cloud-user.

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*id string A unique integer value identifying this Resource.

RESPONSE

STATUS CODE - 200:

RESPONSE MODEL - application/json

{
status* string min:1 chars
succes if the request is OK
id_resource* string min:1 chars
the ID of the resource modified
favourite* boolean current state of the resource
ressource_identifier* string min:1 chars
}

STATUS CODE - 400: Invalid parameters.

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

268 of 352
22. SENSORS

22.1 POST /sensors/data/

Send data for multiple sensors, for a given sensor pool.

A Sensor must at least send 1 pulse an hour to increase the related bookings.

If not, the related booking will be released.

Max allowed sensors to update at once: 200

REQUEST
REQUEST BODY - application/json
{
pool_uuid* string Pool identifier
data* [{
Array of object: Sensor data

uid* string min:1 chars

Unique sensor identifier
payload* {
Sensor data payload

}
}]
}

RESPONSE

STATUS CODE - 207:

RESPONSE MODEL - application/json

[{
Array of object:

status* integer HTTP Status Code

uid* string min:1 chars
Unique identifier of a sensor for a given pool
message* string min:1 chars
Success or error message
}]

STATUS CODE - 400: Invalid parameters.

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

22.2 POST /sensors/pairing/

Pair multiple sensors uid to multiple resources, for a given sensor pool

REQUEST
REQUEST BODY - application/json

269 of 352
 {
pool_uuid* string Pool identifier
data* [{
Array of object: List of sensors and resources to be paired

uid* string min:1 chars

Unique identifier of a sensor for a given pool
resource_id* integer Instant Booking's resource ID
}]
}

RESPONSE

STATUS CODE - 207:

RESPONSE MODEL - application/json

[{
Array of object:

status* integer HTTP Status Code

uid* string min:1 chars
Unique identifier of a sensor for a given pool
message* string min:1 chars
Success or error message
}]

STATUS CODE - 400: Invalid parameters.

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

22.3 DELETE /sensors/pairing/

Unpair multiple sensors uid, for a given sensor pool

REQUEST
REQUEST BODY - application/json
{
pool_uuid* string Pool identifier
uids* [string] min:1 chars
Uids of sensors to unpair
}

RESPONSE

STATUS CODE - 207:

RESPONSE MODEL - application/json

[{
Array of object:

status* integer HTTP Status Code

uid* string min:1 chars
Unique identifier of a sensor for a given pool
message* string min:1 chars
Success or error message
}]

STATUS CODE - 400: Invalid parameters.

270 of 352
STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

271 of 352
23. SIGNAGE

23.1 GET /signage/{id}/file/

Get the file of the given signage media

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*id string A unique integer value identifying this Digital signage media.

RESPONSE

STATUS CODE - 200:

RESPONSE MODEL - application/json

string

STATUS CODE - 400: The media you ask doesn't have a file

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

STATUS CODE - 404: Signage media not found.

272 of 352
24. STATS

24.1 GET /stats/occupation-rate/

Get occupation rate statistics based on a given location

Get statistics on desk bookings and "office" presence declarations for a day if the office presence
module is enabled

REQUEST
QUERY PARAMETERS
NAME TYPE DESCRIPTION

date date Statistics will be calculated for this day. Defaults to today.
*locatio string Statistics will be calculated for this location which will be cut at the level configured with the
n Cloud Property flex_main_location_level. For instance, if the main level is 'site' and the location
given is {"country": "France", "site": "Paris", "floor": "1"}, then the location used will be {"country":
"France", "site": "Paris"} in order to be more relevant.

JSON format e.g. {"city": "Paris", "site": "Boulogne"}

Valid keys are: company, division, site, departement, corporation, building, floor, door, number,
street_line1, street_line2, zipcode, city, state, cedex, postal_box, country

RESPONSE

STATUS CODE - 200:

RESPONSE MODEL - application/json

{
location_analyzed* {
Location used for the statistics, based on the given one but cut at the mainlevel configured with the Cloud Property flex_main_location_level as
explained in the input schema

JSON format e.g. {"city": "Paris", "site": "Boulogne"}

Valid keys are: company, division, site, departement, corporation, building, floor, door, number, street_line1, street_line2, zipcode, city, state,
cedex, postal_box, country

}
presence_declarations* {
Statistics based on presence declarations at the given location

total_users_on_location_as_default_workplace* integer Number of users whose default location

(workplace) is set to the location used for
these statistics
total_users_on_location_that_day* integer Number of users who have declared their
presence at the location and date used for
these statistics
}
desks* {
Statistics based on desk bookings at the given location

total_desks_on_location* integer Number of desks at the location used for these statistics
total_desks_free_that_day* integer Number of free desks at the location and date used for these statistics
}
}

STATUS CODE - 400: Invalid parameters.

STATUS CODE - 401: Unauthorized. Authentication needed.

273 of 352
 STATUS CODE - 403: Forbidden. Access denied.

24.2 GET /stats/realtime/resources/

Get realtime stats for resources.

This endpoint will give you the resource availability over the current day

You can use multiple filters:

By location,
By resource types

REQUEST
QUERY PARAMETERS
NAME TYPE DESCRIPTION

location string Location value (e.g. SharingCloud/France)

min:1 chars
location_filter string Location filter (e.g. company,country)
min:1 chars
resource_types string Resource types (e.g. 1,2,5,6 or all) (Comma-separated list of numbers, e.g.
min:1 chars `1,2,3`)
search_strat integer First time slot, in local time
between 0 and
23
search_end integer Last time slot, in local time
between 0 and
23

RESPONSE

STATUS CODE - 200:

RESPONSE MODEL - application/json

{
available* integer >=0
How many resource are available regarding filters
now* integer >=0
Busy resource count right now
daily_busy_resources* {
}
}

STATUS CODE - 400: Invalid parameters.

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

274 of 352
25. TYPICAL-WEEKS

25.1 POST /typical-weeks/

Declare or update your typical week.

REQUEST

RESPONSE

STATUS CODE - 200:

RESPONSE MODEL - application/json

{
id integer READ-ONLY
ID of the typical week
agenda_id string READ-ONLY
monday* {
Monday declaration

id integer READ-ONLY
date string
morning* {
Morning (or all day) info

status* enum ALLOWED:0, 1, 2, 3, 4

The presence_status type:
Not set: 0
Office: 1
Remote: 2
Off site: 3
Off: 4
location {
Location in the resource address referential, as a JSON, "
"e.g. `{"country": "France", "site": "Paris", "floor": "1"}`

}
note string max:512 chars
conf_id string 1 to 100 chars
}
afternoon {
Morning (or all day) info

status* enum ALLOWED:0, 1, 2, 3, 4

The presence_status type:
Not set: 0
Office: 1
Remote: 2
Off site: 3
Off: 4
location {
Location in the resource address referential, as a JSON, "
"e.g. `{"country": "France", "site": "Paris", "floor": "1"}`

}
note string max:512 chars
conf_id string 1 to 100 chars
}
is_all_day boolean READ-ONLY
author_id string READ-ONLY
}
tuesday* {
Monday declaration

275 of 352
 id integer READ-ONLY

date string
morning* {
Morning (or all day) info

status* enum ALLOWED:0, 1, 2, 3, 4

The presence_status type:
Not set: 0
Office: 1
Remote: 2
Off site: 3
Off: 4
location {
Location in the resource address referential, as a JSON, "
"e.g. `{"country": "France", "site": "Paris", "floor": "1"}`

}
note string max:512 chars
conf_id string 1 to 100 chars
}
afternoon {
Morning (or all day) info

status* enum ALLOWED:0, 1, 2, 3, 4

The presence_status type:
Not set: 0
Office: 1
Remote: 2
Off site: 3
Off: 4
location {
Location in the resource address referential, as a JSON, "
"e.g. `{"country": "France", "site": "Paris", "floor": "1"}`

}
note string max:512 chars
conf_id string 1 to 100 chars
}
is_all_day boolean READ-ONLY
author_id string READ-ONLY
}
wednesday* {
Monday declaration

id integer READ-ONLY
date string
morning* {
Morning (or all day) info

status* enum ALLOWED:0, 1, 2, 3, 4

The presence_status type:
Not set: 0
Office: 1
Remote: 2
Off site: 3
Off: 4
location {
Location in the resource address referential, as a JSON, "
"e.g. `{"country": "France", "site": "Paris", "floor": "1"}`

}
note string max:512 chars
conf_id string 1 to 100 chars
}
afternoon {
Morning (or all day) info

status* enum ALLOWED:0, 1, 2, 3, 4

The presence_status type:
Not set: 0
Office: 1

276 of 352
 Remote: 2
Off site: 3
Off: 4
location {
Location in the resource address referential, as a JSON, "
"e.g. `{"country": "France", "site": "Paris", "floor": "1"}`

}
note string max:512 chars
conf_id string 1 to 100 chars
}
is_all_day boolean READ-ONLY
author_id string READ-ONLY
}
thursday* {
Monday declaration

id integer READ-ONLY
date string
morning* {
Morning (or all day) info

status* enum ALLOWED:0, 1, 2, 3, 4

The presence_status type:
Not set: 0
Office: 1
Remote: 2
Off site: 3
Off: 4
location {
Location in the resource address referential, as a JSON, "
"e.g. `{"country": "France", "site": "Paris", "floor": "1"}`

}
note string max:512 chars
conf_id string 1 to 100 chars
}
afternoon {
Morning (or all day) info

status* enum ALLOWED:0, 1, 2, 3, 4

The presence_status type:
Not set: 0
Office: 1
Remote: 2
Off site: 3
Off: 4
location {
Location in the resource address referential, as a JSON, "
"e.g. `{"country": "France", "site": "Paris", "floor": "1"}`

}
note string max:512 chars
conf_id string 1 to 100 chars
}
is_all_day boolean READ-ONLY
author_id string READ-ONLY
}
friday* {
Monday declaration

id integer READ-ONLY
date string
morning* {
Morning (or all day) info

status* enum ALLOWED:0, 1, 2, 3, 4

The presence_status type:
Not set: 0
Office: 1
Remote: 2

277 of 352
 Off site: 3
Off: 4
location {
Location in the resource address referential, as a JSON, "
"e.g. `{"country": "France", "site": "Paris", "floor": "1"}`

}
note string max:512 chars
conf_id string 1 to 100 chars
}
afternoon {
Morning (or all day) info

status* enum ALLOWED:0, 1, 2, 3, 4

The presence_status type:
Not set: 0
Office: 1
Remote: 2
Off site: 3
Off: 4
location {
Location in the resource address referential, as a JSON, "
"e.g. `{"country": "France", "site": "Paris", "floor": "1"}`

}
note string max:512 chars
conf_id string 1 to 100 chars
}
is_all_day boolean READ-ONLY
author_id string READ-ONLY
}
saturday* {
Monday declaration

id integer READ-ONLY
date string
morning* {
Morning (or all day) info

status* enum ALLOWED:0, 1, 2, 3, 4

The presence_status type:
Not set: 0
Office: 1
Remote: 2
Off site: 3
Off: 4
location {
Location in the resource address referential, as a JSON, "
"e.g. `{"country": "France", "site": "Paris", "floor": "1"}`

}
note string max:512 chars
conf_id string 1 to 100 chars
}
afternoon {
Morning (or all day) info

status* enum ALLOWED:0, 1, 2, 3, 4

The presence_status type:
Not set: 0
Office: 1
Remote: 2
Off site: 3
Off: 4
location {
Location in the resource address referential, as a JSON, "
"e.g. `{"country": "France", "site": "Paris", "floor": "1"}`

}
note string max:512 chars
conf_id string 1 to 100 chars

278 of 352
 }
is_all_day boolean READ-ONLY
author_id string READ-ONLY
}
sunday* {
Monday declaration

id integer READ-ONLY
date string
morning* {
Morning (or all day) info

status* enum ALLOWED:0, 1, 2, 3, 4

The presence_status type:
Not set: 0
Office: 1
Remote: 2
Off site: 3
Off: 4
location {
Location in the resource address referential, as a JSON, "
"e.g. `{"country": "France", "site": "Paris", "floor": "1"}`

}
note string max:512 chars
conf_id string 1 to 100 chars
}
afternoon {
Morning (or all day) info

status* enum ALLOWED:0, 1, 2, 3, 4

The presence_status type:
Not set: 0
Office: 1
Remote: 2
Off site: 3
Off: 4
location {
Location in the resource address referential, as a JSON, "
"e.g. `{"country": "France", "site": "Paris", "floor": "1"}`

}
note string max:512 chars
conf_id string 1 to 100 chars
}
is_all_day boolean READ-ONLY
author_id string READ-ONLY
}
}

STATUS CODE - 400: Invalid parameters.

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

25.2 GET /typical-weeks/{id}/

Get a single typical week.

Get a single typical week from its ID.

REQUEST
PATH PARAMETERS

279 of 352
 NAME TYPE DESCRIPTION

*id string A unique integer value identifying this typical week.

RESPONSE

STATUS CODE - 200:

RESPONSE MODEL - application/json

{
id integer READ-ONLY
ID of the typical week
agenda_id string READ-ONLY
monday* {
Monday declaration

id integer READ-ONLY
date string
morning* {
Morning (or all day) info

status* enum ALLOWED:0, 1, 2, 3, 4

The presence_status type:
Not set: 0
Office: 1
Remote: 2
Off site: 3
Off: 4
location {
Location in the resource address referential, as a JSON, "
"e.g. `{"country": "France", "site": "Paris", "floor": "1"}`

}
note string max:512 chars
conf_id string 1 to 100 chars
}
afternoon {
Morning (or all day) info

status* enum ALLOWED:0, 1, 2, 3, 4

The presence_status type:
Not set: 0
Office: 1
Remote: 2
Off site: 3
Off: 4
location {
Location in the resource address referential, as a JSON, "
"e.g. `{"country": "France", "site": "Paris", "floor": "1"}`

}
note string max:512 chars
conf_id string 1 to 100 chars
}
is_all_day boolean READ-ONLY
author_id string READ-ONLY
}
tuesday* {
Monday declaration

id integer READ-ONLY
date string
morning* {
Morning (or all day) info

status* enum ALLOWED:0, 1, 2, 3, 4

The presence_status type:
Not set: 0

280 of 352
 Office: 1
Remote: 2
Off site: 3
Off: 4
location {
Location in the resource address referential, as a JSON, "
"e.g. `{"country": "France", "site": "Paris", "floor": "1"}`

}
note string max:512 chars
conf_id string 1 to 100 chars
}
afternoon {
Morning (or all day) info

status* enum ALLOWED:0, 1, 2, 3, 4

The presence_status type:
Not set: 0
Office: 1
Remote: 2
Off site: 3
Off: 4
location {
Location in the resource address referential, as a JSON, "
"e.g. `{"country": "France", "site": "Paris", "floor": "1"}`

}
note string max:512 chars
conf_id string 1 to 100 chars
}
is_all_day boolean READ-ONLY
author_id string READ-ONLY
}
wednesday* {
Monday declaration

id integer READ-ONLY
date string
morning* {
Morning (or all day) info

status* enum ALLOWED:0, 1, 2, 3, 4

The presence_status type:
Not set: 0
Office: 1
Remote: 2
Off site: 3
Off: 4
location {
Location in the resource address referential, as a JSON, "
"e.g. `{"country": "France", "site": "Paris", "floor": "1"}`

}
note string max:512 chars
conf_id string 1 to 100 chars
}
afternoon {
Morning (or all day) info

status* enum ALLOWED:0, 1, 2, 3, 4

The presence_status type:
Not set: 0
Office: 1
Remote: 2
Off site: 3
Off: 4
location {
Location in the resource address referential, as a JSON, "
"e.g. `{"country": "France", "site": "Paris", "floor": "1"}`

}
note string max:512 chars

281 of 352
 conf_id string 1 to 100 chars
}
is_all_day boolean READ-ONLY
author_id string READ-ONLY
}
thursday* {
Monday declaration

id integer READ-ONLY
date string
morning* {
Morning (or all day) info

status* enum ALLOWED:0, 1, 2, 3, 4

The presence_status type:
Not set: 0
Office: 1
Remote: 2
Off site: 3
Off: 4
location {
Location in the resource address referential, as a JSON, "
"e.g. `{"country": "France", "site": "Paris", "floor": "1"}`

}
note string max:512 chars
conf_id string 1 to 100 chars
}
afternoon {
Morning (or all day) info

status* enum ALLOWED:0, 1, 2, 3, 4

The presence_status type:
Not set: 0
Office: 1
Remote: 2
Off site: 3
Off: 4
location {
Location in the resource address referential, as a JSON, "
"e.g. `{"country": "France", "site": "Paris", "floor": "1"}`

}
note string max:512 chars
conf_id string 1 to 100 chars
}
is_all_day boolean READ-ONLY
author_id string READ-ONLY
}
friday* {
Monday declaration

id integer READ-ONLY
date string
morning* {
Morning (or all day) info

status* enum ALLOWED:0, 1, 2, 3, 4

The presence_status type:
Not set: 0
Office: 1
Remote: 2
Off site: 3
Off: 4
location {
Location in the resource address referential, as a JSON, "
"e.g. `{"country": "France", "site": "Paris", "floor": "1"}`

}
note string max:512 chars
conf_id string 1 to 100 chars

282 of 352
 }
afternoon {
Morning (or all day) info

status* enum ALLOWED:0, 1, 2, 3, 4

The presence_status type:
Not set: 0
Office: 1
Remote: 2
Off site: 3
Off: 4
location {
Location in the resource address referential, as a JSON, "
"e.g. `{"country": "France", "site": "Paris", "floor": "1"}`

}
note string max:512 chars
conf_id string 1 to 100 chars
}
is_all_day boolean READ-ONLY
author_id string READ-ONLY
}
saturday* {
Monday declaration

id integer READ-ONLY
date string
morning* {
Morning (or all day) info

status* enum ALLOWED:0, 1, 2, 3, 4

The presence_status type:
Not set: 0
Office: 1
Remote: 2
Off site: 3
Off: 4
location {
Location in the resource address referential, as a JSON, "
"e.g. `{"country": "France", "site": "Paris", "floor": "1"}`

}
note string max:512 chars
conf_id string 1 to 100 chars
}
afternoon {
Morning (or all day) info

status* enum ALLOWED:0, 1, 2, 3, 4

The presence_status type:
Not set: 0
Office: 1
Remote: 2
Off site: 3
Off: 4
location {
Location in the resource address referential, as a JSON, "
"e.g. `{"country": "France", "site": "Paris", "floor": "1"}`

}
note string max:512 chars
conf_id string 1 to 100 chars
}
is_all_day boolean READ-ONLY
author_id string READ-ONLY
}
sunday* {
Monday declaration

id integer READ-ONLY
date string

283 of 352
 morning* {
Morning (or all day) info

status* enum ALLOWED:0, 1, 2, 3, 4

The presence_status type:
Not set: 0
Office: 1
Remote: 2
Off site: 3
Off: 4
location {
Location in the resource address referential, as a JSON, "
"e.g. `{"country": "France", "site": "Paris", "floor": "1"}`

}
note string max:512 chars
conf_id string 1 to 100 chars
}
afternoon {
Morning (or all day) info

status* enum ALLOWED:0, 1, 2, 3, 4

The presence_status type:
Not set: 0
Office: 1
Remote: 2
Off site: 3
Off: 4
location {
Location in the resource address referential, as a JSON, "
"e.g. `{"country": "France", "site": "Paris", "floor": "1"}`

}
note string max:512 chars
conf_id string 1 to 100 chars
}
is_all_day boolean READ-ONLY
author_id string READ-ONLY
}
}

STATUS CODE - 400: Invalid parameters.

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

STATUS CODE - 404: Presence declaration not found.

25.3 PUT /typical-weeks/{id}/

Update a single typical week.

Update a single typical week from its ID.

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*id string A unique integer value identifying this typical week.

RESPONSE

284 of 352
STATUS CODE - 200:

RESPONSE MODEL - application/json

{
id integer READ-ONLY
ID of the typical week
agenda_id string READ-ONLY
monday* {
Monday declaration

id integer READ-ONLY
date string
morning* {
Morning (or all day) info

status* enum ALLOWED:0, 1, 2, 3, 4

The presence_status type:
Not set: 0
Office: 1
Remote: 2
Off site: 3
Off: 4
location {
Location in the resource address referential, as a JSON, "
"e.g. `{"country": "France", "site": "Paris", "floor": "1"}`

}
note string max:512 chars
conf_id string 1 to 100 chars
}
afternoon {
Morning (or all day) info

status* enum ALLOWED:0, 1, 2, 3, 4

The presence_status type:
Not set: 0
Office: 1
Remote: 2
Off site: 3
Off: 4
location {
Location in the resource address referential, as a JSON, "
"e.g. `{"country": "France", "site": "Paris", "floor": "1"}`

}
note string max:512 chars
conf_id string 1 to 100 chars
}
is_all_day boolean READ-ONLY
author_id string READ-ONLY
}
tuesday* {
Monday declaration

id integer READ-ONLY
date string
morning* {
Morning (or all day) info

status* enum ALLOWED:0, 1, 2, 3, 4

The presence_status type:
Not set: 0
Office: 1
Remote: 2
Off site: 3
Off: 4
location {
Location in the resource address referential, as a JSON, "
"e.g. `{"country": "France", "site": "Paris", "floor": "1"}`

285 of 352
 note string max:512 chars
conf_id string 1 to 100 chars
}
afternoon {
Morning (or all day) info

status* enum ALLOWED:0, 1, 2, 3, 4

The presence_status type:
Not set: 0
Office: 1
Remote: 2
Off site: 3
Off: 4
location {
Location in the resource address referential, as a JSON, "
"e.g. `{"country": "France", "site": "Paris", "floor": "1"}`

}
note string max:512 chars
conf_id string 1 to 100 chars
}
is_all_day boolean READ-ONLY
author_id string READ-ONLY
}
wednesday* {
Monday declaration

id integer READ-ONLY
date string
morning* {
Morning (or all day) info

status* enum ALLOWED:0, 1, 2, 3, 4

The presence_status type:
Not set: 0
Office: 1
Remote: 2
Off site: 3
Off: 4
location {
Location in the resource address referential, as a JSON, "
"e.g. `{"country": "France", "site": "Paris", "floor": "1"}`

}
note string max:512 chars
conf_id string 1 to 100 chars
}
afternoon {
Morning (or all day) info

status* enum ALLOWED:0, 1, 2, 3, 4

The presence_status type:
Not set: 0
Office: 1
Remote: 2
Off site: 3
Off: 4
location {
Location in the resource address referential, as a JSON, "
"e.g. `{"country": "France", "site": "Paris", "floor": "1"}`

}
note string max:512 chars
conf_id string 1 to 100 chars
}
is_all_day boolean READ-ONLY
author_id string READ-ONLY
}
thursday* {
Monday declaration

286 of 352
 id integer READ-ONLY

date string
morning* {
Morning (or all day) info

status* enum ALLOWED:0, 1, 2, 3, 4

The presence_status type:
Not set: 0
Office: 1
Remote: 2
Off site: 3
Off: 4
location {
Location in the resource address referential, as a JSON, "
"e.g. `{"country": "France", "site": "Paris", "floor": "1"}`

}
note string max:512 chars
conf_id string 1 to 100 chars
}
afternoon {
Morning (or all day) info

status* enum ALLOWED:0, 1, 2, 3, 4

The presence_status type:
Not set: 0
Office: 1
Remote: 2
Off site: 3
Off: 4
location {
Location in the resource address referential, as a JSON, "
"e.g. `{"country": "France", "site": "Paris", "floor": "1"}`

}
note string max:512 chars
conf_id string 1 to 100 chars
}
is_all_day boolean READ-ONLY
author_id string READ-ONLY
}
friday* {
Monday declaration

id integer READ-ONLY
date string
morning* {
Morning (or all day) info

status* enum ALLOWED:0, 1, 2, 3, 4

The presence_status type:
Not set: 0
Office: 1
Remote: 2
Off site: 3
Off: 4
location {
Location in the resource address referential, as a JSON, "
"e.g. `{"country": "France", "site": "Paris", "floor": "1"}`

}
note string max:512 chars
conf_id string 1 to 100 chars
}
afternoon {
Morning (or all day) info

status* enum ALLOWED:0, 1, 2, 3, 4

The presence_status type:
Not set: 0
Office: 1

287 of 352
 Remote: 2
Off site: 3
Off: 4
location {
Location in the resource address referential, as a JSON, "
"e.g. `{"country": "France", "site": "Paris", "floor": "1"}`

}
note string max:512 chars
conf_id string 1 to 100 chars
}
is_all_day boolean READ-ONLY
author_id string READ-ONLY
}
saturday* {
Monday declaration

id integer READ-ONLY
date string
morning* {
Morning (or all day) info

status* enum ALLOWED:0, 1, 2, 3, 4

The presence_status type:
Not set: 0
Office: 1
Remote: 2
Off site: 3
Off: 4
location {
Location in the resource address referential, as a JSON, "
"e.g. `{"country": "France", "site": "Paris", "floor": "1"}`

}
note string max:512 chars
conf_id string 1 to 100 chars
}
afternoon {
Morning (or all day) info

status* enum ALLOWED:0, 1, 2, 3, 4

The presence_status type:
Not set: 0
Office: 1
Remote: 2
Off site: 3
Off: 4
location {
Location in the resource address referential, as a JSON, "
"e.g. `{"country": "France", "site": "Paris", "floor": "1"}`

}
note string max:512 chars
conf_id string 1 to 100 chars
}
is_all_day boolean READ-ONLY
author_id string READ-ONLY
}
sunday* {
Monday declaration

id integer READ-ONLY
date string
morning* {
Morning (or all day) info

status* enum ALLOWED:0, 1, 2, 3, 4

The presence_status type:
Not set: 0
Office: 1
Remote: 2

288 of 352
 Off site: 3
Off: 4
location {
Location in the resource address referential, as a JSON, "
"e.g. `{"country": "France", "site": "Paris", "floor": "1"}`

}
note string max:512 chars
conf_id string 1 to 100 chars
}
afternoon {
Morning (or all day) info

status* enum ALLOWED:0, 1, 2, 3, 4

The presence_status type:
Not set: 0
Office: 1
Remote: 2
Off site: 3
Off: 4
location {
Location in the resource address referential, as a JSON, "
"e.g. `{"country": "France", "site": "Paris", "floor": "1"}`

}
note string max:512 chars
conf_id string 1 to 100 chars
}
is_all_day boolean READ-ONLY
author_id string READ-ONLY
}
}

STATUS CODE - 400: Invalid parameters.

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

STATUS CODE - 404: Presence declaration not found.

25.4 POST /typical-weeks/{id}/apply/

Apply given week from date to date.

Apply the given week from date to date.

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*id string A unique integer value identifying this typical week.

REQUEST BODY - application/json

{
from_date* string Apply from this date
to_date* string Apply until this date
}

RESPONSE

289 of 352
 STATUS CODE - 200:

RESPONSE MODEL - application/json

{
Monday declaration

id integer READ-ONLY
date string
morning* {
Morning (or all day) info

status* enum ALLOWED:0, 1, 2, 3, 4

The presence_status type:
Not set: 0
Office: 1
Remote: 2
Off site: 3
Off: 4
location {
Location in the resource address referential, as a JSON, "
"e.g. `{"country": "France", "site": "Paris", "floor": "1"}`

}
note string max:512 chars
conf_id string 1 to 100 chars
}
afternoon {
Morning (or all day) info

status* enum ALLOWED:0, 1, 2, 3, 4

The presence_status type:
Not set: 0
Office: 1
Remote: 2
Off site: 3
Off: 4
location {
Location in the resource address referential, as a JSON, "
"e.g. `{"country": "France", "site": "Paris", "floor": "1"}`

}
note string max:512 chars
conf_id string 1 to 100 chars
}
is_all_day boolean READ-ONLY
author_id string READ-ONLY
}

STATUS CODE - 400: Invalid parameters.

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

STATUS CODE - 404: Default Week not found

25.5 PATCH /typical-weeks/{id}/day/

Update a specific day.

Update a specific day within the typical week.

REQUEST
PATH PARAMETERS

290 of 352
 NAME TYPE DESCRIPTION

*id string A unique integer value identifying this typical week.

QUERY PARAMETERS
NAME TYPE DESCRIPTION

*day enum Weekday

ALLOWED: monday, tuesday, wednesday, thursday, friday, saturday, sunday

RESPONSE

STATUS CODE - 200:

RESPONSE MODEL - application/json

{
id integer READ-ONLY
ID of the typical week
agenda_id string READ-ONLY
monday* {
Monday declaration

id integer READ-ONLY
date string
morning* {
Morning (or all day) info

status* enum ALLOWED:0, 1, 2, 3, 4

The presence_status type:
Not set: 0
Office: 1
Remote: 2
Off site: 3
Off: 4
location {
Location in the resource address referential, as a JSON, "
"e.g. `{"country": "France", "site": "Paris", "floor": "1"}`

}
note string max:512 chars
conf_id string 1 to 100 chars
}
afternoon {
Morning (or all day) info

status* enum ALLOWED:0, 1, 2, 3, 4

The presence_status type:
Not set: 0
Office: 1
Remote: 2
Off site: 3
Off: 4
location {
Location in the resource address referential, as a JSON, "
"e.g. `{"country": "France", "site": "Paris", "floor": "1"}`

}
note string max:512 chars
conf_id string 1 to 100 chars
}
is_all_day boolean READ-ONLY
author_id string READ-ONLY
}
tuesday* {
Monday declaration

291 of 352
 id integer READ-ONLY

date string
morning* {
Morning (or all day) info

status* enum ALLOWED:0, 1, 2, 3, 4

The presence_status type:
Not set: 0
Office: 1
Remote: 2
Off site: 3
Off: 4
location {
Location in the resource address referential, as a JSON, "
"e.g. `{"country": "France", "site": "Paris", "floor": "1"}`

}
note string max:512 chars
conf_id string 1 to 100 chars
}
afternoon {
Morning (or all day) info

status* enum ALLOWED:0, 1, 2, 3, 4

The presence_status type:
Not set: 0
Office: 1
Remote: 2
Off site: 3
Off: 4
location {
Location in the resource address referential, as a JSON, "
"e.g. `{"country": "France", "site": "Paris", "floor": "1"}`

}
note string max:512 chars
conf_id string 1 to 100 chars
}
is_all_day boolean READ-ONLY
author_id string READ-ONLY
}
wednesday* {
Monday declaration

id integer READ-ONLY
date string
morning* {
Morning (or all day) info

status* enum ALLOWED:0, 1, 2, 3, 4

The presence_status type:
Not set: 0
Office: 1
Remote: 2
Off site: 3
Off: 4
location {
Location in the resource address referential, as a JSON, "
"e.g. `{"country": "France", "site": "Paris", "floor": "1"}`

}
note string max:512 chars
conf_id string 1 to 100 chars
}
afternoon {
Morning (or all day) info

status* enum ALLOWED:0, 1, 2, 3, 4

The presence_status type:
Not set: 0
Office: 1

292 of 352
 Remote: 2
Off site: 3
Off: 4
location {
Location in the resource address referential, as a JSON, "
"e.g. `{"country": "France", "site": "Paris", "floor": "1"}`

}
note string max:512 chars
conf_id string 1 to 100 chars
}
is_all_day boolean READ-ONLY
author_id string READ-ONLY
}
thursday* {
Monday declaration

id integer READ-ONLY
date string
morning* {
Morning (or all day) info

status* enum ALLOWED:0, 1, 2, 3, 4

The presence_status type:
Not set: 0
Office: 1
Remote: 2
Off site: 3
Off: 4
location {
Location in the resource address referential, as a JSON, "
"e.g. `{"country": "France", "site": "Paris", "floor": "1"}`

}
note string max:512 chars
conf_id string 1 to 100 chars
}
afternoon {
Morning (or all day) info

status* enum ALLOWED:0, 1, 2, 3, 4

The presence_status type:
Not set: 0
Office: 1
Remote: 2
Off site: 3
Off: 4
location {
Location in the resource address referential, as a JSON, "
"e.g. `{"country": "France", "site": "Paris", "floor": "1"}`

}
note string max:512 chars
conf_id string 1 to 100 chars
}
is_all_day boolean READ-ONLY
author_id string READ-ONLY
}
friday* {
Monday declaration

id integer READ-ONLY
date string
morning* {
Morning (or all day) info

status* enum ALLOWED:0, 1, 2, 3, 4

The presence_status type:
Not set: 0
Office: 1
Remote: 2

293 of 352
 Off site: 3
Off: 4
location {
Location in the resource address referential, as a JSON, "
"e.g. `{"country": "France", "site": "Paris", "floor": "1"}`

}
note string max:512 chars
conf_id string 1 to 100 chars
}
afternoon {
Morning (or all day) info

status* enum ALLOWED:0, 1, 2, 3, 4

The presence_status type:
Not set: 0
Office: 1
Remote: 2
Off site: 3
Off: 4
location {
Location in the resource address referential, as a JSON, "
"e.g. `{"country": "France", "site": "Paris", "floor": "1"}`

}
note string max:512 chars
conf_id string 1 to 100 chars
}
is_all_day boolean READ-ONLY
author_id string READ-ONLY
}
saturday* {
Monday declaration

id integer READ-ONLY
date string
morning* {
Morning (or all day) info

status* enum ALLOWED:0, 1, 2, 3, 4

The presence_status type:
Not set: 0
Office: 1
Remote: 2
Off site: 3
Off: 4
location {
Location in the resource address referential, as a JSON, "
"e.g. `{"country": "France", "site": "Paris", "floor": "1"}`

}
note string max:512 chars
conf_id string 1 to 100 chars
}
afternoon {
Morning (or all day) info

status* enum ALLOWED:0, 1, 2, 3, 4

The presence_status type:
Not set: 0
Office: 1
Remote: 2
Off site: 3
Off: 4
location {
Location in the resource address referential, as a JSON, "
"e.g. `{"country": "France", "site": "Paris", "floor": "1"}`

}
note string max:512 chars
conf_id string 1 to 100 chars

294 of 352
 }
is_all_day boolean READ-ONLY
author_id string READ-ONLY
}
sunday* {
Monday declaration

id integer READ-ONLY
date string
morning* {
Morning (or all day) info

status* enum ALLOWED:0, 1, 2, 3, 4

The presence_status type:
Not set: 0
Office: 1
Remote: 2
Off site: 3
Off: 4
location {
Location in the resource address referential, as a JSON, "
"e.g. `{"country": "France", "site": "Paris", "floor": "1"}`

}
note string max:512 chars
conf_id string 1 to 100 chars
}
afternoon {
Morning (or all day) info

status* enum ALLOWED:0, 1, 2, 3, 4

The presence_status type:
Not set: 0
Office: 1
Remote: 2
Off site: 3
Off: 4
location {
Location in the resource address referential, as a JSON, "
"e.g. `{"country": "France", "site": "Paris", "floor": "1"}`

}
note string max:512 chars
conf_id string 1 to 100 chars
}
is_all_day boolean READ-ONLY
author_id string READ-ONLY
}
}

STATUS CODE - 400: Invalid parameters.

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

STATUS CODE - 404: Default Week not found

25.6 POST /typical-weeks/{id}/reset-weekend/

Reset weekend statuses to NOT SET.

Reset weekend statuses to NOT SET on given week.

REQUEST

295 of 352
 PATH PARAMETERS
NAME TYPE DESCRIPTION

*id string A unique integer value identifying this typical week.

RESPONSE

STATUS CODE - 200:

RESPONSE MODEL - application/json

{
id integer READ-ONLY
ID of the typical week
agenda_id string READ-ONLY
monday* {
Monday declaration

id integer READ-ONLY
date string
morning* {
Morning (or all day) info

status* enum ALLOWED:0, 1, 2, 3, 4

The presence_status type:
Not set: 0
Office: 1
Remote: 2
Off site: 3
Off: 4
location {
Location in the resource address referential, as a JSON, "
"e.g. `{"country": "France", "site": "Paris", "floor": "1"}`

}
note string max:512 chars
conf_id string 1 to 100 chars
}
afternoon {
Morning (or all day) info

status* enum ALLOWED:0, 1, 2, 3, 4

The presence_status type:
Not set: 0
Office: 1
Remote: 2
Off site: 3
Off: 4
location {
Location in the resource address referential, as a JSON, "
"e.g. `{"country": "France", "site": "Paris", "floor": "1"}`

}
note string max:512 chars
conf_id string 1 to 100 chars
}
is_all_day boolean READ-ONLY
author_id string READ-ONLY
}
tuesday* {
Monday declaration

id integer READ-ONLY
date string
morning* {
Morning (or all day) info

status* enum ALLOWED:0, 1, 2, 3, 4

296 of 352
 The presence_status type:
Not set: 0
Office: 1
Remote: 2
Off site: 3
Off: 4
location {
Location in the resource address referential, as a JSON, "
"e.g. `{"country": "France", "site": "Paris", "floor": "1"}`

}
note string max:512 chars
conf_id string 1 to 100 chars
}
afternoon {
Morning (or all day) info

status* enum ALLOWED:0, 1, 2, 3, 4

The presence_status type:
Not set: 0
Office: 1
Remote: 2
Off site: 3
Off: 4
location {
Location in the resource address referential, as a JSON, "
"e.g. `{"country": "France", "site": "Paris", "floor": "1"}`

}
note string max:512 chars
conf_id string 1 to 100 chars
}
is_all_day boolean READ-ONLY
author_id string READ-ONLY
}
wednesday* {
Monday declaration

id integer READ-ONLY
date string
morning* {
Morning (or all day) info

status* enum ALLOWED:0, 1, 2, 3, 4

The presence_status type:
Not set: 0
Office: 1
Remote: 2
Off site: 3
Off: 4
location {
Location in the resource address referential, as a JSON, "
"e.g. `{"country": "France", "site": "Paris", "floor": "1"}`

}
note string max:512 chars
conf_id string 1 to 100 chars
}
afternoon {
Morning (or all day) info

status* enum ALLOWED:0, 1, 2, 3, 4

The presence_status type:
Not set: 0
Office: 1
Remote: 2
Off site: 3
Off: 4
location {
Location in the resource address referential, as a JSON, "
"e.g. `{"country": "France", "site": "Paris", "floor": "1"}`

297 of 352
 note string max:512 chars
conf_id string 1 to 100 chars
}
is_all_day boolean READ-ONLY
author_id string READ-ONLY
}
thursday* {
Monday declaration

id integer READ-ONLY
date string
morning* {
Morning (or all day) info

status* enum ALLOWED:0, 1, 2, 3, 4

The presence_status type:
Not set: 0
Office: 1
Remote: 2
Off site: 3
Off: 4
location {
Location in the resource address referential, as a JSON, "
"e.g. `{"country": "France", "site": "Paris", "floor": "1"}`

}
note string max:512 chars
conf_id string 1 to 100 chars
}
afternoon {
Morning (or all day) info

status* enum ALLOWED:0, 1, 2, 3, 4

The presence_status type:
Not set: 0
Office: 1
Remote: 2
Off site: 3
Off: 4
location {
Location in the resource address referential, as a JSON, "
"e.g. `{"country": "France", "site": "Paris", "floor": "1"}`

}
note string max:512 chars
conf_id string 1 to 100 chars
}
is_all_day boolean READ-ONLY
author_id string READ-ONLY
}
friday* {
Monday declaration

id integer READ-ONLY
date string
morning* {
Morning (or all day) info

status* enum ALLOWED:0, 1, 2, 3, 4

The presence_status type:
Not set: 0
Office: 1
Remote: 2
Off site: 3
Off: 4
location {
Location in the resource address referential, as a JSON, "
"e.g. `{"country": "France", "site": "Paris", "floor": "1"}`

}
note string max:512 chars

298 of 352
 conf_id string 1 to 100 chars
}
afternoon {
Morning (or all day) info

status* enum ALLOWED:0, 1, 2, 3, 4

The presence_status type:
Not set: 0
Office: 1
Remote: 2
Off site: 3
Off: 4
location {
Location in the resource address referential, as a JSON, "
"e.g. `{"country": "France", "site": "Paris", "floor": "1"}`

}
note string max:512 chars
conf_id string 1 to 100 chars
}
is_all_day boolean READ-ONLY
author_id string READ-ONLY
}
saturday* {
Monday declaration

id integer READ-ONLY
date string
morning* {
Morning (or all day) info

status* enum ALLOWED:0, 1, 2, 3, 4

The presence_status type:
Not set: 0
Office: 1
Remote: 2
Off site: 3
Off: 4
location {
Location in the resource address referential, as a JSON, "
"e.g. `{"country": "France", "site": "Paris", "floor": "1"}`

}
note string max:512 chars
conf_id string 1 to 100 chars
}
afternoon {
Morning (or all day) info

status* enum ALLOWED:0, 1, 2, 3, 4

The presence_status type:
Not set: 0
Office: 1
Remote: 2
Off site: 3
Off: 4
location {
Location in the resource address referential, as a JSON, "
"e.g. `{"country": "France", "site": "Paris", "floor": "1"}`

}
note string max:512 chars
conf_id string 1 to 100 chars
}
is_all_day boolean READ-ONLY
author_id string READ-ONLY
}
sunday* {
Monday declaration

id integer READ-ONLY

299 of 352
 date string
morning* {
Morning (or all day) info

status* enum ALLOWED:0, 1, 2, 3, 4

The presence_status type:
Not set: 0
Office: 1
Remote: 2
Off site: 3
Off: 4
location {
Location in the resource address referential, as a JSON, "
"e.g. `{"country": "France", "site": "Paris", "floor": "1"}`

}
note string max:512 chars
conf_id string 1 to 100 chars
}
afternoon {
Morning (or all day) info

status* enum ALLOWED:0, 1, 2, 3, 4

The presence_status type:
Not set: 0
Office: 1
Remote: 2
Off site: 3
Off: 4
location {
Location in the resource address referential, as a JSON, "
"e.g. `{"country": "France", "site": "Paris", "floor": "1"}`

}
note string max:512 chars
conf_id string 1 to 100 chars
}
is_all_day boolean READ-ONLY
author_id string READ-ONLY
}
}

STATUS CODE - 400: Invalid parameters.

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

STATUS CODE - 404: Default Week not found

300 of 352
26. USER-AGENDAS

26.1 GET /user-agendas/

Retrieve all UserAgenda instances.

Retrieve all UserAgenda instances with the presence declarations.You can filter on the access status,
the agenda ids and the start-end dates of the presence declarations.

REQUEST
QUERY PARAMETERS
NAME TYPE DESCRIPTION

page integer A page number within the paginated result set.

page_size integer Number of results to return per page.
range_start date Filter from this date
range_end date Filter until this date
access_status string The access_status type:
min:1 Pending: 0
chars Denied: 1
Accepted: 2
No access request: null
agenda_ids string Ids of the agendas (Comma-separated list of numbers, e.g. `1,2,3`)
min:1
chars
user_ids string Ids of the agenda owners (Comma-separated list of numbers, e.g. `1,2,3`)
min:1
chars
location string Filter on users present at this location

JSON format e.g. {"city": "Paris", "site": "Boulogne"}

Valid keys are: company, division, site, departement, corporation, building,
floor, door, number, street_line1, street_line2, zipcode, city, state, cedex,
postal_box, country
location_exclude_past boolean Exclude past dates when filtering on location

RESPONSE

STATUS CODE - 200:

RESPONSE MODEL - application/json

{
id* integer UserAgenda ID
user* {
User who requested the access

id* integer User ID

first_name* string min:1 chars
First name
last_name* string min:1 chars
Last name
picture string READ-ONLY

301 of 352
 Profile picture URI
agenda_id integer READ-ONLY
ID of the viewer's agenda
}
access_status* enum ALLOWED:0, 1, 2, null
The access_status type:
Pending: 0
Denied: 1
Accepted: 2
No access request: null
declarations* [{
Array of object: Monday declaration

id integer READ-ONLY
date string
morning* {
Morning (or all day) info

status* enum ALLOWED:0, 1, 2, 3, 4

The presence_status type:
Not set: 0
Office: 1
Remote: 2
Off site: 3
Off: 4
location {
Location in the resource address referential, as a JSON, "
"e.g. `{"country": "France", "site": "Paris", "floor": "1"}`

}
note string max:512 chars
conf_id string 1 to 100 chars
}
afternoon {
Morning (or all day) info

status* enum ALLOWED:0, 1, 2, 3, 4

The presence_status type:
Not set: 0
Office: 1
Remote: 2
Off site: 3
Off: 4
location {
Location in the resource address referential, as a JSON, "
"e.g. `{"country": "France", "site": "Paris", "floor": "1"}`

}
note string max:512 chars
conf_id string 1 to 100 chars
}
is_all_day boolean READ-ONLY
author_id string READ-ONLY
}]
rules [{
Array of object: Active presence rules (if the user is in a team you manage)

id integer READ-ONLY
valid_from* string
valid_until string
home_min_days number between 0 and 7
home_max_days number between 0 and 7
office_min_days number between 0 and 7
office_max_days number between 0 and 7
}]
}

STATUS CODE - 400: Invalid parameters.

302 of 352
 STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

26.2 GET /user-agendas/current/

Get your own agenda.

REQUEST
QUERY PARAMETERS
NAME TYPE DESCRIPTION

range_start date Filter from this date

range_end date Filter until this date

RESPONSE

STATUS CODE - 200:

RESPONSE MODEL - application/json

{
id* integer UserAgenda ID
user {
User who requested the access

id* integer User ID

first_name* string min:1 chars
First name
last_name* string min:1 chars
Last name
picture string READ-ONLY
Profile picture URI
agenda_id integer READ-ONLY
ID of the viewer's agenda
}
enabled boolean
declarations [{
Array of object: Monday declaration

id integer READ-ONLY
date string
morning* {
Morning (or all day) info

status* enum ALLOWED:0, 1, 2, 3, 4

The presence_status type:
Not set: 0
Office: 1
Remote: 2
Off site: 3
Off: 4
location {
Location in the resource address referential, as a JSON, "
"e.g. `{"country": "France", "site": "Paris", "floor": "1"}`

}
note string max:512 chars
conf_id string 1 to 100 chars
}
afternoon {
Morning (or all day) info

303 of 352
 status* enum ALLOWED:0, 1, 2, 3, 4
The presence_status type:
Not set: 0
Office: 1
Remote: 2
Off site: 3
Off: 4
location {
Location in the resource address referential, as a JSON, "
"e.g. `{"country": "France", "site": "Paris", "floor": "1"}`

}
note string max:512 chars
conf_id string 1 to 100 chars
}
is_all_day boolean READ-ONLY
author_id string READ-ONLY
}]
rules [{
Array of object: Active presence rules (if the user is in a team you manage)

id integer READ-ONLY
valid_from* string
valid_until string
home_min_days number between 0 and 7
home_max_days number between 0 and 7
office_min_days number between 0 and 7
office_max_days number between 0 and 7
}]
default_rules {
Active default rules

home_min_days* number between 0 and 7

Minimum presence days at home per week
home_max_days* number between 0 and 7
Maximum presence days at home per week
office_min_days* number between 0 and 7
Minimum office days at home per week
office_max_days* number between 0 and 7
Maximum office days at home per week
}
reminder_weekday enum ALLOWED:0, 1, 2, 3, 4, 5, 6, 7
remind_new_requests_weekly boolean
remind_missing_declarations_weekly boolean
remind_presence_rules_weekly boolean
can_manage_shared_teams string READ-ONLY
Allowed to create teams shared with their members (i.e. manager
profile)
}

STATUS CODE - 400: Invalid parameters.

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

26.3 GET /user-agendas/current/default-week/

Retrieve the default typical week of the current user.

REQUEST
No request parameters

304 of 352
RESPONSE

STATUS CODE - 200:

RESPONSE MODEL - application/json

{
id integer READ-ONLY
ID of the typical week
agenda_id string READ-ONLY
monday* {
Monday declaration

id integer READ-ONLY
date string
morning* {
Morning (or all day) info

status* enum ALLOWED:0, 1, 2, 3, 4

The presence_status type:
Not set: 0
Office: 1
Remote: 2
Off site: 3
Off: 4
location {
Location in the resource address referential, as a JSON, "
"e.g. `{"country": "France", "site": "Paris", "floor": "1"}`

}
note string max:512 chars
conf_id string 1 to 100 chars
}
afternoon {
Morning (or all day) info

status* enum ALLOWED:0, 1, 2, 3, 4

The presence_status type:
Not set: 0
Office: 1
Remote: 2
Off site: 3
Off: 4
location {
Location in the resource address referential, as a JSON, "
"e.g. `{"country": "France", "site": "Paris", "floor": "1"}`

}
note string max:512 chars
conf_id string 1 to 100 chars
}
is_all_day boolean READ-ONLY
author_id string READ-ONLY
}
tuesday* {
Monday declaration

id integer READ-ONLY
date string
morning* {
Morning (or all day) info

status* enum ALLOWED:0, 1, 2, 3, 4

The presence_status type:
Not set: 0
Office: 1
Remote: 2
Off site: 3
Off: 4
location {
Location in the resource address referential, as a JSON, "

305 of 352
 "e.g. `{"country": "France", "site": "Paris", "floor": "1"}`

}
note string max:512 chars
conf_id string 1 to 100 chars
}
afternoon {
Morning (or all day) info

status* enum ALLOWED:0, 1, 2, 3, 4

The presence_status type:
Not set: 0
Office: 1
Remote: 2
Off site: 3
Off: 4
location {
Location in the resource address referential, as a JSON, "
"e.g. `{"country": "France", "site": "Paris", "floor": "1"}`

}
note string max:512 chars
conf_id string 1 to 100 chars
}
is_all_day boolean READ-ONLY
author_id string READ-ONLY
}
wednesday* {
Monday declaration

id integer READ-ONLY
date string
morning* {
Morning (or all day) info

status* enum ALLOWED:0, 1, 2, 3, 4

The presence_status type:
Not set: 0
Office: 1
Remote: 2
Off site: 3
Off: 4
location {
Location in the resource address referential, as a JSON, "
"e.g. `{"country": "France", "site": "Paris", "floor": "1"}`

}
note string max:512 chars
conf_id string 1 to 100 chars
}
afternoon {
Morning (or all day) info

status* enum ALLOWED:0, 1, 2, 3, 4

The presence_status type:
Not set: 0
Office: 1
Remote: 2
Off site: 3
Off: 4
location {
Location in the resource address referential, as a JSON, "
"e.g. `{"country": "France", "site": "Paris", "floor": "1"}`

}
note string max:512 chars
conf_id string 1 to 100 chars
}
is_all_day boolean READ-ONLY
author_id string READ-ONLY
}

306 of 352
thursday* {
Monday declaration

id integer READ-ONLY
date string
morning* {
Morning (or all day) info

status* enum ALLOWED:0, 1, 2, 3, 4

The presence_status type:
Not set: 0
Office: 1
Remote: 2
Off site: 3
Off: 4
location {
Location in the resource address referential, as a JSON, "
"e.g. `{"country": "France", "site": "Paris", "floor": "1"}`

}
note string max:512 chars
conf_id string 1 to 100 chars
}
afternoon {
Morning (or all day) info

status* enum ALLOWED:0, 1, 2, 3, 4

The presence_status type:
Not set: 0
Office: 1
Remote: 2
Off site: 3
Off: 4
location {
Location in the resource address referential, as a JSON, "
"e.g. `{"country": "France", "site": "Paris", "floor": "1"}`

}
note string max:512 chars
conf_id string 1 to 100 chars
}
is_all_day boolean READ-ONLY
author_id string READ-ONLY
}
friday* {
Monday declaration

id integer READ-ONLY
date string
morning* {
Morning (or all day) info

status* enum ALLOWED:0, 1, 2, 3, 4

The presence_status type:
Not set: 0
Office: 1
Remote: 2
Off site: 3
Off: 4
location {
Location in the resource address referential, as a JSON, "
"e.g. `{"country": "France", "site": "Paris", "floor": "1"}`

}
note string max:512 chars
conf_id string 1 to 100 chars
}
afternoon {
Morning (or all day) info

status* enum ALLOWED:0, 1, 2, 3, 4

The presence_status type:

307 of 352
 Not set: 0
Office: 1
Remote: 2
Off site: 3
Off: 4
location {
Location in the resource address referential, as a JSON, "
"e.g. `{"country": "France", "site": "Paris", "floor": "1"}`

}
note string max:512 chars
conf_id string 1 to 100 chars
}
is_all_day boolean READ-ONLY
author_id string READ-ONLY
}
saturday* {
Monday declaration

id integer READ-ONLY
date string
morning* {
Morning (or all day) info

status* enum ALLOWED:0, 1, 2, 3, 4

The presence_status type:
Not set: 0
Office: 1
Remote: 2
Off site: 3
Off: 4
location {
Location in the resource address referential, as a JSON, "
"e.g. `{"country": "France", "site": "Paris", "floor": "1"}`

}
note string max:512 chars
conf_id string 1 to 100 chars
}
afternoon {
Morning (or all day) info

status* enum ALLOWED:0, 1, 2, 3, 4

The presence_status type:
Not set: 0
Office: 1
Remote: 2
Off site: 3
Off: 4
location {
Location in the resource address referential, as a JSON, "
"e.g. `{"country": "France", "site": "Paris", "floor": "1"}`

}
note string max:512 chars
conf_id string 1 to 100 chars
}
is_all_day boolean READ-ONLY
author_id string READ-ONLY
}
sunday* {
Monday declaration

id integer READ-ONLY
date string
morning* {
Morning (or all day) info

status* enum ALLOWED:0, 1, 2, 3, 4

The presence_status type:
Not set: 0

308 of 352
 Office: 1
Remote: 2
Off site: 3
Off: 4
location {
Location in the resource address referential, as a JSON, "
"e.g. `{"country": "France", "site": "Paris", "floor": "1"}`

}
note string max:512 chars
conf_id string 1 to 100 chars
}
afternoon {
Morning (or all day) info

status* enum ALLOWED:0, 1, 2, 3, 4

The presence_status type:
Not set: 0
Office: 1
Remote: 2
Off site: 3
Off: 4
location {
Location in the resource address referential, as a JSON, "
"e.g. `{"country": "France", "site": "Paris", "floor": "1"}`

}
note string max:512 chars
conf_id string 1 to 100 chars
}
is_all_day boolean READ-ONLY
author_id string READ-ONLY
}
}

STATUS CODE - 400: Invalid parameters.

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

STATUS CODE - 404: Default Week not found

26.4 PUT /user-agendas/current/default-week/

Update the default typical week of the current user.

REQUEST

RESPONSE

STATUS CODE - 200:

RESPONSE MODEL - application/json

{
id integer READ-ONLY
ID of the typical week
agenda_id string READ-ONLY
monday* {
Monday declaration

id integer READ-ONLY
date string
morning* {
Morning (or all day) info

309 of 352
 status* enum ALLOWED:0, 1, 2, 3, 4
The presence_status type:
Not set: 0
Office: 1
Remote: 2
Off site: 3
Off: 4
location {
Location in the resource address referential, as a JSON, "
"e.g. `{"country": "France", "site": "Paris", "floor": "1"}`

}
note string max:512 chars
conf_id string 1 to 100 chars
}
afternoon {
Morning (or all day) info

status* enum ALLOWED:0, 1, 2, 3, 4

The presence_status type:
Not set: 0
Office: 1
Remote: 2
Off site: 3
Off: 4
location {
Location in the resource address referential, as a JSON, "
"e.g. `{"country": "France", "site": "Paris", "floor": "1"}`

}
note string max:512 chars
conf_id string 1 to 100 chars
}
is_all_day boolean READ-ONLY
author_id string READ-ONLY
}
tuesday* {
Monday declaration

id integer READ-ONLY
date string
morning* {
Morning (or all day) info

status* enum ALLOWED:0, 1, 2, 3, 4

The presence_status type:
Not set: 0
Office: 1
Remote: 2
Off site: 3
Off: 4
location {
Location in the resource address referential, as a JSON, "
"e.g. `{"country": "France", "site": "Paris", "floor": "1"}`

}
note string max:512 chars
conf_id string 1 to 100 chars
}
afternoon {
Morning (or all day) info

status* enum ALLOWED:0, 1, 2, 3, 4

The presence_status type:
Not set: 0
Office: 1
Remote: 2
Off site: 3
Off: 4
location {
Location in the resource address referential, as a JSON, "
"e.g. `{"country": "France", "site": "Paris", "floor": "1"}`

310 of 352
 }
note string max:512 chars
conf_id string 1 to 100 chars
}
is_all_day boolean READ-ONLY
author_id string READ-ONLY
}
wednesday* {
Monday declaration

id integer READ-ONLY
date string
morning* {
Morning (or all day) info

status* enum ALLOWED:0, 1, 2, 3, 4

The presence_status type:
Not set: 0
Office: 1
Remote: 2
Off site: 3
Off: 4
location {
Location in the resource address referential, as a JSON, "
"e.g. `{"country": "France", "site": "Paris", "floor": "1"}`

}
note string max:512 chars
conf_id string 1 to 100 chars
}
afternoon {
Morning (or all day) info

status* enum ALLOWED:0, 1, 2, 3, 4

The presence_status type:
Not set: 0
Office: 1
Remote: 2
Off site: 3
Off: 4
location {
Location in the resource address referential, as a JSON, "
"e.g. `{"country": "France", "site": "Paris", "floor": "1"}`

}
note string max:512 chars
conf_id string 1 to 100 chars
}
is_all_day boolean READ-ONLY
author_id string READ-ONLY
}
thursday* {
Monday declaration

id integer READ-ONLY
date string
morning* {
Morning (or all day) info

status* enum ALLOWED:0, 1, 2, 3, 4

The presence_status type:
Not set: 0
Office: 1
Remote: 2
Off site: 3
Off: 4
location {
Location in the resource address referential, as a JSON, "
"e.g. `{"country": "France", "site": "Paris", "floor": "1"}`

311 of 352
 note string max:512 chars
conf_id string 1 to 100 chars
}
afternoon {
Morning (or all day) info

status* enum ALLOWED:0, 1, 2, 3, 4

The presence_status type:
Not set: 0
Office: 1
Remote: 2
Off site: 3
Off: 4
location {
Location in the resource address referential, as a JSON, "
"e.g. `{"country": "France", "site": "Paris", "floor": "1"}`

}
note string max:512 chars
conf_id string 1 to 100 chars
}
is_all_day boolean READ-ONLY
author_id string READ-ONLY
}
friday* {
Monday declaration

id integer READ-ONLY
date string
morning* {
Morning (or all day) info

status* enum ALLOWED:0, 1, 2, 3, 4

The presence_status type:
Not set: 0
Office: 1
Remote: 2
Off site: 3
Off: 4
location {
Location in the resource address referential, as a JSON, "
"e.g. `{"country": "France", "site": "Paris", "floor": "1"}`

}
note string max:512 chars
conf_id string 1 to 100 chars
}
afternoon {
Morning (or all day) info

status* enum ALLOWED:0, 1, 2, 3, 4

The presence_status type:
Not set: 0
Office: 1
Remote: 2
Off site: 3
Off: 4
location {
Location in the resource address referential, as a JSON, "
"e.g. `{"country": "France", "site": "Paris", "floor": "1"}`

}
note string max:512 chars
conf_id string 1 to 100 chars
}
is_all_day boolean READ-ONLY
author_id string READ-ONLY
}
saturday* {
Monday declaration

312 of 352
 id integer READ-ONLY

date string
morning* {
Morning (or all day) info

status* enum ALLOWED:0, 1, 2, 3, 4

The presence_status type:
Not set: 0
Office: 1
Remote: 2
Off site: 3
Off: 4
location {
Location in the resource address referential, as a JSON, "
"e.g. `{"country": "France", "site": "Paris", "floor": "1"}`

}
note string max:512 chars
conf_id string 1 to 100 chars
}
afternoon {
Morning (or all day) info

status* enum ALLOWED:0, 1, 2, 3, 4

The presence_status type:
Not set: 0
Office: 1
Remote: 2
Off site: 3
Off: 4
location {
Location in the resource address referential, as a JSON, "
"e.g. `{"country": "France", "site": "Paris", "floor": "1"}`

}
note string max:512 chars
conf_id string 1 to 100 chars
}
is_all_day boolean READ-ONLY
author_id string READ-ONLY
}
sunday* {
Monday declaration

id integer READ-ONLY
date string
morning* {
Morning (or all day) info

status* enum ALLOWED:0, 1, 2, 3, 4

The presence_status type:
Not set: 0
Office: 1
Remote: 2
Off site: 3
Off: 4
location {
Location in the resource address referential, as a JSON, "
"e.g. `{"country": "France", "site": "Paris", "floor": "1"}`

}
note string max:512 chars
conf_id string 1 to 100 chars
}
afternoon {
Morning (or all day) info

status* enum ALLOWED:0, 1, 2, 3, 4

The presence_status type:
Not set: 0
Office: 1

313 of 352
 Remote: 2
Off site: 3
Off: 4
location {
Location in the resource address referential, as a JSON, "
"e.g. `{"country": "France", "site": "Paris", "floor": "1"}`

}
note string max:512 chars
conf_id string 1 to 100 chars
}
is_all_day boolean READ-ONLY
author_id string READ-ONLY
}
}

STATUS CODE - 400: Invalid parameters.

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

STATUS CODE - 404: Default Week not found

26.5 PATCH /user-agendas/current/default-week/

Update a specific day within the default typical week of the current user.

REQUEST
QUERY PARAMETERS
NAME TYPE DESCRIPTION

*day enum Weekday

ALLOWED: monday, tuesday, wednesday, thursday, friday, saturday, sunday

RESPONSE

STATUS CODE - 200:

RESPONSE MODEL - application/json

{
id integer READ-ONLY
ID of the typical week
agenda_id string READ-ONLY
monday* {
Monday declaration

id integer READ-ONLY
date string
morning* {
Morning (or all day) info

status* enum ALLOWED:0, 1, 2, 3, 4

The presence_status type:
Not set: 0
Office: 1
Remote: 2
Off site: 3
Off: 4
location {
Location in the resource address referential, as a JSON, "
"e.g. `{"country": "France", "site": "Paris", "floor": "1"}`

314 of 352
 }
note string max:512 chars
conf_id string 1 to 100 chars
}
afternoon {
Morning (or all day) info

status* enum ALLOWED:0, 1, 2, 3, 4

The presence_status type:
Not set: 0
Office: 1
Remote: 2
Off site: 3
Off: 4
location {
Location in the resource address referential, as a JSON, "
"e.g. `{"country": "France", "site": "Paris", "floor": "1"}`

}
note string max:512 chars
conf_id string 1 to 100 chars
}
is_all_day boolean READ-ONLY
author_id string READ-ONLY
}
tuesday* {
Monday declaration

id integer READ-ONLY
date string
morning* {
Morning (or all day) info

status* enum ALLOWED:0, 1, 2, 3, 4

The presence_status type:
Not set: 0
Office: 1
Remote: 2
Off site: 3
Off: 4
location {
Location in the resource address referential, as a JSON, "
"e.g. `{"country": "France", "site": "Paris", "floor": "1"}`

}
note string max:512 chars
conf_id string 1 to 100 chars
}
afternoon {
Morning (or all day) info

status* enum ALLOWED:0, 1, 2, 3, 4

The presence_status type:
Not set: 0
Office: 1
Remote: 2
Off site: 3
Off: 4
location {
Location in the resource address referential, as a JSON, "
"e.g. `{"country": "France", "site": "Paris", "floor": "1"}`

}
note string max:512 chars
conf_id string 1 to 100 chars
}
is_all_day boolean READ-ONLY
author_id string READ-ONLY
}
wednesday* {

315 of 352
Monday declaration

id integer READ-ONLY
date string
morning* {
Morning (or all day) info

status* enum ALLOWED:0, 1, 2, 3, 4

The presence_status type:
Not set: 0
Office: 1
Remote: 2
Off site: 3
Off: 4
location {
Location in the resource address referential, as a JSON, "
"e.g. `{"country": "France", "site": "Paris", "floor": "1"}`

}
note string max:512 chars
conf_id string 1 to 100 chars
}
afternoon {
Morning (or all day) info

status* enum ALLOWED:0, 1, 2, 3, 4

The presence_status type:
Not set: 0
Office: 1
Remote: 2
Off site: 3
Off: 4
location {
Location in the resource address referential, as a JSON, "
"e.g. `{"country": "France", "site": "Paris", "floor": "1"}`

}
note string max:512 chars
conf_id string 1 to 100 chars
}
is_all_day boolean READ-ONLY
author_id string READ-ONLY
}
thursday* {
Monday declaration

id integer READ-ONLY
date string
morning* {
Morning (or all day) info

status* enum ALLOWED:0, 1, 2, 3, 4

The presence_status type:
Not set: 0
Office: 1
Remote: 2
Off site: 3
Off: 4
location {
Location in the resource address referential, as a JSON, "
"e.g. `{"country": "France", "site": "Paris", "floor": "1"}`

}
note string max:512 chars
conf_id string 1 to 100 chars
}
afternoon {
Morning (or all day) info

status* enum ALLOWED:0, 1, 2, 3, 4

The presence_status type:
Not set: 0

316 of 352
 Office: 1
Remote: 2
Off site: 3
Off: 4
location {
Location in the resource address referential, as a JSON, "
"e.g. `{"country": "France", "site": "Paris", "floor": "1"}`

}
note string max:512 chars
conf_id string 1 to 100 chars
}
is_all_day boolean READ-ONLY
author_id string READ-ONLY
}
friday* {
Monday declaration

id integer READ-ONLY
date string
morning* {
Morning (or all day) info

status* enum ALLOWED:0, 1, 2, 3, 4

The presence_status type:
Not set: 0
Office: 1
Remote: 2
Off site: 3
Off: 4
location {
Location in the resource address referential, as a JSON, "
"e.g. `{"country": "France", "site": "Paris", "floor": "1"}`

}
note string max:512 chars
conf_id string 1 to 100 chars
}
afternoon {
Morning (or all day) info

status* enum ALLOWED:0, 1, 2, 3, 4

The presence_status type:
Not set: 0
Office: 1
Remote: 2
Off site: 3
Off: 4
location {
Location in the resource address referential, as a JSON, "
"e.g. `{"country": "France", "site": "Paris", "floor": "1"}`

}
note string max:512 chars
conf_id string 1 to 100 chars
}
is_all_day boolean READ-ONLY
author_id string READ-ONLY
}
saturday* {
Monday declaration

id integer READ-ONLY
date string
morning* {
Morning (or all day) info

status* enum ALLOWED:0, 1, 2, 3, 4

The presence_status type:
Not set: 0
Office: 1

317 of 352
 Remote: 2
Off site: 3
Off: 4
location {
Location in the resource address referential, as a JSON, "
"e.g. `{"country": "France", "site": "Paris", "floor": "1"}`

}
note string max:512 chars
conf_id string 1 to 100 chars
}
afternoon {
Morning (or all day) info

status* enum ALLOWED:0, 1, 2, 3, 4

The presence_status type:
Not set: 0
Office: 1
Remote: 2
Off site: 3
Off: 4
location {
Location in the resource address referential, as a JSON, "
"e.g. `{"country": "France", "site": "Paris", "floor": "1"}`

}
note string max:512 chars
conf_id string 1 to 100 chars
}
is_all_day boolean READ-ONLY
author_id string READ-ONLY
}
sunday* {
Monday declaration

id integer READ-ONLY
date string
morning* {
Morning (or all day) info

status* enum ALLOWED:0, 1, 2, 3, 4

The presence_status type:
Not set: 0
Office: 1
Remote: 2
Off site: 3
Off: 4
location {
Location in the resource address referential, as a JSON, "
"e.g. `{"country": "France", "site": "Paris", "floor": "1"}`

}
note string max:512 chars
conf_id string 1 to 100 chars
}
afternoon {
Morning (or all day) info

status* enum ALLOWED:0, 1, 2, 3, 4

The presence_status type:
Not set: 0
Office: 1
Remote: 2
Off site: 3
Off: 4
location {
Location in the resource address referential, as a JSON, "
"e.g. `{"country": "France", "site": "Paris", "floor": "1"}`

}
note string max:512 chars
conf_id string 1 to 100 chars

318 of 352
 }
is_all_day boolean READ-ONLY
author_id string READ-ONLY
}
}

STATUS CODE - 400: Invalid parameters.

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

STATUS CODE - 404: Default Week not found

26.6 POST /user-agendas/disable/{user_id}/

Disable Office Presence module for a User.

Disable Office Presence module for a User by creating an active UserAgendaor by reactivating the
existing one.

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*user_id integer User ID

RESPONSE

STATUS CODE - 200:

RESPONSE MODEL - application/json

{
Agenda requested

id integer READ-ONLY
user* {
User who requested the access

id* integer User ID

first_name* string min:1 chars
First name
last_name* string min:1 chars
Last name
picture string READ-ONLY
Profile picture URI
agenda_id integer READ-ONLY
ID of the viewer's agenda
}
enabled boolean
}

STATUS CODE - 400: Invalid parameters.

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

319 of 352
26.7 POST /user-agendas/enable/{user_id}/

Enable Office Presence module for a User.

Enable Office Presence module for a User by creating an active UserAgendaor by reactivating the
existing one.

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*user_id integer User ID

RESPONSE

STATUS CODE - 204: Success

STATUS CODE - 400: Invalid parameters.

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

26.8 GET /user-agendas/enabled-for-me/

Shortcut to get Office Presence activation status for the current user.

Shortcut to get Office Presence activation status for the current user.Office Presence module has to be
enabled in cloud.

REQUEST
QUERY PARAMETERS
NAME TYPE DESCRIPTION

page integer A page number within the paginated result set.

page_size integer Number of results to return per page.

RESPONSE

STATUS CODE - 200: true or false

STATUS CODE - 400: Invalid parameters.

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

26.9 GET /user-agendas/search/

Search in users.

Search in users whether they have an UserAgenda or not yet. You can use a query for a name search.

320 of 352
REQUEST
QUERY PARAMETERS
NAME TYPE DESCRIPTION

page integer A page number within the paginated result set.

page_size integer Number of results to return per page.
query string Name search query
min:1 chars
exclude_user_ids string IDs of users to exclude (Comma-separated list of numbers, e.g. `1,2,3`)
min:1 chars
exclude_myself boolean Exclude current user from the results

RESPONSE

STATUS CODE - 200:

RESPONSE MODEL - application/json

{
user* {
User who requested the access

id* integer User ID

first_name* string min:1 chars
First name
last_name* string min:1 chars
Last name
picture string READ-ONLY
Profile picture URI
agenda_id integer READ-ONLY
ID of the viewer's agenda
}
id* integer UserAgenda ID
access_status* enum ALLOWED:0, 1, 2
Status of your access request to this agenda (if any)
enabled* boolean Office presence module enabled for this user
}

STATUS CODE - 400: Invalid parameters.

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

26.10 PUT /user-agendas/{id}/

Edit your own agenda.

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*id string A unique integer value identifying this user agenda.

REQUEST BODY - application/json

321 of 352
 {
id integer READ-ONLY
user integer READ-ONLY
reminder_weekday enum ALLOWED:0, 1, 2, 3, 4, 5, 6, 7
0: Monday > 6: Sunday / 7: Never
remind_new_requests_weekly boolean
remind_missing_declarations_weekly boolean
remind_presence_rules_weekly boolean
}

RESPONSE

STATUS CODE - 200:

RESPONSE MODEL - application/json

{
id integer READ-ONLY
user integer READ-ONLY
reminder_weekday enum ALLOWED:0, 1, 2, 3, 4, 5, 6, 7
0: Monday > 6: Sunday / 7: Never
remind_new_requests_weekly boolean
remind_missing_declarations_weekly boolean
remind_presence_rules_weekly boolean
}

STATUS CODE - 400: Invalid parameters.

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

322 of 352
27. USERS

27.1 POST /users/

Create local user.

Create a local user.

REQUEST
REQUEST BODY - application/json
{
first_name* string min:1 chars
last_name* string min:1 chars
email* string min:1 chars
account_type enum ALLOWED:standard, service_with_impersonation,
service_without_impersonation, device
cloud_right string min:1 chars
language string min:1 chars
}

RESPONSE

STATUS CODE - 200:

RESPONSE MODEL - application/json

{
id integer READ-ONLY
uuid string READ-ONLY
first_name string max:150 chars
last_name string max:150 chars
email string max:254 chars
username* string 1 to 150 chars
PATTERN:^[\w.@+-]+$
Required. 150 characters or fewer. Letters, digits and @/./+/-/_
only.
full_name* string min:1 chars
account_type string READ-ONLY
standard, service_with_impersonation,
service_without_impersonation, device
cloud_space_right {
instant_social* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_tv* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_booking* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_signage* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_metrics* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,

323 of 352
 CLOUD_POWERUSER, CLOUD_ADMIN
instant_device_manager* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
}
}

STATUS CODE - 400: Invalid parameters.

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

27.2 GET /users/current/

Get current user data.

REQUEST
No request parameters

RESPONSE

STATUS CODE - 200:

RESPONSE MODEL - application/json

{
id integer READ-ONLY
uuid string READ-ONLY
first_name string max:150 chars
last_name string max:150 chars
email string max:254 chars
username* string 1 to 150 chars
PATTERN:^[\w.@+-]+$
Required. 150 characters or fewer. Letters, digits and @/./+/-/_
only.
full_name* string min:1 chars
account_type string READ-ONLY
standard, service_with_impersonation,
service_without_impersonation, device
cloud_space_right {
instant_social* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_tv* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_booking* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_signage* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_metrics* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_device_manager* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,

324 of 352
 CLOUD_POWERUSER, CLOUD_ADMIN
}
}

STATUS CODE - 400: Invalid parameters.

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

27.3 GET /users/import-model-file/

Get the sample file for the import

REQUEST
No request parameters

RESPONSE

STATUS CODE - 200:

RESPONSE MODEL - application/json

string

STATUS CODE - 400: Invalid parameters.

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

27.4 PUT /users/profile-generic-properties/

Update current profile generic properties.

Update current profile generic properties.

To use this end-point, you have to be cloud-user.

REQUEST
REQUEST BODY - application/json
[{
Array of object:

name* string min:1 chars

value* string min:1 chars
type* string min:1 chars
}]

RESPONSE

STATUS CODE - 200:

RESPONSE MODEL - application/json

[{
Array of object:

name* string min:1 chars

325 of 352
 value* string min:1 chars
type* string min:1 chars
}]

STATUS CODE - 400: Invalid parameters.

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

27.5 DELETE /users/profile-generic-properties/

Delete current profile generic properties.

Delete current profile generic properties.

To use this end-point, you have to be cloud-user.

REQUEST
REQUEST BODY - application/json
{
profile_generic_properties_name_list* [string] min:1 chars
}

RESPONSE

STATUS CODE - 200:

RESPONSE MODEL - application/json

[{
Array of object:

name* string min:1 chars

value* string min:1 chars
type* string min:1 chars
}]

STATUS CODE - 400: Invalid parameters.

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

27.6 GET /users/profile/

Get current profile data.

Get user profile data.

REQUEST
No request parameters

RESPONSE

STATUS CODE - 200:

326 of 352
RESPONSE MODEL - application/json
{
location string Location value (e.g. SharingCloud/France)
language enum ALLOWED:de, en-gb, en, es, fr, it, pt, ru, zh-hans, zh-hant, ja
Language
timezone enum ALLOWED:Africa/Abidjan,
Africa/Accra, Africa/Bamako, Africa/
Banjul, Africa/Bissau, Africa/Conakry, Africa/Dakar, Africa/
Freetown, Africa/Lome, Africa/Monrovia, Africa/Nouakchott,
Africa/Ouagadougou, Africa/Sao_Tome, America/Danmarkshavn,
America/Scoresbysund, Atlantic/Azores, Atlantic/Reykjavik,
Atlantic/St_Helena, GMT, UTC, Africa/Algiers, Africa/Bangui,
Africa/Brazzaville, Africa/Casablanca, Africa/Douala, Africa/
El_Aaiun, Africa/Kinshasa, Africa/Lagos, Africa/Libreville,
Africa/Luanda, Africa/Malabo, Africa/Ndjamena, Africa/Niamey,
Africa/Porto-Novo, Africa/Tunis, Atlantic/Canary, Atlantic/
Faroe, Atlantic/Madeira, Europe/Dublin, Europe/Guernsey,
Europe/Isle_of_Man, Europe/Jersey, Europe/Lisbon, Europe/
London, Africa/Blantyre, Africa/Bujumbura, Africa/Cairo,
Africa/Ceuta, Africa/Gaborone, Africa/Harare, Africa/
Johannesburg, Africa/Juba, Africa/Khartoum, Africa/Kigali,
Africa/Lubumbashi, Africa/Lusaka, Africa/Maputo, Africa/
Maseru, Africa/Mbabane, Africa/Tripoli, Africa/Windhoek,
Antarctica/Troll, Arctic/Longyearbyen, Europe/Amsterdam,
Europe/Andorra, Europe/Belgrade, Europe/Berlin, Europe/
Bratislava, Europe/Brussels, Europe/Budapest, Europe/
Busingen, Europe/Copenhagen, Europe/Gibraltar, Europe/
Kaliningrad, Europe/Ljubljana, Europe/Luxembourg, Europe/
Madrid, Europe/Malta, Europe/Monaco, Europe/Oslo, Europe/
Paris, Europe/Podgorica, Europe/Prague, Europe/Rome, Europe/
San_Marino, Europe/Sarajevo, Europe/Skopje, Europe/Stockholm,
Europe/Tirane, Europe/Vaduz, Europe/Vatican, Europe/Vienna,
Europe/Warsaw, Europe/Zagreb, Europe/Zurich, Africa/
Addis_Ababa, Africa/Asmara, Africa/Dar_es_Salaam, Africa/
Djibouti, Africa/Kampala, Africa/Mogadishu, Africa/Nairobi,
Antarctica/Syowa, Asia/Aden, Asia/Amman, Asia/Baghdad, Asia/
Bahrain, Asia/Beirut, Asia/Damascus, Asia/Famagusta, Asia/
Gaza, Asia/Hebron, Asia/Jerusalem, Asia/Kuwait, Asia/Nicosia,
Asia/Qatar, Asia/Riyadh, Europe/Athens, Europe/Bucharest,
Europe/Chisinau, Europe/Helsinki, Europe/Istanbul, Europe/
Kiev, Europe/Kirov, Europe/Mariehamn, Europe/Minsk, Europe/
Moscow, Europe/Riga, Europe/Simferopol, Europe/Sofia, Europe/
Tallinn, Europe/Uzhgorod, Europe/Vilnius, Europe/Volgograd,
Europe/Zaporozhye, Indian/Antananarivo, Indian/Comoro,
Indian/Mayotte, Asia/Baku, Asia/Dubai, Asia/Muscat, Asia/
Tbilisi, Asia/Yerevan, Europe/Astrakhan, Europe/Samara,
Europe/Saratov, Europe/Ulyanovsk, Indian/Mahe, Indian/
Mauritius, Indian/Reunion, Asia/Kabul, Asia/Tehran,
Antarctica/Mawson, Asia/Aqtau, Asia/Aqtobe, Asia/Ashgabat,
Asia/Atyrau, Asia/Dushanbe, Asia/Karachi, Asia/Oral, Asia/
Qyzylorda, Asia/Samarkand, Asia/Tashkent, Asia/Yekaterinburg,
Indian/Kerguelen, Indian/Maldives, Asia/Colombo, Asia/
Kolkata, Asia/Kathmandu, Antarctica/Vostok, Asia/Almaty,
Asia/Bishkek, Asia/Dhaka, Asia/Omsk, Asia/Qostanay, Asia/
Thimphu, Asia/Urumqi, Indian/Chagos, Asia/Yangon, Indian/
Cocos, Antarctica/Davis, Asia/Bangkok, Asia/Barnaul, Asia/
Ho_Chi_Minh, Asia/Hovd, Asia/Jakarta, Asia/Krasnoyarsk, Asia/
Novokuznetsk, Asia/Novosibirsk, Asia/Phnom_Penh, Asia/

327 of 352
Pontianak, Asia/Tomsk, Asia/Vientiane, Indian/Christmas,
Asia/Brunei, Asia/Choibalsan, Asia/Hong_Kong, Asia/Irkutsk,
Asia/Kuala_Lumpur, Asia/Kuching, Asia/Macau, Asia/Makassar,
Asia/Manila, Asia/Shanghai, Asia/Singapore, Asia/Taipei,
Asia/Ulaanbaatar, Australia/Perth, Australia/Eucla, Asia/
Chita, Asia/Dili, Asia/Jayapura, Asia/Khandyga, Asia/
Pyongyang, Asia/Seoul, Asia/Tokyo, Asia/Yakutsk, Pacific/
Palau, Australia/Adelaide, Australia/Broken_Hill, Australia/
Darwin, Antarctica/DumontDUrville, Antarctica/Macquarie,
Asia/Ust-Nera, Asia/Vladivostok, Australia/Brisbane,
Australia/Hobart, Australia/Lindeman, Australia/Melbourne,
Australia/Sydney, Pacific/Chuuk, Pacific/Guam, Pacific/
Port_Moresby, Pacific/Saipan, Australia/Lord_Howe,
Antarctica/Casey, Asia/Magadan, Asia/Sakhalin, Asia/
Srednekolymsk, Pacific/Bougainville, Pacific/Efate, Pacific/
Guadalcanal, Pacific/Kosrae, Pacific/Norfolk, Pacific/Noumea,
Pacific/Pohnpei, Antarctica/McMurdo, Asia/Anadyr, Asia/
Kamchatka, Pacific/Auckland, Pacific/Fiji, Pacific/Funafuti,
Pacific/Kwajalein, Pacific/Majuro, Pacific/Nauru, Pacific/
Tarawa, Pacific/Wake, Pacific/Wallis, Pacific/Chatham,
Pacific/Apia, Pacific/Enderbury, Pacific/Fakaofo, Pacific/
Tongatapu, Pacific/Kiritimati, Atlantic/Cape_Verde, America/
Miquelon, America/Noronha, America/Nuuk, Atlantic/
South_Georgia, America/St_Johns, Canada/Newfoundland,
America/Araguaina, America/Argentina/Buenos_Aires, America/
Argentina/Catamarca, America/Argentina/Cordoba, America/
Argentina/Jujuy, America/Argentina/La_Rioja, America/
Argentina/Mendoza, America/Argentina/Rio_Gallegos, America/
Argentina/Salta, America/Argentina/San_Juan, America/
Argentina/San_Luis, America/Argentina/Tucuman, America/
Argentina/Ushuaia, America/Bahia, America/Belem, America/
Cayenne, America/Fortaleza, America/Glace_Bay, America/
Goose_Bay, America/Halifax, America/Maceio, America/Moncton,
America/Montevideo, America/Paramaribo, America/Punta_Arenas,
America/Recife, America/Santarem, America/Santiago, America/
Sao_Paulo, America/Thule, Antarctica/Palmer, Antarctica/
Rothera, Atlantic/Bermuda, Atlantic/Stanley, Canada/Atlantic,
America/Anguilla, America/Antigua, America/Aruba, America/
Asuncion, America/Barbados, America/Blanc-Sablon, America/
Boa_Vista, America/Campo_Grande, America/Caracas, America/
Cuiaba, America/Curacao, America/Detroit, America/Dominica,
America/Grand_Turk, America/Grenada, America/Guadeloupe,
America/Guyana, America/Havana, America/Indiana/Indianapolis,
America/Indiana/Marengo, America/Indiana/Petersburg, America/
Indiana/Vevay, America/Indiana/Vincennes, America/Indiana/
Winamac, America/Iqaluit, America/Kentucky/Louisville,
America/Kentucky/Monticello, America/Kralendijk, America/
La_Paz, America/Lower_Princes, America/Manaus, America/
Marigot, America/Martinique, America/Montserrat, America/
Nassau, America/New_York, America/Nipigon, America/
Pangnirtung, America/Port-au-Prince, America/Port_of_Spain,
America/Porto_Velho, America/Puerto_Rico, America/
Santo_Domingo, America/St_Barthelemy, America/St_Kitts,
America/St_Lucia, America/St_Thomas, America/St_Vincent,
America/Thunder_Bay, America/Toronto, America/Tortola,
Canada/Eastern, US/Eastern, America/Atikokan, America/
Bahia_Banderas, America/Bogota, America/Cancun, America/

328 of 352
 Cayman, America/Chicago, America/Eirunepe, America/Guayaquil,
America/Indiana/Knox, America/Indiana/Tell_City, America/
Jamaica, America/Lima, America/Matamoros, America/Menominee,
America/Merida, America/Mexico_City, America/Monterrey,
America/North_Dakota/Beulah, America/North_Dakota/Center,
America/North_Dakota/New_Salem, America/Panama, America/
Rainy_River, America/Rankin_Inlet, America/Resolute, America/
Rio_Branco, America/Winnipeg, Canada/Central, Pacific/Easter,
US/Central, America/Belize, America/Boise, America/
Cambridge_Bay, America/Chihuahua, America/Costa_Rica,
America/Denver, America/Edmonton, America/El_Salvador,
America/Guatemala, America/Inuvik, America/Managua, America/
Mazatlan, America/Ojinaga, America/Regina, America/
Swift_Current, America/Tegucigalpa, America/Yellowknife,
Canada/Mountain, Pacific/Galapagos, US/Mountain, America/
Creston, America/Dawson, America/Dawson_Creek, America/
Fort_Nelson, America/Hermosillo, America/Los_Angeles,
America/Phoenix, America/Tijuana, America/Vancouver, America/
Whitehorse, Canada/Pacific, US/Arizona, US/Pacific, America/
Anchorage, America/Juneau, America/Metlakatla, America/Nome,
America/Sitka, America/Yakutat, Pacific/Pitcairn, US/Alaska,
America/Adak, Pacific/Gambier, Pacific/Marquesas, Pacific/
Honolulu, Pacific/Rarotonga, Pacific/Tahiti, US/Hawaii,
Pacific/Midway, Pacific/Niue, Pacific/Pago_Pago
Timezone
display_am_pm boolean Display mode AM/PM
picture string min:1 chars
default_location {
Default location (e.g. {"country": "France", "city": "Nantes"...})

}
profile_generic_properties* [{
Array of object:

name* string min:1 chars

value* string min:1 chars
type* string min:1 chars
}]
}

STATUS CODE - 400: Invalid parameters.

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

27.7 PUT /users/profile/

Set current profile data.

Set user profile data.

To use this end-point, you have to be cloud-user.

REQUEST
REQUEST BODY - application/json
{
location string Location value (e.g. SharingCloud/France)

329 of 352
language enum ALLOWED:de, en-gb, en, es, fr, it, pt, ru, zh-hans, zh-hant, ja
Language
timezone enum ALLOWED:Africa/Abidjan,
Africa/Accra, Africa/Bamako, Africa/
Banjul, Africa/Bissau, Africa/Conakry, Africa/Dakar, Africa/
Freetown, Africa/Lome, Africa/Monrovia, Africa/Nouakchott,
Africa/Ouagadougou, Africa/Sao_Tome, America/Danmarkshavn,
America/Scoresbysund, Atlantic/Azores, Atlantic/Reykjavik,
Atlantic/St_Helena, GMT, UTC, Africa/Algiers, Africa/Bangui,
Africa/Brazzaville, Africa/Casablanca, Africa/Douala, Africa/
El_Aaiun, Africa/Kinshasa, Africa/Lagos, Africa/Libreville,
Africa/Luanda, Africa/Malabo, Africa/Ndjamena, Africa/Niamey,
Africa/Porto-Novo, Africa/Tunis, Atlantic/Canary, Atlantic/
Faroe, Atlantic/Madeira, Europe/Dublin, Europe/Guernsey,
Europe/Isle_of_Man, Europe/Jersey, Europe/Lisbon, Europe/
London, Africa/Blantyre, Africa/Bujumbura, Africa/Cairo,
Africa/Ceuta, Africa/Gaborone, Africa/Harare, Africa/
Johannesburg, Africa/Juba, Africa/Khartoum, Africa/Kigali,
Africa/Lubumbashi, Africa/Lusaka, Africa/Maputo, Africa/Maseru,
Africa/Mbabane, Africa/Tripoli, Africa/Windhoek, Antarctica/
Troll, Arctic/Longyearbyen, Europe/Amsterdam, Europe/Andorra,
Europe/Belgrade, Europe/Berlin, Europe/Bratislava, Europe/
Brussels, Europe/Budapest, Europe/Busingen, Europe/Copenhagen,
Europe/Gibraltar, Europe/Kaliningrad, Europe/Ljubljana, Europe/
Luxembourg, Europe/Madrid, Europe/Malta, Europe/Monaco, Europe/
Oslo, Europe/Paris, Europe/Podgorica, Europe/Prague, Europe/
Rome, Europe/San_Marino, Europe/Sarajevo, Europe/Skopje,
Europe/Stockholm, Europe/Tirane, Europe/Vaduz, Europe/Vatican,
Europe/Vienna, Europe/Warsaw, Europe/Zagreb, Europe/Zurich,
Africa/Addis_Ababa, Africa/Asmara, Africa/Dar_es_Salaam,
Africa/Djibouti, Africa/Kampala, Africa/Mogadishu, Africa/
Nairobi, Antarctica/Syowa, Asia/Aden, Asia/Amman, Asia/Baghdad,
Asia/Bahrain, Asia/Beirut, Asia/Damascus, Asia/Famagusta, Asia/
Gaza, Asia/Hebron, Asia/Jerusalem, Asia/Kuwait, Asia/Nicosia,
Asia/Qatar, Asia/Riyadh, Europe/Athens, Europe/Bucharest,
Europe/Chisinau, Europe/Helsinki, Europe/Istanbul, Europe/Kiev,
Europe/Kirov, Europe/Mariehamn, Europe/Minsk, Europe/Moscow,
Europe/Riga, Europe/Simferopol, Europe/Sofia, Europe/Tallinn,
Europe/Uzhgorod, Europe/Vilnius, Europe/Volgograd, Europe/
Zaporozhye, Indian/Antananarivo, Indian/Comoro, Indian/Mayotte,
Asia/Baku, Asia/Dubai, Asia/Muscat, Asia/Tbilisi, Asia/Yerevan,
Europe/Astrakhan, Europe/Samara, Europe/Saratov, Europe/
Ulyanovsk, Indian/Mahe, Indian/Mauritius, Indian/Reunion, Asia/
Kabul, Asia/Tehran, Antarctica/Mawson, Asia/Aqtau, Asia/Aqtobe,
Asia/Ashgabat, Asia/Atyrau, Asia/Dushanbe, Asia/Karachi, Asia/
Oral, Asia/Qyzylorda, Asia/Samarkand, Asia/Tashkent, Asia/
Yekaterinburg, Indian/Kerguelen, Indian/Maldives, Asia/Colombo,
Asia/Kolkata, Asia/Kathmandu, Antarctica/Vostok, Asia/Almaty,
Asia/Bishkek, Asia/Dhaka, Asia/Omsk, Asia/Qostanay, Asia/
Thimphu, Asia/Urumqi, Indian/Chagos, Asia/Yangon, Indian/Cocos,
Antarctica/Davis, Asia/Bangkok, Asia/Barnaul, Asia/Ho_Chi_Minh,
Asia/Hovd, Asia/Jakarta, Asia/Krasnoyarsk, Asia/Novokuznetsk,
Asia/Novosibirsk, Asia/Phnom_Penh, Asia/Pontianak, Asia/Tomsk,
Asia/Vientiane, Indian/Christmas, Asia/Brunei, Asia/Choibalsan,
Asia/Hong_Kong, Asia/Irkutsk, Asia/Kuala_Lumpur, Asia/Kuching,
Asia/Macau, Asia/Makassar, Asia/Manila, Asia/Shanghai, Asia/
Singapore, Asia/Taipei, Asia/Ulaanbaatar, Australia/Perth,
Australia/Eucla, Asia/Chita, Asia/Dili, Asia/Jayapura, Asia/

330 of 352
Khandyga, Asia/Pyongyang, Asia/Seoul, Asia/Tokyo, Asia/Yakutsk,
Pacific/Palau, Australia/Adelaide, Australia/Broken_Hill,
Australia/Darwin, Antarctica/DumontDUrville, Antarctica/
Macquarie, Asia/Ust-Nera, Asia/Vladivostok, Australia/Brisbane,
Australia/Hobart, Australia/Lindeman, Australia/Melbourne,
Australia/Sydney, Pacific/Chuuk, Pacific/Guam, Pacific/
Port_Moresby, Pacific/Saipan, Australia/Lord_Howe, Antarctica/
Casey, Asia/Magadan, Asia/Sakhalin, Asia/Srednekolymsk,
Pacific/Bougainville, Pacific/Efate, Pacific/Guadalcanal,
Pacific/Kosrae, Pacific/Norfolk, Pacific/Noumea, Pacific/
Pohnpei, Antarctica/McMurdo, Asia/Anadyr, Asia/Kamchatka,
Pacific/Auckland, Pacific/Fiji, Pacific/Funafuti, Pacific/
Kwajalein, Pacific/Majuro, Pacific/Nauru, Pacific/Tarawa,
Pacific/Wake, Pacific/Wallis, Pacific/Chatham, Pacific/Apia,
Pacific/Enderbury, Pacific/Fakaofo, Pacific/Tongatapu, Pacific/
Kiritimati, Atlantic/Cape_Verde, America/Miquelon, America/
Noronha, America/Nuuk, Atlantic/South_Georgia, America/
St_Johns, Canada/Newfoundland, America/Araguaina, America/
Argentina/Buenos_Aires, America/Argentina/Catamarca, America/
Argentina/Cordoba, America/Argentina/Jujuy, America/Argentina/
La_Rioja, America/Argentina/Mendoza, America/Argentina/
Rio_Gallegos, America/Argentina/Salta, America/Argentina/
San_Juan, America/Argentina/San_Luis, America/Argentina/
Tucuman, America/Argentina/Ushuaia, America/Bahia, America/
Belem, America/Cayenne, America/Fortaleza, America/Glace_Bay,
America/Goose_Bay, America/Halifax, America/Maceio, America/
Moncton, America/Montevideo, America/Paramaribo, America/
Punta_Arenas, America/Recife, America/Santarem, America/
Santiago, America/Sao_Paulo, America/Thule, Antarctica/Palmer,
Antarctica/Rothera, Atlantic/Bermuda, Atlantic/Stanley, Canada/
Atlantic, America/Anguilla, America/Antigua, America/Aruba,
America/Asuncion, America/Barbados, America/Blanc-Sablon,
America/Boa_Vista, America/Campo_Grande, America/Caracas,
America/Cuiaba, America/Curacao, America/Detroit, America/
Dominica, America/Grand_Turk, America/Grenada, America/
Guadeloupe, America/Guyana, America/Havana, America/Indiana/
Indianapolis, America/Indiana/Marengo, America/Indiana/
Petersburg, America/Indiana/Vevay, America/Indiana/Vincennes,
America/Indiana/Winamac, America/Iqaluit, America/Kentucky/
Louisville, America/Kentucky/Monticello, America/Kralendijk,
America/La_Paz, America/Lower_Princes, America/Manaus, America/
Marigot, America/Martinique, America/Montserrat, America/
Nassau, America/New_York, America/Nipigon, America/Pangnirtung,
America/Port-au-Prince, America/Port_of_Spain, America/
Porto_Velho, America/Puerto_Rico, America/Santo_Domingo,
America/St_Barthelemy, America/St_Kitts, America/St_Lucia,
America/St_Thomas, America/St_Vincent, America/Thunder_Bay,
America/Toronto, America/Tortola, Canada/Eastern, US/Eastern,
America/Atikokan, America/Bahia_Banderas, America/Bogota,
America/Cancun, America/Cayman, America/Chicago, America/
Eirunepe, America/Guayaquil, America/Indiana/Knox, America/
Indiana/Tell_City, America/Jamaica, America/Lima, America/
Matamoros, America/Menominee, America/Merida, America/
Mexico_City, America/Monterrey, America/North_Dakota/Beulah,
America/North_Dakota/Center, America/North_Dakota/New_Salem,
America/Panama, America/Rainy_River, America/Rankin_Inlet,
America/Resolute, America/Rio_Branco, America/Winnipeg, Canada/

331 of 352
 Central, Pacific/Easter, US/Central, America/Belize, America/
Boise, America/Cambridge_Bay, America/Chihuahua, America/
Costa_Rica, America/Denver, America/Edmonton, America/
El_Salvador, America/Guatemala, America/Inuvik, America/
Managua, America/Mazatlan, America/Ojinaga, America/Regina,
America/Swift_Current, America/Tegucigalpa, America/
Yellowknife, Canada/Mountain, Pacific/Galapagos, US/Mountain,
America/Creston, America/Dawson, America/Dawson_Creek, America/
Fort_Nelson, America/Hermosillo, America/Los_Angeles, America/
Phoenix, America/Tijuana, America/Vancouver, America/
Whitehorse, Canada/Pacific, US/Arizona, US/Pacific, America/
Anchorage, America/Juneau, America/Metlakatla, America/Nome,
America/Sitka, America/Yakutat, Pacific/Pitcairn, US/Alaska,
America/Adak, Pacific/Gambier, Pacific/Marquesas, Pacific/
Honolulu, Pacific/Rarotonga, Pacific/Tahiti, US/Hawaii,
Pacific/Midway, Pacific/Niue, Pacific/Pago_Pago
Timezone
display_am_pm boolean Display mode AM/PM
picture string min:1 chars
default_location {
Default location (e.g. {"country": "France", "city": "Nantes"...})

}
}

RESPONSE

STATUS CODE - 200:

RESPONSE MODEL - application/json

{
location string Location value (e.g. SharingCloud/France)
language enum ALLOWED:de, en-gb, en, es, fr, it, pt, ru, zh-hans, zh-hant,
ja
Language
timezone enum ALLOWED:Africa/Abidjan,
Africa/Accra, Africa/Bamako, Africa/
Banjul, Africa/Bissau, Africa/Conakry, Africa/Dakar, Africa/
Freetown, Africa/Lome, Africa/Monrovia, Africa/Nouakchott,
Africa/Ouagadougou, Africa/Sao_Tome, America/Danmarkshavn,
America/Scoresbysund, Atlantic/Azores, Atlantic/Reykjavik,
Atlantic/St_Helena, GMT, UTC, Africa/Algiers, Africa/Bangui,
Africa/Brazzaville, Africa/Casablanca, Africa/Douala,
Africa/El_Aaiun, Africa/Kinshasa, Africa/Lagos, Africa/
Libreville, Africa/Luanda, Africa/Malabo, Africa/Ndjamena,
Africa/Niamey, Africa/Porto-Novo, Africa/Tunis, Atlantic/
Canary, Atlantic/Faroe, Atlantic/Madeira, Europe/Dublin,
Europe/Guernsey, Europe/Isle_of_Man, Europe/Jersey, Europe/
Lisbon, Europe/London, Africa/Blantyre, Africa/Bujumbura,
Africa/Cairo, Africa/Ceuta, Africa/Gaborone, Africa/Harare,
Africa/Johannesburg, Africa/Juba, Africa/Khartoum, Africa/
Kigali, Africa/Lubumbashi, Africa/Lusaka, Africa/Maputo,
Africa/Maseru, Africa/Mbabane, Africa/Tripoli, Africa/
Windhoek, Antarctica/Troll, Arctic/Longyearbyen, Europe/
Amsterdam, Europe/Andorra, Europe/Belgrade, Europe/Berlin,
Europe/Bratislava, Europe/Brussels, Europe/Budapest, Europe/
Busingen, Europe/Copenhagen, Europe/Gibraltar, Europe/
Kaliningrad, Europe/Ljubljana, Europe/Luxembourg, Europe/
Madrid, Europe/Malta, Europe/Monaco, Europe/Oslo, Europe/
Paris, Europe/Podgorica, Europe/Prague, Europe/Rome, Europe/

332 of 352
San_Marino, Europe/Sarajevo, Europe/Skopje, Europe/
Stockholm, Europe/Tirane, Europe/Vaduz, Europe/Vatican,
Europe/Vienna, Europe/Warsaw, Europe/Zagreb, Europe/Zurich,
Africa/Addis_Ababa, Africa/Asmara, Africa/Dar_es_Salaam,
Africa/Djibouti, Africa/Kampala, Africa/Mogadishu, Africa/
Nairobi, Antarctica/Syowa, Asia/Aden, Asia/Amman, Asia/
Baghdad, Asia/Bahrain, Asia/Beirut, Asia/Damascus, Asia/
Famagusta, Asia/Gaza, Asia/Hebron, Asia/Jerusalem, Asia/
Kuwait, Asia/Nicosia, Asia/Qatar, Asia/Riyadh, Europe/
Athens, Europe/Bucharest, Europe/Chisinau, Europe/Helsinki,
Europe/Istanbul, Europe/Kiev, Europe/Kirov, Europe/
Mariehamn, Europe/Minsk, Europe/Moscow, Europe/Riga, Europe/
Simferopol, Europe/Sofia, Europe/Tallinn, Europe/Uzhgorod,
Europe/Vilnius, Europe/Volgograd, Europe/Zaporozhye, Indian/
Antananarivo, Indian/Comoro, Indian/Mayotte, Asia/Baku,
Asia/Dubai, Asia/Muscat, Asia/Tbilisi, Asia/Yerevan, Europe/
Astrakhan, Europe/Samara, Europe/Saratov, Europe/Ulyanovsk,
Indian/Mahe, Indian/Mauritius, Indian/Reunion, Asia/Kabul,
Asia/Tehran, Antarctica/Mawson, Asia/Aqtau, Asia/Aqtobe,
Asia/Ashgabat, Asia/Atyrau, Asia/Dushanbe, Asia/Karachi,
Asia/Oral, Asia/Qyzylorda, Asia/Samarkand, Asia/Tashkent,
Asia/Yekaterinburg, Indian/Kerguelen, Indian/Maldives, Asia/
Colombo, Asia/Kolkata, Asia/Kathmandu, Antarctica/Vostok,
Asia/Almaty, Asia/Bishkek, Asia/Dhaka, Asia/Omsk, Asia/
Qostanay, Asia/Thimphu, Asia/Urumqi, Indian/Chagos, Asia/
Yangon, Indian/Cocos, Antarctica/Davis, Asia/Bangkok, Asia/
Barnaul, Asia/Ho_Chi_Minh, Asia/Hovd, Asia/Jakarta, Asia/
Krasnoyarsk, Asia/Novokuznetsk, Asia/Novosibirsk, Asia/
Phnom_Penh, Asia/Pontianak, Asia/Tomsk, Asia/Vientiane,
Indian/Christmas, Asia/Brunei, Asia/Choibalsan, Asia/
Hong_Kong, Asia/Irkutsk, Asia/Kuala_Lumpur, Asia/Kuching,
Asia/Macau, Asia/Makassar, Asia/Manila, Asia/Shanghai, Asia/
Singapore, Asia/Taipei, Asia/Ulaanbaatar, Australia/Perth,
Australia/Eucla, Asia/Chita, Asia/Dili, Asia/Jayapura, Asia/
Khandyga, Asia/Pyongyang, Asia/Seoul, Asia/Tokyo, Asia/
Yakutsk, Pacific/Palau, Australia/Adelaide, Australia/
Broken_Hill, Australia/Darwin, Antarctica/DumontDUrville,
Antarctica/Macquarie, Asia/Ust-Nera, Asia/Vladivostok,
Australia/Brisbane, Australia/Hobart, Australia/Lindeman,
Australia/Melbourne, Australia/Sydney, Pacific/Chuuk,
Pacific/Guam, Pacific/Port_Moresby, Pacific/Saipan,
Australia/Lord_Howe, Antarctica/Casey, Asia/Magadan, Asia/
Sakhalin, Asia/Srednekolymsk, Pacific/Bougainville, Pacific/
Efate, Pacific/Guadalcanal, Pacific/Kosrae, Pacific/Norfolk,
Pacific/Noumea, Pacific/Pohnpei, Antarctica/McMurdo, Asia/
Anadyr, Asia/Kamchatka, Pacific/Auckland, Pacific/Fiji,
Pacific/Funafuti, Pacific/Kwajalein, Pacific/Majuro,
Pacific/Nauru, Pacific/Tarawa, Pacific/Wake, Pacific/Wallis,
Pacific/Chatham, Pacific/Apia, Pacific/Enderbury, Pacific/
Fakaofo, Pacific/Tongatapu, Pacific/Kiritimati, Atlantic/
Cape_Verde, America/Miquelon, America/Noronha, America/Nuuk,
Atlantic/South_Georgia, America/St_Johns, Canada/
Newfoundland, America/Araguaina, America/Argentina/
Buenos_Aires, America/Argentina/Catamarca, America/
Argentina/Cordoba, America/Argentina/Jujuy, America/
Argentina/La_Rioja, America/Argentina/Mendoza, America/
Argentina/Rio_Gallegos, America/Argentina/Salta, America/

333 of 352
 Argentina/San_Juan, America/Argentina/San_Luis, America/
Argentina/Tucuman, America/Argentina/Ushuaia, America/Bahia,
America/Belem, America/Cayenne, America/Fortaleza, America/
Glace_Bay, America/Goose_Bay, America/Halifax, America/
Maceio, America/Moncton, America/Montevideo, America/
Paramaribo, America/Punta_Arenas, America/Recife, America/
Santarem, America/Santiago, America/Sao_Paulo, America/
Thule, Antarctica/Palmer, Antarctica/Rothera, Atlantic/
Bermuda, Atlantic/Stanley, Canada/Atlantic, America/
Anguilla, America/Antigua, America/Aruba, America/Asuncion,
America/Barbados, America/Blanc-Sablon, America/Boa_Vista,
America/Campo_Grande, America/Caracas, America/Cuiaba,
America/Curacao, America/Detroit, America/Dominica, America/
Grand_Turk, America/Grenada, America/Guadeloupe, America/
Guyana, America/Havana, America/Indiana/Indianapolis,
America/Indiana/Marengo, America/Indiana/Petersburg,
America/Indiana/Vevay, America/Indiana/Vincennes, America/
Indiana/Winamac, America/Iqaluit, America/Kentucky/
Louisville, America/Kentucky/Monticello, America/Kralendijk,
America/La_Paz, America/Lower_Princes, America/Manaus,
America/Marigot, America/Martinique, America/Montserrat,
America/Nassau, America/New_York, America/Nipigon, America/
Pangnirtung, America/Port-au-Prince, America/Port_of_Spain,
America/Porto_Velho, America/Puerto_Rico, America/
Santo_Domingo, America/St_Barthelemy, America/St_Kitts,
America/St_Lucia, America/St_Thomas, America/St_Vincent,
America/Thunder_Bay, America/Toronto, America/Tortola,
Canada/Eastern, US/Eastern, America/Atikokan, America/
Bahia_Banderas, America/Bogota, America/Cancun, America/
Cayman, America/Chicago, America/Eirunepe, America/
Guayaquil, America/Indiana/Knox, America/Indiana/Tell_City,
America/Jamaica, America/Lima, America/Matamoros, America/
Menominee, America/Merida, America/Mexico_City, America/
Monterrey, America/North_Dakota/Beulah, America/
North_Dakota/Center, America/North_Dakota/New_Salem,
America/Panama, America/Rainy_River, America/Rankin_Inlet,
America/Resolute, America/Rio_Branco, America/Winnipeg,
Canada/Central, Pacific/Easter, US/Central, America/Belize,
America/Boise, America/Cambridge_Bay, America/Chihuahua,
America/Costa_Rica, America/Denver, America/Edmonton,
America/El_Salvador, America/Guatemala, America/Inuvik,
America/Managua, America/Mazatlan, America/Ojinaga, America/
Regina, America/Swift_Current, America/Tegucigalpa, America/
Yellowknife, Canada/Mountain, Pacific/Galapagos, US/
Mountain, America/Creston, America/Dawson, America/
Dawson_Creek, America/Fort_Nelson, America/Hermosillo,
America/Los_Angeles, America/Phoenix, America/Tijuana,
America/Vancouver, America/Whitehorse, Canada/Pacific, US/
Arizona, US/Pacific, America/Anchorage, America/Juneau,
America/Metlakatla, America/Nome, America/Sitka, America/
Yakutat, Pacific/Pitcairn, US/Alaska, America/Adak, Pacific/
Gambier, Pacific/Marquesas, Pacific/Honolulu, Pacific/
Rarotonga, Pacific/Tahiti, US/Hawaii, Pacific/Midway,
Pacific/Niue, Pacific/Pago_Pago
Timezone
display_am_pm boolean Display mode AM/PM
picture string min:1 chars

334 of 352
 default_location {
Default location (e.g. {"country": "France", "city": "Nantes"...})

}
}

STATUS CODE - 400: Invalid parameters.

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

27.8 GET /users/search-users/

Retrieves users from the input string

Retrieves users from the input string within the current cloud and a specified app

List of UUIDsorExact First Name & Last NameorStartsWith emailorStartsWith last nameorStartsWith
first name

You have to be at least CLOUD_USER

REQUEST
QUERY PARAMETERS
NAME TYPE DESCRIPTION

page integer A page number within the paginated result set.

page_size integer Number of results to return per page.
*query string Filter users on first_name or last_name or email address (or uuids if
min:2 chars specified)
*app enum 0 : RSE
ALLOWED: 0, 1, 2, 3, 4, 1 : INSTANT_TV
5 2 : INSTANT_BOOKING
3 : INSTANT_SIGNAGE
4 : INSTANT_METRICS
5 : INSTANT_DEVICE_MANAGER
query_uuids boolean Enable searching users by a list of UUIDs, separated by commas ( , )

RESPONSE

STATUS CODE - 200:

RESPONSE MODEL - application/json

{
pagination* {
total_results integer
results_per_page integer
total_pages integer
current_page integer
previous_page integer
next_page integer
}
results* [{
Array of object:

335 of 352
 first_name string max:150 chars
last_name string max:150 chars
email string max:254 chars
full_name* string min:1 chars
uuid string READ-ONLY
}]
}

STATUS CODE - 400: Invalid parameters.

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

27.9 GET /users/search/

Retrieves all users

Retrieves all users from the user's cloud and all clouds where the request user is an cloud admin

REQUEST
QUERY PARAMETERS
NAME TYPE DESCRIPTION

page integer A page number within the paginated result set.

page_size integer Number of results to return per page.

RESPONSE

STATUS CODE - 200:

RESPONSE MODEL - application/json

[{
Array of object:

query* string min:1 chars

Filter user on first_name or last_name or email address or username or uuid
}]

STATUS CODE - 400: Invalid parameters.

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

27.10 GET /users/wide_search/

Retrieves a specified user

Retrieves a specified from the user's cloudand all clouds where the user is an cloud admin

REQUEST
QUERY PARAMETERS
NAME TYPE DESCRIPTION

336 of 352
 NAME TYPE DESCRIPTION

*query string Filter user on first_name or last_name or email address or username or uuid
min:1 chars

RESPONSE

STATUS CODE - 200:

RESPONSE MODEL - application/json

{
id integer READ-ONLY
first_name string max:150 chars
last_name string max:150 chars
email string max:254 chars
username* string 1 to 150 chars
PATTERN:^[\w.@+-]+$
Required. 150 characters or fewer. Letters, digits and
@/./+/-/_ only.
full_name* string min:1 chars
account_type string READ-ONLY
standard, service_with_impersonation,
service_without_impersonation, device
uuid string READ-ONLY
clouds string READ-ONLY
cloud_space_right {
instant_social* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_tv* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_booking* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_signage* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_metrics* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_device_manager* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
}
profile {
favorite_language enum ALLOWED:de, en-devel, en-gb, en, es, fr, it, no, pl, pt,
ro, tr, ru, zh-hans, zh-hant, ja
timezone enum ALLOWED:Africa/Abidjan, Africa/Accra, Africa/Bamako,
Africa/Banjul, Africa/Bissau, Africa/Conakry, Africa/
Dakar, Africa/Freetown, Africa/Lome, Africa/Monrovia,
Africa/Nouakchott, Africa/Ouagadougou, Africa/Sao_Tome,
America/Danmarkshavn, America/Scoresbysund, Atlantic/
Azores, Atlantic/Reykjavik, Atlantic/St_Helena, GMT,
UTC, Africa/Algiers, Africa/Bangui, Africa/Brazzaville,
Africa/Casablanca, Africa/Douala, Africa/El_Aaiun,
Africa/Kinshasa, Africa/Lagos, Africa/Libreville,
Africa/Luanda, Africa/Malabo, Africa/Ndjamena, Africa/

337 of 352
Niamey, Africa/Porto-Novo, Africa/Tunis, Atlantic/
Canary, Atlantic/Faroe, Atlantic/Madeira, Europe/
Dublin, Europe/Guernsey, Europe/Isle_of_Man, Europe/
Jersey, Europe/Lisbon, Europe/London, Africa/Blantyre,
Africa/Bujumbura, Africa/Cairo, Africa/Ceuta, Africa/
Gaborone, Africa/Harare, Africa/Johannesburg, Africa/
Juba, Africa/Khartoum, Africa/Kigali, Africa/
Lubumbashi, Africa/Lusaka, Africa/Maputo, Africa/
Maseru, Africa/Mbabane, Africa/Tripoli, Africa/
Windhoek, Antarctica/Troll, Arctic/Longyearbyen,
Europe/Amsterdam, Europe/Andorra, Europe/Belgrade,
Europe/Berlin, Europe/Bratislava, Europe/Brussels,
Europe/Budapest, Europe/Busingen, Europe/Copenhagen,
Europe/Gibraltar, Europe/Kaliningrad, Europe/Ljubljana,
Europe/Luxembourg, Europe/Madrid, Europe/Malta, Europe/
Monaco, Europe/Oslo, Europe/Paris, Europe/Podgorica,
Europe/Prague, Europe/Rome, Europe/San_Marino, Europe/
Sarajevo, Europe/Skopje, Europe/Stockholm, Europe/
Tirane, Europe/Vaduz, Europe/Vatican, Europe/Vienna,
Europe/Warsaw, Europe/Zagreb, Europe/Zurich, Africa/
Addis_Ababa, Africa/Asmara, Africa/Dar_es_Salaam,
Africa/Djibouti, Africa/Kampala, Africa/Mogadishu,
Africa/Nairobi, Antarctica/Syowa, Asia/Aden, Asia/
Amman, Asia/Baghdad, Asia/Bahrain, Asia/Beirut, Asia/
Damascus, Asia/Famagusta, Asia/Gaza, Asia/Hebron, Asia/
Jerusalem, Asia/Kuwait, Asia/Nicosia, Asia/Qatar, Asia/
Riyadh, Europe/Athens, Europe/Bucharest, Europe/
Chisinau, Europe/Helsinki, Europe/Istanbul, Europe/
Kiev, Europe/Kirov, Europe/Mariehamn, Europe/Minsk,
Europe/Moscow, Europe/Riga, Europe/Simferopol, Europe/
Sofia, Europe/Tallinn, Europe/Uzhgorod, Europe/Vilnius,
Europe/Volgograd, Europe/Zaporozhye, Indian/
Antananarivo, Indian/Comoro, Indian/Mayotte, Asia/Baku,
Asia/Dubai, Asia/Muscat, Asia/Tbilisi, Asia/Yerevan,
Europe/Astrakhan, Europe/Samara, Europe/Saratov,
Europe/Ulyanovsk, Indian/Mahe, Indian/Mauritius,
Indian/Reunion, Asia/Kabul, Asia/Tehran, Antarctica/
Mawson, Asia/Aqtau, Asia/Aqtobe, Asia/Ashgabat, Asia/
Atyrau, Asia/Dushanbe, Asia/Karachi, Asia/Oral, Asia/
Qyzylorda, Asia/Samarkand, Asia/Tashkent, Asia/
Yekaterinburg, Indian/Kerguelen, Indian/Maldives, Asia/
Colombo, Asia/Kolkata, Asia/Kathmandu, Antarctica/
Vostok, Asia/Almaty, Asia/Bishkek, Asia/Dhaka, Asia/
Omsk, Asia/Qostanay, Asia/Thimphu, Asia/Urumqi, Indian/
Chagos, Asia/Yangon, Indian/Cocos, Antarctica/Davis,
Asia/Bangkok, Asia/Barnaul, Asia/Ho_Chi_Minh, Asia/
Hovd, Asia/Jakarta, Asia/Krasnoyarsk, Asia/
Novokuznetsk, Asia/Novosibirsk, Asia/Phnom_Penh, Asia/
Pontianak, Asia/Tomsk, Asia/Vientiane, Indian/
Christmas, Asia/Brunei, Asia/Choibalsan, Asia/
Hong_Kong, Asia/Irkutsk, Asia/Kuala_Lumpur, Asia/
Kuching, Asia/Macau, Asia/Makassar, Asia/Manila, Asia/
Shanghai, Asia/Singapore, Asia/Taipei, Asia/
Ulaanbaatar, Australia/Perth, Australia/Eucla, Asia/
Chita, Asia/Dili, Asia/Jayapura, Asia/Khandyga, Asia/
Pyongyang, Asia/Seoul, Asia/Tokyo, Asia/Yakutsk,
Pacific/Palau, Australia/Adelaide, Australia/

338 of 352
Broken_Hill, Australia/Darwin, Antarctica/
DumontDUrville, Antarctica/Macquarie, Asia/Ust-Nera,
Asia/Vladivostok, Australia/Brisbane, Australia/Hobart,
Australia/Lindeman, Australia/Melbourne, Australia/
Sydney, Pacific/Chuuk, Pacific/Guam, Pacific/
Port_Moresby, Pacific/Saipan, Australia/Lord_Howe,
Antarctica/Casey, Asia/Magadan, Asia/Sakhalin, Asia/
Srednekolymsk, Pacific/Bougainville, Pacific/Efate,
Pacific/Guadalcanal, Pacific/Kosrae, Pacific/Norfolk,
Pacific/Noumea, Pacific/Pohnpei, Antarctica/McMurdo,
Asia/Anadyr, Asia/Kamchatka, Pacific/Auckland, Pacific/
Fiji, Pacific/Funafuti, Pacific/Kwajalein, Pacific/
Majuro, Pacific/Nauru, Pacific/Tarawa, Pacific/Wake,
Pacific/Wallis, Pacific/Chatham, Pacific/Apia, Pacific/
Enderbury, Pacific/Fakaofo, Pacific/Tongatapu, Pacific/
Kiritimati, Atlantic/Cape_Verde, America/Miquelon,
America/Noronha, America/Nuuk, Atlantic/South_Georgia,
America/St_Johns, Canada/Newfoundland, America/
Araguaina, America/Argentina/Buenos_Aires, America/
Argentina/Catamarca, America/Argentina/Cordoba,
America/Argentina/Jujuy, America/Argentina/La_Rioja,
America/Argentina/Mendoza, America/Argentina/
Rio_Gallegos, America/Argentina/Salta, America/
Argentina/San_Juan, America/Argentina/San_Luis,
America/Argentina/Tucuman, America/Argentina/Ushuaia,
America/Bahia, America/Belem, America/Cayenne, America/
Fortaleza, America/Glace_Bay, America/Goose_Bay,
America/Halifax, America/Maceio, America/Moncton,
America/Montevideo, America/Paramaribo, America/
Punta_Arenas, America/Recife, America/Santarem,
America/Santiago, America/Sao_Paulo, America/Thule,
Antarctica/Palmer, Antarctica/Rothera, Atlantic/
Bermuda, Atlantic/Stanley, Canada/Atlantic, America/
Anguilla, America/Antigua, America/Aruba, America/
Asuncion, America/Barbados, America/Blanc-Sablon,
America/Boa_Vista, America/Campo_Grande, America/
Caracas, America/Cuiaba, America/Curacao, America/
Detroit, America/Dominica, America/Grand_Turk, America/
Grenada, America/Guadeloupe, America/Guyana, America/
Havana, America/Indiana/Indianapolis, America/Indiana/
Marengo, America/Indiana/Petersburg, America/Indiana/
Vevay, America/Indiana/Vincennes, America/Indiana/
Winamac, America/Iqaluit, America/Kentucky/Louisville,
America/Kentucky/Monticello, America/Kralendijk,
America/La_Paz, America/Lower_Princes, America/Manaus,
America/Marigot, America/Martinique, America/
Montserrat, America/Nassau, America/New_York, America/
Nipigon, America/Pangnirtung, America/Port-au-Prince,
America/Port_of_Spain, America/Porto_Velho, America/
Puerto_Rico, America/Santo_Domingo, America/
St_Barthelemy, America/St_Kitts, America/St_Lucia,
America/St_Thomas, America/St_Vincent, America/
Thunder_Bay, America/Toronto, America/Tortola, Canada/
Eastern, US/Eastern, America/Atikokan, America/
Bahia_Banderas, America/Bogota, America/Cancun,
America/Cayman, America/Chicago, America/Eirunepe,
America/Guayaquil, America/Indiana/Knox, America/

339 of 352
 Indiana/Tell_City, America/Jamaica, America/Lima,
America/Matamoros, America/Menominee, America/Merida,
America/Mexico_City, America/Monterrey, America/
North_Dakota/Beulah, America/North_Dakota/Center,
America/North_Dakota/New_Salem, America/Panama,
America/Rainy_River, America/Rankin_Inlet, America/
Resolute, America/Rio_Branco, America/Winnipeg, Canada/
Central, Pacific/Easter, US/Central, America/Belize,
America/Boise, America/Cambridge_Bay, America/
Chihuahua, America/Costa_Rica, America/Denver, America/
Edmonton, America/El_Salvador, America/Guatemala,
America/Inuvik, America/Managua, America/Mazatlan,
America/Ojinaga, America/Regina, America/Swift_Current,
America/Tegucigalpa, America/Yellowknife, Canada/
Mountain, Pacific/Galapagos, US/Mountain, America/
Creston, America/Dawson, America/Dawson_Creek, America/
Fort_Nelson, America/Hermosillo, America/Los_Angeles,
America/Phoenix, America/Tijuana, America/Vancouver,
America/Whitehorse, Canada/Pacific, US/Arizona, US/
Pacific, America/Anchorage, America/Juneau, America/
Metlakatla, America/Nome, America/Sitka, America/
Yakutat, Pacific/Pitcairn, US/Alaska, America/Adak,
Pacific/Gambier, Pacific/Marquesas, Pacific/Honolulu,
Pacific/Rarotonga, Pacific/Tahiti, US/Hawaii, Pacific/
Midway, Pacific/Niue, Pacific/Pago_Pago
display_am_pm enum ALLOWED:true, false
picture string READ-ONLY
Profile picture URI
default_location {
}
location string READ-ONLY
}
}

STATUS CODE - 400: Invalid parameters.

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

STATUS CODE - 404: User not found

27.11 PUT /users/{id}/profile-generic-properties/

Update a profile generic property for the given user.

Update a profile generic property for the given user.

To use this end-point, you have to be power-user and the property has to be updatable by
administrators.

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*id string A unique integer value identifying this user.

340 of 352
 REQUEST BODY - application/json
{
name* string min:1 chars
value* string min:1 chars
type* string min:1 chars
}

RESPONSE

STATUS CODE - 200:

RESPONSE MODEL - application/json

{
name* string min:1 chars
value* string min:1 chars
type* string min:1 chars
}

STATUS CODE - 400: Invalid parameters.

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

27.12 DELETE /users/{uuid}/delete/

Delete user by uuid

Delete the user if it is part of the cloud where the request user is administrator(if you want to select no
cloud_space, clear the list)

To use this end-point, you have to be cloud admin.

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*uuid string

REQUEST BODY - application/json

{
cloud_space [integer]
}

RESPONSE

STATUS CODE - 204: Success

STATUS CODE - 400: Invalid parameters.

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

STATUS CODE - 404: User not found

341 of 352
27.13 PUT /users/{uuid}/edit/

Update a given user

Update a given user'cloud_space' corresponds to an array of space cloud number where the user can
have rights,such as 2 (INSTANT BOOKING).

RSE = 0
INSTANT_TV = 1
INSTANT_BOOKING = 2
INSTANT_SIGNAGE = 3
INSTANT_METRICS = 4
INSTANT_DEVICE_MANAGER = 5

Warning :

If you clear the list 'cloud_space', then you disable account of user
If you don't fill in all the cloud spaces of the user where he has rights, THESE RIGHTS WILL BE
DELETED
If no rights is assigned to the user for one of the cloud spaces,the rights will automatically be
CLOUD_USER

To use this end-point, you have to be cloud admin

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*uuid string

REQUEST BODY - application/json

{
location string Location value (e.g. SharingCloud/France)
language enum ALLOWED:de, en-gb, en, es, fr, it, pt, ru, zh-hans, zh-hant, ja
Language
timezone enum ALLOWED:Africa/Abidjan,
Africa/Accra, Africa/Bamako, Africa/
Banjul, Africa/Bissau, Africa/Conakry, Africa/Dakar, Africa/
Freetown, Africa/Lome, Africa/Monrovia, Africa/Nouakchott,
Africa/Ouagadougou, Africa/Sao_Tome, America/Danmarkshavn,
America/Scoresbysund, Atlantic/Azores, Atlantic/Reykjavik,
Atlantic/St_Helena, GMT, UTC, Africa/Algiers, Africa/Bangui,
Africa/Brazzaville, Africa/Casablanca, Africa/Douala, Africa/
El_Aaiun, Africa/Kinshasa, Africa/Lagos, Africa/Libreville,
Africa/Luanda, Africa/Malabo, Africa/Ndjamena, Africa/Niamey,
Africa/Porto-Novo, Africa/Tunis, Atlantic/Canary, Atlantic/
Faroe, Atlantic/Madeira, Europe/Dublin, Europe/Guernsey,
Europe/Isle_of_Man, Europe/Jersey, Europe/Lisbon, Europe/
London, Africa/Blantyre, Africa/Bujumbura, Africa/Cairo,
Africa/Ceuta, Africa/Gaborone, Africa/Harare, Africa/
Johannesburg, Africa/Juba, Africa/Khartoum, Africa/Kigali,
Africa/Lubumbashi, Africa/Lusaka, Africa/Maputo, Africa/
Maseru, Africa/Mbabane, Africa/Tripoli, Africa/Windhoek,
Antarctica/Troll, Arctic/Longyearbyen, Europe/Amsterdam,
Europe/Andorra, Europe/Belgrade, Europe/Berlin, Europe/
Bratislava, Europe/Brussels, Europe/Budapest, Europe/

342 of 352
Busingen, Europe/Copenhagen, Europe/Gibraltar, Europe/
Kaliningrad, Europe/Ljubljana, Europe/Luxembourg, Europe/
Madrid, Europe/Malta, Europe/Monaco, Europe/Oslo, Europe/
Paris, Europe/Podgorica, Europe/Prague, Europe/Rome, Europe/
San_Marino, Europe/Sarajevo, Europe/Skopje, Europe/Stockholm,
Europe/Tirane, Europe/Vaduz, Europe/Vatican, Europe/Vienna,
Europe/Warsaw, Europe/Zagreb, Europe/Zurich, Africa/
Addis_Ababa, Africa/Asmara, Africa/Dar_es_Salaam, Africa/
Djibouti, Africa/Kampala, Africa/Mogadishu, Africa/Nairobi,
Antarctica/Syowa, Asia/Aden, Asia/Amman, Asia/Baghdad, Asia/
Bahrain, Asia/Beirut, Asia/Damascus, Asia/Famagusta, Asia/
Gaza, Asia/Hebron, Asia/Jerusalem, Asia/Kuwait, Asia/Nicosia,
Asia/Qatar, Asia/Riyadh, Europe/Athens, Europe/Bucharest,
Europe/Chisinau, Europe/Helsinki, Europe/Istanbul, Europe/
Kiev, Europe/Kirov, Europe/Mariehamn, Europe/Minsk, Europe/
Moscow, Europe/Riga, Europe/Simferopol, Europe/Sofia, Europe/
Tallinn, Europe/Uzhgorod, Europe/Vilnius, Europe/Volgograd,
Europe/Zaporozhye, Indian/Antananarivo, Indian/Comoro,
Indian/Mayotte, Asia/Baku, Asia/Dubai, Asia/Muscat, Asia/
Tbilisi, Asia/Yerevan, Europe/Astrakhan, Europe/Samara,
Europe/Saratov, Europe/Ulyanovsk, Indian/Mahe, Indian/
Mauritius, Indian/Reunion, Asia/Kabul, Asia/Tehran,
Antarctica/Mawson, Asia/Aqtau, Asia/Aqtobe, Asia/Ashgabat,
Asia/Atyrau, Asia/Dushanbe, Asia/Karachi, Asia/Oral, Asia/
Qyzylorda, Asia/Samarkand, Asia/Tashkent, Asia/Yekaterinburg,
Indian/Kerguelen, Indian/Maldives, Asia/Colombo, Asia/
Kolkata, Asia/Kathmandu, Antarctica/Vostok, Asia/Almaty,
Asia/Bishkek, Asia/Dhaka, Asia/Omsk, Asia/Qostanay, Asia/
Thimphu, Asia/Urumqi, Indian/Chagos, Asia/Yangon, Indian/
Cocos, Antarctica/Davis, Asia/Bangkok, Asia/Barnaul, Asia/
Ho_Chi_Minh, Asia/Hovd, Asia/Jakarta, Asia/Krasnoyarsk, Asia/
Novokuznetsk, Asia/Novosibirsk, Asia/Phnom_Penh, Asia/
Pontianak, Asia/Tomsk, Asia/Vientiane, Indian/Christmas,
Asia/Brunei, Asia/Choibalsan, Asia/Hong_Kong, Asia/Irkutsk,
Asia/Kuala_Lumpur, Asia/Kuching, Asia/Macau, Asia/Makassar,
Asia/Manila, Asia/Shanghai, Asia/Singapore, Asia/Taipei,
Asia/Ulaanbaatar, Australia/Perth, Australia/Eucla, Asia/
Chita, Asia/Dili, Asia/Jayapura, Asia/Khandyga, Asia/
Pyongyang, Asia/Seoul, Asia/Tokyo, Asia/Yakutsk, Pacific/
Palau, Australia/Adelaide, Australia/Broken_Hill, Australia/
Darwin, Antarctica/DumontDUrville, Antarctica/Macquarie,
Asia/Ust-Nera, Asia/Vladivostok, Australia/Brisbane,
Australia/Hobart, Australia/Lindeman, Australia/Melbourne,
Australia/Sydney, Pacific/Chuuk, Pacific/Guam, Pacific/
Port_Moresby, Pacific/Saipan, Australia/Lord_Howe,
Antarctica/Casey, Asia/Magadan, Asia/Sakhalin, Asia/
Srednekolymsk, Pacific/Bougainville, Pacific/Efate, Pacific/
Guadalcanal, Pacific/Kosrae, Pacific/Norfolk, Pacific/Noumea,
Pacific/Pohnpei, Antarctica/McMurdo, Asia/Anadyr, Asia/
Kamchatka, Pacific/Auckland, Pacific/Fiji, Pacific/Funafuti,
Pacific/Kwajalein, Pacific/Majuro, Pacific/Nauru, Pacific/
Tarawa, Pacific/Wake, Pacific/Wallis, Pacific/Chatham,
Pacific/Apia, Pacific/Enderbury, Pacific/Fakaofo, Pacific/
Tongatapu, Pacific/Kiritimati, Atlantic/Cape_Verde, America/
Miquelon, America/Noronha, America/Nuuk, Atlantic/
South_Georgia, America/St_Johns, Canada/Newfoundland,
America/Araguaina, America/Argentina/Buenos_Aires, America/

343 of 352
Argentina/Catamarca, America/Argentina/Cordoba, America/
Argentina/Jujuy, America/Argentina/La_Rioja, America/
Argentina/Mendoza, America/Argentina/Rio_Gallegos, America/
Argentina/Salta, America/Argentina/San_Juan, America/
Argentina/San_Luis, America/Argentina/Tucuman, America/
Argentina/Ushuaia, America/Bahia, America/Belem, America/
Cayenne, America/Fortaleza, America/Glace_Bay, America/
Goose_Bay, America/Halifax, America/Maceio, America/Moncton,
America/Montevideo, America/Paramaribo, America/Punta_Arenas,
America/Recife, America/Santarem, America/Santiago, America/
Sao_Paulo, America/Thule, Antarctica/Palmer, Antarctica/
Rothera, Atlantic/Bermuda, Atlantic/Stanley, Canada/Atlantic,
America/Anguilla, America/Antigua, America/Aruba, America/
Asuncion, America/Barbados, America/Blanc-Sablon, America/
Boa_Vista, America/Campo_Grande, America/Caracas, America/
Cuiaba, America/Curacao, America/Detroit, America/Dominica,
America/Grand_Turk, America/Grenada, America/Guadeloupe,
America/Guyana, America/Havana, America/Indiana/Indianapolis,
America/Indiana/Marengo, America/Indiana/Petersburg, America/
Indiana/Vevay, America/Indiana/Vincennes, America/Indiana/
Winamac, America/Iqaluit, America/Kentucky/Louisville,
America/Kentucky/Monticello, America/Kralendijk, America/
La_Paz, America/Lower_Princes, America/Manaus, America/
Marigot, America/Martinique, America/Montserrat, America/
Nassau, America/New_York, America/Nipigon, America/
Pangnirtung, America/Port-au-Prince, America/Port_of_Spain,
America/Porto_Velho, America/Puerto_Rico, America/
Santo_Domingo, America/St_Barthelemy, America/St_Kitts,
America/St_Lucia, America/St_Thomas, America/St_Vincent,
America/Thunder_Bay, America/Toronto, America/Tortola,
Canada/Eastern, US/Eastern, America/Atikokan, America/
Bahia_Banderas, America/Bogota, America/Cancun, America/
Cayman, America/Chicago, America/Eirunepe, America/Guayaquil,
America/Indiana/Knox, America/Indiana/Tell_City, America/
Jamaica, America/Lima, America/Matamoros, America/Menominee,
America/Merida, America/Mexico_City, America/Monterrey,
America/North_Dakota/Beulah, America/North_Dakota/Center,
America/North_Dakota/New_Salem, America/Panama, America/
Rainy_River, America/Rankin_Inlet, America/Resolute, America/
Rio_Branco, America/Winnipeg, Canada/Central, Pacific/Easter,
US/Central, America/Belize, America/Boise, America/
Cambridge_Bay, America/Chihuahua, America/Costa_Rica,
America/Denver, America/Edmonton, America/El_Salvador,
America/Guatemala, America/Inuvik, America/Managua, America/
Mazatlan, America/Ojinaga, America/Regina, America/
Swift_Current, America/Tegucigalpa, America/Yellowknife,
Canada/Mountain, Pacific/Galapagos, US/Mountain, America/
Creston, America/Dawson, America/Dawson_Creek, America/
Fort_Nelson, America/Hermosillo, America/Los_Angeles,
America/Phoenix, America/Tijuana, America/Vancouver, America/
Whitehorse, Canada/Pacific, US/Arizona, US/Pacific, America/
Anchorage, America/Juneau, America/Metlakatla, America/Nome,
America/Sitka, America/Yakutat, Pacific/Pitcairn, US/Alaska,
America/Adak, Pacific/Gambier, Pacific/Marquesas, Pacific/
Honolulu, Pacific/Rarotonga, Pacific/Tahiti, US/Hawaii,
Pacific/Midway, Pacific/Niue, Pacific/Pago_Pago
Timezone

344 of 352
 display_am_pm boolean Display mode AM/PM

picture string min:1 chars

default_location {
Default location (e.g. {"country": "France", "city": "Nantes"...})

}
cloud_space [integer]
first_name* string min:1 chars
first name
last_name* string min:1 chars
last_name
email* string min:1 chars
email
}

RESPONSE

STATUS CODE - 200:

RESPONSE MODEL - application/json

{
id integer READ-ONLY
uuid string READ-ONLY
first_name string max:150 chars
last_name string max:150 chars
email string max:254 chars
username* string 1 to 150 chars
PATTERN:^[\w.@+-]+$
Required. 150 characters or fewer. Letters, digits and @/./+/-/_
only.
full_name* string min:1 chars
account_type string READ-ONLY
standard, service_with_impersonation,
service_without_impersonation, device
cloud_space_right {
instant_social* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_tv* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_booking* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_signage* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_metrics* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
instant_device_manager* enum ALLOWED:CLOUD_GUEST, CLOUD_RESTRICTEDACCESS,
CLOUD_LEARNER, CLOUD_VIEWER, CLOUD_USER,
CLOUD_POWERUSER, CLOUD_ADMIN
}
}

STATUS CODE - 400: Invalid parameters.

STATUS CODE - 401: Unauthorized. Authentication needed.

345 of 352
STATUS CODE - 403: Forbidden. Access denied.

STATUS CODE - 404: User not found

346 of 352
28. WIFI-GUEST

28.1 GET /wifi-guest/access/

Get List Wifi Access Request

Get list of information about a created wifi access request like where is the access.

REQUEST
QUERY PARAMETERS
NAME TYPE DESCRIPTION

page integer A page number within the paginated result set.

page_size integer Number of results to return per page.
limit integer Limit
offset integer Offset
order_by string sorting
min:1 chars

RESPONSE

STATUS CODE - 200:

RESPONSE MODEL - application/json

{
pagination* {
total_results integer
results_per_page integer
total_pages integer
current_page integer
previous_page integer
next_page integer
}
results* [{
Array of object:

first_name string min:1 chars

First name
last_name string min:1 chars
Last name
email string min:1 chars
Email
access_start* string Access start time
access_end* string Access end time
wifi_provider_id* string min:1 chars
Wifi provider ID
phone_number string min:1 chars
Phone number
wifi_access* {
Wifi access

id* string min:1 chars

Wifi access request ID

347 of 352
 ssid* string min:1 chars
SSID
password string min:1 chars
Password
username string min:1 chars
Username
portal_login string min:1 chars
Portal login
portal_password string min:1 chars
Portal password
encryption_type* string min:1 chars
Encryption type
}
}]
}

STATUS CODE - 400: Invalid parameters.

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

28.2 POST /wifi-guest/access/

Request Wifi Access

Create a wifi access request.

REQUEST
REQUEST BODY - application/json
{
first_name string min:1 chars
First name
last_name string min:1 chars
Last name
email string min:1 chars
Email
access_start* string Access start time
access_end* string Access end time
wifi_provider_id* string min:1 chars
Wifi provider ID
phone_number string min:1 chars
Phone number
}

RESPONSE

STATUS CODE - 201:

RESPONSE MODEL - application/json

{
id* string min:1 chars
Id of the access request
eta* string ETA to access creation
}

STATUS CODE - 400: Invalid parameters.

348 of 352
 STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

28.3 GET /wifi-guest/access/{access_request_id}/

Get Wifi Access Request

Get information about a created wifi access request like where is the access.

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*access_request_id string

QUERY PARAMETERS
NAME TYPE DESCRIPTION

page integer A page number within the paginated result set.

page_size integer Number of results to return per page.

RESPONSE

STATUS CODE - 200:

RESPONSE MODEL - application/json

{
first_name string min:1 chars
First name
last_name string min:1 chars
Last name
email string min:1 chars
Email
access_start* string Access start time
access_end* string Access end time
wifi_provider_id* string min:1 chars
Wifi provider ID
phone_number string min:1 chars
Phone number
wifi_access* {
Wifi access

id* string min:1 chars

Wifi access request ID
ssid* string min:1 chars
SSID
password string min:1 chars
Password
username string min:1 chars
Username
portal_login string min:1 chars
Portal login
portal_password string min:1 chars
Portal password

349 of 352
 encryption_type* string min:1 chars
Encryption type
}
}

STATUS CODE - 400: Invalid parameters.

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

28.4 DELETE /wifi-guest/access/{access_request_id}/

Cancel A Wifi Access Request

Cancel a wifi access request so that wifi access is not created

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*access_request_id string

RESPONSE

STATUS CODE - 204: Success

STATUS CODE - 400: Invalid parameters.

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

28.5 GET /wifi-guest/provider-specs/

Get List Of Possible Providers

Get specs of available providers and expected parameters so that you can configure a new
provider.This endpoint give you a full list of parameters you'll need for each known provider type.

REQUEST
QUERY PARAMETERS
NAME TYPE DESCRIPTION

page integer A page number within the paginated result set.

page_size integer Number of results to return per page.

RESPONSE

STATUS CODE - 200: Success

STATUS CODE - 400: Invalid parameters.

350 of 352
 STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

28.6 POST /wifi-guest/provider/

Configure a new wifi provider

Configure a new wifi provider.

REQUEST

RESPONSE

STATUS CODE - 201: Success

STATUS CODE - 400: Invalid parameters.

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

28.7 PUT /wifi-guest/provider/{provider_id}/

Edit Provider Configuration

Modify parameters of a wifi provider in case configuration needs to be updated

REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION

*provider_id string

RESPONSE

STATUS CODE - 200: Success

STATUS CODE - 400: Invalid parameters.

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

28.8 DELETE /wifi-guest/provider/{provider_id}/

Decomission Wifi Provider

Decommission a wifi provider you could have configured.

REQUEST
PATH PARAMETERS

351 of 352
 NAME TYPE DESCRIPTION

*provider_id string

RESPONSE

STATUS CODE - 204: Success

STATUS CODE - 400: Invalid parameters.

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

28.9 GET /wifi-guest/search-provider/

Get List Of Configured Providers

Get list of configured wifi access providers and their parameters

REQUEST
QUERY PARAMETERS
NAME TYPE DESCRIPTION

page integer A page number within the paginated result set.

page_size integer Number of results to return per page.
limit integer Limit
offset integer Offset
order_by string sorting
min:1 chars

RESPONSE

STATUS CODE - 200: Success

STATUS CODE - 400: Invalid parameters.

STATUS CODE - 401: Unauthorized. Authentication needed.

STATUS CODE - 403: Forbidden. Access denied.

352 of 352