...
Table of Contents | ||
---|---|---|
|
...
Panel | ||||||
---|---|---|---|---|---|---|
| ||||||
GET /api/v1/groundworks/{gipodId} Anchor |
|
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
...
Panel | ||||||
---|---|---|---|---|---|---|
| ||||||
PATCH /api/v1/groundworks/{gipodId} Anchor |
|
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 Block | ||||
---|---|---|---|---|
| ||||
Code sample TBD[ { "key": "Period", "value": { "start": "2019-11-20T08:00:00Z", "typeend": "string"2019-12-20T08:00:00Z" } }, { "titlekey": "stringEstimatedDurationDays", "statusvalue": 0, "detail 3 } ] |
Modify period and status of a groundwork.
Code Block | ||||
---|---|---|---|---|
| ||||
[ { "key": "stringPeriod", "value": { "instancestart": "string2019-11-20T08:00:00Z", "property1": {}, "property2": {} } |
Panel | ||
---|---|---|
| ||
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)
Scopes
TBD
Example(s)
...
"end": "2019-12-20T08:00:00Z"
}
},
{
"key": "StatusId",
"value": "3603C0B5778E4407AE577300E0694888" // Uitgevoerd
},
] |
Modify only the period of a groundwork.
Code Block | ||||
---|---|---|---|---|
| ||||
Code sample TBD[ { "typekey": "stringPeriod", "value": { "titlestart": "string2019-11-20T08:00:00Z", "status": 0, "detail "end": "2019-12-20T08:00:00Z" } } ] |
Modify the description of a groundwork.
Code Block | ||||
---|---|---|---|---|
| ||||
[ { "key": "stringDescription", "instancevalue": "string", "property1": {}, "property2": {} } The new description of the groundwork." } ] |
...
Panel | ||
---|---|---|
| ||
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.
...
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)
Scopes
...
Scope
gipod_pdo_read
Example(s)
...
TBD
...
language | xml |
---|---|
theme | DJango |
...
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 the zone details of a Groundwork for detailed information of a given GIPOD ID and groundwork zone ID.
Resource URL
GET /api/v1/groundworks/{gipodId}/zones/{zoneId} (Swagger)
Scopes
...
Scope
gipod_pdo_read
Example(s)
...
TBD
Code Block | ||||
---|---|---|---|---|
| ||||
Code sample TBD
{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"property1": {},
"property2": {}
}
|
...
bgColor | #f05e23 |
---|
...
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)
Scope
gipod_pdo_write
Example(s)
Request and response samples are provided in Swagger.
...
Panel | ||
---|---|---|
| ||
GET /api/v1/groundworks/{gipodId} Anchor | | PATCHGW | PATCHGW
Description
Modify a GroundworkGet a given attachment of a groundwork.
Resource URL
PATCH GET /api/v1/groundworks/{gipodId}/attachments/{attachmentId} (Swagger link TBD)
Scopes
...
Scope
gipod_pdo_read
Example(s)
...
TBD
...
language | xml |
---|---|
theme | DJango |
...
Response samples are provided in Swagger.
...
Panel | ||
---|---|---|
| ||
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.
...
Panel | ||
---|---|---|
| ||
POSTGW | POSTGW||
Anchor |
Description
Register a new Groundworkgroundwork.
Resource URL
...
Scope
gipod_pdo
Examples
You want to register a Groundwork ...
Code Block | ||||
---|---|---|---|---|
| ||||
Code sample TBD
{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"property1": {},
"property2": {}
}
|
You want to register a Groundwork ...
Code Block | ||||
---|---|---|---|---|
| ||||
Code sample TBD
{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"property1": {},
"property2": {}
}
|
You want to register a Groundwork ...
Code Block | ||||
---|---|---|---|---|
| ||||
Code sample TBD
{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"property1": {},
"property2": {}
}
|
...
bgColor | #663a82 |
---|
...
_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}/zones/{zoneId}attachments |
Description
Modify a zoneUpload an attachment to a given groundwork.
Resource URL
...
...
...
Scopes
...
Scope
gipod_pdo_write
Example(s)
TBD
...
language | xml |
---|---|
theme | DJango |
...
Request and response samples are provided in Swagger.
...