WHMCS / developer-docs

Developer documentation portal content
72 stars 114 forks source link

Incomplete / Wrong Documentation for API Command "DomainGetWhoisInfo" #282

Open KaiSchwarz-cnic opened 1 year ago

KaiSchwarz-cnic commented 1 year ago

Hi all! -> https://github.com/WHMCS/developer-docs/blob/master/api-reference/domaingetwhoisinfo.md

wrong Response Parameters

missing Response Parameters

Also: Response Parameters that are optionally returned, should be marked as such, otherwise it is leaving questions e.g.: Is Registrant always returned? Are Billing, Technical & Admin are optional?

Example Response JSON

current:

{
    "result": "success",
    "Registrant": "{\"First_Name\":\"Test\",\"Last_Name\":\"Client\",\"Organisation_Name\":null,\"Job_Title\":null,\"Email\":\"test@testemail.com\",\"Address_1\":\"123 Test Street\",\"Address_2\":\"\",\"City\":\"Test\",\"State\":\"Test\",\"Postcode\":\"TE5 5ST\",\"Country\":GB,\"Phone\":\"+44.1234567890\"}"
}

to patch:

In addition, it would be great having the above escaped contact data fields documented in a table-way as well for better readability.

Thanks!