Project

General

Profile

Statistics
| Branch: | Tag: | Revision:

cdm-dataportal / modules / cdm_dataportal / cdm_api / webservice_uris.php @ a9a297f6

History | View | Annotate | Download (7.73 KB)

1
<?php
2
/**
3
 * @file
4
 * CDM Server URI definitions.
5
 */
6

    
7
define('CDM_WS_PORTAL_GENERIC', 'portal/$0');
8

    
9
const CDM_WS_CLASSIFICATION = 'classification';
10

    
11
define('CDM_WS_AGENT', 'agent');
12
define('CDM_WS_PORTAL_AGENT', 'portal/agent');
13
define('CDM_WS_REFERENCE', 'reference');
14
define('CDM_WS_REFERENCE_AUTHORTEAM', 'reference/$0/authorship');
15
define('CDM_WS_NOMENCLATURAL_REFERENCE_CITATION', 'reference/$0/nomenclaturalCitation');
16

    
17
define('CDM_WS_NAME', 'name');
18
define('CDM_WS_NAME_NAMECAHE', 'name/$0/nameCache');
19
define('CDM_WS_NAME_TYPEDESIGNATIONS', 'name/$0/typeDesignations');
20
define('CDM_WS_TYPE_DESIGNATION_STATUS_FILTER_TERMS', 'name/typeDesignationStatusFilterTerms');
21

    
22
define('CDM_WS_PORTAL_NAME', 'portal/name');
23
define('CDM_WS_PORTAL_NAME_FINDBYNAME', 'name/findByName/');
24
define('CDM_WS_PORTAL_NAME_DESCRIPTIONS', 'portal/name/$0/taxonNameDescriptions');
25
define('CDM_WS_PORTAL_NAME_TYPEDESIGNATIONS', 'portal/name/$0/typeDesignations');
26
define('CDM_WS_PORTAL_NAME_TYPEDESIGNATIONS_IN_HOMOTYPICAL_GROUP', 'portal/name/$0/typeDesignationsInHomotypicalGroup');
27
define('CDM_WS_PORTAL_NAME_NAME_RELATIONS', 'portal/name/$0/nameRelations');
28

    
29
define('CDM_WS_NOMENCLATURALSTATUS', 'nomenclaturalStatus/$0');
30

    
31
define('CDM_WS_TYPEDESIGNATION', 'typedesignation/$0');
32
define('CDM_WS_PORTAL_TYPEDESIGNATION', 'portal/typedesignation/$0');
33

    
34

    
35
define('CDM_WS_TAXON', 'taxon');
36

    
37
define('CDM_WS_TAXON_FIELDUNIT_DTOS', 'taxon/$0/fieldUnitDTOs');
38

    
39
define('CDM_WS_TAXON_CLASSIFICATIONS', 'taxon/$0/classifications');
40
define('CDM_WS_TAXON_FINDBY_DESCRIPTIONELEMENT_FULLTEXT', 'taxon/findByDescriptionElementFullText');
41
/**
42
 * Parameter $0 : the taxon uuid.
43
 *
44
 * Returns the taxon which is the accepted synonym for the taxon given as
45
 * parameter taxonUuid. If the taxon specified by taxonUuid is itself the
46
 * accepted taxon, this one will be returned.
47
 */
48
define('CDM_WS_PORTAL_TAXON_ACCEPTED', 'portal/taxon/$0/accepted');
49

    
50
define('CDM_WS_PORTAL_TAXON', 'portal/taxon');
51
define('CDM_WS_PORTAL_TAXON_SYNONYMY', 'portal/taxon/$0/synonymy');
52
define('CDM_WS_PORTAL_TAXON_RELATIONS', 'portal/taxon/$0/taxonRelationships');
53
define('CDM_WS_PORTAL_TAXON_RELATIONS_DTO', 'taxon/$0/taxonRelationshipsDTO');
54
define('CDM_WS_PORTAL_TAXON_DESCRIPTIONS', 'portal/taxon/$0/descriptions');
55
define('CDM_WS_PORTAL_TAXON_TAXONNODEAGENTRELATIONS', 'portal/taxon/$0/taxonNodeAgentRelations/$1');
56

    
57
/**
58
 * Parameter $0: taxon UUID.
59
 * Parameter $1: simple name of the class extending DescriptionElementBase.
60
 */
