Lightweight HTTP(S) request algorithm performing post / get requests (Request in QGIS)

[qgis-bot]

Request for documentation

From pull request qgis/QGIS#58681
Author: @signedav
QGIS version: 3.40

** Lightweight HTTP(S) request algorithm performing post / get requests**

PR Description:

Considert inputs from here qgis/QGIS#58464 (comment)

Options

• Optional data can be passed by POST Requests
• An authentification configuration can be passed optionally
• The reply data can be written optionally to a file for further use
• Network errors can be considered as algorithm failure - otherwise it passes and returns the codes

Return values are:

• STATUS_CODE: The HTTP Status
• ERROR_CODE: When it fails (like as well on 404 HTTP Status etc.)
• ERROR_MESSAGE: In case of failure - the error message
• RESULT_DATA: In case of success - this is a string containing the data
• OUTPUT: In case of success - The optional output file containing the data

Notes

• This algorithm supports application/x-www-form-urlencoded requests. Additional feature could be the possibility to add binary data to perform multipart requests but not in this PR
• There is an option to consider the algorithm as failed on error (means everything except error code 0). Additional feature could be the possibility to choose on what specific error code(s) or HTTP status code(s) it should fail

Commits tagged with [need-docs] or [FEATURE]