2.15 21/05/2013 Tilføjet dokumentation af bvn input for GetEngagementDetailed

APOS2 REST API

Forord Dette dokument er en del af APOS version 2 manualerne. APOS version 2 (APOS2 herefter) er et organisation, klassifikation og personale system baseret på Sag & Dokument standarderne. Dokument oversigt: APOS2 Bulk data import / export APOS2 Security APOS2 Installation, Operation and Monitoring APOS2 Service Catalogue APOS2 Data Models APOS2 Administration Guide Alle dokumenterne kan findes på: http://axapoint.com/ Dette dokument beskriver REST API til APOS 2. 2

Versioner Version Date Description 1.0.0 06/03/2012 Initial version 1.0.1 11/03/2012 tilføjet parametre til enhed opret og ret 1.1.0 30/03/2012 flere services samt dimension på parametre 1.5.0 02/04/2012 resterende services samt eksempler på alle læsninger 1.5.1 09/05/2012 tilføjet getunitsforclass, udvidet beskrivelse af retengagement 1.5.2 09/05/2012 tilføjet getattachedunitsforperson 2.1 12/07/2012 Services til at modificere integration attributter tilføjet 2.3 24/08/2012 tilføjet og opdateret 2.3 10/09/2012 Flyttet GetPersonListeUdFraLeder og GetPersonListeUdFra- Stedfortraeder til composite sektion 2.5 25/10/2012 Opdateret mht. virkningfra, virkningtil på opdaterende funktioner 2.5 12/11/2012 Opdateret Stedfortræder beskrivelsen. 2.5 26/11/2012 GetFunctionsForSubtree parameter krav ændret. 2.6 13/12/2012 GetEngagementKaskadeForFunktion tilføjet, beskrivelse af EndEngagment ændret. 2.7 4/01/2013 tilføjet beskrivelse ved services hvor aktive gyldighed kan angives med virkningfra og virkningtil. Link til Live eksempler fjernet 2.8 17/01/2013 GetOrganisationList beskrivelse tilføjet 2.9 31/01/2013 RetEngagement interface ændringer 2.10 08/02/2013 Tilføjet GetClosestResponsible service 2.11 12/02/2013 Fra/til på opret stedfortræder 2.11 18/02/2013 Tilføjet beskrivelse af getfunctioncascade, indført beskrivelse af format parameter 2.12 05/03/2013 Opdateret parametre på organisationenhedret 2.12.1 12/03/2013 Tilføjet dokumentation af EndOrganisation 2.13.1 23/03/2013 fjernet getpersonlisteforsubtree 2.14 16/05/2013 Tilføjet dokumentation af GetNearestRelationBetweenOrganizations 2.15 21/05/2013 Tilføjet dokumentation af bvn input for GetEngagementDetailed 2.16 23/05/2013 rettet GetEngagementDetailed brugerid beskrivelse 2.17 26/05/2013 tilføjet engagementuuid til retbuger 2.18 26/05/2013 tilføjet locationuuid til GetUnitDetails 2.19 07/06/2013 beskrevet unituuid for RetEngagement 2.20 25/06/2013 opdater parametre for GetFunctionsForUnit 2.21 26/06/2013 tilføjet bvn til GetKlasseForFacet 2.22 02/07/2013 ændret beskrivelse af GetPersonListeUdFraLeder 3

