Locale

Description

The Locale data structure represents a geographical region or location.

The Locale data structure is used as part of the QualificationRequirement data structure when specifying a requirement based on the locale Qualification, and as part of the Qualification data structure describing the value of a locale Qualification.

When used in a QualificationRequirement, the Locale data structure only needs to contain as much of the locale as the Worker needs to match to meet the requirement. For example, a requirement that the Worker be living anywhere in the United States would have only the Country field.

[Note]Note

Currently, a Locale data structure only supports the Country field. A future version of the API may include other aspects of a locale.

Example

The following example indicates a locale in the United States.

<LocaleValue>
  <Country>US</Country>
</LocaleValue>

Elements

The Locale structure may contain the following elements. When the structure is used in a request, elements described as "required" must be included for the request to succeed.

NameDescriptionTypeValue
Country

The country of the locale.

Required

An ISO 3166 country code. For example, the code US refers to the United States of America.