#285 milk predictions

collections/icarMilkPredictionsCollection.json

@@ -0,0 +1,21 @@
+{
+  "description": "Represents a collection of milk predictions per animal. Based on icarResourceCollection to provide paging etc.",
+
+  "allOf": [{
+      "$ref": "../collections/icarResourceCollection.json"
+    },
+    {
+      "type": "object",
+
+      "properties": {
+        "member": {
+          "type": "array",
+          "items": {
+            "$ref": "../resources/icarMilkPredictionResource.json"
+          },
+          "description": "As per JSON-LD Hydra syntax, member provides the array of objects, in this case milk prediction events."
+        }
+      }
+    }
+  ]
+}

resources/icarMilkPredictionResource.json

@@ -0,0 +1,27 @@
+{
+  "description": "This returns a prediction of the expected milk, fat and protein for a cow for the remaining the lactation. Also a prediction of this production on the next testday is included and it eventually gives indication of when the peak production is reached.",
+
+  "allOf": [{
+      "$ref": "../resources/icarAnimalEventCoreResource.json"
+    },
+    {
+      "type": "object",
+
+      "properties": {
+        "averagePredictedProduction": {
+          "$ref": "../types/icarMilkingPredictionType.json"
+        },
+        "daysInMilkAtLactationPeak": {
+          "type": "integer",
+          "description": "The days in milk in a lactation when the peak production is expected to occur."
+        },
+        "lactationPeakProduction": {
+          "$ref": "../types/icarMilkingMilkWeightType.json"
+        },
+        "PredictedProductionNextMR": {
+          "$ref": "../types/icarMilkingPredictionType.json"
+        }
+      }
+    }
+  ]
+}

resources/icarTestDayResultEventResource.json

@@ -19,7 +19,10 @@
           "items": {
             "$ref": "../types/icarMilkCharacteristicsType.json"
           }
-        }
+        },
+        "PredictedProductionOnTestday": {
+          "$ref": "../types/icarMilkingPredictionType.json"
+	}
       }
     }
   ]

types/icarMilkingFatWeightType.json

@@ -0,0 +1,24 @@
+{
+  "description": "The amount of fat milked",
+
+  "type": "object",
+
+  "required": [
+    "unitCode",
+    "value"
+  ],
+
+  "properties": {
+    "unitCode": {
+      "type": "string",
+      "description": "UN/CEFACT Common Code for Units of Measurement.",
+      "enum": [
+        "KGM"
+      ]
+    },
+    "value": {
+      "type": "number",
+      "format": "double"
+    }
+  }
+}

types/icarMilkingPredictionType.json

@@ -0,0 +1,26 @@
+{
+  "description": "The amount of milk, fat and protein milked in a defined period of time",
+
+  "type": "object",
+
+  "required": [
+    "unitCode",
+    "value"
+  ],
+
+  "properties": {
+    "MilkWeight": {
+      "$ref": "../types/icarMilkingMilkWeightType.json"
+    },
+    "FatWeight": {
+      "$ref": "../types/icarMilkingFatWeightType.json"
+    },
+    "ProteinWeight": {
+      "$ref": "../types/icarMilkingProteinWeightType.json"
+    },
+    "Hours": {
+      "type": "number",
+      "description": "The number of hours in which the mentioned milk, fat and protein were produced. Most commonly used is a 24 hours production."
+    }
+  }
+}

types/icarMilkingProteinWeightType.json

@@ -0,0 +1,24 @@
+{
+  "description": "The amount of protein milked",
+
+  "type": "object",
+
+  "required": [
+    "unitCode",
+    "value"
+  ],
+
+  "properties": {
+    "unitCode": {
+      "type": "string",
+      "description": "UN/CEFACT Common Code for Units of Measurement.",
+      "enum": [
+        "KGM"
+      ]
+    },
+    "value": {
+      "type": "number",
+      "format": "double"
+    }
+  }
+}

url-schemes/exampleUrlScheme.json

@@ -14,7 +14,7 @@
     "url": "https://icar-ade.standard.com"
   }],
   "tags": [{
-      "name": "ADE-1.3 additions",
+      "name": "ADE-1.4 additions",
       "description": "new endpoints not yet approved"
     },
     {
@@ -249,6 +249,45 @@
         }
       }
     },
