The resource Groundworks has the following endpoints:

GET /api/v1/groundworks/{gipodId}

Description

Get details of a Groundwork for a given GIPOD ID.

Resource URL

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

Scope

gipod_pdo_read

Example(s)

TBD

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

GET /api/v1/groundworks/{gipodId}/occurrences

Description

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

Resource URL

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

Scope

gipod_pdo_read

Example(s)

TBD

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

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 sample TBD
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "property1": {},
  "property2": {}
}

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

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

PATCH /api/v1/groundworks/{gipodId}

Description

Partial modification of a groundwork.

Resource URL

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

Scope

gipod_pdo_write

Example(s)

Modify period and estimated duration in days of a groundwork.

[
{
	"key": "Period",
	"value": {
		"start": "2019-11-20T08:00:00Z",
		"end": "2019-12-20T08:00:00Z"
	}
},
{
	"key": "EstimatedDurationDays",
	"value": 3
}
]

Modify period and status of a groundwork.

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

Modify only the period of a groundwork.

[
{
	"key": "Period",
	"value": {
		"start": "2019-11-20T08:00:00Z",
		"end": "2019-12-20T08:00:00Z"
	}
}
]

Modify the description of a groundwork.

[
{
	"key": "Description",
	"value": "The new description of the groundwork."
}
]

POST /api/v1/groundworks

Description

Register a new Groundwork.

Resource URL

POST /api/v1/groundworks

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

{
	"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
}

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 sample TBD
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "property1": {},
  "property2": {}
}

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 sample TBD
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "property1": {},
  "property2": {}
}