-
Notifications
You must be signed in to change notification settings - Fork 5
GetClientsDetails()
Through this explanation we assume that you have using WHMCS_API;
on the begining of the file
And the API()
class initialized as _api
If needed check the Getting Started page
Jump to the full example
Prototype: public GetClientsDetails.GetClientsDetails GetClientDetails(int ClientID = -1, string ClientEmail = "", bool Stats = false)
Input:
- ClientID: Filter Details for a specific Client ID (optional)
- ClientEmail: Filter Details for a specific Client Email (optional)
- Stats: Gets stats for the specified user (optional [default: false])
Input Note: ClientID or ClientEmail required
Output: GetClientsDetails Model with API Call Result, Client details .Client
and Client Stats .Stats
Exception: "An API Error has Ocurred" witch contains an inner exception with further explanation of the error
To call it just use GetClientsDetails.GetClientsDetails clientDetails = _api.GetClientsDetails(1, Stats: true);
The GetClientDetails model is inside it's own namespace (more info)
The result will be stored in clientInfo variable with the result of the call (it should allways be success) with all the info of the client
WHMCS API Reference: https://developers.whmcs.com/api-reference/getclientsdetails/
PCDev Open Source Development Team 2017