Overview

Use this endpoint to retrieve the details of a specific SOS monitoring version.

The version detail focuses on the differences associated with the selected version compared with its previous version.

This endpoint is useful when your application needs to understand what changed, rather than retrieving the complete SOS object.

Example

Consider the following simplified SOS history:

Version 1
Status: Active
Address: Address A

        ↓ Change detected

Version 2
Status: Active
Address: Address B

The Version Detail for Version 2 identifies the relevant change between Version 1 and Version 2, rather than requiring the consumer to compare two complete SOS responses.

When Should I Use This API?

Use Version Detail when you need to:

• Determine what changed in a particular version.
• Display changes in your application.
• Process only changed information.
• Understand the transition between consecutive SOS versions.

Version Detail vs. Snapshot

Use Version Detail when the question is:

What changed?

Use Version Snapshot when the question is:

What did the complete SOS record look like at this version?

Related APIs

Use List SOS Versions first if you need to determine which versions are available.

Use Version Snapshot if you need the complete SOS object for the selected version.