

# Locale


## Description


 The Locale data structure represents a geographical region or location. 

 The Locale data structure is used as part of the [ QualificationRequirement](ApiReference_QualificationRequirementDataStructureArticle.md) data structure when you specify a requirement based on the locale Qualification, and as part of the [Qualification](ApiReference_QualificationDataStructureArticle.md) 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**  
 Currently, a Locale data structure only supports the `Country` field and `Subdivision` field. Please note that subdivisions or states are only available for the United States of America. 

## 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. 


| Name | Description | Required | 
| --- | --- | --- | 
|   `Country`   |  The country of the locale.  Type: A valid [ ISO 3166 country code](https://www.iso.org/iso-3166-country-codes.html). For example, the code **US** refers to the United States of America.  Default: none  |  Yes  | 
|   `Subdivision`   |  The state or subdivision of the locale.  Type: Type: A valid ISO 3166-2 subdivision code. For example, the code CA refers to the state of California  Default: none  |  No  | 

## Example


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

```
LocaleValue:{
  Country:"US"
}
```

## Example


 The following code sample indicates a locale in the state of California in the United States of America. 

```
LocaleValue:{
  Country:"US",
  Subdivision:"CA"
}
```