SBT

The Host

The host object is the same as here with the same methods (GET/POST/PATCH/DELETE) there are only 2 more properties linesAllowed and driverLine

Attribute	Description
linesAllowed [string]	An array of allowed lines ids that indicates which lines this user can use. E.g.: ["l01", "l03"] so this user is allowed to use VILA NINO and TREMEMBÉ. Default: null (This user is not allowed to use any line) (Set as an empty array to remove all lines)
driverLine string	This property indicates if this user is a driver and what is his line. E.g.: "l06" so this is a driver of SAPOPEMA. Default: null (This user is not a driver) (Set as an empty string to remove it)

Available lines

Obs.: Every line id starts with lowercase L

id	Name
l01	VILA NINO
l02	EDU CHAVES
l03	TREMEMBÉ
l04	CIDADE TIRA-DENTES
l05	ITAIM PAULISTA
l06	SAPOPEMA
l07	GUARULHOS VIA DUTRA
l08	METRÔ CONCEIÇÃO
l09	SANTO ANDRÉ / SÃO CAETANO DO SUL
l10	JUNDIAI
l11	SÃO MIGUEL
l12	OSASCO
l13	BARRA FUNDA
l14	TRANSPORTE NOTURNO

Sample request

Update a host

PATCH https://api.w3lcome.com/v1/host/:id

This is the same endpoint as Update a Host but with the 2 extra parameters.

Path Parameters

Name	Type	Description
id	string	ID of the host

Headers

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

Request Body

Name	Type	Description
linesAllowed	array	An array of lines id
driverLine	string	A single line id

200 Success

{
    "id": "5d13bad4ae9c50948f6edd67a16d6936",
    "email": "[email protected]",
    "name": "Alisson Enz Rossi",
    "isActive": true,
    "pictureUrl": "",
    "position": "CTO",
    "sector": "IT",
    "phone": "(43) 9 9982-0420",
    "countryCode": "+55",
    "isPhoneValid": true,
    "company": "W3lcome",
    "type": "host",
    "message": "HOST UPDATED",
    "role": "manager",
    "linesAllowed": ["l01", "l04"],
    "driverLine": "l06"
}

400 Error

Table of errors

Methos	Type	Description
POST PATCH	INVALID_LINE_ID	The line id provided is not a valid one