Webservice contacts: Unterschied zwischen den Versionen

Aus infra-struktur AdminWiki 2.10
Zur Navigation springenZur Suche springen
← Zum vorherigen Versionsunterschied
Keine Bearbeitungszusammenfassung
Keine Bearbeitungszusammenfassung
 
(23 dazwischenliegende Versionen von 4 Benutzern werden nicht angezeigt)
Zeile 1: Zeile 1:
''Struktur einer SOAP-Nachricht:''
* '''WSDL Datei'''
<source lang="xml">
 
<?xml version="1.0"?>
Die zur Nutzung des Ansprechpartner Webservice notwendige WSDL Datei befindet sich unter:
<s:Envelope xmlns:s="http://www.w3.org/2003/05/soap-envelope">
 
    <s:Header>
http://demo.infra-struktur.eu/webservice/wsdl/wsdl.php?ido
     </s:Header>
 
    <s:Body>
* '''Funktionsübersicht'''
     </s:Body>
 
</s:Envelope>
''<u>Authenticate</u>''
</source>
 
Authentifiziert einen Benutzer am Webservice
 
{| class="wikitable" border=1
! width="100px" | Parameter       
! width="100px" | Datentyp 
! width="400px" | Beschreibung
|-
| instanceName    ||String ||| Vollständiger Pfad der Instanz
|-
| userName    || String ||| infra-struktur Benutzername
|-
| password    || String ||| infra-struktur Passwort
|-
| &nbsp; || |||
|-
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
| token    || String ||| Authentifizierungstoken für weitere Anfragen am Webservice
|}
 
 
''<u>getContacts</u>''
 
Liefert ein Array mit allen zu einem Datensatz hinterlegten Ansprechpartnern
 
{| class="wikitable" border=1
! width="100px" | Parameter       
! width="100px" | Datentyp 
! width="400px" | Beschreibung
|-
| IDOID|| Integer||| Datensatz ID
|-
| InstanceID||Integer||| InstanzID
|-
| Token|| String||| Authentifizierungstoken
|-
| &nbsp; || |||
|-
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
| Contacts|| Array||| Array Aufbau: Array->ContactID->FieldID->FieldValue
|}
 
 
''<u>getContactFields</u>''
 
Liefert die Konfiguration der Ansprechpartnerfelder einer IDO Instanz
 
{| class="wikitable" border=1
! width="100px" | Parameter       
! width="100px" | Datentyp 
! width="400px" | Beschreibung
|-
| InstanceID||Integer||| InstanzID
|-
| Token|| String||| Authentifizierungstoken
|-
| &nbsp; || |||
|-
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
| Configuration|| Array||| Array Aufbau: Array->FieldID->FieldName in Reihenfolge der Konfiguration
|}
 
 
''<u>getContactCount</u>''
 
Liefert die Anzahl der Ansprechpartner eines Datensatzes zurück
 
{| class="wikitable" border=1
! width="100px" | Parameter       
! width="100px" | Datentyp 
! width="400px" | Beschreibung
|-
| InstanceID||Integer||| InstanzID
|-
| IDOID|| Integer||| Datensatz ID
|-
| Token|| String||| Authentifizierungstoken
|-
| &nbsp; || |||
|-
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
| Count|| Integer||| Anzahl der Ansprechpartner
|}
 
 
''<u>searchContactByValue</u>''
 
Liefert die Datensätze auf welche das Suchkriterium zutrifft zurück
 
{| class="wikitable" border=1
! width="100px" | Parameter       
! width="100px" | Datentyp 
! width="400px" | Beschreibung
|-
| InstanceID||Integer||| InstanzID
|-
| SearchString|| String||| Suchbegriff
|-
| Token|| String||| Authentifizierungstoken
|-
| &nbsp; || |||
|-
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
| Result|| Array||| Array Aufbau: Array->InstanceID->IDOID->ContactID->FieldID = Searchmatch
|}
 
 
''<u>getNextContactID</u>''
 
Liefert die nächste freie AnsprechpartnerID
 
