TechnicalDocumentation - Revision history

L.suhrbier: /* Opening Annotation View or Annotation Editor from http-reference URI */

2017-08-15T08:45:55Z

Opening Annotation View or Annotation Editor from http-reference URI

← Older revision		Revision as of 10:45, 15 August 2017
Line 931:		Line 931:

	The URI referring repository data object can be passed to AnnoSys via the parameter ''repositoryURI'', i.e.		The URI referring repository data object can be passed to AnnoSys via the parameter ''repositoryURI'', i.e.
	;~~recordURI~~		;repositoryURI
	:The parameter must contain a valied URI dereferencing an annotation or XML record in the AnnoSys repository.		:The parameter must contain a valied URI dereferencing an annotation or XML record in the AnnoSys repository.

L.suhrbier: /* Annotation creation */

2017-05-04T15:51:57Z

Annotation creation

← Older revision		Revision as of 17:51, 4 May 2017
Line 213:		Line 213:
	:The AnnoSysID of the annotation shall uniquely identify any annotation created. In accordance to the [[#AnnoSysID.27s_and_Globally_Unique_Identifiers_.28GUIDs.29\|AnnoSysID's and Globally Unique Identifiers (GUIDs)]], the AnnoSysID is constructed based on the following components:		:The AnnoSysID of the annotation shall uniquely identify any annotation created. In accordance to the [[#AnnoSysID.27s_and_Globally_Unique_Identifiers_.28GUIDs.29\|AnnoSysID's and Globally Unique Identifiers (GUIDs)]], the AnnoSysID is constructed based on the following components:
	:;institutionID		:;institutionID
	:: ~~Organisation~~ running the AnnoSys instance creating the annotation(e.g. "BGBM").		:: Is currently filled with the institutionId of the organisation running the AnnoSys instance creating the annotation(e.g. "BGBM").
	:;collectionID		:;collectionID
	:: ~~Name~~ of the annotation repository (e.g. "AnnoSys").		:: Is currently filled with the name of the annotation repository (e.g. "AnnoSys").
	:;unitID		:;unitID
	:: ~~Time~~ in milliseconds since 01/01/1970 the annotation was first instantiated by the system		:: In order to produce unique unitIDs, this field is currently filled with the time in milliseconds since 01/01/1970 when the annotation was first instantiated by the AnnoSys system.
	:Since, annotations are not intended to be modified after publication and [http://www.openannotation.org/spec/core/20130208/index.html W3C Open Annotation Data Model (OA)] actually is the only standard supported for annotation exchange, the fields '''version''' and '''format''' are currently unneeded.		:Since, annotations are not intended to be modified after publication and [http://www.openannotation.org/spec/core/20130208/index.html W3C Open Annotation Data Model (OA)] actually is the only standard supported for annotation exchange, the fields '''version''' and '''format''' are currently unneeded.

L.suhrbier: /* Download via direct URL */

2016-10-05T12:55:07Z

Download via direct URL

← Older revision		Revision as of 14:55, 5 October 2016
Line 906:		Line 906:
	* BioCASE response documents containing ABCD2.06 based XML data record(s)		* BioCASE response documents containing ABCD2.06 based XML data record(s)
	* [http://wiki.bgbm.org/bps/index.php/Archiving ABCD Archives] containing either ABCD2.06 based XML data record(s) or BioCASE response documents		* [http://wiki.bgbm.org/bps/index.php/Archiving ABCD Archives] containing either ABCD2.06 based XML data record(s) or BioCASE response documents
			* SimpleDarwinCore based XML data record

	In case of any of the document holds more than a single data record, the AnnoSys user interface provides a record selection dialog where annotators may select records for further being processed either as mass annotation or multiple individual annotations from a list of successfully transmitted data records.		In case of any of the document holds more than a single data record, the AnnoSys user interface provides a record selection dialog where annotators may select records for further being processed either as mass annotation or multiple individual annotations from a list of successfully transmitted data records.

L.suhrbier: /* Opening Annotation View or Annotation Editor from http-reference URI */

2016-06-30T14:47:39Z

Opening Annotation View or Annotation Editor from http-reference URI

← Older revision		Revision as of 16:47, 30 June 2016
Line 934:		Line 934:

	Example: https://annosys.bgbm.fu-berlin.de/AnnoSysTest/AnnoSys?repositoryURI=https%3A%2F%2Fannosys.bgbm.fu-berlin.de%2FAnnoSysTest%2Fservices%2Fannotations%2FBGBM%2FAnnoSys%2F1405093916622		Example: https://annosys.bgbm.fu-berlin.de/AnnoSysTest/AnnoSys?repositoryURI=https%3A%2F%2Fannosys.bgbm.fu-berlin.de%2FAnnoSysTest%2Fservices%2Fannotations%2FBGBM%2FAnnoSys%2F1405093916622

			==== Examples of AnnoSys dataportals integrations ====
			The following example links are all referring to the same object: B 40 0025800 (Padina Pavonia):
			* [http://ww2.bgbm.org/Herbarium/specimen.cfm?Barcode=B400025800 Herbarium Berolinense – Virtual Herbarium]
			* [http://www.binhum.net/?tab=annotation&context=specimen&fq=scientificName%3A%22Padina%20pavonia%22&fq=id%3A%22B/Herbarium%20Berolinense/B%2040%200025800%22 BiNHum Sammlungsportal des Humboldt-Rings]
			* [http://wfospecimens.cybertaxonomy.org/search/record?unitID=B+40+0025800&collectioncode=Herbarium+Berolinense&institutioncode=B World Flora Online Specimen Explorer for Phytotaxonomists]
			* [http://www.gbif.org/occurrence/144881790 Global Biodiversity Information Facility] (Please click on the AnnoSys Feature Button to the right)
			* [http://search.biocase.org/bgbm/search/units/details/getDetails?institutionID=B&collectionID=Herbarium+Berolinense&unitID=B+40+0025800&resourceKey=12888&bioKey=144881790 BIOCASE portal for BGBM collection]

	=== Information Retrieval ===		=== Information Retrieval ===

L.suhrbier: /* Examples of AnnoSys dataportals integrations */

2016-06-30T14:47:23Z

Examples of AnnoSys dataportals integrations

← Older revision		Revision as of 16:47, 30 June 2016
Line 941:		Line 941:
	Returns, if the AnnoSys repository knows the record of the given triple id and, if there are annotations, also the number of annotations the given record.		Returns, if the AnnoSys repository knows the record of the given triple id and, if there are annotations, also the number of annotations the given record.
	For more detailed information, see [[#Request:_GET_.24.7BServicesURL.7D.2Frecords.2F.3Clsid:authority.3E.2F.3Clsid:namespace.3E.2F.3Clsid:objectId.3E.2Fannotations\|Request: GET ${ServicesURL}/records/<lsid:authority>/<lsid:namespace>/<lsid:objectId>/annotations]].		For more detailed information, see [[#Request:_GET_.24.7BServicesURL.7D.2Frecords.2F.3Clsid:authority.3E.2F.3Clsid:namespace.3E.2F.3Clsid:objectId.3E.2Fannotations\|Request: GET ${ServicesURL}/records/<lsid:authority>/<lsid:namespace>/<lsid:objectId>/annotations]].

	~~==== Examples of AnnoSys dataportals integrations ====~~
	~~The following example links are all referring to the same object: B 40 0025800 (Padina Pavonia):~~
	* [http://ww2.bgbm.org/Herbarium/specimen.cfm?Barcode=B400025800 Herbarium Berolinense – Virtual Herbarium]
	* [http://www.binhum.net/?tab=annotation&context=specimen&fq=scientificName%3A%22Padina%20pavonia%22&fq=id%3A%22B/Herbarium%20Berolinense/B%2040%200025800%22 BiNHum Sammlungsportal des Humboldt-Rings]
	* [http://wfospecimens.cybertaxonomy.org/search/record?unitID=B+40+0025800&collectioncode=Herbarium+Berolinense&institutioncode=B World Flora Online Specimen Explorer for Phytotaxonomists]
	* [http://www.gbif.org/occurrence/144881790 Global Biodiversity Information Facility] (Please click on the AnnoSys Feature Button to the right)
	* [http://search.biocase.org/bgbm/search/units/details/getDetails?institutionID=B&collectionID=Herbarium+Berolinense&unitID=B+40+0025800&resourceKey=12888&bioKey=144881790 BIOCASE portal for BGBM collection]

	== Web Services ==		== Web Services ==

L.suhrbier: /* Information Retrieval */

2016-06-30T14:46:42Z

Information Retrieval

← Older revision		Revision as of 16:46, 30 June 2016
Line 941:		Line 941:
	Returns, if the AnnoSys repository knows the record of the given triple id and, if there are annotations, also the number of annotations the given record.		Returns, if the AnnoSys repository knows the record of the given triple id and, if there are annotations, also the number of annotations the given record.
	For more detailed information, see [[#Request:_GET_.24.7BServicesURL.7D.2Frecords.2F.3Clsid:authority.3E.2F.3Clsid:namespace.3E.2F.3Clsid:objectId.3E.2Fannotations\|Request: GET ${ServicesURL}/records/<lsid:authority>/<lsid:namespace>/<lsid:objectId>/annotations]].		For more detailed information, see [[#Request:_GET_.24.7BServicesURL.7D.2Frecords.2F.3Clsid:authority.3E.2F.3Clsid:namespace.3E.2F.3Clsid:objectId.3E.2Fannotations\|Request: GET ${ServicesURL}/records/<lsid:authority>/<lsid:namespace>/<lsid:objectId>/annotations]].

			==== Examples of AnnoSys dataportals integrations ====
			The following example links are all referring to the same object: B 40 0025800 (Padina Pavonia):
			* [http://ww2.bgbm.org/Herbarium/specimen.cfm?Barcode=B400025800 Herbarium Berolinense – Virtual Herbarium]
			* [http://www.binhum.net/?tab=annotation&context=specimen&fq=scientificName%3A%22Padina%20pavonia%22&fq=id%3A%22B/Herbarium%20Berolinense/B%2040%200025800%22 BiNHum Sammlungsportal des Humboldt-Rings]
			* [http://wfospecimens.cybertaxonomy.org/search/record?unitID=B+40+0025800&collectioncode=Herbarium+Berolinense&institutioncode=B World Flora Online Specimen Explorer for Phytotaxonomists]
			* [http://www.gbif.org/occurrence/144881790 Global Biodiversity Information Facility] (Please click on the AnnoSys Feature Button to the right)
			* [http://search.biocase.org/bgbm/search/units/details/getDetails?institutionID=B&collectionID=Herbarium+Berolinense&unitID=B+40+0025800&resourceKey=12888&bioKey=144881790 BIOCASE portal for BGBM collection]

	== Web Services ==		== Web Services ==

L.suhrbier: /* Opening Annotation View or Annotation Editor from http-reference URI */

2016-06-28T14:46:38Z

Opening Annotation View or Annotation Editor from http-reference URI

← Older revision		Revision as of 16:46, 28 June 2016
Line 933:		Line 933:
	:The parameter must contain a valied URI dereferencing an annotation or XML record in the AnnoSys repository.		:The parameter must contain a valied URI dereferencing an annotation or XML record in the AnnoSys repository.

	Example: https://annosys.bgbm.fu-berlin.de/AnnoSysTest/AnnoSys?repositoryURI=https%3A%2F%2Fannosys.bgbm.fu-berlin.de%2FAnnoSysTest%2Fservices%2Fannotations%~~2FB~~%2FAnnoSys%2F1405093916622		Example: https://annosys.bgbm.fu-berlin.de/AnnoSysTest/AnnoSys?repositoryURI=https%3A%2F%2Fannosys.bgbm.fu-berlin.de%2FAnnoSysTest%2Fservices%2Fannotations%2FBGBM%2FAnnoSys%2F1405093916622

	=== Information Retrieval ===		=== Information Retrieval ===

L.suhrbier: /* Download via direct URL */

2016-06-28T14:45:28Z

Download via direct URL

← Older revision		Revision as of 16:45, 28 June 2016
Line 900:		Line 900:
	:The parameter should contain the URL of the document to be downloaded.		:The parameter should contain the URL of the document to be downloaded.

	Example: https://annosys.bgbm.fu-berlin.de/AnnoSysTest/AnnoSys?recordURL=~~http~~://~~ww2~~.~~biocase~~.~~org~~/~~svn~~/~~annotation~~/~~original~~/~~03666bc0-f0f4-11d8-b22f-b8a03c50a862~~/~~abcd2.06~~/B/~~Bridel%20Herbar~~/~~Bridel-1-12~~.~~xml~~		Example: https://annosys.bgbm.fu-berlin.de/AnnoSysTest/AnnoSys?recordURL=https://annosys.bgbm.fu-berlin.de/AnnoSysTest/services/records/B/Herbarium+Berolinense/B+10+0295820/1411030267936/abcd2.06b

	The URL may refer to the following types of documents		The URL may refer to the following types of documents

L.suhrbier: /* Services */

2016-06-28T14:42:04Z

Services

L.suhrbier: /* Preliminaries */

2016-06-28T14:38:34Z

Preliminaries

← Older revision		Revision as of 16:38, 28 June 2016
Line 874:		Line 874:
	'''Please use the ${AnnoSysTestURL} or ${ServicesTestURL} if you are testing the integration of AnnoSys with your application!'''		'''Please use the ${AnnoSysTestURL} or ${ServicesTestURL} if you are testing the integration of AnnoSys with your application!'''

	Currently, '''only ABCD2.06 based XML data records are supported ! (namespacePrefix "abcd2.06b")'''		Currently, '''only ABCD2.06 and Simple Darwin Core based XML data records are supported ! (namespacePrefix "abcd2.06b" or "dwcsimple" respectively)'''

	Annotations are stored and will be delivered on request in RDF according to our implementation of the W3C Open Annotation Data Model described here.		Annotations are stored and will be delivered on request in RDF according to our implementation of the W3C Open Annotation Data Model described here.

← Older revision		Revision as of 16:42, 28 June 2016
Line 900:		Line 900:
	:The parameter should contain the URL of the document to be downloaded.		:The parameter should contain the URL of the document to be downloaded.

	Example: https://annosys.bgbm.fu-berlin.de/AnnoSysTest/AnnoSys?recordURL=http://ww2.biocase.org/svn/annotation/original/03666bc0-f0f4-11d8-b22f-b8a03c50a862/abcd2.06/~~BGBM~~/Bridel%20Herbar/Bridel-1-12.xml		Example: https://annosys.bgbm.fu-berlin.de/AnnoSysTest/AnnoSys?recordURL=http://ww2.biocase.org/svn/annotation/original/03666bc0-f0f4-11d8-b22f-b8a03c50a862/abcd2.06/B/Bridel%20Herbar/Bridel-1-12.xml

	The URL may refer to the following types of documents		The URL may refer to the following types of documents
Line 924:		Line 924:
	: The unitID (lsid:objectId) part of the tripleId describing the record (e.g. B 20 0145120).		: The unitID (lsid:objectId) part of the tripleId describing the record (e.g. B 20 0145120).

	Example: https://annosys.bgbm.fu-berlin.de/AnnoSysTest/AnnoSys?providerURL=http%3A%2F%2Fww3.bgbm.org%2Fbiocase%2Fpywrapper.cgi%3Fdsa%3DHerbar%26&protocolURI=http%3A%2F%2Fwww.biocase.org%2Fschemas%2Fprotocol%2F1.3&formatURI=http%3A%2F%2Fwww.tdwg.org%2Fschemas%2Fabcd%2F2.06&institution=~~BGBM~~&source=Herbarium%20Berolinense&unitID=B%2020%200145120		Example: https://annosys.bgbm.fu-berlin.de/AnnoSysTest/AnnoSys?providerURL=http%3A%2F%2Fww3.bgbm.org%2Fbiocase%2Fpywrapper.cgi%3Fdsa%3DHerbar%26&protocolURI=http%3A%2F%2Fwww.biocase.org%2Fschemas%2Fprotocol%2F1.3&formatURI=http%3A%2F%2Fwww.tdwg.org%2Fschemas%2Fabcd%2F2.06&institution=B&source=Herbarium%20Berolinense&unitID=B%2020%200145120

	==== Opening Annotation View or Annotation Editor from http-reference URI ====		==== Opening Annotation View or Annotation Editor from http-reference URI ====
Line 933:		Line 933:
	:The parameter must contain a valied URI dereferencing an annotation or XML record in the AnnoSys repository.		:The parameter must contain a valied URI dereferencing an annotation or XML record in the AnnoSys repository.

	Example: https://annosys.bgbm.fu-berlin.de/AnnoSysTest/AnnoSys?repositoryURI=https%3A%2F%2Fannosys.bgbm.fu-berlin.de%2FAnnoSysTest%2Fservices%2Fannotations%~~2FBGBM~~%2FAnnoSys%2F1405093916622		Example: https://annosys.bgbm.fu-berlin.de/AnnoSysTest/AnnoSys?repositoryURI=https%3A%2F%2Fannosys.bgbm.fu-berlin.de%2FAnnoSysTest%2Fservices%2Fannotations%2FB%2FAnnoSys%2F1405093916622
	=== Information Retrieval ===		=== Information Retrieval ===

Line 1,021:		Line 1,021:
	Records are identified within the AnnoSys repository by an extended LSID, including LSID data plus a prefix describing the document format. Thus, the path to be appended to the general records context path is build up on the tripleId, plus a timestamp stating lsid:version and an AnnoSys predefined namespacePrefix identifying the record's document format. Currently, only '''abcd2.06b''' is supported.		Records are identified within the AnnoSys repository by an extended LSID, including LSID data plus a prefix describing the document format. Thus, the path to be appended to the general records context path is build up on the tripleId, plus a timestamp stating lsid:version and an AnnoSys predefined namespacePrefix identifying the record's document format. Currently, only '''abcd2.06b''' is supported.

	Example: '''/~~BGBM~~/Herbarium Berolinense/B -W 00400 -00 0/3534524354/abcd2.06b'''		Example: '''/B/Herbarium Berolinense/B -W 00400 -00 0/3534524354/abcd2.06b'''

	==== Request: GET ${ServicesURL}/records/<lsid:authority>/<lsid:namespace>/<lsid:objectId>/<lsid:version>/<annosys:formatPrefix> ====		==== Request: GET ${ServicesURL}/records/<lsid:authority>/<lsid:namespace>/<lsid:objectId>/<lsid:version>/<annosys:formatPrefix> ====