Soracom

Unified Endpoint のレスポンスのフォーマットは、グループ設定の [Unified Endoint 設定] で変更できます。

Unified 形式

Unified 形式のレスポンスのフォーマットは以下のとおりです。

ステータスコード

すべての転送先へのリクエストが成功した場合は 200 が、ひとつでも失敗した場合は 207 が返されます。

プロパティ

レスポンスの例

すべての転送先で正常に送信できた場合の例

• ステータスコード: 200

• ボディ:

  {
    "result": "ok",
    "detail": {
      "SoracomBeam": {
        "statusCode": 200,
        "contentType": "text/html;charset=utf-8",
        "body": "Success: {\"temperature\"=>12.3, \"humidity\"=>45.6, \"time\"=>\"2024-09-02T12:34:56.789Z\"}",
        "headers": {
          "content-type": "text/html;charset=utf-8",
          "content-length": "84",
          "x-xss-protection": "1; mode=block",
          "x-content-type-options": "nosniff",
          "x-frame-options": "SAMEORIGIN",
          "connection": "close",
          "server": "thin"
        }
      },
      "SoracomHarvest": {
        "statusCode": 201
      }
    }
  }
  

1 つ以上の転送先からエラーが返却された場合

• ステータスコード: 207

• ボディ:

  {
    "result": "ng",
    "detail": {
      "SoracomBeam": {
        "statusCode": 200,
        "contentType": "text/html;charset=utf-8",
        "body": "Success: {\"temperature\"=>12.3, \"humidity\"=>45.6, \"time\"=>\"2024-09-02T12:34:56.789Z\"}",
        "headers": {
          "content-type": "text/html;charset=utf-8",
          "content-length": "84",
          "x-xss-protection": "1; mode=block",
          "x-content-type-options": "nosniff",
          "x-frame-options": "SAMEORIGIN",
          "connection": "close",
          "server": "thin"
        }
      },
      "SoracomHarvest": {
        "statusCode": 400,
        "body": "Invalid custom timestamp value in request"
      }
    }
  }
  

カスタムレスポンス機能

レスポンスのフォーマットで「カスタム」を選択した場合、成功時のレスポンスと失敗時のレスポンスを指定できます。

すべての転送先に対して正常に送信できた場合は「成功時のレスポンス」が返却されます。いずれかの転送先でエラーが返却された場合は「失敗時のレスポンス」が返却されます。