Ir al contenido principal

Recursos

Actualizado hace más de 3 meses

Grupo Recurso

Key

Type

Description

id

Number

El id del grupo.

name

String

El nombre del grupo.

type

String

El tipo del grupo, puede ser 'que regresa' o 'que no regresa'.

visitors

Array

Recurso Visitante que regresa

Key

Type

Description

id

Number

El id del visitante que regresa (miembro).

group_id

Number

El ID del grupo al que está asignado el visitante que regresa.

site_id

Number

Opcional. El ID del sitio al que está restringido el visitante que regresa.

QR_codes

Array

Opcional. Lista de códigos QR asignados.

personal_fields

Object

Objeto que contiene los campos personales como nombre, rol, email, etc.

photo_url

String

Opcional. Una URL a una foto del visitante.

last_in

String

Opcional. Una cadena con formato ISO-8601 que representa la última vez que el visitante registró entrada.

last_out

String

Opcional. Una cadena con formato ISO-8601 que representa la última vez que el visitante registró salida.

status

String

Cadena que representa el estado del visitante que regresa. Los valores son 'signed_in', 'signed_out' y 'unknown'.

permissions

Object

Un objeto con los permisos de la aplicación complementaria.

Códigos QR Object

{

"id": 345,

"contents": "ABC123DEF456"

}

Campos personales Object

Se trata de un par clave-valor. Los campos name, role, mobile y email son campos personales específicos del sistema. Todos los campos adicionales han sido definidos en el espacio cliente.

{

"name": "Joe Bloggs",

"role": "Manager",

"mobile": "+16789123456",

"email": "[email protected]",

"field1": "value1",

"field2": 789,

"field3": true

}

Permisos Object

Se trata de un par clave-valor de permisos asignados al visitante que regresa. Estos permisos son aplicables a la aplicación complementaria.

Key

Type

Description

can_access_firelist

Boolean

can_pre_reg

Boolean

can_mobile_sign_in

Boolean

can_view_sign_in_history

Boolean

can_auto_sign_in

Boolean

Dependent on the can_mobile_sign_in

can_access_today

Boolean

{

"can_access_firelist": true,

"can_pre_reg": false,

"can_mobile_sign_in": true,

"can_view_sign_in_history": false,

"can_auto_sign_in": false,

"can_access_today": false

}

Recurso Visitante

Key

Type

Description

id

Number

El id de la visita.

group_id

Number

ID del grupo al que pertenece el visitante.

returning_visitor_id

Number

Opcional. ID del visitante que regresa.

name

String

El nombre del visitante que ha registrado entrada.

photo_url

String

Opcional. URL de una foto del visitante.

badge_url

String

Opcional. URL de la imagen de la tarjeta impresa para el visitante.

status

String

Una cadena que representa el estado del visitante. Los valores son 'signed_in', 'signed_out' y 'expected'.

in_datetime

String

Opcional. Cadena con formato ISO-8601 que representa la hora de entrada del visitante.

out_datetime

String

Optional. Una cadena con formato ISO-8601 que representa la hora de salida del visitante.

expected_datetime

String

Opcional. Una cadena formateada en formato ISO-8601 que representa la hora de llegada prevista del visitante.

additional_fields

Object

Campos adicionales asociados al visitante tomados durante el registro de entrada o de salida.

personal_fields

Object

Campos personales asociados al visitante (sólo para visitantes frecuentes).

qr_codes

Array

Lista de contenidos de códigos QR asociados al visitante.

Campo adicional y campo personal Object.

Se trata de un par clave-valor.

{ "field1": "value1", "field2": 789, "field3": true }

¿Ha quedado contestada tu pregunta?