2.23 29/08/2013 ændret beskrivelse af OrganisationEnhedRet og div, tekst rettelser 2.24 29/08/2013 Tilføjet dokumentation af OrganisationEnhedAktiver 2.25 11/09/2013 GetEntireHierarchy udvidet 2.26 20/09/2013 RetLokation parametre beskrevet, table float fixed 2.27 23/09/2013 GetFunctionCasade, udvidet med flere parametre 2.28 06/10/2013 GetAttachedPersonsForUnit, added format 2.29 22/10/2013 GetFunctionsForUnit, added attached 2.30 04/11/2013 OrganisationEnhedAfslut, kan nu afslutte et helt undertræ 2.31 12/11/2013 GetClosestResponsible udvidet med flere parametre 2.32 22/11/2013 GetTilknyttedeEnheder service 2.33 09/12/2013 GetClosestResponsible udvidet med excludevacantfunctions 2.34 13/01/2014 TilknytItSystemOrganisationEnhed 2.35 05/02/2014 opdateret OpretBruger parameter beskrivelse 2.36 24/02/2014 opdateret GetAdresseList new parameter 2.37 05/03/2014 Beskrivelse af GetClosestResponsible og GetFunctionsForPerson revideret. 2.38 11/03/2014 TilknytEngagmeentEnhed, EndTilknytEngagementEnhed service beskrivelser tilføjet. 2.39 14/03/2014 GetUnitDetails udvidet. 2.40 18/03/2014 JSON on GetEngagementDetailed. 2.41 01/04/2014 Tilføjet beskrivelse af GetFunction. 2.42 02/04/2014 Tilføjet beskrivelse af EndBruger. 2.43 07/05/2014 Opdater PersonOpret api beskrivelse. 2.44 27/05/2014 Tilføjet parameter brugertypeuuid til bruger services. 2.45 05/09/2014 Tilføjet beskrivelse af GetAttachedEngagementsToUnit. 2.46 10/09/2014 GetAttachedEngagementsToUnit, tilføjet parameter active. 2.47 26/09/2014 updated attachment services. Indhold 1 Generelt om API et 5 1.1 Hvorfor et REST API?............................. 5 1.2 Service API grundlæggende.......................... 5 1.2.1 Entiteter og id............................. 5 1.3 Kald af service metoder............................ 5 1.3.1 URL opbygning............................. 5 1.3.2 Service kald eksempel......................... 7 4

2 Service beskrivelser 8 3 Service eksempler 8 3.1 Generelt for services.............................. 8 3.2 Generelt for opdaterende services....................... 8 3.3 Organisation.................................. 9 3.3.1 GetOrganisationList.......................... 9 3.3.2 EndOrganisation............................ 9 3.3.3 GetEntireHierarchy.......................... 9 3.3.4 GetUnitDetails............................. 10 3.3.5 GetLocations.............................. 10 3.3.6 GetFunction.............................. 10 3.3.7 GetFunctionsForUnit.......................... 11 3.3.8 GetFunctionsForPerson........................ 11 3.3.9 GetAttachedPersonsForUnit...................... 12 3.3.10 GetAttachedUnitsForPerson...................... 12 3.3.11 GetUnitsToRoot............................ 12 3.3.12 GetUnitsForClass............................ 12 3.3.13 GetFunctionsForSubTree....................... 13 3.3.14 GetBruger................................ 13 3.3.15 GetItSystemList............................ 14 3.3.16 GetOrganisationEnhedIntegration.................. 14 3.3.17 RetOrganisationEnhedIntegration.................. 14 3.3.18 EndOrganisationEnhedIntegration.................. 15 3.3.19 OrganisationEnhedOpret....................... 15 3.3.20 OrganisationEnhedRet......................... 16 3.3.21 OrganisationEnhedAfslut....................... 16 3.3.22 OrganisationEnhedAktiver...................... 16 3.3.23 OrganisationOpret........................... 17 3.3.24 LokationOpret............................. 17 3.3.25 EndLocation.............................. 17 3.3.26 MovePersonLokation.......................... 17 3.3.27 EndFunction.............................. 18 3.3.28 CreateLeaderFunction......................... 18 3.3.29 UpdateLeaderFunction......................... 19 3.3.30 MoveAttachedPersons......................... 19 3.3.31 EndAttachedPersons.......................... 20 3.3.32 AttachPerson.............................. 20 3.3.33 AttachPersonToFunction....................... 20 3.3.34 OrganisationEnhedTilknyt....................... 21 3.3.35 EndAttachedUnits........................... 21 3.3.36 MoveAttachedUnits.......................... 21 3.3.37 OrganisationEnhedFlyt........................ 22 5

