Release Notes API Beta 0.7.0.0
General
Some changes are made to the Gipod OpenAPI document to be compatible with the OpenAPI specification.
New Calls
Action | More information |
|
---|---|---|
Generate period occurrences based on the provided time schedule | Retrieves all the period occurrences based on a time schedule | |
Upload a file attachment to a groundwork | 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 | Downloads an uploaded attachment for a groundwork | |
Download an attachment of a work | Downloads an uploaded attachment for a work | |
Download an attachment of an event | 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 | Returns all notification categories | |
Get a notification category by id | 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 | 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 |
---|---|---|
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 | 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 |
|
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 | Query string parameter “roadusercategoryid” removed | |
Get groundwork details BREAKING CHANGES | https://private-api.gipod.beta-vlaanderen.be/api-documentation.html#operation/GetGroundwork | Renamed properties:
Removed properties:
Extra Http Status Code:
|
Get trench synergy details BREAKING CHANGES | https://private-api.gipod.beta-vlaanderen.be/api-documentation.html#operation/GetTrenchSynergy | New properties:
Modified properties:
|
Get trench synergy request details BREAKING CHANGES | New properties:
Modified properties:
Removed properties:
| |
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:
|
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 |
| |
Search trench synergy requests BREAKING CHANGES |
| |
Register Groundwork | https://private-api.gipod.beta-vlaanderen.be/api-documentation.html#operation/RegisterGroundwork |
|
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
|
|
Removed Calls
Action | More information | Changed |
---|---|---|
Get taxonomies for road user categories | This call has been removed. This use case is covered by ConsequenceTypes | |
ClientCredentialGrantWithExplicitScopes |
|