W3lcome API
  • Introduction
  • FAQ
  • Authentication
  • Changelog
  • Host
    • The Host Object
    • Retrieve a Host
    • Retrieve a List of Hosts
    • Insert a Host
    • Update a Host
    • Delete a Host
  • Visit
    • The Visit Object
    • Retrieve a Visit
    • Retrieve a List of Visits
    • Change Visit Status
    • Check-out a Visit
    • Check-in with Invitee Id
    • Check-out with Invitee Id
    • Delete a Visit
  • Blocked list
    • The Blocked List Object
    • Retrieve a Person on the Blocked List
    • Retrieve a List of People from the Blocked List
    • Insert a Person on the Blocked List
    • Update a Person on the Blocked List
    • Delete a Person from the Blocked List
  • Invitee
    • The Invitee Object
    • Retrieve an Invitee
    • Retrieve a List of Invitees
    • Insert an Invitee
    • Update an Invitee
    • Delete an Invitee
  • Delivery
    • The Delivery Object
  • Meeting
    • The Meeting Object
  • Notification
    • The Notification Object
  • Webhook
    • Webhook Endpoints
  • Company
    • The Company Object
    • Retrieve Company Information
    • Company Fields
  • Integration
    • W-Access
    • SBT
    • SBT QRCodes
    • Workplace by Facebook
Powered by GitBook
On this page
  • The Host
  • Available lines
  • Sample request
  • Update a host
  • Table of errors

Was this helpful?

  1. Integration

SBT

PreviousW-AccessNextSBT QRCodes

Last updated 4 years ago

Was this helpful?

The Host

The host object is the same as 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

{
    "id": "5d13bad4ae9c50948f6edd67a16d6936",
    "email": "alisson@w3lcome.com",
    "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"
}
{
    "type": "INVALID_LINE_ID"
}

Table of errors

Methos

Type

Description

POST PATCH

INVALID_LINE_ID

The line id provided is not a valid one

here