Versions Compared

Old Version 66

changes.mady.by.user Bavo Van Eyken

Saved on

compared with

New Version Current

changes.mady.by.user Bavo Van Eyken

Saved on

Key

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

...

Table of Contents
maxLevel1

...

Panel
bgColor#50c878

GET /api/v1/groundworks/{gipodId} 
Anchor
GWGETGW
GWGETGW

Description

Get details detailed information of a Groundwork for a given GIPOD ID.

Resource URL

GET /api/v1/groundworks/{gipodId} (Swagger)

Scope

gipod_pdo_read

Example(s)

TBD

Code Block
languagexml
themeDJango
Code sample TBD
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "property1": {},
  "property2": {}
}
Panel
bgColor#50c878

GET /api/v1/groundworks/{gipodId}/occurrences

Description

Get the period occurence of a specific groundwork.

Resource URL

GET /api/v1

...

/

...

Scope

gipod_pdo_read

Example(s)

TBD

Code Block
languagexml
themeDJango
Code sample TBD
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "property1": {},
  "property2": {}
}
Panel
bgColor#50c878

GET /api/v1/groundworks/{gipodId}/contactorganisations/{contactId}

Description

Get contact information of a Groundwork for a given GIPOD ID and contact ID.

Resource URL

...

groundworks/{gipodId

...

} (Swagger)

Scope

gipod_pdo_read

Example(s)

TBD

Code Block
languagexml
themeDJango
Code sample TBD
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "property1": {},
  "property2": {}
}
Panel
bgColor#50c878

GET /api/v1/groundworks/{gipodId}/zones/{zoneId}

Description

Get the zone details of a Groundwork for a given GIPOD ID and zone ID.

Resource URL

GET /api/v1/groundworks/{gipodId}/zones/{zoneId} (Swagger)

Scope

gipod_pdo_read

Example(s)

TBD

...

languagexml
themeDJango

...

A response sample is provided in Swagger

...

Panel
bgColor#f05e23

PATCH /api/v1/groundworks/{gipodId}
Anchor
PATCHGW
PATCHGW

Description

Partial modification of a given groundwork. Supported modifications are indicated in the request sample.

Resource URL

PATCH /api/v1/groundworks/{gipodId} (Swagger)

Scope

gipod_pdo_write

Example(s)

Modify period and estimated duration in days of a groundwork.

...

Code Block
languagexml
themeDJango
[
{
	"key": "Description",
	"value": "The new description of the groundwork."
}
]

...

POSTGW

/{gipodId}

Panel
bgColor#add8e6#E27A7A
POST

DELETE /api/v1/groundworks

Anchor
POSTGW

Description

Register Remove a new Groundworkgiven groundwork.

Resource URL

...

Scope

gipod_pdo_write

Example

...

Register a category 1 groundwork of type "Electriciteit" that is planned from 01/07/2020 till 31/07/2020 with an estimated duration of 5 days

...

languagexml
themeDJango

...

(s)

Request and response samples are provided in Swagger.

...

Panel
bgColor#50c878

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

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)

Scope

gipod_pdo_read

Example(s)

Response samples are provided in Swagger.

...

Panel
bgColor#663a82

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
bgColor#E27A7A

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

GET /api/v1/groundworks/{gipodId}/zones/{zoneId}

Description

Get detailed information of a given groundwork zone.

Resource URL

GET /api/v1/groundworks/{gipodId}/zones/{zoneId} (Swagger)

Scope

gipod_pdo_read

Example(s)

Response samples are provided in Swagger.

...

Panel
bgColor#663a82

PUT /api/v1/groundworks/{gipodId}/zones/{zoneId}

Description

Modify a given groundwork zone.

Resource URL

PUT /api/v1/groundworks/{gipodId}/zones/{zoneId} (Swagger link TBD)

Scope

gipod_pdo_write

Example(s)

TBD

Code Block
languagexml
themeDJango
Code sample TBD
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "property1": {},
  "property2": {}
}

...

bgColor#663a82

...

Request and response samples are provided in Swagger.

...

Panel
bgColor#50c878

GET /api/v1/groundworks/{gipodId}/attachments/{attachmentId}

Description

Get a given attachment of a groundwork.

Resource URL

GET /api/v1/groundworks/{gipodId}/attachments/{attachmentId} (Swagger)

Scope

gipod_pdo_read

Example(s)

Response samples are provided in Swagger.

...

Panel
bgColor#E27A7A

DELETE /api/v1/groundworks/{gipodId}/

contactorganisations

attachments/{

contactId

attachmentId}

Description

Modify the contact information of a specific contact organisationRemove a given groundwork attachment.

Resource URL

...

...

...

attachmentId} (Swagger

...

)

Scope

gipod_pdo_write

Example(s)

Response samples are provided in Swagger.

...

Panel
bgColor#add8e6

POST /api/v1/groundworks

Description

Register a new groundwork.

Resource URL

POST /api/v1/groundworks (Swagger)

...

TBD

...

languagexml
themeDJango

...

Scope

gipod_pdo_write

Example(s)

Request and response samples are provided in Swagger.

...

Panel
bgColor#add8e6

POST /api/v1/groundworks/{gipodId}/contactorganisations

Description

Add an extra contact organisation to a given groundwork.

Resource URL

POST /api/v1/groundworks/{gipodId}/contactorganisations (Swagger)

Scope

gipod_pdo_write

Example(s)

Request and response samples are provided in Swagger.

...

Panel
bgColor#add8e6

POST /api/v1/groundworks/{gipodId}/attachments

Description

Upload an attachment to a given groundwork.

Resource URL

POST /api/v1/groundworks/{gipodId}/attachments (Swagger)

Scope

gipod_pdo_write

Example(s)

Request and response samples are provided in Swagger.

...