API Format Additional Data

From Openprovider API documentation

(Difference between revisions)
Jump to: navigation, search
(→Format specification > additionalData)
(→Format specification > additionalData)
Line 65: Line 65:
|idnScript
|idnScript
|Optional: Only necessary for IDN domains
|Optional: Only necessary for IDN domains
-
possible values: 'AFR','ALB','ARA','ARG','ARM','ASM','AST','AVE','AWA','AZE','BAN','BAL','BAS','BAK','BAQ','BEL','BEN','BHO','BOS','BUL','BUR','CAR', 'CAT','CHE','CHI','CHV','COP','COS','SCR','CZE','DAN','DIV','DOI','DUT','ENG','EST','FAO','FIJ','FIN','FRE','FRY','GLA','GEO','GER','GON','GRE','GUJ','HEB', 'HIN','HUN','ICE','INC','IND','INH','GLE','ITA','JPN','JAV','KAS','KAZ','KHM','KIR','KOR','KUR','LAO','LAV','LIT','LTZ','MAC','MAL','MAY','MLT','MAO','MOL', 'MON','NEP','NOR','ORI','OSS','PAN','PER','POL','POR','PUS','RAJ','RUM','RUS','SMO','SAN','SRD','SCC','SCR','SND','SIN','SLO','SLV','SOM','SPA','SWA','SWE',  'SYR','TGK','TAM','TEL','THA','TIB','TUR','UKR','URD','UZB','VIE','WEL','YID'
+
possible values:  
 +
* 'AFR' (Afrikaans)
 +
* 'ALB' (Albanian)
 +
* 'ARA' (Arabic)
 +
* 'ARG' (Aragonese)
 +
* 'ARM' (Armenian)
 +
* 'ASM' (Assamese)
 +
* 'AST' (Asturian)
 +
* 'AVE' (Avestan)
 +
* 'AWA' (Awadhi)
 +
* 'AZE' (Azerbaijani)
 +
* 'BAN' (Balinese)
 +
* 'BAL' (Baluchi)
 +
* 'BAS' (Basa)
 +
* 'BAK' (Bashkir)
 +
* 'BAQ' (Basque)
 +
* 'BEL' (Belarusian)
 +
* 'BEN' (Bengali)
 +
* 'BHO' (Bhojpuri)
 +
* 'BOS' (Bosnian)
 +
* 'BUL' (Bulgarian)
 +
* 'BUR' (Burmese)
 +
* 'CAR' (Carib)
 +
* 'CAT' (Catalan)
 +
* 'CHE' (Chechen)
 +
* 'CHI' (Chinese)
 +
* 'CHV' (Chuvash)
 +
* 'COP' (Coptic)
 +
* 'COS' (Corsican)
 +
* 'SCR' (Croatian)
 +
* 'CZE' (Czech)
 +
* 'DAN' (Danish)
 +
* 'DIV' (Divehi)
 +
* 'DOI' (Dogri)
 +
* 'DUT' (Dutch)
 +
* 'ENG' (English)
 +
* 'EST' (Estonian)
 +
* 'FAO' (Faroese)
 +
* 'FIJ' (Fijian)
 +
* 'FIN' (Finnish)
 +
* 'FRE' (French)
 +
* 'FRI' (Frisian)
 +
* 'GLA' (Gaelic)
 +
* 'GEO' (Georgian)
 +
* 'GER' (German)
 +
* 'GON' (Gondi)
 +
* 'GRE' (Greek)
 +
* 'GUJ' (Gujarati)
 +
* 'HEB' (Hebrew)
 +
* 'HIN' (Hindi)
 +
* 'HUN' (Hungarian)
 +
* 'ICE' (Icelandic)
 +
* 'INC' (Indic)
 +
* 'IND' (Indonesian)
 +
* 'INH' (Ingush)
 +
* 'GLE' (Irish)
 +
* 'ITA' (Italian)
 +
* 'JPN' (Japanese)
 +