3.3.38 OrganisationFunktionFlyt....................... 22 3.3.39 OpretBruger.............................. 22 3.3.40 RetBruger................................ 23 3.3.41 EndUser................................. 23 3.3.42 EndBruger............................... 23 3.3.43 GetPersonUuiderFraBrugerId..................... 24 3.3.44 GetClosestResponsible......................... 24 3.3.45 GetNearestRelationBetweenOrganizations.............. 28 3.3.46 GetTilknyttedeEnheder........................ 29 3.3.47 TilknytItSystemOrganisationEnhed................. 31 3.3.48 EndAttachedItSystem......................... 32 3.3.49 TilknytEngagementEnhed....................... 33 3.3.50 EndTilknytningEngagementEnhed.................. 34 3.3.51 GenerateBrugernavnItSystem..................... 35 3.4 Part....................................... 37 3.4.1 GetPersonList............................. 37 3.4.2 GetAdresseList............................. 37 3.4.3 PersonOpret.............................. 38 3.4.4 PersonRet................................ 38 3.4.5 OpretGeografiskAdresse........................ 39 3.4.6 RetGeografiskAdresse......................... 39 3.4.7 GetGeografiskAdresse......................... 40 3.4.8 ImportGeografiskAdresse....................... 41 3.4.9 EndGeografiskAdresse......................... 41 3.5 Klassifikation.................................. 42 3.5.1 GetKlassifikationList.......................... 42 3.5.2 GetFacetterForKlassifikation..................... 42 3.5.3 GetKlasseForFacet........................... 42 3.5.4 GetKlasseList.............................. 43 3.5.5 KlassifikationSelect........................... 43 3.5.6 OpretKlassifikation........................... 43 3.5.7 RetKlassifikation............................ 43 3.5.8 AfslutKlassifikation........................... 44 3.5.9 OpretFacet............................... 44 3.5.10 RetFacet................................ 44 3.5.11 AfslutFacet............................... 45 3.5.12 OpretKlasse............................... 45 3.5.13 RetKlasse................................ 45 3.5.14 AfpublicerKlasse............................ 45 3.6 Composite services............................... 46 3.6.1 GetEngagement............................. 46 3.6.2 GetEngagementDetailed........................ 46 3.6.3 GetFunctionCascade.......................... 47 6

3.6.4 GetLokationDetails........................... 47 3.6.5 GetCompanyDepartmentOffice.................... 47 3.6.6 FindPersonsEngagedInSubtree.................... 48 3.6.7 OpretEngagement........................... 48 3.6.8 RetEngagement............................. 49 3.6.9 EndEngagement............................ 51 3.6.10 RetLokation............................... 51 3.6.11 OpretStedfortraeder.......................... 52 3.6.12 RetStedfortraeder........................... 52 3.6.13 GetStedfortraederListe......................... 53 3.6.14 GetPersonListeUdFraLeder...................... 54 3.6.15 GetPersonListeUdFraStedfortraeder................. 54 3.6.16 CompleteExport............................ 55 3.6.17 SecurityChecker............................ 56 3.6.18 DPR................................... 56 3.6.19 CompleteExport............................ 56 3.6.20 GetEngagementKaskadeFunktion................... 57 3.6.21 GetAttachedEngagementsForUnit.................. 58 3.6.22 EndAttachmentEngagementToUnit.................. 58 3.6.23 AttachEngagementToUnit....................... 58 3.6.24 CleanPersonerUdenEngagementer.................. 59 3.7 Deprecated and not in use........................... 62 3.8 Removed services................................ 62 4 Appendiks 63 4.1 I.a opdaterende service response eksempler................. 63 4.1.1 Succes ved opret............................ 63 4.1.2 Manglende parameter......................... 63 4.1.3 Entitet ikke fundet........................... 63 4.2 I.b læsende service eksempler......................... 63 4.2.1 GetOrganisationList.......................... 63 4.2.2 GetEntireHierarchy.......................... 63 4.2.3 GetUnitDetailsResponse........................ 64 4.2.4 GetLocations.............................. 64 4.2.5 GetFunction.............................. 65 4.2.6 GetFunctionsForUnit.......................... 65 4.2.7 GetFunctionsForPerson........................ 65 4.2.8 GetAttachedPersonsForUnit...................... 66 4.2.9 GetAttachedUnitsForPerson...................... 66 4.2.10 GetUnitsToRootResponse....................... 66 4.2.11 GetUnitsForClassResponse...................... 66 4.2.12 GetFunctionsForSubTreeResponse.................. 66 4.2.13 GetFunctionCascadeResponse..................... 67 7

