Webservice ido

• WSDL Datei

Die zur Nutzung der infra-struktur IDO Webservices notwendige WSDL-Datei finden Sie 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

Diese in PHP geschrieben Beispielapplikation dient als leichter Einstieg in die infra-struktur Webservices

  <?php
  //Einen neuen SoapClient erstellen und Verbindung mit der infra-struktur WSDL Datei aufnehmen
  $client = new SoapClient("http://instanzname.infra-struktur.de/webservice/wsdl/wsdl.php?ido",array('exceptions'=>false));
  
  //Authentifizierung am Webservice mit den infra-struktur Benutzerdaten
  $token = $client->__soapCall("authenticate",array("http://instanzname.infra-struktur.de","benutzername","passwort"));
  
  //In der IDO Instanz mit der ID 1, im Datensatz mit der ID 2, das Textfeld mit der ID 3 auf den Wert "vier" setzen
  $client->__soapCall("setTextfieldValue",array(1,2,3,"vier",$token));
  
  //Alle Textfelder der Instanz mit der ID 1 ermitteln und die dazugehörigen Werte ausgeben
  foreach($client->__soapCall("getTextfieldsByInstanceID",array(1,$token)) as $feldID => $feldName)
  {
      //Den Namen des ermittelten Felds in den UTF-8 Zeichensatz konvertieren und ausgeben
      echo "Name des Feldes: ".utf8_decode($feldName);
  }
  ?>

• 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

GetTextfieldsByInstanceID

Liefert sämtliche Textfelder zur gewählten Instanz

Parameter	Datentyp	Beschreibung
instanceID	Integer	ID der IDO Instanz
token	String	Validierungstoken
Rückgabewert
idoTextFields	Array	Array mit den verfügbaren Textfeldern (FeldID,Feldname)

GetInstances

Liefert sämtliche verfügbare IDO Instanzen

Parameter	Datentyp	Beschreibung
userID	Integer	UserID des Benutzers
token	String	Validierungstoken
Rückgabewert
idoInstances	Array	Array mit den verfügbaren IDO-Instanzen (InstanceID,Instanzname)

GetSelectFieldsByInstanceID

Liefert sämtliche Selectfelder der gewählten Instanz

Parameter	Datentyp	Beschreibung
InstanceID	Integer	ID der IDO Instanz
token	String	Validierungstoken
Rückgabewert
IdoSelectFields	Array	Array mit den verfügbaren Selectfeldern (FeldID,Feldname)

GetRadiofieldsByInstanceID

Liefert sämtliche Radiofelder der gewählten Instanz

Parameter	Datentyp	Beschreibung
InstanceID	Integer	ID der IDO Instanz
token	String	Validierungstoken
Rückgabewert
IdoRadiofields	Array	Array mit den verfügbaren Radiofeldern (FeldID,Feldname)

GetCheckboxesByInstanceID

Liefert sämtliche Checkboxen der gewählten Instanz

Parameter	Datentyp	Beschreibung
InstanceID	Integer	ID der IDO Instanz
token	String	Validierungstoken
Rückgabewert
IdoRadiofields	Array	Array mit den verfügbaren Checkboxen (FeldID,Feldname)

CountConfigurenCheckboxesByInstanceID

Gibt die Anzahl der verfügbaren Checkboxen zurück

Parameter	Datentyp	Beschreibung
InstanceID	Integer	ID der IDO Instanz
token	String	Validierungstoken
Rückgabewert
CountCheckboxes	Integer	Anzahl der verfügbaren Felder

GetPossibleCheckboxValues

Liefert die Auswahlmöglichkeiten einer Checkbox

Parameter	Datentyp	Beschreibung
InstanceID	Integer	ID der IDO Instanz
CheckboxID	Integer	ID der Checkbox
token	String	Validierungstoken
Rückgabewert
CheckboxValues	Array	Array mit den verfügbaren Values (ValueID,ValueName)

CountConfiguredSelectfieldsByInstanceID

Gibt die Anzahl der verfügbaren Selectfelder zurück

Parameter	Datentyp	Beschreibung
InstanceID	Integer	ID der IDO Instanz
token	String	Validierungstoken
Rückgabewert
CountSelectfields	Integer	Anzahl der verfügbaren Felder

CountConfiguredRadiofieldsByInstanceID

Gibt die Anzahl der verfügbaren Radiofelder zurück

Parameter	Datentyp	Beschreibung
InstanceID	Integer	ID der IDO Instanz
token	String	Validierungstoken
Rückgabewert
CountSelectfields	Integer	Anzahl der verfügbaren Felder

GetPossibleSelectfieldValues

Liefert die Auswahlmöglichkeiten eines Selectfeldes

