SampleBase Data Type

Subtypes
Sample
Properties
name data type constraints description
sampleMethod SampleMethod   The method used for this sample.
date VagueDate   The date when sampling occured.
locality Locality required Describes the position of this sample.
survey SurveyBase required 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 required 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 required 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

{
  "sampleMethod" : "TIMED_COUNT",
  "date" : {
    "from" : "...",
    "to" : "...",
    "type" : "YEAR"
  },
  "locality" : {
    "position" : {
      "mtb" : { },
      "epsg" : 12345,
      "type" : "POINT",
      "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" : [ "CREATE", "UPDATE" ]
    },
    "obfuscationPolicies" : [ {
      "role" : "ANONYMOUS",
      "permission" : "LOCATION_MTBQQQ"
    }, {
      "role" : "COORDINATOR",
      "permission" : "PERSONS"
    } ],
    "obfuscationPoliciesExternal" : [ {
      "role" : "ACCEPTED",
      "permission" : "LOCATION_MTBQQ"
    }, {
      "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" : [ "DELETE", "DELETE" ]
  },
  "recorder" : {
    "firstName" : "...",
    "lastName" : "...",
    "externalKey" : "...",
    "email" : "...",
    "id" : 12345,
    "createdBy" : "...",
    "creationDate" : "...",
    "links" : [ {
      "href" : "...",
      "rel" : "..."
    }, {
      "href" : "...",
      "rel" : "..."
    } ],
    "modifiedBy" : "...",
    "modificationDate" : "...",
    "userAlloewdToEdit" : true,
    "obfuscated" : true,
    "allowedOperations" : [ "CREATE", "DELETE" ]
  },
  "tags" : [ "...", "..." ],
  "id" : "...",
  "createdBy" : "...",
  "creationDate" : "...",
  "links" : [ {
    "href" : "...",
    "rel" : "..."
  }, {
    "href" : "...",
    "rel" : "..."
  } ],
  "modifiedBy" : "...",
  "modificationDate" : "...",
  "userAlloewdToEdit" : true,
  "obfuscated" : true,
  "allowedOperations" : [ "CREATE", "UPDATE" ]
}