Project

General

Profile

Download (7.8 KB) Statistics
| Branch: | Tag: | Revision:
1
<?php
2
/**
3
 * @file
4
 * CDM Server URI definitions.
5
 */
6

    
7
const CDM_WS_CLASSIFICATION = 'classification';
8

    
9
const CDM_WS_AGENT = 'agent';
10
const CDM_WS_PORTAL_AGENT = 'portal/agent';
11
const CDM_WS_REFERENCE = 'reference';
12
const CDM_WS_REFERENCE_AUTHORTEAM = 'reference/$0/authorship';
13
/**
14
 * Parameter $0 : the reference uuid
15
 *
16
 * Provides the protologue and original publication links of the name
17
 */
18
const CDM_WS_NAME_PROTOLOGUE_LINKS = 'name/$0/protologueLinks';
19
const CDM_WS_NOMENCLATURAL_REFERENCE_CITATION = 'reference/$0/nomenclaturalCitation';
20

    
21
const CDM_WS_NAME = 'name';
22
const CDM_WS_NAME_NAMECAHE = 'name/$0/nameCache';
23
const CDM_WS_NAME_TYPEDESIGNATIONS = 'name/$0/typeDesignations';
24
const CDM_WS_TYPE_DESIGNATION_STATUS_FILTER_TERMS = 'name/typeDesignationStatusFilterTerms';
25

    
26
const CDM_WS_PORTAL_NAME = 'portal/name';
27
const CDM_WS_PORTAL_NAME_FINDBYNAME = 'name/findByName/';
28
const CDM_WS_PORTAL_NAME_DESCRIPTIONS = 'portal/name/$0/taxonNameDescriptions';
29
const CDM_WS_PORTAL_NAME_TYPEDESIGNATIONS = 'portal/name/$0/typeDesignations';
30
const CDM_WS_PORTAL_NAME_TYPEDESIGNATIONS_IN_HOMOTYPICAL_GROUP = 'portal/name/$0/typeDesignationsInHomotypicalGroup';
31
const CDM_WS_PORTAL_NAME_NAME_RELATIONS = 'portal/name/$0/nameRelations';
32

    
33
const CDM_WS_NOMENCLATURALSTATUS = 'nomenclaturalStatus/$0';
34

    
35
const CDM_WS_TYPEDESIGNATION = 'typedesignation/$0';
36
const CDM_WS_PORTAL_TYPEDESIGNATION = 'portal/typedesignation/$0';
37

    
38

    
39
const CDM_WS_TAXON = 'taxon';
40

    
41
const CDM_WS_PORTAL_TAXON_ROOTUNIT_DTOS = 'portal/taxon/$0/rootUnitDTOs';
42

    
43
const CDM_WS_TAXON_CLASSIFICATIONS = 'taxon/$0/classifications';
44
const CDM_WS_TAXON_FINDBY_DESCRIPTIONELEMENT_FULLTEXT = 'taxon/findByDescriptionElementFullText';
45
/**
46
 * Parameter $0 : the taxon uuid.
47
 *
48
 * Returns the taxon which is the accepted synonym for the taxon given as
49
 * parameter taxonUuid. If the taxon specified by taxonUuid is itself the
50
 * accepted taxon, this one will be returned.
51
 */
52
const CDM_WS_PORTAL_TAXON_ACCEPTED = 'portal/taxon/$0/accepted';
53

    
54
const CDM_WS_PORTAL_TAXON = 'portal/taxon';
55
const CDM_WS_PORTAL_TAXON_SYNONYMY = 'portal/taxon/$0/synonymy';
56
const CDM_WS_PORTAL_TAXON_RELATIONS = 'portal/taxon/$0/taxonRelationships';
57
const CDM_WS_PORTAL_TAXON_RELATIONS_DTO = 'taxon/$0/taxonRelationshipsDTO';
58
const CDM_WS_PORTAL_TAXON_DESCRIPTIONS = 'portal/taxon/$0/descriptions';
59
const CDM_WS_PORTAL_TAXON_TAXONNODEAGENTRELATIONS = 'portal/taxon/$0/taxonNodeAgentRelations/$1';
60

    
61
/**
62
 * Parameter $0: taxon UUID.
63
 * Parameter $1: simple name of the class extending DescriptionElementBase.
64
 */
