Client API

Purpose

This API is used to get the list of clients, to add, to modify and to delete the clients.

Get clients API

This API is used to get the list of clients.

Request URL:

https://people.zoho.com/people/api/timetracker/getclients?authtoken=<token>

Request parameter:

authtokenSpecify the authentication token

Example URL:

https://people.zoho.com/people/api/timetracker/getclients?authtoken=7d985878998943g4j09h43dd0b167dda34b

XML response:

<response uri="/api/timetracker/getclients">
<status>0</status>
<message>Data fetched successfully</message>
<result>
<client>
<lastName />
<currencyCode>AFN</currencyCode>
<streetAddr />
<state />
<billingMethod>hourly user rate</billingMethod>
<clientId>281496000000331001</clientId>
<city />
<country>0</country>
<pincode />
<phoneNo />
<compsize>0</compsize>
<emailId />
<description />
<clientName>Google client</clientName>
<faxNo />
<industry />
<firstName />
<mobileNo />
</client>
<client>
<lastName />

JSON response:

{ "response": { "message": "Data fetched successfully", "result": [ { "lastName": "", "currencyCode": "AFN", "streetAddr": "", "state": "", "billingMethod": "hourly user rate", "clientId": "281496000000331001", "city": "", "country": "0", "pincode": "", "phoneNo": "", "compsize": 0, "emailId": "", "description": "", "clientName": "Google client", "faxNo": "", "industry": "", "firstName": "", "mobileNo": "" }, "status": 0, "uri": "/api/timetracker/getclients" } }

Add clients API

This API is used to add a client.

Request URL:

https://people.zoho.com/people/api/timetracker/addclient?authtoken=<token>&clientName=<clientName>&currency=<currency>&billingMethod=<billingMethod>&firstName=<firstName>&emailId=<emailId>&phoneNo=<phoneNo>&mobileNo=<mobileNo>&faxNo=<faxNo>&city=<city>&state=<state>&pincode=<pincode>&country=<country>&industry=<industry>&compsize=<compsize>&description=<description>

Request parameter:

authtokenSpecify the authentication token
clientNameSpecify the client name
currencySpecify the currency code(Example: INR for Indian Rupee)
billingMethodSpecify the hourly job rate or hourly user rate
firstNameSpecify the first name
emailIdSpecify the email Id
phoneNoSpecify the phone number
mobileNoSpecify the mobile number
faxNoSpecify the fax number
citySpecify the city
stateSpecify the state
pincodeSpecify the pincode
countrySpecify the country code(Example: IN-India)
industrySpecify the industry
compsizeSpecify the company size
descriptionSpecify the description

Example URL:

people.zoho.com/people/api/timetracker/addclient?authtoken=2110c57f48434f76c22c139c6ef88926&clientName=Google client&currency=Testigapi&firstName=fname&lastName=lname&emailId=google@gmail.com&phoneNo=958736222&mobileNo=472829292344&faxNo=439987772899&streetAddr=Add_1&city=Ch&state=TN&pincode=600001&country=India&industry=IT&compsize=30&billingMethod=Hourly Job Rate

XML Response:

<response uri="/api/timetracker/addclient">
<status>0</status>
<message>Client added Successfully</message>
<result>
<clientId>293141000000144015</clientId>
</result>
</response>

JSON Response:

{ "response": { "message": "Client added Successfully", "result": [ { "clientId": "293141000000144027" } ], "status": 0, "uri": "/api/timetracker/addclient" } }

Modify clients API

This API is used to modify the list of clients.

Request URL:

https://people.zoho.com/people/api/timetracker/modifyclient?authtoken=<token>&clientId=<clientId>&clientName=<clientName>&currency=<currency>&billingMethod=<billingMethod>&firstName=<firstName>&lastName=<lastName>&emailId=<emailId>&phoneNo=<phoneNo>&mobileNo=<mobileNo>&faxNo=<faxNo>&city=<city>&state=<state>&pincode=<pincode>&country=<country>&industry=<industry>&compsize=<compsize>&description=<description>

Request parameter:

authtokenSpecify the authentication token
clientIdSpecify the client Id
clientNameSpecify the client name
currencySpecify the currency code
billingMethodSpecify the hourly job rate or hourly user rate
firstNameSpecify the first name
lastNameSpecify the last name
emailIdSpecify the email Id
phoneNoSpecify the phone number
mobileNoSpecify the mobile number
faxNoSpecify the fax number
citySpecify the city
stateSpecify the state
pincodeSpecify the pincode
countrySpecify the country
industrySpecify the industry
compsizeSpecify the company size
descriptionSpecify the description

Example URL:

people.zoho.com/people/api/timetracker/modifyclient?authtoken=2110c57f48434f76c22c139c6ef88926&clientId=177402000000814321 &clientName=Google client&currency=Testigapi&firstName=fname&lastName=lname&emailId=google@gmail.com&phoneNo=958736222&mobileNo=472829292344&faxNo=439987772899&streetAddr=Add_1&city=Ch&state=TN&pincode=600001&country=India&industry=IT&compsize=30&billingMethod=Hourly Job Rate

XML Response:

<response uri="/api/timetracker/modifyclient">
<status>0</status>
<message>Client modified Successfully</message>
<result>
<clientId>293141000000144015</clientId>
</result>
</response>

JSON Response:

{ "response": { "message": "Client modified Successfully", "result": [ { "clientId": "293141000000144027" } ], "status": 0, "uri": "/api/timetracker/modifyclient" } }

Delete clients API

This API is used to delete the list of clients.

Request URL:

https://people.zoho.com/people/api/timetracker/deleteclient?authtoken=<token>&clientId=<clientId>

Request parameter:

authtokenSpecify the authentication token
clientIdSpecify the client Id (seperated by commas)

Example URL:

people.zoho.com/people/api/timetracker/deleteclient?authtoken=2110c57f48434f76c22c139c6ef88926&clientId=177402000000814321

XML Response:

<response uri="/api/timetracker/deleteclient">
<status>0</status>
<message>Client deleted Successfully</message>
<result>
<clientId>293141000000144015</clientId>
</result>
</response>

JSON Response:

{ "response": { "message": "Client deleted Successfully", "result": [ { "clientId": "293141000000144027" } ], "status": 0, "uri": "/api/timetracker/deleteclient" } }