⭐ Special ⏰ History 📤 Email 🖨️ Print 💾 MD 💾 ODT

📌

1. List of the API return codes 1.1. /api/document/convert 1.2. /api/document/create 1.3. /api/document/delete 1.4. /api/document/get 1.5. /api/document/list 1.6. /api/document/remote/convert 1.7. /api/document/rename 1.8. /api/login 1.9. /api/markdown/convert 1.10. /api/oauth 1.11. /api/page/create 1.12. /api/page/delete 1.13. /api/page/edit 1.14. /api/page/export 1.15. /api/page/move 1.16. /api/page/validate 1.17. /api/project/env/set 1.18. /api/project/get 1.19. /api/project/graph/get 1.20. /api/project/list 1.21. /api/project/progress/get 1.22. /api/project/users/get 1.23. /api/server/env/get 1.24. /api/server/headers/get 1.25. /api/server/ping 1.26. /api/server/shutdown 1.27. /api/server/unlock 1.28. /api/user/create 1.29. /api/user/language/set 1.30. /api/user/password/change 1.31. /api/user/roles/set

Related pages: 🇫🇷 Codes retour API

#api

1. List of the API return codes

This page summarizes in Markdown format all the return codes of Pwic.wiki's API.

It is also a technical demo of what an enhancement in pwic_extension.py can achieve: these tables are automatically generated and not saved in the page.

1.1. /api/document/convert

RC	Description
200	Successful operation
400	Invalid parameters
401	Unsufficient authorizations
403	Disabled feature
422	File cannot be converted

1.2. /api/document/create

RC	Description
200	Successful operation
400	Invalid parameters
401	Unsufficient authorizations
403	Forbidden content
409	Duplicate file name in the project
413	File size limit or number of pixels exceeded
415	Failed MIME verification
500	File incorrectly managed on the server
503	Update temporarily unavailable or ongoing server maintenance

1.3. /api/document/delete

RC	Description
200	Successful operation
400	Invalid parameters
401	Unsufficient authorizations, or not found
500	File incorrectly managed on the server
503	Update temporarily unavailable or ongoing server maintenance

1.4. /api/document/get

RC	Description
200	Successful operation
302	Successful redirection to another location
400	Invalid parameters
404	Unsufficient authorizations, or not found

1.5. /api/document/list

RC	Description
200	Successful operation
400	Invalid parameters
401	Unsufficient authorizations
404	Unknown project or page

1.6. /api/document/remote/convert

RC	Description
200	Successful operation
400	Invalid parameters
401	Unsufficient authorizations
403	Disabled feature
422	File cannot be converted

1.7. /api/document/rename

RC	Description
200	Successful operation
400	Invalid parameters
401	Unsufficient authorizations, or not found
500	File incorrectly managed on the server
503	Update temporarily unavailable or ongoing server maintenance

1.8. /api/login

RC	Description
200	Successful operation if no body, else redirected page from 302
302	Redirection with the parameter ?failed if the credentials were rejected
401	Unsufficient authorizations
408	Expired PIN code for 2FA TOTP

1.9. /api/markdown/convert

RC	Description
200	Successful operation
400	Invalid parameters
401	Unsufficient authorizations

1.10. /api/oauth

RC	Description
200	Successful login
302	Successful login
307	Redirection with the parameter ?failed if the credentials were rejected
401	Unsufficient authorizations
501	Invalid OAuth provider
503	Connection temporarily unavailable

1.11. /api/page/create

RC	Description
200	Successful operation
400	Invalid parameters
401	Unsufficient authorizations
403	Exceeded limitations
404	Reference page not found
503	Update temporarily unavailable

1.12. /api/page/delete

RC	Description
200	Successful operation
400	Invalid parameters
401	Unsufficient authorizations, or not found
500	Dependent files not fully removed from the system
503	Update temporarily unavailable

1.13. /api/page/edit

RC	Description
200	Successful operation
400	Invalid parameters
401	Unsufficient authorizations
503	Update temporarily unavailable

1.14. /api/page/export

RC	Description
200	Successful operation
400	Invalid parameters
401	Unsufficient authorizations, or not found
403	Disabled feature
404	Rejected by a custom rule
415	Invalid file format

1.15. /api/page/move

RC	Description
302	Successful operation
400	Invalid parameters
401	Unsufficient authorizations, or project not found
403	Target page already exists
404	Unkown source page
409	Attachments in conflict with the target project
500	Corrupted documents to be repaired
503	Update temporarily unavailable

1.16. /api/page/validate

RC	Description
200	Successful operation
400	Invalid parameters
401	Unsufficient authorizations, or not found
503	Update temporarily unavailable

1.17. /api/project/env/set

RC	Description
200	Successful operation
400	Invalid parameters
401	Unsufficient authorizations

1.18. /api/project/get

RC	Description
200	Successful operation
400	Invalid parameters
401	Unsufficient authorizations
501	Unsupported combination of options

1.19. /api/project/graph/get

RC	Description
200	Successful operation
400	Invalid parameters
401	Unsufficient authorizations
403	Disabled feature

1.20. /api/project/list

RC	Description
200	Successful operation
401	Unsufficient authorizations

1.21. /api/project/progress/get

RC	Description
200	Successful operation
400	Invalid parameters
401	Unsufficient authorizations

1.22. /api/project/users/get

RC	Description
200	Successful operation
400	Invalid parameters
401	Unsufficient authorizations, or not found

1.23. /api/server/env/get

RC	Description
200	Successful operation
401	Unsufficient authorizations, or not found

1.24. /api/server/headers/get

RC	Description
200	Successful operation
401	Session not active

1.25. /api/server/ping

RC	Description
200	Session still alive
401	Session not active

1.26. /api/server/shutdown

RC	Description
403	Connect from localhost only
503	Shutdown temporarily unavailable

1.27. /api/server/unlock

RC	Description
200	Successful operation
400	Database not locked
403	Connect from localhost only

1.28. /api/user/create

RC	Description
200	Successful operation
400	Invalid parameters
401	Unsufficient authorizations
403	Forbidden operation
503	Update temporarily unavailable

1.29. /api/user/language/set

RC	Description
200	Successful operation
400	Invalid parameters

1.30. /api/user/password/change

RC	Description
200	Successful operation
400	Invalid parameters
401	Unsufficient authorizations
500	Invalid configuration of the server
503	Update temporarily unavailable

1.31. /api/user/roles/set

RC	Description
200	Successful operation, followed by the new value
400	Invalid parameters
401	Unsufficient authorizations
503	Update temporarily unavailable

Revision #1 was last modified by gitbra
on 2024-11-30 at 00:00:00 — 973d9c04bdabf273