...

...

Description

Get details of a Groundwork for a given GIPOD IDdetailed information of a given groundwork.

Resource URL

Scope

gipod_pdo_read

Example(s)

A response sample is provided in Swagger

...

Description

Partial modification of a given groundwork. Supported modifications are indicated in the request sample.

Resource URL

GET PATCH /api/v1/groundworks/{gipodId} (Swagger)

Scopes

...

Scope

gipod_pdo_write

Example(s)

TBDModify period and estimated duration in days of a groundwork.

Code sample TBD[
{
	"key": "Period",
	"value": {
		"start": "2019-11-20T08:00:00Z",
		"typeend": "string"2019-12-20T08:00:00Z"
	}
},
{
 	"titlekey": "stringEstimatedDurationDays",
  	"statusvalue": 0,3
}
]
"detail

Modify period and status of a groundwork.

[
{
	"key": "stringPeriod",
	"value": {
		"instancestart": "string2019-11-20T08:00:00Z",
  "property1": {},
  "property2": {}
}

Description

Get the periods of a Groundwork for a given GIPOD ID.

Resource URL

GET /api/v1/groundworks/{gipodId}/occurrences (Swagger)

Scopes

TBD

Example(s)

TBD

		"end": "2019-12-20T08:00:00Z"
	}
},
{
	"key": "StatusId",
	"value": "3603C0B5778E4407AE577300E0694888" // Uitgevoerd
},
]

Modify only the period of a groundwork.

Code sample[
TBD
{
  	"typekey": "stringPeriod",
	"value": {
		"titlestart": "string2019-11-20T08:00:00Z",
		"end":  "status": 0,
  "detail"2019-12-20T08:00:00Z"
	}
}
]

Modify the description of a groundwork.

[
{
	"key": "stringDescription",
  	"instancevalue": "string",
  "property1": {},
  "property2": {}
}
The new description of the groundwork."
}
]

...

Description

Remove a given groundwork.

Resource URL

Scope

gipod_pdo_write

Example(s)

Request and response samples are provided in Swagger.

...

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.

...

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)

Scopes

...

Scope

gipod_pdo_read

Example(s

...

TBD

...

...

)

Response samples are provided in Swagger.

...

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.

...

Description

Remove a given groundwork contact organisation.

Resource URL

Scope

gipod_pdo_write

Example(s)

Response samples are provided in Swagger.

...

Description

Get the zone details detailed information of a Groundwork for a given GIPOD ID and zone IDgiven groundwork zone.

Resource URL

GET /api/v1/groundworks/{gipodId}/zones/{zoneId} (Swagger)

Scopes

...

Scope

gipod_pdo_read

Example(s)

TBD

Code sample TBD
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "property1": {},
  "property2": {}
}

...

...

Response samples are provided in Swagger.

...

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.

...

Description

...

Description

Get a given attachment of a groundwork are possible. Supported modifications are indicated in the request sample.

Resource URL

PATCH GET /api/v1/groundworks/{gipodId}/attachments/{attachmentId} (Swagger)

Scopes

...

Scope

gipod_pdo_read

Example(s)

...

TBD

...

...

Response samples are provided in Swagger.

...

Panel
bgColor #E27A7A
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.

...

Description

Register a new Groundworkgroundwork.

Resource URL

...

Scope

gipod_pdo

Examples

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

{
"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",
"address": {},
"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": 3
}

You want to register a Groundwork ...

Code sample TBD
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "property1": {},
  "property2": {}
}

You want to register a Groundwork ...

Code sample TBD
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "property1": {},
  "property2": {}
}

...

...

_write

Example(s)

Request and response samples are provided in Swagger.

...

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.

...

Description

Modify a zoneUpload an attachment to a given groundwork.

Resource URL

...

...

...

Scopes

...

Scope

gipod_pdo_write

Example(s)

TBD

...

...

Request and response samples are provided in Swagger.

...