4.2.14 GetBrugerResponse.......................... 68 4.2.15 GetPersonListResponse........................ 68 4.2.16 GetAdresseListResponse........................ 69 4.2.17 GetKlassifikationListResponse.................... 69 4.2.18 GetFacetterForKlassifikationResponse................ 69 4.2.19 GetKlasseForFacetResponse...................... 69 4.2.20 GetKlasseListResponse........................ 69 4.2.21 KlassifikationSelectResponse..................... 70 4.2.22 GetEngagementResponse....................... 70 4.2.23 GetEngagementDetailedResponse................... 70 4.2.24 GetLokationDetailsResponse..................... 71 4.2.25 CompleteExportResponse....................... 71 8

1 Generelt om API et 1.1 Hvorfor et REST API? Fordi det har god performance, er nemt at integrere til og nemt at teste. Læs mere her om REST services i det offentlige. 1.2 Service API grundlæggende Dette afsnit beskriver grundlæggende anvendelse af service API et. 1.2.1 Entiteter og id Alle entitier har et Universally Unique ID (UUID). Dette anvendes som oftest til at referere til entiteter, men brugervendtnøgle er også unique og kan med forde anvendes i nogle services hvor dette er tilladt. Der hvor typen uuid er angivet refereres der til en tekststreng der unikt identificere en entitet. 1.3 Kald af service metoder Alle metoder kan kaldes med GET eller POST. Der differentieres ikke på Http method, da vi således ikke behøver at sikre denne konfiguration i den kaldende klient. Der er dog anbefalinger til hvilken method der skal bruges under de enkelte service beskrivelser, men vi anvender ikke andre method s som DELETE, CREATE etc. Når der angives dynamiske parameter lister, såsom arbejdsopgave[x], betyder det at flere kan sættes således:?arbejdsopgave0=cbb4fdad-e737-435b-bd6d-679174c6bfab &arbejdsopgave1=97fdb8f5-050e-442b-9bc8-fa5386c6aedf Hvis flere parametre er angivet med samme variable i parents betyder det at de hænger sammen i gruppe, eksempel for integrationattributname[y] og integrationattributvalue[y] :?integrationattributname0=los-nr&integrationattributvalue0=666 1.3.1 URL opbygning Service komponenterne er opdelt i fire, vist herunder, se tabel 2, for en forklaring af tokens i URL. Organisation komponent 9

http://<server>[:<port>]/apos2-app-organisation[-<miljø>]/<service> Part komponent http://<server>[:<port>]/apos2-app-part[-<miljø>]/<service> Klassifiaktion komponent http://<server>[:<port>]/apos2-app-klassifikation[-<miljø>]/<service> Sammensatte services komponent http://<server>[:<port>]/apos2-composite-services[-<miljø>]/<service> token <server> :<port> -<miljø> beskrivelse DNS navnet på serveren angives hvis den ikke kører på port 80, typisk vil den være på port 8080, som er standard for Tomcat angives hvis det ikke er produktions serveren, alternativt -test el. -trial Tabel 2: URL tokens Eksempel på URL til servicen GetEntireHierarchy på den offentlige test server: http://kattegat.axapoint.com:8080/apos2-app-organisation-test/getentirehierarchy Eksempel på URL til servicen GetEntireHierarchy på en produktions server, Bemærk at -test er udeladt.: http://kattegat.axapoint.com:8080/apos2-app-organisation/getentirehierarchy 10

1.3.2 Service kald eksempel Figur 1 viser sekvens af lokation oprettelse med alle service kald til at fremfinde relationer etc. Figur 1: Opret lokation sekvens. 11

