API CombiUitvoering

Uit DSP
Versie door Bjorn.ampting (Overleg | bijdragen) op 18 jan 2021 om 19:21 (Berichtdefinitie (WSDL))

Ga naar: navigatie, zoeken

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 (Voor LIP Aanvragen het 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 door technisch beheer ingericht te zijn op de API. De inrichting + bijbehorende login-gegevens kunnen worden aangevraagd via de service desk.

Berichtdefinitie 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) te downloaden op CombiUitvoering.wsdl