ingresso-group / slate

Ingresso F13 online docs
Other
0 stars 0 forks source link

Document `supported_barcode_types` #27

Open cakemanny opened 2 years ago

cakemanny commented 2 years ago

The supported_barcode_types property of a purchase.v1 response is not documented as at writing. It sits at the order level, and is an array.

Possibly values include

possible supported_barcode_types values
aztec
aztec_small
datamatrix
code128
code93
code39
interleaved_2of5
ean
upc
codabar
msi
plessey
qr_code
pdf417

Though, in practise, it looks like we are currently only spitting out code128 and qr_code. Need to check whether to document all of them or only a select set.

joegrimeringresso commented 2 years ago

Added this in latest two commits: https://github.com/ingresso-group/slate/commits/master

joegrimeringresso commented 2 years ago

Pete: I would list all tnhe ones which may possibly come out - but the older 1d ones prbably just by name. however we are highly likely to produce PDF417, plus Aztec as well as QR codes. Possibly datamatrix too - though I have never seen that on a ticket. PDF417 is a very common barcode though (and is what TicketMatsre use). Aztec is the first 2 code we ever saw, which was on the Central Station system way back in 2000, and is what Apple wallet uses for its flguht barclodes. You see them reaosnbaly often,. Datamatrix is probably the mosr reliable, as was added becaise someone actuakly used it - may have been SkiData. been supersedd by QR cardes on tickets I would inagine.

But just naming them shoudl eb enough - people can look up the formats if they need to.

joegrimeringresso commented 2 years ago

@minusbat going with this:

code128 | qr_code | pdf417 | aztec | aztec_small| datamatrix | code39 | code93 |

based on what you said above

minusbat commented 2 years ago

yes, that looks good to me - covers all the things we are likely to se in practice

cakemanny commented 2 years ago

That table's coming out a bit weird image

joegrimeringresso commented 2 years ago

That table's coming out a bit weird image

made it a list. pushed