61
define('CDM_WS_PORTAL_TAXON_DESCRIPTIONS_ELEMENTSBYTYPE', 'portal/taxon/$0/descriptions/elementsByType/$1');
62
define('CDM_WS_PORTAL_TAXON_USEDESCRIPTIONS', 'portal/taxon/$0/useDescriptions');
63
define('CDM_WS_PORTAL_TAXON_TO_NAMERELATIONS', 'portal/taxon/$0/toNameRelationships');
64
define('CDM_WS_PORTAL_TAXON_FROM_NAMERELATIONS', 'portal/taxon/$0/fromNameRelationships');
65
define('CDM_WS_PORTAL_TAXON_MEDIA', 'portal/taxon/$0/media');
66
define('CDM_WS_PORTAL_TAXON_SUBTREE_MEDIA', 'portal/taxon/$0/subtree/media');
67

    
68
define('CDM_WS_PORTAL_TAXON_TAXONNODES', 'portal/taxon/$0/taxonNodes');
69
define('CDM_WS_PORTAL_TAXON_FIND', 'portal/taxon/find');
70
define('CDM_WS_PORTAL_TAXON_SEARCH', 'portal/taxon/search');
71
define('CDM_WS_TAXON_SEARCH', 'taxon/search');
72
define('CDM_WS_PORTAL_TAXON_FINDBY_DESCRIPTIONELEMENT_FULLTEXT', 'portal/taxon/findByDescriptionElementFullText');
73

    
74
define('CDM_WS_IIIF_TAXON_MANIFEST', 'iiif/taxon/$0/manifest');
75

    
76

    
77
define('CDM_WS_TAXONNODE', 'taxonNode/$0');
78

    
79
/**
80
 * /description/{uuid}/naturalLanguageDescription/{termtree_uuid}
81
 */
