Migration to v1

Version v1.0.0 has some breaking changes which require client-side adaptations. This guide will list the changes made and give tips to adapt client apps.

Base API url

The API is now available at https://api.asi.swiss/api/v1/.

Note the trailing /v1/.

Paginated resources

The response of all resources listing endpoints is now paginated.

Concerned resources: Athlete, ManagerPermissions, Devices, JsonSchema, Activities, TimeFrames

Instead of a single JSON array in the body, response has the following pagination meta.

{
    "count": 1234,
    "page": 1,
    "next": 2,
    "previous": null,
    "results": [
        // a page of results
    ]
}

• count gives you the total number of results for your query
• page gives you the current page number
• next gives you the next page number, or null if there is no remaining page
• previous gives you the previous page number, or null if there is no previous page
• results contains the array of results for this page

You can change page with the page query parameter, for example page=2 fetch the second page.

By default, the page size is 150. You can change the page size with the limit query parameter, but a maximum of 500 items per page is tolerated.

Moreover, preprocessed data listing endpoint, which was already paginated, now use the same pagination meta as described above. Default (and maximum) page size is 10000.

Filtering resource

The following resources can be filtered with theses query parameters

Activity

• name : insensitive contains lookup on name field
• owner : exact match on owner id

Device

• device_name : insensitive contains lookup on device_name field
• serial_number : insensitive contains lookup on serial_number field
• device_type : exact match on device_type field
• activation_time_from : greater than or equal lookup on activation_time field
• activation_time_to : lesser than or equal lookup on activation_time field

Device

• device : exact match on device id
• athlete : exact match on athlete id
• owner : exact match on owner id
• activity : exact match on activity id
• start_time_from : greater than or equal lookup on start_time field
• start_time_to : lesser than or equal lookup on start_time field
• end_time_from : greater than or equal lookup on end_time field
• end_time_to : lesser than or equal lookup on end_time field

Athlete

• email : insensitive contains lookup on email field
• username : insensitive contains lookup on username field
• external_id : insensitive contains lookup on external_id field
• first_name : insensitive contains lookup on first_name field of the athelte profile
• last_name : insensitive contains lookup on last_name field of the athelte profile
• gender : insensitive exact match on gender field of the athelte profile
• managed_by : exact match on managed_by id
• birthdate_from : greater than or equal lookup on birthdate field of the athelte profile
• birthdate_to : lesser than or equal lookup on birthdate field of the athelte profile

Requesting device ownership

Requesting ownership of device is now done on ASI website at https://api.asi.swiss/device-activation/.

You need to be logged in as a manager user. Then fill the form as follow.

• The device's serial number, which you need to enter it manually
• The device name, which will be read from device connected via USB (use the Select device button and choose corresponding device)

Then submit the form, and you will be redirected to a status page, showing if registration is successful or not.

An API endpoint can also be used to take ownership of a device: /take-ownership/.

The /own/ endpoint has been removed.

Device resource updates

• device_id field was confusing, it has been renamed to device_name
• Device resource has less exposed fields, only the following remain:
  • id
  • device_name
  • serial_number
  • device_type
  • firmware_version

WebSockets streaming of preprocessed data

Streaming preprocessed data of a device now require its id (integer), not the device_name.

For example: wss://api.asi.swiss/api/ws/preprocessed-data/1/