Metoder
Metodenavn | Returnerer | Beskrivelse | Eksempel på kald af metode med XML data |
---|---|---|---|
HelloWorld() | Hello <datostempel> | Returnerer ”Hello <datostempel>” hvilket indikerer at services og database er oppe og at der er hul igennem IP/Grund/Ung. | |
GetXMLSchema | XML-Schema | Denne metode returnerer det navngivne skema, som xml-data forventes at overholde, når der overføres data fra de administrative systemer til servicen.Det anbefales, at leverandøren altid sikrer sig, at xml-data overholder det skema, der udstilles via GetXmlSchema, og validerer xml-data mod skemaet før overførelse til webservicen. | |
ValidateXmlAgainstSchema | ImportSvarXML | Denne metode validerer overførte XML data mod de nævnte schema. Der returneres enten et OK-svar, hvis schemaet validerer/parses korrekt, eller en liste med fejlmeddelelser. ValidateXmlAgainstSchema har alene til formål at teste XML data og opdaterer ikke data i registeret. | |
InsertDaginstitution | ImportSvarXML | Opretter daginstitution i registeret | |
UpdateDaginstitution | ImportSvarXML | Opdaterer oplysninger på daginstitution i registeret | |
DeleteDaginstitution | ImportSvarXML | Sletter daginstitution i registeret | |
InsertAnvisningsEnhed | ImportSvarXML | Opretter anvisningsenhed i registeret | |
UpdateAnvisningsEnhed | ImportSvarXML | Opdaterer oplysninger på anvisningsenhed i registeret | |
DeleteAnvisningsEnhed | ImportSvarXML | Sletter anvisningsenhed i registeret | |
InsertAlternativAdresse | ImportSvarXML | Opretter alternativadresse i registeret | insertAlternativAdresse.xml |
UpdateAlternativAdresse | ImportSvarXML | Opdaterer oplysninger på alternativadresse i registeret | |
DeleteAlternativAdresse | ImportSvarXML | Sletter alternativadresse i registeret | |
MoveAnvisningsEnhed | ImportSvarXML | Flytter en anvisningsenhed, med evt tilhørende alternativeadresser fra et daginstitution til et anden daginstition. Flytning er kun muligt indenfor samme (kommunale) administrative enhed. | moveAnvisningsEnhed.xml |
MoveAlternativAdresse | ImportSvarXML | Flytter en alternativadresse fra en anvisningsenhed til en anden anvisningsenhed . Flytning er kun muligt indenfor samme (kommunale) administrative enhed. |
XML-Schemaer
Requesttype | XML-Schemanavn | BeskrivelseBeskrivelse |
---|---|---|
DeleteDaginstitutionXML | DagInstitutionDelete.xsd | Schema til brug ved sletning af daginstitution |
InsertDaginstitutionXML | Schema til brug ved oprettelse af daginstitution | |
UpdateDaginstitutionXML | Schema til brug ved opdatering af daginstitution | |
InsertAnvisningsEnhedXML | Schema til brug ved sletning af anvisningsenhed | |
DeleteAnvisningsEnhedXML | AnvisningsEnhedDelete.xsd | Schema til brug ved sletning af anvisningsenhed |
UpdateAnvisningsEnhedXML | Schema til brug ved sletning af anvisningsenhed | |
MoveAnvisningsEnhedXML | AnvisningsEnhedMove.xsd | Schema til brug ved flytning af anvisningsenhed |
DeleteAlternativAdresseXML | AlternativAdresseDelete.xsd | Schema til brug ved sletning af alternativadresse |
InsertAlternativAdresseXML | AlternativAdresseInsert.xsd | Schema til brug ved oprettelse af alternativadresse |
UpdateAlternativAdresseXML | AlternativAdresseUpdate.xsd | Schema til brug ved opdatering af alternativadresse |
MoveAlternativAdresseXML | AlternativAdresseMove.xsd | Schema til brug ved flytning af alternativadresse |
Responsetyper
ImportSvarXML
Standaliseret svar ved update, insert og delete metodekald i ImportService.
Navn | Beskrivelse | Format |
---|---|---|
errorCount | Antal fundne fejl | Heltal |
message | Status på kaldet: OK eller Error | Tekst (max 5 tegn) |
number | Det nye institutionsnummer. Kun aktuelt ved kalde af insertmetoder, ellers nil | Tekst( 6 tegn) |
validationsErrors | Liste med valideringsfejl af typen ValidationsError | |
validationsError | Valideringsfejl | |
errorMessage | Fejlmeddelelse | Tekst (max 132 tegn) |
errorType | Fejltype: XmlValidationError - fejl ift XML-schema ValidationError - øvrige fejl | Tekst (max 50 tegn) |
Status: OK
Eksempel på et kald hvor en ny daginstitution oprettes og får tildelt nummer G54262:
Status: Error/Fejl
Systemet validerer data i to faser. I første fase valideres data mod det tilhørende XML-schema. Hvis der er fejl svares der med en eller flere validationError elementer med errorTypen "XmlvalidationError".
Eksempel på ikke validt kald med to XmlValidationError:
Hvor der er fundet datatypefejl på felterne kommuneKode og instType3.
Status: ValidationError
I anden fase valideres for mere komplekse fejl, som validering mod det officielle adresseregister, krydsvalidering af ejerform, lovgrundlag og institutionstype mm. Hvis der er fejl, svares der med en eller flere validationError elementer med errorTypen "validationError". Fase to gennemføres kun såfremt der ikke er fundet fejl under fase et.
I nedenstående tabel vises en komplet liste over mulige fejl af typen "validationError".
Typer af ValidationError
errorMessage | Metoder | Beskrivelse |
---|---|---|
Unknown dagInstitutionsNummer (100) | UpdateDaginstitution | Det anførte daginsititutionsnummer findes ikke dagtilbudsregisteret |
Unknown code in admKommunekode (101) | UpdateDaginstitution, InsertDaginstitution | Ukendt kommunekoden, jævnfør den officielle kommunekodeliste |
Unable to delete record. Unknown dagInstitutionsNummer (102) | DeleteDaginstitution | Det anførte daginsititutionsnummer findes ikke dagtilbudsregisteret |
Unable to delete record. The dagInstitutionsNummer is | DeleteDaginstitution | Daginstitutionen kunne ikke slettes, idet den refereres til af underliggende anvisningsenheder. De underliggende anvisningsenheder skal slettes før daginstitutionen kan slettes. |
Unable to delete record. Unknown anvisningsEnhedsNummer (104) | DeleteAnvisningsEnhed | Det anførte anvisningsenhedsNummer findes ikke dagtilbudsregisteret |
Unable to delete record. The anvisningsEnhedsNummer is | DeleteAnvisningsEnhed | Anvisningsenheden kunne ikke slettes, idet den refereres til af underliggende alternativeadresser. De underliggende alternativeadresser skal slettes før anvisningsenheden kan slettes. |
Unable to delete record. Unknown alternativAdresseNummer (106) | DeleteAlternativAdresse | Det anførte alternativAdresseNummer findes ikke dagtilbudsregisteret |
Unknown code in kommunekode (107) | UpdateAnvisningsEnhed, | Ukendt kommunekoden, jvænfør den officielle kommunekodeliste |
Unknown address (108) | UpdateAnvisningsEnhed, UpdateAlternativAdresse, InsertAnvisningsEnhed, InsertAlternativAdresse | Adressen er ikke gyldigt jævnfør https://dawa.aws.dk/. Kombinationen af vejNavn, husNummer, postNummer og kommuneKode) er forsøgt opslået i DAWA, men den var ikke valid. |
Unknown pNummer (109) | UpdateAnvisningsEnhed, | Pnummeret valideres mod cvr-registeret, og denne fejl betyder at den angivne pnummer er ukendt eller nedlagt. |
Unknown code in instType3 (110) | UpdateAnvisningsEnhed, InsertAnvisningsEnhed | Ukendt institutionstype, se her (indsæt link til liste) |
Unknown anvisningsEnhedsNummer (111) | UpdateAnvisningsEnhed, InsertAlternativAdresse | Det anførte anvisningsenhedsNummer findes ikke dagtilbudsregisteret |
Unknown alternativAdresseNummer (112) | UpdateAlternativAdresse | Det anførte alternativAdresseNummer findes ikke dagtilbudsregisteret |
Wrong kommunekode in address (113) | UpdateAnvisningsEnhed, | Den anførte Kommundekode stemmer ikke med den kommunkode der er fundet ved opslag af adressen i https://dawa.aws.dk/ |
Unable to move record. Unknown anvisningsEnhedsNummer (114) | MoveAnvisningsEnhed | Det anførte anvisningsenhedsNummer findes ikke dagtilbudsregisteret |
Unable to move record. Unknown dagInstitutionsNummer (115) | MoveAnvisningsEnhed | Det anførte daginsititutionsnummer findes ikke dagtilbudsregisteret |
Unable to move record. Different AdmKommuneNummer (116) | MoveAnvisningsEnhed | AdmKommuneNummer skal være identisk på daginstitutionesniveau for den enhed der flyttes fra og den enhed der flyttes til. |
Unable to move record. Unknown alternativAdresseNummer (117) | MoveAlternativAdresse | Det anførte alternativAdresseNummer findes ikke dagtilbudsregisteret |
Insufficient privileges for InstitutionNummer (201) | Alle metoder | Det i IPUNG anførte institutionsnummer har ikke rettigheder til at arbejde på den pågældende administrative enhed |
Unknown InstitutionNummer (202) | Alle metoder | Ukendt institutionsnummer anført i IPUNG |
Missing InstitutionNummer (203) | Alle metoder | Der mangler et institutionsnummer i kaldet fra IPUNG |
No access to private institutions (221) | Alle metoder der ændre i data | De anførte credentials giver ikke adgang til at operette/slette/ændre i data for private institutioner |
Access denied to importservice (220) | Importservice | De anførte credentials giver ikke adgang til importservicen |
Ugyldig kombination af ejerform: '<kode> - <form>' og lovgrundlag: '<kode> - <lov>' (301) | InsertDaginstitution | Kombination af ejerform og lovgrundlag er ikke gyldigt ift. krydsvalideringstabellen (evt. indsæt link til tabellen). |
Ugyldig InstType: '<kode> - <type>' baseret på ejerform: '<kode> - <form>' og lovgrundlag: '<kode> - <lov>' på den tilknyttede daginstitution (303) | InsertAnvisningsenhed | Den angivne institutionstype passer ikke med dagtilbudsinstitutionens ejerform og lovgrundlag jfr. krydsvalideringstabellen i nedenstående afsnit. (evt. indsæt link til tabellen). |
Eksempel på ikke validt kald med en validationError:
Hvor requestet fejler, fordi der forsøges opdateres på et ukendt institutionsnummer .
Når man opretter eller opdaterer en daginstitution, så bliver ejerform og lovgrundlag krydsvalideret. Hvis kombinationen af ejerform og lovgrundlag ikke er gyldig, så svares der også med en ValidationError.
Når en anvisningsenhed oprettes, opdateres eller flyttes, så bliver ejerform, lovgrundlag og institutionstype krydsvalideret. Hvis kombinationen af daginstitutionens ejerform og lovgrundlag og anvisningsenhedens institutionstype ikke er gyldig, så svares der ligeledes med en ValidationError.
Status: OK, men med advarsel
Hvis du opdaterer en daginstitutions lovgrundlag, og opdateringen betyder, at de underliggende anvisningsenheder bliver ugyldige ifølge krydsvalideringen, så vil du få en advarsel. Opdateringen vil gå igennem, men du skal være opmærksom på, at anvisningsenhederne skal opdateres for igen at blive gyldige.
warningMessage | Metoder | Beskrivelse |
Den tilknyttede anvisningsenhed med enhedsnummer: '<anvisningsenhedsNummer>' er nu ugyldig baseret på instType: '<instTypeKode> - <instType>', ejerform: '<ejerformKode> - <ejerform>' og lovgrundlag: '<lovKode> - <lovgrundlag>' (304) | UpdateDaginstitution | Institutionstypen på den tilknyttede anvisningsenhed passer ikke med dagtilbudsinstitutionens ejerform og lovgrundlag jfr. krydsvalideringstabellen |
Eksempel på et validt kald, som returnerer en warningMessage.
I dette eksempel bliver anvisningsenheden ’G54258’ med institutionstype '6010 - Vuggestue (0-2 år)’ ugyldig ifølge krydsvalideringen, fordi den tilknyttede daginstitution nu er registreret med ejerform: '1 - Kommunal' og lovgrundlag: '8 - Fritidshjem, kommunal'.