listSupportedLocales

Supports the retrieval of all locales supported by the site.

Client Servlet Server Servlet HTTP Methods Supported Requires Authentication
CRContentAPI SRContentAPI GET, POST Server.

Client API Syntax

https://secure2.convio.net/organization/site/CRContentAPI?method=listSupportedLocales &api_key=value &v=value [ &center_id=value ] [ &error_redirect=value ] [ &redirect=value ] [ &response_format=xml | json ] [ &sign_redirects=value ] [ &source=value ] [ &sub_source=value ] [ &success_redirect=value ] [ &suppress_response_codes=value ]

Server API Syntax

https://secure2.convio.net/organization/site/SRContentAPI?method=listSupportedLocales & api_key =value & login_name =value & login_password =value & v =value [ & center_id =value ] [ & response_format =xml |json ] [ & source =value ] [ & sub_source =value ] [ & suppress_response_codes =value ]

Usage Notes

This method returns a list of the locales supported by the Luminate Online site.

No method-specific parameters are supported by this method.

Client API Parameters

Common Client Parameters

See topic Common Parameters.

Server API Parameters

Common Server Parameters

See topic Common Parameters.

Response

See topic HTTP Status Codes.

XML response
<?xml version="1.0" encoding="UTF-8"?>
<listSupportedLocalesResponse xsi:schemaLocation="http://convio.com/crm/v1.0 http://service.convio.net/xmlschema/crm.public.v1.xsd" xmlns="http://convio.com/crm/v1.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <supportedLocale>
    <fullyQualifiedName>en_US</fullyQualifiedName>
    <displayName>English (United States)</displayName>
    <defaultLocale>true</defaultLocale>
    <country>US</country>
    <displayCountry>United States</displayCountry>
    <language>en</language>
    <displayLanguage>English</displayLanguage>
    <variant/>
    <displayVariant/>
  </supportedLocale>
  <supportedLocale>
    <fullyQualifiedName>en_GB</fullyQualifiedName>
    <displayName>English (United Kingdom)</displayName>
    <defaultLocale>false</defaultLocale>
    <country>GB</country>
    <displayCountry>United Kingdom</displayCountry>
    <language>en</language>
    <displayLanguage>English</displayLanguage>
    <variant/>
    <displayVariant/>
  </supportedLocale>
  <supportedLocale>
    <fullyQualifiedName>en_CA</fullyQualifiedName>
    <displayName>English (Canada)</displayName>
    <defaultLocale>false</defaultLocale>
    <country>CA</country>
    <displayCountry>Canada</displayCountry>
    <language>en</language>
    <displayLanguage>English</displayLanguage>
    <variant/>
    <displayVariant/>
  </supportedLocale>
  <supportedLocale>
    <fullyQualifiedName>fr_CA</fullyQualifiedName>
    <displayName>français (Canada)</displayName>
    <defaultLocale>false</defaultLocale>
    <country>CA</country>
    <displayCountry>Canada</displayCountry>
    <language>fr</language>
    <displayLanguage>français</displayLanguage>
    <variant/>
    <displayVariant/>
  </supportedLocale>
  <supportedLocale>
    <fullyQualifiedName>es_US</fullyQualifiedName>
    <displayName>español (Estados Unidos)</displayName>
    <defaultLocale>false</defaultLocale>
    <country>US</country>
    <displayCountry>Estados Unidos</displayCountry>
    <language>es</language>
    <displayLanguage>español</displayLanguage>
    <variant/>
    <displayVariant/>
  </supportedLocale>
</listSupportedLocalesResponse>

        
JSON response
{"listSupportedLocalesResponse":{"supportedLocale":[{"defaultLocale":"true","displayCountry":"United States","displayVariant":{},"displayLanguage":"English","fullyQualifiedName":"en_US","language":"en","displayName":"English (United States)","variant":{},"country":"US"},{"defaultLocale":"false","displayCountry":"United Kingdom","displayVariant":{},"displayLanguage":"English","fullyQualifiedName":"en_GB","language":"en","displayName":"English (United Kingdom)","variant":{},"country":"GB"},{"defaultLocale":"false","displayCountry":"Canada","displayVariant":{},"displayLanguage":"English","fullyQualifiedName":"en_CA","language":"en","displayName":"English (Canada)","variant":{},"country":"CA"},{"defaultLocale":"false","displayCountry":"Canada","displayVariant":{},"displayLanguage":"français","fullyQualifiedName":"fr_CA","language":"fr","displayName":"français (Canada)","variant":{},"country":"CA"},{"defaultLocale":"false","displayCountry":"Estados Unidos","displayVariant":{},"displayLanguage":"español","fullyQualifiedName":"es_US","language":"es","displayName":"español (Estados Unidos)","variant":{},"country":"US"}]}}

        

Example

https://demo-secure.convio.net/demo829/site/CRContentAPI?api_key=MyAPIKey&v=1.0&method=listSupportedLocales

Leave a Comment

Nickname
Comment
Enter this word: