OS1 Services
Motion Tracking System

MTS API Migration Guide

12min

Introduction

This guide helps you migrate from the Motion Tracking Service APIs to be deprecated by the end of March to the current API versions. Migration will ensure the apps continue to work seamlessly when older APIs are deprecated.

Recommended Steps for Migration

  1. Identify usage: Audit your usage to locate all places you call the deprecated MTS APIs. This is crucial to know what needs to change.
  2. Take note of differences: Review the API documentation to understand the key differences in requests/responses between the old and new API version.
  3. Update endpoints: Update the endpoints your application calls to use the new APIs.
  4. Modify payloads: Based on the documentation, modify request/response payloads to align with the new API spec.
  5. Test thoroughly: Be sure to test end-to-end to detect any issues early. Verify that expected data is still returned.

APIs

Sunset Date

Older APIs will be deprecated by end of March 2024.



Trace

New
Old
  • PUT /mts/track/{trackName}/traces
  • GET /mts/track/{trackName}/traces
  • PUT /mts/track/{trackId}/traces
  • GET /mts/track/{trackId}/traces


Missing Sequence Numbers

New
Old
  • GET /mts/track/{trackName}/missing-sequence
  • GET /mts/track/{trackId}/missing-sequence


Snapped Distance

New
Old
  • GET /mts/track/{trackName}/snapped-distance
  • GET /mts/track/{trackId}/snapped-distance


Geofences

New
Old
  • POST /mts/geofences/
  • PUT /mts/geofences/{geofenceId}
  • DELETE /mts/geofences/{geofenceId}
  • GET /mts/geofences/{geofenceId}
  • PUT /mts/geofences/{geofenceId}/devices
  • GET /mts/geofences/{geofenceId}/devices
  • GET /mts/geofences/{geofenceId}/devices/{deviceId}
  • PUT /mts/geofences/{geofenceId}/devices/{deviceId}/unsubscribe


Subscription

New
Old
  • POST /mts/pubsub/devices/{deviceId}/subscription
  • GET /mts/pubsub/devices/{deviceId}/subscription/{subscriptionId}
  • PUT /mts/pubsub/devices/{deviceId}/subscription/{subscriptionId}/deactivate


Track APIs

The following APIs have been categorized by SIM, GPS, and mobile phones. The previous APIs will be deprecated by the end of March.

Older APIs

To be deprecated in March 2024

  • POST /mts/providers/tracks
  • GET /mts/providers/tracks
  • GET /mts/providers/tracks/{externalRefId}
  • GET /mts/providers/tracks/{trackId}
  • PUT /mts/providers/tracks/{trackId}
  • PUT /mts/providers/tracks/{externalRefId}

New APIs

Developers need to migrate to these new APIs.

SIM
Smart Phones
GPS
  • POST /mts/sim/tracks
  • GET /mts/sim/tracks
  • GET /mts/sim/tracks/{trackId}
  • PUT /mts/sim/tracks/{trackId}
  • GET /mts/sim/tracks/{trackName}
  • PUT /mts/sim/tracks/{trackName}