milkURLScheme.json

{
    "openapi": "3.1.0",
    "info": {
        "title": "Milk recording and lactation information API Specifications",
        "description": "Specifications for messages that support dairy milking visits, lactation, and related information.",
        "version": "1.4",
        "contact": {
            "name": "Animal Data Exchange Working Group",
            "url": "https://www.icar.org/index.php/technical-bodies/working-groups/animal-data-exchange-wg/",
            "email": "icar@icar.org"
        }
    },
    "servers": [
        {
            "url": "https://icar-ade.standard.com"
        }
    ],
    "tags": [
        {
            "name": "ADE-1.4-milk",
            "description": "Milking-related messages approved by the working group"
        }
    ],
    "paths": {
        "/locations/{location-scheme}/{location-id}/milking-visits": {
            "get": {
                "operationId": "get-milking-visits",
                "summary": "Get the milking-visits for a certain location",
                "description": "# Purpose\nProvides the animal milking-visits 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 diagnoses for the given location.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/icarMilkingVisitEventCollection"
                                }
                            }
                        }
                    },
                    "default": {
                        "$ref": "#/components/responses/default"
                    }
                }
            },
            "post": {
                "operationId": "post-single-milking-visits",
                "summary": "Add a single new milking-visits.",
                "description": "# Purpose\nAllows a client to add a single milking-visits.\n",
                "tags": [
                    "ADE-1.4-milk"
                ],
                "parameters": [
                    {
                        "$ref": "#/components/parameters/location-scheme"
                    },
                    {
                        "$ref": "#/components/parameters/location-id"
                    }
                ],
                "requestBody": {
                    "required": true,
                    "description": "The milking-visits to create. \nA client MAY fill in the *Id* field with a client-generated UUID and the server MAY use this *Id*.\nIf the server does not use the client-specified *ID* field it shall issue its own *ID* for the resource.\nA client SHALL ensure that the *meta.source* and *meta.sourceId* fields are filled by the client.\n",
                    "content": {
                        "application/json": {
                            "schema": {
                                "$ref": "#/components/schemas/icarMilkingVisitEventResource"
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "Successful. The response contains a copy of the event, as modifed by the server.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/icarMilkingVisitEventResource"
                                }
                            }
                        }
                    },
                    "201": {
                        "description": "Created. The Location header contains the URI to the new resource.",
                        "headers": {
                            "Location": {
                                "schema": {
                                    "type": "string",
                                    "format": "uri"
                                },
                                "description": "Contains the URI to the new resource."
                            }
                        }
                    },
                    "202": {
                        "description": "Accepted. The Location header contains a URI that the client can query for processing status.",
                        "headers": {
                            "Location": {
                                "schema": {
                                    "type": "string",
                                    "format": "uri"
                                },
                                "description": "Contains a URI to query creation status."
                            }
                        }
                    },
                    "default": {
                        "$ref": "#/components/responses/default"
                    }
                }
            }
        },
        "/locations/{location-scheme}/{location-id}/test-days": {
            "get": {
                "operationId": "get-test-day",
                "summary": "Get the test-day for a certain location",
                "description": "# Purpose\nProvides the animal test-day 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 diagnoses for the given location.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/icarTestDayCollection"
                                }
                            }
                        }
                    },
                    "default": {
                        "$ref": "#/components/responses/default"
                    }
                }
            },
            "post": {
                "operationId": "post-single-test-day",
                "summary": "Add a single new test-day.",
                "description": "# Purpose\nAllows a client to add a single test-day.\n",
                "tags": [
                    "ADE-1.4-milk"
                ],
                "parameters": [
                    {
                        "$ref": "#/components/parameters/location-scheme"
                    },
                    {
                        "$ref": "#/components/parameters/location-id"
                    }
                ],
                "requestBody": {
                    "required": true,
                    "description": "The test-day to create. \nA client MAY fill in the *Id* field with a client-generated UUID and the server MAY use this *Id*.\nIf the server does not use the client-specified *ID* field it shall issue its own *ID* for the resource.\nA client SHALL ensure that the *meta.source* and *meta.sourceId* fields are filled by the client.\n",
                    "content": {
                        "application/json": {
                            "schema": {
                                "$ref": "#/components/schemas/icarTestDayResource"
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "Successful. The response contains a copy of the event, as modifed by the server.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/icarTestDayResource"
                                }
                            }
                        }
                    },
                    "201": {
                        "description": "Created. The Location header contains the URI to the new resource.",
                        "headers": {
                            "Location": {
                                "schema": {
                                    "type": "string",
                                    "format": "uri"
                                },
                                "description": "Contains the URI to the new resource."
                            }
                        }
                    },
                    "202": {
                        "description": "Accepted. The Location header contains a URI that the client can query for processing status.",
                        "headers": {
                            "Location": {
                                "schema": {
                                    "type": "string",
                                    "format": "uri"
                                },
                                "description": "Contains a URI to query creation status."
                            }
                        }
                    },
                    "default": {
                        "$ref": "#/components/responses/default"
                    }
                }
            }
        },
        "/locations/{location-scheme}/{location-id}/test-day-results": {
            "get": {
                "operationId": "get-test-day-result",
                "summary": "Get the test-day-result for a certain location",
                "description": "# Purpose\nProvides the animal test-day-result 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 diagnoses for the given location.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/icarTestDayResultEventCollection"
                                }
                            }
                        }
                    },
                    "default": {
                        "$ref": "#/components/responses/default"
                    }
                }
            },
            "post": {
                "operationId": "post-single-test-day-result",
                "summary": "Add a single new test-day-result.",
                "description": "# Purpose\nAllows a client to add a single test-day-result.\n",
                "tags": [
                    "ADE-1.4-milk"
                ],
                "parameters": [
                    {
                        "$ref": "#/components/parameters/location-scheme"
                    },
                    {
                        "$ref": "#/components/parameters/location-id"
                    }
                ],
                "requestBody": {
                    "required": true,
                    "description": "The test-day-result to create. \nA client MAY fill in the *Id* field with a client-generated UUID and the server MAY use this *Id*.\nIf the server does not use the client-specified *ID* field it shall issue its own *ID* for the resource.\nA client SHALL ensure that the *meta.source* and *meta.sourceId* fields are filled by the client.\n",
                    "content": {
                        "application/json": {
                            "schema": {
                                "$ref": "#/components/schemas/icarTestDayResultEventResource"
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "Successful. The response contains a copy of the event, as modifed by the server.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/icarTestDayResultEventResource"
                                }
                            }
                        }
                    },
                    "201": {
                        "description": "Created. The Location header contains the URI to the new resource.",
                        "headers": {
                            "Location": {
                                "schema": {
                                    "type": "string",
                                    "format": "uri"
                                },
                                "description": "Contains the URI to the new resource."
                            }
                        }
                    },
                    "202": {
                        "description": "Accepted. The Location header contains a URI that the client can query for processing status.",
                        "headers": {
                            "Location": {
                                "schema": {
                                    "type": "string",
                                    "format": "uri"
                                },
                                "description": "Contains a URI to query creation status."
                            }
                        }
                    },
                    "default": {
                        "$ref": "#/components/responses/default"
                    }
                }
            }
        },
        "/locations/{location-scheme}/{location-id}/daily-milking-averages": {
            "get": {
                "operationId": "get-daily-milking-averages",
                "summary": "Get the daily milking averages for a certain location",
                "description": "# Purpose\nProvides the animal daily milking averages 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 diagnoses for the given location.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/icarDailyMilkingAveragesCollection"
                                }
                            }
                        }
                    },
                    "default": {
                        "$ref": "#/components/responses/default"
                    }
                }
            }
        },
        "/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",
                "summary": "Get the lactations for a certain location",
                "description": "# Purpose\nProvides the animal lactation for a location\n",
                "tags": [
                    "ADE-1.4-milk"
                ],
                "parameters": [
                    {
                        "$ref": "#/components/parameters/location-scheme"
                    },
                    {
                        "$ref": "#/components/parameters/location-id"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "Successful. The response contains the diagnoses for the given location.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/icarLactationCollection"
                                }
                            }
                        }
                    },
                    "default": {
                        "$ref": "#/components/responses/default"
                    }
                }
            }
        },
        "/locations/{location-scheme}/{location-id}/lactation-status-observations": {
            "get": {
                "operationId": "get-lactation-status-observations",
                "summary": "Get the lactation status observations for a certain location",
                "description": "# Purpose\nProvides the animal lactation status observations 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 diagnoses for the given location.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/icarLactationStatusObservedEventCollection"
                                }
                            }
                        }
                    },
                    "default": {
                        "$ref": "#/components/responses/default"
                    }
                }
            },
            "post": {
                "operationId": "post-single-lactation-status-observation",
                "summary": "Add a single new lactation status observation event.",
                "description": "# Purpose\nAllows a client to add a single lactation status observation event.\n",
                "tags": [
                    "ADE-1.4-milk"
                ],
                "parameters": [
                    {
                        "$ref": "#/components/parameters/location-scheme"
                    },
                    {
                        "$ref": "#/components/parameters/location-id"
                    }
                ],
                "requestBody": {
                    "required": true,
                    "description": "The lactation-status-observation to create. \nA client MAY fill in the *Id* field with a client-generated UUID and the server MAY use this *Id*.\nIf the server does not use the client-specified *ID* field it shall issue its own *ID* for the resource.\nA client SHALL ensure that the *meta.source* and *meta.sourceId* fields are filled by the client.\n",
                    "content": {
                        "application/json": {
                            "schema": {
                                "$ref": "#/components/schemas/icarLactationStatusObservedEventResource"
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "Successful. The response contains a copy of the event, as modifed by the server.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/icarLactationStatusObservedEventResource"
                                }
                            }
                        }
                    },
                    "201": {
                        "description": "Created. The Location header contains the URI to the new resource.",
                        "headers": {
                            "Location": {
                                "schema": {
                                    "type": "string",
                                    "format": "uri"
                                },
                                "description": "Contains the URI to the new resource."
                            }
                        }
                    },
                    "202": {
                        "description": "Accepted. The Location header contains a URI that the client can query for processing status.",
                        "headers": {
                            "Location": {
                                "schema": {
                                    "type": "string",
                                    "format": "uri"
                                },
                                "description": "Contains a URI to query creation status."
                            }
                        }
                    },
                    "default": {
                        "$ref": "#/components/responses/default"
                    }
                }
            }
        },
        "/locations/{location-scheme}/{location-id}/milking-withdrawals": {
            "get": {
                "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": [
                    "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 withdrawals for the given location.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/icarWithdrawalEventCollection"
                                }
                            }
                        }
                    },
                    "default": {
                        "$ref": "#/components/responses/default"
                    }
                }
            }
        },
        "/batches/locations/{location-scheme}/{location-id}/milking-visits": {
            "post": {
                "operationId": "post-batch-milking-visits",
                "summary": "Add a single new milking-visits event",
                "description": "# Purpose \nAllows a client to add a collection of milking visits.\n",
                "tags": [
                    "ADE-1.4-milk"
                ],
                "parameters": [
                    {
                        "$ref": "#/components/parameters/location-scheme"
                    },
                    {
                        "$ref": "#/components/parameters/location-id"
                    }
                ],
                "requestBody": {
                    "required": true,
                    "description": "The collection of {milking-visits:node} to create. \nA client MAY fill in resource *Id*s with a client-generated UUID and the server MAY use these *Id*s.\nIf the server does not use the client-specified *Id* field it shall issue its own *Id*s for the resources.\nA client SHALL ensure that the *meta.source* and *meta.sourceId* fields are filled by the client.\n",
                    "content": {
                        "application/json": {
                            "schema": {
                                "$ref": "#/components/schemas/icarMilkingVisitEventArray"
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "Successful. The response contains a set of batch results, which may include warnings.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/batchResults"
                                }
                            }
                        }
                    },
                    "201": {
                        "description": "Created. The Location header contains URI to retrieve a set of batch results, which may include warnings.",
                        "headers": {
                            "Location": {
                                "schema": {
                                    "type": "string",
                                    "format": "uri"
                                },
                                "description": "Contains the URI to the results."
                            }
                        }
                    },
                    "202": {
                        "description": "Accepted. The Location header contains a URI that the client can query for processing status.",
                        "headers": {
                            "Location": {
                                "schema": {
                                    "type": "string",
                                    "format": "uri"
                                },
                                "description": "Contains a URI to query creation status."
                            }
                        }
                    },
                    "default": {
                        "description": "The response contains a set of batch results, which may include errors and warnings.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/batchResults"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/batches/locations/{location-scheme}/{location-id}/test-days": {
            "post": {
                "operationId": "post-batch-test-days",
                "summary": "Add batch of test-days.",
                "description": "# Purpose \nAllows a client to add a collection of test-days.\n",
                "tags": [
                    "ADE-1.4-milk"
                ],
                "parameters": [
                    {
                        "$ref": "#/components/parameters/location-scheme"
                    },
                    {
                        "$ref": "#/components/parameters/location-id"
                    }
                ],
                "requestBody": {
                    "required": true,
                    "description": "The collection of test-days to create. \nA client MAY fill in resource *Id*s with a client-generated UUID and the server MAY use these *Id*s.\nIf the server does not use the client-specified *Id* field it shall issue its own *Id*s for the resources.\nA client SHALL ensure that the *meta.source* and *meta.sourceId* fields are filled by the client.\n",
                    "content": {
                        "application/json": {
                            "schema": {
                                "$ref": "#/components/schemas/icarTestDayArray"
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "Successful. The response contains a set of batch results, which may include warnings.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/batchResults"
                                }
                            }
                        }
                    },
                    "201": {
                        "description": "Created. The Location header contains URI to retrieve a set of batch results, which may include warnings.",
                        "headers": {
                            "Location": {
                                "schema": {
                                    "type": "string",
                                    "format": "uri"
                                },
                                "description": "Contains the URI to the results."
                            }
                        }
                    },
                    "202": {
                        "description": "Accepted. The Location header contains a URI that the client can query for processing status.",
                        "headers": {
                            "Location": {
                                "schema": {
                                    "type": "string",
                                    "format": "uri"
                                },
                                "description": "Contains a URI to query creation status."
                            }
                        }
                    },
                    "default": {
                        "description": "The response contains a set of batch results, which may include errors and warnings.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/batchResults"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/batches/locations/{location-scheme}/{location-id}/test-day-results": {
            "post": {
                "operationId": "post-batch-test-day-results",
                "summary": "Add an array of test-day-results.",
                "description": "# Purpose \nAllows a client to add a collection of test-day-result.\n",
                "tags": [
                    "ADE-1.4-milk"
                ],
                "parameters": [
                    {
                        "$ref": "#/components/parameters/location-scheme"
                    },
                    {
                        "$ref": "#/components/parameters/location-id"
                    }
                ],
                "requestBody": {
                    "required": true,
                    "description": "The collection of test day results to create. \nA client MAY fill in resource *Id*s with a client-generated UUID and the server MAY use these *Id*s.\nIf the server does not use the client-specified *Id* field it shall issue its own *Id*s for the resources.\nA client SHALL ensure that the *meta.source* and *meta.sourceId* fields are filled by the client.\n",
                    "content": {
                        "application/json": {
                            "schema": {
                                "$ref": "#/components/schemas/icarTestDayResultEventArray"
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "Successful. The response contains a set of batch results, which may include warnings.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/batchResults"
                                }
                            }
                        }
                    },
                    "201": {
                        "description": "Created. The Location header contains URI to retrieve a set of batch results, which may include warnings.",
                        "headers": {
                            "Location": {
                                "schema": {
                                    "type": "string",
                                    "format": "uri"
                                },
                                "description": "Contains the URI to the results."
                            }
                        }
                    },
                    "202": {
                        "description": "Accepted. The Location header contains a URI that the client can query for processing status.",
                        "headers": {
                            "Location": {
                                "schema": {
                                    "type": "string",
                                    "format": "uri"
                                },
                                "description": "Contains a URI to query creation status."
                            }
                        }
                    },
                    "default": {
                        "description": "The response contains a set of batch results, which may include errors and warnings.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/batchResults"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/batches/locations/{location-scheme}/{location-id}/lactation-status-observations": {
            "post": {
                "operationId": "post-batch-lactation-status-observations",
                "summary": "Add an array of lactation status observations.",
                "description": "# Purpose \nAllows a client to add a collection of lactation status observations.\n",
                "tags": [
                    "ADE-1.4-milk"
                ],
                "parameters": [
                    {
                        "$ref": "#/components/parameters/location-scheme"
                    },
                    {
                        "$ref": "#/components/parameters/location-id"
                    }
                ],
                "requestBody": {
                    "required": true,
                    "description": "The collection of lactation status observations to create. \nA client MAY fill in resource *Id*s with a client-generated UUID and the server MAY use these *Id*s.\nIf the server does not use the client-specified *Id* field it shall issue its own *Id*s for the resources.\nA client SHALL ensure that the *meta.source* and *meta.sourceId* fields are filled by the client.\n",
                    "content": {
                        "application/json": {
                            "schema": {
                                "$ref": "#/components/schemas/icarLactationStatusObservedEventArray"
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "Successful. The response contains a set of batch results, which may include warnings.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/batchResults"
                                }
                            }
                        }
                    },
                    "201": {
                        "description": "Created. The Location header contains URI to retrieve a set of batch results, which may include warnings.",
                        "headers": {
                            "Location": {
                                "schema": {
                                    "type": "string",
                                    "format": "uri"
                                },
                                "description": "Contains the URI to the results."
                            }
                        }
                    },
                    "202": {
                        "description": "Accepted. The Location header contains a URI that the client can query for processing status.",
                        "headers": {
                            "Location": {
                                "schema": {
                                    "type": "string",
                                    "format": "uri"
                                },
                                "description": "Contains a URI to query creation status."
                            }
                        }
                    },
                    "default": {
                        "description": "The response contains a set of batch results, which may include errors and warnings.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/batchResults"
                                }
                            }
                        }
                    }
                }
            }
        }
    },
    "components": {
        "schemas": {
            "batchResults": {
                "type": "array",
                "items": {
                    "$ref": "../resources/icarBatchResult.json"
                }
            },
            "icarMilkingVisitEventResource": {
                "$ref": "../resources/icarMilkingVisitEventResource.json"
            },
            "icarMilkingVisitEventCollection": {
                "$ref": "../collections/icarMilkingVisitEventCollection.json"
            },
            "icarMilkingVisitEventArray": {
                "type": "array",
                "items": {
                    "$ref": "#/components/schemas/icarMilkingVisitEventResource"
                }
            },
            "icarTestDayResource": {
                "$ref": "../resources/icarTestDayResource.json"
            },
            "icarTestDayCollection": {
                "$ref": "../collections/icarTestDayCollection.json"
            },
            "icarTestDayArray": {
                "type": "array",
                "items": {
                    "$ref": "#/components/schemas/icarTestDayResource"
                }
            },
            "icarTestDayResultEventResource": {
                "$ref": "../resources/icarTestDayResultEventResource.json"
            },
            "icarTestDayResultEventCollection": {
                "$ref": "../collections/icarTestDayResultEventCollection.json"
            },
            "icarTestDayResultEventArray": {
                "type": "array",
                "items": {
                    "$ref": "#/components/schemas/icarTestDayResultEventResource"
                }
            },
            "icarDailyMilkingAveragesCollection": {
                "$ref": "../collections/icarDailyMilkingAveragesCollection.json"
            },
             "icarMilkPredictionsCollection": {
                "$ref": "../collections/icarMilkPredictionsCollection.json"
            },
            "icarLactationCollection": {
                "$ref": "../collections/icarLactationCollection.json"
            },
            "icarLactationStatusObservedEventResource": {
                "$ref": "../resources/icarLactationStatusObservedEventResource.json"
            },
            "icarLactationStatusObservedEventCollection": {
                "$ref": "../collections/icarLactationStatusObservedEventCollection.json"
            },
            "icarLactationStatusObservedEventArray": {
                "type": "array",
                "items": {
                    "$ref": "#/components/schemas/icarLactationStatusObservedEventResource"
                }
            },
            "icarWithdrawalEventCollection": {
                "$ref": "../collections/icarWithdrawalEventCollection.json"
            }
        },
        "parameters": {
            "location-scheme": {
                "name": "location-scheme",
                "in": "path",
                "description": "The scheme id for the location identifier.",
                "required": true,
                "schema": {
                    "type": "string"
                }
            },
            "location-id": {
                "name": "location-id",
                "in": "path",
                "description": "The unique identifier for the location.",
                "required": true,
                "schema": {
                    "type": "string"
                }
            },
            "meta-modified-from": {
                "name": "meta-modified-from",
                "in": "query",
                "description": "The start of the date-time range for the data to get in the request.",
                "schema": {
                    "type": "string",
                    "format": "date-time"
                }
            },
            "meta-modified-to": {
                "name": "meta-modified-to",
                "in": "query",
                "description": "The end of the date-time range for the data to get in the request.",
                "schema": {
                    "type": "string",
                    "format": "date-time"
                }
            }
        },
        "responses": {
          "default": {
            "description": "An error has occured while handling the request. Check the content of the message for the error details.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "../collections/icarErrorCollection.json"
                }
              }
            }
          }
        }
    }
}