Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Table of Contents
maxLevel1

...

Panel
bgColor#50c878

GET /api/v1groundworks/{gipodid}/trench-synergy-requests/{trenchSynergyRequestId}
Anchor
TOONDETAIL
TOONDETAIL

Description

Get the details for a given trench synergy request.

...

Response samples are provided in Swagger.

...

Panel
bgColor#E27A7A

DELETE /api/v1/groundworks/{gipodId}/trench-synergy-requests/{trenchsynergyrequestid}
Anchor
TREKSSAIN
TREKSSAIN

Description

Withdraw a trench synergy request. The trench synergy request process will be stopped.

...

Request and response samples are provided in Swagger.

...

Panel
bgColor#663a82

PUT /api/v1/groundworks/{gipodId}/trench-synergy-requests/{trenchsynergyrequestid}
Anchor
PUTADDINFO
PUTADDINFO

...

Request and response samples are provided in Swagger.


Panel
bgColor#50c878

GET /api/v1/trench-synergy-requests-to-be-answered
Anchor
TOBEANSWERED
TOBEANSWERED

...

Response samples are provided in Swagger.

...

Panel
bgColor#50c878

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
bgColor#50c878

GET /api/v1/trench-synergy-requests

Description

Search trench synergy requests.

...

Code Block
languagexml
themeDJango
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
bgColor#add8e6

POST /api/v1/groundworks/{gipodId}/trench-synergy-requests
Anchor
launchssa
launchssa

Description

Launch a new trench synergy request for a given groundwork.

...

Request and response samples are provided in Swagger.

...

Panel
bgColor#663a82

PUT /api/v1/groundworks/{gipodId}/trench-synergy-requests/{trenchSynergyRequestId}/answers
Anchor
ANTWOORDSSA
ANTWOORDSSA

...

Code Block
languagexml
themeDJango
{
  "joining": false
}

...

Panel
bgColor#663a82

PUT /api/v1/groundworks/{gipodId}/trench-synergy-requests/{trenchSynergyRequestId}/answer/groundworks

Description

Add groundworks to a trench synergy request.

...

Request and response samples are provided in Swagger.

...

Panel
bgColor#add8e6

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.

...