Made JoinData spec comparable to the DL draft; tagged JD endpoints with new/existing compared to draft

JoinData/README.md

@@ -0,0 +1,22 @@
+# JoinData message spec
+
+
+This directory contains the JoinData specs, derived from the ICAR ADE XML standard.
+
+The Open API Spec file contains the URL scheme for JoinData. It follows a specific structure that ultimately uses the ICAR ADE JSON messages.
+
+URL scheme vs message types
+---------------------------
+Each _message_ or _event_ has its own path. Per _path_, the (standardized) parameters are described. There is always a default type for errors (called error). The actual response is build up out of several types:
+* The full response for a message xxx is described in a type called xxxResponse. This contains an array of data sources that have responded
+* The xxxDataSources type describes the response per data source. It can contain information on the data source itself or errors it produced. There are all generic. It can also contain the actual message.
+* The xxxResponseDataSource type describes the actual response. This should be a wrapper to an ICAR defined JSON scheme, e.g. to an xxxResource file.
+
+
+Naming Conventions
+------------------
+
+A message that can be transported by itself should be placed in a file called xxxResource. Basic types that are reused in multiple messages and are not transported by themselves should be placed in a file called xxxType. An enum type should be located in a file called xxxCode.
+
+Typically, most messages have a plural version (e.g. icarGestationsResource) which is simply an array wrapping a singular type (e.g. icarGestationResource). In many cases, the endpoint would be defined on the plural version but this allows for more flexibility.
+

JoinData/icarAnimalIdSchemeCode.json

@@ -0,0 +1,6 @@
+{
+        "type": "string",
+        "enum": [
+          "nl-v1"
+        ]
+}

JoinData/icarAnimalIdType.json

@@ -0,0 +1,3 @@
+{
+	type: string
+}

JoinData/icarAnimalIdentifierType.json

@@ -0,0 +1,16 @@
+{
+        "required": [
+          "id",
+          "scheme"
+        ],
+        "type": "object",
+        "properties": {
+          "id": {
+            "$ref": "https://raw.githubusercontent.com/alamers/ICAR/master/JoinData/icarAnimalIdType.json"
+          },
+          "scheme": {
+            "$ref": "https://raw.githubusercontent.com/alamers/ICAR/master/JoinData/icarAnimalIdSchemeCode.json"
+          }
+        },
+        "description": "Identifies an animal"
+}

JoinData/icarAnimalMilkingSampleResource.json

@@ -0,0 +1,34 @@
+{
+	"type": "object",
+	"properties": {
+		"bottleIdentifierType": {
+			"type": "string",
+			"description": "The type of bottle identifiertype according to ICAR_BottleIdentifierCode",
+			"enum": [
+				"BRC",
+				"RFD"
+			]
+		},
+		"rackNumber": {
+			"type": "string",
+			"description": "Number of the sample rack"
+		},
+		"bottlePosition": {
+			"type": "string",
+			"description": "Position of the bottle in the sample rack"
+		},
+		"bottleIdentifier": {
+			"type": "string",
+			"description": "Bottle identifier read from barcode or RFID"
+		},
+		"validSampleFillingIndicator": {
+			"type": "string",
+			"description": "Indicator of valid sample filling according to ICAR_ValidSampleFillingIndicatorCode list",
+			"enum": [
+				"0",
+				"1",
+				"2"
+			]
+		}
+	}
+}

JoinData/icarAnimalMovementDataSetType.json

@@ -0,0 +1,6 @@
+{
+	"type": "array",
+	"items": {
+		"$ref": "https://raw.githubusercontent.com/alamers/ICAR/master/JoinData/icarAnimalMovementType.json"
+	}
+}

JoinData/icarAnimalMovementType.json

@@ -0,0 +1,14 @@
+{
+	"required": [
+		"arrival"
+	],
+	"type": "object",
+	"properties": {
+		"arrival": {
+			"$ref": "https://raw.githubusercontent.com/alamers/ICAR/master/JoinData/icarArrivalCoreDataSetType.json"
+		},
+		"departure": {
+			"$ref": "https://raw.githubusercontent.com/alamers/ICAR/master/JoinData/icarDepartureCoreDataSetType.json"
+		}
+	}
+}

JoinData/icarAnimalMovementsType.json