2 Service beskrivelser I de følgende afsnit beskrives service opdelt på komponenter. For en klient hvor APOS2 er installeret med alle 3 komponenter er det betydningsløst hvor services eksekveres. Hver service er beskrevet med parametre til input og deres tilhørende type og beskrivelse. 3 Service eksempler For alle services gives eksempler på kald i Appendiks II, se sektion 4.1. Services til læsning har fulde eksempler enkeltvist. Services der opdaterer har lignende response struktur, hvorfor de har ét samlet afsnit. 3.1 Generelt for services Parameteren vt (forkortelse af valid tid) er anvendt til at lave opslaget eller opdateringen på det angivne tidspunkt og angives som dato i formattet DD-MM-YYYY. Eftersom APOS2 er tidsstyret ned til sekunder, vil en dato bliver fortolket til midt på dagen før ved opslag og til 1 sekund før midnat dagen før ved rettelser. Hvis datoen ikke angives antages den i servicen til at være nu. rt (revisions tid), anvendes kun af enkelte services. Når rt ikke er angivet antages det at være nu. orguuid, der hvor denne parameter kan angives sikrer man en søgning i den korrekt organisation. Angives orguuid IKKE antages først oprettede organisation. I beskrivelserne af parametre til services angives r som required parameter og o som optional parameter. De fleste services returnerer kun XML. Ved de services der kan returnere JSON skal accept HTTP header sættes. Det skal være text/xml eller application/json. format parameteren kan angives for services hvor det understøttes, indholdet af parameteren bruges til at overskrive accept header. For CSV format angives eksempelvist værdien text/csv. 3.2 Generelt for opdaterende services På grund af virknings perioder for relationer kan der angives virkningfra, virkningtil på opdaterende funktioner. Det kan dog udelades hvor der så antages virkningfra er nu (minus 1 dag) og virkningtil ikke er angivet, hvilket vil sige gyldig indtil afsluttet eller ændret. 12

3.3 Organisation 3.3.1 GetOrganisationList Returnerer alle gyldige organisationer med type angivelse. Servicen kan returnere JSON eller XML. Ingen parametre udover vt kan angives. Gå til 4.2.1 for response eksempel. 3.3.2 EndOrganisation Denne service gør en organisation INAKTIV fra angivet tidspunkt. Servicen kan returnerer XML response. uuid r UUID uuid på organisation uuid der gøres inaktiv Tabel 3: EndOrganisation parametre 3.3.3 GetEntireHierarchy Denne service returnerer hele hierakiet for en organisation. Svaret indeholder enheder med stam information samt reference til overordnet enhed med objektid, som er APOS2 s interne id. Hele strukturen kan udledes af overordnetid, som er en reference til objectid på parent. type i svaret kan være child eller root. root noden er roden på organisationen, ved at tage udgangspunkt i denne kan man traversere strukturen fra toppen. Hensigten med servicen er at kunne returnere et organisations træ så hurtigt som muligt. Servicen kan returnere JSON eller XML. uuid o UUID organisation uuid, hvis udeladt anvendes første registrerede Oganisation pathtorootunituuid o UUID enhed uuid, hvis angivet returneres kun enheder i stien til roden subtreeunituuid o UUID enhed uuid, hvis angivet returneres kun hieraki for enheden og undertræ Tabel 4: GetEntireHierarchy parametre Gå til 4.2.2 for response eksempel. 13

3.3.4 GetUnitDetails Giver flere detaljer på en enhed såsom integrationatttributter, tilknyttede enheder mm. Enheden kan identificeres med én af 3 nøgler; uuid, objectid eller bvn. Response format er XML. Servicen understøtter POST. uuid UUID o organisationenhed uuid uuids UUID o organisationenhed uuid på flere enheder locationuuid UUID o uuid på en lokation, vil returnere enhed som lokationen tilhører bvn tekststreng o organisationenhed brugervendtnoegle objectid heltal o organisationenhed intern object id Tabel 5: GetUnitDetails parametre Gå til 4.2.3 for response eksempel. 3.3.5 GetLocations Returnerer lokationer på en enhed med stam information. Hensigten er at kunne liste lokationer hurtigst muligt via denne diskrete service. Kan returnere JSON eller XML. uuid r UUID organisationenhed uuid Tabel 6: GetLocations parametre Gå til 4.2.4 for response eksempel. 3.3.6 GetFunction Returnerer organisationfunktioner ud fra funktionens uuid eller bvn. Returnerer JSON eller XML. uuid UUID o organisationfunktion uuid bvn tekststreng o organisationfunktion brugervendtnoegle uuid UUID o organisationfunktion uuid type UUID o type af funktion, kan angive engagement, leder m.fl. Kan også udelades Tabel 7: GetFunction parametre Gå til 4.2.5 for response eksempel. 14

