Skip to content
/Projects

(1.0.0)

Download OpenAPI description
document.json
document.yaml
Languages
Servers
Mock server
https://docs.insert.nl/_mock/apis/document/
https://accept-app.insert.nl/api/v1/

Authentication

Operations

Products

Operations

Projects

Operations

List projects

Request

Security
oauth2
curl -i -X GET \
  https://docs.insert.nl/_mock/apis/document/projects \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Paginated set of ProjectResource

Bodyapplication/json
dataArray of objects(ProjectResource)required
data[].​idintegerrequired
data[].​titlestringrequired
data[].​publishedbooleanrequired
data[].​created_atstring or null(date-time)required
data[].​updated_atstring or null(date-time)required
data[].​beschrijvingstring or nullrequired
data[].​contactpersoon_naamstring or nullrequired
data[].​contactpersoon_emailstring or nullrequired
data[].​adresstring or nullrequired
data[].​postcodestring or nullrequired
data[].​plaatsstring or nullrequired
data[].​latitudestring or nullrequired
data[].​longitudestring or nullrequired
data[].​functie_objectstring or nullrequired
data[].​bouwjaarinteger or nullrequired
data[].​aantal_bouwlageninteger or nullrequired
data[].​bruto_vloeroppervlak_m2integer or nullrequired
data[].​architectstring or nullrequired
data[].​voorbereidende_werkzaamheden_mogelijk_vanafstring or null(date-time)required
data[].​grondwaterstandinteger or nullrequired
data[].​grondsoortstring or nullrequired
data[].​bereikbaarheid_locatiestring or nullrequired
data[].​materiaal_beschikbaar_vanafstring or null(date-time)required
data[].​materiaal_beschikbaar_totstring or null(date-time)required
data[].​materiaal_online_vanafstring or null(date-time)required
data[].​materiaal_online_totstring or null(date-time)required
data[].​leveringstring or nullrequired
data[].​status_materiaalstring or nullrequired
data[].​materiaaleigenaarstring or nullrequired
data[].​priveboolean or nullrequired
data[].​archivedboolean or nullrequired
data[].​urlstringrequired
linksobjectrequired
links.​firststring or nullrequired
links.​laststring or nullrequired
links.​prevstring or nullrequired
links.​nextstring or nullrequired
metaobjectrequired
meta.​current_pageintegerrequired
meta.​frominteger or nullrequired
meta.​last_pageintegerrequired
meta.​linksArray of objectsrequired

Generated paginator links.

meta.​links[].​urlstring or nullrequired
meta.​links[].​labelstringrequired
meta.​links[].​activebooleanrequired
meta.​pathstring or nullrequired

Base path for paginator generated URLs.

meta.​per_pageintegerrequired

Number of items shown per page.

meta.​tointeger or nullrequired

Number of the last item in the slice.

meta.​totalintegerrequired

Total number of items being paginated.

Response
application/json
{
  "data": [
    { … }
  ],
  "links": {
    "first": "string",
    "last": "string",
    "prev": "string",
    "next": "string"
  },
  "meta": {
    "current_page": 0,
    "from": 0,
    "last_page": 0,
    "links": [ … ],
    "path": "string",
    "per_page": 0,
    "to": 0,
    "total": 0
  }
}

Create project

Request

Security
oauth2
Bodyapplication/jsonrequired
titlestring<= 255 charactersrequired
contactpersoon_naamstringrequired
contactpersoon_emailstring(email)required
adresstringrequired
postcodestringrequired
plaatsstringrequired
materiaal_beschikbaar_vanafstring(date-time)required
materiaal_beschikbaar_totstring(date-time)required
materiaal_online_vanafstring(date-time)required
materiaal_online_totstring(date-time)required
leveringstringrequired
status_materiaalstringrequired
Enum"Beschikbaar""Te koop""Gereserveerd""Geleverd""Verkocht"
grondsoortstring or null<= 255 characters
Enum"""Zand""Veen""Klei""Loss""Anders"
priveboolean
curl -i -X POST \
  https://docs.insert.nl/_mock/apis/document/projects \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "title": "string",
    "contactpersoon_naam": "string",
    "contactpersoon_email": "user@example.com",
    "adres": "string",
    "postcode": "string",
    "plaats": "string",
    "materiaal_beschikbaar_vanaf": "2019-08-24T14:15:22Z",
    "materiaal_beschikbaar_tot": "2019-08-24T14:15:22Z",
    "materiaal_online_vanaf": "2019-08-24T14:15:22Z",
    "materiaal_online_tot": "2019-08-24T14:15:22Z",
    "levering": "string",
    "status_materiaal": "Beschikbaar",
    "grondsoort": "",
    "prive": true
  }'

Responses

Bodyapplication/json
idintegerrequired
Response
application/json
{
  "id": 0
}

Add project image

Request

Security
oauth2
Path
projectintegerrequired

The project ID

Bodyapplication/jsonrequired
namestringrequired
srcstringrequired
curl -i -X POST \
  'https://docs.insert.nl/_mock/apis/document/projects/{project}/images' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "src": "string"
  }'

Responses

Bodyapplication/jsonArray [
object
]
Response
application/json
[
  null
]

Delete project image

Request

Security
oauth2
Path
projectintegerrequired

The project ID

imageIdintegerrequired
curl -i -X DELETE \
  'https://docs.insert.nl/_mock/apis/document/projects/{project}/images/{imageId}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/jsonArray [
object
]
Response
application/json
[
  null
]

Subscriptions

Operations