System
AirBands DynaMo ForceDecks ForceFrame HumanTrak NordBord SmartJump SmartSpeed TeleHab VALD Hub
Contact us

Search

Updating from DashBord (DB) API - Breaking Changes

Liesl Thrum
  • Updated

As mentioned in API Updates February 2024 - Breaking Changes, DashBord (DB) API is being decommissioned and replaced with scope-specific APIs.

To utilise the new APIs, you must modify your existing API process. The method of migration will depend on the version of DashBord API you previously employed.

DB API v2018q3

This version of DashBord API uses a no longer supported identifier for both TeamId and AthleteId. These identifiers use integers instead of GUIDs.

These identifiers do not directly map with any of the latest versions of our APIs.
DB API v2019q2 This version of DashBord API uses the current identifiers for both TeamId and AthleteId, and contains endpoints which can be leveraged to migrate from the old identifiers to the new.
DB API v2021q2 This version of DashBord API uses the current identifiers for both TeamId and AthleteId.

If you are currently utilising older versions of the DashBord API, you will need to do the following:

Convert your old identifiers

  1. Call v2019q2/teams/.
    1. This will list all teams you have access to.
    2. The response will contain the below fields. Use the response to determine the new identifier based off the old identifier.
Id This is the new identifier (GUID) for the Team.
LegacyId This is the old identifier (int) for the Team.
  1. Call v2019q2/teams/{teamid}/athletes (Where {teamid} is the new identifier).
    1. This will list all athletes for the team.
    2. The response will contain the following fields.
Id This is the new identifier (GUID) for the Athlete.
LegacyId This is the old identifier (int) for the Athlete.
  1. Call v2019q2/teams/{teamid}/tests (Where {teamid} is the new identifier).
    1. This will list all tests for the team.
    2. The response will contain the following fields.
Id This is the new identifier (GUID) for the Test.
TestId This is the old identifier (int) for the Test.

Map your new identifiers to new APIs

DashBord API was historically used to retrieve tenant (Team), profile (Athlete), as well as NordBord and ForceFrame data. While DashBord API will no longer be available, this data can still be retrievable through the following new APIs.

New API Existing DashBord API endpoints
External Tenant
  • /teams
  • /teams/{teamId}
  • /teams/{teamId}/groups
External Profile
  • /teams/{teamId}/athletes
  • /teams/{teamId}/athletes/externalid
  • /teams/{teamId}/athletes/{profileId}
  • /teams/{teamId}/athletes/{profileId}/externalid
External ForceFrame
  • /teams/{teamId}/tests/{page}
  • /teams/{teamId}/athletes/{profileId}/tests/{dateFrom}
    /{dateTo}/{page}
  • /teams/{teamId}/tests/{dateFrom}/{dateTo}/{page}
  • /teams/{teamId}/tests/{testId}/forceframetrace
  • /tests/{testId}
External NordBord
  • /teams/{teamId}/tests/{page}
  • /teams/{teamId}/athletes/{profileId}/tests/{dateFrom}
    /{dateTo}/{page}
  • /teams/{teamId}/tests/{dateFrom}/{dateTo}/{page}
  • /teams/{teamId}/tests/{testId}/nordbordtrace
  • /tests/{testId}

Comments

0 comments

Please sign in to leave a comment.

Related articles