v3/Access API's

Get Access (Legacy v2)

Deprecated — use the v3 endpoint instead. New integrations should use GET /api/v3/booking/getLockData/:referenceId.

This API endpoint allows you to fetch all active access credentials for a booking.

Method

GET

URL

https://api.mosler.in/api/v2/booking/access

Headers

Name	Type	Required	Description
`apikey`	`string`	Yes	API Key

Request Query

Name	Type	Required	Description
`ref_id`	`string`	Yes	The unique identifier for the booking.
`provider`	`string`	No	The PMS provider for the booking. Defaults to Mosler.

Response Parameters

Name	Type	Description
`message`	`string`	The message returned by the API.
`code`	`number`	The status code returned by the API.
`error`	`boolean`	Indicates if an error occurred during the API call.
`data`	`array`	An array of objects containing the data returned by the API.

The data object is an array of objects containing the following fields:

Name	Type	Description
`lockData`	`string`	Lock data, used to operate lock.
`lockMac`	`string`	MAC address of the lock.
`lockId`	`string`	The unique identifier of the lock.
`lockLocationType`	`string`	The type of lock location. `"door"` or `"cabinet"`
`roomNumber`	`string` or `null`	The room number. `null` when `lockLocationType == "cabinet"`
`bedNumber`	`string` or `null`	The bed number. `null` when `lockLocationType == "door"`
`siteName`	`string`	The site name.
`keyId`	`number`	The unique identifier of the e-key.

Response Example

{
    "message": "Successfully fetched Ekeys for Booking.",
    "code": 7005,
    "error": false,
    "data": [
        {
            "lockData": "Rz7oNSAH1No3YXRiG0j8FKB3xBjhuILrkTjWkOMwFNwriRFjSnWAatQJOR8Nf5OkbuHyjYYLAqVAL1JB/rXxvV7D7XlZJDnuIba9D4cgR52FL3TeYwlojr4K1T5v7LjA4Bu/rv8tNGrQl2PlWk474OL2HdoBKWvphx6ZipcejONpHNHUTBrEBCYEIVAhI7PBuaqO6XUvX4sO1eeCT5VHsEXcolbPAWI0v15fhoRt4k5iXe3rrdtJf899Dnx4mLpzyzyxDi2Su1ov13nVC7xMVT5Pjr33ijSgNgPXeh0S+lKqwe4gjFc87Jn8mAiL5uMlXEuRtWXBxURIQ6YtVYllUyPFEEsFwQpSeVO4PHmpthjQp1q0D7H+x3fEXlK5crba+QoU6J8AHpyuqzfqRCxWZvkiw+b8U9ah3ePwwKfp5gQD6krw2mGZdlbrHwwqGX5oTZIuqzmaLuJLGgt6r2f+t20WOaQB8/GgdYj3LALkT/3Uc++wEW75PnSzjZW+kXJFyVGjsM7qJ6eGmE1ktMP+aPN+uBpdnrVq4KabcuLYNLyAJhqhSkoEMEBCc/PfXwB1cpD796niYbRHKI3wf1hpCjzRyyyMsnRJ92baBzn7ey1PBgmPjbe9VRVxacxH1HcEPS2pnSEbK9NlMH0gKmADIu5FvYSxdJzEXpPzIqcPz21IJsXIWNhnNITqKeR4CYWPNddtewApeP9fmbupibNNIEewlCKGDX8GW89hRV/zicC1h+UMhBk9jFu8eoxsF6oUy2iwdDc9gjBiCRGKEqNbn/RqieCoMsPYlLW6KnaOhW4e+V5U8r54LSmIcpF8VTkmHMZ1ekmzAAIbP6kPX6k7x6Pfubbk5CKMR1Xp1rb++tF4JhT+uzh7wv+1iLdYhRJJmax2RHIJHjqtiXpaycrPhBdnOOZXvVlAFtS71lHLiejryn9qi/3juPeXrSHEmu+cbkeVTlUawQNf7qeBVIWQYjytB6BvQ180rMK6emvOABkB5pkfR2/9apkrcMvY8DrfR1ugluRMnWfnTSEkoj+4PBfqFs0SlD4Wre1lZN2rZ1v5P/RIcbH7bGqhJtegyZUnoV9wT7JwLaswM13i5YenVl3ubXkGhu+nF8Ta75tGLY2ctYjD0RQ=",
            "lockMac": "9C:B5:88:C3:D1:14",
            "lockId": "71268",
            "lockLocationType": "door",
            "roomNumber": "101",
            "bedNumber": null,
            "siteName": "Delhi",
            "keyId": 118483626
        },
        {
            "lockData": "omSRy+RAnPZxyD+8OftdCzjne75JLC8oIWf0843mvEYkgrZRKv5vIsmJkP3VA75rNnmVhYrsdHQBPOAgqA1oTsxv8HtjtsCleVku4HVds6nw3qMLL0eWm3XGpP5LZc0ov1OC94rPj1P6DiPuPJYxo3fUy/c+AuwgK9YGOdRu0EqcE2xGxQ0i8KXHtOSBMczYxITOEOYbg+iUiZ6fqPmHw42cff/4qZxGMxxW8kBHmV/YOdrF4AGLKd4MaaWB+M2xrUdppQfRehuA2S5ltibaZTYmJfcnU4XhtVipVf3jkaUWYaqCfqYpSP/uQKKp0BFZ3eJc0IUI0RXmXAhCBPqyFH+R7Q72waDEqzO4M1zcT5RYtYVRCnUhbgicTppZQSxv8CoIAIN/tzqMLhKaNogUeeUjM0Eqj7AKp0j/CkVOGvZY5AizlCkKsmpMHpVssFufyH7Ook/CFe1NPz7ylqIZUFDPDsWi7XzGmMM9Ln/69jIU8hDlk9/dCUCA/hOdDBDOyeSLFZ8RtLbjY2VrhCJOB3CujiakO+qS4VAoO+9TkvwEUIAbNhed10uDyQr7k0TWCTgHx1LkkUiBy0aJOZ3I1/jz3UgXWpPOKnINHfHaVA6XUtY0Z9ElKio8gIrYIf9e0y6493yDQf82+UOdiNMSPz9ZQaHTjFZ0DZoluyyjkXYO+yA4CPAbTOHbKMqIO3fYm2GEy5JQy8He0C9JZ0VmUVhFxHQY1Xduf/oBYVgYCtAJxWLVYqe5utZjZAaZc9/e1KNmjCCcoGhvRFyNnlBebu8M3DqZDg5Z49xMl18Xu/RywDLysMZJ6VYY5phcv8N4zON4OSEE2ObZ9ZI1pxX3+G6qIShVMADJViXgm3FMo4IzlNWASs+dC2lX3PF91YBs3ODi92KXwo4RsnV7KxssxeUNoZMmflS8b4lI9hrk+LfwieH2qC2cAp8JkiR/qtHRsVqcvyWIsgK5xqvC4pyUehmRRDu2mVF1VW3/wdIJNk9nPKtczu6oG252t5FWytChIuxehDJZdwQwPOsosfNgXReANUh1D1V0GlXBGY61JkoCg4yLuEDVYe7cWHWtWwLHxsaiK7ISJsFGZj3x9TmlojBnN8FuIWciEIO0H4zjaApvnuyGWuo=",
            "lockMac": "6F:9E:EC:86:5A:EA",
            "lockId": "71269",
            "lockLocationType": "cabinet",
            "roomNumber": null,
            "bedNumber": "a",
            "siteName": "Delhi",
            "keyId": 118483627
        }
    ]
}