Document Sessions

Purpose

To get the list of active sessions for a particular document.

HTTP Request URL

https://{api.office-integrator_domain}/writer/officeapi/v1/documents/<document_id>/sessions?apikey=<apikey>

Request Parameters

Parameter	Data Type	Description
Mandatory Parameters
apikey	String	Uniquely identifies the web application in which the Writer editor is integrated.
document_id	String	Unique id of the document.

Sample Request

Copiedhttps://api.office-integrator.com/writer/officeapi/v1/documents/1349/sessions?apikey=423s*****

Sample Response

Copied{		
"document_id" : "1349",
"active_sessions_count" : "2" ,
"document_name" : "New",
"document_type" : "document/merge_template/fillable_template",
"created_time": "2022-08-04T07:30:00Z",
"created_time_ms": "1659578400000",
"expires_on": "2022-08-04T13:34:00Z",
"expires_on_ms": "1659600270000",
"sessions":[
	{
          "status" : "active/inactive"
	  "user_info":  {
                                "display_name":"Amelia",
                                "user_id":"123"
                               }
          "info": {
                     "document_id": "1349",
                     "created_time_ms": "1659578400000",
                     "created_time": "2022-08-04T07:30:00Z",
                     "expires_on_ms": "1659600270000",
                     "expires_on": "2022-08-04T13:34:00Z",
                     "session_url": "https://writer.zoho.com/writer/officeapi/v1/documents/<session_id>/edit",
                     "session_delete_url":"https://writer.zoho.com/writer/officeapi/v1/sessions/<session_id>"
                     }
       }
      {
 	.......
      }
   ]
}