Feature #1275
Updated by Bernhard Koschiček-Krombholz almost 4 years ago
As discussed at the [[Meeting_API_2020-06-15|API meeting]], the API need more parameters, so a frontend can used it. *Branch name:* feature_api_pagination First wave parameters: * Pagination -> Seek Method ** Default value and offset * Filtering Basic Operators * Searching * Sorting Basic ASC/DESC Second wave parameters: * Filtering: ** show subunits for classes and types #1206 ** XXX ** XXX Please change the parameters to your needs. Example of path. <pre><code class="xml"> <pre> /class/{class}: /class/{class}/{limit}/{column}/{filter}/{sort}: get: tags: - Users summary: retrieves a list of geojson representations wich share a specified class code operationId: retrieveEntitiesByClass security: - cookieAuth: [] parameters: - in: path name: class description: a cidocCRM class code eg E21 required: true schema: type: string - in: query path name: limit description: number of geojson representations to be returned required: true schema: type: number - in: query path name: column description: the column wich should be sorted and filtered required: true schema: type: string - in: query path name: sort description: sort direction asc/desc required: true schema: type: string - in: query path name: filter description: filter operator to be applied required: true schema: type: string responses: '200': description: a geojson representation of the specified entities content: application/ld+json: schema: $ref: '#/components/schemas/featureCollectionGeoJSON' '404': description: not found </code></pre> </pre>