Webservice contacts
Aus infra-struktur AdminWiki 2.10
- WSDL Datei
Die zur Nutzung des Ansprechpartner Webservice notwendige WSDL Datei befindet sich unter:
http://demo.infra-struktur.eu/webservice/wsdl/wsdl.php?ido
- Funktionsübersicht
Authenticate
Authentifiziert einen Benutzer am Webservice
| Parameter | Datentyp | Beschreibung |
|---|---|---|
| instanceName | String | Vollständiger Pfad der Instanz |
| userName | String | infra-struktur Benutzername |
| password | String | infra-struktur Passwort |
Rückgabewert |
||
| token | String | Authentifizierungstoken für weitere Anfragen am Webservice |
getContacts
Liefert ein Array mit allen zu einem Datensatz hinterlegten Ansprechpartnern
| Parameter | Datentyp | Beschreibung |
|---|---|---|
| IDOID | Integer | Datensatz ID |
| InstanceID | Integer | InstanzID |
| Token | String | Authentifizierungstoken |
Rückgabewert |
||
| Contacts | Array | Array Aufbau: Array->ContactID->FieldID->FieldValue |
getContactFields
Liefert die Konfiguration der Ansprechpartnerfelder einer IDO Instanz
| Parameter | Datentyp | Beschreibung |
|---|---|---|
| InstanceID | Integer | InstanzID |
| Token | String | Authentifizierungstoken |
Rückgabewert |
||
| Configuration | Array | Array Aufbau: Array->FieldID->FieldName in Reihenfolge der Konfiguration |
getContactCount
Liefert die Anzahl der Ansprechpartner eines Datensatzes zurück
| Parameter | Datentyp | Beschreibung |
|---|---|---|
| InstanceID | Integer | InstanzID |
| IDOID | Integer | Datensatz ID |
| Token | String | Authentifizierungstoken |
Rückgabewert |
||
| Count | Integer | Anzahl der Ansprechpartner |
searchContactByValue
Liefert die Datensätze auf welche das Suchkriterium zutrifft zurück
| Parameter | Datentyp | Beschreibung |
|---|---|---|
| InstanceID | Integer | InstanzID |
| SearchString | String | Suchbegriff |
| Token | String | Authentifizierungstoken |
Rückgabewert |
||
| Result | Array | Array Aufbau: Array->InstanceID->IDOID->ContactID->FieldID = Searchmatch |
getNextContactID
Liefert die nächste freie AnsprechpartnerID
| Parameter | Datentyp | Beschreibung |
|---|---|---|
| InstanceID | Integer | InstanzID |
| IDOID | Integer | Datensatz ID |
| Token | String | Authentifizierungstoken |
Rückgabewert |
||
| ContactID | Integer | ID des nächsten Ansprechartners |
setContactValue
Setzt den Wert eines speziellen Ansprechpartnerfeldes
| Parameter | Datentyp | Beschreibung |
|---|---|---|
| InstanceID | Integer | InstanzID |
| IDOID | Integer | Datensatz ID |
| ContactID | Integer | Ansprechpartner ID |
| FieldID | Integer | Feld ID |
| Value | String | Neuer Inhalt des Feldes |
| Token | String | Authentifizierungstoken |
Rückgabewert |
||
| Status | Boolean | true/false |
addContact
Erzeugt einen neuen leeren Ansprechpartnern
| Parameter | Datentyp | Beschreibung |
|---|---|---|
| InstanceID | Integer | InstanzID |
| IDOID | Integer | Datensatz ID |
| Token | String | Authentifizierungstoken |
Rückgabewert |
||
| ContactID | Integer | ID des neuen Ansprechpartners |