Document toolboxDocument toolbox

Vanaf 9 december worden deze pagina's niet meer geüpdatet. De nieuwe en actuele cocreatiepagina's van GIPOD vind je nu op de Athumi Space.

Let op: deze pagina's worden op termijn uitgefaseerd. Pas ook je bookmarks aan die naar deze pagina’s doorverwijzen.

👉 Ga naar de nieuwe pagina's: https://athumi.atlassian.net/wiki/spaces/NGC/overview

Release Notes API Beta 0.5.0.0

Bug fixes


  • 05-05-2020: Register a groundwork with causingGroundworks was resulting in an Internal Server Error.

New Calls


Action

More information

 

Action

More information

 

Modify a work

https://private-api.gipod.beta-vlaanderen.be/api-documentation.html#operation/ModifyWork

Modify status, period, timeschedule , estimatedDurationDays, description, reference, urls, specification type and public domain occupancy type

Transfer the pilot of a trench synergy

https://private-api.gipod.beta-vlaanderen.be/api-documentation.html#operation/TransferPilot

It is possible to transfer the pilot of a trench synergy to another organisation that is a participant of the trench synergy.

Remove contact organisation for event

https://private-api.gipod.beta-vlaanderen.be/api-documentation.html#operation/RemoveGroundworkContactOrganisation

It is possible to remove contact organisations from a event

Remove contact organisation for work

https://private-api.gipod.beta-vlaanderen.be/api-documentation.html#operation/RemoveGroundworkContactOrganisation

It is possible to remove contact organisations from a work

Remove contact organisation for groundwork

https://private-api.gipod.beta-vlaanderen.be/api-documentation.html#operation/RemoveGroundworkContactOrganisation

It is possible to remove contact organisations from a groudwork

Add contact organisation for event

https://private-api.gipod.beta-vlaanderen.be/api-documentation.html#operation/AddGroundworkContactOrganisation

It is possible to add contact organisations to an event. The organisationIdrequest field is mandatory

Add contact organisation for work

https://private-api.gipod.beta-vlaanderen.be/api-documentation.html#operation/AddGroundworkContactOrganisation

It is possible to add contact organisations to a work. The organisationIdrequest field is mandatory

Add contact organisation for groundwork

https://private-api.gipod.beta-vlaanderen.be/api-documentation.html#operation/AddGroundworkContactOrganisation

It is possible to add contact organisations to a groundwork. The organisationIdrequest field is mandatory

Taxonomies

https://private-api.gipod.beta-vlaanderen.be/api-documentation.html#operation/GetGrbStatuses

It is possible to get the GRB statuses from the taxonomy api.

Add contact organisation for trench synergy

https://private-api.gipod.beta-vlaanderen.be/api-documentation.html#operation/AddGroundworkContactOrganisation

It is possible to add contact organisations to a trench synergy

Register a mobility hindrance

https://private-api.gipod.beta-vlaanderen.be/api-documentation.html#operation/RegisterMobilityHindrance

 

Modify a mobility hindrance

https://private-api.gipod.beta-vlaanderen.be/api-documentation.html#operation/ModifyMobilityHindrance

Modify description, time schedule and periods, zones

Changed Calls


Action

More information

Changes

Action

More information

Changes

Launch trench synergy request (ONLY CHANGED ON BETA ENVIRONMENT)

https://private-api.gipod.beta-vlaanderen.be/api/v1/groundworks/%7BgipodId%7D/trench-synergy-requests

-

https://private-api.gipod.beta-vlaanderen.be/api-documentation.html#operation/LaunchTrenchSynergyRequest

When on the BETA environment the deadlines for a launched groundwork will no longer be the same as production.
Deadline 1 : 15 days from the DAY the groundwork trench synergy request was launched. Changes (on BETA) to 4 hours from the EXACT TIME the groundwork trench synergy request was launched.
Deadline 2 : 45 days from the DAY the groundwork trench synergy request was launched. Changes (on BETA) to 24 hours from the EXACT TIME the groundwork trench synergy request was launched.

Register a groundwork

https://private-api.gipod.beta-vlaanderen.be/api-documentation.html#operation/RegisterGroundwork

  • A groundwork of category 2, 3 or urgent can now be registered with a geometry of type Point, Polygoon or MultiPolygoon.

  • Register a groundwork for an organisation within the organisational structure.

  • Rename property SpecificationTypeId to SpecificationId

  • A groundwork of category 2, 3 or urgent can now be registered by providing a addressId instead of providing a zone.

  • It is possible to register a groundwork with category urgent.

  • Additional validation on groundwork specification. Now you must specify a additional specification when choosing specification:
    herstel/onderhoud or (her)aanleg

  • Additional field for GRB diversion and as-built plan

  • OwnerId is required

  • There must be at least one Contact Information with the role “Dossierbeheerder”. There is no restriction anymore on the fact that the Contact Information has to be private.

Modify a groundwork

