API

Relaties

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

Maak een relatie aan

POST /1.0/:apiObjectId/relation

Parameters

Naam Type Omschrijving
type string Type van de relatie (person / business)
name string Achternaam/bedrijfsnaam

In plaats van het type/naam kan ook de volledige relatie XML als raw request body meegestuurd worden (Volgens de relation XSD's).

Response

Status: 200 OK
{
  "apiObjectId": 1111111
}

De apiObjectId in het response is het API id van de net aangemaakte relatie.

Haal een relatie op

GET /1.0/relation/:apiObjectId

Response

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

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

Bewerk een relatie

POST /1.0/relation/:apiObjectId

Parameters

De XML van de relatie wordt als raw request body meegestuurd.

Response

Status: 200 OK
{
  "apiObjectId": 1766845205
}

De apiObjectId in het response is het API id van de net bijgewerkte relatie.

Xsd specificaties relatie

Versie 1.2

Versie 1.1

Versie 1.0