===== AgilogikCustomerAccessor ===== ==== AddTariffService ==== == Parameter == String itentis, String itoris, String customerContractKey, String tariffName == Return == Boolean * **true**, falls der Tarif gefunden wurde und dem Vertrag zugeordnet werden konnte. * **false** sonst. == Beschreibung == Ordnet einen Tarifeintrag einem Vertrag zu. Existiert die Zuordnung schon erfolgt keine Änderung und es wird **false** zurückgegeben. ==== CreateOrUpdateCustomerContractService ==== == Parameter == String itentis, String itoris, String customerKey, String customerContractKey, String customerContractName, String customerContractDescription, String tempestContractName, String tempestProductName, Long ts_start, Long ts_dismiss, Long ts_end, Long ts_balance, Boolean usageTermsAccepted, Boolean businessConditionsAccepted, String state == Return == String Im Erfolgsfall wird der Schlüssel des neu erzeugten Objektes zurückgegeben. == Beschreibung == Der //customerKey// muss angegeben werden und ein dazu passender Kunde muss existieren. Der Vertrag wird ihm zugeordnet. Ein im leeren Raum stehender Vertrag kann nicht erzeugt werden. Legt einen neuen Datensatz an, falls //customerContractKey// **null** ist. Wird ein Key angegeben, so wird der Datensatz gesucht und versucht ihn zu modifizieren. Die Angabe des //customerKey// ist dann optional. Ist ein Key angegeben, der nicht gefunden wird, wird keine Änderung gemacht und **null** zurückgegeben. ==== CreateOrUpdateCustomerService ==== Legt einen neuen Kunden an, oder aktualisiert die angegebenen Werte. == Parameter == String itentis, String itoris, String customerKey, String customerType, String description, String companyName, String departmentName, String surname, String forename, String title, String gender, String additionalInformation, String postbox, String streetName, String streetNumber, String city, String postalCode, String country, String telephoneNumber, String cellphoneNumber, String userEmail, String iban, String bic, String ustid, String separef, String state == Return == String Schlüssel des neu erzeugten Datensatzes oder Wiederholung des Datensatzschlüssel im Falle eines erfolgreichen Updates. Null sonst. == Beschreibung == Wird als //customerKey// **null** übergeben, so wird ein neuer Datensatz angelegt und versucht zu speichern. Im Erfolgfall wird der neue Schlüssel dieses Datensatzes zurückgegeben. Wird der //customerKey// spezifiziert, so werden alle Werte die nicht **null** sind überschrieben. Alle anderen werden unverändert gelassen. War das speichern erfolgreich, wird der gegebene //contractKey// wieder zurückgegeben. ==== CreateOrUpdateTariffService ==== Erzeugt einen neuen Tarifeintrag, oder aktualisiert einen alten. == Parameter == String itentis, String itoris, String tariffName, String tariffDescription, Double factorFee, Double constantFee, Boolean recurring, Boolean usagebound, String intervall, Double upperBound, Double lowerBound == Return == Boolean == Beschreibung == Ein Tarifeintrag kennt keinen Binärschlüssel. Der //tariffName// muss diese Funktion übernehmen und deshalb **eindeutig** sein!" Wird zu dem angegebenen Namen ein Eintrag gefunden, so wird dieser durch alle Werte die nicht **null** sind aktualisiert. Alle anderen bleiben unverändert. Wird der Name des Tarifes nicht gefunden, so wird ein neuer Eintrag erstellt. ==== DeleteCustomerContractService ==== == Parameter == String itentis, String itoris, String customerContractKey == Return == Boolean == Beschreibung == Löscht einen Kundenvertragseintrag, der durch //customerContractKey// spezifiziert wurde. dazu muss dieser Eintrag existieren. Die Verlinkung zu einem Kundeneintrag wird aufgehoben und der Eintrag physikalisch gelöscht. **Vorsicht**! Eine Umkehrung dieses Befehls ist nicht möglich. ==== DeleteCustomerService ==== == Parameter == String itentis, String itoris, String customerKey == Return == Boolean == Beschreibung == Löscht einen Kundendatensatz. **Größte Vorsicht!** Dieser Befehl löscht sofort rekursiv gleichzeitig **alle Verträge** die mit diesem Kunden assoziiert sind. Alle Daten sind dann verloren. Eine Umkehrung dieses Befehls ist **nicht möglich**! ==== DeleteTariffService ==== Löscht einen Tarifeintrag. == Parameter == String itentis, String itoris, String tariffName == Return == Boolean == Beschreibung == Löscht einen nicht mehr benötigten Tarifeintrag aus der Datenbank. Dieser muss existieren und darf nicht mehr in Verträgen verlinkt sein. ==== ListCustomerContractsByCustomerService ==== Ermittelt die Verträge, die zu einem Kunden gehören. == Parameter == String itentis, String itoris, String customerKey == Return == KeyNamePair == Beschreibung == Ermittelt die Verträge, die zu dem Kunden gehören, der durch den //customerKey// spezifiziert waren. Zurückgegeben werden der Vertragsschlüssel //customerContractKey// als //accessKey// und ein Mnemonic-Code, der sich aus dem Vertragsnamen, den SystemVertragsnamen, dem Systemproduktnamen und dem Vertragszustand zusammen setzen. ==== ListCustomerContractsService ==== == Parameter == String itentis, String itoris, Long offsetItems, Long maxItems == Return == KeyNamePair ==Beschreibung == Ermittelt alle Verträge. Zurückgegeben werden der Vertragsschlüssel //customerContractKey// als //accessKey// und ein Mnemonic-Code, der sich aus dem Vertragsnamen, den SystemVertragsnamen, dem Systemproduktnamen und dem Vertragszustand zusammen setzen. Und zwar eine Anzahl von //maxItems// ab der Position //offsetItems//. ==== ListCustomersService ==== Ermittelt die Kunden im System. == Parameter == String itentis, String itoris, Long offsetItems, Long maxItems, String companyName, String surname == Return == KeyNamePair ==Beschreibung == Ermittelt alle Kunden, die im System gespeichert sind, falls //companyName// und //surName// **null** sind. Dann werden nur //offsetItems// und //mayItems// interpretiert. Werden die Suchparameter aber angegeben, so wird eine Query erstellt, die auf das Vorkommen des angegebenen Substrings prüft. ==== ListTariffsByContractService ==== == Parameter == String itentis, String itoris, String customerContractKey == Return == List ==Beschreibung == Ermittelt alle Tarife, die in diesem Vertrag gebucht sind. Zurückgegeben werden die Namen der Tarife, die gemäß Definition eindeutig sind und als Schlüssel fungieren. ==== ListTariffsService ==== == Parameter == keine == Return == List ==Beschreibung == Liefert alle Name der im System eingepflegten Tarife auf. ==== RemoveCustomerContractService ==== == Parameter == String itentis, String itoris, String customerKey, String customerContractKey == Return == Boolean ==Beschreibung == Hebt die Assotiation zwischen einem Kunden und einem Vertrag auf, falls beide gefunden werden und assoziiert sind. Andernfalls gibt der Service **false** zurück. Achtung: Keiner der Einträge wird gelöscht. Der Vertrag bleibt ohne gültigen //owner// Eintrag zurück. ==== RemoveTariffService ==== == Parameter == String itentis, String itoris, String customerContractKey, String tariffName == Return == Boolean ==Beschreibung == Löst eine Verbindung eines Vertrages zu einem Tariff, falls der Vertrag gefunden wird und der Tarif dort eingetragen ist. Sonst liefert der Service **false** zurück. ==== RetrieveCustomerContractService ==== == Parameter == String itentis, String itoris, String customerContractKey == Return == CustomerContractData{ @XmlElement String customerContractKey @XmlElement String customerContractName @XmlElement String customerContractDescription @XmlElement String tempestContractName @XmlElement String tempestProductName @XmlElement Long ts_start @XmlElement Long ts_dismiss @XmlElement Long ts_end @XmlElement Long ts_balance @XmlElement Boolean usageTermsAccepted @XmlElement Boolean businessConditionsAccepted @XmlElement String state @XmlElement String owner @XmlElement Long cts_ts } ==Beschreibung == Ermittelt alle Werte eines speziellen Vertragseintrages. ==== RetrieveCustomerService ==== == Parameter == String itentis, String itoris, String customerKey == Return == CustomerAddressData { @XmlElement String customerKey @XmlElement String customerType @XmlElement String description @XmlElement String companyName @XmlElement String departmentName @XmlElement String surname @XmlElement String forename @XmlElement String title @XmlElement String gender @XmlElement String additionalInformation @XmlElement String postbox @XmlElement String streetName @XmlElement String streetNumber @XmlElement String city @XmlElement String postalCode @XmlElement String country @XmlElement String telephoneNumber @XmlElement String cellphoneNumber @XmlElement String userEmail @XmlElement String iban @XmlElement String bic @XmlElement String ustid @XmlElement String separef @XmlElement String state @XmlElement Long cts_ts } ==Beschreibung == Ermittelt alle Werte eines speziellen Kundeneintrages. ==== RetrieveTariffService ==== == Parameter == String itentis, String itoris, String tariffName == Return == CustomerTariffData { @XmlElement String tariffName @XmlElement String tariffDescription @XmlElement Double factorFee @XmlElement Double constantFee @XmlElement Boolean recurring @XmlElement Boolean usagebound @XmlElement String intervall @XmlElement Double upperBound @XmlElement Double lowerBound ==Beschreibung == Ermittelt die Werte eines Vertragstarifs.