A guide to using the External NordBord API

This guide is intended to provide instructions on how to interact with and use the External NordBord API.

The External NordBord API can be utilised to access team and athlete test data.

• Identify your region
• Scenario 1: Retrieve a collection of tests for a tenant
• Scenario 2: Retrieve a single test
• Scenario 3: Retrieve a NordBord force trace associated with a single test

Identify your region

The endpoint you use to interact with the External NordBord API is dependant on what region you (the client) reside in.

Please note that only tenant data which resides within the region of the API endpoint used is accessible. Therefore, if a tenant's data resides in Australia (East), it will only be accessible from that region's API.

Choose your region below and copy the endpoint URL provided.

If you are unsure which region-specific URL you should be using, please contact support@vald.com.

Scenario 1: Retrieve a collection of tests for a tenant

Details

Description

1. Set the required parameters.
   1. Ensure the testFromUtc and testToUtc are within six months of each other.
   2. Use the modifiedFromUtc as a mechanism to refine the tests down further. If unsure, set this parameter to be equal to testFromUtc.
   3. Set page equal to 1.
2. Retrieve a page of data using

   /tests?TenantId={tenantId}&ModifiedFromUtc={modifiedFromUtc}&TestFromUtc={testFromUtc}&TestToUtc={testToUtc}&Page={page}

3. Increment the page parameter.
4. Repeat steps 2 - 3 until a No Content 204 status code is returned.

Note: Tests are returned in descending order of test date (i.e. newest to oldest).

Response

Below is a sample response you would expect to see.

{
  "tests": [
    {
      "athleteId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "testId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "modifiedUtc": "2024-02-20T23:59:07.756Z",
      "testDateUtc": "2024-02-20T23:59:07.756Z",
      "testTypeId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "testTypeName": "string",
      "notes": "string",
      "device": "string",
      "leftAvgForce": 0,
      "leftImpulse": 0,
      "leftMaxForce": 0,
      "leftTorque": 0,
      "leftCalibration": 0,
      "rightAvgForce": 0,
      "rightImpulse": 0,
      "rightMaxForce": 0,
      "rightTorque": 0,
      "rightCalibration": 0,
      "leftRepetitions": 0,
      "rightRepetitions": 0
    }
  ],
  "page": 1,
  "pageCount": 1
}

Scenario 2: Retrieve a single test

Details

Description

Use to retrieve summary information about a test.

Response

Below is a sample response you would expect to see.

{
  "athleteId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "testId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "modifiedUtc": "2024-02-20T23:59:53.820Z",
  "testDateUtc": "2024-02-20T23:59:53.820Z",
  "testTypeId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "testTypeName": "string",
  "notes": "string",
  "device": "string",
  "leftAvgForce": 0,
  "leftImpulse": 0,
  "leftMaxForce": 0,
  "leftTorque": 0,
  "leftCalibration": 0,
  "rightAvgForce": 0,
  "rightImpulse": 0,
  "rightMaxForce": 0,
  "rightTorque": 0,
  "rightCalibration": 0,
  "leftRepetitions": 0,
  "rightRepetitions": 0
}

Scenario 3: Retrieve a NordBord force trace associated with a single test

Details

Description

Use to retrieve a NordBord force trace.

Response

Below is a sample response you would expect to see.

{
  "athleteId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "testId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "testTypeId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "testTypeName": "string",
  "forces": [
    {
      "ticks": 0,
      "leftForce": 0,
      "rightForce": 0
    }
  ],
  "device": "string",
  "testDateUtc": "2024-02-21T00:00:07.953Z",
  "notes": "string"
}