API

Projecten

Bij alle methodes van deze API module dient authenticatie informatie mee gestuurd te worden met het request.

Maak een project

POST /1.0/:apiObjectId/project

Parameters

Naam Type Omschrijving
scenario string Scenario van het project (BBvk, BBvh, NBvk, NBvh, etc...)
type string Type van het project (Woonruimte, Bouwgrond, Ligplaats, etc...)
subtype string Subtype van het project (Woonhuis, Appartement, etc...)
name string Naam van het project (adres)
country string Land (Nederland, België, etc...)
city string Stad
street string Straat
zipcode string Postcode
housenumber integer Huisnummer
housenumber_addition string Huisnummer toevoegen

Response

Status: 200 OK
{
  "id": 1111111
}

Haal een project op

GET /1.0/:apiObjectId

Parameters

Naam Type Omschrijving
version float Api XML versie (1.0, 1.1, 1.2). Standaard waarde: 1.2

Response

Status: 200 OK
{
  "xml": <?xml version="1.0" encoding="UTF-8"?>...
}

Opmerking: De XML kan gevalideerd worden aan de hand van de project XSD's.

Response met XML header

Als je een "Accept: application/xml" header meestuurt, dan krijg je de XML direct in het response terug

Status: 200 OK

<?xml version="1.0" encoding="UTF-8"?>
<Project xmlns="http://service.yes-co.nl/apixml/project12"
    timestampGenerated="2024-10-29T16:03:02+01:00"
    modifiedDate="2024-10-29T14:47:21+01:00" id="1111">
    ....
</Project>

Haal alle projecten op

GET /1.0/:apiObjectId/project

Response

Status: 200 OK
{
  "objects": [
    {
        "project": {
            "id": 1111,
            "scenario": "BBvk",
            "name": "Object 1"
        }
    },
    {
        "project": {
            "id": 2222,
            "scenario": "BBvh",
            "name": "Object 2"
        }
    }
  ]
}

Bewerk een project

POST /1.0/:apiObjectId

Parameters

De XML van het project wordt als raw request body meegestuurd.

Response

Status: 200 OK
{
  "apiObjectId": 1766845205
}

Xsd specificaties project

Versie 1.3 (nog niet ondersteund)

Versie 1.2

Versie 1.1

Versie 1.0