The Aeon API allows developers to perform actions in Aeon and build integrations outside of the installed Aeon components. For example, the API allows the developers to connect to the database and change a transaction status.
Installation
Using the Aeon API requires Aeon version 4+. The Aeon API requires the .NET Core components at version 2.1 or higher. This installer is provided by Microsoft and must be run separately.
Note: As of v5.1, the Aeon API is installed by default during the server installation/update process and does not need to be installed separately. However, the .NET Core components are not part of the default Aeon install and will still need to be installed separately.
The latest installer for the Aeon Web API is available on the Aeon Downloads page.
Please contact Atlas Systems at 1-800-567-7401 x1 or support@atlas-sys.com for the credentials to download the installer.
Service hours are Monday through Friday 8am-5pm eastern time, excluding Federal holidays.
Swagger Documentation
The Aeon API has developer-oriented documentation built-in. You can get to the API Swagger documentation at https://servername/aeon/api/swagger/.
*Replace 'servername' with the IP address or DNS.
Available Endpoints
Custom Fields
Get | /api/customFieldDefinitions/{contextType} | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Returns a list of custom fields defined for the specified context type. Parameters:
Click for properties of the information returned
Custom Fields Support in Other EndpointsTo include custom fields when creating a request via the POST Request endpoint, the Request JSON object must have a property named "CustomFieldsValues" containing all custom field values that will be supplied in the "ShortName:value" format. Response objects returned by the GET Request and POST Request endpoints and user objects returned by the GET User endpoint will contain a CustomFields property listing all defined fields for the given request, in the same "ShortName:value" format. Null values will be included. |
Queues
Get | /api/Queues |
---|---|
Returns queues configured in Aeon. | |
Get | /api/Queues/{id} |
Returns a Queue identified by ID. | |
Get |
/api/Queues/{id}/requests |
Returns requests associated with the queue identified by ID. |
Reading Rooms
Get | /api/ReadingRooms | ||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Returns a list of reading rooms configured for appointment scheduling in Aeon. Parameters:
Click for properties of the information returned
|
|||||||||||||||||||||||||||||
Get | /api/ReadingRooms/{id} | ||||||||||||||||||||||||||||
Returns information on a specified reading room identified by ID. Parameters:
Click for properties of the information returned
|
|||||||||||||||||||||||||||||
Get |
/api/ReadingRooms/{id}/Closures |
||||||||||||||||||||||||||||
Returns a list of full closures for the specified reading room, limited to those occurring in the future. This endpoint reports both full closures (i.e. "Closed" exception types) and "partial" closures (i.e. "Reduced Availability" exception types) that reserve a number of seats greater than or equal to the reading room's total available seats. Parameters:
|
|||||||||||||||||||||||||||||
Get |
/api/ReadingRooms/{id}/AvailableAppointments/{date} |
||||||||||||||||||||||||||||
Returns a list of available appointment times for the specified reading room on the specified date. Parameters:
Click for properties of the information returned
|
Requests
Get | /api/Requests/{id} |
---|---|
Returns a request identified by transaction number.
|
|
Get | /api/Requests/{id}/nextsteps |
Returns next step process names for the transaction identified by ID. | |
Post | /api/Requests/create/ |
Creates Aeon requests for a specified user. API Call: At a minimum the username (user must be a valid user in the database) must be supplied; however, additional user information may be provided if supplied by the appropriate corresponding database column names.
|
|
Post
|
/api/Requests/{id}/route |
Routes a transaction to the given transaction or photoduplication status. Routing rules will be applied. | |
Get | /api/Requests/{id}/routes |
Returns a list of the valid transactions and photoduplication queues a request may be routed to. | |
Post | /api/Requests/Batch/?{parameters} |
Returns a list of requests for the given barcode. Unlike the RequestBarcodes/Reshelved endpoints, the endpoint allows for nonstandard characters. API Call:
|
|
Post | /api/Requests/Batch/Reshelved |
Reshelves request based on the given barcode. Unlike the RequestBarcodes/Reshelved endpoints, the endpoint allows for nonstandard characters. API Call:
|
|
Post | /api/RequestBarcodes/{barcode}/reshelved |
The RequestBarcode endpoints have been replaced by the Requests/Batch endpoints and are now considered deprecated.
Reshelves request based on the given barcode. API Call:
|
|
Post |
/api/RequestBarcodes/{id}/reshelved |
The RequestBarcode endpoints have been replaced by the Requests/Batch endpoints and are now considered deprecated.
Reshelves request based on a given transaction number. API Call:
|
System Information
Get | /api/SystemInformation/Version |
---|---|
Returns the version of the Web API.
|
Token
Post | /api/Token |
---|---|
Retrieves an authentication token for the provided staff credentials.
|
Users
Get | /api/Users/{username} |
---|---|
Returns a user identified by username.
|
|
Get
|
/api/Users/{username}/requests
|
Retrieves a list of all requests (or active requests only if the ActiveOnly parameter is used) for a specific user.
|
|
Get
|
/api/Users/{username}/appointments
|
Returns a JSON object containing the list of appointments for a given user. The appointment object also contains the associated reading room object. Parameters:
|
Authentication
Most of the actions will require authentication. There are 2 ways to authenticate in the Aeon API: Aeon API Key or staff tokens.
API Key
You can create an API key in the Aeon Customization Manager. More information on API keys is available at Configuring the Aeon Web Platform.
The Base Webservice URL isn't relevant for the API so you can just enter the API URL: https://yourservername.aeon.atlas-sys.com/aeon/api/.
Staff Token
The staff tokens will use the POST Token operation where you'll post an Aeon staff username and password. It will return a token which should be used as a BEARER authentication header.
Testing the Authentication
To test in the swagger interface, you can click on Authorize in the top right corner of the swagger interface. A pop-up like an image shown below will appear.
- The first option (Name: X-AEON-API-KEY) is for the API Key; Just paste the API key directly into the value and click authorize and you should be good.
- For the staff token authentication, note that it currently has a 5-minute timeout. You would need to POST to the Token operation to get a JWTvalue. In the swagger interface, you would enter BEARER <JWT value from Token response>
Additional Information
If there is specific functionality that you are looking to use to integrate with your services, we encourage you to submit enhancements & ideas to Uservoice at https://uservoice.atlas-sys.com/. Thanks!