来訪者バッジ API が返すもの
照会・チェックイン・チェックアウトが返しうるすべての判定と、記録されうるすべての action、そして 3 つが意図的に食い違う唯一の場面 — いちど退館して戻ってきた来訪者。
ゲートで使う 3 つの呼び出し — 照会、チェックイン、チェックアウト — はどれも読み取ったコードを受け取り、同じ形で答えます。このページはその形です。バリアが従う判定と、答えるついでに Offision が何を記録したか。これらを使う手順は Offision の来訪者バッジでゲートを開けるにあります。
判定
verify | 意味 |
|---|---|
valid | いま、この建物で有効 |
notYetValid | 実在するバッジだが、訪問がまだ始まっていない |
expired | 訪問が過ぎている |
cancelled | 訪問またはバッジが取り消された。自社システムからのコードをまだ待っているバッジもここに入る |
rejected | 承認者がこの来訪者を却下した |
waitingForApproval | まだ誰も承認していない |
wrongLocation | 実在する有効なバッジ — ただし別の建物のもの |
alreadyCheckedOut | この来訪者はすでに退館している |
notFound | 一致するものがない |
あわせて isGranted が返ります。バリアが実際に従うのはこの項目です。コードの背後にある来訪者とバッジも返るので、ゲート脇の画面にコードではなく氏名を表示できます。
何が記録されたか
チェックインとチェックアウトは判定とあわせて action を返し、実際に何が書き込まれたかを示します。
action | 返る場面 |
|---|---|
checkedIn | 最初の来訪 — バッジが 訪問中 になる |
alreadyCheckedIn | すでに館内にいた。何も書き込まれていない |
reCheckedIn | 退館したあと戻ってきた。チェックアウトが取り消された |
checkedOut | バッジが 退場 になる |
alreadyCheckedOut | すでに記録済み。退館時刻はそのまま |
none | 何も記録されていない — 拒否された読み取り、長期バッジ、またはチェックインしていない人の退館 |
再入館・退館・長期バッジ
ゲート側の処理を書く前に知っておきたい挙動が 2 つあります。
- 退館は入館より緩やかです。 チェックアウトは解決できるバッジをすべて受け付けます。期限切れのものも含めてです。会議のあいだにパスが切れたからといって、館内に閉じ込められる人が出ないようにするためです。退館が記録されるのは実際にチェックインした人だけで、していない人にはゲートは開きますが
actionはnoneになります。存在しなかった訪問を作り出さないためです。 - 退館後に戻ってきた人は再入館できます。 ただしその訪問がその建物を含んでいる場合に限ります。照会は
alreadyCheckedOutを返して拒否し、同じコードでのチェックインは訪問を開き直します。2 つの呼び出しが意図的に食い違う唯一の場所であり、ゲートが照会の答えで自分で判断するのではなくチェックインを呼ぶべき理由でもあります。
毎週のように訪れる人が持つ長期バッジには開くべき訪問がないので、action は常に none です。有効なものであればゲートは開き、それがこのバッジの目的です。長期バッジには専用のエンドポイントがあり、有効化と無効化の操作で、人を削除せずにパスだけを止められます。

