JavaScript Address API - update

Mit dem Aufruf update aktualisieren Sie bestehende Daten.

Verwendung

---

Binden Sie die Bibliothek stets am Anfang eines Skripts ein:

let address = require('address/objects');

update.book

---

Mit diesem Aufruf aktualisieren Sie ein Adressbuch.

data befüllen Sie wie folgt:

let object = objects.find('<zu aktualisierendes Objekt>');
  
let data = {
  name:         '<Name des Addressbuchs>',
  description:  '<Beschreibung des Addressbuchs>' 
                // optional
};

Bestehende Daten auslesen

Wenn das Objekt bekannt ist, lesen Sie die bestehenden Daten folgendermaßen aus:

let name = object.name;
let description = object.description;

Beispiel

let address = require('address/objects'); 
let objects = require('common/objects'); 

let object = objects.find('<zu aktualisierendes Objekt>'); 

let data = { 
  name:        'Unsichtbare Universität aktualisiert', 
  description: 'Version 2.0'   
               // optional 
}; 

//Aufruf:
address.update('book', object, data);

update.organisation

---

Mit diesem Aufruf aktualisieren Sie eine Organisation.

data befüllen Sie wie folgt:

let object = objects.find('<zu aktualisierendes Objekt>');
  
let data = {
  name:            '<Name der Organisation>',
  additionalName1: '<Zusatzname 1>',
  additionalName2: '<Zusatzname 2>',
  customerNumber:  '<Kundennummer>',
  taxNumber:       '<Steuernummer>',
  description:     '<beliebige Beschreibung>',
  salesTaxIdentificationNumber: '<Ust-Id>'
};

Bestehende Daten auslesen

Wenn das Objekt bekannt ist, lesen Sie die bestehenden Daten folgendermaßen aus:

object.name - set und get,
object.additionalName1 set und get,
object.additionalName2 - set und get,
object.customerNumber - set und get,
object.salesTaxIdentificationNumber - set und get,
object.taxNumber - set und get,
object.description - set und get

Beispiel

let address = require('address/objects'); 
let objects = require('common/objects'); 

let object = objects.find('1337');
  
let data = {
  name:            'Ankh Organisation',
  additionalName1: 'Morkpork',
  additionalName2: ' ',
  customerNumber:  '456987',
  taxNumber:       '10 321 654 988',
  description:     'aktualisierte Beschreibung',
  salesTaxIdentificationNumber: 'DE999999990'
};

//Aufruf: 
address.update ('organisation', object, data);

update.department

---

Mit diesem Aufruf aktualisieren Sie eine Abteilung.

data befüllen sie wie folgt:

let object = objects.find('<zu aktualisierendes Objekt>');
  
let data = {
  name:            '<Name der Abteilung>',
  additionalName1: '<Zusatzname 1>', 
  additionalName2: '<Zusatzname 2>',
  customerNumber:  '<Abteilungsnummer>',
  taxNumber:       '<Steuernummer>',
  description:     '<beliebige Beschreibung>',
  salesTaxIdentificationNumber: '<Ust-Id>'
};

Bestehende Daten auslesen

Wenn das Objekt bekannt ist, lesen Sie die bestehenden Daten folgendermaßen aus:

object.getName(),
object.getAdditionalName1(),
object.getAdditionalName2(),
object.getCustomerNumber(),
object.getSalesTaxIdentificationNumber(),
object.getTaxNumber(),
object.getDescription()

Beispiel

let address = require('address/objects'); 
let objects = require('common/objects'); 

let object = objects.find('787844');
  
let data = {
  name:            'Niederlassung Hamburg',
  additionalName1: 'Z-Name 1 - Hamburg',
  additionalName2: 'Z-Name 2 - Hamburg',
  customerNumber:  'Kundennummer',
  taxNumber:       '10 385 654 568',
  description:     'Abteilung der Qualitätssicherung',
  salesTaxIdentificationNumber: 'DE111111111'
};

//Aufruf
address.update ('department', object, data);

update.person

---

Mit diesem Aufruf aktualisieren Sie eine Person.

data befüllen Sie wie folgt:

let object = objects.find('<zu aktualisierendes Objekt>');

let data = { 
  salutation:     '<Anrede>', 
                  // Auswahlmöglichkeiten: mr; mrs; mrmrs; family 
                  // (Herr, Frau, Herr und Frau, Familie) 
  title:          '<Titel>', 
  givenName:      '<Vorname>', 
  familyName:     '<Familienname>', 
  familyStatus:   '<Familienstatus>',   
                  // Auswahlmöglichkeiten: unmarried (ledig), married (verheiratet),   
                  // unknown (-) 
  dateOfBirth:    '<Geburtstag (Datum)>', 
  description:    '<beliebige Beschreibung>', 
  sex:            '<Geschlecht>',   
                  // Auswahlmöglichkeiten: male (männlich), female (weiblich), 
                  // unknown (unbekannt) 
  placeOfBirth:   '<Geburtsort>', 
  maidenName:     '<Geburtsname>',
  welcomeMessage: '<Sehr geehrter Herr Familienname>'  
};

Bestehende Daten auslesen

Wenn das Objekt bekannt ist, lesen Sie die bestehenden Daten folgendermaßen aus:

let person = object.getD4wAddressPerson();
  
person.getGivenName(),
person.getFamilyName(),
person.getFamilyState(),
person.getMaidenName(),
person.getTitle(),
person.getSalutation(),
person.getDescription()

Beispiel

let address = require('address/objects'); 
let objects = require('common/objects'); 

let object = objects.find('37895');

