Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

De authenticatie loopt via https://authenticatie.vlaanderen.be/docs/beveiligen-van-api/oauth-rest/ waarbij Mijn Burgerprofiel de afnemer (= Client) is en de dienstenleverancier als aanbieder (= Resource) optreedt.

Mijn Burgerprofiel zal bij het aanvragen van een access token de scope dv_mbp_incidents specificeren. Deze scope moet door de dienstenleverancier als default worden toegewezen aan de client. Dit kan eenvoudig via het beheersportaal van ACM.

Info

Meer informatie: https://vlaamseoverheid.atlassian.net/wiki/spaces/IKPubliek/pages/2076934790/Algemene+REST+API-specificaties#Authorization

...

Drawio
mVer2
zoom1
simple0
inComment0
custContentId6623396115
pageId6521752181
lbox1
diagramDisplayNameUntitled Diagram-1699360017383.drawio
contentVer4
revision5
baseUrlhttps://vlaamseoverheid.atlassian.net/wiki
diagramNameUntitled Diagram-1699360017383.drawio
pCenter0
width472
linkstbstyle
height722

...

contentVer4
revision5
baseUrlhttps://vlaamseoverheid.atlassian.net/wiki
diagramNameUntitled Diagram-1699360017383.drawio
pCenter0
width472
links
tbstyle
height722

Swagger-documentatie “Incidents” (Meldingen)

Swagger open api macro
displayOperationIdfalse
methodsnone,get,put,post,delete,options,head,patch,trace
validator
defaultModelsExpandDepth1
url
token
defaultModelRenderingexample
filter
password
expandlist
showCommonExtensionsfalse
filenameIncidents
operations
maxDisplayedTags
attachtrue
showExtensionsfalse
displayRequestDurationfalse
username
order
Swagger open api macro
displayOperationIdfalse
methodsnone,get,put,post,delete,options,head,patch,trace
validator
defaultModelsExpandDepth1
url
token
defaultModelRenderingexample
filter
password
expandlist
showCommonExtensionsfalse
filenameIncidents
operations
maxDisplayedTags
attachtrue
showExtensionsdisplayRequestDurationfalse
displayRequestDurationshowExtensionsfalse
username
order

Voorbeeld JSON schema

Expand
titleJSON-Voorbeeld
Code Block
languagejson
{
  "$schema": "http://json-schema.org/draft-07/schema",
  "type": "object",
  "required": [ "contactType", "contact" ],
  "properties": {
    "contactType": {
      "oneOf": [
        { "const": "authenticated" },
        { "const": "userInput" }
      ]
    },
    "contact": { "$ref": "#/definitions/Contact" },
    "location": { "$ref": "#/definitions/Location" }
  },
  "definitions": {
    "Contact": {
      "type": "object",
      "required": [ "firstname", "lastname" ],
      "properties": {
        "firstname": { "type": "string" },
        "lastname": { "type": "string" },
        "rrn": { "type": "number" },
        "address": { "$ref": "#/definitions/Address" },
        "email": { "type": "string" },
        "phone": { "type": "string" }
      }
    },
    "Address": {
      "type": "object",
      "required": [ "street", "number", "city" ],
      "properties": {
        "street": { "type": "string" },
        "number": { "type": "string" },
        "box": { "type": "string" },
        "zipcode": { "type": "string" },
        "city": { "type": "string" }
      }
    },
    "Location": {
      "type": "object",
      "properties": {
        "address": { "$ref": "#/definitions/Address" },
        "coordinates": { "$ref": "#/definitions/Coordinates" }
      }
    },
    "Coordinates": {
      "type": "object",
      "properties": {
        "longlng": {
          "type": "number",
          "format": "double"
        },
        "lat": {
          "type": "number",
          "format": "double"
        },
        "accuracy": {
          "type": "number",
          "format": "double"
        }
      }
    }
  }
}

...

Expand
titleJSON-voorbeeld
Code Block
languagejson
{
  "channel": "gemeenteApp",
  "contactType": "authenticated",
  "nisCode": 71022,
  "categories": [
    {
      "id": "7a005ef2-0c56-4be4-8a70-caed94831799",
      "name": "Verkeer, parkeren"
    },
    {
      "id": "0443dd74-37ec-4f6c-ba83-3efdb7706a0c",
      "name": "Parkeren",
      "parentId": "7a005ef2-0c56-4be4-8a70-caed94831799"
    },
    {
      "id": "6ea49d53-bdcf-4afa-9628-6a8a446be684",
      "name": "Mindervalide parkeerplaats",
      "parentId": "0443dd74-37ec-4f6c-ba83-3efdb7706a0c"
    }
  ],
  "description": "Markering van de mindervalide parkeerplaats is niet zichtbaar",
  "location": {
    "address": {
      "street": "Meldertstraat",
      "number": "5",
      "zipcode": "3500",
      "city": "Hasselt"
    },
    "coordinates": {
      "longlng": 50.93060711270709,
      "lat": 5.341160931979752,
      "accuracy": 0.0
    }
  },
  "contact": {
    "firstname": "Jan",
    "lastname": "Modaal",
    "rrn": 91010100243,
    "address": {
      "street": "Limburgplein",
      "number": "1",
      "box": "b",
      "zipcode": "3500",
      "city": "hasselt"
    },
    "email": "jan.modaal@hotmail.com",
    "phone": "+32476123456"
  }
}