This documentation has moved

XML API documentation can now be found at developer.openprovider.com. This page will remain available until September 2026, but will no longer be updated.

The XML API itself is not changing. Your existing integration continues to work.

API Format Additional Data

From Openprovider API documentation

(Difference between revisions)
Jump to: navigation, search
(Format specification > additionalData)
(Format specification > additionalData)
Line 96: Line 96:
|voteAcceptance
|voteAcceptance
|This field is required, should be set to 1 to confirm acceptance of .vote registry policies
|This field is required, should be set to 1 to confirm acceptance of .vote registry policies
 +
|-
 +
|colspan="2" style="background-color:#EEEEEE;"|'''.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
|}
|}

Revision as of 07:17, 18 June 2015

Format specification > additionalData

Overview of which additional data is required per TLD

value content
.id.au, com.au, .net.au, .org.au
eligibilityTypeRelationship possible values:
  • '1'
  • '2'
eligibilityType 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'
  • 'ASS'
  • 'CCO'
  • 'CCT'
  • 'EDU'
  • 'GOV'
  • 'HOP'
  • 'INB'
  • 'LAM'
  • 'LGR'
  • 'MAJ'
  • 'OMK'
  • 'PLT'
  • 'PRT'
  • 'RES'
  • 'TDM'
  • 'TRD'
  • 'TRS'
.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
Views
Personal tools