Favorites List API

Purpose

To fetch and list all your favorite employees' details like Erecno, Employee ID and Email ID. Unmark/Remove Favourite Employee API - To unmark/remove an employee from the favorites list. Marking an Employee as Favourite API - To mark an employee as favorite in the favorites list.

Request URL

https://people.zoho.com/people/api/employee/records/favorites?authtoken=<token>

Request Parameters

authtokenSpecify the authentication token

Example

Request URL:

https://people.zoho.com/people/api/employee/records/favorites?authtoken=7d985878998943g4j09h43dd0b167dda34b

XML response:

<Response Status="1">
<Records>
<Record>
<Erecno>6000000026007</Erecno>
<EmployeeLastname>lokesh</EmployeeLastname>
<EmployeemailId>lokesh@zohosmtpin.india.adventnet.com</EmployeemailId>
<EmployeeFirstname>lokesh</EmployeeFirstname>
<Departmentname>Gadgets</Departmentname>
<ResidentialPhone>
</ResidentialPhone>
<workExtn>6543</workExtn>
<workPhone>3453</workPhone>
<mobile>9987898789</mobile>
<EmployeeId>4</EmployeeId>
</Record>
</Records>
</Response>

JSON response:

[{"Erecno":6000000026007,"EmployeeLastname":"lokesh","EmployeemailId":"lokesh@domain.com","EmployeeFirstname":"lokesh","Departmentname":"Support","ResidentialPhone":"","workExtn":"6543","workPhone":"3453","mobile":"9987898789","EmployeeId":"4"}]

Unmark/Remove Favourite Employee API

Purpose:

You can unmark/remove an employee from the favorites list any time.

Request URL:

https://people.zoho.com/people/api/employee/records/<recordId>?favStatus=false&authtoken=<token>

Request Parameter:

authtokenSpecify the authentication token
recordidSpecify the user record ID of the record being added
favStatusSpecify false to unmark

Example URL:

https://people.zoho.com/people/api/employee/records/6000000043063?favStatus=false&authtoken=7d985878998943g4j09h43dd0b167dda34b

XML response:

<Response Status="1">
<message>Successfully removed</message>
</Response>

JSON response:

[{"message":"Successfully removed","Response":1}]

Marking an Employee as Favourite API

Purpose:

The favorites list holds all your favorite employees' details. Just mark them as favorite and you can view them under the favorites list.

Request URL:

https://people.zoho.com/people/api/employee/records/<recordId>?favStatus=true&authtoken=<token>

Request Parameter:

authtokenSpecify the authentication token
recordIdSpecify the user record ID of the record being added
favStatusSpecify true to tag an employee as favorite

Example URL:

https://people.zoho.com/people/api/employee/records/6000000043063?favStatus=true&authtoken=7d985878998943g4j09h43dd0b167dda34b

XML response:

<Response Status="1">
<message>Successfully added</message>
</Response>

JSON format:

[{"message":"Successfully added","Response":1}]

Error codes

Please refer Error codes.