1. Home
2. JSON
3. Sample

Sample Data Type

Properties

name	data type	description
occurrences	array of Occurrence
Properties inherited from SampleBase
sampleMethod	SampleMethod	The method used for this sample.
date	VagueDate	The date when sampling occured.
locality	Locality	Describes the position of this sample.
survey	SurveyBase	The survey to which this sample belongs.
recorder	Person	The person who did this sample.
tags	array of string
Properties inherited from BaseUUID
id	string
Properties inherited from Base
createdBy	string	The id of the user who created this entity. This entity is read only and populated by the service. It is ignored when saving entities.
creationDate	string	The timestamp of the cration of this entity. The timestamp is in the timezone Europe/Berlin by default. This entity is read only and populated by the service. It is ignored when saving entities.
links	array of Link	A collection of Links related to this entity. This entity is read only and populated by the service. It is ignored when saving entities.
modifiedBy	string	The id of the user who changed this entity last. This entity is read only and populated by the service. It is ignored when saving entities.
modificationDate	string	The timestamp of the last modification on this entity. The timestamp is in the timezone Europe/Berlin by default. This entity is read only and populated by the service. It is ignored when saving entities.
userAlloewdToEdit	boolean	Indicates weather the user who made the request is allowed to edit this entity or not. This entity is read only and populated by the service. It is ignored when saving entities.
obfuscated	boolean	Indicate weather the data is obfuscated This entity is read only and populated by the service. It is ignored when saving entities.
allowedOperations	array of Operation

Example

