/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 @ 6eaec849

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

Project

General

Profile

EDIT