{| class="wikitable" border=1  
! width="100px" | Parameter       
! width="100px" | Datentyp 
! width="400px" | Beschreibung
|-
| InstanceID||Integer||| InstanzID
|-
| IDOID|| Integer||| Datensatz ID
|-
| Token|| String||| Authentifizierungstoken
|-
| &nbsp; || |||
|-
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
| ContactID|| Integer||| ID des nächsten Ansprechartners
|}
 
 
''<u>setContactValue</u>''
 
Setzt den Wert eines speziellen Ansprechpartnerfeldes
 
{| class="wikitable" border=1
! width="100px" | Parameter       
! width="100px" | Datentyp 
! width="400px" | 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
|-
| &nbsp; || |||
|-
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
| 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
|-
| &nbsp; || |||
|-
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
| ContactID|| Integer||| ID des neuen Ansprechpartners
|}
 
 
''<u>getConfiguredContactsTextFields</u>''
 
Liefert die konfigurierten Textfelder des Ansprechpartner-Reiters
 
{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceID    ||Integer ||| ID der IDO Instanz
|-
| token    || String ||| Validierungstoken
|-
| &nbsp; || |||
|-
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
|      ||  |||
|}
 
 
''<u>getFullContactsByIdoId</u>''
 
Liefert alle Ansprechpartner eines Datensatzes (vollständig)
 
{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| InstanceId    ||Integer ||| ID der IDO Instanz
|-
| IdoID    ||Integer ||| ID des Datensatzes
|-
| Token     || String ||| Validierungstoken
|-
| &nbsp; || |||
|-
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
|      ||  |||
|}
 
 
''<u>getContactDataByInstanceIDOIDAndFieldID</u>''
 
Liefert den Wert eines bestimmten Feldes eines Ansprechpartners
 
{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceID    ||Integer ||| ID der IDO Instanz
|-
| idoID    ||Integer ||| ID des Datensatzes
|-
| fieldID     ||Integer ||| ID des Feldes
|-
| ContactID    ||Integer ||| ID des Ansprechpartners
|-
| token    || String ||| Validierungstoken
|-
| &nbsp; || |||
|-
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
|      ||  |||
|}
 
 
''<u>set_contacts</u>''
 
Setzt Ansprechpartner-Daten
 
{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| &nbsp; || |||
|-
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
|      ||  |||
|}
 
 
== Hauptkapitel ==
* [[Webservice Dokumentation]]
 
== Verwandte Themen ==
* [[Webservice_activities]]
* [[Webservice_calendar]]
* [[Webservice_contacts]]
* [[Webservice_dms]]
* [[Webservice_dmstagging]]
* [[Webservice_ido]]
* [[Webservice_idolinkings]]
* [[Webservice_msg]]
* [[Webservice_user]]
* [[Webservice_email]]
* [[Webservice_task]]

Aktuelle Version vom 13. Mai 2026, 11:56 Uhr

  • 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


getConfiguredContactsTextFields

Liefert die konfigurierten Textfelder des Ansprechpartner-Reiters

Parameter Datentyp Beschreibung
instanceID Integer ID der IDO Instanz
token String Validierungstoken
 
Rückgabewert


getFullContactsByIdoId

Liefert alle Ansprechpartner eines Datensatzes (vollständig)

Parameter Datentyp Beschreibung
InstanceId Integer ID der IDO Instanz
IdoID Integer ID des Datensatzes
Token String Validierungstoken
 
Rückgabewert


getContactDataByInstanceIDOIDAndFieldID

Liefert den Wert eines bestimmten Feldes eines Ansprechpartners

Parameter Datentyp Beschreibung
instanceID Integer ID der IDO Instanz
idoID Integer ID des Datensatzes
fieldID Integer ID des Feldes
ContactID Integer ID des Ansprechpartners
token String Validierungstoken
 
Rückgabewert


set_contacts

Setzt Ansprechpartner-Daten

Parameter Datentyp Beschreibung
 
Rückgabewert


Hauptkapitel

Verwandte Themen

Abgerufen von „https://adminwiki210.infra-struktur.de/index.php?title=Webservice_contacts&oldid=2794“