Parameter	Datentyp	Beschreibung
InstanceID	Integer	ID der IDO Instanz
SelectfieldID	Integer	ID der Selectbox
token	String	Validierungstoken
Rückgabewert
SelectfieldsValues	Array	Array mit den verfügbaren Values (ValueID,ValueName)

GetPossibleRadiofieldValues

Liefert die Auswahlmöglichkeiten einer Radiobox

Parameter	Datentyp	Beschreibung
InstanceID	Integer	ID der IDO Instanz
RadiofieldID	Integer	ID des Radiofelds
token	String	Validierungstoken
Rückgabewert
RadiofieldValues	Array	Array mit den verfügbaren Values (ValueID,ValueName)

GetIDOInstanceSpecialFieldConfiguration

Liefert den Konfigurationsstatus der angefragten Zusatzfeldverwaltung

Parameter	Datentyp	Beschreibung
InstanceID	Integer	ID der IDO Instanz
SpecialFieldType	String	Abzufragende Konfiguration * mögliche SpecialFieldTypes archivefield - Ist das Archivfeld aktiviert messagefield - Ist das Hinweisfeld aktiviert nextcontacttime - Ist das nächster Kontaktfeld (Uhrzeit) aktiviert nextcontact - Ist das nächster Kontaktfeld (Datum) aktiviert datasetowner - Ist das Feld Kontaktperson aktiviert lastcontact - Ist das Feld letzter Kontakt aktiviert deleteright - Ist der Löschen-Button aktiviert
token	String	Validierungstoken
Rückgabewert
true/false	Boolian	Konfigurationsstatus

* mögliche SpecialFieldTypes - archivefield - Ist das Archivfeld aktiviert - messagefield - Ist das Hinweisfeld aktiviert - nextcontacttime - Ist das nächster Kontaktfeld (Uhrzeit) aktiviert - nextcontact - Ist das nächster Kontaktfeld (Datum) aktiviert - datasetowner - Ist das Feld Kontaktperson aktiviert - lastcontact - Ist das Feld letzter Kontakt aktiviert - deleteright - Ist der Löschen-Button aktiviert

GetConfiguredContactsTextFields

Liefert die konfigurierten Felder des Ansprechpartnerreiters

Parameter	Datentyp	Beschreibung
InstanceID	Integer	ID der IDO Instanz
token	String	Validierungstoken
Rückgabewert
ContactFields	Array	Array mit den verfügbaren Feldern (FeldID,Feldname)

GenerateFieldTypeArray

Liefert ein mehrdimensionales Array mit allen Feldtypen der Instanz

Parameter	Datentyp	Beschreibung
InstanceID	Integer	ID der IDO Instanz
token	String	Validierungstoken
Rückgabewert
FieldTypeArray	Array	Zweidimensionales Array im Format array[Feldtyp][FeldID] mit dem Value Feldname

GetFieldType

Liefert den Typ eines bestimmten Feldes zurück

Parameter	Datentyp	Beschreibung
InstanceID	Integer	ID der IDO Instanz
FieldID	Integer	ID des Feldes
FieldName	String	Name des Feldes
token	String	Validierungstoken
Rückgabewert
Feldtyp	String	Typ des Feldes

GetDataByInstanceIDOIdAndFieldID

Liefert den Wert des angegebenen Feldes zurück

• mögliche Feldtypen

● optfield (Standard) ● radiofield ● selectfield

Parameter	Datentyp	Beschreibung
InstanceID	Integer	ID der IDO Instanz
IdoID	Integer	ID des Datensatzes
FieldID	Integer	ID des Feldes
FieldType	String	Typ des Feldes *
token	String	Validierungstoken
Rückgabewert
FieldValue	String	Wert des Feldes

GetCheckedValuesForInstanceAndCheckBoxID

Liefert ein Array der angehakten IDs der Einträge der abgefragten Checkbox mit dem jeweiligen Status als Boolian zurück

Parameter	Datentyp	Beschreibung
InstanceID	Integer	ID der IDO Instanz
IdoID	Integer	ID des Datensatzes
CheckboxID	Integer	ID der Checkbox
token	String	Validierungstoken
Rückgabewert
CheckBoxValues	Array	Array dessen Key die ValueID und das Value der Name ist

GetPossibleValuesForInstanceIDOAndCheckboxID

Liefert alle verfügbaren Einträge einer Checkbox zurück

Parameter	Datentyp	Beschreibung
InstanceID	Integer	ID der IDO Instanz
CheckboxID	Integer	ID der Checkbox
token	String	Validierungstoken
Rückgabewert
CheckBoxValues	Array	Array dessen Key die ValueID und das Value der Name ist

