Survey Data Type

Properties
name data type description
Properties inherited from SurveyBase
name string The name of the survey.
description string The description of the survey.
container boolean Indicates if the survey is a container for other surveys (true) or if it contains Samples (false).
availability Availability The availability level of the data in this survey.
werbeoOriginal boolean Indicates at the home of the data is in werbeo.
allowDataEntry boolean Indicates if new Occurrence and Sample data is allowed for this survey.
allowExport boolean Indicates whether data-export for this survey is allowed or not
portal Portal
obfuscationPolicies array of ObfuscationPolicy
obfuscationPoliciesExternal array of ObfuscationPolicy
dataReceivingPortals array of number
tags array of string Tags for this survey.
parent SurveyBase
Properties inherited from BaseInt
id number The id of the entity.
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

{
  "name" : "...",
  "description" : "...",
  "container" : true,
  "availability" : "FREE",
  "werbeoOriginal" : true,
  "allowDataEntry" : true,
  "allowExport" : true,
  "portal" : {
    "config" : {
      "exportPolicies" : [ "NO_CSV_EXPORT_FOR_NOT_APPROVED_USERS", "NO_CSV_EXPORT_FOR_NOT_APPROVED_USERS" ],
      "staticMapStyle" : "VEGETWEB",
      "defaultDataEntrySurveyId" : 12345,
      "mapInitialZoom" : 12345.0,
      "mapInitialLatitude" : 12345.0,
      "mapInitialLongitude" : 12345.0,
      "mapOverlayLayers" : [ "MTB", "TOPO_MV" ],
      "maxUploadSize" : 12345,
      "allowAnonymousAccess" : true,
      "coordinateSystems" : [ "EPSG5650", "EPSG25832" ],
      "taxonListIds" : [ 12345, 12345 ],
      "dataExchangeMasterPortalId" : 12345,
      "dataExchangePortalIds" : [ 12345, 12345 ],
      "distmapStartYear" : 12345,
      "distmapRequiredValidations" : [ "INVALID", "PROBABLE" ]
    },
    "name" : "...",
    "url" : "...",
    "id" : 12345,
    "createdBy" : "...",
    "creationDate" : "...",
    "links" : [ {
      "href" : "...",
      "rel" : "..."
    }, {
      "href" : "...",
      "rel" : "..."
    } ],
    "modifiedBy" : "...",
    "modificationDate" : "...",
    "userAlloewdToEdit" : true,
    "obfuscated" : true,
    "allowedOperations" : [ "READ", "CREATE" ]
  },
  "obfuscationPolicies" : [ {
    "role" : "ACCEPTED",
    "permission" : "LOCATION_MTBQ"
  }, {
    "role" : "COORDINATOR",
    "permission" : "LOCATION_MTBQQ"
  } ],
  "obfuscationPoliciesExternal" : [ {
    "role" : "ANONYMOUS",
    "permission" : "LOCATION_POINT"
  }, {
    "role" : "APPROVED",
    "permission" : "PERSONS"
  } ],
  "dataReceivingPortals" : [ 12345, 12345 ],
  "tags" : [ "...", "..." ],
  "parent" : {
    "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", "DELETE" ]
    },
    "obfuscationPolicies" : [ {
      "role" : "APPROVED",
      "permission" : "LOCATION_MTBQ"
    }, {
      "role" : "ANONYMOUS",
      "permission" : "LOCATION_MTBQQ"
    } ],
    "obfuscationPoliciesExternal" : [ {
      "role" : "VALIDATOR",
      "permission" : "LOCATION_MTBQQQ"
    }, {
      "role" : "APPROVED",
      "permission" : "LOCATION_MTBQQ"
    } ],
    "dataReceivingPortals" : [ 12345, 12345 ],
    "tags" : [ "...", "..." ],
    "parent" : { },
    "id" : 12345,
    "createdBy" : "...",
    "creationDate" : "...",
    "links" : [ {
      "href" : "...",
      "rel" : "..."
    }, {
      "href" : "...",
      "rel" : "..."
    } ],
    "modifiedBy" : "...",
    "modificationDate" : "...",
    "userAlloewdToEdit" : true,
    "obfuscated" : true,
    "allowedOperations" : [ "UPDATE", "UPDATE" ]
  },
  "id" : 12345,
  "createdBy" : "...",
  "creationDate" : "...",
  "links" : [ {
    "href" : "...",
    "rel" : "..."
  }, {
    "href" : "...",
    "rel" : "..."
  } ],
  "modifiedBy" : "...",
  "modificationDate" : "...",
  "userAlloewdToEdit" : true,
  "obfuscated" : true,
  "allowedOperations" : [ "CREATE", "UPDATE" ]
}