Aeon API

Returns a list of custom fields defined for the specified context type.

Custom Fields Support in Other Endpoints

To 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.

/api/Queues/{id}/requests                                                                                        

Returns a list of reading rooms configured for appointment scheduling in Aeon.

Parameters:

• siteCode (optional): If supplied, only the reading rooms for that site will be returned; if not supplied, all reading rooms will be returned.

Returns information on a specified reading room identified by ID. 

Parameters:

• id (int): The ID of the reading room for which to return information.

/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:

• startDate (datetime): Specifies a start time in the reading room's timezone.
• endDate (datetime): Specifies an end time in the reading room's timezone.
• note (string): Specifies the public note associated with the closure.

/api/ReadingRooms/{id}/AvailableAppointments/{date}                                              

Returns a list of available appointment times for the specified reading room on the specified date.

Parameters:

• id (int): The ID of the reading room for which to return information.
• date (string): The date for which availability should be returned.

• userStatus (string)*: The user status for which availability should be returned, based on the policies defined for that status in the Status-Specific Policies table configured for the reading room in the Aeon Customization Manager.

  If a status is not specified in the userStatus parameter or if the status specified in the parameter does not have an entry in the reading room's Status-Specific Policies table, then the endpoint will return appointment availability based on the default policies defined for the reading room.

*Aeon 5.2 only

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.

• Request process:

  • The request will be created and the initial routing will be performed of the transaction and will return a JSON object with creation details including the transaction, including TN, and any default field values.

Example Call:

{
  "requestFor": {
    "type": "Activity",
    "reference": "string"
  },
  "username": "string",
  "appointmentID": 0,
  "bundleID": 0,
  "callNumber": "string",
  "documentType": "string",
  "eadNumber": "string",
  "format": "string",
  "forPublication": true,
  "itemAuthor": "string",
  "itemCitation": "string",
  "itemDate": "string",
  "itemEdition": "string",
  "itemInfo1": "string",
  "itemInfo2": "string",
  "itemInfo3": "string",
  "itemInfo4": "string",
  "itemInfo5": "string",
  "itemIssue": "string",
  "itemISxN": "string",
  "itemNumber": "string",
  "itemPages": "string",
  "itemPlace": "string",
  "itemPublisher": "string",
  "itemSubTitle": "string",
  "itemTitle": "string",
  "itemVolume": "string",
  "location": "string",
  "maxCost": "string",
  "pageCount": 0,
  "referenceNumber": "string",
  "scheduledDate": "2022-10-14T15:05:13.137Z",
  "serviceLevel": "string",
  "shippingOption": "string",
  "site": "string",
  "specialRequest": "string",
  "subLocation": "string",
  "systemID": "string",
  "webRequestForm": "string",
  "customFieldValues": {}
}

/api/Requests/{id}/route

Returns a list of requests for the given barcode. Unlike the RequestBarcodes/Reshelved endpoints, the endpoint allows for nonstandard characters.

API Call:

• The request will check to see if the provided transaction number has a TransactionStatus of Awaiting Item Reshelving. If so, the API will route the request to the Item Reshelved status, and then to Request Finished status.
• The custom queue Item Reshelved will act as a transitory status that will trigger requests to automatically route to the Request Finished status.  
• If activeOnly is set to true, only active requests will be returned. 

Reshelves request based on the given barcode. Unlike the RequestBarcodes/Reshelved endpoints, the endpoint allows for nonstandard characters.

API Call:

• Request process:
  1. The request will search for the transaction record whose ItemNumber field matches the barcode provided in the API request. The ItemNumber field should be the only location used for the barcode number since Aeon assumes this field is the barcode and will not check any other fields for the barcode number. 
  2. The request will then check to see if the provided transaction number has a TransactionStatus of Awaiting Item Reshelving. If so, the API will route the request to the Item Reshelved status, and then to Request Finished status.
• The custom queue Item Reshelved will act as a transitory status that will trigger requests to automatically route to the Request Finished status. 

Adds a note to an existing request.

Parameters (required):

• noteText (string): The text for the note being added
• username (string): The username adding the note
  • This value does not need to be an Aeon user and can be set to a value such as "Aeon Web API" to indicate that the note was added by the API.
• noteType (string): The type of the note being added
  • Valid values for noteType are System, Staff, User, or ItemDetail
  • If noteType is not specified, the value will default to System

API Call:

• The endpoint requires a JSON body containing information in the following format:

Example Call:

{
    "noteText": "PostNote test note",
    "username": "Aeon Web API",
    "noteType": "System"
}

Example Response:

{
    "id": 662,
    "transactionNumber": 15,
    "noteDate": "2022-09-08T18:57:12.8656546",
    "noteText": "PostNote test note",
    "username": "Aeon Web API",
    "noteType": "System"
}

Returns a list of notes associated with a specified request.

Parameters (required):

• TransactionNumber: The transaction number for the request

Example Response:

[
  {
    "id": 1,
    "transactionNumber": 1,
    "noteDate": "2022-09-12T13:48:50.855Z",
    "noteText": "Note Text",
    "username": "username",
    "noteType": "System"
  },
  {
    "id": 2,
    "transactionNumber": 1,
    "noteDate": "2022-09-12T13:48:50.855Z",
    "noteText": "Note Text 2",
    "username": "username",
    "noteType": "System"
  }
]

Used to update information for a specific request.

API Call:

• In addition to the ID for the request specified in the API call, requests to this endpoint must contain a body in the JSON Patch format using the "replace" action to specify which Aeon fields on the course record to overwrite with new values:

  [
    { "op": "replace", "path": "/<aeonField1>", 
      "value": "<NewValue>" },
    { "op": "replace", "path": "/<aeonField2>", 
      "value": "<NewValue>" }
  ]

  Note: The path property must specify an Aeon request field name using camelcase, e.g. 'fieldName'
• Custom fields defined in the CustomFieldDefinitions table will need to be updated using the following format, where <ShortName> is replaced by the short name defined for the field in the Customization Manager:

  [
    {"op": "replace", "path": "/customFieldValues", 
     "value": {"<ShortName>": "<NewValue>"}}
  ]

Example Call:

The following example will set the ItemAuthor field to Doe, John, the ItemVolume field to 456, the ItemTitle field to null, the ItemInfo5 field to ItemInfo, and a Transaction type custom field defined in the CustomFieldDefinitions table with the short name Container3 to Custom:

[
    {"op": "replace", "path": "/itemAuthor", "value": "Doe, John"},
    {"op": "replace", "path": "/itemVolume", "value": "456"},
    {"op": "replace", "path": "/itemTitle", "value": null},
    {"op": "replace", "path": "/itemInfo5", "value": "ItemInfo"},
    {"op": "replace", "path": "/customFieldValues", 
     "value": {"Container3": "Custom"}}
]

Response:

• 200 Success: The operation was completed successfully and a JSON model of the updated request is returned
• 400 Bad Request: The request information was invalid 
• 401 Unauthorized: The API request was not properly authorized
• 404 Not Found: The specified request was not found

Retrieves a list of all users up to a maximum of 2000 results.

Returns a JSON object containing the list of appointments for a given user. The appointment object also contains the associated reading room object.

Parameters:

• Username: The username for which to retrieve appointments.
• Context: Can be "Self," "Researcher," or "Both" to filter the list of appointments for just the user, just the user's researchers, or to include both. If no context is specified, "Self" will be the default value.
• PendingOnly: Filters out past appointments by StartTime.