Guide til SOAP-servicen i Plandata.dk.

Transkript

1 Guide til SOAP-servicen i Plandata.dk. Formål med servicen. Via SOAP-webservicen, kan man hente, oprette og redigere planer i Plandata.dk. Planernes data udveksles med servicen i GML-format. Værktøjer. Der kan benyttes værktøjer, som understøtter SOAP. Det kan være test-værktøjer som SoapUI, Postman eller diverse udviklingsværktøjer. Links til servicen. Forsiden. På forsiden er der links til WSDL-filer, XSD-skemaer og et link til en oversigt over planregler. Links til WSDL. Link til WSDL til webservicen Pdk2plusWs: Her er XML-beskrivelsen af webservicens interface. Webservicen Pdk2Ws udstilles for bagudkompatibilitet. Den bør ikke benyttes længere. Link til XSD er. Her er en oversigt over XSD er, som beskriver hvordan GML til de enkelte planer skal opbygges, når de gemmes via webservicen. Links til Javadoc. Her er dokumentation af webmetoder og deres parametre. Regler for SOAP. Her kan ses hvilke regler der skal overholdes for hver plantype, når de gemmes. Reglerne er beskrevet på feltniveau, og behøver ikke altid at blive overholdt for kladder.

2 Planers livsforløb. Status. Nogle planer kan følge et forløb, hvor de har forskellige statusser. Nogle af disse statusser kan have kladder: Statusser for en plantype med kladder: Kladde til forslag (KF), forslag (F), kladde til vedtaget (KV), vedtaget (V) og aflyst (A). I den GML som udveksles med webservicen angives status via datofelter som eksempelvis DATOFORSL, DATOVEDT, DATOGSTART, DATOGSLUT og DATOAFLYST. Hvis en plan kan være i kladde-tilstand, har GML en feltet PSTATUS. Feltet kan have værdien 1 eller 2. Hvis PSTATUS = 1 angiver det, at planen er i kladde-tilstand. Hvis PSTATUS = 2 er planen i den status, som er angivet via datofelterne. Versionering. Nogle plantyper har versionering på ændringer. Denne versionering er ikke synlig via SOAP-servicen. De tidligere versioner kan ikke hentes eller rettes via SOAP-servicen. Der kan kun rettes i den aktuelle version.