let data = {
  salutation:     'mr',
  title:          'Dipl.Ing.(FH) Update',
  givenName:      'Rolf Wolf',
  familyName:     'Lang Kurz',
  dateOfBirth:    new Date('1966-08-12T12:00:00.000+02:00'),
  description:    'Neuer Projektleiter',
  sex:            'male',
  placeOfBirth:   'Denkendorf',
  maidenName:     'Geburtsname',
  welcomeMessage: 'Sehr geehrter Herr Lang Kurz'    
};

//Aufruf
address.update ('person', object, data);

update.mail

---

Mit diesem Aufruf aktualisieren Sie die E-Mail-Adresse.

data befüllen Sie wie folgt: 

let object = objects.find('<zu aktualisierendes Objekt>');

let data = {
  mailAddress:        '<email@adresse.com',
  defaultMailAddress: true/false 
                      // ob Standard-E-Mail-Adresse
};

Bestehende Daten auslesen

Wenn das Objekt bekannt ist, lesen Sie die bestehenden Daten folgendermaßen aus:

object.getMailAddress(),
object.getDefaultMailAddress()

Beispiel

let address = require('address/objects'); 
let objects = require('common/objects'); 

let object = objects.find('42456');

let data = { 
  mailAddress:        'rolf.lang.neu@agorum.de',
  defaultMailAddress: true
};

//Aufruf 
address.update ('mail', object, data);

update.phone

---

Mit diesem Aufruf aktualisieren Sie die Telefonnummer.

data befüllen Sie wie folgt:

let object = objects.find('<zu aktualisierendes Objekt>');
  
let data = {
  type:          '<Art der Nummer>',     
                 // Auswahlmöglichkeiten: telephone/mobile/fax
                 // (siehe CSV-Datei: d4w_address_phone_type.csv)     
  defaultNumber: true/false, 
                 // ob Standardtelefonnummer     
  phoneNumber:   'Telefonnummer' 
                 // Muss so formatiert werden:                 
                 //  +Land Vorwahl Nummer-Durchwahl                  
                 //  +Land Vorwahl Nummer (wenn es keine Durchwahl gibt)    
}; 

Bestehende Daten auslesen

Wenn das Objekt bekannt ist, lesen Sie die bestehenden Daten folgendermaßen aus:

object.getType(),
object.getDefaultNumber(),
object.getCompleteNumberNormalized()

Beispiel

let address = require('address/objects'); 
let objects = require('common/objects'); 

let object = objects.find('89894');
  
let data = {
  type:          'telephone',
  defaultNumber: true,
  phoneNumber:   '+49 711 34610-60'
};

//Aufruf
address.update ('phone', object, data);

update.link

---

Mit diesem Aufruf aktualisieren Sie einen Link.

data befüllen Sie wie folgt:

let object = objects.find('<zu aktualisierendes Objekt>');
  
let data = {
  link:        '<URL>',
  defaultLink: '<Standardlink true/false>',
  subject:     'Webseite 2'
};

Bestehende Daten auslesen

Wenn das Objekt bekannt ist, lesen Sie die bestehenden Daten folgendermaßen aus:

object.getLink(),
object.getDefaultLink(),
object.getSubject()

Beispiel

let address = require('address/objects'); 
let objects = require('common/objects'); 


let object = objects.find('8457');
  
let data = {
  link:        'http://www.agorum.com/2',
  defaultLink: true, 
               // true oder false
  subject:     'Webseite 2'
};

//Aufruf
address.update ('link', object, data);

update.info

---

Mit diesem Aufruf aktualisieren Sie die Zusatzinformation zu einer Person.

data befüllen Sie wie folgt:

let object = objects.find('<Zu aktualisierendes Objekt>');
  
let data = {
  jobTitle:     '<Berufsbezeichnung>',
  activityRate: '<Integer-Zahl, mit wie viel Prozent der Job gemacht wird>'
};

Bestehende Daten auslesen

Wenn das Objekt bekannt ist, lesen Sie die bestehenden Daten folgendermaßen aus:

object.getJobTitle(),
object.getActivityRate()

Beispiel

let address = require('address/objects'); 
let objects = require('common/objects'); 

let object = objects.find('85947');

let data = { 
  jobTitle:     'Softwareentwicklung', 
  activityRate: 100 
};

//Aufruf
address.update ('info', object, data);

update.data

---

Mit diesem Aufruf aktualisieren Sie die Ortsadresse.

data befüllen Sie wie folgt:

let object = objects.find('<zu aktualisierendes Objekt>');
  
let data = { 
  street1:      '<Straßenname>', 
  zip:          '<PLZ>', 
  city:         '<Ort>', 
  state:        '<Bundesland>', 
  country:      '<Ländercode>',
                // (siehe CSV-Datei: d4w_address_data_country.csv) 
  postBox:      '<Postboxnummer>', 
  zipPostBox:   '<PLZ der Postbox>', 
  cityPostBox:  '<Ort der Postbox>', 
  houseNumber1: '<Hausnummer>'
};

Bestehende Daten auslesen

Wenn das Objekt bekannt ist, lesen Sie die bestehenden Daten folgendermaßen aus:

object.getStreet1(),
object.getStreet2(),
object.getStreet3(),
object.getZip(),
object.getCity(),
object.getState(),
object.getCountry(),
object.getPostBox(),
object.getZipPostBox(),
object.getCityPostBox(),
object.getHouseNumber1()
object.getHouseNumber2()
object.getHouseNumber3()

Beispiel

let address = require('address/objects'); 
let objects = require('common/objects'); 

let object = objects.find('963582');

let data = { 
  street1:      'Vogelsangstrasse', 
  zip:          '73760', 
  city:         'Ostfildern', 
  state:        'Baden Württemberg', 
  country:      'de', 
  postBox:      '16423', 
  zipPostBox:   '73770', 
  cityPostBox:  'Denkendorf', 
  houseNumber1: '16'
};

//Aufruf
address.update ('data', object, data);