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 you specify a requirement based on the locale Qualification, and as part of the Qualification data structure that describes 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.

Elements

The Locale structure can contain the elements described in the following table. When the structure is used in a request, elements described as Required must be included for the request to succeed.

NameDescriptionRequired

Country

The country of the locale

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

Default: none

Yes

Example

The following code sample indicates a locale in the United States.

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