{ "openapi": "3.0.0", "info": { "title": "Catalog Provider API", "description": "Read and update catalog resources.\n\nAuthenticate with a Personal Access Token, using the Bearer scheme.\nManage your Tokens in your account, in the security section.\n\nUse HTTP header `Accept: application/json` in your requests to ensure a JSON response from server.\n\nWhen sending JSON, don't escape unicode characters.\n\nCurrent version of this API only support GeoData resources, and a subset of fields.\n", "termsOfService": "https://viageo.ch/conditions-generales", "contact": { "name": "ASIT Support", "url": "https://viageo.ch/support", "email": "support@viageo.ch" }, "version": "0.1.2" }, "paths": { "/api/catalog/provider/geodata/": { "get": { "summary": "List all GeoData Resources for the account", "operationId": "get_catalog_provider_api_geodata_list.fr", "requestBody": { "content": { "application/json": {} } }, "responses": { "200": { "description": "List all GeoData Resources a user can edit", "content": { "application/json": { "schema": { "type": "array", "items": { "properties": { "uuid": { "type": "string", "example": "691738d6-1d32-4671-b627-1667b0da5d8e" }, "title": { "type": "string", "example": "Title of the resource" }, "owner": { "type": "string", "example": "Super Commune" }, "ownerUuid": { "type": "string", "example": "06b0bfc8-6812-418b-a2ac-2d13d4a8cb45" }, "status": { "type": "string", "default": "published", "enum": [ "draft", "unpublished", "published", "archived" ] }, "canBeEdited": { "type": "boolean" }, "canBeDeleted": { "type": "boolean" } }, "type": "object" } } } } } } } }, "/api/catalog/provider/geodata/{uuid}/": { "get": { "summary": "Get one GeoData", "operationId": "get_catalog_provider_api_geodata_read.fr", "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string", "pattern": "[a-f0-9\\-]+" } } ], "requestBody": { "content": { "application/json": {} } }, "responses": { "200": { "description": "Get a GeoData Resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GeoDataDTO" } } } } } }, "patch": { "summary": "Partially update a GeoData.", "description": "If you want to partially update a GeoData (for example, change an existing field or add a new one) you\ncan do so by sending only the field concerned.\\\nThis merges the fields sent with the existing GeoData.\n\nIf you want to remove a value, set it to `null`, or `[]` for arrays.", "operationId": "patch_catalog_provider_api_geodata_update_patch.fr", "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string", "pattern": "[a-f0-9\\-]+" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GeoDataDTO2" } } } }, "responses": { "200": { "description": "The updated GeoData Resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GeoDataDTO" } } } } } } }, "/api/catalog/provider/geodata/{uuid}/status": { "get": { "summary": "Get status of a GeoData. Published or unpublished.", "operationId": "get_catalog_provider_api_geodata_status_get.fr", "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string", "pattern": "[a-f0-9\\-]+" } } ], "responses": { "200": { "description": "Current status", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StatusDTO2" } } } } } }, "put": { "summary": "Change status of a GeoData. Published or unpublished.", "operationId": "put_catalog_provider_api_geodata_status_put.fr", "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string", "pattern": "[a-f0-9\\-]+" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StatusDTO3" } } } }, "responses": { "200": { "description": "New status", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StatusDTO2" } } } } } } } }, "components": { "schemas": { "StatusDTO": { "required": [ "status" ], "properties": { "status": { "type": "string" } }, "type": "object" }, "UserDTO": { "required": [ "fullName", "email", "id", "uuid" ], "properties": { "fullName": { "type": "string", "example": "Firstname Lastname" }, "email": { "type": "string", "example": "firstname.lastname@example.org" }, "id": { "type": "integer" }, "uuid": { "type": "string", "example": "a89166eb-0e1f-4968-a57f-f0ab9fa35929" } }, "type": "object" }, "GeoDataDTO": { "required": [ "networkTypes", "creationDate", "publicationDate", "lastUpdateDate", "extent", "title", "abstract", "managers" ], "properties": { "dataType": { "type": "string", "enum": [ "network", "image", "other" ], "nullable": true }, "networkTypes": { "description": "Required for dataType : network", "type": "array", "items": { "enum": [ "electricity_distribution", "electricity_signal", "electricity_street_lighting", "electricity_transport", "gas_distribution", "gas_transport", "remote_cooling", "remote_heating", "telecom_multimedia", "wastewater_primary", "wastewater_secondary", "water_distribution", "water_transport" ] }, "enum": [ "electricity_distribution", "electricity_signal", "electricity_street_lighting", "electricity_transport", "gas_distribution", "gas_transport", "remote_cooling", "remote_heating", "telecom_multimedia", "wastewater_primary", "wastewater_secondary", "water_distribution", "water_transport" ] }, "emergencyPhoneNumber": { "description": "Only for dataType : network", "type": "string", "nullable": true }, "emergencyPhoneNumberNote": { "description": "Only for dataType : network", "type": "string", "nullable": true }, "networkConnectionInformation": { "description": "Only for dataType : network. URL to a network connection information page or document.", "type": "string", "nullable": true }, "topicCategory": { "description": "GeoCategory code specified in eCH-0166 : https://www.ech.ch/fr/ech/ech-0166/1.2", "type": "string", "enum": [ "imageryBaseMapsEarthCover_BaseMaps", "imageryBaseMapsEarthCover_EarthCover", "imageryBaseMapsEarthCover_Imagery", "location", "elevation", "boundaries", "planningCadastre_Planning", "planningCadastre_Cadastre", "geoscientificInformation_Geology", "geoscientificInformation_Soils", "geoscientificInformation_NaturalHazards", "biota", "oceans", "inlandWaters", "climatologyMeteorologyAtmosphere", "environment_EnvironmentalProtection", "environment_NatureProtection", "society", "health", "structure", "transportation", "utilitiesCommunication_Energy", "utilitiesCommunication_Utilities", "utilitiesCommunication_Communication", "intelligenceMilitary", "farming", "economy" ], "nullable": true }, "resolution": { "description": "Required for dataType : image. Value unit is [cm].", "type": "string", "enum": [ "2", "5", "10", "15", "20", "25", "50", "62.5", "100", "200", "500", "1000", "1500", "2000", "2500", "5000" ], "nullable": true }, "resolutionNote": { "type": "string", "nullable": true }, "optimalScaleDenominator": { "description": "Level of detail expressed as the scale denominator of a comparable hardcopy map or chart. E.g. `5000` value for a `1:5000` scale.", "type": "integer", "enum": [ 100, 200, 250, 500, 1000, 2000, 5000, 10000, 20000, 25000, 50000, 100000, 200000, 500000, 1000000 ], "nullable": true }, "acquisitionDate": { "description": "Required for dataType : image", "type": "string", "nullable": true }, "isOpenData": { "type": "boolean", "nullable": true }, "openDataTermsOfUse": { "description": "Required if `isOpenData` is true. See values : https://opendata.swiss/en/terms-of-use", "type": "string", "enum": [ "open", "by", "ask", "by_ask" ], "nullable": true }, "creationDate": { "type": "string", "format": "date" }, "publicationDate": { "type": "string", "format": "date" }, "referenceSystemEPSG": { "type": "string", "enum": [ "EPSG:2056", "EPSG:21781", "EPSG:4326", "EPSG:5728", "EPSG:5729" ], "nullable": true }, "lineage": { "type": "string", "nullable": true }, "lastUpdateDate": { "type": "string", "format": "date" }, "updateFrequency": { "type": "string", "enum": [ "continual", "daily", "weekly", "monthly", "annually", "asNeeded", "notPlanned" ], "nullable": true }, "updateFrequencyNote": { "type": "string", "nullable": true }, "geoDataStatus": { "type": "string", "enum": [ "completed", "onGoing", "planned", "historicalArchive" ], "nullable": true }, "hasElevationInformation": { "type": "boolean", "nullable": true }, "extent": { "type": "object", "oneOf": [ { "title": "FREE (geom/multipolygon) type perimeter definition", "properties": { "type": { "type": "string", "default": "FREE", "enum": [ "FREE" ] }, "geom": { "description": "A valid GeoJSON describing a POLYGON or MULTIPOLYGON", "type": "object", "example": "{\n \"type\": \"MultiPolygon\",\n \"crs\": {\n \"type\": \"name\",\n \"properties\": {\n \"name\": \"urn:ogc:def:crs:EPSG::2056\"\n }\n },\n \"coordinates\": [\n [[[2537610.439, 1154738.812], [2536260.439, 1153538.812], [2537310.439, 1152088.812], [2538910.439, 1153088.812], [2537610.439, 1154738.812]]]\n ]\n }" } } }, { "title": "MUNICIPALITY perimeter definition", "properties": { "type": { "type": "string", "default": "MUNICIPALITY", "enum": [ "MUNICIPALITY" ] }, "identifiers": { "description": "List of OFS/BFS number of municipalities", "type": "array", "items": { "type": "integer", "example": 5586 } } } }, { "title": "CANTON perimeter definition", "properties": { "type": { "type": "string", "default": "CANTON", "enum": [ "CANTON" ] }, "identifiers": { "description": "List of OFS/BFS number of cantons", "type": "array", "items": { "type": "integer", "example": 22 } } } }, { "title": "LAKE perimeter definition", "properties": { "type": { "type": "string", "default": "LAKE", "enum": [ "LAKE" ] }, "identifiers": { "description": "List of OFS/BFS number of lakes", "type": "array", "items": { "type": "integer", "example": 9757 } } } }, { "title": "KM_GRID perimeter definition", "properties": { "type": { "type": "string", "default": "KM_GRID", "enum": [ "KM_GRID" ] }, "identifiers": { "description": "List of KM_GRID swisstopo identifier", "type": "array", "items": { "type": "string", "example": "2537_1152" } } } } ] }, "extentNote": { "type": "string", "nullable": true }, "distributionContact": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/UserDTO" } ] }, "id": { "type": "integer", "nullable": true }, "uuid": { "type": "string", "nullable": true }, "extraLocales": { "nullable": true, "oneOf": [ { "type": "array", "items": { "nullable": true } }, { "type": "object", "additionalProperties": { "nullable": true } } ] }, "title": { "description": "A hashmap with language code as a key and the text as the value.", "properties": { "fr": { "description": "French title", "type": "string", "example": "Titre en fran\u00e7ais" } }, "type": "object", "example": "{\"fr\": \"Titre en fran\u00e7ais\", \"de\": \"Deutscher Titel\"}", "additionalProperties": { "type": "string" } }, "abstract": { "description": "A hashmap with language code as a key and the text as the value.", "properties": { "fr": { "description": "French abstract", "type": "string", "example": "Description en fran\u00e7ais" } }, "type": "object", "example": "{\"fr\": \"Description en fran\u00e7ais\", \"de\": \"Deutsche Beschreibung\"}", "additionalProperties": { "type": "string" } }, "status": { "type": "string", "enum": [ "draft", "unpublished", "published", "archived" ], "nullable": true }, "useLimitation": { "type": "string", "nullable": true }, "legalConstraints": { "type": "string", "nullable": true }, "managers": { "title": "Users who can edit the resource", "oneOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/UserDTO" } }, { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/UserDTO" } } ] }, "manageContact": { "title": "User shown as Manage Contact (custodian)", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/UserDTO" } ] }, "metadataContact": { "title": "User shown as Metadata Contact", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/UserDTO" } ] } }, "type": "object" }, "GeoDataDTO2": { "required": [ "networkTypes", "creationDate", "publicationDate", "lastUpdateDate", "extent", "title", "abstract" ], "properties": { "dataType": { "type": "string", "enum": [ "network", "image", "other" ], "nullable": true }, "networkTypes": { "description": "Required for dataType : network", "type": "array", "items": { "enum": [ "electricity_distribution", "electricity_signal", "electricity_street_lighting", "electricity_transport", "gas_distribution", "gas_transport", "remote_cooling", "remote_heating", "telecom_multimedia", "wastewater_primary", "wastewater_secondary", "water_distribution", "water_transport" ] }, "enum": [ "electricity_distribution", "electricity_signal", "electricity_street_lighting", "electricity_transport", "gas_distribution", "gas_transport", "remote_cooling", "remote_heating", "telecom_multimedia", "wastewater_primary", "wastewater_secondary", "water_distribution", "water_transport" ] }, "emergencyPhoneNumber": { "description": "Only for dataType : network", "type": "string", "nullable": true }, "emergencyPhoneNumberNote": { "description": "Only for dataType : network", "type": "string", "nullable": true }, "networkConnectionInformation": { "description": "Only for dataType : network. URL to a network connection information page or document.", "type": "string", "nullable": true }, "topicCategory": { "description": "GeoCategory code specified in eCH-0166 : https://www.ech.ch/fr/ech/ech-0166/1.2", "type": "string", "enum": [ "imageryBaseMapsEarthCover_BaseMaps", "imageryBaseMapsEarthCover_EarthCover", "imageryBaseMapsEarthCover_Imagery", "location", "elevation", "boundaries", "planningCadastre_Planning", "planningCadastre_Cadastre", "geoscientificInformation_Geology", "geoscientificInformation_Soils", "geoscientificInformation_NaturalHazards", "biota", "oceans", "inlandWaters", "climatologyMeteorologyAtmosphere", "environment_EnvironmentalProtection", "environment_NatureProtection", "society", "health", "structure", "transportation", "utilitiesCommunication_Energy", "utilitiesCommunication_Utilities", "utilitiesCommunication_Communication", "intelligenceMilitary", "farming", "economy" ], "nullable": true }, "resolution": { "description": "Required for dataType : image. Value unit is [cm].", "type": "string", "enum": [ "2", "5", "10", "15", "20", "25", "50", "62.5", "100", "200", "500", "1000", "1500", "2000", "2500", "5000" ], "nullable": true }, "resolutionNote": { "type": "string", "nullable": true }, "optimalScaleDenominator": { "description": "Level of detail expressed as the scale denominator of a comparable hardcopy map or chart. E.g. `5000` value for a `1:5000` scale.", "type": "integer", "enum": [ 100, 200, 250, 500, 1000, 2000, 5000, 10000, 20000, 25000, 50000, 100000, 200000, 500000, 1000000 ], "nullable": true }, "acquisitionDate": { "description": "Required for dataType : image", "type": "string", "nullable": true }, "isOpenData": { "type": "boolean", "nullable": true }, "openDataTermsOfUse": { "description": "Required if `isOpenData` is true. See values : https://opendata.swiss/en/terms-of-use", "type": "string", "enum": [ "open", "by", "ask", "by_ask" ], "nullable": true }, "creationDate": { "type": "string", "format": "date" }, "publicationDate": { "type": "string", "format": "date" }, "referenceSystemEPSG": { "type": "string", "enum": [ "EPSG:2056", "EPSG:21781", "EPSG:4326", "EPSG:5728", "EPSG:5729" ], "nullable": true }, "lineage": { "type": "string", "nullable": true }, "lastUpdateDate": { "type": "string", "format": "date" }, "updateFrequency": { "type": "string", "enum": [ "continual", "daily", "weekly", "monthly", "annually", "asNeeded", "notPlanned" ], "nullable": true }, "updateFrequencyNote": { "type": "string", "nullable": true }, "geoDataStatus": { "type": "string", "enum": [ "completed", "onGoing", "planned", "historicalArchive" ], "nullable": true }, "hasElevationInformation": { "type": "boolean", "nullable": true }, "extent": { "type": "object", "oneOf": [ { "title": "FREE (geom/multipolygon) type perimeter definition", "properties": { "type": { "type": "string", "default": "FREE", "enum": [ "FREE" ] }, "geom": { "description": "A valid GeoJSON describing a POLYGON or MULTIPOLYGON", "type": "object", "example": "{\n \"type\": \"MultiPolygon\",\n \"crs\": {\n \"type\": \"name\",\n \"properties\": {\n \"name\": \"urn:ogc:def:crs:EPSG::2056\"\n }\n },\n \"coordinates\": [\n [[[2537610.439, 1154738.812], [2536260.439, 1153538.812], [2537310.439, 1152088.812], [2538910.439, 1153088.812], [2537610.439, 1154738.812]]]\n ]\n }" } } }, { "title": "MUNICIPALITY perimeter definition", "properties": { "type": { "type": "string", "default": "MUNICIPALITY", "enum": [ "MUNICIPALITY" ] }, "identifiers": { "description": "List of OFS/BFS number of municipalities", "type": "array", "items": { "type": "integer", "example": 5586 } } } }, { "title": "CANTON perimeter definition", "properties": { "type": { "type": "string", "default": "CANTON", "enum": [ "CANTON" ] }, "identifiers": { "description": "List of OFS/BFS number of cantons", "type": "array", "items": { "type": "integer", "example": 22 } } } }, { "title": "LAKE perimeter definition", "properties": { "type": { "type": "string", "default": "LAKE", "enum": [ "LAKE" ] }, "identifiers": { "description": "List of OFS/BFS number of lakes", "type": "array", "items": { "type": "integer", "example": 9757 } } } }, { "title": "KM_GRID perimeter definition", "properties": { "type": { "type": "string", "default": "KM_GRID", "enum": [ "KM_GRID" ] }, "identifiers": { "description": "List of KM_GRID swisstopo identifier", "type": "array", "items": { "type": "string", "example": "2537_1152" } } } } ] }, "extentNote": { "type": "string", "nullable": true }, "extraLocales": { "nullable": true, "oneOf": [ { "type": "array", "items": { "nullable": true } }, { "type": "object", "additionalProperties": { "nullable": true } } ] }, "title": { "description": "A hashmap with language code as a key and the text as the value.", "properties": { "fr": { "description": "French title", "type": "string", "example": "Titre en fran\u00e7ais" } }, "type": "object", "example": "{\"fr\": \"Titre en fran\u00e7ais\", \"de\": \"Deutscher Titel\"}", "additionalProperties": { "type": "string" } }, "abstract": { "description": "A hashmap with language code as a key and the text as the value.", "properties": { "fr": { "description": "French abstract", "type": "string", "example": "Description en fran\u00e7ais" } }, "type": "object", "example": "{\"fr\": \"Description en fran\u00e7ais\", \"de\": \"Deutsche Beschreibung\"}", "additionalProperties": { "type": "string" } }, "useLimitation": { "type": "string", "nullable": true }, "legalConstraints": { "type": "string", "nullable": true } }, "type": "object" }, "StatusDTO2": { "required": [ "status" ], "properties": { "status": { "type": "string", "enum": [ "draft", "unpublished", "published", "archived" ] } }, "type": "object" }, "StatusDTO3": { "required": [ "status" ], "properties": { "status": { "type": "string", "enum": [ "published", "unpublished" ] } }, "type": "object" } }, "securitySchemes": { "bearer": { "type": "http", "description": "Personal Access Token, you can generate one in your account", "name": "Personal Access Token", "bearerFormat": "Personal Access Token", "scheme": "bearer" } } }, "security": [ { "bearer": [] } ] }