...
Table of Contents | ||
---|---|---|
|
...
Panel | ||||||
---|---|---|---|---|---|---|
| ||||||
GET /api/v1/groundworks/{gipodId} Anchor |
|
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
...
language | xml |
---|---|
theme | DJango |
...
...
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
Code Block | ||||
---|---|---|---|---|
| ||||
Code sample TBD
{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"property1": {},
"property2": {}
}
|
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 | ||
---|---|---|
| ||
POST DELETE /api/v1/groundworks Anchor | | POSTGW | POSTGW
Description
Register Remove a new Groundworkgiven 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
...
language | xml |
---|---|
theme | DJango |
...
(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 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": {}
}
|
...
bgColor | #663a82 |
---|
...
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}/contactorganisationsattachments/{contactIdattachmentId} |
Description
Modify the contact information of a specific contact organisationRemove a given groundwork attachment.
Resource URL
...
...
...
...
Scope
gipod_pdo_write
Example(s)
TBD
...
language | xml |
---|---|
theme | DJango |
...
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.
...