Document toolboxDocument toolbox

Release Notes API Beta 0.7.0.0

General


New Calls


Action

More information

 

Action

More information

 

Generate period occurrences based on the provided time schedule

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

Retrieves all the period occurrences based on a time schedule

Upload a file attachment to a groundwork

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

It is now possible to upload a PDF or JPG file and link it to an existing groundwork

Upload a file attachment to a work

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

It is now possible to upload a PDF or JPG file and link it to an existing work

Upload a file attachment to an event

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

It is now possible to upload a PDF or JPG file and link it to an existing event

Creating a signaling permit

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

It is now possible to create a signaling permit.

Modify a signaling permit

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

it is now possible to edit the applicant, reference, status, url and period of a signaling permit.

Get signaling permit details.

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

Returns the detail of a signaling permit in the form of a oslo response

Download an attachment of a groundwork

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

Downloads an uploaded attachment for a groundwork

Download an attachment of a work

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

Downloads an uploaded attachment for a work

Download an attachment of an event

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

Downloads an uploaded attachment for a event

Remove a groundwork

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

It is now possible to remove a groundwork

Get all notification categories

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

Returns all notification categories

Get a notification category by id

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

Returns the notification category for a given id

Get all notification types

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

Returns all available notification types

Get notification

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

Returns details of a given notification

Search notifications

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

Returns all notifications matching the provided criteria

Update notification

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

Update the status of a given notification.

Changed Calls


Action

More information

Changes

Action

More information

Changes

Get event period occurrences BREAKING CHANGES

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

It is now possible to sort the period occurrences by start and end time. The results are also paged.

Get work period occurrences BREAKING CHANGES

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

It is now possible to sort the period occurrences by start and end time. The results are also paged.

Get mobility hindrance occurrences BREAKING CHANGES

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

It is now possible to sort the period occurrences by start and end time. The results are also paged.

Modify a groundwork

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

  • It is now possible to change the address of a groundwork of category 2 or 3.

  • Causing groundworks are mandatory when the groundwork is a relocation groundwork.

Modify a work

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

Added support to modify the zone of a work. Use the “Constructionzone” patch key.

All POST, PUT and PATCH endpoints

A few examples:

The response message contains now an ETag Response header. This value is a long number representing the version of the created or modified resource.

All GET endpoints for reading the detail of a resource

A few examples:

When the If-Match request header is given, a check will be made to see whether the version of the resource has already been changed.

The value of the If-Match request header you send when reading a groundwork should be the long number returned in the ETag response header when that groundwork was created or last modified.

Search mobilityhindrances breaking changes

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

Query string parameter “roadusercategoryid” removed

Get groundwork details BREAKING CHANGES

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

Renamed properties:

  • periodWithDuration → period

Removed properties:

  • detour

  • locationDescription

Extra Http Status Code:

  • 410 Gone: The groundwork was deleted.

Get trench synergy details BREAKING CHANGES

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

New properties:

  • gipodId

  • groundworks: add gipodId of the groundwork to each participating groundwork

  • trenchSynergyRequest: trench synergy request from the trench synergy was created.

Modified properties:

  • zone

Get trench synergy request details BREAKING CHANGES

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

New properties:

  • trenchSynergy: the trench synergy that was created from the trench synergy request.

Modified properties:

  • zone

  • launchingGroundwork

  • answer.groundwork

Removed properties:

  • identifiers

All PATCH endpoints BREAKING CHANGES

A few examples:

The request contract was updated to a JSON Object with one field items which contains an array of key value pairs of the modifications .

Example:

{ "items": [ { "key": "StatusId", "value": "73b250b4-3902-4640-8b76-d3a579a1c83a" }, { "key": "TrenchSynergyZone", "value": "POLYGON((122980.5 183762,122973.5 183742.75,123007 183740.5,122980.5 183762))" } ] }

 

Get statuses

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

The statuses taxonomy endpoint now contains the possible notification statuses.

Update list public domain occupancy types for Work

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

  • Changes in public domain occupancy types for work:

    • New value ‘Riolering’

    • Rename value ‘verhuislift’ → '(verhuis)lift/levering'

Search trench synergy requests BREAKING CHANGES

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

  • Modified properties in HydraCollection member:

    • Property “gipodId” is mapped to the id of the trench synergy request instead of the groundwork id.

    • Property “trenchSynergyRequestId“ is removed from the response and replaced by “gipodId“.

    • Property “launchingGroundwork“ is added.

    • Property “owner” is renamed to “pilot”.

    • Property “launchDate” is renamed to “launchTime“.

  • Added query string parameter:

    • launchingGroundworkId: it’s possible to filter based on the id of the groundwork from which the trench synergy request was launched.

Register Groundwork

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

  • Causing groundworks are mandatory when the groundwork is a relocation groundwork.

Add contactorganisation

Modify contactinformation

Register and Modify ContactInformation

Register Work, Groundwork, Event and MobilityHindrance

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

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


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


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


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


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


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


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


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


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


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


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


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

  • Contact organisation role dossierbeheerder => OrganisationId required

  • All other Contact organisation roles => OrganisationId not required, organization name as free text is sufficient (you must always specify role-organization email) instead of passing organization via Id

  • If both OrganisationId and name of the organisation are given, a validation error is returned

Removed Calls


Action

More information

Changed

Action

More information

Changed

Get taxonomies for road user categories

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

This call has been removed. This use case is covered by ConsequenceTypes

ClientCredentialGrantWithExplicitScopes

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