...
| Table of Contents | ||
|---|---|---|
|
...
| Panel | ||||||
|---|---|---|---|---|---|---|
| ||||||
GET /api/v1groundworks/{gipodid}/trench-synergy-requests/{trenchSynergyRequestId} Anchor |
|
Description
Get the details for a given trench synergy request.
...
Scope
gipod_ts_read
Example(s)
NAResponse samples are provided in Swagger.
...
| Panel | ||||||
|---|---|---|---|---|---|---|
| ||||||
DELETE /api/v1/groundworks/{gipodId}/trench-synergy-requests/{trenchsynergyrequestid} Anchor |
|
Description
Withdraw a trench synergy request. The trench synergy request process will be stopped.
...
Request and response samples are provided in Swagger.
...
| Panel | ||||||
|---|---|---|---|---|---|---|
| ||||||
PUT /api/v1/groundworks/{gipodId}/trench-synergy-requests/{trenchsynergyrequestid} Anchor |
|
...
Scope
gipod_ts_write
Example
| language | xml |
|---|---|
| theme | DJango |
Request and response samples are provided in Swagger.
| Panel | ||||||
|---|---|---|---|---|---|---|
| ||||||
GET /api/v1/trench-synergy-requests-to-be-answered Anchor |
|
...
Scope
gipod_ts_read
Example(s)
NAResponse samples are provided in Swagger.
...
| Panel | ||
|---|---|---|
| ||
GET /api/v1/trench-synergy-requests-with-groundworks-to-be-added |
Description
Get joined trench synergy requests where no groundworks have been added.
...
Response samples are provided in Swagger.
...
| Panel | ||
|---|---|---|
| ||
GET /api/v1/trench-synergy-requests |
Description
Search trench synergy requests.
...
| Code Block | ||||
|---|---|---|---|---|
| ||||
https://test-pdo-search-api.azurewebsites.net/api/v1/trench-synergy-requests/trench-synergy-requests?pilotid=10aee532-9c4b-0797-973f-057e03a797bb https://test-pdo-search-api.azurewebsites.net/api/v1/trench-synergy-requests/trench-synergy-requests?start=2020-01-27T10%3A00%3A00Z&end=2020-01-29T10%3A00%3A00Z |
...
| Panel | ||||||
|---|---|---|---|---|---|---|
| ||||||
POST /api/v1/groundworks/{gipodId}/trench-synergy-requests Anchor |
|
Description
Launch a new trench synergy request for a given groundwork.
...
Scope
gipod_ts_write
Example
...
| language | xml |
|---|---|
| theme | DJango |
...
Request and response samples are provided in Swagger.
...
| Panel | ||||||
|---|---|---|---|---|---|---|
| ||||||
PUT /api/v1/groundworks/{gipodId}/trench-synergy-requests/{trenchSynergyRequestId}/answers Anchor |
|
...
Before deadline1 it's possible to answer 'No' or 'Yes' with conditions or groundworks.
After deadline1 it's not possible to add a new answer. Only changing the answer to 'No' is possible.
Resource URL
PUT /api/v1/groundworks/{gipodId}/trench-synergy-requests/{trenchSynergyRequestId}/answers (Swagger)
Scope
gipod_ts_write
...
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"joining": false
} |
...
| Panel | ||
|---|---|---|
| ||
PUT /api/v1/groundworks/{gipodId}/trench-synergy-requests/{trenchSynergyRequestId}/answer/groundworks |
Description
Add groundworks to a trench synergy request.
Resource URL
Scope
gipod_ts_write
Example(s)
A request sample is Request and response samples are provided in Swagger.
...
| Panel | ||
|---|---|---|
| ||
POST /api/v1/groundworks/{gipodId}/trench-synergy-requests/{trenchSynergyRequestId}/trench-synergies |
Description
Close a trench synergy request before deadline2. This can only be done by the pilot if all organisations which want to participate have added groundworks to their answer. The trench synergy request will be closed with status 'ClosedWithConsequence' and a trench synergy will be created afterwards.
Resource URL
POST /api/v1/groundworks/{gipodId}/trench-synergy-requests/{trenchSynergyRequestId}/trench-synergies (Swagger)
Scope
gipod_ts_write
Example(s)
A response sample is Response samples are provided in Swagger.