* 'JAV' (Javanese)
 +
* 'KAS' (Kashmiri)
 +
* 'KAZ' (Kazakh)
 +
* 'KHM' (Khmer)
 +
* 'KIR' (Kirghiz)
 +
* 'KOR' (Korean)
 +
* 'KUR' (Kurdish)
 +
* 'LAO' (Lao)
 +
* 'LAV' (Latvian)
 +
* 'LIT' (Lithuanian)
 +
* 'LTZ' (Luxembourgisch)
 +
* 'MAC' (Macedonian)
 +
* 'MAL' (Malayalam)
 +
* 'MAY' (Malay)
 +
* 'MLT' (Maltese)
 +
* 'MAO' (Maori)
 +
* 'MOL' (Moldavian)
 +
* 'MON' (Mongolian)
 +
* 'NEP' (Nepali)
 +
* 'NOR' (Norwegian)
 +
* 'ORI' (Oriya)
 +
* 'OSS' (Ossetian)
 +
* 'PAN' (Panjabi)
 +
* 'PER' (Persian)
 +
* 'POL' (Polish)
 +
* 'POR' (Portuguese)
 +
* 'PUS' (Pushto)
 +
* 'RAJ' (Rajasthani)
 +
* 'RUM' (Romanian)
 +
* 'RUS' (Russian)
 +
* 'SMO' (Samoan)
 +
* 'SAN' (Sanskrit)
 +
* 'SRD' (Sardinian)
 +
* 'SCC' (Serbian)
 +
* 'SND' (Sindhi)
 +
* 'SIN' (Sinhalese)
 +
* 'SLO' (Slovak)
 +
* 'SLV' (Slovenian)
 +
* 'SOM' (Somali)
 +
* 'SPA' (Spanish)
 +
* 'SWA' (Swahili)
 +
* 'SWE' (Swedish)
 +
* 'SYR' (Syriac)
 +
* 'TGK' (Tajik)
 +
* 'TAM' (Tamil)
 +
* 'TEL' (Telugu)
 +
* 'THA' (Thai)
 +
* 'TIB' (Tibetan)
 +
* 'TUR' (Turkish)
 +
* 'UKR' (Ukrainian)
 +
* 'URD' (Urdu)
 +
* 'UZB' (Uzbek)
 +
* 'VIE' (Vietnamese)
 +
* 'WEL' (Welsh)
 +
* 'YID' (Yiddish)
|-
|-
|colspan="2" style="background-color:#EEEEEE;"|'''.org'''
|colspan="2" style="background-color:#EEEEEE;"|'''.org'''

Revision as of 11:40, 8 June 2016

Format specification > additionalData

Overview of which additional data is required per TLD. Mandatory fields are in bold.

