Policies
Understand Location Intelligence API policies
Overview
Moody's RMS has the following security, versioning, and deprecation policies.
Security policy
Moody's RMS encrypts all calls to and from RMS Intelligent Risk Platform™, including all requests and responses that use the Location Intelligence API.
Access to the Intelligent Risk Platform is controlled by means of API keys and security tokens. Every request to an Moody's RMS API must provide either a valid API key or security token or the request will be rejected.
API keys and access tokens enable RMS to ensure that the correct licensing, access control, and other tenant-specific customizations are in place. To learn more, see Authentication and Authorization.
Versioning policy
Moody's RMS makes periodic updates to models based on new science, changing scientific consensus, or a better understanding of perils. Changes to models may trigger updates to data products made available through Location Intelligence API resources.
The Location Intelligence API does not update version numbers for the following changes:
- Additions of new operation endpoints
- Changes to the default or optional request parameters
- Changes to the attributes that must be specified in a request
- Changes to the attributes returned in a response
Updates to Location Intelligence API resources are recorded in the Changelog.
Data product versions
For purposes of business continuity, Location Intelligence API may support multiple versions of the same data product simultaneously. For example, the Location Intelligence API may expose version 18.0 and 18.1 of the US Convective Storm Loss Cost data product.
Each data product version is represented by a unique resource, e.g. /li/us_cs_loss_cost/18.0
and /li/us_cs_loss_cost/18.1
.
The layer path identifies the layer, which identifies the Location Intelligence data product. The version path identifies the version of the data product.
For each data product, the Location Intelligence API exposes a resource that accesses the most recent version of the data product. This resource substitutes the string latest in place of data product version, e.g. /li/us_cs_loss_cost/latest
. This resource is an alias for /li/us_cs_loss_cost/18.1
when the most recent version of the US Severe Convection Storm Loss Cost data product is version 18.1. The latest resource will always use the most recent version of a data product.
Deprectation policy
In general, Location Intelligence deprecates resources that are older than one update and retires Location Intelligence resources that have deprecated for at least one year.
- A deprecated resource returns the requested data, and a response header that states that the resource is deprecated. The deprecated resource remains accessible for one year.
- A retired resource returns a
410 Gone
HTTP status code.
Neither deprecated or retired resources are documented in the Moody's RMS Developer Portal.
Updated over 1 year ago