Passer au contenu principal

Ressources

A
Écrit par Aurelia Farey
Mis à jour il y a plus d'un mois

Groupe Ressource

Key

Type

Description

id

Number

L'identifiant du groupe.

name

String

Le nom du groupe.

type

String

Le type du groupe, qui peut être 'retournant' ou 'non-retournant'.

visitors

Array

Ressource pour les visiteurs qui reviennent

Key

Type

Description

id

Number

L'identifiant du visiteur qui revient (membre).

group_id

Number

L'identifiant du groupe auquel le visiteur qui revient est assigné.

site_id

Number

Optionnel. L'ID du site auquel le visiteur qui revient est limité.

qr_codes

Array

Optionnel. Une liste de codes QR attribués.

personal_fields

Object

Un objet contenant les champs personnels comme le nom, le rôle, l'email, etc.

photo_url

String

Optionnel. Une URL vers une photo du visiteur.

last_in

String

Optionnel. Une chaîne de caractères au format ISO-8601 représentant la dernière fois que le visiteur a enregistré son entrée.

last_out

String

Optionnel. Une chaîne de caractères au format ISO-8601 représentant la dernière fois que le visiteur a enregistré sa sortie.

status

String

Chaîne de caractères représentant le statut du visiteur qui revient. Les valeurs sont 'signed_in', 'signed_out' et 'unknown'.

permissions

Object

Un objet avec les permissions de l'application compagnon.


QR Codes Object

{

"id": 345,

"contents": "ABC123DEF456"

}

Champs personnels Object

Il s'agit d'une paire clé-valeur. name, role, mobile et email sont des champs personnels spécifiques au système. Tous les champs supplémentaires ont été définis dans l'espace client.

{

"name": "Joe Bloggs",

"role": "Manager",

"mobile": "+16789123456",

"email": "[email protected]",

"field1": "value1",

"field2": 789,

"field3": true

}

Permissions Object

Il s'agit d'une paire clé-valeur de permissions attribuées au visiteur qui revient. Ces permissions sont applicables à Sign In App Companion.

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

}

Ressource visiteurs

Key

Type

Description

id

Number

L'identifiant de la visite.

group_id

Number

L'identifiant du groupe dans lequel le visiteur a enregistré son entrée.

returning_visitor_id

Number

Optionnel. L'identifiant du visiteur qui revient.

name

String

Le nom du visiteur qui a enregistré son entrée.

photo_url

String

Optionnel. Une URL vers une photo du visiteur.

badge_url

String

Optionnel. Une URL vers une image du badge imprimé pour le visiteur.

status

String

Une chaîne représentant le statut du visiteur. Les valeurs sont 'signed_in', 'signed_out' et 'expected'.

in_datetime

String

Optionnel. Une chaîne de caractères au format ISO-8601 représentant l'heure à laquelle le visiteur a enregistré l'entrée.

out_datetime

String

Optionnel. Une chaîne de caractères au format ISO-8601 représentant l'heure à laquelle le visiteur a enregistré la sortie.

expected_datetime

String

Optionnel. Une chaîne de caractères au format ISO-8601 représentant l'heure à laquelle le visiteur est pré-enregistré pour arriver.

additional_fields

Object

Champs supplémentaires associés au visiteur pris lors de l'enregistrement d'entrée ou de sortie.

additional_fields

Object

Champs supplémentaires associés au visiteur lors de l'enregistrement d'entrée ou de sortie.

qr_codes

Array

Liste des contenus de codes QR associés au visiteur.

Champ supplémentaire et champ personnel Object.

Il s'agit d'une paire clé-valeur.

{

"field1": "value1",

"field2": 789,

"field3": true

}

Avez-vous trouvé la réponse à votre question ?