Infocenter update service endpoints¶
- For general information see How to work with infocenter update.
- Technical definitions of each API endpoint, sample code, test UI and Open API definitions to download could be found in the developer portal. -> developer.discover.swiss/apis
General headers¶
| Header Name | Type | Description |
|---|---|---|
| Ocp-Apim-Subscription-Key | string | Appropriate subscription key you can get in the developer portal |
General query parameters¶
| Parameter Name | Type | Description |
|---|---|---|
| project | string | project name of data to be modified |
| sourceId | string | external identifier of data which is used by partners on theirs portals |
Limitations¶
To ensure data integrity and comply with the underlying storage constraints, the following system limits apply:
- Maximum Request Size: The request body (JSON payload) for POST and PUT operations must not exceed 1.8 MB. This limit ensures that the data fits within the strict 2 MB document size limit of Azure Cosmos DB after internal processing and metadata addition. Requests exceeding this size will be rejected.
Creative Work¶
| Route | Type | Request type | Response type |
|---|---|---|---|
| /creativeWorks/{project} | POST | CreativeWorkRequest | UpdateResponse |
| /creativeWorks/{project} | PUT | CreativeWorkRequest | UpdateResponse |
| /creativeWorks/{project}/{sourceId} | GET | - | CreativeWorkRequest |
| /creativeWorks/{project}/{sourceId} | DELETE | - | UpdateResponse |
Tour¶
| Route | Type | Request type | Response type |
|---|---|---|---|
| /tours/{project} | POST | TourRequest | UpdateResponse |
| /tours/{project} | PUT | TourRequest | UpdateResponse |
| /tours/{project}/{sourceId} | GET | - | TourRequest |
| /tours/{project}/{sourceId} | DELETE | - | UpdateResponse |
Product¶
| Route | Type | Request type | Response type |
|---|---|---|---|
| /products/{project} | POST | ProductRequest | UpdateResponse |
| /products/{project} | PUT | ProductRequest | UpdateResponse |
| /products/{project}/{sourceId} | GET | - | ProductRequest |
| /products/{project}/{sourceId} | DELETE | - | UpdateResponse |
ImageObject¶
| Route | Type | Request type | Response type |
|---|---|---|---|
| /image/{project} | POST | multipart/form-data | string |
| /imageObjects/{project} | POST | ImageObjectRequest | UpdateResponse |
| /imageObjects/{project} | PUT | ImageObjectRequest | UpdateResponse |
| /imageObjects/{project}/{sourceId} | GET | - | ImageObjectRequest |
| /imageObjects/{project}/{sourceId} | DELETE | - | UpdateResponse |
FoodEstablishment¶
| Route | Type | Request type | Response type |
|---|---|---|---|
| /foodEstablishments/{project} | POST | FoodEstablishmentRequest | UpdateResponse |
| /foodEstablishments/{project} | PUT | FoodEstablishmentRequest | UpdateResponse |
| /foodEstablishments/{project}/{sourceId} | GET | - | FoodEstablishmentRequest |
| /foodEstablishments/{project}/{sourceId} | DELETE | - | UpdateResponse |
LodgingBusiness¶
| Route | Type | Request type | Response type |
|---|---|---|---|
| /lodgingbusinesses/{project} | POST | LodgingBusinessRequest | UpdateResponse |
| /lodgingbusinesses/{project} | PUT | LodgingBusinessRequest | UpdateResponse |
| /lodgingbusinesses/{project}/{sourceId} | GET | - | LodgingBusinessRequest |
| /lodgingbusinesses/{project}/{sourceId} | DELETE | - | UpdateResponse |
Accommodation¶
| Route | Type | Request type | Response type |
|---|---|---|---|
| /accommodations/{project} | POST | AccommodationRequest | UpdateResponse |
| /accommodations/{project} | PUT | AccommodationRequest | UpdateResponse |
| /accommodations/{project}/{sourceId} | GET | - | AccommodationRequest |
| /accommodations/{project}/{sourceId} | DELETE | - | UpdateResponse |
Webcam¶
| Route | Type | Request type | Response type |
|---|---|---|---|
| /webcams/{project} | POST | WebcamRequest | UpdateResponse |
| /webcams/{project} | PUT | WebcamRequest | UpdateResponse |
| /webcams/{project}/{sourceId} | GET | - | WebcamRequest |
| /webcams/{project}/{sourceId} | DELETE | - | UpdateResponse |
OpenAPI document¶
All methods and response models can be viewed in the Developer Portal. To generate an API client you can use the following URLs without user authentication but still with the Subscription Key in the Header (Ocp-Apim-Subscription-Key) or as Query Parameter (subscription-key=<your-surbscription-key>):
- hhttps://api.discover.swiss/info-update/v2/openapi/v2.json
- hhttps://api.discover.swiss/info-update/v2/openapi/v3.json