public-offering
/
pad.pub0.org
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update http_api.md 

More information for public Staus HTTP API Calls
pull/5424/head
Robert Geislinger 2022-02-10 12:38:08 +01:00 committed by Richard Hansen
parent 4c53f76c25
commit 58ec6a5c88
1 changed files with 3 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc/api/http_api.md
View File

@ -566,11 +566,12 @@ returns the id of a pad which is assigned to the readOnlyID
#### setPublicStatus(padID, publicStatus) #### setPublicStatus(padID, publicStatus)
* API >= 1 * API >= 1
sets a boolean for the public status of a pad sets a boolean for the public status of a group pad
*Example returns:* *Example returns:*
* `{code: 0, message:"ok", data: null}` * `{code: 0, message:"ok", data: null}`
* `{code: 1, message:"padID does not exist", data: null}` * `{code: 1, message:"padID does not exist", data: null}`
* `{code: 1, message:"You can only get/set the publicStatus of pads that belong to a group", data: null}`
#### getPublicStatus(padID) #### getPublicStatus(padID)
* API >= 1 * API >= 1
@ -580,6 +581,7 @@ return true of false
*Example returns:* *Example returns:*
* `{code: 0, message:"ok", data: {publicStatus: true}}` * `{code: 0, message:"ok", data: {publicStatus: true}}`
* `{code: 1, message:"padID does not exist", data: null}` * `{code: 1, message:"padID does not exist", data: null}`
* `{code: 1, message:"You can only get/set the publicStatus of pads that belong to a group", data: null}`
#### listAuthorsOfPad(padID) #### listAuthorsOfPad(padID)
* API >= 1 * API >= 1