Page Comparison

Table of Contents

...

Info

Once-Only-principle: minimale input voor een maximaal hergebruik

Door het gebruik van IPDC en once-only principes streven we maximaal naar eenvoudige en eenduidige configuraties die de gebruiker een consistente ervaring geven doorheen het platform.

De minimaal verpichte velden zijn hieronder aangegeven met ^*

Key

Beschrijving

_links.embed

De link naar het fomulier dat geëmbed wordt in Mijn Burgerprofiel.

Conform JSON-HAL kan dit een templated link zijn.

Indien het formulier SSO verwacht (zie hieronder), dan kan in de URI template query expansion gedaan worden van TEMP_SSO_TOKEN of token (die overeenkomen met het single use SSO token, zie https://vlaamseoverheid.atlassian.net/wiki/spaces/IKPubliek/pages/5848175061#Gebruikerscontext-doorgeven-aan-een-Aanvraagmodule

Info
Gebruik deze key indien er geen `fallback` wordt meegegeven.

_links.fallback

De link naar een formulier dat een gebruiker kan openklikken wanneer het formulier niet kan worden geëmbed, bijv. door browser-incompatibiliteit.

Note
Om een fallback-link te gebruiken moeten er een global header en footer geconfigureerd zijn.

Info
Gebruik deze key indien er geen `embed` wordt meegegeven.

_links.thirdPartyCookieApi

Alleen nodig als de formulieren worden aangeboden via een third-party domein, niet indien onder een CNAME van *.formulieren.burgerprofiel.be

Voor meer details, zie https://vlaamseoverheid.atlassian.net/wiki/spaces/IKPubliek/pages/6180832603/Aanvraagformulieren+-+Third-party+cookies#Alternatieve-oplossing:-Third-party-cookie-API-endpoint

_links.ssoTokenRegistationApi

Verplicht voor formulieren die een aangemelde context vereisen (samen met sso.audience, hieronder beschreven).

Geeft aan op welk endpoint de aangemelde context van MBP overgedragen kan worden.

Voor meer details, zie Aanvraagformulieren - Authenticatie via Single Sign-on (SSO)

sso.audience

Verplicht wanneer _links.ssoTokenRegistationApi meegegeven wordt.

Geeft aan voor welke doelgroep of “audience” (ACM Client-ID) de token exchange moet gebeuren wanneer de burger het formulier opent.

Note
Voorwaarde: een trust-relatie bij ACM (white-listed) van Mijn Burgerprofiel → klant Zie ook: https://vlaamseoverheid.atlassian.net/wiki/spaces/IKPubliek/pages/6117854932/ACM-integratie#Aanvragen---Provider-API

productId ^*

Het IPDC- productId wordt gebruikt om in IPDC de titel, beschrijving, afleverende dienst, thematiek en meer info-link op te vragen.

nisCode

Voor formulieren die voor een lokale bestuur beschikbaar is.

Voor dienstverleningen op Vlaams niveau komt deze property niet terug - kan vrijblijvend wel worden ingevuld, afhankelijk van de context.
Voor dienstverleningen op lokaal niveau is deze property wel verplicht.

Bijv.

Code Block
"nisCode": "23096"

...

Code Block

breakoutMode	full-width

{
    "_links": {
      "self": { "href": "https://fl-test-eportal.skryv.comdienstenleverancier.be/api/v1/form-submissions?limit=10&offset=0" },
      "first": { "href": "https://fl-test-eportal.skryv.comdienstenleverancier.be/api/v1/form-submissions?limit=10&offset=0" },
      "next": { "href": "https://fl-test-eportal.skryv.comdienstenleverancier.be/api/v1/form-submissions?limit=10&offset=10" },
      "last": { "href": "https://fl-test-eportal.skryv.comdienstenleverancier.be/api/v1/form-submissions?limit=10&offset=20" },
    },
    "_pageMetadata": {
      "offset": 0,
      "size": 10,
      "totalItems": 26
    },
   "_embedded": {
      "items": [
        {
          "_links": {
              "embed": { "href": "https://fluw-testeloket-eportalcname.formulieren.skryvburgerprofiel.combe/#submission/80a5af1fcff3bebb-8786dd1c-41244937-9d60-652e53428a8d" b335-f6c8c9543cb6?token={TEMP_SSO_TOKEN}", "templated": true },
              "fallback": { "href": "https://fluw-testeloket-eportalcname.formulieren.skryvburgerprofiel.combe/#submission/80a5af1fcff3bebb-8786dd1c-41244937-9d60b335-652e53428a8d"f6c8c9543cb6 },
              "formssoTokenRegistrationApi": { "href": "https://fluw-testeloket-eportalcname.formulieren.skryvburgerprofiel.combe/api/#v1/dossiertemp-info/8350d7ed-ae18-4525-ac2c-abaa49656e3csso-token" },
          },
          "thirdPartyCookieApisso": {
            "hrefaudience": "https://fl-test-eportal.skryv.com/api/v1/third_party_cookies" }93a4b91a-93f4-4cb2-bdc5-14bc53762cef"
          },
          "id": "80a5af1fcff3bebb-8786dd1c-41244937-9d60b335-652e53428a8df6c8c9543cb6",
          "formIdproductId": "8350d7ed-ae18-4525-ac2c-abaa49656e3c",697"
          "status": "in-progress",
          "providercreated": {"2020-08-11T08:34:55.451Z",
            "idupdated": "OVO000106",2020-08-19T10:58:12.379Z"
        },
   "name": "Wonen-Vlaanderen",    {
      },    "_links": {
     "created": "2020-08-11T08:34:55.451Z",         "embed": { "updatedhref": "2020-08-19T10:58:12.379Z"
        https://formulieren.loket.vlaanderen.be/submission/80a5af1f-8786-4124-9d60-652e53428a8d?token={TEMP_SSO_TOKEN}", "templated": true },
              "fallback": { "href": "https://formulieren.loket.vlaanderen.be/submission/80a5af1f-8786-4124-9d60-652e53428a8d" },
      ]     }
  }   "thirdPartyCookieApi": { "href": "https://formulieren.loket.vlaanderen.be/api/v1/third_party_cookies" },
              "ssoTokenRegistrationApi": { "href": "https://formulieren.loket.vlaanderen.be/api/v1/temp-sso-token" }
          },
          "sso": {
            "audience": "d9da076d-3069-481c-9fa7-783ccb84ad61"
          },
          "id": "80a5af1f-8786-4124-9d60-652e53428a8d",
          "productId": "1390",
          "submissionTitle": "Renovatielening voor Structurele Elementen"
          "nisCode": "23096",
          "status": "in-progress",
          "created": "2020-08-11T08:34:55.451Z",
          "updated": "2020-08-19T10:58:12.379Z"
        },
        ...
      ]
    }
  }

Het bovenstaande codevoorbeeld geeft items terug met deze extra extensies:

status: in progress zodat het formulier tussentijds kan bewaard worden provider id en name: de OVO-code en de naam van de bevoegde overheid-progress zodat het formulier tussentijds kan bewaard worden
created: Datum wanneer de instantie van het formulier aangemaakt is
updated: Datum wanneer de laatste wijziging is gebeurd aan de instantie van het formulier
submissionTitle: Optioneel veld die een specifieke titel geeft aan de submission

Query parameters

Parameter	Beschrijving
`limit`, `offset`	Zie https://vlaamseoverheid.atlassian.net/wiki/spaces/IKPubliek/pages/2076934790/Algemene+REST+API-specificaties#Paginering

Headers

Zie https://vlaamseoverheid.atlassian.net/wiki/spaces/IKPubliek/pages/2076934790/Algemene+REST+API-specificaties#CorrelationId-en-RequestId

...

Versions Compared

Old Version 53

New Version 54

Key

Headers