Get EasySecure configurations.

GETRequest

import { RecranetApiClient } from "@recranet/sdk";

const client = new RecranetApiClient({ apiKey: process.env.RECRANET_API_KEY! });

const result = await client.easysecure.configurations.list();

Responses

200400

Response 200

Successful response

application/json

Example responseGenerated from schema

[
  {
    "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"
  }
]

Response 400

Bad request

application/json

Example 1

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

Query parameters

• securityCodestringoptional
• locationReferencenumberoptional
• activebooleanoptional

Returns

Array of ESConfiguration

Schema shown for 200 · application/json

• 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