GetArchiveContent

Liefert den Inhalt des Archivfelds eines bestimmten Datensatzes zurück

Parameter	Datentyp	Beschreibung
InstanceID	Integer	ID der IDO Instanz
IdoID	Integer	ID des Datensatzes
token	String	Validierungstoken
Rückgabewert
ArchiveContent	String	Inhalt des Archivfelds

GetMessageContent

Liefert den Inhalt des Hinweisfelds eines bestimmten Datensatzes

Parameter	Datentyp	Beschreibung
InstanceID	Integer	ID der IDO Instanz
IdoID	Integer	ID des Datensatzes
token	String	Validierungstoken
Rückgabewert
MessageContent	String	Inhalt des Hinweisfelds

GetNextContact

Liefert das Datum der Wiedervorlage / nächsten Kontakts zurück

Parameter	Datentyp	Beschreibung
InstanceID	Integer	ID der IDO Instanz
IdoID	Integer	ID des Datensatzes
token	String	Validierungstoken
Rückgabewert
NextContact	String	Datum des nächsten Kontakts

GetNextContactTime

Liefert die Uhrzeit der Wiedervorlage / nächsten Kontakts zurück

Parameter	Datentyp	Beschreibung
InstanceID	Integer	ID der IDO Instanz
IdoID	Integer	ID des Datensatzes
token	String	Validierungstoken
Rückgabewert
NextContactTime	String	Uhrzeit des nächsten Kontakts

IsTerminOnNextContact

Liefert zurück ob der nächste Kontakt ein Termin ist

Parameter	Datentyp	Beschreibung
InstanceID	Integer	ID der IDO Instanz
IdoID	Integer	ID des Datensatzes
token	String	Validierungstoken
Rückgabewert
isTermin	Boolian	Termin oder nicht

GetContactPerson

Liefert die ausgewählte Kontaktperson des Datensatzes zurück

Parameter	Datentyp	Beschreibung
InstanceID	Integer	ID der IDO Instanz
IdoID	Integer	ID des Datensatzes
token	String	Validierungstoken
Rückgabewert
contactPerson	Integer	UserID der Kontaktperson

SetValueForDataset

Setzt den Wert eines bestimmten Feldes

Parameter	Datentyp	Beschreibung
InstanceID	Integer	ID der IDO Instanz
IdoID	Integer	ID des Datensatzes
FieldID	Integer	ID des Feldes
Value	String	Wert des Feldes
FieldType	String	Feldtyp des Feldes
token	String	Validierungstoken
Rückgabewert
Status	Boolian	Status der Abfrage

SetValueForDataset

Setzt den Wert eines bestimmten Feldes

Parameter	Datentyp	Beschreibung
InstanceID	Integer	ID der IDO Instanz
FieldID	Integer	ID des Feldes
Value	String	Wert der Option
token	String	Validierungstoken
Rückgabewert
Status	Boolian	Status der Abfrage

SetTextFieldValue

Setzt den Wert eines Textfeldes

Parameter	Datentyp	Beschreibung
InstanceID	Integer	ID der IDO Instanz
IdoID	Integer	ID des Datensatzes
FieldID	Integer	ID des Feldes
Value	String	Wert der Option
token	String	Validierungstoken
Rückgabewert
Status	Boolian	Status der Abfrage

SetArchiveContent

Setzt den Wert des Archivfelds

• mögliche Feldtypen

● UPDATE (Standard) - ergänzt bestehenden Inhalt ● OVERWRITE - überschreibt bestehenden Inhalt

Parameter	Datentyp	Beschreibung
InstanceID	Integer	ID der IDO Instanz
IdoID	Integer	ID des Datensatzes
Value	String	Wert der Option
HandleType	String	Typ der Aktion *
token	String	Validierungstoken
Rückgabewert
Status	Boolian	Status der Abfrage

SetContactPerson

Parameter	Datentyp	Beschreibung
InstanceID	Integer	ID der IDO Instanz
IdoID	Integer	ID des Datensatzes
EmployeeID	Integer	UserID der Kontaktperson
token	String	Validierungstoken
Rückgabewert
Status	Boolian	Status der Abfrage

SetMessageContent

Setzt den Wert des Hinweisfelds

-mögliche Aktionen ● UPDATE (Standard) - ergänzt bestehenden Inhalt ● OVERWRITE - überschreibt bestehenden Inhalt

Parameter	Datentyp	Beschreibung
InstanceID	Integer	ID der IDO Instanz
IdoID	Integer	ID des Datensatzes
Value	String	Wert der Option
HandleType	String	Typ der Aktion *
token	String	Validierungstoken
Rückgabewert
Status	Boolian	Status der Abfrage