3 Eksempel på et forløb for en plan. I det følgende vises et eksempel på oprettelse af en lokalplan med et delområde og derefter forløbet fra status KF til A. Der skal oprettes planid til lokalplanen. Følgende XML benyttes. 1. <soapenv:envelope xmlns:soapenv=" xmlns:s er=" 2. <soapenv:header/> 3. <soapenv:body> 4. <ser:getnewfeatureid> 5.  6. <user>${#project#user}</user> 7.  8. <pwd>${#project#password}</pwd> 9. <featuretype>20</featuretype> 10. </ser:getnewfeatureid> 11. </soapenv:body> 12. </soapenv:envelope> Feltet featuretype er objektkoden for planen. Den kan findes på siden med planregler i tabellen tilhørende plantypen. Udfør kaldet til webservicen. Resultat. 1. <S:Envelope xmlns:s=" 2. <S:Body> 3. <ns2:getnewfeatureidresponse xmlns:ns2=" "> 4. <return><![cdata[<?xml version="1.0" encoding="iso "?> 5. <PlanSystemDK version="3.0.1" build="76" gistools_version="4.2 Build 67" method="ge tnewfeatureid( x, ****, 20 )"> 6. <getnewfeatureidresult featuretype="20"> 7. <id>x</id> 8. </getnewfeatureidresult> 9. </PlanSystemDK>]]></return> 10. </ns2:getnewfeatureidresponse> 11. </S:Body> 12. </S:Envelope> Kopier id fra resultatet til Notepad eller lignende. ${#Project#planidlokalplan} = id i det følgende. Opret planid til delområdet. Sæt featuretype=30 og udfør kaldet ovenfor igen, kopier id. {#Project#planidlokalplandelomraade} = id.

4 Oprettelse af lokalplan med et delområde i kladdetilstand. GML med data til planerne pakkes ind i et CDATA-tag i en XML, som følgende. 1. <soapenv:envelope xmlns:soapenv=" xmlns:s er=" 2. <soapenv:header/> 3. <soapenv:body> 4. <ser:savefeature> 5. <user>${#project#user}</user> 6. <pwd>${#project#password}</pwd> 7. <gml><![cdata[ GML HER ]]></gml> 8. </ser:savefeature> 9. </soapenv:body> 10. </soapenv:envelope> GML med en lokalplan og et delområde. Status kladde til forslag. 1. <pdk:plan 2. xmlns:pdk=" 3. xmlns:gml=" 4. xmlns:xlink=" 5. xmlns:xsi=" 6. xsi:schemalocation=" t:8080/pdkws/schemas3/pdk3/plandk3.xsd /PdkWs/schemas3/gml/feature.xsd /PdkWs/schemas3/gml/xlinks.xsd"> 7. <gml:boundedby> 8. <gml:box srsname='epsg:25832'> 9. <gml:coord> 10. <gml:x> </gml:x> 11. <gml:y> </gml:y> 12. </gml:coord> 13. <gml:coord> 14. <gml:x> </gml:x> 15. <gml:y> </gml:y> 16. </gml:coord> 17. </gml:box> 18. </gml:boundedby> 19. <gml:featuremember> 20. <pdk:lokalplan> 21. <pdk:planid>${#project#planidlokalplan}</pdk:planid> 22. <pdk:komnr>159</pdk:komnr> 23. <pdk:objektkode>20</pdk:objektkode> 24. <pdk:plantype>20.1</pdk:plantype> 25. <pdk:plannr>lp Test </pdk:PLANNR> 26. <pdk:plannavn>omsorgscentret Eggegaarden</pdk:PLANNAVN> 27. <pdk:anvgen>71</pdk:anvgen> 28. <pdk:datoforsl> </pdk:datoforsl> 29.  30.  31. <pdk:datoikraft> </pdk:datoikraft> 32. <pdk:datostart> </pdk:datostart> 33. <pdk:datoslut> </pdk:datoslut> 34. <pdk:doklink> pdf</pdk:DOKLINK> 35. <pdk:zone>1</pdk:zone> 36. <pdk:dataprod>kommunen</pdk:dataprod> 37. <pdk:digigrundl>uoplyst</pdk:digigrundl> 38. <pdk:vvmredeg>false</pdk:vvmredeg> 39. <pdk:sforhold>denne lokalplan har saerlige forhold</pdk:sforhold>

5 40. <pdk:minuds>1</pdk:minuds> 41. <pdk:datogstart> </pdk:datogstart> 42. <pdk:datogslut> </pdk:datogslut> 43. <pdk:pstatus>1</pdk:pstatus> 44. <pdk:sforaktuel>true</pdk:sforaktuel> 45. <pdk:anvtype> 46. <pdk:sbygomfag> 47. <pdk:anvspec>1140</pdk:anvspec> 48. <pdk:bygpct>30</pdk:bygpct> 49. <pdk:bygpcth>1</pdk:bygpcth> 50. <pdk:bygpctar>45</pdk:bygpctar> 51. </pdk:sbygomfag> 52. <pdk:sbygomfag> 53. <pdk:anvspec>1120</pdk:anvspec> 54. <pdk:bygpct>43</pdk:bygpct> 55. <pdk:bygpcth>1</pdk:bygpcth> 56. <pdk:eareal>3322</pdk:eareal> 57. <pdk:earealh>1</pdk:earealh> 58. <pdk:m3_m2>222</pdk:m3_m2> 59. <pdk:m3_m2h>3</pdk:m3_m2h> 60. <pdk:maxbhjd>323</pdk:maxbhjd> 61. <pdk:maxetage>11</pdk:maxetage> 62. </pdk:sbygomfag> 63. </pdk:anvtype> 64. <gml:multipolygonproperty> 65. <gml:multipolygon srsname="epsg:25832"> 66. <gml:polygonmember> 67. <gml:polygon> 68. <gml:outerboundaryis> 69. <gml:linearring> 70. <gml:coordinates> , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , </gml:coordinates > 80. </gml:linearring> 81. </gml:outerboundaryis> 82. </gml:polygon> 83. </gml:polygonmember> 84. </gml:multipolygon> 85. </gml:multipolygonproperty> 86. </pdk:lokalplan> 87. </gml:featuremember> <gml:featuremember> 90. <pdk:lokalplandel> 91. <pdk:planid>${#project#planidlokalplandelomraade}</pdk:planid> 92. <pdk:delnr>1222</pdk:delnr> 93. <pdk:objektkode>30</pdk:objektkode> 94. <pdk:lokplan_id>${#project#planidlokalplan}</pdk:lokplan_id> 95. <pdk:plantype>30.1</pdk:plantype>

6 96. <pdk:anvgen>11</pdk:anvgen> 97. <pdk:anvspec>1110</pdk:anvspec> 98. <pdk:zone>1</pdk:zone> 99. <pdk:anvkonkret>1</pdk:anvkonkret> 100. <pdk:datoforsl> </pdk:datoforsl> 101.  102. <pdk:maxetager>1.0</pdk:maxetager> 103. <pdk:minuds>1</pdk:minuds> 104. <pdk:datogstart> </pdk:datogstart> 105. <pdk:pstatus>1</pdk:pstatus> 106. <pdk:sforaktuel>false</pdk:sforaktuel> 107. <pdk:anvtype> 108. <pdk:sbygomfag> 109. <pdk:anvspec>1140</pdk:anvspec> 110. <pdk:bygpctar>58</pdk:bygpctar> 111. </pdk:sbygomfag> 112. <pdk:sbygomfag> 113. <pdk:anvspec>1120</pdk:anvspec> 114. <pdk:eareal>3322</pdk:eareal> 115. <pdk:earealh>1</pdk:earealh> 116. </pdk:sbygomfag> 117. </pdk:anvtype> 118. <gml:multipolygonproperty> 119. <gml:multipolygon srsname="epsg:25832"> 120. <gml:polygonmember> 121. <gml:polygon> 122. <gml:outerboundaryis> 123. <gml:linearring> 124. <gml:coordinates> , , , , , , </gml:coordinates> 126. </gml:linearring> 127. </gml:outerboundaryis> 128. </gml:polygon> 129. </gml:polygonmember> 130. </gml:multipolygon> 131. </gml:multipolygonproperty> 132. </pdk:lokalplandel> 133. </gml:featuremember> 134. </pdk:plan> Kaldet udføres. I resultatet ses, at tilstatus=kladde for både lokalplanen og delområdet. Når planen er i status kladde, er det muligt at oprette planen uden, at der foretages validering af en række felter.

7 Statusskifte. Når der skiftes status, må kun hoveplanen være med i kaldet, som følgende: 1. <pdk:plan 2. xmlns:pdk=" 3. xmlns:gml=" 4. xmlns:xlink=" 5. xmlns:xsi=" 6. xsi:schemalocation=" t:8080/pdkws/schemas3/pdk3/plandk3.xsd /PdkWs/schemas3/gml/feature.xsd /PdkWs/schemas3/gml/xlinks.xsd"> 7. <gml:boundedby> 8. <gml:box srsname='epsg:25832'> 9. <gml:coord> 10. <gml:x> </gml:x> 11. <gml:y> </gml:y> 12. </gml:coord> 13. <gml:coord> 14. <gml:x> </gml:x> 15. <gml:y> </gml:y> 16. </gml:coord> 17. </gml:box> 18. </gml:boundedby> 19. <gml:featuremember> 20. <pdk:lokalplan> 21. <pdk:planid>${#project#planidlokalplan}</pdk:planid> 22. <pdk:komnr>159</pdk:komnr> 23. <pdk:objektkode>20</pdk:objektkode> 24. <pdk:plantype>20.1</pdk:plantype> 25. <pdk:plannr>lp Test </pdk:PLANNR> 26. <pdk:plannavn>omsorgscentret Eggegaarden</pdk:PLANNAVN> 27. <pdk:anvgen>71</pdk:anvgen> 28. <pdk:datoforsl> </pdk:datoforsl> 29.  30.  31. <pdk:datoikraft> </pdk:datoikraft> 32. <pdk:datostart> </pdk:datostart> 33. <pdk:datoslut> </pdk:datoslut> 34. <pdk:doklink> pdf</pdk:DOKLINK> 35. <pdk:zone>1</pdk:zone> 36. <pdk:dataprod>kommunen</pdk:dataprod> 37. <pdk:digigrundl>uoplyst</pdk:digigrundl> 38. <pdk:vvmredeg>false</pdk:vvmredeg> 39. <pdk:sforhold>denne lokalplan har saerlige forhold</pdk:sforhold> 40. <pdk:minuds>1</pdk:minuds> 41. <pdk:datogstart> </pdk:datogstart> 42. <pdk:datogslut> </pdk:datogslut> 43. <pdk:pstatus>2</pdk:pstatus> 44. <pdk:sforaktuel>true</pdk:sforaktuel> 45. <pdk:anvtype> 46. <pdk:sbygomfag> 47. <pdk:anvspec>1140</pdk:anvspec> 48. <pdk:bygpct>30</pdk:bygpct> 49. <pdk:bygpcth>1</pdk:bygpcth> 50. <pdk:bygpctar>45</pdk:bygpctar> 51. </pdk:sbygomfag> 52. <pdk:sbygomfag> 53. <pdk:anvspec>1120</pdk:anvspec> 54. <pdk:bygpct>43</pdk:bygpct> 55. <pdk:bygpcth>1</pdk:bygpcth> 56. <pdk:eareal>3322</pdk:eareal> 57. <pdk:earealh>1</pdk:earealh> 58. <pdk:m3_m2>222</pdk:m3_m2>

8 59. <pdk:m3_m2h>3</pdk:m3_m2h> 60. <pdk:maxbhjd>323</pdk:maxbhjd> 61. <pdk:maxetage>11</pdk:maxetage> 62. </pdk:sbygomfag> 63. </pdk:anvtype> 64. <gml:multipolygonproperty> 65. <gml:multipolygon srsname="epsg:25832"> 66. <gml:polygonmember> 67. <gml:polygon> 68. <gml:outerboundaryis> 69. <gml:linearring> 70. <gml:coordinates> , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , </gml:coordinates > 80. </gml:linearring> 81. </gml:outerboundaryis> 82. </gml:polygon> 83. </gml:polygonmember> 84. </gml:multipolygon> 85. </gml:multipolygonproperty> 86. </pdk:lokalplan> 87. </gml:featuremember> </pdk:plan> Her er delområdet klippet ud og PSTATUS er sat til 2. Status forslag. Kør ovenstående kald. Eventuelle fejl i datoerne rettes. Når kaldet returnerer med status ok har planen og delområdet skiftet status til forslag (F). Status kladde til vedtaget. Sæt PSTATUS til 1 og sæt DATOVEDT til i dag eller i fremtiden. Udfør kaldet. Der skiftes til status kladde til vedtaget (KV). Status vedtaget. Sæt PSTATUS=2. Udfør kaldet og ret eventuelle datofejl. Når kaldet er succesfuldt, er der skiftet til status vedtaget (V).