icarAnimalSetResource

Description

Core schema for representing animal sets (often called groups or sessions).

The icarAnimalSetResource schema inherits from icarResource.

Properties

Name	Description	Required	Type
Id	Unique identifier in the source system for this animal set.	Yes	string
Name	Human readable name of the set.	No	string
Purpose	Purpose of the animal set.	No	icarSetPurposeType
Member	As per JSON-LD Hydra syntax, member provides the array of objects, in this case animals assigned to the set.	Yes	Array of  icarIdentifierType
Self	Uniform resource identifier (URI) of the resource (rel=self).	No	string
Meta	Meta-data for the resource. Mandatory if you wish to support synchronisation.	No	icarMetaDataType
Location	Unique location scheme and identifier combination.	No	icarIdentifierType

Examples

Example 1

{
  "id": "id",
  "name": "name",
  "purpose": "Enclosure",
  "member": [
    {
      "id": "id",
      "scheme": "scheme"
    }
  ],
  "resourceType": "resourceType",
  "@self": "@self",
  "meta": {
    "source": "source",
    "sourceId": "sourceId",
    "isDeleted": false,
    "modified": "2024-05-29T21:48:11.6190416+00:00",
    "created": "2024-05-29T21:48:11.6190431+00:00",
    "creator": "creator",
    "validFrom": "2024-05-29T21:48:11.6190455+00:00",
    "validTo": "2024-05-29T21:48:11.6190468+00:00"
  },
  "location": {
    "id": "id",
    "scheme": "scheme"
  }
}