65
const CDM_WS_PORTAL_TAXON_DESCRIPTIONS_ELEMENTSBYTYPE = 'portal/taxon/$0/descriptions/elementsByType/$1';
66
const CDM_WS_PORTAL_TAXON_USEDESCRIPTIONS = 'portal/taxon/$0/useDescriptions';
67
const CDM_WS_PORTAL_TAXON_ASSOCIATED_ROOTUNITS = 'portal/taxon/$0/associatedRootUnits';
68
const CDM_WS_PORTAL_TAXON_TO_NAMERELATIONS = 'portal/taxon/$0/toNameRelationships';
69
const CDM_WS_PORTAL_TAXON_FROM_NAMERELATIONS = 'portal/taxon/$0/fromNameRelationships';
70
const CDM_WS_PORTAL_TAXON_MEDIA = 'portal/taxon/$0/media';
71
const CDM_WS_PORTAL_TAXON_SUBTREE_MEDIA = 'portal/taxon/$0/subtree/media';
72

    
73
const CDM_WS_PORTAL_TAXON_TAXONNODES = 'portal/taxon/$0/taxonNodes';
74
const CDM_WS_PORTAL_TAXON_FIND = 'portal/taxon/find';
75
const CDM_WS_PORTAL_TAXON_SEARCH = 'portal/taxon/search';
76
const CDM_WS_TAXON_SEARCH = 'taxon/search';
77
const CDM_WS_PORTAL_TAXON_FINDBY_DESCRIPTIONELEMENT_FULLTEXT = 'portal/taxon/findByDescriptionElementFullText';
78

    
79
const CDM_WS_IIIF_TAXON_MANIFEST = 'iiif/taxon/$0/manifest';
80

    
81

    
82
const CDM_WS_TAXONNODE = 'taxonNode/$0';
83

    
84
/**
85
 * /description/{uuid}/naturalLanguageDescription/{termtree_uuid}
86
 */
87
const CDM_WS_DESCRIPTION_NAMEDAREAS_IN_USE = 'description/namedAreasInUse';
88
const CDM_WS_DESCRIPTION_NATURALLANGUAGE_DESCRIPTION = 'description/$0/naturalLanguageDescription/$1';
89
const CDM_WS_DESCRIPTION_HAS_STRUCTRURED_DATA = 'description/$0/hasStructuredData';
90

    
91
const CDM_WS_PORTAL_DESCRIPTION = 'portal/description/$0';
92
const CDM_WS_PORTAL_DESCRIPTION_AREAS_TREE = 'portal/description/$0/namedAreaTree';
93

    
94
const CDM_WS_PORTAL_DESCRIPTION_DISTRIBUTION_INFO_FOR = 'portal/description/distributionInfoFor/$0';
95

    
96
const CDM_WS_DESCRIPTIONELEMENT = 'descriptionElement/$0';
97
const CDM_WS_DESCRIPTIONELEMENT_BY_TAXON = 'portal/descriptionElement/byTaxon';
98
const CDM_WS_PORTAL_DESCRIPTIONELEMENT = 'portal/descriptionElement/$0';
99

    
100
/**
101
 * Gets the root nodes of the taxonomic concept tree for the concept
102
 * reference specified by the secUuid parameter.
103
 *
104
 * stub: treenode_root
105
 */
106
const CDM_WS_PORTAL_TAXONOMY = 'portal/classification';
107
/**
108
 * TODO: harmonize return type, the REST service should return TaxonNodeDto, see #6222
109
 *
110
 * returns list of TaxonNode
111
 */
112
const CDM_WS_PORTAL_TAXONOMY_CHILDNODES = 'portal/classification/$0/childNodes';
113
/**
114
 * returns list of TaxonNodeDto
115
 */
116
const CDM_WS_PORTAL_TAXONOMY_CHILDNODES_AT_RANK = 'portal/classification/$0/childNodesAt/$1';
117
/**
118
 * returns list of TaxonNodeDto
119
 */
120
const CDM_WS_PORTAL_TAXONOMY_CHILDNODES_OF_TAXON = 'portal/classification/$0/childNodesOf/$1';
121
/**
122
 * returns list of TaxonNodeDto
123
 */
124
const CDM_WS_PORTAL_TAXONOMY_PATH_FROM = 'portal/classification/$0/pathFrom/$1';
125
/**
126
 * returns list of TaxonNodeDto
127
 */
