Funk­ti­ons­um­fang

Der Web­ser­vice Regio­nal­struk­tur Adress­aus­wahl Post­ort ermit­telt für die Ein­ga­be einer Post­leit­zahl oder eines Teils alle pas­sen­den Post­leit­zahl-Ort-Kom­bi­na­tio­nen. Genau­so wer­den bei Ein­ga­be eines Orts­na­mens oder eines Teils davon die mög­li­chen Ergeb­nis­se zurück­ge­lie­fert. Auch die Kom­bi­na­ti­on bei­der (Teil-)Angaben ist mög­lich. Dabei kann die Anzahl der zurück­ge­ge­be­nen Ergeb­nis­se auf eine über­sicht­li­che Zahl an Mög­lich­kei­ten ein­ge­schränkt wer­den, die maxi­ma­le Anzahl der Rück­ga­be­wer­te beträgt 50.

Der Web­ser­vice Regio­nal­struk­tur Adress­aus­wahl Stra­ße ermit­telt bei der Über­ga­be von Post­leit­zahl und Ort alle dort vor­han­de­nen Stra­ßen­na­men. Wird ein Stra­ßen­na­me oder ein Teil davon mit über­ge­ben, wird die Rück­ga­be ent­spre­chend ein­ge­grenzt. Dabei kann auch hier die Anzahl der zurück­ge­ge­be­nen Ergeb­nis­se auf maxi­mal 50 ein­ge­schränkt werden. 

Durch Zuhil­fe­nah­me des Web­ser­vice Regio­nal­struk­tur Adress­va­li­die­rung bzw. Regio­nal­struk­tur Adress­va­li­die­rung Lis­te kann ein belie­bi­ger Adress­da­ten­be­stand vali­diert und gege­be­nen­falls berei­nigt wer­den. Für jede Ein­ga­be erfolgt eine Rück­mel­dung zum Validierungsstatus.

Alle Web­ser­vices die­ses Pakets kön­nen auch kom­bi­niert ange­spro­chen wer­den, um Nut­zern den größt­mög­li­chen Kom­fort bei der Adress­ein­ga­be zu bieten.

Ein­ga­be

Zur Ermitt­lung einer Kom­bi­na­ti­on aus ​„Post­leit­zahl“ und ​„Ort“ muss min­des­tens einer von bei­den Wer­ten an die Schnitt­stel­le des Web­ser­vice über­ge­ben wer­den. Auch die Anga­be bei­der Wer­te bzw. Tei­len davon ist mög­lich, so kann bei­spiels­wei­se die Ein­ga­be von ​„41 Hü“ zur Ermitt­lung von ​„41836 Hückel­ho­ven“ ver­wen­det wer­den. Optio­nal kann über den Para­me­ter ​„count“ die Anzahl der ermit­tel­ten Ergeb­nis­se wei­ter ein­ge­schränkt werden.

Sol­len die an einem Post­ort vor­han­de­nen Stra­ßen ermit­telt wer­den, müs­sen Anga­ben zu ​„Post­leit­zahl“ und ​„Ort“ an die Schnitt­stel­le des zwei­ten Web­ser­vice über­mit­telt wer­den. Die optio­na­le Anga­be eines Teils des Stra­ßen­na­mens schränkt die Aus­ga­be auf pas­sen­de Ergeb­nis­se ein. Auch hier kann über den Para­me­ter ​„count“ die Anzahl der ermit­tel­ten Ergeb­nis­se redu­ziert werden.

Aus­ga­be

Der Post­ort-Web­ser­vice lie­fert eine Lis­te pas­sen­der Post­leit­zahl-Ort-Kom­bi­na­tio­nen für die über­mit­tel­ten Infor­ma­tio­nen zu ​„Post­leit­zahl“ und/​oder ​„Ort“ zurück. Der Stra­ßen-Web­ser­vice über­trägt gül­ti­ge Stra­ßen­na­men zu einer über­tra­gen­den Kom­bi­na­ti­on aus ​„Post­leit­zahl“ und ​„Ort“ zurück, gege­be­nen­falls ein­ge­schränkt durch Anga­be eines Straßennamens(teils) als Such­text. Bei den Web­ser­vices zur Adress­va­li­die­rung erfolgt eine Rück­mel­dung, ob die Adres­se kor­rekt ist, kor­ri­giert wur­de oder kein ein­deu­ti­ges Ergeb­nis ermit­telt wer­den konnte.

Das Web­ser­vice­pa­ket wur­de nach dem RESTful-Para­dig­ma ent­wi­ckelt. Der Archi­tek­tur­stil REST (Repre­sen­ta­tio­nal Sta­te Trans­fer) ermög­licht eine platt­form­un­ab­hän­gi­ge Maschi­ne-zu-Maschi­ne-Kom­mu­ni­ka­ti­on. Es kom­men aus­schließ­lich stan­dar­di­sier­te HTTP-Metho­den zum Ein­satz, inner­halb derer Daten in unter­schied­li­chen For­ma­ten und Struk­tu­ren aus­ge­lie­fert wer­den können.

Zugangs­vor­aus­set­zun­gen