+    "/locations/{location-scheme}/{location-id}/milk-predictions": {
+        "get": {
+            "operationId": "get-milk-predictions",
+            "summary": "Get the milk predictions for a certain location",
+            "description": "# Purpose\nProvides the milk predictions for a location\n",
+            "tags": [
+                "ADE-1.4 additions"
+            ],
+            "parameters": [
+                {
+                    "$ref": "#/components/parameters/location-scheme"
+                },
+                {
+                    "$ref": "#/components/parameters/location-id"
+                },
+                {
+                    "$ref": "#/components/parameters/meta-modified-from"
+                },
+                {
+                    "$ref": "#/components/parameters/meta-modified-to"
+                }
+            ],
+            "responses": {
+                "200": {
+                    "description": "Successful. The response contains the milk predictions for the given location.",
+                    "content": {
+                        "application/json": {
+                            "schema": {
+                                "$ref": "#/components/schemas/icarMilkPredictionsCollection"
+                            }
+                        }
+                    }
+                },
+                "default": {
+                    "$ref": "#/components/responses/default"
+                }
+            }
+        }
+    },
     "/locations/{location-scheme}/{location-id}/daily-milking-averages": {
       "get": {
         "operationId": "get-daily-milking-averages",
@@ -2066,6 +2105,9 @@
       "icarWithdrawalEventCollection": {
         "$ref": "../collections/icarWithdrawalEventCollection.json"
       },
+      "icarMilkPredictionsCollection": {
+         "$ref": "../collections/icarMilkPredictionsCollection.json"
+      },
       "icarReproMatingRecommendationCollection": {
         "$ref": "../collections/icarReproMatingRecommendationCollection.json"
       },

url-schemes/milkURLScheme.json

@@ -16,6 +16,10 @@
         }
     ],
     "tags": [
+        {
+          "name": "ADE-1.4-milk",
+          "description": "new endpoints not yet approved"
+        },
         {
             "name": "ADE-1.3-milk",
             "description": "Milking-related messages approved by the working group"
@@ -361,7 +365,7 @@
                 ],
                 "responses": {
                     "200": {
-                        "description": "Successful. The response contains the diagnoses for the given location.",
+                        "description": "Successful. The response contains the daily milk averages for the given location.",
                         "content": {
                             "application/json": {
                                 "schema": {
@@ -376,6 +380,45 @@
                 }
             }
         },
+        "/locations/{location-scheme}/{location-id}/milk-predictions": {
+            "get": {
+                "operationId": "get-milk-predictions",
+                "summary": "Get the milk predictions for a certain location",
+                "description": "# Purpose\nProvides the milk predictions for a location\n",
+                "tags": [
+                    "ADE-1.4-milk"
+                ],
+                "parameters": [
+                    {
+                        "$ref": "#/components/parameters/location-scheme"
+                    },
+                    {
+                        "$ref": "#/components/parameters/location-id"
+                    },
+                    {
+                        "$ref": "#/components/parameters/meta-modified-from"
+                    },
+                    {
+                        "$ref": "#/components/parameters/meta-modified-to"
+                    }
+                ],
+                "responses": {
+                    "200": {
+                        "description": "Successful. The response contains the milk predictions for the given location.",
+                        "content": {
+                            "application/json": {
+                                "schema": {
+                                    "$ref": "#/components/schemas/icarMilkPredictionsCollection"
+                                }
+                            }
+                        }
+                    },
+                    "default": {
+                        "$ref": "#/components/responses/default"
+                    }
+                }
+            }
+        },
         "/locations/{location-scheme}/{location-id}/lactations": {
             "get": {
                 "operationId": "get-lactations",
@@ -516,7 +559,7 @@
         },
         "/locations/{location-scheme}/{location-id}/milking-withdrawals": {
             "get": {
-                "operationId": "get existing milking-withdrawals",
+                "operationId": "get-existing-milking-withdrawals",
                 "summary": "Get the milking-withdrawals for a certain location",
                 "description": "# Purpose\nProvides the milking-withdrawals for a certain location\n",
                 "tags": [
@@ -901,6 +944,9 @@
             "icarDailyMilkingAveragesCollection": {
                 "$ref": "../collections/icarDailyMilkingAveragesCollection.json"
             },
+            "icarMilkPredictionsCollection": {
+                "$ref": "../collections/icarMilkPredictionsCollection.json"
+            },
             "icarLactationCollection": {
                 "$ref": "../collections/icarLactationCollection.json"
             },