Algemeen

Voor meer informatie rond de werking van uitzonderingen in RESTful service, wordt verwezen naar Werking en overzicht uitzonderingen MAGDA RESTful services. Op deze pagina zijn de verschillende response codes te vinden en voorbeelden ervan.

Hieronder zijn de dienst specifieke response codes te vinden.

Response codes <> 20X

MAGDA streeft ernaar om de berichgeving bij een “unhappy flow” zoveel mogelijk te standaardiseren. De standaard response codes en de inhoud van de bijhorende errormessage is terug te vinden op Werking en overzicht uitzonderingen MAGDA RESTful services

Afwijkingen ten opzichte van deze standaard, specifiek voor deze operatie zijn hieronder te vinden. Deze afwijkingen zijn over het algemeen noodzakelijk doordat de bron het niet mogelijk maakt om de standaard te volgen of omdat de bron extra data doorgeeft.

Response code 400

Bij validatie fouten zal WiV de errormessage uitbreiden met de verschillende validaties die falen door een validationErrors element toe te voegen. MAGDA neemt deze informatie over.

{
  "validationErrors": [
    {
      "name": "string",
      "reason": "string"
    }
  ],
  "title": "string",
  "status": 0,
  "detail": "string"
}

Response code 404

Indien WiV een 404 terug geeft is geen woning gevonden voor de opgegeven path parameters. MAGDA neemt deze foutmelding over met de toevoeging van “Source: “ in het detail element.

{
  "title": "Not found",
  "status": 404,
  "detail": "Source: Geen woning gevonden",
  "instance": "e24aff4c-2df9-458c-8bb8-fbe71c745df6"
}

Response code 500 van WiV

Indien WiV een 500 terug geeft zal MAGDA een 502 terug geven aan de afnemer. In de payload van WiV zit enkel een message welke wordt overgenomen in het detail element, voorafgegaan door “Source: “.

{
  "title": "Bad Gateway",
  "status": 502,
  "detail": "Source: Internal server error",
  "instance": "e24aff4c-2df9-458c-8bb8-fbe71c745df6"
}

Response codes <> 20X

MAGDA streeft ernaar om de berichgeving bij een “unhappy flow” zoveel mogelijk te standaardiseren. De standaard response codes en de inhoud van de bijhorende errormessage is terug te vinden op Werking en overzicht uitzonderingen MAGDA RESTful services

Afwijkingen ten opzichte van deze standaard, specifiek voor deze operatie zijn hieronder te vinden. Deze afwijkingen zijn over het algemeen noodzakelijk doordat de bron het niet mogelijk maakt om de standaard te volgen of omdat de bron extra data doorgeeft.

Response code 400

Bij validatie fouten zal WiV de errormessage uitbreiden met de verschillende validaties die falen door een validationErrors element toe te voegen. MAGDA neemt deze informatie over.

{
  "validationErrors": [
    {
      "name": "string",
      "reason": "string"
    }
  ],
  "title": "string",
  "status": 0,
  "detail": "string"
}

Response code 404

Indien WiV geen woning gevonden heeft voor de opgegeven path parameters neemt MAGDA deze foutmelding over met de toevoeging van “Source: “ in het detail element.

Eigenaar is een Woonmaatschappij

{
  "title": "Not found",
  "status": 404,
  "detail": "Source: Indien de eigenaar van een woning een Woonmaatschappij is dan dient de woning aangemaakt te worden via Projectportaal.",
  "instance": "e24aff4c-2df9-458c-8bb8-fbe71c745df6"
}

Woning bestaat reeds

{
  "title": "Not found",
  "status": 404,
  "detail": "Source: Er bestaat al een woning met gelijkaardige gegevens.",
  "instance": "e24aff4c-2df9-458c-8bb8-fbe71c745df6"
}

Woning bestaat reeds binnen uw patrimonium

{
  "title": "Not found",
  "status": 404,
  "detail": "Source: Er bestaat al een woning met gelijkaardige gegevens binnen uw patrimonium.",
  "instance": "e24aff4c-2df9-458c-8bb8-fbe71c745df6"
}

Response code 500 van WiV

Indien WiV een 500 terug geeft zal MAGDA een 502 terug geven aan de afnemer. In de payload van WiV zit enkel een message welke wordt overgenomen in het detail element, voorafgegaan door “Source: “.

{
  "title": "Bad Gateway",
  "status": 502,
  "detail": "Source: Internal server error",
  "instance": "e24aff4c-2df9-458c-8bb8-fbe71c745df6"
}