https://private-api.gipod.beta-vlaanderen.be/api-documentation.html#operation/ModifyGroundwork

  • A groundwork of category 2, 3 or urgent can now be modified to a geometry of type Point, Polygoon or MultiPolygoon.

  • Modify a groundwork of an organisation within the organisational structure.

  • Rename patch key SpecificationTypeIds to SpecificationIds

  • Additional validation on groundwork specification. Now you must specify a additional specification when choosing specification:
    herstel/onderhoud or (her)aanleg

  • Additional key for GRB diversion and as-built plan

  • There must be at least one Contact Information with the role “Dossierbeheerder”. There is no restriction anymore on the fact that the Contact Information has to be private.

Modify the zone of groundwork

https://private-api.gipod.beta-vlaanderen.be/api-documentation.html#operation/ModifyGroundworkZone

  • The zone of a groundwork of category 2 or 3 can now be modified to a geometry of type Point, Polygoon or MultiPolygoon.

  • Modify the zone of a groundwork of an organisation within the organisational structure.

Register a work

https://private-api.gipod.beta-vlaanderen.be/api-documentation.html#operation/RegisterWork

  • Register a work for an organisation within the organisational structure.

  • Rename property SpecificationTypeId to SpecificationId

  • There must be at least one Contact Information with the role “Dossierbeheerder”. There is no restriction anymore on the fact that the Contact Information has to be private.

Modify a work

https://private-api.gipod.beta-vlaanderen.be/api-documentation.html#operation/ModifyWork

  • Modify a work of an organisation within the organisational structure.

  • Rename patch key SpecificationTypeIds to SpecificationIds

  • There must be at least one Contact Information with the role “Dossierbeheerder”. There is no restriction anymore on the fact that the Contact Information has to be private.

Register an event

https://private-api.gipod.beta-vlaanderen.be/api-documentation.html#operation/RegisterEvent

  • Register an event for an organisation within the organisational structure.

  • There must be at least one Contact Information with the role “Dossierbeheerder”. There is no restriction anymore on the fact that the Contact Information has to be private.

Modify an event

https://private-api.gipod.beta-vlaanderen.be/api-documentation.html#operation/ModifyEvent

  • Modify an event of an organisation within the organisational structure.

  • There must be at least one Contact Information with the role “Dossierbeheerder”. There is no restriction anymore on the fact that the Contact Information has to be private.

Extend list public domain occupancy types

https://private-api.gipod.beta-vlaanderen.be/api-documentation.html#operation/GetPublicDomainOccupancyTypes

  • New item ‘Hoogtewerker’ added under ‘Werk > Bouwwerk’

  • New item ‘Reclame’ added under ‘Evenement’

  • New item ‘Uitstalling’ added under ‘Evenement’

Response of Groundwork detail

https://private-api.gipod.beta-vlaanderen.be/api-documentation.html#operation/GetGroundwork

  • The contactinformation in detail of a Groudwork was extended to include the Contactrole

  • Rename SpecificationType to Specification in response of Groundwork detail

  • Link to address registry is added

  • GRB field is returned

Response of Work detail

https://private-api.gipod.beta-vlaanderen.be/api-documentation.html#operation/GetWork

The contactinformation in detail of a Work was extended to include the Contactrole

  • Rename SpecificationType to Specification in response of work detail

Response of Event detail

https://private-api.gipod.beta-vlaanderen.be/api-documentation.html#operation/GetEvent

The contactinformation in detail of a Event was extended to include the Contactrole

Move & Extend list public domain occupancy specifications

https://private-api.gipod.beta-vlaanderen.be/api-documentation.html#operation/GetSpecificationTypess

  • Moved to endpoint /api/v1/taxonomies/public-domain-occupancy/specifications

  • Split specifications for Groundwork & Work into subtrees

  • Update list of values

Taxonomies

https://private-api.gipod.beta-vlaanderen.be/api-documentation.html#tag/Taxonomies

  • Main types: Grondwerk, Werk & Event are now used with the same value in different taxonomies. Making the selection of the desired subtree of a taxonomy more userfriendly.

Response of Trench Synergy

https://private-api.gipod.beta-vlaanderen.be/api-documentation.html#operation/GetTrenchSynergy

  • When creating a Trench Synergy the Trench Synergy zone is the union of all Groundwork Zones linked to the Trench Synergy at that moment.
    Future changes to the linked Groundworks will not affect this zone.

Search trench synergy requests

https://private-api.gipod.beta-vlaanderen.be/api-documentation.html#operation/SearchTrenchSynergyRequests

  • It is now possible to search trench synergy request by deadline1 and deadline2. New available search criteria:

    • deadline1.start 

    • deadline1.end

    • deadline2.start

    • deadline2.end  

Response of mobility hindrance detail

https://private-api.gipod.beta-vlaanderen.be/api-documentation.html#operation/GetMobilityHindrance

  • The following properties were added to the detail response:

    • consequenceOf

    • occurrence

  • The following properties were removed from the detail response:

    • location

    • refersToPublicDomainOccupancyZone

  • Effects are now a property of each zone element:

    • hasEffect

Modify trench synergy request additional information

https://private-api.gipod.beta-vlaanderen.be/api-documentation.html#operation/ModifyAdditionalInfoTrenchSynergyRequest

  • When trying to modify the additional information for a trench synergy request which is not active anymore, the response has the status code 403 (forbidden). Before it was 404(not found).

Removed Calls