3.3.7 GetFunctionsForUnit Returnerer organisationfunktioner der er tilknyttet en enhed. Enheden kan fremsøges med enten uuid eller bvn. type angives til at filtrere på organisationfunktionstype, angives den ikke, returneres alle typer. Svaret indeholder tilknyttede organisationfunktioner med tilknyttede personer og opgaver. Servicen indeholder pagination. Returnerer JSON eller XML. uuid UUID r organisationenhed uuid bvn tekststreng o organisationenhed brugervendtnoegle type UUID o klasse uuid på organisationfunktiontype limit heltal o max antal resultater start heltal o angivelse af resultat start til pagination attached true/false o hvis den er sat returnerer kun funktioner der tilknyttet vis TIlknyttedeFunktioner på enheden, pagination fungerer ikke med denne. Tabel 8: GetFunctionsForUnit parametre Gå til 4.2.6 for response eksempel. 3.3.8 GetFunctionsForPerson Returnerer organisationfunktioner der er tilknyttet en person. Personen kan fremsøges med enten uuid eller bvn. type angives til at filtrere på organisationfunktionstype, angives den ikke, returneres alle typer. Svaret indeholder tilknyttede organisationfunktioner med tilknyttede personer, opgaver og enheder. Svaret giver aktive funktioner, samt en struktur med kommende aktive funktioner der matcher (afventende) og funktioner der har været aktive (afsluttede). Funktioner optræder i de aktive hvis de har en AKTIV værdi i Gyldighed på det tidspunkt der forespørges. De optræder i afventende hvis de på nuværende tidspunkt er INAKTIV og der i fremtiden kommer en AKTIV periode. De optræder i afsluttede hvis de på nuværende tidspunkt har INAKTIV periode og der ikke fremtiden kommer en AKTIV periode. Returnerer JSON eller XML, understøtter format. uuid UUID o person uuid bvn tekststreng o person brugervendtnoegle type UUID r klasse uuid på organisationfunktiontype Tabel 9: GetFunctionsForPerson parametre Gå til 4.2.7 for response eksempel. 15

3.3.9 GetAttachedPersonsForUnit Lister personer der blot er tilknyttet en enhed. Returnerer JSON eller XML. Understøtter format parameteren. uuid UUID r organisationenhed uuid Tabel 10: GetAttachedPersonsForUnit parametre Gå til 4.2.8 for response eksempel. 3.3.10 GetAttachedUnitsForPerson Lister personer der blot er tilknyttet en enhed. Returnerer JSON eller XML. uuid UUID r organisationenhed uuid Tabel 11: GetAttachedUnitsForPerson parametre Gå til 4.2.9 for response eksempel. 3.3.11 GetUnitsToRoot Fra en given enhed i en given organisation returneres stam information på enheder i stien fra enheden til rod enheden i organisationen. Rækkefølgen er yderste node først. Returnerer JSON eller XML. unituuid UUID r organisationenhed uuid på child orguuid UUID o organisation uuid Tabel 12: GetUnitsToRoot parametre Gå til 4.2.10 for response eksempel. 3.3.12 GetUnitsForClass Returnerer enheder der har given klasse som opgave, enhedstype eller branche. Returnerer JSON eller XML. 16

