Update EasySecure user.

PUT/api/easysecure/users/{id}

Can be used to update some details of an EasySecure user. The most important property is gdprConsent. Show a GDPR consent form to the user to update this property before uploading a photo.

PUTRequest

TypeScript samples are coming soon.

Responses

Response 200

Successful response

application/json

Example responseGenerated from schema

{
  "id": 0,
  "uuid": "uuid",
  "uniqueId": "RB-123456",
  "name": "name",
  "start": "2024-07-01T00:00:00Z",
  "end": "2024-07-08T00:00:00Z",
  "created": "created",
  "configuration": {
    "id": 0,
    "created": "created",
    "locale": "locale",
    "description": "description",
    "gdprStatement": "gdprStatement",
    "locationReference": 1,
    "numOfDaysBeforeCheckin": 7,
    "numOfDaysAfterCheckout": 1,
    "numOfDaysAfterCheckoutWithRetainConsent": 180,
    "hasCustomCheckinCheckoutTime": false,
    "checkinTime": "checkinTime",
    "checkoutTime": "checkoutTime",
    "numOfMinutesBeforeCheckin": 0,
    "numOfMinutesAfterCheckout": 0,
    "includeOwnerReservations": false,
    "includeReservationFellowGuests": true,
    "includeReservationAdditionalGuests": true,
    "hasPhotoEnabled": false,
    "hasTapkeyEnabled": false,
    "hasQRCodeEnabled": false,
    "updateProfilePictureAfterPhotoUpload": false,
    "lockUserAfterPhotoUpload": false,
    "deleteQRCodeAfterPhotoUpload": false,
    "deletePhotoAfterQRCodeEnabled": false,
    "active": false,
    "modified": "modified"
  },
  "hasPhotoEnabled": true,
  "hasPhoto": true,
  "hasTapkeyEnabled": true,
  "hasTapkey": true,
  "hasQRCodeEnabled": true,
  "hasQRCode": true,
  "registered": false,
  "gdprConsent": false,
  "retainConsent": false,
  "locked": false,
  "modified": "modified",
  "expires": "expires",
  "exported": "exported"
}

Response 400

Bad request

application/json

Example 1

{
  "statusCode": 400,
  "description": "Bad request",
  "errors": [
    "Bad request"
  ]
}

Path parameters

idnumberrequired

Request body

Required: No
Content type: application/json

object[]
Show array — 5 properties
- hasPhotoEnabledbooleanoptional
- hasQRCodeEnabledbooleanoptional
- gdprConsentbooleanoptional
- retainConsentstringoptional
- lockedstringoptional

Returns

Schema shown for 200 · application/json

idnumber
uuidstring
uniqueIdstring
EasySecure ID of the user
namestring
startstring
endstring
hasPhotoEnabledbooleanoptional
Default: false
Indicates if the user can use the photo method.
hasPhotobooleanoptional
Default: false
Indicates if the user currently has a photo.
hasTapkeyEnabledbooleanoptional
Default: false
Indicates if the user can use the Tapkey method.
hasTapkeybooleanoptional
Default: false
Indicates if the user currently has a Tapkey.
hasQRCodeEnabledbooleanoptional
Default: false
Indicates if the user can use the QR code method.
hasQRCodebooleanoptional
Default: false
Indicates if the user currently has a QR code.
registeredbooleanoptional
Default: false
gdprConsentbooleanoptional
Default: false
retainConsentbooleanoptional
Default: false
lockedbooleanoptional
Default: false
createdstring
modifiedstringoptional
expiresstringoptional
exportedstringoptional
configurationESConfiguration
Show 26 properties
- idnumber
- descriptionstringoptional
- gdprStatementstringoptional
- locationReferencenumberoptional
  Default: 1
- numOfDaysBeforeCheckinnumberoptional
  Default: 7
- numOfDaysAfterCheckoutnumberoptional
  Default: 1
- numOfDaysAfterCheckoutWithRetainConsentnumberoptional
  Default: 180
- hasCustomCheckinCheckoutTimebooleanoptional
  Default: false
- checkinTimestringoptional
- checkoutTimestringoptional
- numOfMinutesBeforeCheckinnumberoptional
  Default: 0
- numOfMinutesAfterCheckoutnumberoptional
  Default: 0
- includeOwnerReservationsbooleanoptional
  Default: false
- includeReservationFellowGuestsbooleanoptional
  Default: true
- includeReservationAdditionalGuestsbooleanoptional
  Default: true
- hasPhotoEnabledbooleanoptional
  Default: false
- hasTapkeyEnabledbooleanoptional
  Default: false
- hasQRCodeEnabledbooleanoptional
  Default: false
- updateProfilePictureAfterPhotoUploadbooleanoptional
  Default: false
- lockUserAfterPhotoUploadbooleanoptional
  Default: false
- deleteQRCodeAfterPhotoUploadbooleanoptional
  Default: false
- deletePhotoAfterQRCodeEnabledbooleanoptional
  Default: false
- activebooleanoptional
  Default: false
- createdstring
- modifiedstringoptional
- localestring