Add locations resource

collections/icarLocationCollection.json

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

resources/icarLocationResource.json

@@ -0,0 +1,32 @@
+{
+  "description": "An  location scheme / location id combinations.",
+
+  "allOf": [{
+      "$ref": "./icarResource.json",
+    }, {
+      "type": "object",
+
+      "required": [
+        "identifier"
+      ],
+
+      "properties": {
+        "identifier": {
+          "$ref": "../types/icarLocationIdentifierType.json",
+          "description": "Unique location scheme and identifier combination."
+        },
+        "alternativeIdentifiers": {
+          "type": "array",
+          "items": {
+            "$ref": "../types/icarLocationIdentifierType.json"
+          },
+          "description": "Alternative identifiers for the location. Must be a 1:1 mapping, meaning that when querying resources with an alternative identifier (instead of the 'main' identifier), the response may not be different."
+        },
+        "name": {
+          "type": "string",
+          "description": "The human readable name of the location."
+        }
+      }
+    }
+  ]
+}

url-schemes/exampleUrlScheme.json

@@ -35,6 +35,36 @@
     }
   ],
   "paths": {
+    "/locations": {
+      "get": {
+        "operationId": "get-locations",
+        "summary": "Get available schema/id combinations for locations.",
+        "description": "# Purpose\nProvide a list of available locations.\nShould return only those combinations the user currently logged in has access to.",
+        "tags": [
+          "additions"
+        ],
+        "responses": {
+          "200": {
+            "description": "Successful. The response contains the available locations.",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/icarLocationCollection"
+                },
+                "examples": {
+                  "base": {
+                    "$ref": "#/components/examples/locations"
+                  }
+                }
+              }
+            }
+          },
+          "default": {
+            "$ref": "#/components/responses/default"
+          }
+        }
+      }
+    },
     "/locations/{location-scheme}/{location-id}/milking-visits": {
       "get": {
         "operationId": "get-milking-visits",
@@ -708,6 +738,9 @@
       "error": {
         "$ref": "../resources/exampleErrorResource.json"
       },
+      "icarLocationCollection": {
+        "$ref": "../collections/icarLocationCollection.json"
+      },
       "icarMilkingVisitEventCollection": {
         "$ref": "../collections/icarMilkingVisitEventCollection.json"
       },
@@ -825,6 +858,32 @@
       }
     },
     "examples": {
+      "locations": {
+        "value": {
+          "view": {
+            "totalItems": 1,
+            "totalPages": 1,
+            "pageSize": 10,
+            "currentPage": 1
+          },
+          "member": [{
+            "identifier": {
+              "id": "276031231231234",
+              "schema": "eu.farmId"
+            },
+            "name": "My little farm",
+            "meta": {
+              "source": "source",
+              "creator": "creator",
+              "modified": "2020-01-29T08:49:06.1314223+00:00",
+              "created": "2020-01-29T08:49:06.1314223+00:00",
+              "validFrom": null,
+              "validTo": null
+            }
+          }
+         ],
+        }
+      },
       "arrival": {
         "value": {
           "view": {