日付チェック API

日付チェック ( app=dateCheck )の点検結果を参照する API の仕様です。
保存済みの点検結果を参照します。この API からの登録はできません。
共通の認証・ベースURLは 基本情報・認証仕様 を参照してください。


1. 🗺️ エンドポイント一覧

メソッドエンドポイント(クエリパラメータ)処理概要
GET?app=dateCheck&docId={id}点検結果の単一取得
GET?app=dateCheck&docId={id}&image={imageIndex}点検画像を 1 枚取得
GET?app=dateCheck&date=YYYY-MM月次一覧取得(登録日基準)
GET?app=dateCheck&date=YYYY-MM-DD日次一覧取得(登録日基準)

⚠️ 非対応スコープ(制限事項)
以下の操作およびデータ連携には対応していません。

  • 点検結果の登録(POST)・修正・削除
  • 確認・承認フローの実行
  • 点検画像 URL(imgFileURL)の返却。画像本体は、下記「画像の取り方」の手順で JPEG として取得できます。
  • NG 時のメール通知
  • 製品マスタ・端末マスタの取得・更新

💡 画像の取り方

1件の点検結果に画像は複数枚あります。JSON には番号だけが入り、JPEG は番号ごとに別リクエストです。 imgFileURL は返しません。

  1. GET {baseUrl}?app=dateCheck&docId={id} で点検結果を取得する。 checkItems のうち imageIndex がある項目だけ画像がある。
  2. その番号ごとに GET {baseUrl}?app=dateCheck&docId={id}&image={imageIndex} を呼ぶ。応答は JSON ではなく image/jpeg の 1 枚。認証はこれまで通りヘッダーの x-api-key 。

例: imageIndex が 0 と 1 なら、画像の取得は 2 回です。


2. 📤 GET: 点検結果の取得

取得系APIにおいて、レスポンスに含まれるすべての日付・時刻フィールドは、 YYYY/MM/DD HH:mm の文字列形式に統一されて返却されます。 画像がある点検項目には imageIndex が付きます。画像本体の取得は上記「画像の取り方」と 2.5 を参照してください。

2.1 単一取得(docId 指定)

  • Request: GET {baseUrl}?app=dateCheck&docId=label_check_doc_id_11111
{
  "data": [
    {
      "id": "label_check_doc_id_11111",
      "userUID": "user_uid_example",
      "shopUID": "xxxxxxxxxxxxxxxxxxxx",
      "productName": "黒蜜かわらけ80g",
      "allowableDays": 10,
      "deviceName": "端末A",
      "sender": "山田太郎",
      "checkItems": [
        {
          "title": "ラベル",
          "checkType": "label",
          "readType": "barcode",
          "value": "4901234567890",
          "readLine": 1,
          "datePatterns": [],
          "dateSeparators": [],
          "passOnly": false,
          "isPassed": true,
          "checkResult": "OK",
          "imageIndex": 0
        },
        {
          "title": "賞味期限",
          "checkType": "date",
          "readType": "",
          "value": "",
          "readLine": 1,
          "datePatterns": ["YYYYMMDD", "YYMMDD"],
          "dateSeparators": ["/", "-", ".", "年月日"],
          "passOnly": true,
          "isPassed": true,
          "checkResult": "2026/08/20",
          "imageIndex": 1
        }
      ],
      "isNormalForReport": true,
      "registeredAt": "2026/08/20 00:00",
      "sentAt": "2026/08/20 09:16",
      "confirmedAt": "",
      "confirmerName": "",
      "approvedAt": "",
      "approverName": "",
      "createdAt": "2026/08/20 09:16",
      "updatedAt": "2026/08/20 09:16"
    }
  ]
}

2.2 一覧取得(date 指定)

  • GET {baseUrl}?app=dateCheck&date=2026-08(月次一覧取得)
  • GET {baseUrl}?app=dateCheck&date=2026-08-20(日次一覧取得)

