Location

The location object is used to determine the user's location. It returns a list of countries or regions. Please note that all country/ region codes are case sensitive

A country object contains the following fields:

code A country code e.g. "US"
name the full name of the country e.g. "United States"

Sample Country XML

<country>
    <code>US</code>
    <name>United states</name>
</country>

A region object contains the following fields:

 
code A region code e.g. "US-CA"
name the full name of the region e.g. "California"
country the country code to which this region belongs e.g. "US"

Sample Region XML

<region>
    <code>US-CA</code>
    <name>California</name>
    <country>us</country>
</region>

Supported methods

Countries

Method countries
Description Returns a list of all supported countries on checklist.com
URL https://api.checklist.com/rest/v1/locations/countries [GET]
Authentication required
Parameters
Response A list of country objects
Errors 401UnAuthorized - returned if not authorized to perform this action
Throttling This method is only allowed to commercial licenses

Regions

Method regions list
Description Returns a list of all supported regions on checklist.com
URL https://api.checklist.com/rest/v1/locations/regions [GET]
Authentication required
Parameters
Response A list of region objects
Errors 401UnAuthorized - returned if not authorized to perform this action
Throttling This method is only allowed to commercial licenses

Regions By Country

Method regions list by country
Description Returns a list of all supported regions for a specific country
URL https://api.checklist.com/rest/v1/locations/regions/{countryCode} [GET]
Authentication required
Parameters countryCodethe country code to filter by (e.g. US)
Response A list of region objects
Errors 401UnAuthorized - returned if not authorized to perform this action
Throttling This method is only allowed to commercial licenses
* - optional parameter.