Equiptrack products and services are based only on information supplied to Equiptrack. Equiptrack does not have the complete history of every unique piece of equipment. Use the Equiptrack search as one important tool, along with an equipment inspection and functional check, to make a better decision about purchasing your next piece of used medical equipment.
The Basics
The Equiptrack Recall Sentry API provides programmatic access to Equiptrack data and functionality, allowing developers to build custom features to do things like extend Work Orders to include tasks related to recalled equipment and augment RTLS systems for improved recall management.
To use the Recall Sentry API, you need to register as a Equiptrack Partner. Once you have an account and are logged in, you can get an API key and begin making calls to the API.
Recall Sentry API Process
1). Register as a Partner
Fill out our simple Partner Sign Up form here and touch base with the Team so that we can discuss your specific API requirements.
2). API Access
Equiptrack will send a contract for API access based on your business and client needs.
3). API Partner Role
After the contract is finalized, the Partner will be assigned a special Recall Sentry API Partner role which grants exclusive access to the Recall records section of the platform.
This API requires authentication via Basic Authentication using `username` and `accesskey`. Ensure valid credentials are included in the request.
4). API Access Key Email
An email is sent to the Partner email address on file which will include the API Access Key. This key serves as a secure credential for accessing and retrieving medical equipment recall records, providing an added layer of security to the process.
Success Response
– **Status Code:** `200 OK`
– **Content-Type:** `application/json`
– **Body:** Returns an array of recall records.
Sample Response
[
{
‘n_equip_id’ => ‘1004’,
‘web_address’ => ‘http://www.accessdata.fda.gov/scripts/cdrh/cfdocs/cfres/res.cfm?id=xxxxx’,
‘recall_number’ => ‘Z-xxxx-20xx’,
‘product_description’ => ‘BD Care Coordination Engine (CCE) Infusion Adapter, Safety Management Software’,
‘recall_class’ => ‘1’,
‘center_classification_dt’ => ‘2025-03-13 00:00:00’,
‘manufacturer_recall_reason’ => ‘Software issue that may result in outdated automated programming request(APR) being sent to the progressive care unit (PCU).’,
‘sn_lot’ => ‘123456789’,
‘sn_lot_range’ => ”,
‘sw_revorunit_config’ => ‘Systems with Software: v1.7.2’,
‘udi’ => ‘10885403510472’,
‘subassembly_name’ => ‘Software’,
‘reported_issue’ => ‘Software issue that may result in outdated automated programming request(APR) being sent to the progressive care unit (PCU).’,
‘recall_cust_actions_summary’ => ‘1. Users should review all infusion parameters pre-populated and confirm they are correct before pressing START as stated in the BD Alaris User Manual.<br><br>2. Disseminate this notice within your facility network to ensure that all concerned personnel are made aware of this issue.<br><br>3. BD Project Managers will engage with you to address any questions regarding this notice, and specific next steps for your facility.<br><br>4. Complete the attached Customer Response Form and return to the BD contact noted on the form, regardless of whether you have any of the impacted material. This will allow BD to confirm receipt of this notification.<br><br>5. Report any adverse health consequences experienced with the use of this product to BD. Events may also be reported to the FDA\’s MedWatch Adverse Event Reporting program.
}
]
Error Handling
In case of wrong credentials ( username or password ) API will respond as follows
{
“code”: “invalid_username”,
“message”: “<strong>Error:</strong> Unknown username. Check again or try your email address.”,
“data”: {
“status”: 401
}
}
{
“code”: “incorrect_password”,
“message”: “The provided password is an invalid application password.”,
“data”: {
“status”: 401
}
}
NOTE: in some cases, Recalls may not be shown on a particular date due to no medical equipment recalls being entered and classified on the FDA site over that time period.
Error Response
{
“code”: “fda_match_error”,
“message”: “An error occurred while processing the FDA match data”,
“data”: {
“status”: 500
}
}
API Versions
The Recall Sentry API is currently on version 1.0.
API structure
The Recall Sentry API generally follows REST conventions, with some deviations.
* Resources are typically nouns like subscribers or campaigns.
* Subresources can be multiply nested under resources.
* Actions are usually represented by HTTP methods. Actions that do not correspond to HTTP methods are collected under an actions/ subresource.
* Responses use the generic JSON content type.
We use the OpenAPI Specification (formerly known as Swagger) to describe each endpoint. The API self-description also contains type information to help you error-check your requests.
What is an API Key?
An API (Application Programming Interface) key is a way for applications to connect and work with your account without you having to enter a password. Programs can then work together behind the scenes to complete tasks.
How to locate your Equiptrack API Key
If you have misplaced your API Key, please contact Equiptrack and we can resend your key via your Partner email.
User API access
API authentication is tied to the Partner that created the API key. If the Partner is removed from the account, that authentication token will be revoked.
Attempts to perform an API action that aren’t permitted for the role will return a 403 error.
Note: You are responsible for the security of API keys/tokens; we recommend that you store them in a secure location.