128
const CDM_WS_PORTAL_TAXONOMY_PATH_FROM_TO_RANK = 'portal/classification/$0/pathFrom/$1/toRank/$2';
129
const CDM_WS_PORTAL_TAXONOMY_MEDIA = 'portal/classification/$0/$1';
130

    
131
const CDM_WS_TAXONNODE_PARENT = 'taxonNode/$0/parent';
132

    
133
const CDM_WS_TERMVOCABULARY = 'termVocabulary/$0';
134

    
135
const CDM_WS_TERM_COMPARE = 'term/$0/compareTo/$1';
136
const CDM_WS_TERM = 'term';
137
const CDM_WS_PORTAL_TERM = 'portal/term/$0';
138

    
139

    
140
const CDM_WS_TERMTREE = 'portal/termTree/$0';
141
const CDM_WS_TERMTREES = 'portal/termTree';
142
// define('CDM_WS_TERMTREE_CHILDREN', 'termTree/$0/children');
143
const CDM_WS_GEOSERVICE_DISTRIBUTIONMAP = 'ext/edit/mapServiceParameters/taxonDistributionFor/$0';
144
const CDM_WS_GEOSERVICE_OCCURRENCEMAP_FOR_FIELDUNITS = 'ext/edit/mapServiceParameters/taxonOccurrencesForX';
145
const CDM_WS_GEOSERVICE_OCCURRENCEMAP = 'ext/edit/mapServiceParameters/taxonOccurrencesFor/$0';
146
const CDM_WS_KML_SPECIMENSOROCCURENCES = 'kml/specimensOrOccurences/$0';
147
const CDM_WS_KML_TYPEDESIGNATIONS = 'kml/typeDesignations/$0';
148
const CDM_WS_KML_TAXON_OCCURRENCE = 'kml/taxonOccurrencesFor/$0';
149

    
150
const CDM_WS_OCCURRENCE = 'occurrence';
151
const CDM_WS_OCCURRENCE_ROOT_UNIT_DTOS = 'occurrence/$0/rootUnitDTOs';
152
const CDM_WS_PORTAL_OCCURRENCE = 'portal/occurrence';
153
const CDM_WS_PORTAL_OCCURRENCE_AS_DTO = 'portal/occurrence/$0/asDTO';
154
const CDM_WS_OCCURRENCE_ACCESSION_NUMBER = 'occurrence/byGeneticAccessionNumber';
155
/**
156
 * url query parameters:
157
 *
158
 * - taxonUuid
159
 * - relationshipUuids e.g. CongruentTo;  "60974c98-64ab-4574-bb5c-c110f6db634d"
160
 * - relationshipInversUuids
161
 * - maxDepth null for unlimited
162
 * - pageNumber
163
 * - pageSize
164
 * - unknown_type
165
 *
166
 * returns Pager<SpecimenOrObservationBase>
167
 */
168
const CDM_WS_OCCURRENCE_BY_ASSOCIATEDTAXON = 'occurrence/byAssociatedTaxon';
169
const CDM_WS_OCCURRENCE_ROOTUNIT_DTO_BY_ASSOCIATEDTAXON = 'occurrence/rootUnitDTOsByAssociatedTaxon';
170
const CDM_WS_DERIVEDUNIT_FACADE = 'derivedUnitFacade/$0';
171
const CDM_WS_PORTAL_DERIVEDUNIT_FACADE = 'portal/derivedUnitFacade/$0';
172

    
173
const CDM_WS_IDENTIFICATIONKEY = 'identificationKey';
174
const CDM_WS_MEDIAKEY = 'mediaKey';
175
const CDM_WS_MULTIACCESSKEY = 'multiAccessKey';
176
const CDM_WS_POLYTOMOUSKEY = 'polytomousKey';
177
const CDM_WS_PORTAL_POLYTOMOUSKEY_NODE = 'portal/polytomousKeyNode';
178

    
179
const CDM_WS_MEDIA = 'media';
180
const CDM_WS_PORTAL_MEDIA = 'portal/media';
181

    
182
const CDM_WS_MEDIA_METADATA = 'media/$0/metadata';
183

    
184
const CDM_WS_REGISTRATION = "registration";
185

    
186
/**
187
 * url query parameters:
188
 *  - identifier (mandatory)
189
 *
190
 */
191
const CDM_WS_REGISTRATION_DTO = "registrationDTO";
192
/**
193
 * url query parameters:
194
 *  - identifier (mandatory)
195
 *
196
 */
197
const CDM_WS_REGISTRATION_STATUS = "registration/status";
198

    
199
const CDM_WS_MANAGE_REINDEX = 'manage/reindex';
200
const CDM_WS_MANAGE_PURGE = 'manage/purge';
201

    
202
const CDM_WS_EVENTBASE = 'eventBase';
(11-11/12)