...
Description
Get detailed information for of a specified given groundwork.
Resource URL
Scope
gipod_pdo_read
Example(s)
A response sample is provided in Swagger
Panel | ||
---|---|---|
| ||
GET /api/v1/groundworks/{gipodId}/occurrences |
Description
Get the period occurence of a specific groundwork.
Resource URL
GET /api/v1/groundworks/{gipodId}/occurrences (Swagger)
Scope
gipod_pdo_read
Example(s)
TBD
Code Block | ||||
---|---|---|---|---|
| ||||
Code sample TBD
{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"property1": {},
"property2": {}
}
|
Panel | ||
---|---|---|
| ||
GET /api/v1/groundworks/{gipodId}/contactorganisations/{contactId} |
Description
Get contact information of a Groundwork for a given GIPOD ID and contact ID.
Resource URL
GET /api/v1/groundworks/{gipodId}/contactorganisations/{contactId}( Swagger)
Scope
gipod_pdo_read
Example(s)
TBD
Code Block | ||||
---|---|---|---|---|
| ||||
Code sample TBD
{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"property1": {},
"property2": {}
}
|
Panel | ||
---|---|---|
| ||
GET /api/v1/groundworks/{gipodId}/zones/{zoneId} |
Description
Get the zone details of a Groundwork for a given GIPOD ID and zone ID.
Resource URL
GET /api/v1/groundworks/{gipodId}/zones/{zoneId} (Swagger)
Scope
gipod_pdo_read
Example(s)
TBD
...
language | xml |
---|---|
theme | DJango |
...
...
Panel | ||||||
---|---|---|---|---|---|---|
| ||||||
PATCH /api/v1/groundworks/{gipodId} Anchor |
|
Description
Partial modification of a given groundwork. Supported modifications are indicated in the request sample.
Resource URL
PATCH /api/v1/groundworks/{gipodId} (Swagger)
Scope
gipod_pdo_write
Example(s)
Modify period and estimated duration in days of a groundwork.
...
Code Block | ||||
---|---|---|---|---|
| ||||
[ { "key": "Description", "value": "The new description of the groundwork." } ] |
...
Panel | ||
---|---|---|
| ||
DELETE/api/v1/groundworks/{gipodId} |
Description
Remove a given groundwork.
Resource URL
Scope
gipod_pdo_write
Example(s)
Request and response samples are provided in Swagger.
...
Panel | ||
---|---|---|
| ||
GET /api/v1/groundworks/{gipodId}/occurrences |
Description
Get the period occurrences of a given groundwork.
Resource URL
GET /api/v1/groundworks/{gipodId}/occurrences (Swagger)
Scope
gipod_pdo_read
Example(s)
Response samples are provided in Swagger.
...
Panel | ||
---|---|---|
| ||
GET /api/v1/groundworks/{gipodId}/contactorganisations/{contactId} |
Description
Get contact information of a Groundwork for a given GIPOD ID and contact ID.
Resource URL
GET /api/v1/groundworks/{gipodId}/contactorganisations/{contactId} (Swagger)
Scope
gipod_pdo_read
Example(s)
Response samples are provided in Swagger.
...
Panel | ||
---|---|---|
| ||
PUT /api/v1/groundworks/{gipodId}/contactorganisations/{contactId} |
Description
Modify the contact information of a specific contact organisation.
Resource URL
PUT /api/v1/groundworks/{gipodId}/contactorganisations/{contactId} (Swagger)
Scope
gipod_pdo_write
Example(s)
Request and response samples are provided in Swagger.
...
Panel | ||
---|---|---|
| ||
DELETE /api/v1/groundworks/{gipodId}/contactorganisations/{contactId} |
Description
Remove a given groundwork contact organisation.
Resource URL
Scope
gipod_pdo_write
Example(s)
Response samples are provided in Swagger.
...
Panel | ||
---|---|---|
| ||
GET /api/v1/groundworks/{gipodId}/zones/{zoneId} |
Description
Get detailed information of a given groundwork zone.
Resource URL
GET /api/v1/groundworks/{gipodId}/zones/{zoneId} (Swagger)
Scope
gipod_pdo_read
Example(s)
Response samples are provided in Swagger.
...
Panel | ||
---|---|---|
| ||
PUT /api/v1/groundworks/{gipodId}/zones/{zoneId} |
Description
Modify a given groundwork zone.
Resource URL
PUT /api/v1/groundworks/{gipodId}/zones/{zoneId} (Swagger)
Scope
gipod_pdo_write
Example(s)
Request and response samples are provided in Swagger.
...
Panel | ||
---|---|---|
| ||
GET /api/v1/groundworks/{gipodId}/attachments/{attachmentId} |
Description
Get a given attachment of a groundwork.
Resource URL
GET /api/v1/groundworks/{gipodId}/attachments/{attachmentId} (Swagger)
Scope
gipod_pdo_read
Example(s)
Response samples are provided in Swagger.
...
Panel | ||
---|---|---|
| ||
DELETE /api/v1/groundworks/{gipodId}/attachments/{attachmentId} |
Description
Remove a given groundwork attachment.
Resource URL
Scope
gipod_pdo_write
Example(s)
Response samples are provided in Swagger.
...
Panel | ||
---|---|---|
| ||
POST /api/v1/groundworks |
Description
Register a new groundwork.
Resource URL
Scope
gipod_pdo_write
Example(s)
Request and response samples are provided in Swagger.
...
Panel | ||
---|---|---|
| ||
POST /api/v1/groundworks/{gipodId}/contactorganisations |
Description
Add an extra contact organisation to a given groundwork.
Resource URL
Scope
gipod_pdo_write
Example(s)
Request and response samples are provided in Swagger.
...
Panel | ||
---|---|---|
| ||
POST /api/v1/groundworks/{gipodId}/attachments |
Description
Upload an attachment to a given groundwork.
Resource URL
Scope
gipod_pdo_write
Example(s)
Request and response samples are provided in Swagger.
...
Panel | ||||||
---|---|---|---|---|---|---|
| ||||||
POST /api/v1/groundworks Anchor |
|
Description
Register a new Groundwork.
Resource URL
Scope
gipod_pdo_write
Example
Register a category 1 groundwork of type "Electriciteit" that is planned from 01/07/2020 till 31/07/2020 with an estimated duration of 5 days
Code Block | ||||
---|---|---|---|---|
| ||||
{ "ownerId": "1c75e9cc-d222-4fa9-9649-4d87f381e470", "reference": "Reference of the groundwork", "description": "Description of the groundwork", "url": [ "https://vlaanderen.be/" ], "groundworkZone": "POLYGON((122980.5 183762,122973.5 183742.75,123007 183740.5,122980.5 183762))", "publicDomainOccupancyStatusId": "3232baa5-a157-4126-a2be-354ad1e480f7", // Voorontwerp "contactOrganisation": [ { "organisationId": null, // If not specified the contactorganisation will be the organisation that registered the groundwork "roleId": "aad5e947-f7bf-4592-a84a-f591555b0b8b", // Dossierbeheerder "website": "https://www.vlaanderen.be/", "lastName": "Foo", "firstName": "Bar", "telephone": "0481234567", "fax": "", "email": "foo.bar@vlaanderen.be", // email is required "address": null, "isPublic": false } ], "categoryId": "bb0b471a-7f4d-4eaa-b788-adae1aaf30f8", // Category 1 "publicDomainOccupancyTypeId": [ "a486a968-e498-4708-8820-901686f0712f" // Electriciteit ], "period": { "start": "2020-06-30T22:00:00Z", "end": "2020-07-31T22:00:00Z", "duration": null }, "isRelocationGroundwork": false, "causingGroundwork": [ ], "specificationTypeId": [ "57438692-f1e3-4010-a1c8-725f42b85f56", // HerAanleg "466a03a3-2327-4919-a672-e303b7c9040d" // Verkavelingswerk ], "estimatedDurationDays": 5 } |
Panel | ||
---|---|---|
| ||
PUT /api/v1/groundworks/{gipodId}/zones/{zoneId} |
Description
Modify a zone.
Resource URL
PUT /api/v1/groundworks/{gipodId}/zones/{zoneId} (Swagger link TBD)
Scope
gipod_pdo_write
Example(s)
TBD
Code Block | ||||
---|---|---|---|---|
| ||||
Code sample TBD
{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"property1": {},
"property2": {}
}
|
Panel | ||
---|---|---|
| ||
PUT /api/v1/groundworks/{gipodId}/contactorganisations/{contactId} |
Description
Modify the contact information of a specific contact organisation.
Resource URL
PUT /api/v1/groundworks/{gipodId}/contactorganisations/{contactId} (Swagger link TBD)
Scope
gipod_pdo_write
Example(s)
TBD
Code Block | ||||
---|---|---|---|---|
| ||||
Code sample TBD
{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"property1": {},
"property2": {}
} |
...