value content
.id.au, com.au, .net.au, .org.au
eligibilityTypeRelationship This indicates the relationship between the Eligibility Type (e.g. business name#) and domain name. Specify the Policy reference number as appropriate from the values below.

Possible values:

  • '1' (2LD Domain name is an exact match, an acronym or abbreviation of the company or trading name, organisation or association name, or trademark)
  • '2' (2LD Domain Name is closely and substantially connected to the organisation or activities undertaken by the organisation.)
eligibilityType Specify what makes the registrant eligible to register the .com.au, .net.au, .org.au or .id.au domain name.

Possible values:

  • 'Company'
  • 'RegisteredBusiness'
  • 'SoleTrader'
  • 'Partnership'
  • 'TrademarkOwner'
  • 'PendingTMOwner'
  • 'CitizenResident'
  • 'IncorporatedAssociation'
  • 'Club'
  • 'NonProfitOrganisation'
  • 'Charity'
  • 'TradeUnion'
  • 'IndustryBody'
  • 'CommercialStatutoryBody'
  • 'PoliticalParty'
  • 'Other'
  • 'Non-profit'
  • 'Organisation'
  • 'Charity'
  • 'Citizen/Resident'
.ca
legalType possible values:
  • 'ABO' (Aboriginal Peoples indigenous to Canada)
  • 'ASS' (Canadian Unincorporated Association)
  • 'CCO' (Corporation (Canada or Canadian province or territory))
  • 'CCT' (Canadian citizen)
  • 'EDU' (Canadian Educational Institution)
  • 'GOV' (Government or government entity in Canada)
  • 'HOP' (Canadian Hospital)
  • 'INB' (Indian Band recognized by the Indian Act of Canada)
  • 'LAM' (Canadian Library, Archive or Museum)
  • 'LGR' (Legal Rep. of a Canadian Citizen or Permanent Resident)
  • 'MAJ' (Her Majesty the Queen)
  • 'OMK' (Official mark registered in Canada)
  • 'PLT' (Canadian Political Party)
  • 'PRT' (Partnership Registered in Canada)
  • 'RES' (Permanent Resident of Canada)
  • 'TDM' (Trade-mark registered in Canada (by a non-Canadian owner))
  • 'TRD' (Canadian Trade Union)
  • 'TRS' (Trust established in Canada)
.com, .net
idnScript Optional: Only necessary for IDN domains

possible values:

  • 'AFR' (Afrikaans)
  • 'ALB' (Albanian)
  • 'ARA' (Arabic)
  • 'ARG' (Aragonese)
  • 'ARM' (Armenian)
  • 'ASM' (Assamese)
  • 'AST' (Asturian)
  • 'AVE' (Avestan)
  • 'AWA' (Awadhi)
  • 'AZE' (Azerbaijani)
  • 'BAN' (Balinese)
  • 'BAL' (Baluchi)
  • 'BAS' (Basa)
  • 'BAK' (Bashkir)
  • 'BAQ' (Basque)
  • 'BEL' (Belarusian)
  • 'BEN' (Bengali)
  • 'BHO' (Bhojpuri)
  • 'BOS' (Bosnian)
  • 'BUL' (Bulgarian)
  • 'BUR' (Burmese)
  • 'CAR' (Carib)
  • 'CAT' (Catalan)
  • 'CHE' (Chechen)
  • 'CHI' (Chinese)
  • 'CHV' (Chuvash)
  • 'COP' (Coptic)
  • 'COS' (Corsican)
  • 'SCR' (Croatian)
  • 'CZE' (Czech)
  • 'DAN' (Danish)
  • 'DIV' (Divehi)
  • 'DOI' (Dogri)
  • 'DUT' (Dutch)
  • 'ENG' (English)
  • 'EST' (Estonian)
  • 'FAO' (Faroese)
  • 'FIJ' (Fijian)
  • 'FIN' (Finnish)
  • 'FRE' (French)
  • 'FRI' (Frisian)
  • 'GLA' (Gaelic)
  • 'GEO' (Georgian)
  • 'GER' (German)
  • 'GON' (Gondi)
  • 'GRE' (Greek)
  • 'GUJ' (Gujarati)
  • 'HEB' (Hebrew)
  • 'HIN' (Hindi)
  • 'HUN' (Hungarian)
  • 'ICE' (Icelandic)
  • 'INC' (Indic)
  • 'IND' (Indonesian)
  • 'INH' (Ingush)
  • 'GLE' (Irish)
  • 'ITA' (Italian)
  • 'JPN' (Japanese)
  • 'JAV' (Javanese)
  • 'KAS' (Kashmiri)
  • 'KAZ' (Kazakh)
  • 'KHM' (Khmer)
  • 'KIR' (Kirghiz)
  • 'KOR' (Korean)
  • 'KUR' (Kurdish)
  • 'LAO' (Lao)
  • 'LAV' (Latvian)
  • 'LIT' (Lithuanian)
  • 'LTZ' (Luxembourgisch)
  • 'MAC' (Macedonian)
  • 'MAL' (Malayalam)
  • 'MAY' (Malay)
  • 'MLT' (Maltese)
  • 'MAO' (Maori)
  • 'MOL' (Moldavian)
  • 'MON' (Mongolian)
  • 'NEP' (Nepali)
  • 'NOR' (Norwegian)
  • 'ORI' (Oriya)
  • 'OSS' (Ossetian)
  • 'PAN' (Panjabi)
  • 'PER' (Persian)
  • 'POL' (Polish)
  • 'POR' (Portuguese)
  • 'PUS' (Pushto)
  • 'RAJ' (Rajasthani)
  • 'RUM' (Romanian)
  • 'RUS' (Russian)
  • 'SMO' (Samoan)
  • 'SAN' (Sanskrit)
  • 'SRD' (Sardinian)
  • 'SCC' (Serbian)
  • 'SND' (Sindhi)
  • 'SIN' (Sinhalese)
  • 'SLO' (Slovak)
  • 'SLV' (Slovenian)
  • 'SOM' (Somali)
  • 'SPA' (Spanish)
  • 'SWA' (Swahili)
  • 'SWE' (Swedish)
  • 'SYR' (Syriac)
  • 'TGK' (Tajik)
  • 'TAM' (Tamil)
  • 'TEL' (Telugu)
  • 'THA' (Thai)
  • 'TIB' (Tibetan)
  • 'TUR' (Turkish)
  • 'UKR' (Ukrainian)
  • 'URD' (Urdu)
  • 'UZB' (Uzbek)
  • 'VIE' (Vietnamese)
  • 'WEL' (Welsh)
  • 'YID' (Yiddish)
.org
idnScript Optional: Only necessary for IDN domains

possible values: 'ZH-TW','ZH-CN','DA','DE','HU','IS','KO','LV','LT','PL','ES','SV','BS','BG','BE','MK','RU','SR','UK'

.us
nexusAppPurpose This field is mandatory.

Enter one of the following purposes: P1 - Business use for profit; P2 - Non-profit business, club, association, religious organization, etc; P3 - Personal use; P4 - Education purposes; P5 - Government purposes;

.xxx
defensive This field is optional, should be set to 1 to block domain (defensive registration by non-member of the "Sponsored Community")
.voto
votoAcceptance This field is required, should be set to 1 to confirm acceptance of .voto registry policies
.vote
voteAcceptance This field is required, should be set to 1 to confirm acceptance of .vote registry policies
.scot, .eus, .gal
intendedUse This field is required, should contain information on how the domain name will be used
idnScript Optional: Only necessary for IDN domains

possible values: 'Latn'

domainNameVariants This field is optional, should be an array of strings, representing appropriate domain variant names
.شبكة (xn--ngbc5azd), .موقع (xn--4gbrim)
idnScript Mandatory for IDN domains

possible values: 'ar'

.cайт (xn--80aswg), .онлайн (xn--80asehdb)
idnScript Mandatory for IDN domains

possible values: 'Cyrl'

.democrat, .dance, .ninja, .social, .futbol, .reviews, .pub, .moda, .consulting, .rocks, .actor, .republican, .attorney, .lawyer, .airforce, .vet, .army, .navy, .mortgage, .market, .engineer, .software, .auction, .dentist, .rehab, .gives, .degree, .forsale, .rip, .band
idnScript Optional: Only necessary for IDN domains

possible values: 'fr','es'

.immobilien, .kaufen, .haus
idnScript Optional: Only necessary for IDN domains

possible values: 'fr','es','de'

.nrw
idnScript Optional: Only necessary for IDN domains

possible values: 'de'

.орг (xn--c1avg)
idnScript Mandatory for IDN domains

possible values: 'ru'

.机构 (xn--nqv7f)
idnScript Mandatory for IDN domains

possible values: 'ZH-TW','ZH-CN'

.संगठन (xn--i1b6b1a6a2e)
idnScript Mandatory for IDN domains

possible values: 'hin-deva'

Retrieved from "https://doc.openprovider.eu/API_Format_Additional_Data"
Views
Personal tools