API CombiUitvoering: verschil tussen versies

Versie van 18 jan 2021 om 18:48

Voor CAPO is een API beschikbaar waarmee de netbeheerder kan aangeven of een aanvraag wel of niet wordt uitgevoerd in de combi.

Daarvoor dient de netbeheerder via de API een bericht aan CAPO te sturen met daarin:

• ClusterID (Aanvraagnummer, String)
• Organisatiecode (Netbeheerder, String)
• IsCombiUitvoering (Wel of niet in combi, Boolean (0/1))

Hiermee wordt de Aanvraag in CAPO gemarkeerd.

Voordat de functionaliteit gebruikt kan worden dient een netbeheerder ingericht te zijn op de API. De inrichting + bijbehorende login-gegevens kunnen worden aangevraagd via de service desk.

XML

De XML opbouw van het bericht:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:com="http://mijnaansluiting.nl/combi">

  <soapenv:Header/>
  <soapenv:Body>
     <com:CombiUitvoeringbericht>
        <ClusterID>?</ClusterID>
        <OrganisatieCode>?</OrganisatieCode>
        <IsCombiUitvoering>?</IsCombiUitvoering>
     </com:CombiUitvoeringbericht>
  </soapenv:Body>

</soapenv:Envelope>

Berichtdefinitie (WSDL)

De volledige berichtdefinitie (WSDL) is te vinden op CombiUitvoering.wsdl