XML-RPC: Difference between revisions
(XMLRPC spec versie 10 + 1e aanzet versie 11 geplaatst) |
(XML-RPC server versie 13 beschreven) |
||
Line 34: | Line 34: | ||
== Technische omschrijving == | == Technische omschrijving == | ||
<pre> | <pre> | ||
2012.05. | 2012.05.14 HaVe | ||
XML-RPC Hobbynet versie | XML-RPC Hobbynet versie 12. | ||
// XML-RPC beschrijving van acties in hcc.nl LDAP database // | // XML-RPC beschrijving van acties in hcc.nl LDAP database // | ||
Line 64: | Line 64: | ||
array('beheerPassword', $beheerPassword), | array('beheerPassword', $beheerPassword), | ||
[array('hccLidnr', $hccLidnr),] | [array('hccLidnr', $hccLidnr),] | ||
[array('hccLogin', $hccLogin)])); | [array('hccLogin', $hccLogin),] | ||
[array('hccPseudoniem', $hccPseudoniem)]))); | |||
Output positief: | Output positief: | ||
$reply = array('HCCldap', | $reply = array('HCCldap', | ||
Line 72: | Line 74: | ||
array('hccLidnr', $hccLidnr), | array('hccLidnr', $hccLidnr), | ||
array('hccLogin', $hccLogin), | array('hccLogin', $hccLogin), | ||
array('hccPseudoniem', $hccPseudoniem), | |||
array('DBFPersoonID', $DBFPersoonID), | |||
array('cn', $cn), | array('cn', $cn), | ||
array('sn', $sn), | array('sn', $sn), | ||
Line 77: | Line 81: | ||
array('hccIG', $hccIG), | array('hccIG', $hccIG), | ||
array('hccRol', $hccRol), | array('hccRol', $hccRol), | ||
array('ProfielBekend', 'TRUE' / 'FALSE' ); | array('ProfielBekend', 'TRUE' / 'FALSE')); | ||
Output negatief: | Output negatief: | ||
$reply = array('HCCldap', | $reply = array('HCCldap', | ||
Line 123: | Line 127: | ||
[array('hccLidnr', $hccLidnr),] | [array('hccLidnr', $hccLidnr),] | ||
[array('hccLogin', $hccLogin),] | [array('hccLogin', $hccLogin),] | ||
array('nieuw_userPassword', $nieuw_userPassword), | |||
[array('nieuw_hccPseudoniem', $nieuw_hccPseudoniem)]))); | |||
// ** t.b.v. profielpagina van bestaande leden ** | |||
// 2.4 wijzig wachtwoord - optie 4 | |||
// (t.b.v. Drupal profiel-pagina) | |||
// (authenticatie op basis van hccPseudoniem en userPassword) | |||
// ** Deze aanpassingen worden doorgezet naar hccnet.nl (action=2) ** | |||
$request = xmlrpc_encode_request('HCCldap', | |||
array('WijzigGebruikersGegevens', | |||
array('hccPseudoniem', $hccPseudoniem), | |||
array('userPassword', $userPassword), | |||
array('nieuw_userPassword', $nieuw_userPassword))); | array('nieuw_userPassword', $nieuw_userPassword))); | ||
Output positief: | Output positief: | ||
$reply = array('HCCldap', | $reply = array('HCCldap', | ||
Line 168: | Line 185: | ||
array('nieuw_Achternaam', $nieuw_Achternaam), | array('nieuw_Achternaam', $nieuw_Achternaam), | ||
array('nieuw_hccRegio', $nieuw_hccRegio), | array('nieuw_hccRegio', $nieuw_hccRegio), | ||
[array('nieuw_hccIG', $nieuw_hccIG),] | [array('nieuw_hccIG', $nieuw_hccIG),] // komma-gescheiden lijst | ||
[array('nieuw_hccRol', $nieuw_hccRol)] | [array('nieuw_hccRol', $nieuw_hccRol),] // komma-gescheiden lijst | ||
[array('nieuw_hccPseudoniem', $nieuw_hccPseudoniem)])); | |||
Output positief: | Output positief: | ||
Line 185: | Line 203: | ||
array('Status', 'FALSE'), | array('Status', 'FALSE'), | ||
array('Message', 'Gegevenscombinatie onjuist')); | array('Message', 'Gegevenscombinatie onjuist')); | ||
// ** t.b.v. Cronjob ** | // ** t.b.v. Cronjob ** | ||
Line 196: | Line 213: | ||
array('beheerLogin', $beheerLogin), | array('beheerLogin', $beheerLogin), | ||
array('beheerPassword', $beheerPassword), | array('beheerPassword', $beheerPassword), | ||
[array('verwijder_hccLidnr', $verwijder_hccLidnr) | [array('verwijder_hccLidnr', $verwijder_hccLidnr))); | ||
Output positief: | Output positief: | ||
$reply = array('HCCldap', | $reply = array('HCCldap', | ||
Line 212: | Line 228: | ||
array('Status', 'FALSE'), | array('Status', 'FALSE'), | ||
array('Message', 'Gegevenscombinatie onjuist')); | array('Message', 'Gegevenscombinatie onjuist')); | ||
// ** t.b.v. Cronjob ** | // ** t.b.v. Cronjob ** | ||
Line 226: | Line 241: | ||
array('beheerPassword', $beheerPassword), | array('beheerPassword', $beheerPassword), | ||
[array('hccLidnr', $hccLidnr),] | [array('hccLidnr', $hccLidnr),] | ||
[array('nieuw_hccIG', $nieuw_hccIG)])); // komma-gescheiden lijst | [array('nieuw_hccIG', $nieuw_hccIG)])); // komma-gescheiden lijst | ||
Output positief: | Output positief: | ||
Line 242: | Line 256: | ||
array('Status', 'FALSE'), | array('Status', 'FALSE'), | ||
array('Message', 'Gegevenscombinatie onjuist')); | array('Message', 'Gegevenscombinatie onjuist')); | ||
// ** t.b.v. Cronjob ** | // ** t.b.v. Cronjob ** | ||
Line 255: | Line 268: | ||
array('beheerPassword', $beheerPassword), | array('beheerPassword', $beheerPassword), | ||
[array('hccLidnr', $hccLidnr),] | [array('hccLidnr', $hccLidnr),] | ||
array('nieuw_hccRegio', $nieuw_hccRegio))); | array('nieuw_hccRegio', $nieuw_hccRegio))); | ||
Output positief: | Output positief: | ||
Line 271: | Line 283: | ||
array('Status', 'FALSE'), | array('Status', 'FALSE'), | ||
array('Message', 'Gegevenscombinatie onjuist')); | array('Message', 'Gegevenscombinatie onjuist')); | ||
// ** t.b.v. Cronjob ** | // ** t.b.v. Cronjob ** | ||
Line 285: | Line 296: | ||
array('beheerPassword', $beheerPassword), | array('beheerPassword', $beheerPassword), | ||
[array('hccLidnr', $hccLidnr),] | [array('hccLidnr', $hccLidnr),] | ||
[array('nieuw_hccRol', $nieuw_hccRol)])); | [array('nieuw_hccRol', $nieuw_hccRol)])); | ||
Output positief: | Output positief: | ||
Line 301: | Line 311: | ||
array('Status', 'FALSE'), | array('Status', 'FALSE'), | ||
array('Message', 'Gegevenscombinatie onjuist')); | array('Message', 'Gegevenscombinatie onjuist')); | ||
// ** t.b.v. 1e keer doorlopen van de profielpagina ** | // ** t.b.v. 1e keer doorlopen van de profielpagina ** | ||
// 8.1 Maak nieuwe gebruiker bij hccnet.nl, en sla gebruikersnaam en wachtwoord tevens in LDAP op | // 8.1 Maak nieuwe gebruiker bij hccnet.nl, en sla gebruikersnaam, pseudoniem | ||
// en wachtwoord tevens in LDAP op | |||
// (authenticatie op basis van hcc lidnummer en hcc-code) | // (authenticatie op basis van hcc lidnummer en hcc-code) | ||
// ** Deze gegevens worden doorgezet naar hccnet.nl (action=4) ** | // ** Deze gegevens worden doorgezet naar hccnet.nl (action=4) ** | ||
// | |||
$request = xmlrpc_encode_request('HCCnet', | $request = xmlrpc_encode_request('HCCnet', | ||
array('MaakGebruikerAan', | array('MaakGebruikerAan', | ||
array('hccLidnr', $hccLidnr), | array('hccLidnr', $hccLidnr), | ||
array('hccCode', $hccCode), | array('hccCode', $hccCode), | ||
array('nieuw_hccLogin', $nieuw_hccLogin), | |||
array('nieuw_userPassword', $nieuw_userPassword), | |||
array('nieuw_hccPseudoniem', $nieuw_hccPseudoniem))); | |||
Output positief: | Output positief: | ||
$reply = array('HCCnet', | $reply = array('HCCnet', | ||
Line 327: | Line 339: | ||
array('Status', 'FALSE'), | array('Status', 'FALSE'), | ||
array('Message', 'Gebruikersnaam bestaat al')); | array('Message', 'Gebruikersnaam bestaat al')); | ||
$reply = array('HCCnet', | |||
array('Action', 'MaakGebruikerAan'), | |||
array('Status', 'FALSE'), | |||
array('Message', 'Pseudoniem bestaat al')); | |||
$reply = array('HCCnet', | |||
array('Action', 'MaakGebruikerAan'), | |||
array('Status', 'FALSE'), | |||
array('Message', 'Gegevenscombinatie onjuist')); | |||
// ** t.b.v. 1e keer doorlopen van de profielpagina ** | // ** t.b.v. 1e keer doorlopen van de profielpagina ** | ||
Line 348: | Line 367: | ||
array('Message', 'Gebruikersnaam bestaat al')); | array('Message', 'Gebruikersnaam bestaat al')); | ||
// ** t.b.v. 1e keer doorlopen van de profielpagina ** | |||
// 8.3 Controleer of een Pseudoniem op dit moment bestaat | |||
// (geen authenticatie) | |||
// ** Het betreft een momentopname, de naam wordt niet gereserveerd! ** | |||
$request = xmlrpc_encode_request('HCCnet', | |||
array('IsDezePseudoniemNogBeschikbaar', | |||
array('nieuw_hccPseudoniem', $nieuw_hccPseudoniem)); | |||
Output positief: | |||
$reply = array('HCCnet', | |||
array('Action', 'IsDezePseudoniemNogBeschikbaar'), | |||
array('Status', 'TRUE'), | |||
array('Message', 'Pseudoniem is nog beschikbaar')); | |||
Output negatief: | |||
$reply = array('HCCnet', | |||
array('Action', 'IsDezePseudoniemNogBeschikbaar'), | |||
array('Status', 'FALSE'), | |||
array('Message', 'Pseudoniem bestaat al')); | |||
// ** t.b.v. de PC30 zoekpagina ** | // ** t.b.v. de PC30 zoekpagina ** | ||
Line 357: | Line 393: | ||
array('beheerLogin', $beheerLogin), | array('beheerLogin', $beheerLogin), | ||
array('beheerPassword', $beheerPassword), | array('beheerPassword', $beheerPassword), | ||
[array('hccLidnr', $hccLidnr)], | |||
[array('hccLogin', $hccLogin)], | |||
[array('achternaam', $achternaam)], | |||
[array('postcode', $postcode)], | |||
[array('emailAdres', $emailAdres)], | |||
[array('ZoekLimiet' $ZoekLimiet)); | [array('ZoekLimiet' $ZoekLimiet)); | ||
Output positief: | Output positief: | ||
Line 368: | Line 404: | ||
array('Status', 'TRUE'), | array('Status', 'TRUE'), | ||
array('Message', 'Gebruiker(s) gevonden'), | array('Message', 'Gebruiker(s) gevonden'), | ||
[array('ExtraInfo', ' | [array('ExtraInfo', 'Zoekopdracht afgebroken, Y van Z getoond')], | ||
array('Results', | |||
[array('Result', | |||
array( 'hccLidnummer', $hccLidnummer, | |||
'sn', $sn, | |||
'hccStraatnaam', $hccStraatnaam, | |||
'hccHuisnummer', $hccHuisnummer $huisToevoeging, | |||
'hccPostcode', $hccPostcode, | |||
'hccWoonplaats', $hccWoonplaats, | |||
'hccLand', $hccLand, | |||
'hccTelefoon', $hccTelefoon, | |||
'mail', $mail, | |||
'hccIG', $hccIG, | |||
'hccLogin', $hccLogin, | |||
'hccPseudoniem', $hccPseudoniem))]*))); | |||
Output negatief: | Output negatief: | ||
$reply = array('HCCldap', | $reply = array('HCCldap', | ||
Line 388: | Line 430: | ||
// ** t.b.v. DBF GetDossier opvragingen ** | // ** t.b.v. DBF GetDossier opvragingen ** | ||
// B.1 Zoek het PersoonID (GUID) dat bij een | // B.1 Zoek het PersoonID (GUID) dat bij een gebruiker behoort | ||
$request = xmlrpc_encode_request('HCCldap', | $request = xmlrpc_encode_request('HCCldap', | ||
array('GeefDBFPersoonID', | array('GeefDBFPersoonID', | ||
array('beheerLogin', $beheerLogin), | array('beheerLogin', $beheerLogin), | ||
array('beheerPassword', $beheerPassword), | array('beheerPassword', $beheerPassword), | ||
[array('hccLidnr', $hccLidnr),] | |||
[array('hccLogin', $hccLogin),] | |||
[array('hccPseudoniem', $hccPseudoniem)]))); | |||
Output positief: | Output positief: | ||
$reply = array('HCCldap', | $reply = array('HCCldap', | ||
Line 411: | Line 455: | ||
// ** t.b.v. daily cron job ** | // ** t.b.v. daily cron job ** | ||
// C.1 Vraag de lijst met opgeheven | // C.1 Vraag de lijst met opgeheven leden op | ||
// Antwoord: lijst met (lidnummer , datum einde lidmaatschap (formaat:YYYYMMDD)) | // Antwoord: lijst met (lidnummer, hccLogin, hccPseudoniem, | ||
// datum einde lidmaatschap (formaat:YYYYMMDD)) | |||
$request = xmlrpc_encode_request('HCCldap', | $request = xmlrpc_encode_request('HCCldap', | ||
array('GeefOpgezegdeLeden', | array('GeefOpgezegdeLeden', | ||
Line 422: | Line 467: | ||
array('Status', TRUE'), | array('Status', TRUE'), | ||
array('Message', 'Opgezegde leden'), | array('Message', 'Opgezegde leden'), | ||
array('Results', | |||
[array('Result', | |||
array( 'hccLidnummer', $hccLidnummer, | |||
'sn', $sn, | |||
'hccPseudoniem', $hccPseudoniem, | |||
'DatumEindeLidmaatschap', $DatumEindeLidmaatschap))]*))); | |||
Output negatief: | Output negatief: | ||
$reply = array('HCCldap', | $reply = array('HCCldap', | ||
Line 519: | Line 568: | ||
- nieuwe procedure t.b.v. cron-job | - nieuwe procedure t.b.v. cron-job | ||
* C.1 GeefOpgezegdeLeden | * C.1 GeefOpgezegdeLeden | ||
2012.05. | 2012.05.10 Wijzigingen versie 11 | ||
- A.1 'Zoeklimiet bereikt' | - 1.3 GebruikerBestaatControle | ||
* nieuwe parameter: hccPseudoniem | |||
* nieuw veld in antwoord: hccPseudoniem | |||
- 2.3 WijzigGebruikersGegevens | |||
* nieuwe parameter: hccPseudoniem | |||
- 2.4 WijzigGebruikersGegevens | |||
* nieuwe parameter: hccPseudoniem | |||
- 3.1 NieuweGebruiker | |||
* nieuwe parameter: hccPseudoniem | |||
- 8.1 MaakGebruikerAan | |||
* nieuwe parameter: nieuw_hccPseudoniem | |||
* alle parameters zijn verplicht (niet langer optioneel) | |||
* nieuw antwoord: Gegevenscombinatie onjuist | |||
- 8.3 IsDezePseudoniemNogBeschikbaar | |||
* Nieuwe procedure t.b.v. 1e keer doorlopen profielpagina | |||
- A.1 ZoekHCCLid | |||
* 'Zoeklimiet bereikt' wordt als ExtraInfo meegegeven | |||
* nieuwe velden in antwoord: hccPseudoniem en hccLogin | |||
- B.1 GeefDBFPersoonID | |||
* Zoeken kan nu ook op hccLogin en op hccPseudoniem | |||
- C.1 GeefOpgezegdeLeden | |||
* Geef nu ook hccLogin en hccPseudoniem terug | |||
2012.05.14 Wijzigingen versie 12 | |||
- 1.x GebruikerBestaatControle | |||
* Geef ook DBFPersoonID terug | |||
- 4.1 Gooi een gebruiker weg. | |||
* Haal ongebruikte parameter hccLogin weg | |||
- 5.1 Wijzig hccIG | |||
* Haal ongebruikte parameter hccLogin weg | |||
- 6.1 Wijzig hccRegio | |||
* Haal ongebruikte parameter hccLogin weg | |||
- 7.1 Wijzig hccRol | |||
* Haal ongebruikte parameter hccLogin weg | |||
2012.05.20 Wijzigingen versie 13 | |||
- A.1 ZoekHCCLid | |||
* Geef resultaten gestructureerder formaat | |||
* Geef in ExtraInfo weer hoeveel echte resultaten er gevonden zijn | |||
- C.1 GeefOpgezegdeLeden | |||
* Geef resultaten in gestructureerder formaat | |||
</pre> | </pre> | ||
Revision as of 14:15, 20 May 2012
XML-RPC interface
De LDAP server kan direct gemuteerd worden via een LDAP koppeling. Zie de standaard LDAP pagina voor de uitleg welke poorten daarvoor gebruikt kunnen worden.
Daarnaast is er de wens ontstaan om via een standaard protocol met de LDAP omgeving te kunnen communiceren. Er is hiertoe een XML-RPC koppeling ontwikkeld. XML-RPC is een standaard interface, waarmee het mogelijk is om vanuit diverse omgevingen op een gestandaardiseerde manier te communiceren.
Globale functie omschrijving
- Controleer of een gebruiker bestaat
- Wijzig het wachtwoord ('userPassword') en/of de gebruikersnaam ('hccLogin')
- Maak een nieuwe gebruiker
- Gooi een gebruiker weg
- Muteer een gebruiker ('hccIG', 'hccRegio', 'hccRol')
- Zoek een gebruiker
- Vertaal hcc lidnummer naar DBF PersoonID
- Haal de lijst met opgeheven accounts op
Authenticatie
Alle aanroepen gebeuren op basis van authenticatie vanuit de aanroeper. Dit valt uiteen in de volgende categorieën:
- gebruikersnaam ('hccLogin') en wachtwoord ('userPassword')
- hcc lidnummer ('hccLidnummer') en hcc code ('hccCode')
- beheerders-DN ('beheerLogin') en beheerders wachtwoord ('beheerPassword')
Resultaten
Alle aanroepen geven de volgende elementen terug:
- naam van de uitgevoerde procedure ('Action')
- resultaat van de uitgevoerde procedure ('Status')
- Een tekstuele vertaling van het resultaat dan wel de foutmelding ('Message')
- Tijdens de ontwikkelfase kan er debug-info teruggeleverd worden ('ExtraInfo')
Daarnaast geven specifieke aanroepen extra resultaten terug
Technische omschrijving
2012.05.14 HaVe XML-RPC Hobbynet versie 12. // XML-RPC beschrijving van acties in hcc.nl LDAP database // // 1.1 controleer of een gebruiker bestaat - optie 1 // (authenticatie op basis van hccLidnr en hccCode) $request = xmlrpc_encode_request('HCCldap', array('GebruikerBestaatControle', array('hccLidnr', $hccLidnr), array('hccCode', $hccCode))); // 1.2 controleer of een gebruiker bestaat - optie 2 // (authenticatie op basis van hccLogin en userPassword) $request = xmlrpc_encode_request('HCCldap', array('GebruikerBestaatControle', array('hccLogin', $hccLogin), array('userPassword', $userPassword))); // 1.3 controleer of een gebruiker bestaat - optie 3 // (t.b.v. PC30 portal) // (authenticatie op basis van beheerdernaam en beheerderwachtwoord) // * Als hccLidnr gevuld is, dan wordt hccLidnr gebruikt om het juiste record te zoeken // Als hccLidnr leeg is, dan wordt hccLogin gebruikt om het juiste record te zoeken // 1 van beide velden MOET aanwezig zijn $request = xmlrpc_encode_request('HCCldap', array('GebruikerBestaatControle', array('beheerLogin', $beheerLogin), array('beheerPassword', $beheerPassword), [array('hccLidnr', $hccLidnr),] [array('hccLogin', $hccLogin),] [array('hccPseudoniem', $hccPseudoniem)]))); Output positief: $reply = array('HCCldap', array('Action', 'GebruikerBestaatControle'), array('Status', 'TRUE'), array('Message', 'Gebruikersgegevens opgevraagd'), array('hccLidnr', $hccLidnr), array('hccLogin', $hccLogin), array('hccPseudoniem', $hccPseudoniem), array('DBFPersoonID', $DBFPersoonID), array('cn', $cn), array('sn', $sn), array('hccRegio', $hccRegio), array('hccIG', $hccIG), array('hccRol', $hccRol), array('ProfielBekend', 'TRUE' / 'FALSE')); Output negatief: $reply = array('HCCldap', array('Action', 'GebruikerBestaatControle'), array('Status', 'FALSE'), array('Message', 'Onjuiste credentials')); $reply = array('HCCldap', array('Action', 'GebruikerBestaatControle'), array('Status', 'FALSE'), array('Message', 'Gegevenscombinatie onjuist')); // 2.1 wijzig wachtwoord - optie 1 // op basis van hccLidnummer en hccCode (t.b.v. wachtwoord-vergeten procedure) // (authenticatie op basis van hccLidnr en hccCode) // Als de profielpagina nog niet is doorlopen wordt deze aanroep afgekeurd. // ** Deze aanpassingen worden doorgezet naar hccnet.nl (action=2) ** $request = xmlrpc_encode_request('HCCldap', array('WijzigGebruikersGegevens', array('hccLidnr', $hccLidnr), array('hccCode', $hccCode), array('nieuw_userPassword', $nieuw_userPassword))); // ** t.b.v. profielpagina van bestaande leden ** // 2.2 wijzig wachtwoord - optie 2 // (t.b.v. profiel-pagina) // (authenticatie op basis van hccLogin en userPassword) // ** Deze aanpassingen worden doorgezet naar hccnet.nl (action=2) ** $request = xmlrpc_encode_request('HCCldap', array('WijzigGebruikersGegevens', array('hccLogin', $hccLogin), array('userPassword', $userPassword), array('nieuw_userPassword', $nieuw_userPassword))); // 2.3 wijzig wachtwoord - optie 3 // (t.b.v. PC30 portal) // (authenticatie op basis van beheerdernaam en beheerderwachtwoord) // * Als hccLidnr gevuld is, dan wordt hccLidnr gebruikt om het juiste record te zoeken // Als hccLidnr leeg is, dan wordt hccLogin gebruikt om het juiste record te zoeken // 1 van beide velden MOET aanwezig zijn // ** Deze aanpassingen worden doorgezet naar hccnet.nl (action=2) ** $request = xmlrpc_encode_request('HCCldap', array('WijzigGebruikersGegevens', array('beheerLogin', $beheerLogin), array('beheerPassword', $beheerPassword), [array('hccLidnr', $hccLidnr),] [array('hccLogin', $hccLogin),] array('nieuw_userPassword', $nieuw_userPassword), [array('nieuw_hccPseudoniem', $nieuw_hccPseudoniem)]))); // ** t.b.v. profielpagina van bestaande leden ** // 2.4 wijzig wachtwoord - optie 4 // (t.b.v. Drupal profiel-pagina) // (authenticatie op basis van hccPseudoniem en userPassword) // ** Deze aanpassingen worden doorgezet naar hccnet.nl (action=2) ** $request = xmlrpc_encode_request('HCCldap', array('WijzigGebruikersGegevens', array('hccPseudoniem', $hccPseudoniem), array('userPassword', $userPassword), array('nieuw_userPassword', $nieuw_userPassword))); Output positief: $reply = array('HCCldap', array('Action', 'WijzigGebruikersGegevens'), array('Status', 'TRUE'), array('Message', 'Gebruikersgegevens gewijzigd'), array('cn', $cn), array('sn', $sn)); Output negatief: $reply = array('HCCldap', array('Action', 'WijzigGebruikersGegevens'), array('Status', 'FALSE'), array('Message', 'Onjuiste credentials')); $reply = array('HCCldap', array('Action', 'WijzigGebruikersGegevens'), array('Status', 'FALSE'), array('Message', 'Gegevenscombinatie onjuist')); / ** t.b.v. Cronjob ** // 3.1 Creer een nieuwe gebruiker. Per lidnummer is er 1 account. Als er al een // account voor dit lidnummer bestaat wordt het bestaande account hernoemd. // * nieuw_hccLogin mag ontbreken (of leeg gelaten worden). // Dan wordt de inhoud van nieuw_hccLidnr ook in dat veld ingevuld. // * nieuw_userPassword mag ontbreken (of leeg gelaten worden). // Dan wordt de inhoud van nieuw_hccCode ook in dat veld ingevuld. // * 'cn' en 'sn' worden aangemaakt aan de hand van nieuw_Voorletters, nieuw_Tussenvoegsel en nieuw_Achternaam. // Voorbeeld: // nieuw_Voorletters ='T.' // nieuw_Tussenvoegsel = 'van' // nieuw_Achternaam = 'Test' // => cn='T. van Test', sn='Test,T van' // * nieuw_hccIG mag ontbreken (of leeg gelaten worden). // * nieuw_hccRol mag ontbreken (of leeg gelaten worden). $request = xmlrpc_encode_request('HCCldap', array('NieuweGebruiker', array('beheerLogin', $beheerLogin), array('beheerPassword', $beheerPassword), array('nieuw_hccLidnr', $nieuw_hccLidnr), [array('nieuw_hccLogin', $nieuw_hccLogin),] [array('nieuw_userPassword', $nieuw_userPassword),] array('nieuw_hccCode', $nieuw_hccCode), [array('nieuw_Voorletters', $nieuw_Voorletters),] [array('nieuw_Tussenvoegsel', $nieuw_Tussenvoegsel),] array('nieuw_Achternaam', $nieuw_Achternaam), array('nieuw_hccRegio', $nieuw_hccRegio), [array('nieuw_hccIG', $nieuw_hccIG),] // komma-gescheiden lijst [array('nieuw_hccRol', $nieuw_hccRol),] // komma-gescheiden lijst [array('nieuw_hccPseudoniem', $nieuw_hccPseudoniem)])); Output positief: $reply = array('HCCldap', array('Action', 'NieuweGebruiker'), array('Status', 'TRUE'), array('Message', 'Gebruiker aangemaakt')); Output negatief: $reply = array('HCCldap', array('Action', 'NieuweGebruiker'), array('Status', 'FALSE'), array('Message', 'Onjuiste credentials')); $reply = array('HCCldap', array('Action', 'NieuweGebruiker'), array('Status', 'FALSE'), array('Message', 'Gegevenscombinatie onjuist')); // ** t.b.v. Cronjob ** // 4.1 Gooi een gebruiker weg. // * Als verwijder_hccLidnr gevuld is, dan wordt verwijder_hccLidnr gebruikt om het juiste record te zoeken // Als verwijder_hccLidnr leeg is, dan wordt verwijder_hccLogin gebruikt om het juiste record te zoeken // 1 van beide velden MOET aanwezig zijn $request = xmlrpc_encode_request('HCCldap', array('GooiGebruikerWeg', array('beheerLogin', $beheerLogin), array('beheerPassword', $beheerPassword), [array('verwijder_hccLidnr', $verwijder_hccLidnr))); Output positief: $reply = array('HCCldap', array('Action', 'GooiGebruikerWeg'), array('Status', 'TRUE'), array('Message', 'Gebruiker verwijderd')); Output negatief: $reply = array('HCCldap', array('Action', 'GooiGebruikerWeg'), array('Status', 'FALSE'), array('Message', 'Onjuiste credentials')); $reply = array('HCCldap', array('Action', 'GooiGebruikerWeg'), array('Status', 'FALSE'), array('Message', 'Gegevenscombinatie onjuist')); // ** t.b.v. Cronjob ** // 5.1 Wijzig hccIG // * Als hccLidnr gevuld is, dan wordt hccLidnr gebruikt om het juiste record te zoeken // Als hccLidnr leeg is, dan wordt hccLogin gebruikt om het juiste record te zoeken // 1 van beide velden MOET aanwezig zijn // * nieuw_hccIG is een komma-gescheiden lijst. // Als deze lijst leeg is (of ontbreekt), dan worden alle bestaande hccIG records van dit lid weggegooid. $request = xmlrpc_encode_request('HCCldap', array('WijzigHccIG', array('beheerLogin', $beheerLogin), array('beheerPassword', $beheerPassword), [array('hccLidnr', $hccLidnr),] [array('nieuw_hccIG', $nieuw_hccIG)])); // komma-gescheiden lijst Output positief: $reply = array('HCCldap', array('Action', 'WijzigHccIG'), array('Status', 'TRUE'), array('Message', 'hccIG gewijzigd')); Output negatief: $reply = array('HCCldap', array('Action', 'WijzigHccIG'), array('Status', 'FALSE'), array('Message', 'Onjuiste credentials')); $reply = array('HCCldap', array('Action', 'WijzigHccIG'), array('Status', 'FALSE'), array('Message', 'Gegevenscombinatie onjuist')); // ** t.b.v. Cronjob ** // 6.1 Wijzig hccRegio // Pas bij een verhuizing de hccRegio aan // * Als hccLidnr gevuld is, dan wordt hccLidnr gebruikt om het juiste record te zoeken // Als hccLidnr leeg is, dan wordt hccLogin gebruikt om het juiste record te zoeken // 1 van beide velden MOET aanwezig zijn $request = xmlrpc_encode_request('HCCldap', array('WijzigHccRegio', array('beheerLogin', $beheerLogin), array('beheerPassword', $beheerPassword), [array('hccLidnr', $hccLidnr),] array('nieuw_hccRegio', $nieuw_hccRegio))); Output positief: $reply = array('HCCldap', array('Action', 'WijzigHccRegio'), array('Status', 'TRUE'), array('Message', 'hccRegio gewijzigd')); Output negatief: $reply = array('HCCldap', array('Action', 'WijzigHccRegio'), array('Status', 'FALSE'), array('Message', 'Onjuiste credentials')); $reply = array('HCCldap', array('Action', 'WijzigHccRegio'), array('Status', 'FALSE'), array('Message', 'Gegevenscombinatie onjuist')); // ** t.b.v. Cronjob ** // 7.1 Wijzig hccRol // * Als hccLidnr gevuld is, dan wordt hccLidnr gebruikt om het juiste record te zoeken // Als hccLidnr leeg is, dan wordt hccLogin gebruikt om het juiste record te zoeken // 1 van beide velden MOET aanwezig zijn // * nieuw_hccRol is een komma-gescheiden lijst. // Als deze lijst leeg is (of ontbreekt), dan worden alle bestaande hccRol records van dit lid weggegooid. $request = xmlrpc_encode_request('HCCldap', array('WijzigHccRol', array('beheerLogin', $beheerLogin), array('beheerPassword', $beheerPassword), [array('hccLidnr', $hccLidnr),] [array('nieuw_hccRol', $nieuw_hccRol)])); Output positief: $reply = array('HCCldap', array('Action', 'WijzigHccRol'), array('Status', 'TRUE'), array('Message', 'hccRol gewijzigd')); Output negatief: $reply = array('HCCldap', array('Action', 'WijzigHccRol'), array('Status', 'FALSE'), array('Message', 'Onjuiste credentials')); $reply = array('HCCldap', array('Action', 'WijzigHccRol'), array('Status', 'FALSE'), array('Message', 'Gegevenscombinatie onjuist')); // ** t.b.v. 1e keer doorlopen van de profielpagina ** // 8.1 Maak nieuwe gebruiker bij hccnet.nl, en sla gebruikersnaam, pseudoniem // en wachtwoord tevens in LDAP op // (authenticatie op basis van hcc lidnummer en hcc-code) // ** Deze gegevens worden doorgezet naar hccnet.nl (action=4) ** // $request = xmlrpc_encode_request('HCCnet', array('MaakGebruikerAan', array('hccLidnr', $hccLidnr), array('hccCode', $hccCode), array('nieuw_hccLogin', $nieuw_hccLogin), array('nieuw_userPassword', $nieuw_userPassword), array('nieuw_hccPseudoniem', $nieuw_hccPseudoniem))); Output positief: $reply = array('HCCnet', array('Action', 'MaakGebruikerAan'), array('Status', 'TRUE'), array('Message', 'Gebruiker aangemaakt')); Output negatief: $reply = array('HCCnet', array('Action', 'MaakGebruikerAan'), array('Status', 'FALSE'), array('Message', 'Onjuiste credentials')); $reply = array('HCCnet', array('Action', 'MaakGebruikerAan'), array('Status', 'FALSE'), array('Message', 'Gebruikersnaam bestaat al')); $reply = array('HCCnet', array('Action', 'MaakGebruikerAan'), array('Status', 'FALSE'), array('Message', 'Pseudoniem bestaat al')); $reply = array('HCCnet', array('Action', 'MaakGebruikerAan'), array('Status', 'FALSE'), array('Message', 'Gegevenscombinatie onjuist')); // ** t.b.v. 1e keer doorlopen van de profielpagina ** // 8.2 Controleer of de gebruikersnaam op dit moment bestaat // (geen authenticatie) // ** Deze gegevens worden opgevraagd bij hccnet.nl (action=3) ** // ** Het betreft een momentopname, de naam wordt niet gereserveerd! ** $request = xmlrpc_encode_request('HCCnet', array('IsDezeNaamNogBeschikbaar', array('nieuw_hccLogin', $nieuw_hccLogin)); Output positief: $reply = array('HCCnet', array('Action', 'IsDezeNaamNogBeschikbaar'), array('Status', 'TRUE'), array('Message', 'Gebruikersnaam is nog beschikbaar')); Output negatief: $reply = array('HCCnet', array('Action', 'IsDezeNaamNogBeschikbaar'), array('Status', 'FALSE'), array('Message', 'Gebruikersnaam bestaat al')); // ** t.b.v. 1e keer doorlopen van de profielpagina ** // 8.3 Controleer of een Pseudoniem op dit moment bestaat // (geen authenticatie) // ** Het betreft een momentopname, de naam wordt niet gereserveerd! ** $request = xmlrpc_encode_request('HCCnet', array('IsDezePseudoniemNogBeschikbaar', array('nieuw_hccPseudoniem', $nieuw_hccPseudoniem)); Output positief: $reply = array('HCCnet', array('Action', 'IsDezePseudoniemNogBeschikbaar'), array('Status', 'TRUE'), array('Message', 'Pseudoniem is nog beschikbaar')); Output negatief: $reply = array('HCCnet', array('Action', 'IsDezePseudoniemNogBeschikbaar'), array('Status', 'FALSE'), array('Message', 'Pseudoniem bestaat al')); // ** t.b.v. de PC30 zoekpagina ** // A.1 Zoek alle bij de query passende hcc leden // Het optionele veld ZoekLimiet past maximum aantal antwoorden aan // (maximaal tot de door de XML-RPC server ingebouwde limiet) $request = xmlrpc_encode_request('HCCldap', array('ZoekHCCLid', array('beheerLogin', $beheerLogin), array('beheerPassword', $beheerPassword), [array('hccLidnr', $hccLidnr)], [array('hccLogin', $hccLogin)], [array('achternaam', $achternaam)], [array('postcode', $postcode)], [array('emailAdres', $emailAdres)], [array('ZoekLimiet' $ZoekLimiet)); Output positief: $reply = array('HCCldap', array('Action', 'ZoekHCCLid'), array('Status', 'TRUE'), array('Message', 'Gebruiker(s) gevonden'), [array('ExtraInfo', 'Zoekopdracht afgebroken, Y van Z getoond')], array('Results', [array('Result', array( 'hccLidnummer', $hccLidnummer, 'sn', $sn, 'hccStraatnaam', $hccStraatnaam, 'hccHuisnummer', $hccHuisnummer $huisToevoeging, 'hccPostcode', $hccPostcode, 'hccWoonplaats', $hccWoonplaats, 'hccLand', $hccLand, 'hccTelefoon', $hccTelefoon, 'mail', $mail, 'hccIG', $hccIG, 'hccLogin', $hccLogin, 'hccPseudoniem', $hccPseudoniem))]*))); Output negatief: $reply = array('HCCldap', array('Action', 'ZoekHCCLid'), array('Status', 'FALSE'), array('Message', 'Gebruiker niet gevonden')); $reply = array('HCCldap', array('Action', 'ZoekHCCLid'), array('Status', 'FALSE'), array('Message', 'Onjuiste credentials')); // ** t.b.v. DBF GetDossier opvragingen ** // B.1 Zoek het PersoonID (GUID) dat bij een gebruiker behoort $request = xmlrpc_encode_request('HCCldap', array('GeefDBFPersoonID', array('beheerLogin', $beheerLogin), array('beheerPassword', $beheerPassword), [array('hccLidnr', $hccLidnr),] [array('hccLogin', $hccLogin),] [array('hccPseudoniem', $hccPseudoniem)]))); Output positief: $reply = array('HCCldap', array('Action', 'GeefDBFPersoonID'), array('Status', TRUE'), array('Message', Gebruiker gevonden'), array('DBFPersoonID', $DBFPersoonID)); Output negatief: $reply = array('HCCldap', array('Action', 'GeefDBFPersoonID'), array('Status', 'FALSE'), array('Message', 'Gebruiker niet gevonden')); $reply = array('HCCldap', array('Action', 'GeefDBFPersoonID'), array('Status', 'FALSE'), array('Message', 'Onjuiste credentials')); // ** t.b.v. daily cron job ** // C.1 Vraag de lijst met opgeheven leden op // Antwoord: lijst met (lidnummer, hccLogin, hccPseudoniem, // datum einde lidmaatschap (formaat:YYYYMMDD)) $request = xmlrpc_encode_request('HCCldap', array('GeefOpgezegdeLeden', array('beheerLogin', $beheerLogin), array('beheerPassword', $beheerPassword))); Output positief: $reply = array('HCCldap', array('Action', 'GeefOpgezegdeLeden'), array('Status', TRUE'), array('Message', 'Opgezegde leden'), array('Results', [array('Result', array( 'hccLidnummer', $hccLidnummer, 'sn', $sn, 'hccPseudoniem', $hccPseudoniem, 'DatumEindeLidmaatschap', $DatumEindeLidmaatschap))]*))); Output negatief: $reply = array('HCCldap', array('Action', 'GeefOpgezegdeLeden'), array('Status', 'FALSE'), array('Message', 'Onjuiste credentials')); // onbekende aanroep $request = xmlrpc_encode_request('HCCldap', array('OnbekendeAanroep', array('parameter', $iets))); Output negatief: $reply = array('HCCldap', array('Action', 'OnbekendeAanroep'), array('Status', 'FALSE'), array('Message', 'Opdracht onbekend'));
Overzicht van XML procedures die bij HenZ draaien (worden via de Hobbynet XML-RPC server afgehandeld)
Overzicht van XML procedures die bij HenZ draaien (worden via de Hobbynet XML-RPC server afgehandeld) - Action=1 controleer of een gebruiker bestaat op basis van hcclidnummer en de hash van de hcccode. (geen aparte interface definitie noodzakelijk, bestaat al lokaal in XML-RPC server) Zie 1.1: controleer of een gebruiker bestaat - optie 1 - Action=2 wijzig gebruikersnaam en wachtwoord op basis van hcclidnummer en de hash van de hcccode. (geen aparte interface definitie noodzakelijk, bestaat al lokaal in XML-RPC server) (XML-RPC server gaat de hccnet XML-call uitvoeren, zie 2.1, 2.2 en 2.3) - Action=3 controleer of een gebruikersnaam bestaat (XML-RPC server gaat de hccnet XML-call uitvoeren, zie 8.2) - Action=4 creer een nieuwe gebruiker. Per lidnummer is er 1 account. Als er al een account voor dit lidnummer bestaat wordt het bestaande account hernoemd. (XML-RPC server gaat de hccnet XML-call uitvoeren, zie 8.1) - Action=5 wijzig wachtwoord op basis van hcclidnummer en de hash van de hcccode. (geen aparte interface definitie noodzakelijk, bestaat al lokaal in XML-RPC server) (XML-RPC server gaat de hccnet XML-call uitvoeren, zie 2.1, 2.2 en 2.3)
Release notes
2012.02.08 Wijzigingen versie 5: - 4.1 verwijder_hcc_Lidnummer i.p.v. hcc_Lidnummer - 4.1 optionele extra parameter verwijder_hccLogin - Optionele parameters aangegeven - Vanwege de duidelijkheid de beheerLogin en beheerPassword velden bovenin de betreffende aanroepen gezet (De volgorde van de parameters is niet relevant, dus dit is geen interface-aanpassing) 2012.02.16 Wijzigingen versie 6: - 2.1/2.2/2.3 geef ook cn en sn terug na aanpassen van het wachtwoord - 3.1 geef cn en sn terug na aanmaken nieuwe gebruiker 2012.02.27 Wijzigingen versie 7: - Neem de XML interface van HenZ in deze XML-RPC server op 8.1 Maak nieuwe gebruiker bij hccnet.nl, en sla gegevens tevens in LDAP op - 2.1 wijzig wachtwoord - optie 1 * Nieuw wachtwoord is verplicht, niet optioneel * wijzigingen worden naar hccnet.nl doorgezet - 2.2 wijzig wachtwoord, optie 2 * Nieuw wachtwoord is verplicht, niet optioneel * gebruikersnaam kan niet meer via deze interface aangepast worden * wijzigingen worden naar hccnet.nl doorgezet - 2.3 wijzig wachtwoord, optie 3 * wijzigingen worden naar hccnet.nl doorgezet 2012.03.26 Wijzigingen versie 8: - Breidt de XML interface van HenZ in deze XML-RPC server uit met 8.2 Controleer of de gebruikersnaam op dit moment bestaat 2012.04.09 Wijzigingen versie 9: - Vervang alle 'ldap' aanroepen door 'HCCldap' aanroepen - documentatie van HenZ call action=2 aangepast, action=5 toegevoegd 2012.05.03 Wijzigingen versie 10: - 1.1 / 1.2 / 1.3 geven nu ook 'ProfielBekend' terug om uniek te bepalen of deze bezoeker een first-time-login pagina te zien dient te krijgen - documentatie van 2.1 (wijzig wachtwoord) aangepast: 2.1 kan alleen als profiel is doorlopen - nieuwe procedure t.b.v. zoekscherm PC30 * A.1 ZoekHCCLid - hiervoor is de database met diverse velden uitgebreid (postcode, e-mailadres, huisadres, woonplaats, land, telefoonnummer) Dit heeft impact op diverse andere procedures (t.b.s.) - nieuwe procedure t.b.v. 'gewone' profielpagina * B.1 GeefDBFPersoonID - nieuwe procedure t.b.v. cron-job * C.1 GeefOpgezegdeLeden 2012.05.10 Wijzigingen versie 11 - 1.3 GebruikerBestaatControle * nieuwe parameter: hccPseudoniem * nieuw veld in antwoord: hccPseudoniem - 2.3 WijzigGebruikersGegevens * nieuwe parameter: hccPseudoniem - 2.4 WijzigGebruikersGegevens * nieuwe parameter: hccPseudoniem - 3.1 NieuweGebruiker * nieuwe parameter: hccPseudoniem - 8.1 MaakGebruikerAan * nieuwe parameter: nieuw_hccPseudoniem * alle parameters zijn verplicht (niet langer optioneel) * nieuw antwoord: Gegevenscombinatie onjuist - 8.3 IsDezePseudoniemNogBeschikbaar * Nieuwe procedure t.b.v. 1e keer doorlopen profielpagina - A.1 ZoekHCCLid * 'Zoeklimiet bereikt' wordt als ExtraInfo meegegeven * nieuwe velden in antwoord: hccPseudoniem en hccLogin - B.1 GeefDBFPersoonID * Zoeken kan nu ook op hccLogin en op hccPseudoniem - C.1 GeefOpgezegdeLeden * Geef nu ook hccLogin en hccPseudoniem terug 2012.05.14 Wijzigingen versie 12 - 1.x GebruikerBestaatControle * Geef ook DBFPersoonID terug - 4.1 Gooi een gebruiker weg. * Haal ongebruikte parameter hccLogin weg - 5.1 Wijzig hccIG * Haal ongebruikte parameter hccLogin weg - 6.1 Wijzig hccRegio * Haal ongebruikte parameter hccLogin weg - 7.1 Wijzig hccRol * Haal ongebruikte parameter hccLogin weg 2012.05.20 Wijzigingen versie 13 - A.1 ZoekHCCLid * Geef resultaten gestructureerder formaat * Geef in ExtraInfo weer hoeveel echte resultaten er gevonden zijn - C.1 GeefOpgezegdeLeden * Geef resultaten in gestructureerder formaat
Aanpassingen aan de Apache omgeving
De XML-RPC server zal 'ergens' een bestand moeten kunnen vinden met de gebruikersnamen t.b.v. het authenticeren bij de LDAP-server.
Dit bestand wordt geplaatst in de map '/usr/local/hobbynet/etc'. Om dit vanuit Apache te mogen benaderen, dient een aanpassing aan php.ini gemaakt te worden:
/etc/php5/apache2/php.ini include_path = ".:/usr/share/php:/usr/share/pear:/usr/local/hobbynet/etc"
Aanpassingen in de firewall
Op de server waar de XML-RPC server staat, moeten enkele firewall aanpassingen gemaakt worden
- inkomend: sta TCP 443 toe vanaf het interne netwerk (www-prod, www-test), en vanaf eventuele andere plekken die we expliciet toe willen staan.
- uitgaand: sta TCP 443 naar service.hccnet.nl toe