@@ -0,0 +1,6 @@
+{
+        "type": "array",
+        "items": {
+          "$ref": "https://raw.githubusercontent.com/alamers/ICAR/master/JoinData/icarAnimalMovementType.json"
+        }
+}

JoinData/icarAnimalRegistrationBodyType.json

@@ -0,0 +1,59 @@
+{
+        "required": [
+          "identifier",
+          "registrationDate",
+          "registrationType"
+        ],
+        "type": "object",
+        "properties": {
+          "registrationType": {
+            "$ref": "https://raw.githubusercontent.com/alamers/ICAR/master/JoinData/icarRegistrationCode.json"
+          },
+          "registrationDate": {
+            "$ref": "https://raw.githubusercontent.com/alamers/ICAR/master/JoinData/icarDateType.json"
+          },
+          "identifier": {
+            "$ref": "https://raw.githubusercontent.com/alamers/ICAR/master/JoinData/icarAnimalIdentifierType.json"
+          },
+          "specie": {
+            "$ref": "https://raw.githubusercontent.com/alamers/ICAR/master/JoinData/icarSpecieCode.json"
+          },
+          "gender": {
+            "$ref": "https://raw.githubusercontent.com/alamers/ICAR/master/JoinData/icarGenderCode.json"
+          },
+          "birth": {
+            "$ref": "https://raw.githubusercontent.com/alamers/ICAR/master/JoinData/icarDateType.json"
+          },
+          "breed": {
+            "$ref": "https://raw.githubusercontent.com/alamers/ICAR/master/JoinData/icarCodeType.json"
+          },
+          "sire": {
+            "$ref": "https://raw.githubusercontent.com/alamers/ICAR/master/JoinData/icarAnimalIdentifierType.json"
+          },
+          "recipientDam": {
+            "$ref": "https://raw.githubusercontent.com/alamers/ICAR/master/JoinData/icarAnimalIdentifierType.json"
+          },
+          "geneticDam": {
+            "$ref": "https://raw.githubusercontent.com/alamers/ICAR/master/JoinData/icarAnimalIdentifierType.json"
+          },
+          "number": {
+            "type": "string",
+            "description": "A meaningful identification code of the animal, not necessary unique within the location"
+          },
+          "earTagNumber": {
+            "type": "string",
+            "description": "The ear tag number"
+          },
+          "name": {
+            "type": "string",
+            "description": "The name of the animal"
+          },
+          "officialName": {
+            "type": "string",
+            "description": "The official name of the animal"
+          },
+          "productionPurpose": {
+            "$ref": "https://raw.githubusercontent.com/alamers/ICAR/master/JoinData/icarProductionPurposeCode.json"
+          }
+        }
+      }

JoinData/icarAnimalRegistrationResource.json

@@ -0,0 +1,64 @@
+{
+        "required": [
+          "identifier",
+          "registrationDate",
+          "registrationType"
+        ],
+        "type": "object",
+        "properties": {
+          "id": {
+            "type": "string",
+            "description": "A unique identifier for the posted message",
+            "format": "uuid"
+          },
+          "registrationType": {
+            "$ref": "https://raw.githubusercontent.com/alamers/ICAR/master/JoinData/icarRegistrationCode.json"
+          },
+          "registrationDate": {
+            "$ref": "https://raw.githubusercontent.com/alamers/ICAR/master/JoinData/icarDateType.json"
+          },
+          "identifier": {
+            "$ref": "https://raw.githubusercontent.com/alamers/ICAR/master/JoinData/icarAnimalIdentifierType.json"
+          },
+          "specie": {
+            "$ref": "https://raw.githubusercontent.com/alamers/ICAR/master/JoinData/icarSpecieCode.json"
+          },
+          "gender": {
+            "$ref": "https://raw.githubusercontent.com/alamers/ICAR/master/JoinData/icarGenderCode.json"
+          },
+          "birth": {
+            "$ref": "https://raw.githubusercontent.com/alamers/ICAR/master/JoinData/icarDateType.json"
+          },
+          "breed": {
+            "$ref": "https://raw.githubusercontent.com/alamers/ICAR/master/JoinData/icarCodeType.json"
+          },
+          "sire": {
+            "$ref": "https://raw.githubusercontent.com/alamers/ICAR/master/JoinData/icarAnimalIdentifierType.json"
+          },
+          "recipientDam": {
+            "$ref": "https://raw.githubusercontent.com/alamers/ICAR/master/JoinData/icarAnimalIdentifierType.json"
+          },
+          "geneticDam": {
+            "$ref": "https://raw.githubusercontent.com/alamers/ICAR/master/JoinData/icarAnimalIdentifierType.json"
+          },
+          "number": {
+            "type": "string",
+            "description": "A meaningful identification code of the animal, not necessary unique within the location"
+          },
+          "earTagNumber": {
+            "type": "string",
+            "description": "The ear tag number"
+          },
+          "name": {
+            "type": "string",
+            "description": "The name of the animal"
+          },
+          "officialName": {
+            "type": "string",
+            "description": "The official name of the animal"
+          },
+          "productionPurpose": {
+            "$ref": "https://raw.githubusercontent.com/alamers/ICAR/master/JoinData/icarProductionPurposeCode.json"
+          }
+        }
+}

