The resource TrenchSynergyRequests has the following endpoints:

Description

Get the details for a given trench synergy request.

Resource URL

GET /api/v1groundworks/{gipodid}/trench-synergy-requests/{trenchSynergyRequestId} (Swagger)

Scope

gipod_ts_read

Example(s)

NA

Description

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

Resource URL

DELETE /api/v1/groundworks/{gipodId}/trench-synergy-requests/{trenchsynergyrequestid} (Swagger)

Scope

gipod_ts_write

Example(s)

Request and response samples are provided in Swagger.

Description

Modify the additional info for a given trench synergy request.

Resource URL

PUT /api/v1/groundworks/{gipodId}/trench-synergy-requests/{trenchsynergyrequestid} (Swagger)

Scope

gipod_ts_write

Example

{
  "additionalInfo": "New additional info",
 
}

Description

Get trench synergy requests to be answered before deadline 1.

Resource URL

GET /api/v1/trench-synergy-requests-to-be-answered (Swagger)

Scope

gipod_ts_read

Example(s)

NA

Description

Get joined trench synergy requests where no groundworks have been added.

Resource URL

GET /api/v1/trench-synergy-requests-with-groundworks-to-be-added (Swagger)

Scope

gipod_ts_read

Example(s)

Response samples are provided in Swagger.

Description

Search trench synergy requests.

Resource URL

GET /api/v1/trench-synergy-requests (Swagger)

Scope

gipod_ts_read

Example(s)

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

Description

Launch a new trench synergy request for a given groundwork.

Resource URL

POST /api/v1/groundworks/{gipodId}/trench-synergy-requests (Swagger)

Scope

gipod_ts_write

Example

POST/api/v1/groundworks/1234/trench-synergy-requests

{
  "additionalInfo":"Some additional information about the trench synergy request"
}

Description

Add an answer to a trench synergy request.

• 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

Example(s)

Answering organisation wants to join the synergy with conditions

{
  "joining": true,
  "conditions":"i want to join if...",
}

Answering organisation wants to join the trench synergy with specific groundworks

{
  "joining": true,
  "groundworkIds": [
	12345,
	69368
	],
}

Answering organisation will not join the trench synergy 

{
  "joining": false
}

Description

Add groundworks to a trench synergy request.

Resource URL

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

Scope

gipod_ts_write

Example(s)

A request sample is provided in Swagger.

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 provided in Swagger.