Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Algemeen
XSD Visueel
Detail
Note |
---|
Opmerking:Het antwoord bestaat standaard uit Context, Referte en Antwoord zoals beschreven in het document Gebruik Magda Webservices 02.00. Verder zal enkel aandacht besteed worden aan het specifieke Antwoord element. |
Antwoord in detail
Element
Opmerkingen
Voorbeeld
title | Voorbeeld |
---|
language | xml |
---|
Opmerkingen
Codetabellen Antwoord
Element-Naam
Code
Omschrijving
Element-Naam
Code
Algemeen
Afhankelijk van welke waarde in de Bron header parameter wordt ingevuld en de bijhorende waarden worden ingevuld in de payload zullen verschillende acties worden uitgevoerd. Het antwoord bevat een status code 200 indien de registratie gelukt is. Elke andere code duist op een niet geslaagde registratie.
Opgelet : voor onderstaande verwerking gedaan wordt moet aan de request validatieregels voldaan zijn!
Bron header param | Payload voorwaarde | Actie |
---|---|---|
STAT | N/A |
|
SUB | agent.Identificatie |
|
agent.VOPNumber |
| |
SUBSTAT | agent.Identificatie |
|
Succesvol antwoord
Indien de validatie van de request data en de verwerking zoals hierboven omschreven slaagt zal een response code 201 “Created” worden teruggegeven. Er is geen payload aanwezig.
Foutmeldingen
Info |
---|
Details over de foutmeldingen van de MAGDA REST services is te vinden op Overzicht uitzonderingen RESTful-services |
Indien de registratie of validatie niet slaagt zal een status code verschillend van 201 “Created” worden teruggegeven
Indien een validatie van de aangeleverde data niet slaagt zal een status 400 worden teruggegeven met de bijhorende Description in de ErrorMessage in de payload. Zie de Vraag pagina voor de verschillende meldingen.
Andere foutcodes zijn mogelijk zoals omschreven op Overzicht uitzonderingen RESTful-services
Voorbeeld
Code Block |
---|
{
"title": "Bad request",
"status": "400",
"detail": "Een VOPnummer kan enkel meegegeven worden met bron SUB"
} |
Op deze pagina
Table of Contents | ||
---|---|---|
|
Binnen deze handleiding
Onderliggende pagina’s van deze dienst
Info |
---|
Met vragen kunt u steeds terecht bij de MAGDA Service Desk. |