Groundworks
The resource Groundworks has the following endpoints:
GET /api/v1/groundworks/{gipodId}
Description
Get detailed information of a given groundwork.
Resource URL
Scope
gipod_pdo_read
Example(s)
A response sample is provided in Swagger
PATCH /api/v1/groundworks/{gipodId}
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.
[ { "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." } ]
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.