{
  "occurrences" : [ {
    "amount" : "ONE",
    "settlementStatus" : "RESETTELD",
    "recordStatus" : "COMPLETE",
    "taxon" : {
      "name" : "...",
      "authority" : "...",
      "group" : "...",
      "taxaList" : { },
      "externalKey" : "...",
      "defaultSettlementStatusFukarek" : "SYNANTHROP",
      "preferred" : true,
      "id" : 12345,
      "createdBy" : "...",
      "creationDate" : "...",
      "links" : [ { }, { } ],
      "modifiedBy" : "...",
      "modificationDate" : "...",
      "userAlloewdToEdit" : true,
      "obfuscated" : true,
      "allowedOperations" : [ "DELETE", "DELETE" ]
    },
    "sample" : {
      "sampleMethod" : "PITFALL_TRAP",
      "date" : { },
      "locality" : { },
      "survey" : { },
      "recorder" : { },
      "tags" : [ "...", "..." ],
      "id" : "...",
      "createdBy" : "...",
      "creationDate" : "...",
      "links" : [ { }, { } ],
      "modifiedBy" : "...",
      "modificationDate" : "...",
      "userAlloewdToEdit" : true,
      "obfuscated" : true,
      "allowedOperations" : [ "UPDATE", "CREATE" ]
    },
    "determiner" : {
      "firstName" : "...",
      "lastName" : "...",
      "externalKey" : "...",
      "email" : "...",
      "id" : 12345,
      "createdBy" : "...",
      "creationDate" : "...",
      "links" : [ { }, { } ],
      "modifiedBy" : "...",
      "modificationDate" : "...",
      "userAlloewdToEdit" : true,
      "obfuscated" : true,
      "allowedOperations" : [ "DELETE", "READ" ]
    },
    "externalKey" : "...",
    "comment" : "...",
    "lifeStage" : "IMAGO",
    "makropter" : "YES",
    "reference" : {
      "primAuthorFirstName" : "...",
      "primAuthorLastName" : "...",
      "year" : 12345,
      "title" : "...",
      "citeId" : "..."
    },
    "coveredArea" : "MORE_THAN_FIFTY",
    "vitality" : "ABGESTORBEN",
    "settlementStatusFukarek" : "UNBEKANNT",
    "bloomingSprouts" : "FIFTY",
    "quantity" : "ONE_TO_FIVE",
    "observers" : "...",
    "herbarium" : {
      "code" : "...",
      "herbary" : "...",
      "institution" : { }
    },
    "determinationComment" : "...",
    "numericAmount" : 12345,
    "reproduction" : "PLAUSIBLE",
    "sex" : "FEMALE",
    "habitat" : "...",
    "timeOfDay" : "...",
    "remark" : "...",
    "citeId" : "...",
    "citeComment" : "...",
    "documents" : [ {
      "type" : "MAP_TAXON_FLORA_MV_STYLE_THUMB",
      "link" : { },
      "caption" : "..."
    }, {
      "type" : "MAP_TAXON_VEGETWEB_STYLE_THUMB",
      "link" : { },
      "caption" : "..."
    } ],
    "absence" : true,
    "validation" : {
      "status" : "INVALID",
      "validator" : { },
      "validationTime" : "...",
      "comment" : "..."
    },
    "numericAmountAccuracy" : "MORETHAN",
    "id" : "...",
    "createdBy" : "...",
    "creationDate" : "...",
    "links" : [ {
      "href" : "...",
      "rel" : "..."
    }, {
      "href" : "...",
      "rel" : "..."
    } ],
    "modifiedBy" : "...",
    "modificationDate" : "...",
    "userAlloewdToEdit" : true,
    "obfuscated" : true,
    "allowedOperations" : [ "CREATE", "CREATE" ]
  }, {
    "amount" : "SCATTERED",
    "settlementStatus" : "RESETTELD",
    "recordStatus" : "IN_PROGRESS",
    "taxon" : {
      "name" : "...",
      "authority" : "...",
      "group" : "...",
      "taxaList" : { },
      "externalKey" : "...",
      "defaultSettlementStatusFukarek" : "UNBEKANNT",
      "preferred" : true,
      "id" : 12345,
      "createdBy" : "...",
      "creationDate" : "...",
      "links" : [ { }, { } ],
      "modifiedBy" : "...",
      "modificationDate" : "...",
      "userAlloewdToEdit" : true,
      "obfuscated" : true,
      "allowedOperations" : [ "CREATE", "CREATE" ]
    },
    "sample" : {
      "sampleMethod" : "FIELD_OBSERVATION",
      "date" : { },
      "locality" : { },
      "survey" : { },
      "recorder" : { },
      "tags" : [ "...", "..." ],
      "id" : "...",
      "createdBy" : "...",
      "creationDate" : "...",
      "links" : [ { }, { } ],
      "modifiedBy" : "...",
      "modificationDate" : "...",
      "userAlloewdToEdit" : true,
      "obfuscated" : true,
      "allowedOperations" : [ "DELETE", "DELETE" ]
    },
    "determiner" : {
      "firstName" : "...",
      "lastName" : "...",
      "externalKey" : "...",
      "email" : "...",
      "id" : 12345,
      "createdBy" : "...",
      "creationDate" : "...",
      "links" : [ { }, { } ],
      "modifiedBy" : "...",
      "modificationDate" : "...",
      "userAlloewdToEdit" : true,
      "obfuscated" : true,
      "allowedOperations" : [ "READ", "UPDATE" ]
    },
    "externalKey" : "...",
    "comment" : "...",
    "lifeStage" : "IMAGO",
    "makropter" : "YES",
    "reference" : {
      "primAuthorFirstName" : "...",
      "primAuthorLastName" : "...",
      "year" : 12345,
      "title" : "...",
      "citeId" : "..."
    },
    "coveredArea" : "MORE_THAN_THOUSAND",
    "vitality" : "KUEMMERND",
    "settlementStatusFukarek" : "EINGEBUERGERT",
    "bloomingSprouts" : "FIFTY",
    "quantity" : "HUNDRED",
    "observers" : "...",
    "herbarium" : {
      "code" : "...",
      "herbary" : "...",
      "institution" : { }
    },
    "determinationComment" : "...",
    "numericAmount" : 12345,
    "reproduction" : "PLAUSIBLE",
    "sex" : "MALE",
    "habitat" : "...",
    "timeOfDay" : "...",
    "remark" : "...",
    "citeId" : "...",
    "citeComment" : "...",
    "documents" : [ {
      "type" : "AUDIO",
      "link" : { },
      "caption" : "..."
    }, {
      "type" : "MAP_TAXON_VEGETWEB_STYLE",
      "link" : { },
      "caption" : "..."
    } ],
    "absence" : true,
    "validation" : {
      "status" : "IMPROBALE",
      "validator" : { },
      "validationTime" : "...",
      "comment" : "..."
    },
    "numericAmountAccuracy" : "COUNTED",
    "id" : "...",
    "createdBy" : "...",
    "creationDate" : "...",
    "links" : [ {
      "href" : "...",
      "rel" : "..."
    }, {
      "href" : "...",
      "rel" : "..."
    } ],
    "modifiedBy" : "...",
    "modificationDate" : "...",
    "userAlloewdToEdit" : true,
    "obfuscated" : true,
    "allowedOperations" : [ "CREATE", "CREATE" ]
  } ],
  "sampleMethod" : "SUCTION_SAMPLER",
  "date" : {
    "from" : "...",
    "to" : "...",
    "type" : "TO_YEAR"
  },
  "locality" : {
    "position" : {
      "mtb" : { },
      "epsg" : 12345,
      "type" : "SQUARE",
      "posCenterLatitude" : 12345.0,
      "posCenterLongitude" : 12345.0,
      "wkt" : "...",
      "wktEpsg" : 12345
    },
    "blur" : 12345,
    "locationComment" : "...",
    "locality" : "..."
  },
  "survey" : {
    "name" : "...",
    "description" : "...",
    "container" : true,
    "availability" : "RESTRICTED",
    "werbeoOriginal" : true,
    "allowDataEntry" : true,
    "allowExport" : true,
    "portal" : {
      "config" : { },
      "name" : "...",
      "url" : "...",
      "id" : 12345,
      "createdBy" : "...",
      "creationDate" : "...",
      "links" : [ { }, { } ],
      "modifiedBy" : "...",
      "modificationDate" : "...",
      "userAlloewdToEdit" : true,
      "obfuscated" : true,
      "allowedOperations" : [ "UPDATE", "UPDATE" ]
    },
    "obfuscationPolicies" : [ {
      "role" : "ACCEPTED",
      "permission" : "PERSONS"
    }, {
      "role" : "COORDINATOR",
      "permission" : "LOCATION_MTBQQQ"
    } ],
    "obfuscationPoliciesExternal" : [ {
      "role" : "COORDINATOR",
      "permission" : "LOCATION_MTBQQQ"
    }, {
      "role" : "ANONYMOUS",
      "permission" : "PERSONS"
    } ],
    "dataReceivingPortals" : [ 12345, 12345 ],
    "tags" : [ "...", "..." ],
    "parent" : { },
    "id" : 12345,
    "createdBy" : "...",
    "creationDate" : "...",
    "links" : [ {
      "href" : "...",
      "rel" : "..."
    }, {
      "href" : "...",
      "rel" : "..."
    } ],
    "modifiedBy" : "...",
    "modificationDate" : "...",
    "userAlloewdToEdit" : true,
    "obfuscated" : true,
    "allowedOperations" : [ "UPDATE", "READ" ]
  },
  "recorder" : {
    "firstName" : "...",
    "lastName" : "...",
    "externalKey" : "...",
    "email" : "...",
    "id" : 12345,
    "createdBy" : "...",
    "creationDate" : "...",
    "links" : [ {
      "href" : "...",
      "rel" : "..."
    }, {
      "href" : "...",
      "rel" : "..."
    } ],
    "modifiedBy" : "...",
    "modificationDate" : "...",
    "userAlloewdToEdit" : true,
    "obfuscated" : true,
    "allowedOperations" : [ "DELETE", "CREATE" ]
  },
  "tags" : [ "...", "..." ],
  "id" : "...",
  "createdBy" : "...",
  "creationDate" : "...",
  "links" : [ {
    "href" : "...",
    "rel" : "..."
  }, {
    "href" : "...",
    "rel" : "..."
  } ],
  "modifiedBy" : "...",
  "modificationDate" : "...",
  "userAlloewdToEdit" : true,
  "obfuscated" : true,
  "allowedOperations" : [ "READ", "CREATE" ]
}