The resource TrenchSynergies has the following endpoints:

Description

Get the details of a given trench synergy.

Resource URL

GET /api/v1/trench-synergies/{gipodId} (Swagger)

Scope

gipod_ts_read

Example(s)

Response samples are provided in Swagger.

Description

Partial modifications of a trench synergy. Supported modifications are indicated in the request sample.

Resource URL

PATCH /api/v1/trench-synergies/{gipodId} (Swagger)

Scope

gipod_ts_write

Examples

Supported modifications are provided in Swagger.

Description

Retrieve the details of a contact organisation in the given trench synergy.

Resource URL

GET /api/v1/trench-synergies/{gipodId}/contactorganisations/{contactId} (Swagger)

Scope

gipod_ts_read

Example(s)

Response samples are provided in Swagger.

Description

Modify the contact information of a trench synergy.

Resource URL

PUT /api/v1/trench-synergies/{gipodId}/contactorganisations/{contactId} (Swagger)

Scope

gipod_ts_write

Example(s)

Request and response samples are available in Swagger.

Description

Remove the contact organisation of a trench synergy.

Resource URL

Scope

gipod_pdo_write

Example(s)

Response samples are provided in Swagger.

Description

Search for trench synergies that match the specified search criteria.

Resource URL

GET /v1/api/v1/trench-synergies (Swagger)

Scope

gipod_ts_read

Example(s)

Response samples are provided in Swagger.

Description

Transfer the pilot to another organisation for a trench synergy.

Resource URL

PUT /api/v1/trench-synergies/{gipodId}/pilot (Swagger)

Scope

gipod_ts_write

Example(s)

Request and response samples are available in Swagger.

Description

Add the contact organisation of a trench synergy.

Resource URL

Scope

gipod_ts_write

Example(s)

Request and response samples are provided in Swagger.