The Host Object

Host is the person inside the company who is going to receive visits and/or have access to the platform

The Object

Attribute

Description

*id

stringrequired

It is a unique 32 characters string

*name

stringrequired

It is required

*email

stringrequired

Must be a valid email address, and it is unique in a company

*type

stringimmutable

This is an immutable field which indicated the type of the object. In this case 'host'

isActive

Bool

A boolean value indicating if the host is active on the iPad or not

pictureUrl

string

The url of an image. It can be a .png or .jpg

position

string

The current position of the host

sector

string

The current sector of the host

phone

string

It can be only numbers, or formatted but must be a string

countryCode

string

If phone is provided the countryCode must be provided too. Here you can find a list of valid country codes. E.g.: +55

isPhoneValid

bool

An automatic check that W3lcome's server do to verify if the phone is valid or not

company

string

The current company of the host

message

string

A custom message to display at the end of the check in process

Short Sample

{
"id": "5d13bad4ae9c50948f6edd67a16d6936",
"email": "alisson@w3lcome.com",
"name": "Alisson Enz Rossi",
"isActive": true,
"position": "CTO",
"sector": "IT",
"company": "W3lcome"
}

Available Methods

Table of Errors

Method

Type

Description

GET /hosts

INVALID_QUERY_OPERATOR

INVALID_LIMIT_VALUE

INVALID_OFFSET_VALUE

POST /hosts

MISSING_NAME

POST /hosts

MISSING_EMAIL

POST /hosts

INVALID_EMAIL

POST /hosts

ALREADY_EXISTS

PATCH /host/:id

CANNOT_CHANGE_HOST_EMAIL

DELETE GET PATCH

NOT_FOUND

DELETE GET PATCH

MISSING_ID

GET POST PATCH DELETE

INTERNAL

GET POST PATCH DELETE

UNAUTHORIZED