SBT QRCodes
The QRCode
The QRCode object is described below and only has the following method GET.
*id string required
It is a unique string
*type string immutable
This is an immutable field that indicated the type of the object. In this case qrcode
*readAt string required
Date and time this qrcode was read
*readById string required
Id of the person (host) who read the qr code (driver)
*readByName string required
Name of the person (host) who read the qr code (driver)
*qrCodeById string required
Id of the person (host) who had their qr code read (passenger)
*qrCodeByName string required
Name of the person (host) who had their qr code read (passenger)
*allowed bool required
It is a boolean that indicates if the passenger was allowed or not
*line string required
The driver line according to Available lines table
Methods
Get QRCode
GET https://api.w3lcome.com/v1/qrcode/:id
This endpoint allows you to get a qr code by its id
Path Parameters
id*
string
ID of the qr code
Headers
Content-Type*
string
application/JSON
Authentication
string
Basic token
Get QRCodes
GET https://api.w3lcome.com/v1/qrcodes
This endpoint allows you to get a lost of read qr codes
Query Parameters
limit
number
The number of qrcodes you want to retrieve Default: 500 - Min: 1 - Max: 2000
offset
number
The offset from the first qrcode. Used to paginate. Default: 0 - Min: 0 - Max: ∞
queryKey
string
Query by any field in the qrcode queryable fields table Default: none
queryOp
string
Add the type of the query. Default: none Accepted values: < <= == > >=
queryValue
string
Insert the value you want to query. Default: none
Headers
Content-Type
string
application/JSON
Authentication
string
Basic token
Queryable Fields
readAt
Date (ISO format e.g.: 2020-09-08T08:02:17-03:00)
readById
String
qrCodeById
String
allowed
Boolean
line
String
Table of Errors
GET
NOT_FOUND INVALID_LIMIT_VALUE INVALID_OFFSET_VALUE INVALID_QUERY_OPERATOR INVALID_QUERY_KEY
*
INTERNAL UNAUTHORIZED
Last updated
Was this helpful?