API CombiUitvoering: verschil tussen versies

Uit DSP
Ga naar: navigatie, zoeken
(Berichtdefinitie (WSDL))
Regel 32: Regel 32:
 
==Berichtdefinitie (WSDL)==
 
==Berichtdefinitie (WSDL)==
  
De volledige berichtdefinitie (WSDL) te downloaden op [https://s3.eu-central-1.amazonaws.com/wiki.dsplatform.nl/CombiUitvoering.wsdl CombiUitvoering.wsdl]
+
De volledige berichtdefinitie (WSDL) is te downloaden op [https://s3.eu-central-1.amazonaws.com/wiki.dsplatform.nl/CombiUitvoering.wsdl CombiUitvoering.wsdl]

Versie van 18 jan 2021 om 20:01

Voor CAPO is een API beschikbaar waarmee de netbeheerder kan aangeven of een aanvraag wel of niet wordt uitgevoerd in de combi. Dit is een alternatief voor het handmatig aangeven van 'Mee in Combi' in de UI bij de opties op de aanvragen ('Uw Projecten') in de CAPO Applicatie zelf.

Hiermee kan 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 geregistreerd.

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