API Format Additional Data
From Openprovider API documentation
 (→Format specification > additionalData)  | 
		 (→Format specification > additionalData)  | 
		||
| Line 10: | Line 10: | ||
|'''eligibilityTypeRelationship'''  | |'''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  | |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)  | * '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.)  | * '2' (2LD Domain Name is closely and substantially connected to the organisation or activities undertaken by the organisation.)  | ||
| Line 16: | Line 16: | ||
|'''eligibilityType'''  | |'''eligibilityType'''  | ||
|Specify what makes the registrant eligible to register the .com.au, .net.au, .org.au or .id.au domain name.  | |Specify what makes the registrant eligible to register the .com.au, .net.au, .org.au or .id.au domain name.  | ||
| - | + | possible values:  | |
* 'Company'  | * 'Company'  | ||
* 'RegisteredBusiness'  | * 'RegisteredBusiness'  | ||
Revision as of 11:26, 8 June 2016
Format specification > additionalData
Overview of which additional data is required per TLD
| 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: 
  | 
| eligibilityType | Specify what makes the registrant eligible to register the .com.au, .net.au, .org.au or .id.au domain name.
 possible values: 
  | 
| .ca | |
| legalType | possible values:
  | 
| .com, .net | |
| idnScript | 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'  | 
| .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'  |