JoinData/icarArrivalCoreDataSetType.json

@@ -0,0 +1,12 @@
+{
+        "required": [
+          "arrivalDate"
+        ],
+        "type": "object",
+        "properties": {
+          "arrivalDate": {
+            "$ref": "https://raw.githubusercontent.com/alamers/ICAR/master/JoinData/icarDateType.json"
+          }
+        },
+        "description": "not completely implemented yet!"
+}

JoinData/icarBiodiversityCollectiveType.json

@@ -0,0 +1,27 @@
+{
+        "type": "object",
+        "properties": {
+          "id": {
+            "type": "string",
+            "description": "collective number, according to SCAN coding"
+          },
+          "name": {
+            "type": "string",
+            "description": "name of the collective"
+          },
+          "otherProperties": {
+            "type": "array",
+            "description": "e.g. if the farmer is member of ANLb (anlb:true)",
+            "items": {
+              "type": "object",
+              "properties": {}
+            }
+          },
+          "packets": {
+            "type": "array",
+            "items": {
+              "$ref": "https://raw.githubusercontent.com/alamers/ICAR/master/JoinData/icarBiodiversityPacketType.json"
+            }
+          }
+        }
+      }

JoinData/icarBiodiversityPacketElementType.json

@@ -0,0 +1,53 @@
+{
+        "type": "object",
+        "properties": {
+          "elementId": {
+            "type": "string",
+            "description": "identifier of the element of this report. Per element unieke code. Kan dus niet onder verschillende pakketten en/of collectieven herhaald voorkomen."
+          },
+          "ownerlabel": {
+            "type": "array",
+            "description": "Verschillende TBO, eigen beheer",
+            "items": {
+              "type": "integer"
+            }
+          },
+          "size": {
+            "type": "string"
+          },
+          "value": {
+            "type": "number",
+            "description": "Ingetekende oppervlakte/ hoeveelheid van het betreffende BBM",
+            "format": "double"
+          },
+          "unitCode": {
+            "type": "string",
+            "description": "UN/CEFACT Common Code for Units of Measurement.",
+            "enum": [
+              "H18",
+              "C62"
+            ]
+          },
+          "contractStartDate": {
+            "type": "string",
+            "format": "date"
+          },
+          "contractEndDate": {
+            "type": "string",
+            "format": "date"
+          },
+          "lastInspectionDate": {
+            "type": "string",
+            "format": "date"
+          },
+          "inspectionResult": {
+            "type": "string",
+            "enum": [
+              "1",
+              "2",
+              "3",
+              "4"
+            ]
+          }
+        }
+      }

JoinData/icarBiodiversityPacketType.json

@@ -0,0 +1,23 @@
+{
+        "type": "object",
+        "properties": {
+          "packetCode": {
+            "type": "integer",
+            "description": "unique code for the bio diversity packet; Afgesproken unieke BBM code voor betreffende pakket uit de BBM coderingslijst."
+          },
+          "otherProperties": {
+            "type": "array",
+            "description": "e.g. if the packet is member of ANLb (anlb:true)",
+            "items": {
+              "type": "object",
+              "properties": {}
+            }
+          },
+          "elements": {
+            "type": "array",
+            "items": {
+              "$ref": "https://raw.githubusercontent.com/alamers/ICAR/master/JoinData/icarBiodiversityPacketElementType.json"
+            }
+          }
+        }
+}