Documentation

This is taking longer than usual. If nothing appears, refresh the page.

Documentation

Enter at least two characters to search
    {{docApp.userSession.userId}}
    {{docApp.userSession.userName}}
    {{docApp.userSession.email}}
    Issuer : {{docApp.userSession.issuerInstance}}
    Expires : {{new Date(docApp.userSession.validUntil).toLocaleDateString()}}

{{docApp.title}}

{{docApp.description}}

Connect an AI assistant

Your AI assistant can read this documentation directly, so it answers from the current content instead of guessing. Add one of the servers below to your client — they use the Model Context Protocol (MCP). Each one covers a different body of content, so add the one you need.

The catalog did not load. Refresh the page to try again.

Loading…

How can we help?

{{docApp.searchError}}

Keep typing  - a search needs at least two characters

Searching in {{docApp.searchFilterBySpecificBookTitle}}

 {{docApp.currentResultsSearchText}}  in {{docApp.searchFilterBySpecificBookTitle}}
Found {{docApp.searchResponse.totalResultsAvailable}} matches. Showing the top {{docApp.searchResponse.results ? docApp.searchResponse.results.length : 0}}. Use a more specific search to further narrow down the results.
No documentation pages match this search, so all content types are shown. Most matches are in {{docApp.searchDocTypeRescue.best.name}}.
There is no book with the ID "{{docApp.searchBookRescue.bid}}", so the book filter from this link was ignored and results from all books are shown.

You have an odd number of " characters in your search terms - each one needs closing with a matching " character!

  • {{resultItem.title}} {{resultItem.matchedBy === 'semantic' ? 'semantic' : (resultItem.matchedBy === 'both' ? 'keyword + semantic' : 'keyword')}}

    {{resultItem.url}}

{{docApp.libraryHomeViewProduct.title || docApp.libraryHomeViewProduct.id}}

{{docApp.libraryHomeViewProduct.description}}

  1. {{book.title}}

Smart Locker Management / Get Bays

  • Article
  • 2 minutes to read

Operation Information

Retrieves the details of a single Smart Locker bay by ID from the LapSafe / Onarken platform.

This is a Free Tier Integration.

Authentication

This operation requires authentication, the details of which can be securely stored on your instance in a KeySafe Key of type LapSafe Authentication.

To create a key of this type:

  • In the Configuration area of your Hornbill instance, navigate to Platform Configuration > Security > KeySafe;
  • Click on the + Create New Key button;
  • On the resulting Create New Key form, choose LapSafe Authentication in the Type pick list;
  • Give the LapSafe Authentication KeySafe key a Title (this is the name / identifier for the LapSafe Authentication account as you will see it when using the cloud automation node in your workflows);
  • Optionally populate the Description field;
  • Populate the following fields accordingly, then click the Create Key button to create your new key:
Name Type Description
domain string Your LapSafe Instance
API Token string The API Token which can be generated within Profile > API tokens

Tip

To connect to LapSafe, you will need to input your username and password for your LapSafe account.

Revoking Access

If at any point you wish to revoke access to any of the above accounts from your Hornbill instance, just delete the relevant KeySafe key(s) from the KeySafe list.

Warning

This will revoke the rights of any existing Cloud Automation Node in your Hornbill Workflows that are using the revoked LapSafe Authentication account, so you will need to manage these workflows accordingly.

Input Parameters

Display Name ID Type Description Required Supported Values
Bay ID id string The UUID of the Smart Locker bay to retrieve. Yes None provided

Output Parameters

Display Name ID Type Description
Status status string The outcome of the operation — ok or failed.
Error error string Error detail returned if the operation did not succeed.
ID id string The UUID of the bay.
Bay Number bay_number string The bay number label on the locker unit.
Installation ID installation_id string The UUID of the installation this bay belongs to.
Easy Access easy_access boolean Whether the bay is designated as an easy-access bay.
Bay Status bayStatus string The current status of the bay (e.g. Fault).
Size size string The physical size of the bay (e.g. Large).
Charging Type charging_type string The charging capability of the bay (e.g. BaseLine).
Smartline Profile smartline_profile string The Smartline profile assigned to this bay.
Connectivity Equipment connectivity_equipment string The connectivity equipment installed in the bay (e.g. None, KVM).
Door Status — Is Open doorStatusIsOpen boolean Whether the bay door is currently open.
Door Status — Opened At doorStatusOpenedAt string The date and time the bay door was last opened (ISO 8601).
Service service string The service type this bay is configured for (e.g. DropOffCollectionLocker).
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document