Validations

Introduction 🔗︎ click to copy

Mydex Data Services CIC provides an API known as the 'Master Reference Data Services' or MRD. This API provides access to a variety of non-personal, general purpose datasets that may be of use when integrating with the rest of the Mydex platform or simply a valuable managed API service for a range of datasets that can be subscribed to.

One of the services provided on the MRD API is the Validations service, sometimes also referred to as the Developer Helpers service.

What are Validations? 🔗︎ click to copy

This service provides JSON endpoints that give insight into the available datasets and fields that exist in the Personal Data Store (by way of the Master Data Schema) and their structure, as well as basic information about the Mydex Template System and Feature Block modules.

It also contains a number of 'Lookup' services, which can be consumed to understand what values are considered acceptable when choosing from a number of options. This includes options such as Marital Status, Gender, Pronouns, Race/Ethnicity, and so on.

Certain aspects of the Mydex PDX API may validate submitted input against these allowed values, so wherever possible and appropriate, Mydex recommends to render options based on these valid options.

How to use the Validations service via the MRD API 🔗︎ click to copy

The Validations service can be accessed freely. Unlike other MRD API services, it does not require an OAuth2.0 client.

To find out more about how to use the Validations service, please see this page.