コンテンツにスキップ

ランキングデータ

目的

エンジンが出力したランキングデータを取得します。

基本項目

項目 備考
url /api/ranking/:farm_id
メソッド GET
content-type application/json
文字コード utf-8

リクエスト

ヘッダ

ヘッダ名
X-fn-gene-api-idtoken Firebase ID Token

パラメータ(URL)

パラメータ名 名称 サイズ
farm_id 牧場ID string(半角数字) 10byte
cow_id 個体番号 string(半角英数)

パラメータ(クエリ)

なし

ボディ(JSON)

なし

レスポンス

レスポンスステータス

HTTPステータス 内容
200 JSON
401 認証エラー
404 対象がない
500 その他エラー

レスポンスサンプル

  • Content-Type Application/Json
{
  "items": [
    {
      "category": {
        "title": "DWP$",
        "description": "1頭の乳牛の期待生涯利益を表した選択指数..."
      },
      "enrolled_cows": {
        "good": [
          {
            "value": 100,
            "cow_id": {
              "origin": "1234567890",
              "prefix": "12345",
              "middle": "6789",
              "suffix": "0"
            }
          }
        ],
        "bad": [
          {
            "value": 100,
            "cow_id": {
              "origin": "1234567890",
              "prefix": "12345",
              "middle": "6789",
              "suffix": "0"
            }
          }
        ]
      },
      "all_cows": {
        "good": [
          {
            "value": 100,
            "cow_id": {
              "origin": "1234567890",
              "prefix": "12345",
              "middle": "6789",
              "suffix": "0"
            }
          }
        ],
        "bad": [
          {
            "value": 100,
            "cow_id": {
              "origin": "1234567890",
              "prefix": "12345",
              "middle": "6789",
              "suffix": "0"
            }
          }
        ]
      }
    }
  ]
}