LocaleResult document (Data API 23.1)

Contains the result of getting the system locales.

Property Type Constraints Description
count Integer   The number of returned documents.
hits [Locale]   The locales found by the request
id String   The input locale (none specifies get all locales)
include_all Boolean   True to get the all the hits for all the locales, not just the active allowed ones
next String   The URL of the next result page.
previous String   The URL of the previous result page.
select String   The string describing the set of fields to return in the result.
start Integer minIntegerValue=0 The zero-based index of the first search hit to include in the result.
total Integer   The total number of documents.
X OCAPI versions 15.x and 16.x will be retired on March 31, 2021. For dates and more information, see the OCAPI versioning and deprecation policy and this Knowledge Article.
X Privacy Update: We use cookies to make interactions with our websites and services easy and meaningful, to better understand how they are used. By continuing to use this site you are giving us your consent to do this. Privacy Policy.