Zum Hauptinhalt springen

Ressourcen

Vor über 10 Monaten aktualisiert

Gruppe Ressource

Key

Typ

Description

id

Number

Die ID der Gruppe.

name

String

type

String

Der Typ der Gruppe, entweder returning oder non-returning.

visitors

Array

Eine Liste von Besucher-Ressourcen

Ressource für wiederholende Besucher

Key

Type

Description

id

Number

Die ID des zurückkehrenden Besuchers (Mitglieds).

group_id

Number

Die ID der Gruppe, der der zurückkehrende Besucher zugeordnet ist.

site_id

Number

Optional. Die ID des Standorts, auf den der wiederkehrende Besucher beschränkt ist.

qr_codes

Array

Optional. Liste der zugewiesenen QR-Codes.

personal_fields

Object

Objekt mit persönlichen Feldern wie Name, Rolle, E-Mail, usw.

photo_url

String

Optional. Eine URL zu einem Foto des Besuchers.

last_in

String

Optional. Eine ISO-8601-formatierte Zeichenfolge, die das letzte Mal angibt, als sich der Besucher angemeldet hat.

last_out

String

Kann. Eine nach ISO-8601 formatierte Zeichenkette, die angibt, wann der Besucher das letzte Mal ausgecheckt hat.

status

String

Zeichenkette, die den Status des zurückkehrenden Besuchers angibt. Die Werte sind signed_in, signed_out und unknown.

permissions

Object

Ein Objekt mit den Berechtigungen der Begleitanwendung.

QR Codes Object

{

"id": 345,

"contents": "ABC123DEF456"

}

Persönliche Felder Object

Dies ist ein Schlüssel-Werte-Paar. Die Felder name, role, mobile und email sind systemspezifische persönliche Felder. Alle weiteren Felder wurden im Kundenbereich definiert.

{

"name": "Joe Bloggs",

"role": "Manager",

"mobile": "+16789123456",

"email": "[email protected]",

"field1": "value1",

"field2": 789,

"field3": true

}

Berechtigungen Object

Dies ist ein Schlüssel-Wert-Paar von Berechtigungen, die dem zurückkehrenden Besucher zugewiesen werden. Diese Berechtigungen gelten für die komplementäre Anwendung.

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

}

Besucher Ressourcen

Key

Type

Description

id

Number

Die ID des Besuchs.

group_id

Number

Die ID der Gruppe, zu der der Besucher gehört.

returning_visitor_id

Number

Optional. ID des zurückkehrenden Besuchers.

name

String

Der Name des Besuchers, der sich angemeldet hat.

photo_url

String

Optional. URL eines Fotos des Besuchers.

badge_url

String

Optional. URL zum Bild des für den Besucher gedruckten Ausweises.

status

String

Eine Zeichenfolge, die den Status des Besuchers angibt. Die Werte sind signed_in, signed_out und expected.

in_datetime

String

Optional. ISO-8601-formatierte Zeichenfolge, die die Eintrittszeit des Besuchers angibt.

out_datetime

String

Optional. Eine Zeichenkette im ISO-8601-Format, die den Zeitpunkt des Verlassens des Besuchers angibt.

expected_datetime

String

Optional. Eine Zeichenkette im ISO-8601-Format, die die erwartete Ankunftszeit des Besuchers angibt.

additional_fields

Object

Zusätzliche Felder im Zusammenhang mit dem Besucher, die beim Ein- oder Auschecken erfasst werden.

personal_fields

Object

Persönliche Felder, die mit dem Besucher verbunden sind (nur für häufige Besucher).

qr_codes

Array

Liste der QR-Code-Inhalte, die mit dem Besucher verbunden sind.

Zusatzfeld und persönliches Feld Object.

Dies ist ein Schlüsselwertpaar.

{

"field1": "value1",

"field2": 789,

"field3": true

}

Hat dies deine Frage beantwortet?