icarAnimalSetResource.json

{
  "description": "Core schema for representing animal sets (often called groups or sessions).",

  "allOf": [
    {
      "$ref": "../resources/icarResource.json"
    },
    {
      "type": "object",

      "required": [
        "id",
        "member"
      ],
      
      "properties": {
        "id": {
          "type": "string",
          "description": "Unique identifier in the source system for this animal set."
        },
        "name": {
          "type": "string",
          "description": "Human readable name of the set."
        },
        "reference": {
          "type": "string",
          "description": "This property can be used by parties for any other reference information used to synchronise systems or display to the user."
        },
        "purpose": {
          "$ref": "../enums/icarSetPurposeType.json",
          "description": "Purpose of the animal set."
        },
        "member": {
          "type": "array",
          "items": {
            "$ref": "../types/icarAnimalIdentifierType.json"
          },
          "description": "As per JSON-LD Hydra syntax, member provides the array of objects, in this case animals assigned to the set."
        }
      }
    }
  ]
}