Introductie
Hieronder vindt u de functionele beschrijving van de berichtsoortenservice. Ook de OpenAPI definities kunnen geraadpleegd worden. De beschrijving is ook hieronder aanwezig in PDF
Request
De service is een REST service en als volgt aangeroepen worden:
https://<biv-host>/filers-information/messagetypes-details
<biv-host> dient vervangen te worden door de host die gebruikt wordt voor de betreffende BIV omgeving:
- bta-frcportaal.nl
- btba-frcportaal.nl
- btp.frcportaal.nl
Om een call te maken is een header property vereist in de GET methode:
|
Key |
Value |
Notes |
|
Accept |
application/json;api-version=<version> |
Replace <version> with the actual version to be used. For example: application/json;api-version=2020.1.0 |
Response
De service retourneert de resultaten in JSON formaat. Omdat de inhoud van de resultaten kunnen wijzigen, is een versienummering aangebracht.
Version 2020.1.0
Zie voorbeeld hieronder:
|
{ "berichtsoorten": [ { "berichtsoort": "Krediet", "beschrijving": "Krediet rapportage", "toegestaneOntvangers": [ { "naam": "Bank", "identiteitType": "ID-ontvanger", "identiteitNummer": "00000003900000010000" } ] }, { "berichtsoort": "SBV", "beschrijving": "SBV", "toegestaneOntvangers": [] }, { "berichtsoort": "Vastgoed", "beschrijving": "Vastgoed rapportage", "toegestaneOntvangers": [ { "naam": "Bank", "identiteitType": "ID-ontvanger", "identiteitNummer": "00000003900000010000" } ] } ] } |
Version 2020.2.0
De toegestane entrypoints voor elke berichtsoort wordt geretourneerd, inclusief de naam, vervaldatum en eventuele opties als bijlage.
|
{ "berichtsoorten": [ { "berichtsoort": "Krediet", "beschrijving": "Krediet rapportage", "toegestaneOntvangers": [ { "naam": "Bank", "identiteitType": "ID-ontvanger", "identiteitNummer": "00000003900000010000" } ], "allowedEntrypoints": [ { "name": "Beperkte inrichtingsjaarrekening 2019", "entrypoint": "https://www.sbrbanken.nl/ft14/frc/20191204/entrypoints/frc-rpt-nt-inrichtingsjaarrekening-beperkt-2019.xsd", "expirationDate": "2023-03-31T22:00:00Z", "allowedAsContent": true, "allowedAsAttachment": false } ] }, { "berichtsoort": "SBV", "beschrijving": "SBV", "toegestaneOntvangers": [] }, { "berichtsoort": "Vastgoed", "beschrijving": "Vastgoed rapportage", "toegestaneOntvangers": [ { "naam": "Bank", "identiteitType": "ID-ontvanger", "identiteitNummer": "00000003900000010000" } ], "allowedEntrypoints": [ { "name": "Taxatiegegevens", "entrypoint": "https://www.sbrbanken.nl/vt13/frc/20190703/entrypoints/frc-rpt-vt-taxatiegegevens.xsd", "expirationDate": "2030-12-30T23:00:00Z", "allowedAsContent": true, "allowedAsAttachment": false } ] } ] } |
Version 2020.3.0
Een maximum en minimum aantal bijlagen voor elke berichtsoort wordt geretourneerd.
|
{ "berichtsoorten": [ { "berichtsoort": "Krediet", "beschrijving": "Krediet rapportage", "maximumNumberOfAttachments": 2, "toegestaneOntvangers": [ { "naam": "Bank", "identiteitType": "ID-ontvanger", "identiteitNummer": "00000003900000010000" } ], "allowedEntrypoints": [ { "name": "Beperkte inrichtingsjaarrekening 2019", "entrypoint": "https://www.sbrbanken.nl/ft14/frc/20191204/entrypoints/frc-rpt-nt-inrichtingsjaarrekening-beperkt-2019.xsd", "expirationDate": "2023-03-31T22:00:00Z", "allowedAsContent": true, "allowedAsAttachment": false } ], "allowedAttachments": [ { "dataType":"XBRL", "minimumNumberOfAttachments":0, "maximumNumberOfAttachments":0 }, { "dataType":"XML", "minimumNumberOfAttachments":0, "maximumNumberOfAttachments":0 } ] }, { "berichtsoort": "SBV", "beschrijving": "SBV", "toegestaneOntvangers": [] }, { "berichtsoort": "Vastgoed", "beschrijving": "Vastgoed rapportage", "maximumNumberOfAttachments": 2, "toegestaneOntvangers": [ { "naam": "Bank", "identiteitType": "ID-ontvanger", "identiteitNummer": "00000003900000010000" } ], "allowedEntrypoints": [ { "name": "Taxatiegegevens", "entrypoint": "https://www.sbrbanken.nl/vt13/frc/20190703/entrypoints/frc-rpt-vt-taxatiegegevens.xsd", "expirationDate": "2030-12-30T23:00:00Z", "allowedAsContent": true, "allowedAsAttachment": false } ], "allowedAttachments": [ { "dataType":"XBRL", "minimumNumberOfAttachments":0, "maximumNumberOfAttachments":0 }, { "dataType":"XML", "minimumNumberOfAttachments":0, "maximumNumberOfAttachments":0 } ] } ] } |
Service description:
De OpenAPI definities van de service kun je hieronder downloaden: