Skip Navigation
  1. BlackBerry Docs
  2. BlackBerry AtHoc
  3. 7.15
  4. BlackBerry AtHoc Release Notes 7.15 (OnPrem)
  5. What's new in BlackBerry AtHoc 7.15 (OnPrem)
  6. API

API

New APIs

  • GET /orgs/{orgCode}/AccountEvents/templates
    : Returns the list of accountability templates.
  • GET /orgs/{orgCode}/AccountEvents/templates/{commonName}
    : Returns accountability event template details.
  • GET /orgs/{orgCode}/AccountEvents
    : Returns a list of published accountability events based on PageNo and PageSize.
  • POST /orgs/{orgCode}/AccountEvents
    : Publishes an accountability event using a template.
  • GET /orgs/{orgCode}/AccountEvents/{eventId}/Officers
    : Returns the accountability event officer list for the specified event ID.
  • GET: /orgs/{orgCode}/attachments/{guid}
    : Returns details about an attachment.
  • GET /orgs/{orgCode}/attributes/{commonName}/Values
    : Returns all attribute values for the specified common name.
  • GET /orgs/{orgCode}/attributes/{commonName}/Values/{valueCommonName}
    : Returns all attribute values for the specified common name.
  • DELETE /orgs/{orgCode}/attributes/{commonName}/values
    : Deletes one or multiple values from a List type attribute.
  • POST /orgs/{orgCode}/attributes/{commonName}/values
    : Adds new attribute values for an attribute.
  • PUT /orgs/{orgCode}/attributes/{commonName}/values
    : Updates existing attribute values for an attribute.
  • PUT /orgs/{orgCode}/attributes/{commonName}/values/{valueCommonName}
    : Updates the attribute value.
  • DELETE /orgs/{orgCode}/attributes/{commonName}/Values/{valueCommonName}/Users
    : Deletes attribute values for the specified users.
  • PUT /orgs/{orgCode}/attributes/{commonName}/Values/{valueCommonName}/Users
    : Adds attribute values for the specified users.
  • GET /orgs/{orgCode}/AuditLog
    : Returns a list of operator audit logs based on RowOffset and Limit.
  • GET /orgs/{orgCode}/DeliveryTemplates
    : Returns a list of delivery templates based on Offset and Limit.
  • POST /orgs/{orgCode}/DeliveryTemplates/Email/Preview/{DeliveryTemplateCommonName}
    : Returns an HTML preview of the email delivery template.
  • POST /orgs/{orgCode}/DeliveryTemplates/Email/Preview
    : Returns an HTML preview of the email delivery based on XSLT stylesheet.
  • POST /orgs/{orgCode}/DeliveryTemplates/DesktopPopup/Preview/{DeliveryTemplateCommonName}
    : Returns an HTML preview of the desktop pop-up delivery template.
  • POST /orgs/{orgCode}/DeliveryTemplates/DesktopPopup/Preview
    : Returns an HTML preview of the desktop pop-up delivery template based on XSLT stylesheet.
  • GET /orgs/{orgCode}/DeliveryTemplates/{DeliveryTemplateCommonName}
    : Returns details about a delivery template based on common name.
  • POST /orgs/{orgCode}/EventLogs
    : Creates an event log for the specified organization.
  • GET /orgs/{orgCode}/IncomingEvents
    : Returns inbound external and user events. Inbound user events include check-ins, check-outs, reports, and emergencies.
  • GET /orgs/{orgCode}/IncomingEvents/{id}
    : Returns details about a specific inbound external or user event.
  • GET /orgs/{orgCode}/operators
    : Returns the list of operator details, including accessible organizations (enterprise and suborganization) and roles.
  • GET /orgs/{orgCode}/operators/{loginId}
    : Returns the operator permissions, roles, and restrictions for the specified login ID.
  • GET /orgs/{orgCode}/users/search/basic
    : Returns user details based on search criteria.
  • POST /orgs/{orgCode}/users/search/advanced
    : Returns user details based on advanced search criteria.
  • GET /orgs/{orgCode}/users/{loginId}/profile
    : Returns basic, distribution list, device, and attribute information for a specified user. Operators must have the correct user roles.
  • POST /orgs/{orgCode}/users/search/alert_users_targeted
    : Returns the details of a specified user based on advanced search criteria.
  • POST /orgs/{orgCode}/users/search/alert_device_coverage
    : Returns active alert device coverage based on advanced search criteria.
  • PUT /orgs/{orgCode}/alerts/{auId}
    : Ends a live alert or updates an alert duration.
  • GET /orgs/{orgCode}/alerts/folders
    : Returns all available folders for the specified organization.
  • GET /orgs/{orgCode}/alerts/{auId}/reports/listsummary
    : Returns a Distribution List Summary report.
  • GET /orgs/{orgCode}/alerts/{auId}/report/alertresponsedetail
    : Returns a Response Details Summary report.
  • GET /orgs/{orgCode}/alerts/{auId}/report/DetailsByUsers
    : Returns a Response Details by User report.
  • GET /orgs/{orgCode}/alerts/{auId}/report/DetailsByUsersDevices
    : Returns a Response Details by User Devices report.
  • GET /orgs/{orgCode}/Users/Roles
    : Returns the user roles for the specified organization.
  • GET /SelfService/{orgCode}/OrgSubscriptions
    : Returns the list of organizations that users can subscribe to.
  • GET /SelfService/{orgCode}/Devices
    : Returns a list of all enabled devices in the organization.
  • GET /SelfService/{orgCode}/{loginId}/Profile
    : Returns profile data for logged-in users.
  • PUT /SelfService/{orgCode}/{loginId}/Profile
    : Updates profile data for logged-in users.
  • GET /SelfService/{orgCode}/{loginId}/OrgSubscriptions
    : Returns the list of subscribed organizations by the user.
  • GET /SelfService/{orgCode}/Attributes
    : Returns all attribute details for the specified common names.
  • POST /SelfService/{orgCode}/{loginId}/OrgSubscriptions/{addOrgCode}
    : Adds or updates an organization subscription to your account.
  • DELETE /SelfService/{orgCode}/{loginId}/OrgSubscriptions/{deleteOrgCode}
    : Deletes the selected organizations from user's organization subscription list.
  • GET /SelfService/{orgCode}/Lists/Static
    : Returns a list of static distribution lists based on PageNo and PageSize.

