{"openapi":"3.0.1","info":{"title":"Masterdata Core API","description":"Acrevis Masterdata Core API","version":"1.11.26"},"servers":[{"url":"https://masterdata-core.acrevison.ch","description":"Generated server url"}],"paths":{"/api/zip-cities":{"get":{"tags":["ZipCities"],"operationId":"getZipCities","parameters":[{"name":"filter","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ZipFilter"}},{"name":"cityLong","in":"query","required":false,"schema":{"type":"string"}},{"name":"orderProperty","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ZipCityOrderProperty"}},{"name":"orderType","in":"query","required":false,"schema":{"$ref":"#/components/schemas/OrderType"}},{"name":"zip","in":"query","required":false,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"comma seperated list of desired fields","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"zip city list","content":{"application/vnd.acrevis.tpl.v1+json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ZipCity"}}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ZipCity"}}}}},"404":{"description":"Not Found","content":{"application/vnd.acrevis.tpl.v1+json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}},"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/zip-cities/verify":{"get":{"tags":["ZipCities"],"operationId":"verifyZipCities","parameters":[{"name":"cityLong","in":"query","required":true,"schema":{"type":"string"}},{"name":"zip","in":"query","required":true,"schema":{"type":"string"}},{"name":"filter","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ZipFilter"}}],"responses":{"200":{"description":"Additionally to the parameter 'zip' the parameter 'cityLong' must be set.","content":{"application/vnd.acrevis.tpl.v1+json":{"schema":{"$ref":"#/components/schemas/BooleanResult"}},"application/json":{"schema":{"$ref":"#/components/schemas/BooleanResult"}}}}}}},"/api/employees":{"get":{"tags":["Employees"],"operationId":"getEmployees","parameters":[{"name":"abbreviation","in":"query","required":false,"schema":{"type":"string"}},{"name":"orderProperty","in":"query","required":false,"schema":{"$ref":"#/components/schemas/AdvisorOrderProperty"}},{"name":"orderType","in":"query","required":false,"schema":{"$ref":"#/components/schemas/OrderType"}},{"name":"query","in":"query","required":false,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"comma seperated list of desired fields","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"employee list","content":{"application/vnd.acrevis.tpl.v1+json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Employee"}}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Employee"}}}}},"404":{"description":"Not Found","content":{"application/vnd.acrevis.tpl.v1+json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}},"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"oauth2":[]}]}},"/api/countries":{"get":{"tags":["Countries"],"operationId":"getCountries","parameters":[{"name":"filter","in":"query","required":false,"schema":{"$ref":"#/components/schemas/CountriesFilter"}},{"name":"iso","in":"query","required":false,"schema":{"type":"string"}},{"name":"orderType","in":"query","required":false,"schema":{"$ref":"#/components/schemas/OrderType"}},{"name":"fields","in":"query","description":"comma seperated list of desired fields","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"country list","content":{"application/vnd.acrevis.tpl.v1+json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Country"}}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Country"}}}}},"404":{"description":"Not Found","content":{"application/vnd.acrevis.tpl.v1+json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}},"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/advisors":{"get":{"tags":["Advisors"],"operationId":"getAdvisors","parameters":[{"name":"number","in":"query","required":false,"schema":{"type":"string"}},{"name":"abbreviation","in":"query","required":false,"schema":{"type":"string"}},{"name":"orderProperty","in":"query","required":false,"schema":{"$ref":"#/components/schemas/AdvisorOrderProperty"}},{"name":"orderType","in":"query","required":false,"schema":{"$ref":"#/components/schemas/OrderType"}},{"name":"query","in":"query","required":false,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"comma seperated list of desired fields","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"advisor list","content":{"application/vnd.acrevis.tpl.v1+json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Advisor"}}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Advisor"}}}}},"404":{"description":"Not Found","content":{"application/vnd.acrevis.tpl.v1+json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}},"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"oauth2":[]}]}},"/api/advisors/{number}":{"get":{"tags":["Advisors"],"operationId":"getAdvisorByNumber","parameters":[{"name":"number","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"advisor details found","content":{"application/vnd.acrevis.tpl.v1+json":{"schema":{"$ref":"#/components/schemas/Advisor"}},"application/json":{"schema":{"$ref":"#/components/schemas/Advisor"}}}},"404":{"description":"Not Found","content":{"application/vnd.acrevis.tpl.v1+json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}},"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"oauth2":[]}]}}},"components":{"schemas":{"Advisor":{"type":"object","allOf":[{"$ref":"#/components/schemas/Employee"},{"type":"object","properties":{"number":{"type":"string"}}}]},"AdvisorOrderProperty":{"type":"string","default":"LAST_NAME","enum":["LAST_NAME","FIRST_NAME","CITY","FUNCTION"]},"BooleanResult":{"type":"object","properties":{"result":{"type":"boolean"}}},"Branch":{"type":"object","properties":{"name":{"type":"string"},"city":{"type":"string"},"street":{"type":"string"},"houseNumber":{"type":"string"},"zip":{"type":"integer","format":"int32"},"lastUpdated":{"type":"string","format":"date-time"}}},"CountriesFilter":{"type":"string","default":"DEFAULT","enum":["DEFAULT","NONE"]},"Country":{"type":"object","properties":{"chBfsId":{"type":"integer","format":"int32"},"chRecognized":{"type":"boolean"},"chRecognizedDate":{"type":"string","format":"date"},"continent":{"type":"string","enum":["Europa","Afrika","Amerika","Asien","Australien","Antarktis"]},"iso2":{"type":"string"},"iso3":{"type":"string"},"lastUpdated":{"type":"string","format":"date-time"},"metaData":{"type":"object"},"name":{"type":"string"},"nameLong":{"type":"string"},"unEntryDate":{"type":"string","format":"date"},"unId":{"type":"integer","format":"int32"},"unMember":{"type":"boolean"},"validFrom":{"type":"string","format":"date"},"version":{"type":"integer","format":"int32"}}},"Employee":{"type":"object","properties":{"abbreviation":{"type":"string"},"email":{"type":"string"},"firstName":{"type":"string"},"function":{"type":"string"},"lastName":{"type":"string"},"city":{"type":"string"},"phoneExternal":{"type":"string"},"photo":{"type":"string"},"photoMediaType":{"type":"string"},"branch":{"$ref":"#/components/schemas/Branch"}}},"ErrorResponse":{"required":["message","timestamp"],"type":"object","properties":{"timestamp":{"type":"string","format":"date-time"},"correlationId":{"type":"string","description":"uuid to trace the request"},"status":{"type":"integer","description":"http status code","format":"int32","example":404},"message":{"type":"string","description":"a meaningful description"}}},"OrderType":{"type":"string","default":"DEFAULT","enum":["BY_ID","DEFAULT","NATURAL","NATURAL_DUPLICATE_ORDERED"]},"ZipCity":{"type":"object","properties":{"cantonIso2":{"type":"string"},"languageAlternativeIso2":{"type":"string"},"languageIso2":{"type":"string"},"city":{"type":"string"},"cityLong":{"type":"string"},"postDeliveryPoint":{"type":"integer","format":"int32"},"postDeliveryPointZip":{"type":"integer","format":"int32"},"zipCityId":{"type":"integer","format":"int32"},"postZipOfficial":{"type":"boolean"},"postZipSupplementaryDigit":{"type":"string"},"postZipType":{"type":"string"},"postZipTypeDescription":{"type":"string"},"zip":{"type":"integer","format":"int32"},"zipBase":{"type":"integer","format":"int32"}}},"ZipCityOrderProperty":{"type":"string","default":"CITY","enum":["ZIP","CITY"]},"ZipFilter":{"type":"string","default":"DOMICILE_BUSINESS","enum":["DOMICILE_BUSINESS"]}},"securitySchemes":{"oauth2":{"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://anmeldung.acrevis.ch/auth/realms/acrevis/protocol/openid-connect/auth","tokenUrl":"https://anmeldung.acrevis.ch/auth/realms/acrevis/protocol/openid-connect/token","scopes":{"read":"","write":""}}}}}}}