...
| Table of Contents | ||
|---|---|---|
|
...
| Panel | ||||||
|---|---|---|---|---|---|---|
| ||||||
GET /api/v1/groundworks/{gipodId} Anchor |
|
Description
...
A response sample is provided in Swagger
...
| 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)
...
| Code Block | ||||
|---|---|---|---|---|
| ||||
[
{
"key": "Description",
"value": "The new description of the groundwork."
}
]
|
...
| Panel | ||
|---|---|---|
| ||
DELETE /api/v1/groundworks/{gipodId} |
Description
Remove a given groundwork.
...
Request and response samples are provided in Swagger.
...
| Panel | ||
|---|---|---|
| ||
GET /api/v1/groundworks/{gipodId}/occurrences |
Description
Get the period occurrences of a given groundwork.
...
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.
...
Response samples are provided in Swagger.
...
| Panel | ||
|---|---|---|
| ||
PUT /api/v1/groundworks/{gipodId}/contactorganisations/{contactId} |
Description
Modify the contact information of a specific contact organisation.
...
Request and response samples are provided in Swagger.
...
| Panel | ||
|---|---|---|
| ||
DELETE /api/v1/groundworks/{gipodId}/contactorganisations/{contactId} |
Description
Remove a given groundwork contact organisation.
...
Response samples are provided in Swagger.
...
| Panel | ||
|---|---|---|
| ||
GET /api/v1/groundworks/{gipodId}/zones/{zoneId} |
Description
Get detailed information of a given groundwork zone.
...
Response samples are provided in Swagger.
...
| Panel | ||
|---|---|---|
| ||
PUT /api/v1/groundworks/{gipodId}/zones/{zoneId} |
Description
Modify a given groundwork zone.
...
Request and response samples are provided in Swagger.
...
| Panel | ||
|---|---|---|
| ||
GET /api/v1/groundworks/{gipodId}/attachments/{attachmentId} |
Description
Get a given attachment of a groundwork.
...
Response samples are provided in Swagger.
...
| Panel | ||
|---|---|---|
| ||
DELETE /api/v1/groundworks/{gipodId}/attachments/{attachmentId} |
Description
Remove a given groundwork attachment.
...
Response samples are provided in Swagger.
...
| Panel | ||
|---|---|---|
| ||
POST /api/v1/groundworks |
Description
Register a new groundwork.
...
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.
...
Request and response samples are provided in Swagger.
...
| Panel | ||
|---|---|---|
| ||
POST /api/v1/groundworks/{gipodId}/attachments |
Description
Upload an attachment to a given groundwork.
...