View Case Details API
This API is used to view case details
View Case Details API - Request URL:
https://people.zoho.com/api/hrcases/viewcase?
Header:
Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxx9be93.9b8xxxxxxf
| Parameter | Values Allowed | Default View | Description |
| *recordId | <Record ID of the case> | <Mandatory> | Specify the record ID of the case |
Success Response Format
"response": {
"result": {
"filesList": [
{
"fileName": <Returns file name>,
"downloadUrl": <Returns download URL of the attached file>,
"filesize": <Returns file size>,
"fileUploadId": <Returns record ID of file attached>,
}, ...
],
"caseDetails": {
"agent": {
"empid": <Agent employee ID>, (Key available only if the agent is employee)
"erecno": <Employee Record ID>, (Key available only if the agent is employee)
"employeePhoto": <Employee Photo URL>, (Key available only if the agent is employee)
"name": <Employee Display name>, (Key available only if the agent is employee)
"zuid": <ZUID of the Agent(Employee)> (Key available only if the agent is employee)
"details": <Agent display name - employee / department / group ID>,
"valueId": <Agent ID - it can be employee / department / group ID>,
"typeId": <Type ID of Agent>,
"type": <Type of Agent - display name>,
},
"permittedCaseStatus": [ (Object is empty if the user cannot change status of this case - Returns only valid status that the user is allowed to change for this case)
{
"optionValue": <Status name>,
"optionId": <Status record ID>,
"systemValue": <Status ID>
}, ...
]
"subject": <Subject of the case>,
"description": <Description of the case>,
"categoryName": <Name of the category>,
"requestor": {
"empid": <Requestor employee ID>,
"erecno": <Employee Record ID>,
"employeePhoto":<Employee Photo URL>,
"name": <Employee Display name>,
"zuid": <ZUID of the Requestor(Employee)>
},
"statusId": <ID of the status of case>,
"isAgent": <Returns true if user is an agent>,
"categoryIcon": <Returns Icon display name of the category>,
"caseId": <Case ID>,
"createdTime": <case created time in Long>,
"isEscalatedUser": <returns true if the case is escalated to the user>,
"categoryId": <Category ID>,
"status": <Status of this case>
},
"needCategoryChange": <returns true if the user is eligible to change category of the case>,
"SLA": { (Object is empty if there is no SLA defined for this case)
"nextViolation": <immediate next violation display time count down>, (Key available only if there is countdown to escalation - not available when there is no SLA or already escalated or case closed)
"currentStatus": <Status of the timer ; 1 - start, 2 - paused, 3 - stop>,
"isViolated": <If the case violated SLA>
},
},
"message": "Success",
"uri": "/api/hrcases/viewcase",
"status": 0
}
}
Error Response Format
{
"response": {
"message": "Error occurred",
"uri": "/api/hrcases/viewcase",
"errors": {
"status": <Status of action performed>,
"desc": <Description of the error>
},
"status": 1
}
}
Threshold Limit: 30 requests | Lock period: 5 minutes
Threshold Limit - Number of API calls allowed within a minute.
Lock Period - Wait time before consecutive API requests.
Sample Request
Copiedhttps://people.zoho.com/api/hrcases/viewcase?recordId=323150000000281001Header
CopiedAuthorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxx9be93.9b8xxxxxxfSample Response
Copied{
"response": {
"result": {
"filesList": [
{
"fileName": "Security_Seminar_Invitation.pdf",
"downloadUrl": "https://people.zoho.com/api/hrcases/downloadFile?&recordId=323150000000686003&fileId=323150000000686025&fileType=1",
"filesize": "32.35 KB",
"fileUploadId": "323150000000686025"
}, ...
],
"caseDetails": {
"agent": {
"empid": "1",
"valueId": "323150000000082005",
"erecno": "323150000000082005",
"employeePhoto": "viewPhoto?filename=567593000000015001",
"name": "1 Admin AD",
"details": "Admin AD",
"typeId": "1",
"type": "Employee",
"zuid": "408541577"
},
"permittedCaseStatus": [],
"subject": "What time does the seminar on Security start tomorrow?",
"description": "Also where in the premises is the seminar held?",
"categoryName": "General Queries",
"requestor": {
"empid": "2",
"erecno": "323150000000082109",
"employeePhoto": "https://contacts.zoho.com/file?ID=409625379&fs=thumb",
"name": "2 Manager MG",
"zuid": "409625379"
},
"statusId": "1",
"isAgent": false,
"categoryIcon": "star",
"caseId": "#00108",
"createdTime": "1559557216353",
"isEscalatedUser": false,
"categoryId": "323150000000281001",
"status": "Open"
},
"needCategoryChange": true,
"sla": {
"nextViolation": "00 : 54 : 22",
"currentStatus": 1,
"isViolated": true
},
},
"message": "Success",
"uri": "/api/hrcases/viewcase",
"status": 0
}
}