/modules/cdm_dataportal/cdm_api/webservice_uris.php - Annotate - EDIT - EDIT Project Management

| Branch: | Tag: | Revision:

cdm-dataportal/modules/cdm_dataportal/cdm_api/webservice_uris.php @ 116fb348

1	6657531f	Andreas Kohlbecker	<?php
2			/**
3			* @file
4			* CDM Server URI definitions.
5			*/
6	d9763fd3	Andreas Kohlbecker	define('CDM_WS_PORTAL_AGENT', 'portal/agent');
7	6657531f	Andreas Kohlbecker	define('CDM_WS_REFERENCE', 'reference');
8	1ce9afb7	Patric Plitzner	define('CDM_WS_REFERENCE_AUTHORTEAM', 'reference/$0/authorship');
9	6657531f	Andreas Kohlbecker	define('CDM_WS_NOMENCLATURAL_REFERENCE_CITATION', 'reference/$0/nomenclaturalCitation');
10
11			define('CDM_WS_NAME', 'name');
12			define('CDM_WS_NAME_NAMECAHE', 'name/$0/nameCache');
13			define('CDM_WS_NAME_TYPEDESIGNATIONS', 'name/$0/typeDesignations');
14
15	d0d068e9	Andreas Kohlbecker	define('CDM_WS_PORTAL_NAME', 'portal/name');
16	6657531f	Andreas Kohlbecker	define('CDM_WS_PORTAL_NAME_FINDBYNAME', 'name/findByName/');
17			define('CDM_WS_PORTAL_NAME_DESCRIPTIONS', 'portal/name/$0/taxonNameDescriptions');
18			define('CDM_WS_PORTAL_NAME_TYPEDESIGNATIONS', 'portal/name/$0/typeDesignations');
19
20			define('CDM_WS_TAXON', 'taxon');
21	61b6ee11	Andreas Kohlbecker	define('CDM_WS_TAXON_CLASSIFICATIONS', 'taxon/$0/classifications');
22	6657531f	Andreas Kohlbecker	define('CDM_WS_TAXON_FINDBY_DESCRIPTIONELEMENT_FULLTEXT', 'taxon/findByDescriptionElementFullText');
23	33fee414	Andreas Kohlbecker	/**
24			* Parameter $0 : the taxon uuid.
25			*
26			* Returns the taxon which is the accepted synonym for the taxon given as
27			* parameter taxonUuid. If the taxon specified by taxonUuid is itself the
28			* accepted taxon, this one will be returned.
29			*/
30	9128dcb4	Andreas Kohlbecker	define('CDM_WS_PORTAL_TAXON_ACCEPTED', 'portal/taxon/$0/accepted');
31	6657531f	Andreas Kohlbecker
32			define('CDM_WS_PORTAL_TAXON', 'portal/taxon');
33			define('CDM_WS_PORTAL_TAXON_SYNONYMY', 'portal/taxon/$0/synonymy');
34			define('CDM_WS_PORTAL_TAXON_RELATIONS', 'portal/taxon/$0/taxonRelationships');
35	116fb348	Andreas Kohlbecker	define('CDM_WS_PORTAL_TAXON_RELATIONS_DTO', 'taxon/$0/taxonRelationshipsDTO');
36	6657531f	Andreas Kohlbecker	define('CDM_WS_PORTAL_TAXON_DESCRIPTIONS', 'portal/taxon/$0/descriptions');
37	7663cd0b	Andreas Kohlbecker	define('CDM_WS_PORTAL_TAXON_TAXONNODEAGENTRELATIONS', 'portal/taxon/$0/taxonNodeAgentRelations/$1');
38	6657531f	Andreas Kohlbecker
39			/**
40			* Parameter $0: taxon UUID.
41			* Parameter $1: simple name of the class extending DescriptionElementBase.
42			*/
43			define('CDM_WS_PORTAL_TAXON_DESCRIPTIONS_ELEMENTSBYTYPE', 'portal/taxon/$0/descriptions/elementsByType/$1');
44			define('CDM_WS_PORTAL_TAXON_USEDESCRIPTIONS', 'portal/taxon/$0/useDescriptions');
45			define('CDM_WS_PORTAL_TAXON_TO_NAMERELATIONS', 'portal/taxon/$0/toNameRelationships');
46			define('CDM_WS_PORTAL_TAXON_FROM_NAMERELATIONS', 'portal/taxon/$0/fromNameRelationships');
47			define('CDM_WS_PORTAL_TAXON_MEDIA', 'portal/taxon/$0/media');
48			define('CDM_WS_PORTAL_TAXON_SUBTREE_MEDIA', 'portal/taxon/$0/subtree/media');
49
50			define('CDM_WS_PORTAL_TAXON_TAXONNODES', 'portal/taxon/$0/taxonNodes');
51			define('CDM_WS_PORTAL_TAXON_FIND', 'portal/taxon/find');
52	6280e639	Andreas Kohlbecker	define('CDM_WS_PORTAL_TAXON_SEARCH', 'portal/taxon/search');
53	93ae67cc	Patrick Plitzner	define('CDM_WS_TAXON_SEARCH', 'taxon/search');
54	6657531f	Andreas Kohlbecker	define('CDM_WS_PORTAL_TAXON_FINDBY_DESCRIPTIONELEMENT_FULLTEXT', 'portal/taxon/findByDescriptionElementFullText');
55
56			/**
57			* /description/{uuid}/naturalLanguageDescription/{featuretree_uuid}
58			*/
59	15fc5483	Andreas Kohlbecker	define('CDM_WS_DESCRIPTION_NAMEDAREAS_IN_USE', 'description/namedAreasInUse');
60	6657531f	Andreas Kohlbecker	define('CDM_WS_DESCRIPTION_NATURALLANGUAGE_DESCRIPTION', 'description/$0/naturalLanguageDescription/$1');
61			define('CDM_WS_DESCRIPTION_HAS_STRUCTRURED_DATA', 'description/$0/hasStructuredData');
62
63	bfb2b81a	Andreas Kohlbecker	define('CDM_WS_PORTAL_DESCRIPTION', 'portal/description/$0');
64	6657531f	Andreas Kohlbecker	define('CDM_WS_PORTAL_DESCRIPTION_AREAS_TREE', 'portal/description/$0/namedAreaTree');
65	0b9fefc3	Andreas Kohlbecker
66
67	092744e1	Andreas Kohlbecker	define('CDM_WS_PORTAL_DESCRIPTION_DISTRIBUTION_INFO_FOR', 'portal/description/distributionInfoFor/$0');
68	6657531f	Andreas Kohlbecker
69			define('CDM_WS_DESCRIPTIONELEMENT', 'descriptionElement/$0');
70	37252893	Andreas Kohlbecker	define('CDM_WS_DESCRIPTIONELEMENT_BY_TAXON', 'portal/descriptionElement/byTaxon');
71	6657531f	Andreas Kohlbecker	define('CDM_WS_PORTAL_DESCRIPTIONELEMENT', 'portal/descriptionElement/$0');
72
73			/**
74			* Gets the root nodes of the taxonomic concept tree for the concept
75			* reference specified by the secUuid parameter.
76			*
77			* stub: treenode_root
78			*/
79			define('CDM_WS_PORTAL_TAXONOMY', 'portal/classification');
80	a0e3ae5c	Andreas Kohlbecker	/**
81	f06c2616	Andreas Kohlbecker	* TODO: harmonize return type, the REST service should return TaxonNodeDto, see #6222
82	a0e3ae5c	Andreas Kohlbecker	*
83			* returns list of TaxonNode
84			*/
85	6657531f	Andreas Kohlbecker	define('CDM_WS_PORTAL_TAXONOMY_CHILDNODES', 'portal/classification/$0/childNodes');
86	a0e3ae5c	Andreas Kohlbecker	/**
87			* returns list of TaxonNodeDto
88			*/
89	6657531f	Andreas Kohlbecker	define('CDM_WS_PORTAL_TAXONOMY_CHILDNODES_AT_RANK', 'portal/classification/$0/childNodesAt/$1');
90	a0e3ae5c	Andreas Kohlbecker	/**
91			* returns list of TaxonNodeDto
92			*/
93	6657531f	Andreas Kohlbecker	define('CDM_WS_PORTAL_TAXONOMY_CHILDNODES_OF_TAXON', 'portal/classification/$0/childNodesOf/$1');
94	a0e3ae5c	Andreas Kohlbecker	/**
95			* returns list of TaxonNodeDto
96			*/
97	6657531f	Andreas Kohlbecker	define('CDM_WS_PORTAL_TAXONOMY_PATH_FROM', 'portal/classification/$0/pathFrom/$1');
98	a0e3ae5c	Andreas Kohlbecker	/**
99			* returns list of TaxonNodeDto
100			*/
101	6657531f	Andreas Kohlbecker	define('CDM_WS_PORTAL_TAXONOMY_PATH_FROM_TO_RANK', 'portal/classification/$0/pathFrom/$1/toRank/$2');
102			define('CDM_WS_PORTAL_TAXONOMY_MEDIA', 'portal/classification/$0/$1');
103
104	38da4e54	Andreas Kohlbecker	define('CDM_WS_TAXONNODE_PARENT', 'taxonNode/$0/parent');
105
106	6657531f	Andreas Kohlbecker	define('CDM_WS_TERMVOCABULARY', 'termVocabulary/$0');
107
108			define('CDM_WS_TERM_COMPARE', 'term/$0/compareTo/$1');
109	211709bc	Andreas Kohlbecker	define('CDM_WS_TERM', 'term');
110	30845bda	Andreas Kohlbecker	define('CDM_WS_PORTAL_TERM', 'portal/term/$0');
111	6657531f	Andreas Kohlbecker
112			/**
113			* Returns FeatureTrees that are stored in this community store.
114			*/
115	42f2e1e0	Andreas Kohlbecker	define('CDM_WS_FEATURETREE', 'portal/featureTree/$0');
116			define('CDM_WS_FEATURETREES', 'portal/featureTree');
117			// define('CDM_WS_FEATURETREE_CHILDREN', 'featureTree/$0/children');
118	6657531f	Andreas Kohlbecker	define('CDM_WS_GEOSERVICE_DISTRIBUTIONMAP', 'ext/edit/mapServiceParameters/taxonDistributionFor/$0');
119	c10f70e4	Katja Luther	define('CDM_WS_GEOSERVICE_OCCURRENCEMAP_FOR_FIELDUNITS', 'ext/edit/mapServiceParameters/taxonOccurrencesForX');
120	6657531f	Andreas Kohlbecker	define('CDM_WS_GEOSERVICE_OCCURRENCEMAP', 'ext/edit/mapServiceParameters/taxonOccurrencesFor/$0');
121
122	3a0d572f	Andreas Kohlbecker	define('CDM_WS_OCCURRENCE', 'occurrence');
123	1ce9afb7	Patric Plitzner	define('CDM_WS_PORTAL_OCCURRENCE', 'portal/occurrence');
124	3a0d572f	Andreas Kohlbecker	/**
125	27bddb2a	Andreas Kohlbecker	* url query parameters:
126	3a0d572f	Andreas Kohlbecker	*
127	27bddb2a	Andreas Kohlbecker	* - taxonUuid
128			* - relationshipUuids e.g. CongruentTo; "60974c98-64ab-4574-bb5c-c110f6db634d"
129			* - relationshipInversUuids
130			* - maxDepth null for unlimited
131			* - pageNumber
132			* - pageSize
133			* - unknown_type
134	3a0d572f	Andreas Kohlbecker	*/
135			define('CDM_WS_OCCURRENCE_BY_ASSOCIATEDTAXON', 'occurrence/byAssociatedTaxon');
136	c10f70e4	Katja Luther	define('CDM_WS_OCCURRENCE_FIELDUNIT_DTO_BY_ASSOCIATEDTAXON', 'occurrence/specimensOrObservationsByAssociatedTaxon');
137	6657531f	Andreas Kohlbecker	define('CDM_WS_DERIVEDUNIT_FACADE', 'derivedUnitFacade/$0');
138
139			define('CDM_WS_IDENTIFICATIONKEY', 'identificationKey');
140			define('CDM_WS_MEDIAKEY', 'mediaKey');
141			define('CDM_WS_MULTIACCESSKEY', 'multiAccessKey');
142			define('CDM_WS_POLYTOMOUSKEY', 'polytomousKey');
143			define('CDM_WS_POLYTOMOUSKEY_NODE', 'polytomousKeyNode');
144
145	b20f6a5f	Andreas Kohlbecker	define('CDM_WS_MEDIA', 'media');
146	6657531f	Andreas Kohlbecker	define('CDM_WS_PORTAL_MEDIA', 'portal/media');
147
148			define('CDM_WS_MEDIA_METADATA', 'media/$0/metadata');
149
150			define('CDM_WS_MANAGE_REINDEX', 'manage/reindex');
151			define('CDM_WS_MANAGE_PURGE', 'manage/purge');

Project

General

Profile

EDIT