82
define('CDM_WS_DESCRIPTION_NAMEDAREAS_IN_USE', 'description/namedAreasInUse');
83
define('CDM_WS_DESCRIPTION_NATURALLANGUAGE_DESCRIPTION', 'description/$0/naturalLanguageDescription/$1');
84
define('CDM_WS_DESCRIPTION_HAS_STRUCTRURED_DATA', 'description/$0/hasStructuredData');
85

    
86
define('CDM_WS_PORTAL_DESCRIPTION', 'portal/description/$0');
87
define('CDM_WS_PORTAL_DESCRIPTION_AREAS_TREE', 'portal/description/$0/namedAreaTree');
88

    
89

    
90
define('CDM_WS_PORTAL_DESCRIPTION_DISTRIBUTION_INFO_FOR', 'portal/description/distributionInfoFor/$0');
91

    
92
define('CDM_WS_DESCRIPTIONELEMENT', 'descriptionElement/$0');
93
define('CDM_WS_DESCRIPTIONELEMENT_BY_TAXON', 'portal/descriptionElement/byTaxon');
94
define('CDM_WS_PORTAL_DESCRIPTIONELEMENT', 'portal/descriptionElement/$0');
95

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

    
127
define('CDM_WS_TAXONNODE_PARENT', 'taxonNode/$0/parent');
128

    
129
define('CDM_WS_TERMVOCABULARY', 'termVocabulary/$0');
130

    
131
define('CDM_WS_TERM_COMPARE', 'term/$0/compareTo/$1');
132
define('CDM_WS_TERM', 'term');
133
define('CDM_WS_PORTAL_TERM', 'portal/term/$0');
134

    
135

    
136
define('CDM_WS_TERMTREE', 'portal/termTree/$0');
137
define('CDM_WS_TERMTREES', 'portal/termTree');
138
// define('CDM_WS_TERMTREE_CHILDREN', 'termTree/$0/children');
139
define('CDM_WS_GEOSERVICE_DISTRIBUTIONMAP', 'ext/edit/mapServiceParameters/taxonDistributionFor/$0');
140
define('CDM_WS_GEOSERVICE_OCCURRENCEMAP_FOR_FIELDUNITS', 'ext/edit/mapServiceParameters/taxonOccurrencesForX');
141
define('CDM_WS_GEOSERVICE_OCCURRENCEMAP', 'ext/edit/mapServiceParameters/taxonOccurrencesFor/$0');
142
define('CDM_WS_KML_SPECIMENSOROCCURENCES', 'kml/specimensOrOccurences/$0');
143
define('CDM_WS_KML_TYPEDESIGNATIONS', 'kml/typeDesignations/$0');
144
define('CDM_WS_KML_TAXON_OCCURRENCE', 'kml/taxonOccurrencesFor/$0');
145

    
146
define('CDM_WS_OCCURRENCE', 'occurrence');
147
define('CDM_WS_OCCURRENCE_FILEUNIT_DTO', 'occurrence/$0/fieldUnitDTO');
148
define('CDM_WS_PORTAL_OCCURRENCE', 'portal/occurrence');
149
define('CDM_WS_OCCURRENCE_ACCESSION_NUMBER', 'occurrence/byGeneticAccessionNumber');
150
/**
151
 * url query parameters:
152
 *
153
 * - taxonUuid
154
 * - relationshipUuids e.g. CongruentTo;  "60974c98-64ab-4574-bb5c-c110f6db634d"
155
 * - relationshipInversUuids
156
 * - maxDepth null for unlimited
157
 * - pageNumber
158
 * - pageSize
159
 * - unknown_type
160
 *
161
 * returns Pager<SpecimenOrObservationBase>
162
 */
163
define('CDM_WS_OCCURRENCE_BY_ASSOCIATEDTAXON', 'occurrence/byAssociatedTaxon');
164
define('CDM_WS_OCCURRENCE_FIELDUNIT_DTO_BY_ASSOCIATEDTAXON', 'occurrence/specimensOrObservationsByAssociatedTaxon');
165
define('CDM_WS_DERIVEDUNIT_FACADE', 'derivedUnitFacade/$0');
166
define('CDM_WS_PORTAL_DERIVEDUNIT_FACADE', 'portal/derivedUnitFacade/$0');
167

    
168
define('CDM_WS_IDENTIFICATIONKEY', 'identificationKey');
169
define('CDM_WS_MEDIAKEY', 'mediaKey');
170
define('CDM_WS_MULTIACCESSKEY', 'multiAccessKey');
171
define('CDM_WS_POLYTOMOUSKEY', 'polytomousKey');
172
define('CDM_WS_PORTAL_POLYTOMOUSKEY_NODE', 'portal/polytomousKeyNode');
173

    
174
define('CDM_WS_MEDIA', 'media');
175
define('CDM_WS_PORTAL_MEDIA', 'portal/media');
176

    
177
define('CDM_WS_MEDIA_METADATA', 'media/$0/metadata');
178

    
179
/**
180
 * url query parameters:
181
 *  - identifier (mandatory)
182
 *
183
 */
184
define('CDM_WS_REGISTRATION_DTO', "registrationDTO");
185
/**
186
 * url query parameters:
187
 *  - identifier (mandatory)
188
 *
189
 */
190
define('CDM_WS_REGISTRATION_STATUS', "registration/status");
191

    
192
define('CDM_WS_MANAGE_REINDEX', 'manage/reindex');
193
define('CDM_WS_MANAGE_PURGE', 'manage/purge');
194

    
195
define('CDM_WS_EVENTBASE', 'eventBase');
Add picture from clipboard (Maximum size: 40 MB)