API CombiUitvoering: verschil tussen versies
| (15 tussenliggende versies door 2 gebruikers niet weergegeven) | |||
| Regel 1: | Regel 1: | ||
| − | Voor | + | Voor de recente informatie voor het aangeven van mee in combi gaan zie https://services.dsplatform.nl/api/capo/documentation/#/combiuitvoering |
| − | + | '''Onderstaande wordt niet meer gebruikt.''' | |
| − | * ClusterID (Aanvraagnummer, String) | + | ---- |
| + | |||
| + | Voor CAPO was 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 kon de netbeheerder via de API een bericht aan CAPO te sturen met daarin: | ||
| + | |||
| + | * ClusterID (Voor LIP Aanvragen het Aanvraagnummer, String) | ||
* Organisatiecode (Netbeheerder, String) | * Organisatiecode (Netbeheerder, String) | ||
* IsCombiUitvoering (Wel of niet in combi, Boolean (0/1)) | * IsCombiUitvoering (Wel of niet in combi, Boolean (0/1)) | ||
| − | Hiermee wordt de Aanvraag in CAPO | + | 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: | De XML opbouw van het bericht: | ||
| − | < | + | <pre> |
| − | |||
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:com="http://mijnaansluiting.nl/combi"> | <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:com="http://mijnaansluiting.nl/combi"> | ||
<soapenv:Header/> | <soapenv:Header/> | ||
| Regel 23: | Regel 34: | ||
</soapenv:Body> | </soapenv:Body> | ||
</soapenv:Envelope> | </soapenv:Envelope> | ||
| + | </pre> | ||
| − | + | ==Berichtdefinitie (WSDL)== | |
| − | De volledige berichtdefinitie (WSDL) is te | + | De volledige berichtdefinitie (WSDL) is te downloaden op [https://s3.eu-central-1.amazonaws.com/wiki.dsplatform.nl/CombiUitvoering.wsdl CombiUitvoering.wsdl] |
Huidige versie van 7 apr 2022 om 06:37
Voor de recente informatie voor het aangeven van mee in combi gaan zie https://services.dsplatform.nl/api/capo/documentation/#/combiuitvoering
Onderstaande wordt niet meer gebruikt.
Voor CAPO was 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 kon 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
