Document toolboxDocument toolbox

Workaround: instellen samenwerkingszone via Swagger

Owned by oliver.may
Last updated: 29 May, 2020 by Naomi Oste
4 min read

Workaround om de samenwerkingszone (nodig voor het synergie-proces) te creëren in de nieuwe GIPOD BETA via Swagger

(wanneer deze functionaliteit in de GUI beschikbaar is, is deze procedure uiteraard niet meer nodig – rechtstreeks via API kan nu al)

Om een samenwerkingszone in te stellen via Swagger zijn er 2 dingen nodig:

  • de WKT van de gewenste zone

  • het organisatieID

1: Exporteer zone als WKT uit OUDE GIPOD BETA

 Je kan hiervoor de huidige synergie-interessezone van je eigen organisatie nemen (evt. nadat je deze eerst nog aangepast en bewaard hebt). Dit lukt enkel met de rol “applicatiebeheerder”.

  • Log in op beta.gipod.vlaanderen.be met een account die de rol applicatiebeheerder heeft, of vraag aan severien.dhoker@vlaanderen.be om deze rol toe te kennen in BETA aan je account. (Dit zal ook ineens geldig zijn voor de NIEUWE GIPOD BETA).

  • Ga naar je organisatie-instellingen, tabblad synergie, en exporteer de zone (kies WKT)

  • Check formaat WKT. Een geëxporteerde WKT (openen in kladblok bijv.) ziet er zo uit:

GEOMETRYCOLLECTION(POLYGON((83451.808000004 189226.7815,86075.808000004 190314.7815,86811.808000004 188266.7815,83643.808000004 187882.7815,83451.808000004 189226.7815)))

  • Je hebt enkel het vette stuk vanaf POLYGON nodig -- let erop dat je het laatste haakje niet mee kopieert!

2: Samenwerkingzone aanmaken in NIEUWE GIPOD BETA

a)     Hiervoor moeten we eerst inloggen (kan al via GUI) en zorgen voor accestoken om te kunnen authoriseren op Swagger.

 

 

  • Vul de Bearer (apiKey) in :

    • Type “Bearer” + spatie

    • Plak je acces_token die je zonet kopieerde

  • Klik op Authorize

  • Authorized! Je kan nu de swagger endpoints gebruiken als ingelogde user. Je mag de pop-up sluiten.

 b)     Nu kunnen we de samenwerkingszone aanmaken of wijzigen (= zone waarbinnen je SSA wil ontvangen) in de nieuwe BETA

  • Nagiveer naar sectie “Organisations”

  • Vraag het organisatieID op van de organisatie waarmee je ingelogd bent

    • Klik op GET: /api/v1/organisations/current

    • Klik rechts op Try it out

    • Klik daarna op Execute

    • In de response die verschijnt zie je het organisationID van de organisatie waarmee je ingelogd bent – kopieer dit ID:

       

  • [MOMENTEEL NOG NIET MOGELIJK - bug is gelogd] Als je een samenwerkingszone wil instellen voor een suborganisatie, kan je de ID daarvan opvragen via:

    • Klik op GET: /api/v1/organisations/{organisationId}/hierarchy 

    • Klik rechts op Try it out

    • Vul het OrganisationID dat je kopieerde in

    • Klik daarna op Execute

    • In de response die verschijnt zie je de suborganisaties en hun organisatieID’s. Kopieer het  gewenste ID

  • De samenwerkingszone aanmaken of wijzigen gaat als volgt:

    • Klik op PUT: /api/v1/organisations/{organisationId}/collaborationzone  

    • Klik rechts op Try it out

    • Vul het OrganisationID in van de (sub)organisatie waarvoor je de zone wil instellen [MOMENTEEL ENKEL MOGELIJK VOOR DE ORG WAARMEE JE INGELOGD BENT]

    • Plak de WKT uit stap 1 in de request body (tussen de aanhalingstekens): 

       

    • Klik daarna op Execute

    • De samenwerkingszone is aangemaakt als je dit te zien krijgt:

       

Voorgedefiniëerde zones (ter info)

 We hebben zelf voor 3 organisaties in de nieuwe BETA de samenwerkingszone al gedefinieerd:

  • Blauw: volledig Vlaanderen

POLYGON((77629.333007813 235957.33398438,13629.333007813 200629.33398438,30013.333007813 153269.33398438,50237.333007813 153781.33398438,57917.333007813 159669.33398438,77373.333007813 153269.33398438,112957.33300781 156085.33398438,124989.33300781 148149.33398438,184381.33300781 159413.33398438,210237.33300781 150197.33398438,263485.33300781 155573.33398438,261181.33300781 163253.33398438,245565.33300781 168629.33398438,260413.33300781 207541.33398438,241469.33300781 214197.33398438,230973.33300781 224181.33398438,216637.33300781 222133.33398438,208957.33300781 227509.33398438,205629.33300781 235445.33398438,200765.33300781 244661.33398438,188221.33300781 240821.33398438,179773.33300781 247733.33398438,169277.33300781 239285.33398438,159293.33300781 244917.33398438,129597.33300781 225461.33398438,116797.33300781 217013.33398438,93501.333007813 224437.33398438,87357.333007813 218037.33398438,82493.333007813 221877.33398438,84797.333007813 228021.33398438,77629.333007813 235957.33398438))

  • Groen: linkerhelft Vlaanderen

POLYGON((19517.333007813 203360,69693.333007813 233824,132157.33300781 222560,160829.33300781 146016,23613.333007813 156000,23869.333007813 156000,19517.333007813 203360))

  • Oranje: rechterhelft Vlaanderen

POLYGON((129853.33300781 228960,155709.33300781 147296,240189.33300781 153440,261949.33300781 154976,254525.33300781 220000,194109.33300781 245088,148541.33300781 245344,129853.33300781 228960))