classuuid UUID r uuid på klasse start UUID o heltal til angivelse af start for pagination limit UUID o heltal til pagination max Tabel 13: GetUnitsForClass parametre Gå til 4.2.11 for response eksempel. 3.3.13 GetFunctionsForSubTree Returnerer alle organisationfunktioner for en enhed og alle enheder der er children til enheden. Indeholder pagination. Hensigten er at kunne søge mere bredt i organisation med et enkelt opslag, bemærk classuuid der muliggører at man kan søge på organisationfunktioner der varetager bestemte opgaver.. dvs er tilknyttet angiven klasse. Med showunits, inkluderer svaret de enheder funktionerne er tilknyttede. Returnerer JSON eller XML. uuid UUID o organisationenhed uuid på parent, hvorfra alle underliggende enheder tages m unituuid UUID o angives hvis der kun ønskes søgning på en bestemt organisationenhed og ikke orguuid UUID o organisation uuid type UUID o klasse uuid på organisationfunktion type classuuid UUID o klasse uuid, matcher på opgaver i funktion showunits boolean o true / false limit heltal o max antal resultater start heltal o angivelse af resultat start til pagination Tabel 14: GetFunctionsForSubTree parametre Gå til 4.2.12 for response eksempel. 3.3.14 GetBruger Returnerer en bruger identificeret med én af parametrene: uuid, bvn eller personuuid. Resultatet kan endvidre reduceres ved at angive hvilket itsystem brugeren skal være tilknyttet. Response format er XML. uuid UUID o bruger uuid bvn tekststreng o bruger brugervendtnoegle personuuid UUID o person uuid itsystemuuid UUID o itsystem uuid Tabel 15: GetBruger 17

Gå til 4.2.14 for response eksempel. 3.3.15 GetItSystemList Returnerer alle aktive IT-systemer Response format er XML. 3.3.16 GetOrganisationEnhedIntegration Modtag OrganisationEnhedIntegration attributter, med mulighed for at vælge tidpunkt, med et selvvalgt attribut navn eller flere. Response format: XML Eksempel: Der skal findes ud af mange EAN-numre og KØR-org.-numre en bestemt bruger er tilknyttet. brugerid brugerid r brugerens brugernavn, man ønsker at få fat i name tekststreng r Navn på attribut(er) der skal ændres f.eks EAN, flere kan angives separeret med, Tabel 16: GetOrganisationEnhedIntegration parametre 3.3.17 RetOrganisationEnhedIntegration Redigere OrganisationEnhedIntegration, med et selvvalgt attribut navn, med eller uden underorganisationer til en selvvalgt værdi, med mulighed for at vælge tidpunkt. Response format: XML Eksempel: Børn- og Ungdomsforvaltningen skal havde et nyt EAN-numre og dette skal rettes og det skal først virke fra en bestemt dato. Angiv enten bvn eller uuid til at identificere enheden. uuid UUID o organisationenhed uuid bvn bvn o organisationenhed med bvn - tager præcedens over UUID name tekststreng r Navn på attribut der skal ændres f.eks EAN value tekststreng r Hvad værdien skal ændres til children true/false o angiver om ændringen også skal ske på underorganisationer. værdien er som default angivet false Tabel 17: RetOrganisationEnhedIntegration parametre 18

3.3.18 EndOrganisationEnhedIntegration Afslutter OrganisationEnhedIntegration, med selvvalgt attribut navn, med eller uden underorganisationer, med mulighed for at vælge tidspunkt. Response format: XML Eksempel: Børn- og Ungdomsforvaltningen skal havde slettet alle EAN-numre. Uuid UUID r organisationenhed uuid, sættes som overordnet name tekststreng r Navn på attribut der skal ændres f.eks EAN children true/false o angiver om ændringen også skal ske på underorganisationer. værdien er som default angivet false Tabel 18: EndOrganisationEnhedIntegration parametre 3.3.19 OrganisationEnhedOpret Opretter en enhed som underenhed til angivne enhed. incrementbvn kan anvendes til at tælle op hvis brugervendtnoegle er et heltal. Response format er XML. parentuuid UUID r organisationenhed uuid, sættes som overordnet orguuid UUID o organisation uuid enhedsnavn tekststreng r navn på den nye enhed enhedstype UUID r klasse uuid ejerskabstype UUID o klasse uuid bvn tekststreng o Brugervendtnøgle branche UUID o klasse uuid opgaver UUID o klasse uuider i en comma sepereret string incrementbvn boolean o true / false, hvis angivet laver bvn integrationattributname[x] tekststreng o navn på integration attribut integrationattributvalue[x] tekststreng o grupperet med integrationattributname Tabel 19: OrganisationEnhedOpret parametre 19

