Durchsuchbare Dokumentation aufrufen | Zurück zur Dokumentationsübersicht
Navigation: Dokumentationen agorum core > agorum core für Entwickler > agorum core JavaScript-API
JavaScript Address API - get
Mit dem Aufruf get erhalten Sie einzelne Objekte.
getEmails
Mit diesem Aufruf erhalten Sie E-Mail-Adressen.
- Das Ergebnis ist ein Array aus E-Mail-Adressen.
- Die E-Mail-Adressen können entweder bei der Firma, der Abteilung oder bei der Person hinterlegt sein.
Beispiel
// Aufruf
address.getEmails(object [, own [, def ]]);
// object kann sein: D4wAddressContainer, D4wAddressOrganisation, D4wAddressDepartment und D4wAddressPerson
// own = true/false: Liefert die Werte, bei denen own === true oder own === false ist.
// def = true/false: Liefert die Werte, bei denen default === true oder default === false ist.
// Beispiel
let aes = address.getEmails(organisation, true, true);
// Das Ergebnis ist ein Array mit folgender Struktur:
[
{
"default" : true, // true === ist die Standard-E-Mail-Adresse des Objekts, auf das belongTo verweist.
"address" : "info3@agorum.com", // Definiert die E-Mail-Adresse.
"completeAddress" : "\"agorum Software GmbH\" <info3@agorum.com>", // Definiert die E-Mail-Adresse inkl. Namen.
// Kann etwa für eine E-Mail verwendet werden.
"own" : false, // true = Standard-E-Mail-Adresse des übergebenen Objekts
"id" : "1144789", // Definiert die id des Objekts.
"uuid" : "a-uuid", // Definiert die uuid des Objekts.
"type" : "mail", // Definiert den type (immer mail).
"belongsTo" : "1139314" // Definiert das Objekt, an dem dieses Objekt verknüpft ist.
}
]
Ergebnis
[
{
"default" : true,
"address" : "info3@agorum.com",
"completeAddress" : "\"agorum Software GmbH\" <info3@agorum.com>",
"own" : false,
"id" : "1144789",
"uuid" : "c2341d40-070c-11ec-ae43-02420a0a000f",
"type" : "mail",
"belongsTo" : "1139314"
},
{
"default" : false,
"address" : "info.developer@agorum.com",
"completeAddress" : "\"Abteilung Entwicklung\" <info.developer@agorum.com>"
"own" : false,
"id" : "1144794",
"uuid" : "c2341d40-070c-11ec-ae43-02420a0a000f",
"type" : "mail",
"belongsTo" : "1139373"
},
{
"default" : true,
"address" : "rolf.lang@agorumcore.de",
"completeAddress" : "\"Dipl. Ing. (FH) Rolf Lang\" <rolf.lang@agorumcore.com>"
"own" : true,
"id" : "1144799",
"uuid" : "c2341d40-070c-11ec-ae43-02420a0a000f",
"type" : "mail",
"belongsTo" : "1139405"
}
]
getPhoneNumbers
Mit diesem Aufruf erhalten Sie eine Telefonnummer.
Die Telefonnummer kann entweder bei der Firma, der Abteilung oder bei der Person hinterlegt sein.
Beispiel
// Aufruf
address.getPhoneNumbers(object, type [, own [, def ]]);
// object kann sein: D4wAddressContainer, D4wAddressOrganisation, D4wAddressDepartment und D4wAddressPerson
// type kann sein: 'fax', 'telephone', 'mobile', null === alle
//Beispiel
let als = address.getPhoneNumbers(organisation, null, true, true);
// Das Ergebnis ist ein Array mit folgender Struktur:
[
{
"number" : "3461062", // Definiert die Hauptnummer.
"default" : true, // true === Standard-E-Mail-Adresse des Objekts, auf das belongTo verweist.
"directAccess" : " ", // Definiert die Durchwahl.
"countryCode" : "+49", // Definiert die Länderkennung.
"prefix" : "711", // Definiert die Vorwahl.
"own" : false, // true = Standard-E-Mail-Adresse des übergebenenen Objekts
"id" : "1144809", // Definiert die id des Objekts.
"uuid" : "a-uuid", // Definiert die uuid des Objekts.
"type" : "fax", // Definiert den type der Nummer.
"belongsTo" : "1139373", // Definiert das Objekt, an dem dieses Objekt verknüpft ist.
"completeNumber" : "+49 711 3461062" // Definiert die komplette Nummer.
}
]
Ergebnis
[
{
"number" : "3461062",
"default" : true,
"directAccess" : " ",
"countryCode" : "+49",
"prefix" : "711",
"own" : false,
"id" : "1144809",
"uuid" : "c2341d40-070c-11ec-ae43-02420a0a000f",
"type" : "fax",
"belongsTo" : "1139373",
"completeNumber" : "+49 711 3461062"
},
{
"number" : "34610",
"default" : true,
"directAccess" : "61",
"countryCode" : "+49",
"prefix" : "711",
"own" : false,
"id" : "1144804",
"uuid" : "c2341d40-070c-11ec-ae43-02420a0a000f",
"type" : "telephone",
"belongsTo" : "1139314",
"completeNumber" : "+49 711 34610-61"
},
{
"number" : "34610",
"default" : true,
"directAccess" : "60",
"countryCode" : "+49",
"prefix" : "711",
"own" : true,
"id" : "1144814",
"uuid" : "c2341d40-070c-11ec-ae43-02420a0a000f",
"type" : "telephone",
"belongsTo" : "1139405",
"completeNumber" : "+49 711 34610-60"
}
]
getLinks
Mit diesem Aufruf erhalten Sie einen Link.
Der Link kann entweder bei der Firma, der Abteilung oder bei der Person hinterlegt sein.
Beispiel
// Aufruf
address.getLinks(objct [, own [, def ]]);
// object kann sein: D4wAddressContainer, D4wAddressOrganisation, D4wAddressDepartment und D4wAddressPerson
//Beispiel
let link = address.getLinks(organisation, true, true);
// Das Ergebnis ist ein Array mit folgender Struktur:
[
{
"default" : true, // true === Standard-E-Mail-Adresse des Objekts, auf das belongTo verweist.
"subject" : "Webseite 2", // Definiert die Beschreibung des Links.
"own" : false, // true = Standard-E-Mail-Adresse des übergebenen Objekts
"link" : "http://www.agorum.com/2", // Definiert den Link.
"id" : "1144824", // Definiert die id des Objekts.
"uuid" : "a-uuid", // Definiert die uuid dieses Objekts.
"belongsTo" : "1139373" // Definiert das Objekt, an dem dieses Objekt verknüpft ist.
}
]
Ergebnis
[
{
"default" : true,
"subject" : "Webseite 2",
"own" : false,
"link" : "http://www.agorum.com/2",
"id" : "1144824",
"uuid" : "c2341d40-070c-11ec-ae43-02420a0a000f",
"belongsTo" : "1139373"
},
{
"default" : true,
"subject" : "Webseite",
"own" : false,
"link" : "http://www.agorum.com/1",
"id" : "1144819",
"uuid" : "c2341d40-070c-11ec-ae43-02420a0a000f",
"belongsTo" : "1139314"
},
{
"default" : true,
"subject" : "Webseite 3",
"own" : true,
"link" : "http://www.agorum.com/3",
"id" : "1144829",
"uuid" : "c2341d40-070c-11ec-ae43-02420a0a000f",
"belongsTo" : "1139405"
}
]
getData
Mit diesem Aufruf erhalten Sie die Adressdaten (data) des Objekts inklusive vererbter Informationen.
Hat eine Person keine eigene Adresse, liefert das System die Adresse der übergeordneten Abteilung oder Organisation zurück. Die Vererbungsreihenfolge ist: Person → Abteilung → Organisation.
Beispiel
// Aufruf
address.getData(object);
// object kann sein: 'D4wAddressContainer', 'D4wAddressOrganisation',
// 'D4wAddressDepartment' oder 'D4wAddressPerson'
// Beispiel: Adressdaten einer Person holen (inkl. vererbter Daten)
let dataOrganisation = address.getData(organisation);
let dataPerson = address.getData(person);
// Das Ergebnis ist ein Array mit folgender Struktur:
[
{
"description": "Beschreibung der Adresse",
"street1": "Straßenname",
"zip": "PLZ",
"city": "Stadt",
"state": "Bundesstaat",
"country": "Ländercode",
"postBox": "Postfach Nr",
"houseNumber1": "Hausnummer",
"zippostbox": "PLZ Postfach Nr",
"citypostbox": "Stadt Postfach Nr",
"id": "1144829",
"uuid": "c2341d40-070c-11ec-ae43-02420a0a000f"
}
]
getMyData
Mit diesem Aufruf erhalten Sie die in data definierten Werte des Objekts.
Bei Organisationen und Abteilungen ignoriert das System vererbte Informationen und liefert nur die eigenen Adressdaten zurück.
Hinweis für Personen (D4wAddressPerson): Bei Personen verhält sich getMyData identisch zu getData und liefert vererbte Adressdaten zurück. Hat die übergeordnete Organisation oder Abteilung eine Adresse, wird diese auch für die Person zurückgegeben, selbst wenn die Person keine eigene Adresse besitzt. Dies hat folgende Auswirkungen:
address.create('data', { target: person })schlägt mit dem Fehler "Only one data is allowed" fehl, wenn die übergeordnete Organisation bereits eine Adresse hat.- Um zu prüfen, ob eine Person eine eigene Adresse hat, verwenden Sie stattdessen die Java-Property
d4wMyAddressDataauf dem Container-Objekt.
Beispiel
// Aufruf
address.getMyData(object);
// object kann sein: 'D4wAddressContainer','D4wAddressOrganisation',
// 'D4wAddressDepartment' oder 'D4wAddressPerson'
//Beispiel
let dataDepartment = address.getMyData(departmentZSB);
// Das Ergebnis ist ein Array mit folgender Struktur:
[
{
"description": "Beschreibung der Adresse",
"street1": "Straßenname",
"zip": "PLZ",
"city": "Stadt",
"state": "Bundesstaat",
"country": "Ländercode", // siehe CSV-Datei: d4w_address_data_country.csv
"postBox": "Postfach Nr",
"houseNumber1": "Hausnummer",
"zippostbox": "PLZ Postfach Nr",
"citypostbox": "Stadt Postfach Nr",
"id" : "1144829",
"uuid" : "c2341d40-070c-11ec-ae43-02420a0a000f",
}
]
Ergebnis
[
{
"description": "Beschreibung der Adresse",
"street1": "Huberstrasse",
"zip": "65432",
"city": "Kulgow",
"country": "de",
"postBox": "12233",
"houseNumber1": "28",
"id" : "1144829",
"uuid" : "c2341d40-070c-11ec-ae43-02420a0a000f",
}
]
getPerson
Mit diesem Aufruf erhalten Sie die Daten einer Person.
Wenn das System keine Person findet, erhalten Sie null zurück.
Beispiel
// Aufruf
address.getPerson(object [, data ]);
// object kann sein: FolderObject, 'D4wAddressOrganisation', 'D4wAddressDepartment'
// data sind Vorname und Nachname der Person
Oder
object kann sein: D4wAddressContainer
// data wird dann nicht benötigt, sondern es wird direkt die Person des Containers ausgelesen.
//Beispiel
let os = address.getPerson(departmentGL, {givenName: 'Vorname OS', familyName:'Nachname OS' });
//Beispiel 2
let rl = address.getPerson(container);
// Das Ergebnis ist ein Array mit folgender Struktur:
[
{
"salutation": "Anrede", // Auswahl aus mr, mrs, mrmrs, family
"title": "titel", // Definiert den Titel der Person, sofern vorhanden.
"givenName": "Bob", // Definiert den Vornamen.
"familyName": "Müller", // Definiert den Nachnamen.
"dateOfBirth": "1978-09-17T12:00:00.000+02:00", // Definiert das Geburtsdatum.
"sex": "male", // Definiert das Geschlecht.
"maidenName": "Kurz", // Definiert den Geburtsnamen.
"description": "Beschreibung", // Definiert eine optionale Beschreibung der Person.
"welcomeMessage": "Sehr geehrter Herr Nachname", // Definiert eine Willkommensnachricht.
"id" : "1144829",
"uuid" : "c2341d40-070c-11ec-ae43-02420a0a000f"
}
]
Ergebnis
[
{
"salutation": "mr",
"title": "Dipl.Ing.(FH)",
"givenName": "Bob",
"familyName": "Müller",
"dateOfBirth": "1978-09-17T12:00:00.000+02:00",
"sex": "male",
"maidenName": "Kurz",
"description": "Herr Müller ist Softwareentwickler bei Firma Y.",
"welcomeMessage": "Sehr geehrter Herr Müller",
"id" : "1144829",
"uuid" : "c2341d40-070c-11ec-ae43-02420a0a000f"
}
]
getInfo
Mit diesem Aufruf erhalten Sie Informationen zu einer Person.
Wenn das System keine Person findet, erhalten Sie null zurück.
Beispiel
// Aufruf
address.getInfo(object);
// object kann sein: Person oder Containerobject, von dem die Information geholt werden soll.
//Beispiel
let osInfo = address.getInfo(os);
// Das Ergebnis ist ein Array mit folgender Struktur:
[
{
"jobTitle": "Job Bezeichnung", // Definiert die Jobbezeichnung der Person.
"activityRate": 100, // Definiert, mit wie viel Prozent der Job ausgeübt wird.
"id" : "1144829",
"uuid" : "c2341d40-070c-11ec-ae43-02420a0a000f"
}
]
Ergebnis
[
{
"jobTitle": "Softwareentwickler",
"activityRate": 100,
"id" : "1144829",
"uuid" : "c2341d40-070c-11ec-ae43-02420a0a000f"
}
]
getOrganisation
Mit diesem Aufruf erhalten Sie Informationen zu einer Organisation.
Wenn das System keine Organisation findet, erhalten Sie null zurück.
Beispiel
// Aufruf
address.getOrganisation(object);
// object kann sein: 'D4WADDRESSCONTAINER', 'D4WADDRESSPERSON', 'D4wAddressOrganisation', 'D4wAddressDepartment'
//Beispiel
let orga = address.getOrganisation(os);
// Das Ergebnis ist ein Objekt mit folgender Struktur:
{
name: 'Name Organisation',
additionalName1: 'Zusatzname 1',
additionalName2: 'Zusatzname 2',
customerNumber: 'Kundennummer',
salesTaxIdentificationNumber: 'Ust-Id',
taxNumber: 'Steuernummer',
description: 'beliebige Beschreibung',
"id" : "1144829",
"uuid" : "c2341d40-070c-11ec-ae43-02420a0a000f"
}
Ergebnis
{
"additionalName1" : "",
"salesTaxIdentificationNumber" : "DE198023952",
"name" : "agorum Software GmbH",
"taxNumber" : "",
"description" : "Hersteller des DMS agorum core",
"customerNumber" : "1221",
"additionalName2" : "",
"id" : "1144829",
"uuid" : "c2341d40-070c-11ec-ae43-02420a0a000f"
}
getDepartment
Mit diesem Aufruf erhalten Sie Informationen zu einem Department (Abteilung).
Wenn das System kein Department findet, erhalten Sie null zurück.
Beispiel
// Aufruf
address.getDepartment(object);
// object kann sein: 'D4WADDRESSCONTAINER', 'D4WADDRESSPERSON', 'D4wAddressDepartment'
//Beispiel
let depart = address.getDepartment(os);
// Das Ergebnis ist ein Objekt mit folgender Struktur:
{
name: '<Name der Abteilung>',
additionalName1: '<Zusatzname 1>',
additionalName2: '<Zusatzname 2>',
customerNumber: '<Abteilungsnummer>',
taxNumber: '<Steuernummer>',
description: '<beliebige Beschreibung>',
salesTaxIdentificationNumber: '<Ust-Id>',
"id" : "1144829",
"uuid" : "c2341d40-070c-11ec-ae43-02420a0a000f"
}
Ergebnis
{
"additionalName1" : "",
"salesTaxIdentificationNumber" : "",
"name" : "Gesch\u00E4ftsleitung",
"taxNumber" : "",
"description" : "",
"customerNumber" : "",
"additionalName2" : "",
"id" : "1144829",
"uuid" : "c2341d40-070c-11ec-ae43-02420a0a000f"
}
getBooks
Mit diesem Aufruf erhalten Sie alle Adressbücher, in denen eine Person enthalten ist.
Aufruf: let books = address.getBooks(<object>);
object: Muss eines der folgenden Objekttypen sein:
D4wAddressOrganisation, D4wAddressDepartment, D4wAddressContainer, D4wAddressPerson
return: [ D4wAddressBook, .... ]
[ 0 ... n ] Adressbücher, in denen "object" enthalten ist.
Beispiel
let address = require('address/objects');
// Person holen und dann die Adressbücher holen, in denen die Person enthalten ist.
let person = address.query('person', {givenName: 'Rolf', familyName: 'Lang'}).limit(1).find()[0];
let books = address.getBooks(person);
getPersonOrganisation
Mit diesem Aufruf erhalten Sie alle Organisation, in der eine Person enthalten ist.
Wenn das System keine Organisation findet, in der die Person enthalten ist, erhalten Sie null zurück.
Aufruf: let organisation = address.getPersonOrganisation(person);
person: D4wAddressContainer, D4wAddressPerson
Hinweis: Wenn D4wAddressPerson übergeben wird, wird nur dann etwas zurückgeliefert, wenn nur 1 Container vorhanden ist.
return: Die Organisation (D4wAddressOrganisation), in der die Person enthalten ist.
Beispiel
let address = require('address/objects');
// Person holen und dann die Organisation holen, in der die Person enthalten ist.
let person = address.query('person', {givenName: 'Rolf', familyName: 'Lang'}).limit(1).find()[0];
let books = address.getPersonOrganisation(person);
getPersonDepartment
Mit diesem Aufruf erhalten Sie alle Abteilungen, in denen eine Person enthalten ist.
Wenn das System keine Abteilung findet, in der die Person enthalten ist, erhalten Sie null zurück.
Aufruf: let department = address.getPersonDepartment(person);
person: D4wAddressContainer, D4wAddressPerson
Hinweis: Wenn D4wAddressPerson übergeben wird, wird nur dann etwas zurückgeliefert, wenn nur 1 Container vorhanden ist.
return: Die Abteilung (D4wAddressDepartment), in der die Person enthalten ist.
Beispiel
let address = require('address/objects');
// Person holen und dann die Organisation holen, in der die Person enthalten ist.
let person = address.query('person', {givenName: 'Rolf', familyName: 'Lang'}).limit(1).find()[0];
let department = address.getPersonDepartment(person);
getPersonContainer
Mit diesem Aufruf erhalten Sie den Container, in dem eine Person enthalten ist.
Wenn eine Person mehreren Containern zugeordnet ist, erhalten Sie keinen Container zurück.
Aufruf: let container = address.getPersonContainer(person);
Object: D4wAddressContainer, D4wAddressPerson
Hinweis: Wenn D4wAddressPerson übergeben wird, wird nur dann etwas zurückgeliefert, wenn nur 1 Container vorhanden ist.
return: Der Container (D4wAddressContainer), in dem die Person zugeordnet ist.
Beispiel
let address = require('address/objects');
// Person holen und dann den Container holen, in dem die Person enthalten ist.
let person = address.query('person', {givenName: 'Rolf', familyName: 'Lang'})
.limit(1)
.find()[0]
.d4wAddressPerson; // D4wAddressPerson - Objekt holen
let container = address.getPersonContainer(person);