Skip to content

Commit

Permalink
Add documentation
Browse files Browse the repository at this point in the history
Signed-off-by: Kipchirchir Sigei <[email protected]>
  • Loading branch information
KipSigei committed Jun 20, 2023
1 parent 6c6c100 commit 7d7edea
Showing 1 changed file with 37 additions and 0 deletions.
37 changes: 37 additions & 0 deletions docs/data.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1099,6 +1099,43 @@ Response
{"status_code": 200, "message": "3 records were deleted"}


Permanent Deletion of Submissions
------------------------------------

**Permanently Delete a specific submission instance**

`DELETE /api/v1/data/{pk}/{dataid}`

A POST payload of parameter `permanent_delete` with the value 'True'. The value is 'False' by default.

**Payload**
::

permanent_delete = 'True'


Response
^^^^^^^^^

::
HTTP 204 No Content

**Permanently Delete a subset of submissions**

`DELETE /api/v1/data/{pk}?permanent_delete=true&instance_ids=1,2,3`

Response
^^^^^^^^^

::

{
"status_code": "200",
"message": "3 records were deleted"
}



GEOJSON
-------

Expand Down

0 comments on commit 7d7edea

Please sign in to comment.