date は YYYY/MM 、 YYYY/MM/DD 、ハイフン区切りのいずれも受け付けます。 範囲は管理画面の点検結果一覧と同じく、 registeredAt (端末送信時の当日 00:00)です。

💡 サーバー側での自動フィルタリング・ソート規則

  • 認証されたAPIキーに紐づく shopUID のデータのみに自動制限されます。
  • データは 登録日順(registeredAt の昇順) 、同じ登録日内においては 製品名順(productName の昇順) 、さらに同じ製品名内では 送信日時順(sentAt の昇順) でソートして返却されます。

2.3 🗂️ 点検結果オブジェクト詳細定義(GETレスポンス)

フィールドキー論理名データ型概要・返却値のルール
idドキュメントIDstringデータベース上で一意に割り振られたドキュメントID。
productName製品名string点検対象の製品名。一覧の「製品名」に相当します。
allowableDays賞味期限許容日数number製品マスタの賞味期限許容日数。
deviceName端末名string送信した端末の名称。未設定のときは空文字です。
sender送信者名string点検を送信した担当者の氏名。
userUIDユーザーIDstring送信した端末ユーザーのID。
shopUID店舗IDstring点検結果が属する店舗ID。
checkItems点検項目array点検項目の配列。詳細は 2.4 を参照。
isNormalForReport点検結果boolean 全点検項目が合格なら true (画面の OK)、1件でも不合格なら false (画面の NG)。
registeredAt登録日string端末送信時の当日 00:00。一覧の日付・月の絞り込みに使います。
sentAt送信日時string端末が点検結果を保存した日時。
createdAt作成日時stringドキュメントの初回作成日時。
updatedAt更新日時stringドキュメントの最終更新日時。
confirmedAt確認日時string管理画面で確認された日時。未確認時は ""。
confirmerName確認者氏名string確認を行ったユーザーの氏名。未確認時は ""。
approvedAt承認日時string管理画面で承認された日時。未承認時は ""。
approverName承認者氏名string承認を行ったユーザーの氏名。未承認時は ""。

2.4 点検項目(checkItems)

詳細画面の「点検画像」に並ぶ各項目です。 画面の点検値は、 checkType が label のとき value 、 date のとき checkResult です。

フィールドキー論理名データ型概要・返却値のルール
title項目名string製品マスタの点検項目名。
checkType点検種別string"label" (ラベル)または "date" (賞味期限)。
readType読み取り形式string ラベルのとき "text" または "barcode" 。賞味期限のときは空文字。
value期待値stringラベルの照合値。賞味期限のときは空文字。
readLine読み取り行数numberラベル文字列の読み取り行数(1 / 2 / 3)。
datePatterns日付形式array 賞味期限の日付形式( YYYYMMDD / YYMMDD )。
dateSeparators区切り文字array賞味期限の区切り文字。
passOnlyOKのみ送信boolean賞味期限で、合格時のみ送信できる設定か。
isPassed項目の合否boolean 合格なら true (画面の OK)、不合格なら false (画面の NG)。
checkResult点検値string ラベルは "OK" / "NG" 。賞味期限は読み取った日付文字列。
imageIndex画像番号number 画像がある項目だけに付きます。 checkItems の番号で、2.5 の image に指定します。

2.5 点検画像の取得

点検結果の imageIndex を image に指定します。応答は JSON ではなく、その番号の JPEG 1 枚です。

  • Request: GET {baseUrl}?app=dateCheck&docId=label_check_doc_id_11111&image=0
  • Response: Content-Type: image/jpeg (JPEG ファイル本体)

2.1 の例には画像が 2 枚あります。ラベルは image=0 、賞味期限は image=1 で、上と同じ形の取得を 2 回します。

失敗したときの応答は次のとおりです。

条件HTTPステータスレスポンスボディ
docId が無い400docId query parameter is required for image
image が 0 以上の整数でない400image must be a non-negative integer
他店舗の docId403Forbidden
結果が無い、またはその番号に画像が無い404Not Found