Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
KaiSchwarz-cnic opened this issue Mar 16, 2023 · 0 comments

Comments

@KaiSchwarz-cnic
Copy link

KaiSchwarz-cnic commented Mar 16, 2023

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

wrong Response Parameters

  • current ---> Parameter: Tech, Type: array, Description: The registrant contact details
  • patched --> Parameter: Technical, Type: array, Description: The technical contact details

missing Response Parameters

  • Parameter: message, Type: String, Description: the error message in case result is error (relates to Error Responses)
  • Parameter: Billing, Type: array, Description: The billing contact details

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\":\"[email protected]\",\"Address_1\":\"123 Test Street\",\"Address_2\":\"\",\"City\":\"Test\",\"State\":\"Test\",\"Postcode\":\"TE5 5ST\",\"Country\":GB,\"Phone\":\"+44.1234567890\"}"
}

to patch:

  • Organisation_Name ---> Company_Name
  • Address_1 ---> Address

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

Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant