Merge pull request #405 from adewg/erwinspeybroeck

Add service-sires API - #402
adewg · Aug 24, 2023 · 9a0699d · 9a0699d
2 parents e6dc41f + 3e14f12
commit 9a0699d
Showing 1 changed file with 32 additions and 0 deletions.
diff --git a/url-schemes/exampleUrlScheme.json b/url-schemes/exampleUrlScheme.json
@@ -717,6 +717,38 @@
         }
       }
     },
+    "/service-sires": {
+      "get": {
+        "operationId": "get-service-sires",
+        "summary": "Get the service sires matching your query parameters - for now we only implement the query by some identifier, like lifetime number, ai-code, ... ",
+        "description": "# Purpose\nProvides the service sires.\nOnly animal fields relevant to service sires will be populated (location is not expected, for example).",
+        "tags": [
+          "ADE-1.3-registration"
+        ],
+        "parameters": [{
+            "$ref": "#/components/parameters/identifier-scheme"
+          },
+          {
+            "$ref": "#/components/parameters/identifier-id"
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Successful. The response contains the service sires matching your query parameters",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/icarAnimalCoreCollection"
+                }
+              }
+            }
+          },
+          "default": {
+            "$ref": "#/components/responses/default"
+          }
+        }
+      }
+    },
     "/locations/{location-scheme}/{location-id}/statistics": {
             "get": {
                 "operationId": "get-statistics",