{ "openapi": "3.0.0", "info": { "description": "\n\n\n# Authentifizierung / API-Key\nFür sämtliche Anfragen an die API muss ein API-Key als Request-Header mitgegeben werden. Der API-Key legt fest, welche Daten abgefragt werden dürfen.\n\nUm einen API-Key zu beantragen, wenden Sie sich bitte an:\nwebways ag \nTelefon 061 695 99 99 \nE-Mail: api@webways.ch \n\n# Versionierung\nDie API Versionierung entspricht dem [Semantic Versioning](https://semver.org/lang/de/).\nDie Angabe der Version im Request-Header ist zwingend. Hier muss die MAJOR Versionsnummer angegeben werden, also beispielsweise 1 für die Version 1.2.23\n# Changelog\nsiehe [Changelog](https://doku.spitex.sozialadmin.ch/rest-api/changelog)", "version": "1.7.0", "title": "spitex.sozialadmin.ch API", "contact": { "email": "api@webways.ch", "name": "API Support", "url": "https://spitex.sozialadmin.ch/apidocs" } }, "servers": [ { "url": "https://spitex.sozialadmin.ch/api", "description": "The main prod server" }, { "url": "https://dev.spitex.sozialadmin.ch/api", "description": "The dev server" } ], "tags": [ { "name": "organisations", "description": "Spitex Organisationen" }, { "name": "phonedirectory", "description": "Spitex Telefonverzeichnis" }, { "name": "comparis", "description": "Spitex Organisationen" } ], "paths": { "/organisations": { "parameters": [ { "$ref": "#/components/parameters/apikey" }, { "$ref": "#/components/parameters/version" }, { "$ref": "#/components/parameters/lang" }, { "name": "activity-postcode", "in": "header", "description": "Filtert auf die PLZ des Tätigkeitsgebietes. Dies erfolgt unscharf im Format __eingabe__*. Beispielsweise gibt eine Eingabe von 80 alle Organisationen mit einem Tätigkeitsgebiet zurück, dessn Postleitzahl mit 80 beginnt.", "required": false, "example": 405, "schema": { "pattern": "[0-9]{4}", "type": "integer" } }, { "name": "activity-city", "in": "header", "description": "Filtert auf den Ort des Tätigkeitsgebietes. Die Suche erfolgt grundsätzlich exakt/scharf. Es kann aber auch ein * als Wildcard Pattern verwendet werden um eine unscharfe Suche zu erzwingen.", "example": "*rich*", "required": false, "schema": { "type": "string" } }, { "name": "activity-searchterm", "in": "header", "description": "Filtert auf die PLZ und den Ort des Tätigkeitsgebietes. Der Suchbegriff muss entweder in der PLZ oder im Ort Vorkommen, beginnend mit dem Suchbegriff (z.B. 40 sucht nach 40%).", "example": "4056", "required": false, "schema": { "type": "string" } }, { "name": "searchterm", "in": "header", "description": "Sucht im Namen, der Zusatzbezeichnung, der Postleitzahl und Ort der Organisation", "required": false, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/per-page" }, { "$ref": "#/components/parameters/page" } ], "get": { "tags": [ "organisations" ], "operationId": "getOrganisation", "summary": "Gibt Spitex Organisationen zurück\n", "description": " ", "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OrganisationSimple" } } } } } }, "security": [ { "apiKey": [] } ] } }, "/organisations/{identitynumber}": { "parameters": [ { "$ref": "#/components/parameters/apikey" }, { "$ref": "#/components/parameters/version" }, { "name": "identitynumber", "in": "path", "description": "identitynumber der Spitex-Organisation", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/lang" } ], "get": { "tags": [ "organisations" ], "summary": "Gibt eine Spitex Organisation zurück\n", "description": "> ", "operationId": "getOrganisationSpitex", "responses": { "200": { "description": "successful operation", "headers": { "x-total": { "$ref": "#/components/headers/x-total" }, "x-total-pages": { "$ref": "#/components/headers/x-total-pages" }, "x-per-page": { "$ref": "#/components/headers/x-per-page" }, "x-page": { "$ref": "#/components/headers/x-page" }, "x-previous-page": { "$ref": "#/components/headers/x-previous-page" }, "x-next-page": { "$ref": "#/components/headers/x-next-page" } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Organisation" } } } } }, "400": { "description": "Invalid ID supplied," }, "404": { "description": "institution not found" } }, "security": [ { "apiKey": [] } ] } }, "/spitexag/palliative": { "parameters": [ { "$ref": "#/components/parameters/apikey" }, { "$ref": "#/components/parameters/version" }, { "$ref": "#/components/parameters/lang" }, { "name": "searchterm", "in": "header", "description": "PLZ oder Ortschaftsname", "required": false, "schema": { "type": "string" } } ], "get": { "tags": [ "organisations" ], "operationId": "getPalliative", "summary": "Gibt Palliativ-Zentren der Spitex AG resp. VAKA zurück\n", "description": " ", "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OrganisationSimplePalliative" } } } } }, "500": { "description": "Internal Error" } }, "security": [ { "apiKey": [] } ] } }, "/spitexag/palliative/{identitynumber}": { "parameters": [ { "$ref": "#/components/parameters/apikey" }, { "$ref": "#/components/parameters/version" }, { "name": "identitynumber", "in": "path", "description": "identitynumber der Spitex-Organisation", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/lang" } ], "get": { "tags": [ "organisations" ], "summary": "Gibt ein Palliativ-Zentrum der Spitex AG resp. VAKA zurück. Entspricht dem Endpunkt /organisations/{identitynumber}\n", "description": "> ", "operationId": "getPalliativeDetail", "responses": { "200": { "description": "successful operation", "headers": { "x-total": { "$ref": "#/components/headers/x-total" }, "x-total-pages": { "$ref": "#/components/headers/x-total-pages" }, "x-per-page": { "$ref": "#/components/headers/x-per-page" }, "x-page": { "$ref": "#/components/headers/x-page" }, "x-previous-page": { "$ref": "#/components/headers/x-previous-page" }, "x-next-page": { "$ref": "#/components/headers/x-next-page" } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Organisation" } } } } }, "400": { "description": "Invalid ID supplied," }, "404": { "description": "institution not found" } }, "security": [ { "apiKey": [] } ] } }, "/phonedirectory": { "parameters": [ { "$ref": "#/components/parameters/apikey" }, { "$ref": "#/components/parameters/version" }, { "name": "canton", "in": "header", "description": "Einschränkung auf Kanton", "example": "BS", "required": false, "schema": { "type": "string" } }, { "name": "mode", "in": "header", "description": "Modus (gültige oder ungültige zurückgeben) [valid|notvalid]", "example": "valid", "required": false, "schema": { "type": "string" } }, { "name": "sortorder", "in": "header", "description": "Sortierung nach PLZ, Ort oder Organisationsname [postcode|city]", "example": "city", "required": false, "schema": { "type": "string" } } ], "get": { "tags": [ "phonedirectory" ], "operationId": "getPhonedirectory", "summary": "Gibt das Telefonverzeichnis zurück (z.B. für den Excel-Export)\n", "description": " ", "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/phonedirectory" } } } } } }, "security": [ { "apiKey": [] } ] } }, "/phonedirectory/items": { "parameters": [ { "$ref": "#/components/parameters/apikey" }, { "$ref": "#/components/parameters/version" }, { "$ref": "#/components/parameters/lang" }, { "name": "canton", "in": "header", "description": "Einschränkung auf Kanton", "example": "BS", "required": false, "schema": { "type": "string" } }, { "name": "mode", "in": "header", "description": "Modus (gültige oder ungültige zurückgeben)", "example": "valid", "required": false, "schema": { "type": "string", "enum": [ "valid", "notvalid" ] } }, { "name": "sortorder", "in": "header", "description": "Sortierung nach PLZ oder Ort", "example": "city", "required": false, "schema": { "type": "string", "enum": [ "postcode", "city" ] } } ], "get": { "tags": [ "phonedirectory" ], "operationId": "getPhonedirectoryItems", "summary": "Gibt die Einträge für das UI im CMS zurück\n", "description": " ", "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/phonedirectoryItem" } } } } } }, "security": [ { "apiKey": [] } ] } }, "/phonedirectory/search": { "parameters": [ { "$ref": "#/components/parameters/apikey" }, { "$ref": "#/components/parameters/version" }, { "$ref": "#/components/parameters/lang" }, { "name": "canton", "in": "header", "description": "Einschränkung auf Kanton", "example": "BS", "required": false, "schema": { "type": "string" } }, { "name": "searchterm", "in": "header", "description": "Suchbegriff", "required": false, "schema": { "type": "string" } } ], "get": { "tags": [ "phonedirectory" ], "operationId": "getPhonedirectorySearch", "summary": "Suche auf Spitex-Organisationen (zur Auswahl/Zuordnung im Telefonverzeichnis)\n", "description": " ", "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/phonedirectorySearch" } } } } } }, "security": [ { "apiKey": [] } ] } }, "/phonedirectory/organisations": { "parameters": [ { "$ref": "#/components/parameters/apikey" }, { "$ref": "#/components/parameters/version" }, { "name": "ids", "in": "header", "description": "Liste von ClientIDs", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/lang" } ], "get": { "tags": [ "phonedirectory" ], "operationId": "getPhonedirectoryOrganisations", "summary": "Gibt die angeforderten Organisationen zurück\n", "description": " ", "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/phonedirectoryOrganisation" } } } } } }, "security": [ { "apiKey": [] } ] } }, "/phonedirectory/organisations/ids": { "parameters": [ { "$ref": "#/components/parameters/apikey" }, { "$ref": "#/components/parameters/version" } ], "get": { "tags": [ "phonedirectory" ], "operationId": "getPhonedirectoryOrganisationsIds", "summary": "Gibt alle Organisations-IDs zurück\n", "description": " ", "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string", "example": "6A34A6C5-763B-4FB1-91E9F29E678DAC80" } } } } } }, "security": [ { "apiKey": [] } ] } }, "/phonedirectory/organisations/{id}": { "parameters": [ { "$ref": "#/components/parameters/apikey" }, { "$ref": "#/components/parameters/version" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "put": { "tags": [ "phonedirectory" ], "operationId": "putPhonedirectoryOrganisationsId", "summary": "Aktualisiert die für das Swisscom-Verzeichnis genutzte Telefonnummer.\n", "description": "Übrige Properties der Organisation können über diesen Endpunkt nicht geändert werden.", "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "object" } } } } }, "security": [ { "apiKey": [] } ] } }, "/phonedirectory/postcodes/{postcode}": { "put": { "parameters": [ { "$ref": "#/components/parameters/apikey" }, { "$ref": "#/components/parameters/version" }, { "$ref": "#/components/parameters/lang" }, { "name": "postcode", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "ID der Spitex-Organisation", "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "6A34A6C5-763B-4FB1-91E9F29E678DAC80" } } } } } }, "tags": [ "phonedirectory" ], "operationId": "putPhonedirectoryPostcodes", "summary": "Weist einer PLZ die zuständige Spitex-Organisation zu\n", "description": "Weist einer PLZ die zuständige Spitex-Organisation zu", "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/phonedirectoryPostcodes" } } } } }, "security": [ { "apiKey": [] } ] }, "delete": { "parameters": [ { "$ref": "#/components/parameters/apikey" }, { "$ref": "#/components/parameters/version" }, { "name": "postcode", "in": "path", "required": true, "schema": { "type": "string" } } ], "tags": [ "phonedirectory" ], "operationId": "deletePhonedirectoryPostcodes", "summary": "Löscht die Relation einer Spitex-Organisation zu einer PLZ\n", "description": "Löscht die Relation einer Spitex-Organisation zu einer PLZ", "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "object" } } } } }, "security": [ { "apiKey": [] } ] } }, "/comparis/organisations": { "parameters": [ { "$ref": "#/components/parameters/apikey" }, { "$ref": "#/components/parameters/version" } ], "get": { "tags": [ "comparis" ], "operationId": "getComparisOrganisation", "summary": "Gibt Spitex Organisation für Comparis zurück\n", "description": " ", "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OrganisationComparisSimple" } } } } } }, "security": [ { "apiKey": [] } ] } }, "/comparis/organisations/{id}": { "parameters": [ { "$ref": "#/components/parameters/apikey" }, { "$ref": "#/components/parameters/version" } ], "get": { "tags": [ "comparis" ], "summary": "Gibt eine Spitex Organisation für Comparis zurück\n", "description": "> ", "operationId": "getOrganisationComparis", "parameters": [ { "name": "id", "in": "path", "description": "OPAN UID der Spitex-Organisation", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OrganisationComparis" } } } } }, "400": { "description": "Invalid ID supplied," }, "404": { "description": "organisation not found" } }, "security": [ { "apiKey": [] } ] } } }, "components": { "headers": { "x-per-page": { "description": "max records to return", "schema": { "type": "integer", "example": 25, "maximum": 100 } }, "x-total": { "description": "total records", "schema": { "type": "integer" }, "example": 57 }, "x-page": { "description": "current page", "schema": { "type": "integer" }, "example": 2 }, "x-previous-page": { "description": "previous page", "schema": { "type": "integer" }, "example": 1 }, "x-next-page": { "description": "next page", "schema": { "type": "integer" }, "example": 3 }, "x-total-pages": { "description": "total pages", "schema": { "type": "integer", "format": "int32" }, "example": 6 } }, "parameters": { "apikey": { "in": "header", "name": "apiKey", "required": true, "description": "Der API-Key, welcher Ihnen für den Zugriff auf die API bereitgestellt wurde.", "schema": { "type": "string" } }, "version": { "in": "header", "name": "version", "required": true, "description": "Welche API Version soll genutzt werden.", "schema": { "type": "integer", "format": "int64", "default": 1 } }, "lang": { "in": "header", "name": "lang", "required": false, "description": "In welcher Sprache soll das Ergebnis zurückgegeben werden. Derzeit sind [de|fr] möglich.", "schema": { "type": "string", "default": "de" } }, "per-page": { "in": "header", "name": "per-page", "required": false, "description": "How many results (per page) should be returned", "schema": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 100, "default": 20 } }, "page": { "in": "header", "name": "page", "required": false, "description": "Which page (for pagination) should be returned", "schema": { "type": "integer", "format": "int64", "default": 1 } } }, "securitySchemes": { "apiKey": { "type": "apiKey", "name": "api_key", "in": "header" } }, "schemas": { "Organisation": { "type": "object", "properties": { "identitynumber": { "type": "string", "example": "jQLzMhy", "readOnly": true }, "name": { "type": "string", "description": "Name der Organisation" }, "addition": { "type": "string", "description": "Namenszusatz der Organisation" }, "address": { "$ref": "#/components/schemas/address" }, "longitude": { "type": "string", "description": "Longitude (Google Maps)" }, "latitude": { "type": "string", "description": "Latitude (Google maps)" }, "phonebusiness": { "type": "string", "description": "Telefon Geschäft" }, "phonedirect": { "type": "string", "description": "Telefon direkt" }, "mobile": { "type": "string", "description": "Mobiltelefon" }, "fax": { "type": "string", "description": "Fax" }, "email": { "type": "string", "description": "E-Mail-Adress" }, "url": { "type": "string", "description": "URL / Homepage" }, "gln": { "type": "string", "description": "Global Location Number (frühere Bezeichnung EAN-Code)" }, "zsr": { "type": "string", "description": "Zahlstellenregister-Nummer" }, "showmap": { "type": "boolean", "description": "Google Map in der Detailansicht anzeigen (ja/nein)" }, "zoomlevel": { "type": "number", "description": "Zoom-Level Google Maps" }, "logo": { "type": "string", "description": "Logo File URL" }, "activityregions": { "type": "array", "description": "Array mit Tätigkeitsgebieten (sortiert nach Postleitzahl aufsteigend)", "readOnly": true, "items": { "$ref": "#/components/schemas/activityregion" } }, "businessopenintervals": { "type": "array", "description": "Array mit Öffnungszeiten", "readOnly": true, "items": { "$ref": "#/components/schemas/businessopenintervals" } }, "cards": { "type": "string", "description": "Bezug von Trauerkarten" }, "chair": { "type": "string", "description": "Leitung/Präsidium/Rechnungsstelle" }, "contacts": { "type": "array", "description": "Array mit Kontakten", "items": { "$ref": "#/components/schemas/contact" } }, "detailurl": { "type": "string", "description": "URL with further information on the organisation https://www.spitex-vor.ort.ch" }, "donationaccount": { "type": "string", "description": "Spendenkonto" }, "joboffers": { "type": "array", "description": "Array mit Stelleninseraten", "items": { "$ref": "#/components/schemas/joboffer" } }, "legalform": { "type": "string", "description": "Rechtsform/Trägerschaft" }, "membership": { "type": "string", "description": "Mitgliedschaft" }, "minimumperiodoftreatment": { "type": "string", "description": "Mindesteinsatzdauer" }, "professionremark": { "type": "string", "description": "Allgemeine Bemerkungen zu den Ausbildungsberufen" }, "professions": { "type": "array", "description": "Array mit Ausbildungsberufen", "items": { "$ref": "#/components/schemas/profession" } }, "ratespdf": { "type": "string", "description": "Tarife nicht-kassenpflichtiger Angebote (PDF-Datei)" }, "ratesremark": { "type": "string", "description": "Tarife nicht-kassenpflichtiger Angebote" }, "remark": { "type": "string", "description": "Bemerkungen" }, "services": { "type": "array", "description": "Array mit Dienstleistungen", "readOnly": true, "items": { "$ref": "#/components/schemas/service" } }, "serviceurl": { "type": "string", "description": "URL with further information on the services offered. Currently, data is only provided here for members of the Zurich Cantonal Association" } } }, "OrganisationComparis": { "type": "object", "properties": { "id": { "type": "string", "example": "1010000763000", "readOnly": true }, "identitynumber": { "type": "string", "example": "jQLzMhy", "readOnly": true }, "webwaysid": { "type": "string", "example": "jQLzMhy" }, "gln": { "type": "string", "description": "Globale Lokations-Nr. (GLN).", "example": "1234567891013", "readOnly": true }, "zsr": { "type": "string", "description": "ZSR Nummer", "example": "Y123456" }, "hin": { "type": "string", "description": "HIN (-Emailadresse).", "example": "" }, "comparisenabled": { "type": "boolean", "description": "Indicates if the organisation agrees to share data with Comparis." }, "ratingemail": { "type": "string", "description": "E-Mail für Comparis Bewertungen" }, "name": { "type": "string", "description": "Name der Organisation" }, "logo_de": { "type": "string", "description": "Logo File URL" }, "logo_fr": { "type": "string", "description": "Logo File URL" }, "minimumperiodoftreatment": { "type": "string", "description": "Mindesteinsatzdauer in Minuten. 0 für keine Mindesteinsatzdauer, leer wenn dazu keine Informationen vorliegen, ansonsten in Minuten", "example": "20" }, "address": { "$ref": "#/components/schemas/addressComparis" }, "businessopenintervals": { "type": "array", "description": "Array mit Öffnungszeiten", "readOnly": true, "items": { "$ref": "#/components/schemas/businessopenintervals" } }, "activityregions": { "type": "array", "description": "Array mit Tätigkeitsgebieten (sortiert nach Postleitzahl aufsteigend)", "readOnly": true, "items": { "$ref": "#/components/schemas/activityregionComparis" } }, "services": { "type": "array", "description": "Array mit Dienstleistungen", "readOnly": true, "items": { "$ref": "#/components/schemas/serviceComparis" } } } }, "OrganisationSimple": { "type": "object", "properties": { "identitynumber": { "type": "string", "example": "jQLzMhy", "readOnly": true }, "name": { "type": "string", "description": "Name der Organisation" }, "addition": { "type": "string", "description": "Zusatzbezeichnung der Organisation" }, "address": { "$ref": "#/components/schemas/address" }, "longitude": { "type": "string", "description": "Longitude (Google Maps)" }, "latitude": { "type": "string", "description": "Latitude (Google maps)" }, "phonebusiness": { "type": "string", "description": "Telefon Geschäft" }, "fax": { "type": "string", "description": "Fax" }, "email": { "type": "string", "description": "E-Mail-Adress" }, "hin": { "type": "string", "description": "HIN (-Emailadresse).", "example": "" }, "url": { "type": "string", "description": "URL / Homepage" }, "serviceurl": { "type": "string", "description": "URL with further information on the services offered. Currently, data is only provided here for members of the Zurich Cantonal Association" }, "detailurl": { "type": "string", "description": "URL with further information on the organisation https://www.spitex-vor.ort.ch" }, "logo": { "type": "string", "description": "Logo File URL" } } }, "OrganisationSimplePalliative": { "type": "object", "properties": { "identitynumber": { "type": "string", "example": "jQLzMhy", "readOnly": true }, "name": { "type": "string", "description": "Name der Organisation" }, "addition": { "type": "string", "description": "Zusatzbezeichnung der Organisation" }, "address": { "$ref": "#/components/schemas/address" }, "longitude": { "type": "string", "description": "Longitude (Google Maps)" }, "latitude": { "type": "string", "description": "Latitude (Google maps)" }, "phonebusiness": { "type": "string", "description": "Telefon Geschäft" }, "fax": { "type": "string", "description": "Fax" }, "email": { "type": "string", "description": "E-Mail-Adress" }, "hin": { "type": "string", "description": "HIN (-Emailadresse).", "example": "" }, "url": { "type": "string", "description": "URL / Homepage" }, "serviceurl": { "type": "string", "description": "URL with further information on the services offered. Currently, data is only provided here for members of the Zurich Cantonal Association" }, "detailurl": { "type": "string", "description": "URL with further information on the organisation https://www.spitex-vor.ort.ch" }, "logo": { "type": "string", "description": "Logo File URL" }, "communities": { "type": "array", "items": { "$ref": "#/components/schemas/communities" }, "description": "Gemäss Suchbegriff gefundene Gemeinden, für die das Palliativ-Zentrum zuständig ist" } } }, "communities": { "type": "object", "properties": { "postcode": { "type": "string", "example": "5316" }, "name": { "type": "string", "example": "Leuggern" } } }, "OrganisationComparisSimple": { "type": "object", "properties": { "id": { "type": "string", "example": "1010000763000", "readOnly": true }, "identitynumber": { "type": "string", "example": "jQLzMhy", "readOnly": true }, "webwaysid": { "type": "string", "example": "D2F0E5F6-BA93-4C24-A880D23C8849BDD0" }, "gln": { "type": "string", "description": "Globale Lokations-Nr. (GLN).", "example": "1234567891013", "readOnly": true }, "zsr": { "type": "string", "description": "ZSR Nummer", "example": "Y123456" }, "hin": { "type": "string", "description": "HIN (-Emailadresse).", "example": "" }, "comparisenabled": { "type": "boolean", "description": "Indicates if the organisation agrees to share data with Comparis." }, "ratingemail": { "type": "string", "description": "E-Mail für Comparis Bewertungen" }, "name": { "type": "string", "description": "Name der Organisation" }, "logo_de": { "type": "string", "description": "Logo File URL" }, "logo_fr": { "type": "string", "description": "Logo File URL" }, "minimumperiodoftreatment": { "type": "string", "description": "Mindesteinsatzdauer in Minuten. 0 für keine Mindesteinsatzdauer, leer wenn dazu keine Informationen vorliegen, ansonsten in Minuten", "example": "20" }, "lastupdatedaddress": { "type": "string", "description": "Datum der letzten Aktualisierung der Adresse im Format dd.mm.yyyy HH:mm", "example": "04.03.2011 09:03" }, "lastupdatedinformation": { "type": "string", "description": "Datum der letzten Aktualisierung der Basisdaten im Format dd.mm.yyyy HH:mm", "example": "04.03.2011 09:03" }, "address": { "$ref": "#/components/schemas/addressComparis" } } }, "activityregionComparis": { "type": "object", "description": "Tätigkeitsgebiet der Organisation (Entspricht intern dem CatchmentArea)", "properties": { "id": { "type": "string", "readOnly": true, "example": "55B07A2F-DD89-D414-848EBDEDDB49AA94" }, "zip": { "type": "string", "description": "Postleitzahl", "example": "1484" }, "location": { "type": "string", "description": "Stadt", "example": "Aumont" } } }, "activityregion": { "type": "object", "description": "Tätigkeitsgebiet der Organisation", "properties": { "postcode": { "type": "string", "description": "Postleitzahl", "example": "1484" }, "city": { "type": "string", "description": "Stadt", "example": "Aumont" } } }, "businessopenintervals": { "type": "object", "description": "Öffnungszeiten", "properties": { "day": { "type": "string", "description": "Wochentag", "example": "Mo", "readOnly": true }, "start": { "type": "string", "description": "Startzeit des Intervals im Format (HH:mm)", "example": "14:00" }, "end": { "type": "string", "description": "Enddzeit des Intervals im Format (HH:mm)", "example": "16:00" } } }, "serviceComparis": { "type": "object", "description": "", "properties": { "id": { "type": "integer", "readOnly": true, "example": 34 }, "webwaysid": { "type": "string", "readOnly": true, "example": "55B07A2F-DD89-D414-848EBDEDDB49AA94" }, "servicename": { "items": { "$ref": "#/components/schemas/servicenameComparis" } }, "remark": { "items": { "$ref": "#/components/schemas/remarkComparis" } } } }, "servicenameComparis": { "type": "object", "description": "", "properties": { "de": { "type": "string", "description": "Bezeichnung der Dienstleistung (deutsch)", "example": "Hauswirtschaft, Betreuung, Soziale Begleitung", "readOnly": true }, "fr": { "type": "string", "description": "Bezeichnung der Dienstleistung (französisch)", "example": "Aide au ménage, accompagnement, accompagnement social" } } }, "remarkComparis": { "type": "object", "description": "", "properties": { "de": { "type": "string", "description": "Anmerkung zur Dienstleistung (deutsch), kann HTML Tags enthalten", "example": "

Ab 2019 Teil der Spitex See/Lac

", "readOnly": true }, "fr": { "type": "string", "description": "Anmerkung zur Dienstleistung (französisch), kann HTML Tags enthalten", "example": "

Fait partie de Spitex See/Lac à partir de 2019

" } } }, "service": { "type": "object", "description": "", "properties": { "servicename": { "type": "string", "description": "Name der Dienstleistung", "example": "Autofahrdienst" }, "internal": { "type": "boolean", "description": "Dienstleistung wird von der Spitex intern erbracht", "example": true }, "external": { "type": "boolean", "description": "Dienstleistung wird von externen Partnern erbracht", "example": true }, "remark": { "$ref": "#/components/schemas/remark" } } }, "remark": { "type": "string", "description": "Anmerkung zur Dienstleistung (deutsch), kann HTML Tags enthalten", "example": "

Ab 2019 Teil der Spitex See/Lac

" }, "address": { "type": "object", "properties": { "address": { "type": "string", "description": "Strasse und Hausnummer", "example": "Schönenbüelstrasse 2731" }, "haspobox": { "type": "boolean", "description": "Hat die Organisation ein Postfach ?", "default": false }, "poboxnumber": { "type": "string", "description": "Postfach der Organisation", "example": "90" }, "postcode": { "type": "string", "description": "Postleitzahl" }, "city": { "type": "string", "description": "Stadt", "example": "Basel" }, "canton": { "type": "string", "description": "Kanton", "example": "BS" }, "country": { "type": "string", "description": "Land", "example": "Schweiz" } } }, "addressComparis": { "type": "object", "properties": { "address1": { "type": "string", "description": "Strasse und Hausnummer", "example": "Schönenbüelstrasse 2731" }, "haspobox": { "type": "boolean", "description": "Hat die Organisation ein Postfach ?", "default": false }, "poboxnumber": { "type": "string", "description": "Postfach der Organisation", "example": "90" }, "zip": { "type": "string", "description": "Postleitzahl" }, "location": { "type": "string", "description": "Stadt", "example": "Basel" }, "canton": { "type": "string", "description": "Kanton", "example": "BS" } } }, "profession": { "type": "object", "properties": { "available": { "type": "boolean", "description": "Lehrstellen/Praktika für diesen Beruf werden angeboten (ja/nein)" }, "name": { "type": "string", "description": "Berufsbezeichnung" } } }, "joboffer": { "type": "object", "properties": { "date": { "type": "string", "description": "Stellendatum" }, "url": { "type": "string", "description": "URL des Stellendetails" }, "title": { "type": "string", "description": "Stellentitel" } } }, "contact": { "type": "object", "properties": { "remark": { "type": "string" }, "lastname": { "type": "string" }, "mobile": { "type": "string" }, "fax": { "type": "string" }, "role": { "type": "string" }, "gender": { "type": "string" }, "firstname": { "type": "string" }, "phonebusiness": { "type": "string" }, "label": { "type": "string" }, "phonedirect": { "type": "string" }, "email": { "type": "string" } } }, "phonedirectory": { "type": "object", "properties": { "postcode": { "type": "string", "example": "4056" }, "city": { "type": "string", "example": "Basel" }, "phone": { "type": "string", "example": "0619998877" } } }, "phonedirectoryItem": { "type": "object", "properties": { "canton": { "type": "string", "example": "BS" }, "isvalid": { "type": "boolean", "example": true }, "cities": { "type": "array", "items": { "type": "string" } }, "fkaddress": { "type": "string", "example": "6A34A6C5-763B-4FB1-91E9F29E678DAC80" }, "invalid": { "type": "boolean", "example": false }, "city": { "type": "string", "example": "Basel" }, "phone": { "type": "string", "example": "0619998877" }, "label": { "type": "string", "example": "Musterfirma" }, "postcode": { "type": "string", "example": "9999" } } }, "phonedirectorySearch": { "type": "object", "properties": { "name": { "type": "string", "example": "Musterfirma" }, "id": { "type": "string", "example": "6A34A6C5-763B-4FB1-91E9F29E678DAC80" } } }, "phonedirectoryOrganisation": { "type": "object", "properties": { "phoneswisscombusinessnumber": { "type": "string", "example": "0619998877" }, "name": { "type": "string", "example": "Musterfirma" }, "id": { "type": "string", "example": "6A34A6C5-763B-4FB1-91E9F29E678DAC80" } } }, "phonedirectoryPostcodes": { "type": "object", "properties": { "isvalid": { "type": "boolean", "description": "Nummer ist gültig" }, "id": { "type": "string", "example": "6A34A6C5-763B-4FB1-91E9F29E678DAC80", "description": "Kunden-ID" }, "exists": { "type": "boolean", "description": "Existiert der Kunde?" }, "phone": { "type": "string", "description": "Telefonnummer", "example": "0619998877" }, "label": { "type": "string", "example": "Musterfirma", "description": "Kundenname" } } } } }, "x-tagGroups": [ { "name": "comparis", "tags": [ "comparis" ] }, { "name": "misc", "tags": [ "organisations" ] } ] }