Hier werden die Unterschiede zwischen zwei Versionen angezeigt.
| de:soapmore [2014/02/03 16:07] – angelegt 192.168.0.48 | de:soapmore [2014/03/17 16:02] (aktuell) – gelöscht sw | ||
|---|---|---|---|
| Zeile 1: | Zeile 1: | ||
| - | ====== getUserData ====== | ||
| - | This API provides you with stored user data. | ||
| - | |||
| - | ===== Syntax ===== | ||
| - | |||
| - | <code delphi> | ||
| - | |||
| - | ==== Parameter ==== | ||
| - | === userIdentification === | ||
| - | {{section> | ||
| - | |||
| - | === userDataParts (optional)=== | ||
| - | |//array// | An array with a data part name (see below) as key and a boolean defines whether the part should be returned (< | ||
| - | Configures which data parts should be returned. Every data part will be returned is set as a default. | ||
| - | Possible data parts: | ||
| - | ^Data part name^Description ^ | ||
| - | |userDetails |if false the returned userDetails (gender, | ||
| - | |selectedNewsletter |if false the returned selectedNewsletter (the newsletter the user has subscribed to) is null | | ||
| - | |newsletterList |if false, the returned newsletterList (all available Newsletter from your client) is null | | ||
| - | |selectedBlocklists |if false, the returned selectedBlocklist (the blocklist the user was subscribed to) is null | | ||
| - | |blocklistList |if false, the returned blocklistList (all available blocklists from your client) is null | | ||
| - | |holiday | | | ||
| - | |||
| - | |||
| - | ==== Return ==== | ||
| - | An array with the following data fields and the selected data parts as key and the corresponding users data as value. The value type depends on the data part | ||
| - | |||
| - | ^Key^Value^Description^ | ||
| - | |mail |//string// | | | ||
| - | |userId |// | ||
| - | |newsletterId |// | ||
| - | |userDetails |//array// or < | ||
| - | |selectedNewsletter|// | ||
| - | |newsletterList|// | ||
| - | |selectedBlocklists|// | ||
| - | |blocklistList|// | ||
| - | |holiday|// | ||
| - | |||
| - | |||
| - | |||
| - | ===== Errors ===== | ||
| - | * [[de: | ||
| - | * [[de: | ||
| - | * [[de: | ||
| - | |||
| - | |||
| - | ===== Examples ===== | ||
| - | ==== Soap ==== | ||
| - | === PHP === | ||
| - | == Call == | ||
| - | |||
| - | {{section> | ||
| - | |||
| - | <code php> | ||
| - | $userDataParts = array( " | ||
| - | | ||
| - | $mySoapClient = new SoapClient( " | ||
| - | $result = $mySoapClient-> | ||
| - | </ | ||
| - | |||
| - | == Returns == | ||
| - | <code php> | ||
| - | array(9) { | ||
| - | [" | ||
| - | string(23) " | ||
| - | [" | ||
| - | int(717985) | ||
| - | [" | ||
| - | int(123) | ||
| - | [" | ||
| - | NULL | ||
| - | [" | ||
| - | NULL | ||
| - | [" | ||
| - | NULL | ||
| - | [" | ||
| - | NULL | ||
| - | [" | ||
| - | NULL | ||
| - | [" | ||
| - | NULL | ||
| - | } | ||
| - | </ | ||
| - | |||
| - | === XML === | ||
| - | |||
| - | == Request == | ||
| - | {{section> | ||
| - | |||
| - | == Response == | ||
| - | <code xml> | ||
| - | <?xml version=" | ||
| - | < | ||
| - | < | ||
| - | < | ||
| - | < | ||
| - | < | ||
| - | </ | ||
| - | < | ||
| - | < | ||
| - | < | ||
| - | < | ||
| - | < | ||
| - | </ | ||
| - | </ | ||
| - | </ | ||
| - | </ | ||