Webservice contacts: Unterschied zwischen den Versionen
Ino (Diskussion | Beiträge) Keine Bearbeitungszusammenfassung |
Ino (Diskussion | Beiträge) Keine Bearbeitungszusammenfassung |
||
| Zeile 173: | Zeile 173: | ||
|- | |- | ||
| Status|| Boolean||| true/false | | Status|| Boolean||| true/false | ||
|} | |||
''<u>addContact</u>'' | |||
Erzeugt einen neuen leeren Ansprechpartnern | |||
{| class="wikitable" border=1 | |||
! width="100px" | Parameter | |||
! width="100px" | Datentyp | |||
! width="400px" | Beschreibung | |||
|- | |||
| InstanceID||Integer||| InstanzID | |||
|- | |||
| IDOID|| Integer||| Datensatz ID | |||
|- | |||
| Token|| String||| Authentifizierungstoken | |||
|- | |||
| || ||| | |||
|- | |||
| <div align=center>'''Rückgabewert'''</div> || ||| | |||
|- | |||
| ContactID|| Integer||| ID des neuen Ansprechpartners | |||
|} | |} | ||
Version vom 8. Mai 2009, 12:28 Uhr
- WSDL Datei
Die zur Nutzung des Ansprechpartner Webservice notwendige WSDL Datei befindet sich unter:
http://instanzname.infra-struktur.de/webservice/wsdl/wsdl.php?ido
Beachten Sie, dass der Webserver für die Verwendung der Webservices Schreibrechte auf das Verzeichnis „WEBROOT/webservice/wsdl“ benötigt.
- Example
- 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 |
|---|---|---|
| InstanceID | Integer | InstanzID |
| IDOID | Integer | Datensatz ID |
| 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 Ansprechopartnerfelds
| 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 |