Versioner sammenlignet

Nøgle

  • Linjen blev tilføjet.
  • Denne linje blev fjernet.
  • Formatering blev ændret.

...

Operationen Indberet i webservicen er bygget op som beskrevet i de følgende afsnit.

Struktur for Indberet

Image RemovedImage Added

Indberet

Felt

Type

Krævet

Lovlige værdier

Beskrivelse

KontaktpersonInfo

XML element

Ja


Element til indberetning af kontaktperson for en eller flere elever.

KontaktpersonInfo

Felt

Type

Krævet

Lovlige værdier

Beskrivelse

Elev

XML element

Ja

Max 100

En eller flere forekomster. Angiver de elever, der skal angives kontaktpersonen for. Max 100 i ét kald.

DatakildeInstitutionNummer

Integer(10)

Ja


Institutionsnummer på kaldende institution (markering af hvem der sender data ind)

KontaktPerson

String(250)

Ja


Kontaktpersonens navn eller gruppe

KontaktTelefon

String(20)

Ja


Kontaktpersonen/gruppens telefonnummer.

KontaktMail

String(64)

Ja


Kontaktpersonen/gruppens mail.

SlutDato

DateTime

Nej


Eventuel slutdato på kontaktpersonen/gruppen.

Elev

Felt

Type

Krævet

Lovlige værdier

Beskrivelse

CPRNr

String(10)

Ja

Skal kunne findes i CPR-registeret

CPR-nummeret på den unge, som indberetningen vedrører.
Den unge skal have bopælsadresse i Danmark.

IndberetSvar

Webservicen returnerer følgende i et synkront svar.

Struktur for IndberetSvar

Image RemovedImage Added

IndberetSvar

Felt

Type

Krævet

Beskrivelse

ElevStatus

XML element

Ja

Element der indeholder markering af status på indberetning for hver af de unge der er indberettet kontaktperson på.

ElevStatus

Felt

Type

Krævet

Beskrivelse

CPRNr

String(10)

Nej

CPR-nummeret på den unge, som indberetningen vedrører.
Den unge skal have bopælsadresse i Danmark.

IndberetningOk

Boolean

Ja

Angiver om der er fundet fejl ved validering. Ved True er indberetningen af kontaktperson gået godt.

Fejlkode

Integer(10)

Nej

Fejlkode, hvis valideringer finder fejl. Ved fejlkode 5 returneres kun én fejlkode og fejltekst uanset om flere der var flere Elev-elementer i indberetningen.

FejlTekst

String

Nej

Fejltekst, hvis valideringer finder fejl. Ved fejlkode 5 returneres kun én fejlkode og fejltekst uanset om flere der var flere Elev-elementer i indberetningen.

Valideringer

Følgende valideringer finder sted i indberetning af kontaktperson fra uddannelsesinstitutionen:

Fejlnummer

Relateret attribut

Fejltekst

Forklaring

5DatakildeInstitutionNummerUkendt institutionsnummerDer kan kun kaldes på institutioner, der er registreret i institutionsregistret. Hvis den kaldende institution ikke findes i registret vil der returneres fejlbesked. Fejlbeskeden returneres uden eventuelle CPR-numre fra request.
14CPRNrDen Unge findes ikke i UngedatabasenDer skal kun indberettes for unge med bopæl i Danmark. CPR nummeret kan ikke genfindes i Ungedatabasen i relation til en aktiv ung bosiddende i Danmark.
68CPRNrDen unge findes ikke i aktivt abonnementDen unge findes ikke i aktivt STAR abonnement i Ungedatabasen og der kan derfor ikke indberettes kontaktperson.
84CPRNrIkke aktiv på institutionenDen unge er ikke aktiv på den institution, der forsøger at indberette kontaktinformation.


Endpoints til testmiljø

Endpoints til testmiljø kan findes her: https://viden.stil.dk/display/OFFintegrationsplatformen/Services.

...