{"openapi":"3.1.0","info":{"title":"Meldedaten API","description":"Die Meldedaten API","version":"1.0.0"},"servers":[{"url":"https:\/\/api.wirtschaftscompass.at\/residents","description":"Generated server url"}],"security":[{"compass-api-token":[]}],"tags":[{"name":"V1","description":"Meldedaten Version 1"}],"paths":{"\/v1\/excerpt":{"get":{"tags":["V1"],"summary":"Einen geb\u00fchrenpflichtigen ZMR\/ZPR-Auszug direkt aus dem Zentralen Melderegister (ZMR) oder bereits abgeholte Ausz\u00fcge geb\u00fchrenfrei erneut abfragen","description":"Die geb\u00fchrenpflichtige Abfrage eines Auszugs im Zentralen Melderegister (ZMR) der Republik \u00d6sterreich (FETCH_NEW). <br \/>Dar\u00fcber hinaus kann das \"Wirtschafts-Compass Archiv\" gepr\u00fcft werden, ob der betroffene Auszug bereits abgefragt wurde. Bei dieser Option k\u00f6nnen zus\u00e4tzliche Abfrageparameter angewendet werden:<br \/>- FETCH_IF_NOT_AVAILABLE: Neue Abfrage im ZMR bzw. ZPR, wenn kein Auszug im Archiv vorhanden ist.<br \/>- CACHE_ONLY: Dabei erfolgt die Abfrage nur aus dem Archiv.<br \/>- FETCH_NEW_IF_OUTDATED: Ist der im Archiv befindliche Auszug \u00e4lter als z.B. 7 Tage (frei w\u00e4hlbar), wird ein neuer Auszug abgeholt.<br \/>Als Ergebnis wird die [reference]-ID zur\u00fcckgeliefert. Mit dieser kann im n\u00e4chsten Schritt der Auszug \u00fcber die \"Archiv API\" abgerufen werden.<br \/>F\u00fcr eine Abfrage im ZMR ben\u00f6tigen Sie mindestens die Parameter: Nachname, Vorname und Geburtsdatum. Der Parameter \"Geburtsdatum\" kann durch Geburtsnamen bzw. Teile der Adresse (PLZ, Ort, Hausnummer, Zweitwohnsitz) ersetzt werden. Werden hingegen bereits abgeholte Ausz\u00fcge gesucht, so ist die Eingabe des Nachnamens und Vornamens ausreichend.<br \/>Ausz\u00fcge, die neu abgeholt werden, sind geb\u00fchrenpflichtig. Bereits archivierte Ausz\u00fcge, die erneut abgerufen werden, hingegen nicht.","operationId":"searchExcerpt","parameters":[{"name":"validity","in":"query","description":"G\u00fcltigkeit","required":false,"schema":{"type":"string","default":"CACHE_ONLY","enum":["FETCH_IF_NOT_AVAILABLE","CACHE_ONLY","FETCH_NEW_IF_OUTDATED","FETCH_NEW","FETCH_NEW_IF_CHANGED"]}},{"name":"valid-days","in":"query","description":"G\u00fcltigkeitsdauer in Tagen - Maximaler G\u00fcltigkeitszeitraum eines bestehenden Dokuments, wenn die ''Validity-Option'' FETCH_NEW_IF_OUTDATED verwendet wird","required":false,"schema":{"type":"integer","format":"int32","default":7}},{"name":"purpose","in":"query","description":"Der Abfragegrund gem\u00e4\u00df den Richtlinien des ZMR muss angegeben werden. Zul\u00e4ssig sind im Standard ''Bankzwecke'' (sofern es sich um diesen handelt) oder alternativ eigene Angaben zum Gesch\u00e4ftsfall Ihres Unternehmens.","required":false,"schema":{"type":"string","default":"Bankzwecke"}},{"name":"register","in":"query","description":"Auf ein bestimmtes Register einschr\u00e4nken (ZMR oder ZPR)","required":false,"schema":{"type":"string","default":"ZMR","enum":["ZMR","ZPR"]}},{"name":"last-name","in":"query","description":"Nachname","required":true,"schema":{"type":"string"}},{"name":"first-name","in":"query","description":"Vorname","required":true,"schema":{"type":"string"}},{"name":"maiden-name","in":"query","description":"Name vor erster Ehe (Geburtsname)","required":false,"schema":{"type":"string"}},{"name":"date-of-birth","in":"query","description":"Geburtsdatum (YYYY-MM-DD)","required":false,"schema":{"type":"string","format":"date"}},{"name":"citizenship","in":"query","description":"Staatsangeh\u00f6rigkeit","required":false,"schema":{"type":"string"}},{"name":"place-of-birth","in":"query","description":"Geburtsort","required":false,"schema":{"type":"string"}},{"name":"zip-code","in":"query","description":"Postleitzahl","required":false,"schema":{"type":"string"}},{"name":"city","in":"query","description":"Ort","required":false,"schema":{"type":"string"}},{"name":"street","in":"query","description":"Stra\u00dfe","required":false,"schema":{"type":"string"}},{"name":"street-number","in":"query","description":"Hausnummer","required":false,"schema":{"type":"string"}},{"name":"zmr-identifier","in":"query","description":"ZMR Zahl","required":false,"schema":{"type":"string"}}],"responses":{"400":{"description":"","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Failure"}}}},"500":{"description":"Internal Server Error","content":{"*\/*":{"schema":{"$ref":"#\/components\/schemas\/Failure"}}},"x-exception-class":["java.lang.Exception"]},"404":{"description":"","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Failure"}}}},"503":{"description":"Service Unavailable","content":{"*\/*":{"schema":{"$ref":"#\/components\/schemas\/Failure"}}},"x-exception-class":["at.compass.api.shared.exception.ExternalServiceException"]},"401":{"description":"","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Failure"}}}},"403":{"description":"","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Failure"}}}},"200":{"description":"OK","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Document"}},"application\/xml":{"schema":{"$ref":"#\/components\/schemas\/Document"}}}}}}},"\/v1\/excerpt\/{excerpt-reference}":{"get":{"tags":["V1"],"summary":"Strukturierte Daten eines bereits abgefragten ZMR-Auszugs (oder ZPR-Auszugs) abfragen","description":"Mit der [compassArchiveId], die das Ergebnis der Suche nach Nachname und Vorname (\/v1\/archive) liefert, k\u00f6nnen strukturierte Daten abgefragt werden.<br \/>\u00dcber den \"response content type\" kann zwischen XML oder JSON unterschieden werden. Mit der Option \"historic-information\" k\u00f6nnen historische Daten (sofern vorhanden) zus\u00e4tzlich abgefragt werden.","operationId":"structuredData","parameters":[{"name":"excerpt-reference","in":"path","description":"[compassArchiveId] eines spezifisches Datensatzes (\/v1\/archive)","required":true,"schema":{"type":"string"}},{"name":"consider-previous-excerpts","in":"query","description":"Bereits fr\u00fcher abgefragte Daten ausgeben (sofern vorhanden)","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"400":{"description":"Bad Request","content":{"*\/*":{"schema":{"$ref":"#\/components\/schemas\/Failure"}}},"x-exception-class":["at.compass.api.shared.exception.InvalidParameterException"]},"500":{"description":"Internal Server Error","content":{"*\/*":{"schema":{"$ref":"#\/components\/schemas\/Failure"}}},"x-exception-class":["java.lang.Exception"]},"404":{"description":"Not Found","content":{"*\/*":{"schema":{"$ref":"#\/components\/schemas\/Failure"}}},"x-exception-class":["at.compass.api.shared.exception.ExternalServiceNotFoundException"]},"503":{"description":"Service Unavailable","content":{"*\/*":{"schema":{"$ref":"#\/components\/schemas\/Failure"}}},"x-exception-class":["at.compass.api.shared.exception.ExternalServiceException"]},"401":{"description":"","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Failure"}}}},"403":{"description":"","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Failure"}}}},"200":{"description":"OK","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/StructuredResidentsExcerpt"}},"application\/xml":{"schema":{"$ref":"#\/components\/schemas\/StructuredResidentsExcerpt"}}}}}}},"\/health":{"get":{"tags":["X"],"summary":"","description":"","operationId":"getPing","responses":{"400":{"description":"Bad Request","content":{"*\/*":{"schema":{"$ref":"#\/components\/schemas\/Failure"}}},"x-exception-class":["at.compass.api.shared.exception.InvalidParameterException"]},"500":{"description":"Internal Server Error","content":{"*\/*":{"schema":{"$ref":"#\/components\/schemas\/Failure"}}},"x-exception-class":["java.lang.Exception"]},"404":{"description":"Not Found","content":{"*\/*":{"schema":{"$ref":"#\/components\/schemas\/Failure"}}},"x-exception-class":["at.compass.api.shared.exception.ExternalServiceNotFoundException"]},"503":{"description":"Service Unavailable","content":{"*\/*":{"schema":{"$ref":"#\/components\/schemas\/Failure"}}},"x-exception-class":["at.compass.api.shared.exception.ExternalServiceException"]},"401":{"description":"","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Failure"}}}},"403":{"description":"","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Failure"}}}},"200":{"description":"OK","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ResponseString"}}}}}}}},"components":{"schemas":{"Failure":{"properties":{"message":{"type":"string"},"stacktrace":{"type":"string"}},"required":["message","stacktrace"],"xml":{"name":"failure","namespace":"urn:compass:wico:api:1.0"}},"Api":{"type":"object","properties":{"domain":{"type":"string","description":""},"version":{"type":"string","description":""}},"required":["domain","version"],"xml":{"name":"api","namespace":"urn:compass:wico:api:1.0"}},"ChildDocument":{"type":"object","properties":{"reference":{"type":"string","description":""},"documentTitle":{"type":"string","description":""},"documentType":{"type":"string","description":""},"contentType":{"type":"string","description":""}},"required":["contentType","documentTitle","documentType","reference"]},"ChildDocuments":{"type":"object","properties":{"childDocument":{"type":"array","description":"","items":{"$ref":"#\/components\/schemas\/ChildDocument"}}}},"Document":{"type":"object","properties":{"meta":{"$ref":"#\/components\/schemas\/Meta","description":""},"data":{"$ref":"#\/components\/schemas\/DocumentDetails","description":""}},"required":["data","meta"],"xml":{"name":"document","namespace":"urn:compass:wico:api:1.0"}},"DocumentDetails":{"type":"object","properties":{"source":{"type":"string","description":"","enum":["ARCHIVE","BUSINESS_REGISTER","WIEREG_REGISTER","TRADE_REGISTER","ASSOCIATION_REGISTER","ZMR_REGISTER","ZPR_REGISTER","ZMR_AND_ZPR_REGISTER","LAND_REGISTER","IMMAZING"]},"notes":{"type":"string","description":""},"reference":{"type":"string","description":""},"documentTitle":{"type":"string","description":""},"documentType":{"type":"string","description":""},"contentType":{"type":"string","description":""},"childDocuments":{"$ref":"#\/components\/schemas\/ChildDocuments","description":""}},"required":["contentType","documentTitle","documentType","notes","reference","source"]},"Meta":{"type":"object","properties":{"api":{"$ref":"#\/components\/schemas\/Api","description":""},"user":{"$ref":"#\/components\/schemas\/User","description":""},"cost":{"type":"string","description":""},"lastUpdate":{"type":"string","description":""},"generationDate":{"type":"string","description":""}},"required":["api","cost","generationDate","lastUpdate","user"],"xml":{"name":"meta","namespace":"urn:compass:wico:api:1.0"}},"User":{"type":"object","properties":{"organisation":{"type":"string","description":""},"username":{"type":"string","description":""},"clientInfo":{"type":"string","description":""}},"required":["clientInfo","organisation","username"],"xml":{"name":"user","namespace":"urn:compass:wico:api:1.0"}},"AddressType":{"type":"object","properties":{"addressType":{"type":"string","description":"","xml":{"name":"address-type"}},"countryCode":{"$ref":"#\/components\/schemas\/CountryCodeType","description":"","xml":{"name":"country-code"}},"state":{"type":"string","description":""},"district":{"type":"string","description":""},"postalCode":{"type":"string","description":"","xml":{"name":"postal-code"}},"place":{"type":"string","description":""},"streetAddress":{"type":"string","description":"","xml":{"name":"street-address"}},"houseNumber":{"type":"string","description":"","xml":{"name":"house-number"}},"apartmentNumber":{"type":"string","description":"","xml":{"name":"apartment-number"}},"careOf":{"type":"string","description":"","xml":{"name":"care-of"}},"geoLocation":{"$ref":"#\/components\/schemas\/GeoLocationType","description":"","xml":{"name":"geo-location"}},"poBox":{"type":"string","description":"","xml":{"name":"po-box"}}}},"Birth":{"type":"object","properties":{"dateOfBirth":{"type":"string","description":""},"placeOfBirth":{"type":"string","description":""}},"required":["dateOfBirth","placeOfBirth"],"xml":{"name":"birth","namespace":"urn:compass:wico:api:1.0"}},"CountryCodeType":{"type":"object","properties":{"value":{"type":"string","description":""},"type":{"type":"string","description":"","enum":["ISO_3166_1_ALPHA_3"],"xml":{"attribute":true}}}},"Death":{"type":"object","properties":{"dateOfDeath":{"type":"string","description":""},"placeOfDeath":{"type":"string","description":""},"countryOfDeath":{"type":"string","description":""}},"required":["countryOfDeath","dateOfDeath","placeOfDeath"],"xml":{"name":"death","namespace":"urn:compass:wico:api:1.0"}},"Excerpt":{"type":"object","properties":{"reference":{"type":"string","description":""},"requestDate":{"type":"string","description":""},"source":{"type":"string","description":"","enum":["ARCHIVE","BUSINESS_REGISTER","WIEREG_REGISTER","TRADE_REGISTER","ASSOCIATION_REGISTER","ZMR_REGISTER","ZPR_REGISTER","ZMR_AND_ZPR_REGISTER","LAND_REGISTER","IMMAZING"]},"status":{"type":"string","description":"","enum":["CURRENT","HISTORIC"]},"address":{"$ref":"#\/components\/schemas\/AddressType","description":""},"additionalInformation":{"type":"string","description":""}},"required":["reference","requestDate","source","status"],"xml":{"name":"excerpt","namespace":"urn:compass:wico:api:1.0"}},"GeoLocationType":{"type":"object","properties":{"lat":{"type":"number","format":"double","description":""},"lon":{"type":"number","format":"double","description":""}}},"StructuredResidentsExcerpt":{"type":"object","properties":{"meta":{"$ref":"#\/components\/schemas\/Meta","description":""},"data":{"$ref":"#\/components\/schemas\/StructuredResidentsExcerptData","description":""}},"required":["data","meta"],"xml":{"name":"structuredResidentsExcerpt","namespace":"urn:compass:wico:api:1.0"}},"StructuredResidentsExcerptData":{"type":"object","properties":{"firstName":{"type":"string","description":""},"lastName":{"type":"string","description":""},"citizenship":{"type":"string","description":""},"birth":{"$ref":"#\/components\/schemas\/Birth","description":""},"death":{"$ref":"#\/components\/schemas\/Death","description":""},"excerpt":{"type":"array","description":"","items":{"$ref":"#\/components\/schemas\/Excerpt"}}},"required":["birth","citizenship","firstName","lastName"]},"ResponseString":{"type":"object","properties":{"status":{"type":"string","description":"","enum":["OK","ERROR"]},"message":{"type":"string","description":""},"data":{"type":"string","description":""}}}},"securitySchemes":{"compass-api-token":{"type":"apiKey","name":"Authorization","in":"header","scheme":"bearer","bearerFormat":"JWT"}}}}