GET api/2.0/people/remove/progress This function requires authentication

Description

Returns the progress of the started data deletion for the user with the ID specified in the request.

Parameters

Name	Description	Type	Example
userId sent in url	User ID	guid	9924256A-739C-462b-AF15-E652A3B1B6EB

Example

GET api/2.0/people/remove/progress?userId=%229924256A-739C-462b-AF15-E652A3B1B6EB%22
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json

Returns

Deletion progress

Example Response

application/json

{
  "status": 0,
  "response": {
    "Id": 123124,
    "Status": 1,
    "Error": "error",
    "Percentage": 555.0,
    "IsCompleted": false,
    "FromUser": "f528a377-b268-4cdb-8209-91d0fa1417c2"
  }
}

text/xml

<result>
  <status>0</status>
  <response>
    <Id>123124</Id>
    <Status>1</Status>
    <Error>error</Error>
    <Percentage>555</Percentage>
    <IsCompleted>False</IsCompleted>
    <FromUser>f528a377-b268-4cdb-8209-91d0fa1417c2</FromUser>
  </response>
</result>

GET api/2.0/people/remove/progress This function requires authentication

Get information

Get help