3.3.20 OrganisationEnhedRet Retter en enhed. Response format er XML. uuid UUID r organisationenhed uuid enhedsnavn tekststreng o nyt navn bvn tekststreng o Brugervendtnøgle enhedstype UUID o klasse uuid ejerskabstype UUID o klasse uuid branche UUID o klasse uuid opgaver UUID o klasse uuider i en comma sepereret string type2 UUID o klasse uuid integrationattributname[x] tekststreng o navn på integration attribut integrationattributvalue[x] tekststreng o grupperet med integrationattributname Tabel 20: OrganisationEnhedRet parametre 3.3.21 OrganisationEnhedAfslut Afslutter en enhed, dvs gyldighed sættes til INAKTIV. Response format er XML. uuid UUID r organisationenhed uuid endsubtree boolean o true/false om hele undertræet i den givne organisation skal afsluttes. Default er false orguuid UUID o organisation uuid skal gives ifm. afslutning af undertræ Tabel 21: OrganisationEnhedAfslut parametre 3.3.22 OrganisationEnhedAktiver Aktiverer en enhed, som var inaktiv før. Response format er XML. uuid UUID r enhed uuid vt tekststreng o virkningstid i format dd-mm-yyyy Tabel 22: OrganisationEnhedAktiver parametre 20

3.3.23 OrganisationOpret Opretter en ny organisation. Response format er XML. organisationsnavn tekststreng r navn på nye organisation enhedsnavn tekststreng r navn på rod enhed til nye organisation Tabel 23: OrganisationOpret parametre 3.3.24 LokationOpret Opretter en lokation på givne enhed. Response format er XML. unituuid UUID r organisationenhed uuid adresseuuid UUID o adresse uuid, tilknyt en adresse til lokationen lokationsnavn tekststreng o navn på lokation aabningstider tekststreng o åbningstider i fri tekst pnummer tekststreng o fysisk arbejdssteds nr Tabel 24: LokationOpret parametre 3.3.25 EndLocation Afslutter en lokation. Returnerer XML. uuid UUID r lokation uuid Tabel 25: EndLocation parametre 3.3.26 MovePersonLokation Flyt personers relation lokation, dette er ArbejderHer relationen. Enten enkelt uuid på person angives eller uuid er på flere personer via uuids. fromenheduuid skal angives for at fjerne evt. eksisterende placering. Servicen tager personer som input, men følger egentligt engagementet. Returnerer XML. 21

uuid UUID o uuid på person der placeres uuids UUID o komma separeret liste af flere personer fromenheduuid UUID r enhed som personerne er engageret i tolokationuuid UUID r uuid på lokation som personer placeres på, angiv null for at fjerne relation Tabel 26: MovePersonLokation parametre 3.3.27 EndFunction Afslutter en given organisationfunktion, dv.s gyldighed sætte til INAKTIV. Returnerer XML. uuid UUID r organisationfunktion uuid Tabel 27: EndFunction parametre 3.3.28 CreateLeaderFunction Opretter en tom organisationfunktion af typen leder tilknyttet givne enhed. Returnerer XML. unituuid UUID r organisationenhed uuid lederbetegnelse UUID r klasse uuid til betegnelse af leder lederansvaruuids UUID o klasse uuid til angivelse af ansvar, flere separeret med, funktionsnavn tekststreng o navn på lederfunktion virkningfra dato streng o virkningfra kan angives istedet for vt virkningtil dato streng o kan angives sammen med virkningfra eller vt til at angive aktive gyldigheds periode for funktion Tabel 28: CreateLeaderFunction parametre 22

3.3.29 UpdateLeaderFunction Retter enorganisationfunktion af typen leder. Returnerer XML. uuid UUID r organisationfunktion uuid lederbetegnelse UUID r klasse uuid til betegnelse af leder lederansvaruuids UUID o klasse uuid til angivelse af ansvar, flere separeret med, funktionsnavn tekststreng o navn på lederfunktion personuuids UUID o person uuid på tilknyttet person, flere separeret med, Tabel 29: UpdateLeaderFunction parametre 3.3.30 MoveAttachedPersons Flytter tilknyttede personer fra en enhed til en anden. Returnerer XML. fromuuid UUID r organisationenhed uuid på en enhed der flyttes fra touuid UUID r organisationenhed uuid på en enhed der flyttes til uuid UUID o person uuid uuids UUID o person uuid på tilknyttet person, flere separeret med, Tabel 30: MoveAttachedPersons parametre 23