PostalPortal/QuickSend
2
0
Wiki

Add barcode type for URL link

Skylar Ittner 2024-05-05 21:18:32 -06:00
parent dc0f6835e9
commit 29d5f553bb
1 changed files with 10 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
Home.md

@ -22,6 +22,16 @@ All barcodes shall start with `QSv1` as the first field. The second field shall
## Data Fields
### Subtype `u`: URL providing the code content
This type allows for smaller and shorter codes by providing a HTTP URL linking to where the barcode's content can be retrieved. The URL shall respond to a `GET` request by serving a Quick Send code with the mimetype `text/plain`. The data shall be served in the same format as it would be if encoded into a barcode directly. If a response is received that is not a valid Quick Send code, the application should handle it the same as scanning an incompatible barcode.
Position | Meaning
---------|--------
0 | Format header (`QSv1`)
1 | Subtype header (`u`)
2 | URL, starting with `http://` or `https://`
### Subtype `a`: To/From Addresses
Basic to/from address data only.