Modified APIs

  • GET /orgs/{orgCode}/AccountEvents/{eventId}
    :
    • Missing fields were added for Event Details.
    • The Reporting Summary was updated.
    • User Messages and Workflow are included in the event details.
  • No status common name
    : The common name of the user status “no status” was changed to "SYS:NOSTATUS" for the following APIs:
    • GET /orgs/{orgCode}/AccountEvents/{eventId}
    • GET /orgs/{orgCode}/AccountEvents/{eventId}/StatusSummary
    • GET /orgs/{orgCode}/AccountEvents/{eventId}/EventUsers
    • GET /orgs/{orgCode}/AccountEvents/{eventId}/Users/{loginId}
    • PUT /orgs/{orgCode}/AccountEvents/{eventId}/EventUserStatus
  • GET: /orgs/{orgCode}/attributes and GET: /orgs/{orgCode}/attributes/{commonName}
    : The Attributes APIs now contain the UseAsResponseOption and GroupTargeting fields. The UseAsResponseOption field indicates if this attribute can be used as a response option in the Publish Alert API. Valid values are True and False. The GroupTargeting field indicates if this attribute can be used in the Publish Alert API Group Targeting section. Valid values are True and False.
  • GET: /orgs and GET: /orgs/{orgCode}
    : The DeliveryLocalesSupported field was added to the response payload. This field displays the list of delivery locales supported by the organization for alerting content. All valid users can use these APIs. Previously, only Organization Administrators, Enterprise Administrators, and Connect Agreement Managers could use them.
  • Distribution Lists
    : The Distribution Lists APIs now returns only distribution lists that the user has permissions to manage or publish to by default. The AllowedToManage and AllowedToPublish fields were added to indicate the permissions. The following APIs are affected:
    • GET /orgs/{orgCode}/lists
    • GET /orgs/{orgCode}/lists/static
    • GET /orgs/{orgCode}/lists/dynamic
  • GET /orgs/{orgCode}/users
    : Returns a list of users based on offset and limit. The default value is 1. The maximum value is 100.
  • GET /orgs/{orgCode}/attachments/{guid}
    : If an alert or accountability event or template contains attachments, the response now contains the GUID for those attachments instead of the complete body as a Base64 string. The GUIDs can be queried using the following Attachments APIs:
    • GET /orgs/{orgCode}/alerttemplates
    • GET /orgs/{orgCode}/AccountEvents/{eventId}
    • GET /orgs/{orgCode}/alerttemplates/{templateCommonName}
  • GET /orgs/{orgCode}/Alerts
    : New fields were added which are helpful for pagination and to enable Enterprise Administrators to see sent alerts from the suborganizations in their enterprise organization.
  • POST /orgs/{orgCode}/Alerts
    : Support was added to override more template fields and sections such as Attachment, FillCountEscalation, and TargetUsers.
  • GET /orgs/{orgCode}/alerttemplates
    : This API's response now includes the IsAvailableForMobile field.
  • GET /orgs/{orgCode}/alerttemplates/{templateCommonName}
    : This API's response now includes the following fields: IsAvailableForMobile, TargetCriteria, TargetDependents, and DeviceDeliveryPrefs.
  • Operator access
    : The following APIs were modified so that any operator with a valid access token can access them:
    • GET /orgs/{orgCode}/attributes
    • GET /orgs/{orgCode}/attributes/{commonName}
    • GET /devices
    • GET /devices/{deviceId}
    • GET /orgs/{orgCode}/devices
    • GET /orgs/{orgCode}/massdevices
    • GET /orgs/{orgCode}/lists
    • GET /orgs/{orgCode}/lists/static
    • GET /orgs/{orgCode}/lists/dynamic
    • GET /orgs/{orgCode}/lists/static/NestedLists
    • GET /orgs/{orgCode}/alert/Types
    • GET /orgs/{orgCode}/alert/Severity
  • Authentication flow
    : The API authentication flow was updated so that when a user signs in and provides the organization code for an enterprise or suborganization, the authentication succeeds regardless of which organization (enterprise or suborganization) the user's profile exists in.
  • AtHoc Query Language (AQL)
    :
    • AQL functionality was introduced in the Publish Alert, Get Alert Details, and Get Alert Template Details APIs to support roles, geolocation, and additional datetime flows.
    • AQL functionality was introduced in the User Search APIs to support roles, geolocation, datetime special values, and CSV values in Organizational Hierarchy.

Deprecated APIs

  • POST /orgs/{orgCode}/users/SyncByDisplayNames
    : The SyncByDisplayNames API is deprecated. Use the SyncByCommonNames API instead.