API

Dossiers

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

Maak een dossier

POST /1.0/:apiObjectId/dossier

Parameters

Naam Type Omschrijving
type string Type van het dossier (document)
title string Titel van het dossier (Koopakte, Huurakte, etc...)
filename string Naam van het bestand (koopakte-nvm-2016.docx)
filepath string Locatie van het bestand (uri). (Optioneel in het geval parameter file is ingevuld)
file string Base64 encoded versie van het bestand. (Alleen van toepassing als filepath niet beschikbaar is)

Response

Status: 200 OK
{
  "apiObjectId": 1111111
}

Opmerking: Het API object id in het request is het project of relatie waarbij het document aangemaakt dient te worden

Haal een dossier op

GET /1.0/dossier/:apiObjectId

Response

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

Opmerking: De XML kan gevalideerd worden aan de hand van de dossier 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"?>
<Document xmlns="http://service.yes-co.nl/apixml/dossier12"
    timestampGenerated="2024-10-29T16:03:02+01:00"
    modifiedDate="2024-10-29T14:47:21+01:00" id="1111">
    ....
</Document>

Haal alle dossiers op

GET /1.0/:apiObjectId/dossier

Response

Status: 200 OK
{
    "objects": [
        {
            "document": {
                "id": 111111,
                "title": "Bestand",
                "filename": "bestand.pdf",
                "created": "2024-12-11T17:47:07+01:00",
                "mimetype": "application/pdf",
                "hash": "zdfbdfxbrawegfbxvxvbxcvbxf"
            }
        },
        {
            "document": {
                "id": 2222,
                "title": "Bestand",
                "filename": "bestand.png",
                "created": "2024-12-11T18:08:05+01:00",
                "mimetype": "image/png",
                "hash": "gfgagfdsfgawergsdfbdsfgbvcxb"
            }
        }
    ]
}

Bewerk een dossier

POST /1.0/:apiObjectId/dossier

Parameters

De XML van het dossier item wordt als raw request body meegestuurd.

Response

Status: 200 OK
{
  "id": 1111111
}

Xsd specificaties dossier items

Versie 1.2

Versie 1.1

Versie 1.0