SetContactDate

Setzt den Wert des Feldes nächster/letzter Kontakt

• mögliche Feldtypen

● NEXT (Standard) - Feld nächster Kontakt ● LAST - Feld letzter Kontakt

Parameter	Datentyp	Beschreibung
InstanceID	Integer	ID der IDO Instanz
IdoID	Integer	ID des Datensatzes
HandleType	String	Typ des Feldes *
Date	String	Datum
token	String	Validierungstoken
Rückgabewert
Status	Boolian	Status der Abfrage

SetContactTime

Setzt die Uhrzeit des nächsten Kontakts

Parameter	Datentyp	Beschreibung
InstanceID	Integer	ID der IDO Instanz
IdoID	Integer	ID des Datensatzes
Time	String	Uhrzeit (HH:MM:SS)
token	String	Validierungstoken
Rückgabewert
Status	Boolian	Status der Abfrage

SetTermin

Setzt den nächsten Kontakt als Termin

Parameter	Datentyp	Beschreibung
InstanceID	Integer	ID der IDO Instanz
IdoID	Integer	ID des Datensatzes
SwitchStatus	Boolian	Termin oder nicht
token	String	Validierungstoken
Rückgabewert
Status	Boolian	Status der Abfrage

SetCombofield

Setzt den Wert eines Combofeldes

Parameter	Datentyp	Beschreibung
InstanceID	Integer	ID der IDO Instanz
IdoID	Integer	ID des Datensatzes
FieldID	Integer	ID des Combofeldes
ValueID	Integer	ID der Values
token	String	Validierungstoken
Rückgabewert
Status	Boolian	Status der Abfrage

SetCheckboxValues

Setzt den Wert einer Checkbox

• im Format array('ValueID1' => true, 'ValueID2' => false, ...)

Parameter	Datentyp	Beschreibung
InstanceID	Integer	ID der IDO Instanz
IdoID	Integer	ID des Datensatzes
FieldID	Integer	ID der Checkbox
Values	Array	Checkboxwerte als Array *
token	String	Validierungstoken
Rückgabewert
Status	Boolian	Status der Abfrage

GetIdoIDByInstanceIDAndFieldIDByFieldValue

Liefert die ID eines Datensatzes anhand der gegebenen ID der IDO Instanzund dem Match auf den Wert des angegebenen Textfeldes

Parameter	Datentyp	Beschreibung
InstanceID	Integer	ID der IDO Instanz
FieldID	Integer	ID des Textfeldes
TextfieldValue	String	Suchbegriff
token	String	Validierungstoken
Rückgabewert
IDOID	Integer	Datensatz ID

CreateNewDataset

Erstellt einen neuen, leeren Datensatz

Parameter	Datentyp	Beschreibung
InstanceID	Integer	ID der IDO Instanz
ContactPerson	Integer	UserID des Besitzers
token	String	Validierungstoken
Rückgabewert
IDOID	Integer	ID des neuen Datensatz

AddActivity

Fügt einem Datensatz eine neue Aktivität hinzu

• Statusmöglichkeiten

● 1 – Rot ● 2 – Gelb ● 3 – Grün

Parameter	Datentyp	Beschreibung
InstanceID	Integer	ID der IDO Instanz
IDOID	Integer	ID des Datensatzes
ActivityStartTime	Integer	Timestamp der Startzeit
ActivityTypeID	Integer	ID des Aktivitätentyps
ActivityTitle	String	Titel der Aktivität
ActivityContent	String	Text der Aktivität
ContactPersonID	Integer	UserID der Kontaktperson
AuthorID	Integer	UserID des Verfassers
ActivityDuration	Integer	Dauer der Aktivität in Minuten
AlarmBeforeStarttime	Integer	Alarm in Minuten vor StartTime
ActivityStatus	Integer	Status der Aktivität *
token	String	Validierungstoken
Rückgabewert
EntryID	Integer	ID der Aktivität

GetActivityTypeIDByName

Liefert die TypenID der jeweiligen Aktivität zurück

Parameter	Datentyp	Beschreibung
InstanceID	Integer	ID der IDO Instanz
ActivityTypeName	String	Name des Aktivitätentyps
token	String	Validierungstoken
Rückgabewert
ActivityTypeID	Integer	ID des Aktivitätentyps

AddActivityToIDO

Fügt eine zuvor gesetzte Aktivität an einen Datensatz

Parameter	Datentyp	Beschreibung
ActivityID	Integer	ID der Aktivität
InstanceID	Integer	ID der IDO Instanz
IDOID	Integer	ID des Datensatzes
token	String	Validierungstoken
Rückgabewert
Status	Boolian	Status der Aktion