Abfrage Kundendaten (getCustomer)
Kunde ist am Portal angemeldet
Portal fragt anhand der customerNo die Kundeninformationen aus EVI an
EVI liefert bei Vorhandensein Kundenprofil oder Kontaktprofil, Kundenadresse und Zusatzinformationen zurück
EVI liefert im Fehlerfall entsprechende Fehlermeldung an Portal
Kundeninformationen werden dem angemeldeten Benutzer im Portal dargestellt
Besonderheiten Ablauf
Die gesamte Integration richtet sich im Ablauf nach einem Muster. Dieses ist unter Interner Ablauf auf der Seite Administrationshandbuch beschrieben. Wenn sich die hier dokumentierte Funktion von diesem Muster unterscheidet, sind die Besonderheiten hier im Folgenden aufgelistet.
Folgende Suchen ermitteln die Daten, die an das Portal geliefert werden. Sollten die Daten kundenspezifisch über andere Wege ermittelt werden, sind die Suchen zu übersteuern und anzupassen:
C12ITC_Context: Liefert Vertragsinformationen, die im Portal einen Überblick geben und für das Befüllen des Dashboards verwendet werden.
C12ITC_CustomerProfile: Liefert alle notwendigen Daten für ein Geschäftspartnerprofil
Feldmapping
Request
ITC | EVI | |||||||
---|---|---|---|---|---|---|---|---|
Feldname | Datentyp | Pflicht | Bemerkung | Entität | Techn. Entitätsname | Feld | Techn. Feldname | Bemerkung |
customerNo | String(250) | Ja* | * Wenn contactId nicht genutzt wird | Geschäftspartner | Customer | Geschäftspartnernummer | CustomerNo2 | |
contactId | String (250) | Nein | Ansprechpartnerschlüssel | Ansprechpartner | ContactPerson | Primärschlüssel | Pk |
Die Felder customerNo und contactId sind wie folgt zu verarbeiten:
customerNo | contactId | Verarbeitung |
---|---|---|
gefüllt | nicht gefüllt | customerNo verwenden |
nicht gefüllt | gefüllt | contactId verwenden |
gefüllt | gefüllt | beides verwenden |
Response
ITC | |||
---|---|---|---|
Feldname | Datentyp | Pflicht | Bemerkung |
status | String | Ja |
|
errorCode | Integer | Nein | |
customerProfile | @customerProfile | Ja | Kundenprofil |
customerAddress | @address | Ja | Standard-Kundenadresse DefaultCuAd.Address == true |
contactProfile | @contactProfile | Ja | Kontaktprofil; wenn ohne contactId angefragt wird, wird der Standardansprechpartner geliefert, sonst der zur contactId passende Ansprechpartner |
contexts | List<@contexts> | Ja |
Im Kundenprofil (customerProfile) sind folgende Informationen enthalten
ITC-Portal | EVI | ||||||||
---|---|---|---|---|---|---|---|---|---|
Feldname | Datentyp | Pflichtfeld | Bedeutung | Beispiel | Entität | Techn. Entitätsname | Feld | Techn. Feldname | Kommentar |
key | String(250) | Ja | customerNo | 08154711 | Geschäftspartner | Customer | Geschäftspartnernummer | CustomerNo2 | |
client | String(250) | Ja | Mandant | demo | Geschäftspartner | Customer | Mandant | ClientNo | |
score | Nein | Verfügbar, wird im Standard nicht genutzt | |||||||
customerType | String(250) | Nein | Verfügbar, wird im Standard nicht genutzt | ||||||
customerTypeAddition | String | Nein | Verfügbar, wird im Standard nicht genutzt | ||||||
salutation | String(250) | Nein | Typ | H - Mann | Geschäftspartner | Customer | Typ | PersonTypeKey | |
title | String(250) | Nein | Akad. Titel | Prof. Dr. | Geschäftspartner | Customer | Namenstitel | AcademicTitle | Es wird die Schlüsselbeschreibung verwendet |
firstName | String(250) | Nein | Vorname | Max | Geschäftspartner | Customer | Vorname | Name2 | |
lastName | String(250) | Nein | Nachname | Mustermann | Geschäftspartner | Customer | Nachname | Name1 | |
companyName | String(250) | Nein | Firmenname | Mustermann AG | Relevant für Gewerbekunden | ||||
letterSalutation | String(250) | Nein | Briefanrede | Sehr geehrter Herr Mustermann | Verfügbar, wird im Standard nicht genutzt | ||||
phoneNoCountry | String(250) | Nein | Telefonnummer Land | +49 | Kommunikation | Telecom | Telefon Landesvorwahl | PhoneNoCountry | Aus Standard-Telekommunikation des Geschäftspartners |
phoneNoCity | String(250) | Nein | Telefonnummer Vorwahl | 06408 | Kommunikation | Telecom | Telefon Vorwahl | PhoneNoCity | |
phoneNoBase | String(250) | Nein | Telefonnummer Rufnummer | 40000 | Kommunikation | Telecom | Telefon Rufnummer | PhoneNoBase | |
phoneNoExt | String(250) | Nein | Telefonnummer Durchwahl | 0 | Kommunikation | Telecom | Telefon Durchwahl | PhoneNoExt | |
optinPhoneNo | Im Standard nicht in Verwendung; projektindividuell | ||||||||
mobileNoCountry | String(250) | Nein | Mobilnummer Land | +49 | Kommunikation | Telecom | Mobiltelefon Landesvorwahl | MobileNoCountry | Aus Standard-Telekommunikation des Geschäftspartners |
mobileNoCity | String(250) | Nein | Mobilnummer Vorwahl | 0172 | Kommunikation | Telecom | Mobiltelefon Vorwahl | MobileNoCity | |
mobileNoBase | String(250) | Nein | Mobilnummer Rufnummer | 123456 | Kommunikation | Telecom | Mobiltelefon Rufnummer | MobileNoBase | |
mobileNoExt | String(250) | Nein | Mobilnummer Durchwahl | 71 | Kommunikation | Telecom | Mobiltelefon Durchwahl | MobileNoExt | |
optinMobileNo | Im Standard nicht in Verwendung; projektindividuell | ||||||||
faxNoCountry | String(250) | Nein | Faxnummer Land | +49 | Kommunikation | Telecom | Fax Landesvorwahl | FaxNoCountry | Aus Standard-Telekommunikation des Geschäftspartners |
faxNoCity | String(250) | Nein | Faxnummer Vorwahl | 06408 | Kommunikation | Telecom | Fax Vorwahl | FaxNoCity | |
faxNoBase | String(250) | Nein | Faxnummer Rufnummer | 40000 | Kommunikation | Telecom | Fax Rufnummer | FaxNoBase | |
faxNoExt | String(250) | Nein | Faxnummer Durchwahl | 666 | Kommunikation | Telecom | Fax Durchwahl | FaxNoExt | |
optinFaxNo | Im Standard nicht in Verwendung; projektindividuell | ||||||||
String(250) | Nein | E-Mail-Adresse | max.mustermann@musterag.de | Kommunikation | Telecom | Aus Standard-Telekommunikation des Geschäftspartners | |||
optinEmail | Im Standard nicht in Verwendung; projektindividuell | ||||||||
birthday | Date | Nein | Geburtsdatum | ISO-Format (0 Uhr, wenn keine Uhrzeit angegeben) | Personen | Person | Geburtsdatum | DateOfOrigin | Datumswert im ISO-Format ohne Uhrzeit |
role | String | Nein | Rolle | Im Standard nicht in Verwendung; projektindividuell | |||||
commercialRegisterNo | String | Nein | Handelsregisternummer | HRB 4711 | Personen | Person | Handelsregister | TradeRegister |
In der Kundenadresse (address) sind folgende Informationen enthalten
Wodurch definieren wir die Standardadresse: DefaultCuAd.Address == true
ITC-Portal | EVI | |||||||||
---|---|---|---|---|---|---|---|---|---|---|
Feldname | Datentyp | Pflichtfeld | Bedeutung | Beispiel | Entität | Techn. Entitätsname | Feld | Techn. Feldname | Werte-Mapping | Kommentar |
Adressen | Address | Adressart | AddressType |
| Wenn Adressart == STRASSE, werden die Felder street, houseNo, houseNoAffix, postalCode, city,country geliefert Wenn Adressart == POSTFACH werden postbox, postalCode, city und country geliefert | |||||
street | String(250) | Ja, wenn Adresstyp = STRASSE | Straße | Friedrich-List-Straße | Adressen | Address | Straße | Street | ||
houseNo | String(10) | Ja, wenn Adresstyp = STRASSE | Hausnummer | 31 | Adressen | Address | Hausnummer | StreetNumber | ||
houseNoAffix | String(10) | Nein | Hausnummer-Zusatz | a | Adressen | Address | Hausnr.-Erg. | StreetNumberAddition | ||
postbox | String(250) | Ja, wenn Adresstyp = POSTFACH | Postfach | 7411 | Adressen | Address | Straße | Street | Nur relevant, wenn Adresstype = POSTFACH | |
postalCode | String(5) | Ja | Postleitzahl | 35398 | Adressen | Address | PLZ | ZIPKey | ||
city | String(250) | Ja | Ort | Gießen | Adressen | Address | Ort | City | ||
country | String(2) | Nein | Land (ISO 3166-1) | DE | Adressen | Address | Land | CountryKey | ||
unitNo | String(250) | Adressen | Address | Verfügbar, wird im Standard nicht genutzt | ||||||
propertyName | String(250) | Adressen | Address | Verfügbar, wird im Standard nicht genutzt | ||||||
district | String(250) | Nein | Ortsteil | Wieseck | Adressen | Address | Ortsteil | District |
In den Kontexten (context) sind folgende Informationen enthalten
Liefert Informationen aus den jeweils verfügbaren Vertragskonten zum Geschäftspartner der übergebenen Kundennummer (customerNo)
Pro Vertrag wird ein Kontext zurückgegeben
ITC-Portal | EVI | ||||||||
---|---|---|---|---|---|---|---|---|---|
Feldname | Datentyp | Pflichtfeld | Bedeutung | Beispiel | Entität | Techn. Entitätsname | Feld | Techn. Feldname | Kommentar |
customerNo | String(250) | Ja | Kundennummer | 47110815 | Geschäftspartner | Customer | ERP-GP-Nr. | CustomerNo2 | |
contractAccountNo | String(250) | Ja | Vertragskontonummer | 10419871339 | Vertragskonto | ContractAccount | Vertragskonto-Nr. | ContAccountNo | |
contractNo | String(250) | Ja | Vertragsnummer | 12345678900 | Abrechnungsverträge | BillingContract | Vertrags-Nr. | Vertrag | Abrechnungsvertrag zu Anlagenkonto, das über Current_BC mit der übergebenen contractNo verknüpft ist |
mediaType | String(250) | Ja | Sparte | 01 - STROM | Anlagenkonto | C12INSTACC | Sparte | Medium | Anlagenkonto, das über ContractAccPk mit der übergebenen contractNo verknüpft ist EVI liefert den Schlüssel. Ein Mapping findet im Portal statt |
installationNo | String(250) | Ja | Anlagennummer | 98754654 | Anlagen | Installation | Anlagen-Nr | InstallationNo | Anlage zu Anlagenkonto, das über ContractAccPk mit der übergebenen contractNo verknüpft ist |
meterNo | String(250) | Ja | Zählernummer | 44600637 | Messeinrichtung | MeasuringDevice | Zählernummer | MeterNo | Messeinrichtung zur Anlage, die im Anlagenkonto im Feld InstallationPk verknüpft ist. Das Anlagenkonto wird indentifiziert über Abrechnungsverträge, Vertragskonto und MaLo. Einbaudatum <= HEUTE && Ausbaudatum >= HEUTE oder leer |
melo | String(250) | Ja, wenn malo leer | Messlokation | 81547119876543211478523690010419 | Anlagen | Installation | MaLo/MeLo (Zählpunktbezeichnung) | MeteringCode | |
malo | String(250) | Ja, wenn melo leer | Marktlokation | 41373559241 | Anlagenkonto | C12INSTACC | MaLo/MeLo (Zählpunktbezeichnung) | MeteringCode |