SBT QRCodes

The QRCode

The QRCode object is described below and only has the following method GET.

Attribute	Description
*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

Name	Type	Description
id*	string	ID of the qr code

Headers

Name	Type	Description
Content-Type*	string	application/JSON
Authentication	string	Basic token

200: OK

{
    "type": "qrcode",
    "id": "4nFYwPqGegKC0ypKqcFG",
    "readAt": "2020-09-08T08:02:17-03:00",
    "readById": "5d13bad4ae9c50948f6edd67a16d6936",
    "readByName": "Alisson Enz",
    "qrCodeById": "98889e097fbe05bb33f9eb83387dcc69",
    "qrCodeByName": "Mateus Schmidt",
    "allowed": false,
    "line": "l01"
}

400: Bad Request

{
    "type": "INVALID_QUERY_OPERATOR"
}

401

{
    "type": "UNAUTHORIZED"
}

Get QRCodes

GET https://api.w3lcome.com/v1/qrcodes

This endpoint allows you to get a lost of read qr codes

Query Parameters

Name	Type	Description
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

Name	Type	Description
Content-Type	string	application/JSON
Authentication	string	Basic token

200: OK

{
    "qrcodes": [
        {
            "type": "qrcode",
            "id": "4nFYwPqGegKC0ypKqcFG",
            "readAt": "2020-09-08T08:02:17-03:00",
            "readById": "5d13bad4ae9c50948f6edd67a16d6936",
            "readByName": "Alisson Enz",
            "qrCodeById": "98889e097fbe05bb33f9eb83387dcc69",
            "qrCodeByName": "Mateus Schmidt",
            "allowed": false,
            "line": "l01"
        },
        {
            ...
        }
    ],
    "size": 5
}

400: Bad Request

{
    "type": "INVALID_QUERY_OPERATOR"
}

Queryable Fields

queryKey	Description
readAt	Date (ISO format e.g.: 2020-09-08T08:02:17-03:00)
readById	String
qrCodeById	String
allowed	Boolean
line	String

Table of Errors

Method	Type
GET	NOT_FOUND INVALID_LIMIT_VALUE INVALID_OFFSET_VALUE INVALID_QUERY_OPERATOR INVALID_QUERY_KEY
*	INTERNAL UNAUTHORIZED