Servicebeskrivelse
Servicebeskrivelse
Servicebeskrivelser
|
|||||
KommunikationAftaleHent |
|||||
System: |
Encyclopedia: |
Version: |
Oprettet: |
Dato: |
|
AogD |
Graensesnit_1_8 |
1.0 |
2013-07-17 |
2013-07-17 |
|
Formål: |
|||||
Henter en kommunikationsaftale |
|||||
Overordnet beskrivelse af funktionalitet: |
|||||
Kan hentes enten ud fra kundenummer eller ud fra aftalenummer, men kalderen starter altid med at tage udgangspunkt i kunden.
Aftalen indeholder kundens valg af sprog, evt. kunderepræsentantforhold, liste af præferencer samt en kommunikationsmappe.
For kunderepræsentantforholdenes aftaler og kommunikationsmappen returneres en transitiv nøgle, der efterfølgende kan bruges i kald af KommunikationMappeHent.
Servicen returnerer desuden antallet af meddelelser under aftalen (pt.). |
|||||
Datastrukturer |
|||||
Input: |
|||||
KommunikationAftaleHent_I |
|||||
KundeNummer |
|||||
Output: |
|||||
KommunikationAftaleHent_O |
|||||
KundeNummer KommunikationAftaleSprog KommunikationAftaleSamtykke KommunikationAftaleGyldigFra (KommunikationAftaleGyldigTil)
* KommunikationPræferencListe * 0{ * KommunikationPræference * [ (MeddelelseTypeNummer) * MeddelelseKanal * [ KanalAdresseIndex KanalTypeNummer (KanalAdresseStruktur) KanalAdresseAktivMarkering KanalAdresseFejlmarkeret ] ( * AdvisKanal * [ KanalAdresseIndex KanalTypeNummer KanalAdresseStruktur KanalAdresseAktivMarkering KanalAdresseFejlmarkeret ] ) KommunikationPræferenceGyldigFra KommunikationPræferenceGyldigTil KommunikationPræferenceNiveau (MeddelelseTypeGruppeNavn) (MeddelelseTypeNavn) ] } KommunikationAftaleMeddelelseAntal |
|||||
Referencer fra use case(s) |
|||||
|
|||||
Noter |
|||||
Skal laves i SKAT XML Skal udstilles til kald fra SKAT IP
Fejlsituationer: - Kunde findes ikke - Kommunikationsaftale findes ikke |
|||||
Fælles datastrukturer
|
AdresseStruktur |
* Adresse * [ (AdresseFortløbendeNummer) (AdresseAnvendelseKode) (AdresseVejNavn) (AdresseVejKode) (AdresseFraHusNummer) (AdresseTilHusNummer) (AdresseFraHusBogstav) (AdresseTilHusBogstav) (AdresseLigeUlige) (AdresseEtageTekst) (AdresseSideDørTekst) (AdresseCONavn) (AdressePostNummer) (AdressePostDistrikt) (AdresseByNavn) (AdressePostBox) (AdresseGyldigFra) (AdresseGyldigTil) (AdresseTypeKode) (AdresseTypeTekst) (AdresseTypeGyldigFra) (AdresseTypeGyldigTil) (LandKode) (LandNavn) ] |
|
AlternativAdresseStruktur |
* AlternativAdresse * [ (AlternativAdresseFortløbendeNummer) (AlternativAdresseAnvendelseKode) (AlternativAdresseAdresseLinie1) (AlternativAdresseAdresseLinie2) (AlternativAdresseAdresseLinie3) (AlternativAdresseAdresseLinie4) (AlternativAdresseAdresseLinie5) (AlternativAdresseAdresseLinie6) (AlternativAdresseAdresseLinie7) (AlternativAdresseGyldigFra) (AlternativAdresseGyldigTil) (AdresseTypeKode) (AdresseTypeTekst) (AdresseTypeGyldigFra) (AdresseTypeGyldigTil) (LandKode) (LandNavn) ] |
|
EmailAdresseStruktur |
* EmailAdresse * [ (EmailAdresseEmail) (EmailAdresseGyldigFra) (EmailAdresseGyldigTil) ] |
|
FaxNummerStruktur |
* FaxNummer * [ (FaxNummer) (FaxLandeKode) (FaxGyldigFra) (FaxGyldigTil) ] |
|
KanalAdresseStruktur |
* AdresseValg * [ AdresseStruktur | AlternativAdresseStruktur | TelefonNummerStruktur | EmailAdresseStruktur | FaxNummerStruktur ] |
|
TelefonNummerStruktur |
* TelefonNummerStruktur * [ (TelefonNummer) (TelefonLandeKode) (TelefonGyldigFra) (TelefonGyldigTil) (TelefonTypeKode) (TelefonTypeTekst) (TelefonTypeGyldigFra) (TelefonTypeGyldigTil) ] |
Dataelementer
Dataelement |
Datatype |
Beskrivelse/værdisæt |
AdresseAnvendelseKode |
base: integer totalDigits: 1 enumeration: 0, 1, 8, 9 |
Kode som angiver adresseringsmuligheder. 0 = Adressen kan anvendes til direkte adressering 1 = Adressen kan ikke anvendes til direkte xxxxxxxxxxx 0 = Adressen xxxxxx xxx xx xxxx 0 = Ingen adresse pga. nyt personnummer
Værdisæt: 0 1 8 9
|
AdresseByNavn |
base: string maxLength: 300 |
Angiver bynavn (lokalt stednavn)
|
AdresseCONavn |
base: string maxLength: 300 |
Angiver navn for en CO-adresse (for virksomheder)
|
AdresseEtageTekst |
base: string maxLength: 2 |
Angiver etagen tilknyttet husnummer/husbogstav
Værdisæt: 00 - 99
|
AdresseFortløbendeNummer |
base: integer totalDigits: 5 |
Angiver fortløbende nummerering ved flere adresser af samme type og på samme tidspunkt.
Værdisæt: 00000 - 99999
|
AdresseFraHusBogstav |
base: string maxLength: 1 pattern: [a-zA-Z] |
Angiver bogstav tilknyttet husnummeret.
Ifølge bekendtgørelse om vejnavne og adresser må kun værdierne A-Z benyttes. På grund af risikoen for forveksling bør bogstaverne I, J, O og Q dog ikke benyttes
Grundlæggende værdisæt: A - Å
|
AdresseFraHusNummer |
base: integer totalDigits: 3 |
Angiver 1. husnummer i et vejafsnit i gaden eller på vejen.
Værdisæt: 000 - 999
|
AdresseGyldigFra |
base: date |
Angiver startdato for adresse (år md dg)
|
AdresseGyldigTil |
base: date |
Angiver slutdato for adressen (år md dg)
|
AdresseLigeUlige |
base: string maxLength: 10 pattern: [a-zA-ZøæåØÆÅ]* enumeration: Lige, Ulige |
Angivelse om tal er lige eller ulige.
Grundlæggende værdisæt: Lige Ulige
|
AdressePostBox |
base: integer totalDigits: 4 |
Angiver postboksnummer
Grundlæggende værdisæt: 0000 - 9999
|
AdressePostDistrikt |
base: string maxLength: 20 |
Angiver postdistriktnavn for postnummer
|
AdressePostNummer |
base: integer totalDigits: 4 minInclusive: 1 |
Angiver postnummer (4-cifre)
|
AdresseSideDørTekst |
base: string maxLength: 4 |
Angiver side/dør tilknyttet husnummer/husbogstav
|
AdresseTilHusBogstav |
base: string maxLength: 1 pattern: [a-zA-Z] |
Angiver bogstav tilknyttet husnummeret.
Ifølge bekendtgørelse om vejnavne og adresser må kun værdierne A-Z benyttes. På grund af risikoen for forveksling bør bogstaverne I, J, O og Q dog ikke benyttes
Værdisæt: A - Å
|
AdresseTilHusNummer |
base: integer totalDigits: 3 |
Angiver sidste lige husnummer i et vejafsnit i gaden eller på vejen.
Værdisæt: 000 - 999
|
AdresseTypeGyldigFra |
base: date |
En adressetypes gyldighedsstartdato
|
AdresseTypeGyldigTil |
base: date |
En adressetypes gyldighedsslutdato
|
AdresseTypeKode |
base: integer totalDigits: 3 |
Unik kode som identificerer en adressetype. Koder omfatter:
001 = Vejregisteradresse 002 = Postboksadresse 003 = Dansk adresse 004 = Udenlandsk adresse 005 = Ufuldstændig adresse
Værdisæt: 001 - 999
001 = Vejregisteradresse 002 = Postboksadresse 003 = Dansk adresse 004 = Udenlandsk adresse 005 = Ufuldstændig adresse
|
AdresseTypeTekst |
base: string minLength: 0 maxLength: 100 whitespace: preserve |
En kort beskrivelse af adressetypen, såsom "Udenlandsk adresse".
|
AdresseVejKode |
base: integer totalDigits: 4 minInclusive: 0 |
Kode der sammen med kommunenummer entydigt identificerer en vej eller en del af en vej i Danmark.
Værdisæt: 0000 - 9999
|
AdresseVejNavn |
base: string minLength: 0 maxLength: 100 whitespace: preserve |
Angiver navnet på en vej/gade i Danmark
|
AlternativAdresseAdresseLinie1 |
base: string maxLength: 70 |
Adresselinje 1
|
AlternativAdresseAdresseLinie2 |
base: string maxLength: 70 |
Adresselinie 2
|
AlternativAdresseAdresseLinie3 |
base: string maxLength: 70 |
Adresselinie 3
|
AlternativAdresseAdresseLinie4 |
base: string maxLength: 70 |
Adresselinie 4
|
AlternativAdresseAdresseLinie5 |
base: string maxLength: 70 |
Adresselinie 5
|
AlternativAdresseAdresseLinie6 |
base: string maxLength: 70 |
Adresselinie 6
|
AlternativAdresseAdresseLinie7 |
base: string maxLength: 70 |
Adresselinie 7
|
AlternativAdresseAnvendelseKode |
base: integer totalDigits: 1 enumeration: 0, 1, 8, 9 |
Beskriver adresseringsmuligheder
|
AlternativAdresseFortløbendeNummer |
base: integer totalDigits: 13 |
Angiver fortløbende nummerering ved flere adresser af samme type og på samme tidspunkt. Indikerer prioritet.
|
AlternativAdresseGyldigFra |
base: date |
Specifik dato (uden start og slutangivelse).
|
AlternativAdresseGyldigTil |
base: date |
Specifik dato (uden start og slutangivelse).
|
EmailAdresseEmail |
base: string maxLength: 320 |
En generisk email adresse, som kan være indeholde en vilkårlig emailadresse, fx. xx.xxxxxx@xxxx.xx
Grundlæggende værdisæt: Skal altid indeholde: 1. et eller flere tegn, samt 2. et @, samt 3. et eller flere tegn, samt 4. et . , samt 5. mindst to tegn
|
EmailAdresseGyldigFra |
base: date |
Dato hvorfra emailadressen er gyldig
|
EmailAdresseGyldigTil |
base: date |
Dato hvortil emailadressen er gyldig
|
FaxGyldigFra |
base: date |
Dato hvorfra faxnummeret er gyldigt
|
FaxGyldigTil |
base: date |
Dato hvortil faxnummeret er gyldigt
|
FaxLandeKode |
base: string maxLength: 5 pattern: [+][0-9]{2}|[+][0-9]{3}|[0][0][0-9]{2}|[0][0][0-9]{3} |
Telefon- og faxnummer landekode. Fx +45 eller 0045. Selve telefonnummeret indgår ikke.
|
FaxNummer |
base: string maxLength: 10 pattern: [0-9]{7}|[0-9]{8}|[0-9]{9}|[0-9]{10} |
Et faxnummer som opfylder gyldige formater for danske og udenlandske telefonnumre
|
KanalAdresseAktivMarkering |
base: boolean totalDigits: 3 |
|
KanalAdresseFejlmarkeret |
base: integer totalDigits: 1 |
Hvis en SMS eller e-mail kanaladresse er fejlet to gange, skal denne adresse markeres som fejlbehæftet, således at denne ikke anvendes igen
Grundlæggende værdisæt: 0,1,2
|
KanalAdresseIndex |
base: integer |
Nummerering af kommunikationsaftalers kanaladresser.
|
KanalTypeNummer |
base: integer totalDigits: 13 |
Et nummer som identificerer typen af kommunikationskanal
Værdisæt: 1 = Mail 2 = Sms 3 = Kun kommunikationsmappe 4 = Brev (post) 5 = Dokumentboks (ikke implementeret)
|
KommunikationAftaleGyldigFra |
base: date |
Start dato for en kommunikationsaftale.
|
KommunikationAftaleGyldigTil |
base: date |
Slut dato for en kommunikationsaftale.
|
KommunikationAftaleMeddelelseAntal |
base: integer totalDigits: 12 |
|
KommunikationAftaleSamtykke |
base: boolean totalDigits: 3 |
Angiver om kunden har afgivet samtykke til anvendelse af andre kanaladresser end brev
|
KommunikationAftaleSprog |
base: string |
Sprogpræferencer i forbindelse med mundtlig kommunikation og udsendelse af meddelelser.
Grundlæggende værdisæt: Eksempler: - Dansk - Svensk - Norsk - English - German
|
KommunikationPræferenceGyldigFra |
base: date |
Samtykkets gyldighed - start
|
KommunikationPræferenceGyldigTil |
base: date |
Samtykkets gyldighed - slut
|
KommunikationPræferenceNiveau |
base: string maxLength: 45 |
Angiver om præferencens gyldighedsområde: Alle meddelelsestyper, en specifik meddelelsestypegruppe, eller en specifik meddelelsestype
Værdisæt: 1=Generelt 2=Gruppe 3=Type
|
KundeNummer |
base: string maxLength: 11 pattern: [0-9]{8,11} |
Identifikationen af kunden i form af CVR/SE nr. for virksomheder, CPR for personer og journalnr. for dem, som ikke har et af de 2 andre typer.
|
LandKode |
base: string maxLength: 2 pattern: [A-Z]{2} |
Landekode
Grundlæggende værdisæt: Feltet skal altid være udfyldt.
ISO-standard, som hentes/valideres i Erhvervssystemets værdisæt for Lande, = elementet Land_nvn_kort.
Undtagelse er dog Grækenland, som er dispenseret fra ordningen og må bruge "EL".
|
LandNavn |
base: string minLength: 0 maxLength: 100 whitespace: preserve |
Navnet på landet
|
MeddelelseTypeGruppeNavn |
base: string minLength: 0 maxLength: 100 whitespace: preserve |
Navn på gruppen
|
MeddelelseTypeNavn |
base: string minLength: 0 maxLength: 100 whitespace: preserve |
Navn på meddelelsestypen. Se liste over værdier.
Værdisæt: Påmindelsesmail I Påmindelsesmail II Påmindelsesmail III FF brev Importspecifikationer Korrektionsangivelser Ny angivelsesfrevkvens KundeRepræsentant har indberettet Samtykke erklæring Samtykke erklæring trukket tilbage Advis ajourfør Kommunikationsaftale Advis Tilknyttet KundeRepræsentant periode ved at udløbe Slutdato for tilknyttet KundeRepræsentant periode er udløbet Afdragsordning Modregningsmeddelelse Rykkerbrev LS-betalingsfil BS-betalingsfil Udsending af udbetaling fra EFI til NemKonto Udsending af OBS-fil til SKB Opkrævning nyreg/ejerskifte Opkrævning vedr. registreringsafgift Opkrævning vedr. registreringsafgift månedlig Errindringsmeddelelse Rykker Advis vedr. tilbagebetaling af overskydende afgift Tilbagebetaling af overskydende afgift v/check Registreringsattest Meddelelse om forsikrings ophør Meddelelse til registreret ejer vedr. ejerskifte Meddelelse til registreret ejer vedr. afmeldning Meddelelse vedr. inddragelse af nummerplade EFI tiltag EFI tiltag Xxxxxx restant Meddel Fordringshaver
|
MeddelelseTypeNummer |
base: string maxLength: 18 |
Unikt ID af den enkelte meddelelsestype.
|
TelefonGyldigFra |
base: date |
Alle gyldige datoer i den danske kalender.
|
TelefonGyldigTil |
base: date |
Alle gyldige datoer i den danske kalender.
|
TelefonLandeKode |
base: string maxLength: 5 pattern: [+][0-9]{2}|[+][0-9]{3}|[0][0][0-9]{2}|[0][0][0-9]{3} |
Telefon- og faxnummer landekode. Fx +45 eller 0045. Selve telefonnummeret indgår ikke.
|
TelefonNummer |
base: string maxLength: 10 pattern: [0-9]{7}|[0-9]{8}|[0-9]{9}|[0-9]{10} |
Et telefonnummer svarende til eks: 23232323.
|
TelefonTypeGyldigFra |
base: date |
Alle gyldige datoer i den danske kalender.
|
TelefonTypeGyldigTil |
base: date |
Alle gyldige datoer i den danske kalender.
|
TelefonTypeKode |
base: string maxLength: 10 |
En kode som beskriver telefonnummeret. Der findes pt. disse i Erhvervssystemet: 1 = Telefon 2 = Telefax 3 = Mobil 4 = Elektronisk post 5 = Udenlandsk telefon 6 = Udenlandsk telefax 7 = Udenlandsk mobil
Værdisæt: 1 = Telefon 2 = Telefax 3 = Mobil 4 = Elektronisk post 5 = Udenlandsk telefon 6 = Udenlandsk telefax 7 = Udenlandsk mobil
|
TelefonTypeTekst |
base: string minLength: 0 maxLength: 100 whitespace: preserve |
Kort beskrivelse af koden. Se dokumentation på koden.
|
26. maj 2015 KommunikationAftaleHent Side 2 af 11