Folgende SOAP-Methoden werden speziell für die Konfiguration und Auswertung von Profil-Pools bereitgestellt.
getAttributes
Attribute eines Pools auslesen
EvalanchePoolAttribute[] getAttributes (int pool_id)
Details
Parameter
- int pool_id: ID des Pools
Rückgabewert
- EvalanchePoolAttribute[]: Liste von Objekten mit folgenden Attributen:
- int id: ID der Attributoption
- string value: Anzeigenname der Attributoption
- int type_id: ID des Typs des Attributes. Mögliche Werte siehe:Pool-Attribute IDs
- int id: ID des Attributes
- string name: Interner Name des Attributes
- string label: Anzeigenname des Attributes
- bool has_options: true, wenn dieses Attribut Optionen erlaubt
- bool can_add_options: true, wenn diesem Attribut Optionen hinzugefügt werden dürfen
- EvalanchePoolAttributeOption[] options: Liste von Objekten mit folgenden Attributen:
Benötigte Rechte
Pool anzeigen
Verwendung
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:pool="https://scnem.com/soap.php/soap/pool">
<soapenv:Header/>
<soapenv:Body>
<pool:getAttributes>
<pool_id>POOL_ID</pool_id>
</pool:getAttributes>
</soapenv:Body>
</soapenv:Envelope><SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/pool">
<SOAP-ENV:Body>
<ns1:getAttributesResponse>
<getAttributesResult>
<item>
<id>ATTRIBUTE_ID</id>
<name>ATTRIBUTE_NAME</name>
<label>ATTRIBUTE_LABEL</label>
<has_options>true/false</has_options>
<can_add_options>true/false</can_add_options>
<options>
<item>
<id>ATTRIBUTE_OPTION_ID</id>
<value>ATTRIBUTE_OPTION_VALUE</value>
</item>
[...]
</options>
<type_id>ATTRIBUTE_TYPE_ID</type_id>
</item>
[...]
</getAttributesResult>
</ns1:getAttributesResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
addAttribute
Ein Attribut anlegen
EvalanchePoolAttribute addAttribute (int pool_id, string name, string label, int type_id)
Details
Parameter
- int pool_id: ID des Pools
- string name: Interner Name des Attributes (Nur Großbuchstaben und Ziffern, erstes Zeichen muss ein Großbuchstabe sein)
- string label: Anzeigenname des Attributes
- int type_id: Typ ID des Feldes, s. Rückgabewert unter Attribute eines Pools auslesen
Rückgabewert
- EvalanchePoolAttribute: Ein Objekt des Typs EvalanchePoolAttribute analog zum Rückgabewert der Methoden getAttributes
Benötigte Rechte
Pool verändern
Verwendung
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:pool="https://scnem.com/soap.php/soap/pool">
<soapenv:Header/>
<soapenv:Body>
<pool:addAttribute>
<pool_id>POOL_ID</pool_id>
<name>ATTRIBUTE_NAME</name>
<label>ATTRIBUTE_LABEL</label>
<type_id>ATTRIBUTE_TYPE_ID</type_id>
</pool:addAttribute>
</soapenv:Body>
</soapenv:Envelope></soapenv:Envelope><SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/pool">
<SOAP-ENV:Body>
<ns1:addAttributeResponse>
<addAttributeResult>
<id>ATTRIBUTE_ID</id>
<name>ATTRIBUTE_NAME</name>
<label>ATTRIBUTE_LABEL</label>
<has_options>true/false</has_options>
<can_add_options>true/false</can_add_options>
<options/>
<type_id>ATTRIBUTE_TYPE_ID</type_id>
</addAttributeResult>
</ns1:addAttributeResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
addAttributeOptions
Attributoptionen anlegen
EvalanchePoolAttribute addAttributeOptions (int pool_id, int attribute_id, string[] labels)
Details
Parameter
- int pool_id: ID des Pools
- int attribute_id: ID des Attributes
- string[] labels: Liste mit den Anzeigennamen der anzulegenden Optionen
Rückgabewert
- EvalanchePoolAttribute: Ein Objekt des Typs EvalanchePoolAttribute analog zum Rückgabewert der Methoden getAttributes
Benötigte Rechte
keine
Verwendung
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:pool="https://scnem.com/soap.php/soap/pool">
<soapenv:Header/>
<soapenv:Body>
<pool:addAttributeOptions>
<pool_id>POOL_ID</pool_id>
<attribute_id>ATTRIBUTE_ID</attribute_id>
<labels>
<!--Zero or more repetitions:-->
<item>ATTRIBUTE_OPTION_LABEL</item>
</labels>
</pool:addAttributeOptions>
</soapenv:Body>
</soapenv:Envelope></soapenv:Envelope><SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/pool">
<SOAP-ENV:Body>
<ns1:addAttributeOptionsResponse>
<addAttributeOptionsResult>
<id>ATTRIBUTE_ID</id>
<name>ATTRIBUTE_NAME</name>
<label>ATTRIBUTE_LABEL</label>
<has_options>true/false</has_options>
<can_add_options>true/false</can_add_options>
<options>
<item>
<id>ATTRIBUTE_OPTION_ID</id>
<value>ATTRIBUTE_OPTION_VALUE</value>
</item>
[...]
</options>
<type_id>ATTRIBUTE_TYPE_ID</type_id>
</addAttributeOptionsResult>
</ns1:addAttributeOptionsResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
deleteAttributeOption
Attributoptionen löschen
EvalanchePoolAttribute deleteAttributeOption (int pool_id, int attribute_id, int option_id)
Details
Parameter
- int pool_id: ID des Pools
- int attribute_id: ID des Attributes
- int option_id: ID der zu löschenden Option
Rückgabewert
- EvalanchePoolAttribute: Ein Objekt des Typs EvalanchePoolAttribute analog zum Rückgabewert der Methoden getAttributes
Benötigte Rechte
keine
Verwendung
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:pool="https://scnem.com/soap.php/soap/pool">
<soapenv:Header/>
<soapenv:Body>
<pool:deleteAttributeOption>
<pool_id>POOL_ID</pool_id>
<attribute_id>ATTRIBUTE_ID</attribute_id>
<option_id>ATTRIBUTE_OPTION_ID</option_id>
</pool:deleteAttributeOption>
</soapenv:Body>
</soapenv:Envelope><SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/pool">
<SOAP-ENV:Body>
<ns1:deleteAttributeOptionResponse>
<deleteAttributeOptionResult>
<id>ATTRIBUTE_ID</id>
<name>ATTRIBUTE_NAME</name>
<label>ATTRIBUTE_LABEL</label>
<has_options>true/false</has_options>
<can_add_options>true/false</can_add_options>
<options>
<item>
<id>ATTRIBUTE_OPTION_ID</id>
<value>ATTRIBUTE_OPTION_VALUE</value>
</item>
[...]
</options>
<type_id>ATTRIBUTE_TYPE_ID</type_id>
</deleteAttributeOptionResult>
</ns1:deleteAttributeOptionResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
updateAttributeOption
Attributoptionen aktualisieren
EvalanchePoolAttribute updateAttributeOption (int pool_id, int attribute_id, int option_id, string label)
Details
Parameter
- int pool_id: ID des Pools
- int attribute_id: ID des Attributes
- int option_id: ID der Option
- string label: Neuer Anzeigenname für die Option
Rückgabewert
- EvalanchePoolAttribute: Ein Objekt des Typs EvalanchePoolAttribute analog zum Rückgabewert der Methoden getAttributes
Benötigte Rechte
keine
Verwendung
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:pool="https://scnem.com/soap.php/soap/pool">
<soapenv:Header/>
<soapenv:Body>
<pool:updateAttributeOption>
<pool_id>POOL_ID</pool_id>
<attribute_id>ATTRIBUTE_ID</attribute_id>
<option_id>ATTRIBUTE_OPTION_ID</option_id>
<label>ATTRIBUTE_OPTION_LABEL</label>
</pool:updateAttributeOption>
</soapenv:Body>
</soapenv:Envelope></soapenv:Envelope><SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/pool">
<SOAP-ENV:Body>
<ns1:updateAttributeOptionResponse>
<updateAttributeOptionResult>
<id>ATTRIBUTE_ID</id>
<name>ATTRIBUTE_NAME</name>
<label>ATTRIBUTE_LABEL</label>
<has_options>true/false</has_options>
<can_add_options>true/false</can_add_options>
<options>
<item>
<id>ATTRIBUTE_OPTION_ID</id>
<value>ATTRIBUTE_OPTION_VALUE</value>
</item>
[...]
</options>
<type_id>ATTRIBUTE_OPTION_TYPE_ID</type_id>
</updateAttributeOptionResult>
</ns1:updateAttributeOptionResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope></SOAP-ENV:Envelope>
Pool-Attribute IDs
1 -> SALUTATION
2 -> COUNTRY
3 -> STATE
4 -> MOBILENETWORK
5 -> INPUT (einzeilige Eingabe)
6 -> MULTILINEINPUT (mehrzeilige Eingabe)
7 -> SELECTION (Einfachauswahl)
8 -> MULTIPLESELECTION (Mehrfachauswahl)
9 -> DATE (Datum)
10 -> EMAIL
11 -> DATETIME (Datum mit Uhrzeit)
12 -> LANGUAGE (Sprache)
13 -> ???
14 -> DATETIMERO (Datum mit Uhrzeit, nur lesen)
15 -> PERMISSION
16 -> BOOLEAN (Wahr/Falsch)
17 -> HARDBOUNCES
18 -> USERSTATE (Userstatus, deprecated)
19 -> FORM (Ursprungsformular)
20 -> INT (ganze Zahl)
21 -> ZIPCODE (Postleitzahl)