Although all parameters are sent as strings over HTTP, we have specified the types of parameters used in the HTTP API requests to help you identify the values that can be passed.
-
Boolean: Possible values are true or false.
Example: ?variable=true -
Integer: Possible values are positive whole numbers.
Example: ?variable=1234 -
Float: Possible values are positive numbers with a decimal component.
Example: ?variable=12.34 -
String: Possible values are context-dependent sequence of characters.
Example: ?variable=abc123.com -
Array: Possible values are any context-dependent collection of values of the same type. Arrays are specified by assigning different values of the same type to the same parameter name multiple times. The order in which values are assigned does not matter.
Example: ?variable=1&variable=2&variable=3&variable=4 -
Map: Possible values are any collection of name-value pairs where name is of type string and value can be any context-dependent type. Name-value pairs are associated with each other by adding the same numeric suffix to them. The numeric suffix, starts from 1 and is incremented for each subsequent name-value pair.
Example: ?domain-name1=abc.com&nameserver1=abc.example.com&domain-name2=xyz.com&nameserver2=xyz.example.comThis associates abc.example.com with abc.com and xyz.example.com with xyz.com
-
The parameter values in the API calls are case sensitive and must be passed correctly to fetch complete details in the response.
For example, the API call to fetch the details of a Domain Registration Order has a paramater options. Values can be: All, OrderDetails, ContactIds, RegistrantContactDetails, AdminContactDetails, TechContactDetails, BillingContactDetails, NsDetails, DomainStatus, DNSSECDetails.
These values are case sensitive and need to passed in the exact manner as mentioned above.
https://test.httpapi.com/api/domains/details-by-name.json?auth-userid=0&api-key=key&domain-name=yourdomain.com&options=OrderDetails -
For associating extra details with a particular Contact or a domain name, the details must be passed in the API call in the form of attr-name and attr-value pairs. These name-value pairs must be passed sequentially, such as attr-name1=param&attr-value1=value&attr-name2=param&attr-value2=value. Usage such as attr-name1=param&attr-value1=value&attr-name3=param&attr-value3=value is incorrect.
Example:
Correct API call
https://test.httpapi.com/api/contacts/add.json?auth-userid=0&api-key=key&name=abc&company=company&email=urname@domain.com&address-line-1=address1&city=city&country=nn&zipcode=0&phone-cc=0&phone=0&customer-id=0&type=Contact&attr-name1=title&attr-value1={Title of the Contact in the Company}&attr-name2=website&attr-value2={Company Website}Incorrect API call
https://test.httpapi.com/api/contacts/add.json?auth-userid=0&api-key=key&name=abc&company=company&email=urname@domain.com&address-line-1=address1&city=city&country=nn&zipcode=0&phone-cc=0&phone=0&customer-id=0&type=Contact&attr-name1=title&attr-value1={Title of the Contact in the Company}&attr-name3=website&attr-value3={Company Website}