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

Transkript

1 APOS2 REST API

2 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å: Dette dokument beskriver REST API til APOS 2. 2

3 Versioner Version Date Description /03/2012 Initial version /03/2012 tilføjet parametre til enhed opret og ret /03/2012 flere services samt dimension på parametre /04/2012 resterende services samt eksempler på alle læsninger /05/2012 tilføjet getunitsforclass, udvidet beskrivelse af retengagement /05/2012 tilføjet getattachedunitsforperson /07/2012 Services til at modificere integration attributter tilføjet /08/2012 tilføjet og opdateret /09/2012 Flyttet GetPersonListeUdFraLeder og GetPersonListeUdFra- Stedfortraeder til composite sektion /10/2012 Opdateret mht. virkningfra, virkningtil på opdaterende funktioner /11/2012 Opdateret Stedfortræder beskrivelsen /11/2012 GetFunctionsForSubtree parameter krav ændret /12/2012 GetEngagementKaskadeForFunktion tilføjet, beskrivelse af EndEngagment ændret /01/2013 tilføjet beskrivelse ved services hvor aktive gyldighed kan angives med virkningfra og virkningtil. Link til Live eksempler fjernet /01/2013 GetOrganisationList beskrivelse tilføjet /01/2013 RetEngagement interface ændringer /02/2013 Tilføjet GetClosestResponsible service /02/2013 Fra/til på opret stedfortræder /02/2013 Tilføjet beskrivelse af getfunctioncascade, indført beskrivelse af format parameter /03/2013 Opdateret parametre på organisationenhedret /03/2013 Tilføjet dokumentation af EndOrganisation /03/2013 fjernet getpersonlisteforsubtree /05/2013 Tilføjet dokumentation af GetNearestRelationBetweenOrganizations /05/2013 Tilføjet dokumentation af bvn input for GetEngagementDetailed /05/2013 rettet GetEngagementDetailed brugerid beskrivelse /05/2013 tilføjet engagementuuid til retbuger /05/2013 tilføjet locationuuid til GetUnitDetails /06/2013 beskrevet unituuid for RetEngagement /06/2013 opdater parametre for GetFunctionsForUnit /06/2013 tilføjet bvn til GetKlasseForFacet /07/2013 ændret beskrivelse af GetPersonListeUdFraLeder 3

4 /08/2013 ændret beskrivelse af OrganisationEnhedRet og div, tekst rettelser /08/2013 Tilføjet dokumentation af OrganisationEnhedAktiver /09/2013 GetEntireHierarchy udvidet /09/2013 RetLokation parametre beskrevet, table float fixed /09/2013 GetFunctionCasade, udvidet med flere parametre /10/2013 GetAttachedPersonsForUnit, added format /10/2013 GetFunctionsForUnit, added attached /11/2013 OrganisationEnhedAfslut, kan nu afslutte et helt undertræ /11/2013 GetClosestResponsible udvidet med flere parametre /11/2013 GetTilknyttedeEnheder service /12/2013 GetClosestResponsible udvidet med excludevacantfunctions /01/2014 TilknytItSystemOrganisationEnhed /02/2014 opdateret OpretBruger parameter beskrivelse /02/2014 opdateret GetAdresseList new parameter /03/2014 Beskrivelse af GetClosestResponsible og GetFunctionsForPerson revideret /03/2014 TilknytEngagmeentEnhed, EndTilknytEngagementEnhed service beskrivelser tilføjet /03/2014 GetUnitDetails udvidet /03/2014 JSON on GetEngagementDetailed /04/2014 Tilføjet beskrivelse af GetFunction /04/2014 Tilføjet beskrivelse af EndBruger /05/2014 Opdater PersonOpret api beskrivelse /05/2014 Tilføjet parameter brugertypeuuid til bruger services /09/2014 Tilføjet beskrivelse af GetAttachedEngagementsToUnit /09/2014 GetAttachedEngagementsToUnit, tilføjet parameter active /09/2014 updated attachment services /12/2014 added parameter incrementbvn for OpretEngagement /12/2014 added description of PublishRegistrations. Indhold 1 Generelt om API et Hvorfor et REST API? Service API grundlæggende Entiteter og id Kald af service metoder

5 1.3.1 URL opbygning Service kald eksempel Service beskrivelser 12 3 Service eksempler Generelt for services Generelt for opdaterende services Organisation GetOrganisationList EndOrganisation GetEntireHierarchy GetUnitDetails GetLocations GetFunction GetFunctionsForUnit GetFunctionsForPerson GetAttachedPersonsForUnit GetAttachedUnitsForPerson GetUnitsToRoot GetUnitsForClass GetFunctionsForSubTree GetBruger GetItSystemList GetOrganisationEnhedIntegration RetOrganisationEnhedIntegration EndOrganisationEnhedIntegration OrganisationEnhedOpret OrganisationEnhedRet OrganisationEnhedAfslut OrganisationEnhedAktiver OrganisationOpret LokationOpret EndLocation MovePersonLokation EndFunction CreateLeaderFunction UpdateLeaderFunction MoveAttachedPersons EndAttachedPersons AttachPerson AttachPersonToFunction OrganisationEnhedTilknyt EndAttachedUnits

6 MoveAttachedUnits OrganisationEnhedFlyt OrganisationFunktionFlyt OpretBruger RetBruger EndUser EndBruger GetPersonUuiderFraBrugerId GetClosestResponsible GetNearestRelationBetweenOrganizations GetTilknyttedeEnheder TilknytItSystemOrganisationEnhed EndAttachedItSystem TilknytEngagementEnhed EndTilknytningEngagementEnhed GenerateBrugernavnItSystem Part GetPersonList GetAdresseList PersonOpret PersonRet OpretGeografiskAdresse RetGeografiskAdresse GetGeografiskAdresse ImportGeografiskAdresse EndGeografiskAdresse Klassifikation GetKlassifikationList GetFacetterForKlassifikation GetKlasseForFacet GetKlasseList KlassifikationSelect OpretKlassifikation RetKlassifikation AfslutKlassifikation OpretFacet RetFacet AfslutFacet OpretKlasse RetKlasse AfpublicerKlasse Composite services GetEngagement

7 3.6.2 GetEngagementDetailed GetFunctionCascade GetLokationDetails GetCompanyDepartmentOffice FindPersonsEngagedInSubtree OpretEngagement RetEngagement EndEngagement RetLokation OpretStedfortraeder RetStedfortraeder GetStedfortraederListe GetPersonListeUdFraLeder GetPersonListeUdFraStedfortraeder CompleteExport SecurityChecker DPR CompleteExport GetEngagementKaskadeFunktion GetAttachedEngagementsForUnit EndAttachmentEngagementToUnit AttachEngagementToUnit CleanPersonerUdenEngagementer PublishRegistrations Deprecated and not in use Removed services Appendiks I.a opdaterende service response eksempler Succes ved opret Manglende parameter Entitet ikke fundet I.b læsende service eksempler GetOrganisationList GetEntireHierarchy GetUnitDetailsResponse GetLocations GetFunction GetFunctionsForUnit GetFunctionsForPerson GetAttachedPersonsForUnit GetAttachedUnitsForPerson GetUnitsToRootResponse

8 GetUnitsForClassResponse GetFunctionsForSubTreeResponse GetFunctionCascadeResponse GetBrugerResponse GetPersonListResponse GetAdresseListResponse GetKlassifikationListResponse GetFacetterForKlassifikationResponse GetKlasseForFacetResponse GetKlasseListResponse KlassifikationSelectResponse GetEngagementResponse GetEngagementDetailedResponse GetLokationDetailsResponse CompleteExportResponse

9 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 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-e b-bd6d c6bfab &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= URL opbygning Service komponenterne er opdelt i fire, vist herunder, se tabel 2, for en forklaring af tokens i URL. Organisation komponent 9

10 Part komponent Klassifiaktion komponent Sammensatte services komponent 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: Eksempel på URL til servicen GetEntireHierarchy på en produktions server, Bemærk at -test er udeladt.: 10

11 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

12 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

13 3.3 Organisation GetOrganisationList Returnerer alle gyldige organisationer med type angivelse. Servicen kan returnere JSON eller XML. Ingen parametre udover vt kan angives. Gå til for response eksempel 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 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 for response eksempel. 13

14 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 for response eksempel 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 for response eksempel 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 for response eksempel. 14

15 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 for response eksempel 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 for response eksempel. 15

16 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 for response eksempel GetAttachedUnitsForPerson Lister personer der blot er tilknyttet en enhed. Returnerer JSON eller XML. uuid UUID r organisationenhed uuid Tabel 11: GetAttachedUnitsForPerson parametre Gå til for response eksempel 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 for response eksempel GetUnitsForClass Returnerer enheder der har given klasse som opgave, enhedstype eller branche. Returnerer JSON eller XML. 16

17 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 for response eksempel 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 for response eksempel 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

18 Gå til for response eksempel GetItSystemList Returnerer alle aktive IT-systemer Response format er XML 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 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

19 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 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

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 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 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

21 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 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 EndLocation Afslutter en lokation. Returnerer XML. uuid UUID r lokation uuid Tabel 25: EndLocation parametre 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

22 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 EndFunction Afslutter en given organisationfunktion, dv.s gyldighed sætte til INAKTIV. Returnerer XML. uuid UUID r organisationfunktion uuid Tabel 27: EndFunction parametre 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

23 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 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

24 EndAttachedPersons Aflsutter tilknytning til én eller flere personer. Returnerer XML. unituuid UUID r organisationenhed uuid på en enhed tilknytninger afsluttes personuuid UUID o person uuid personuuids UUID o angivelse af flere person separeret med, Tabel 31: EndAttachedPersons parametre AttachPerson Tilknyt en person til en enhed. Returnerer XML. unituuid UUID r organisationenhed uuid personuuid UUID r person uuid 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 tilknytning til enhed Tabel 32: AttachPerson parametre AttachPersonToFunction Tilknyt en person til en organisationfunktion. Returnerer XML. functionuuid UUID r organisationfunktion uuid personuuid UUID r person uuid 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 tilknytning til funktion Tabel 33: AttachPersonToFunction parametre 24

25 OrganisationEnhedTilknyt Tilknyt en enhed til en anden enhed. Bemærk her er tale om tilknyttet enhed relation og IKKE overordnet relation. Returnerer XML. uuid UUID r organisationenhed uuid på enhed hvortil anden enhed tilknyttes tilknytuuid UUID r organisationenhed uuid Tabel 34: OrganisationEnhedTilknyt parametre EndAttachedUnits Afslut tilknytninger af enheder til en enhed. Bemærk her er tale om tilknyttet enhed relation og IKKE overordnet relation. Returnerer XML. uuid UUID r organisationenhed uuid på enhed hvortil tilknytninger afsluttes unituuid UUID o organisationenhed uuid unituuids UUID o flere enheder separeret med, Tabel 35: EndAttachedUnits parametre MoveAttachedUnits Flyt tilknytninger til enheder fra én enhed til én anden. Bemærk her er tale om tilknyttet enhed relation og IKKE overordnet relation. Returnerer XML. fromuuid UUID r organisationenhed uuid på enhed hvorfra tilknytninger flyttes touuid UUID r organisationenhed uuid på enhed hvortil tilknytninger flyttes uuid UUID o organisationenhed uuid uuids UUID o flere enheder separeret med, Tabel 36: MoveAttachedUnits parametre 25

26 OrganisationEnhedFlyt Retter overordnet relation på enhed. Response format er XML. uuid UUID r organisationenhed uuid parentuuid UUID r organisationenhed uuid, som bliver ny overordnet Tabel 37: OrganisationEnhedFlyt parametre OrganisationFunktionFlyt Flytter en eller flere organisationfunktioner fra én enhed til en anden. Er organisationfunktionen tilknyttet flere enheder, afsluttes blot den tilknytning på angivne fromuuid og en tilknytning oprettes til touuid. Hvis kun én skal flyttes kan enten angives KUN uuid, eller blot én forekomst i uuids. Response format er XML. uuid UUID o organisationfunktion uuid uuids UUID o organisationfunktion uuid er, separeret med, fromuuid UUID r organisationenhed der flyttes fra touuid UUID r organisationenhed der flyttes til Tabel 38: OrganisationFunktionFlyt parametre OpretBruger Opretter en bruger tilknyttet en person. Response format er XML. personuuid UUID o person uuid engagementuuid UUID o engagement uuid bvn tekststreng r bruger brugervendtnoegle brugernavn tekststreng r navn på brugeren itsystemuuid tekststreng o uuid på det IT system brugeren er tilknyttet brugertypeuuid tekststreng o klasse uuid på type af bruger enheduuid tekststreng o uuid på den enhed brugeren er tilknyttet integrationattributname[x] tekststreng o navn på integration attribut integrationattributvalue[x] tekststreng o grupperet med integrationattributname Tabel 39: OpretBruger 26

27 RetBruger Retter en bruger tilknyttet en person. brugere identificeres enten med bvn eller brugeruuid. Hensigten er at kunne rette integration attributter og navn på bruger. Response format er XML. brugeruuid UUID o bruger uuid bvn tekststreng o bruger brugervendtnoegle brugernavn tekststreng o navn på brugeren brugertypeuuid tekststreng o klasse uuid på type af bruger itsystemuuid tekststreng o uuid på det IT system brugeren er tilknyttet enheduuid tekststreng o uuid på den enhed brugeren er tilknyttet engagmeentuuid tekststreng o uuid på det engagement brugeren er tilknyttet integrationattributname[x] tekststreng o navn på integration attribut integrationattributvalue[x] tekststreng o grupperet med integrationattributname Tabel 40: RetBruger EndUser Aslutter en bruger. returnerer XML. uuid UUID o bruger uuid Tabel 41: EndUser EndBruger Aslutter en bruger. returnerer XML. uuid UUID o bruger uuid Tabel 42: EndBruger 27

28 GetPersonUuiderFraBrugerId Returnere personens UUID ud fra bruger id. Returnerer XML. brugerid String r Bruger id Tabel 43: GetPersonerUuider parametre Eksempel: <getpersonuuiderforbrugeridresponse> <personer> <person uuid="75c0be3b-fce7-41dc-a025-0ba971cdebb8"/> </personer> <qualityofservice> <totaltimems>22</totaltimems> </qualityofservice> </getpersonuuiderforbrugeridresponse> GetClosestResponsible Returnere leder funktioner fra start enhed op til roden i hierakiet for givne organisation. For hver funktion leveres: uuid på enhed som ejer funktionen, uuid er på personer som er tilknyttet funktionen og hvilke opgaver funktionen er klassificeret med. Der hvor en leder har stedfortræder inkluderes disse. Hvis en functionuuid er angivet, så springes enheder over hvor en person tilknyttet det givne engagment er tilknyttet en lederfuntkion med det givne ansvar. Kort sagt.: en person kan ikke have ansvar for sit eget engagement. Returnerer JSON eller XML, understøtter format parameteren. 28

29 unituuid String o UUID for start enheden functionuuid String o UUID for engagement der er tilknyttet en enhed der søges på. orguuid String o uuid på organisation der søges i, default er den organisation som enhed eller engagement er tilknyttet. taskuuid String o Filtrere svaret således at det kun indeholder funktioner som har angivne opgave. Det er muligt at angive flere taskuuid parametre hvilket svarer til en OG operation, dvs. funktionerne skal have alle opgaverne for ikke at blive filtreret fra. Opgaver (task) er både leder ansvar og betegnelse. betegnelseuuid String o begræns til leder med given betegnelse. typeuuid String o leder stedfortræder rolle, default er leder. excludevacantfunctions boolean o true false, default er false, angiver om tomme funktioner skal springes over. Tabel 44: GetClosestResponsible parametre Eksempel: <?xml version="1.0" encoding="utf-8"?> <getclosestresponsibleresponse> <leaders> <function uuid="943f9182-f9ef-4bb0-bb9f-cc8cca7e6822" navn="ungehusleder" objektid="25"> <person uuid="3a9657f8-3db a6be-b9fd015b8470" /> <units> <unit uuid="f b5dd-40a0-8f76-ef87cebae523" /> </units> <tasks> <task uuid="40fb435e-c824-45de-b5d2-75b693e1dcaa"/> <task uuid="uuid-lederansvar-1"/> <task uuid="uuid-lederansvar-2"/> <task uuid="uuid-lederansvar-3"/> <task uuid="uuid-lederansvar-4"/> </tasks> </function> <function uuid="37bf5a37-8b56-4cae-94ba-d3e3a5144a27" navn="kulturchef" objektid="18"> <person uuid="2fccd c-4779-aaf4-c9f01ba9d655" /> <units> <unit uuid="95bf92b6-c895-4e5a-8f4f-2c3b0e2759b9" /> </units> <tasks> <task uuid="88454f75-71c e6-2da23a1a26cf"/> <task uuid="uuid-lederansvar-1"/> <task uuid="uuid-lederansvar-2"/> <task uuid="uuid-lederansvar-3"/> <task uuid="uuid-lederansvar-4"/> <task uuid="uuid-lederansvar-5"/> 29

30 </tasks> </function> <function uuid="927236d7-3d2e-490a a2f1c781a66" navn="centerchef" objektid="327688"> <person uuid="947e6c2b-6b1d-4dd1-a607-1be287a258e5" /> <units> <unit uuid="b8fdd5e bf-a0fa-bb7b314e8e6d" /> </units> <tasks> <task uuid="c523eda4-a445-45df-861a-79d07251f899"/> <task uuid="uuid-lederansvar-1"/> <task uuid="uuid-lederansvar-3"/> <task uuid="uuid-lederansvar-4"/> <task uuid="uuid-lederansvar-6"/> <task uuid="uuid-lederansvar-2"/> </tasks> </function> <function uuid="f621459a b5b4-ae4cfc71d647" navn="direktør" objektid="688129"> <person uuid="cbf81c27-4fc7-4a6b-b ee6c759" /> <units> <unit uuid="d9ccd8f8-7c7c c0-cfc3dd7ff6ce" /> </units> <tasks> <task uuid="6896b73c-ebed-44d5-973a-7cf3dcc6a254"/> <task uuid="uuid-lederansvar-1"/> </tasks> </function> <function uuid="1f6f9d76-374a-489a-90da-efa2b77ff8cd" navn="kommunaldirektør" objektid="688130"> <person uuid="cbf81c27-4fc7-4a6b-b ee6c759" /> <units> <unit uuid="f414a2f1-5cac b8d3109d3133" /> </units> <tasks> <task uuid="f2dc8ddf-498f-4f80-aaa1-2fdf09e46afa"/> <task uuid="uuid-lederansvar-1"/> <task uuid="uuid-lederansvar-6"/> </tasks> </function> </leaders> <proxies> <function uuid="e5ce2a31-5fbf-48cc-a419-e06b3ac3669f" objektid=" "> <person uuid="947e6c2b-6b1d-4dd1-a607-1be287a258e5" /> <person uuid="2fccd c-4779-aaf4-c9f01ba9d655" /> <units> <unit uuid="95bf92b6-c895-4e5a-8f4f-2c3b0e2759b9" /> </units> <tasks> <task uuid="c523eda4-a445-45df-861a-79d07251f899"/> <task uuid="uuid-lederansvar-1"/> </tasks> </function> <function uuid="dd4a266d-92c2-453f-a48a-beb733996a3f" objektid=" "> <person uuid="947e6c2b-6b1d-4dd1-a607-1be287a258e5" /> <person uuid="2fccd c-4779-aaf4-c9f01ba9d655" /> 30

31 <units> <unit uuid="95bf92b6-c895-4e5a-8f4f-2c3b0e2759b9" /> </units> <tasks> <task uuid="c523eda4-a445-45df-861a-79d07251f899"/> <task uuid="uuid-lederansvar-1"/> </tasks> </function> <function uuid="e5ce2a31-5fbf-48cc-a419-e06b3ac3669f" objektid=" "> <person uuid="947e6c2b-6b1d-4dd1-a607-1be287a258e5" /> <person uuid="2fccd c-4779-aaf4-c9f01ba9d655" /> <units> <unit uuid="b8fdd5e bf-a0fa-bb7b314e8e6d" /> </units> <tasks> <task uuid="c523eda4-a445-45df-861a-79d07251f899"/> <task uuid="uuid-lederansvar-1"/> </tasks> </function> <function uuid="dd4a266d-92c2-453f-a48a-beb733996a3f" objektid=" "> <person uuid="947e6c2b-6b1d-4dd1-a607-1be287a258e5" /> <person uuid="2fccd c-4779-aaf4-c9f01ba9d655" /> <units> <unit uuid="b8fdd5e bf-a0fa-bb7b314e8e6d" /> </units> <tasks> <task uuid="c523eda4-a445-45df-861a-79d07251f899"/> <task uuid="uuid-lederansvar-1"/> </tasks> </function> </proxies> <qualityofservice><totaltimems>2286</totaltimems></qualityofservice> </getclosestresponsibleresponse> \\ &taskuuid=c523eda4-a445-45df-861a-79d07251f899 <?xml version="1.0" encoding="utf-8"?> <getclosestresponsibleresponse> <leaders> <function uuid="927236d7-3d2e-490a a2f1c781a66" navn="centerchef" objektid="327688"> <person uuid="947e6c2b-6b1d-4dd1-a607-1be287a258e5" /> <units> <unit uuid="b8fdd5e bf-a0fa-bb7b314e8e6d" /> </units> <tasks> <task uuid="c523eda4-a445-45df-861a-79d07251f899"/> <task uuid="uuid-lederansvar-1"/> <task uuid="uuid-lederansvar-3"/> <task uuid="uuid-lederansvar-4"/> <task uuid="uuid-lederansvar-6"/> <task uuid="uuid-lederansvar-2"/> </tasks> 31

32 </function> </leaders> <proxies> <function uuid="e5ce2a31-5fbf-48cc-a419-e06b3ac3669f" objektid=" "> <person uuid="947e6c2b-6b1d-4dd1-a607-1be287a258e5" /> <person uuid="2fccd c-4779-aaf4-c9f01ba9d655" /> <units> <unit uuid="b8fdd5e bf-a0fa-bb7b314e8e6d" /> </units> <tasks> <task uuid="c523eda4-a445-45df-861a-79d07251f899"/> <task uuid="uuid-lederansvar-1"/> </tasks> </function> <function uuid="dd4a266d-92c2-453f-a48a-beb733996a3f" objektid=" "> <person uuid="947e6c2b-6b1d-4dd1-a607-1be287a258e5" /> <person uuid="2fccd c-4779-aaf4-c9f01ba9d655" /> <units> <unit uuid="b8fdd5e bf-a0fa-bb7b314e8e6d" /> </units> <tasks> <task uuid="c523eda4-a445-45df-861a-79d07251f899"/> <task uuid="uuid-lederansvar-1"/> </tasks> </function> </proxies> <qualityofservice><totaltimems>185</totaltimems></qualityofservice> </getclosestresponsibleresponse> GetNearestRelationBetweenOrganizations Anvendes til at finde relationen fra en enhed i leftorg til en enhed i rightorg, der søges via enhedens roottopath, nærmeste enhed i leftorg med en enhed der er tilknyttet fra rightorg returneres. Findes der ingen relation, returnes tomt resultat. Returnerer XML. unituuid String r UUID for enhed der eksisterer i leftorg leftorguuid String r UUID for organisation hvori enheden er placeret rightorguuid String r UUID for organisation der er tilknyttet leftorg Tabel 45: GetNearestRelationBetweenOrganizations parametre Eksempel: unituuid=29c abd1-f79b74dc64ff &leftorguuid=a5b2a26f-f6c7-4d82-974c-d74cd5e66028&rightorguuid=49cb77da-6ab3-4f e8e421c25372 <?xml version="1.0" encoding="utf-8"?> <getnearestrelationbetweenorganizationsresponse> <enhed uuid="cafead7d-4bc0-4b1e-97c8-0689a58dfc3c" enhedstype="7f5e6cec-200e-402d-ba69-d eefb" tilhoerer="49cb77da-6ab3-4f e8e421c25372" 32

33 objectid="196608" brugervendtnoegle="" navn="kk"> <opgaver> </opgaver> <integrationattributter> </integrationattributter> <tilknyttedeenheder> <enhed uuid="ea9b25d3-1bd c04-98f8711c7823" navn="kattegat Kommune" organisationtilhoereruuid="a5b2a26f-f6c7-4d82-974c-d74cd5e66028" organisationtilhoerernavn="administrativ Organisation" /> </tilknyttedeenheder> </enhed> <quality-of-service>282</quality-of-service> </getnearestrelationbetweenorganizationsresponse> GetTilknyttedeEnheder Returnere alle enheder i en organisation, som har tilknytninger til andre enheder. Servicen levere kun XML. orguuid String r UUID for organisationen Tabel 46: GetTilknyttedeEnheder parametre Eksempel: <?xml version="1.0" encoding="utf-8"?> <gettilknyttedeenhederresponse> <enhed uuid="00a465c8-04ee-46d6-9c6e bf5bbc" bvn="60637fagmed" navn="ai Jelling Børnegård"> <tilknyttet uuid="970d1a b a42352ad"/> </enhed> <enhed uuid="01660f3f b97e-14010d46b4f4" bvn="20415fagmed" navn="tandplejen"> <tilknyttet uuid="73aa3477-2d15-418d-a422-f7af0430fd79"/> <tilknyttet uuid="5e42ae8a-f8f0-44df-83df-15e24f9d2277"/> <tilknyttet uuid="1b15c2d6-a1f2-49bf-bf7c-334f93bedd29"/> <tilknyttet uuid="e3048d1e-bd23-4e0e-93d1-d92d80e6153d"/> <tilknyttet uuid="fd6f71f4-600f-4cc4-b70f-3c551301b0da"/> <tilknyttet uuid="3a43cceb-3d8c-463c-b52b-13b9db4e8f26"/> </enhed> <enhed uuid="037f9653-b172-4d5f-a249-d852aa61d7c3" bvn="40343fagmed" navn="10 klasse skolen"> <tilknyttet uuid="f2c36d51-2d32-470d-8eac-3c1ee4b9edc8"/> <tilknyttet uuid="3c285e21-22bb-44ec-b8ca-610f783fd2e1"/> <tilknyttet uuid="79cc17c ad-9bf8-7cecc9c49122"/> </enhed> <enhed uuid="07ff28c0-cca8-4f58-b738-0fa1810c9395" bvn="60193fagmed" navn="bh VindMøllen"> <tilknyttet uuid="9c9d7e f-34dabb8fb4b3"/> </enhed> <enhed uuid="0b0d80eb-c7e1-40e7-b19b-0dc6561dc4fe" bvn="60196fagmed" navn="ai Mælkebøtten"> <tilknyttet uuid="5adba1dd-7de9-49c1-9ee2-6d15185b9085"/> </enhed> <enhed uuid="0e5da47c aa2-9fba-7d7ff3e19ed3" bvn="60220fagmed" navn="ai Solsikken - Tusindfryd"> <tilknyttet uuid="3496a e-43da-b9dc-3d839ce4f390"/> </enhed> <enhed uuid="0f8c3750-d d eaa11a54e" bvn="40168fagmed" navn="uddannelse & Læring"> <tilknyttet uuid="aee8f1b4-7ad1-477c-92df e72ba"/> 33

34 <tilknyttet uuid="bc2f2e25-0c2b-461c e4d26a6cc17"/> <tilknyttet uuid="bebfd4a a76-b711-eb8a8713c5e9"/> <tilknyttet uuid="fc7b97ac-efdf-4b d922d "/> <tilknyttet uuid="ea974f5e-2aa a8f8-898ee5c86ab7"/> <tilknyttet uuid="65193fae d9f-8c61-942c23d87861"/> <tilknyttet uuid="f2b0a38f ae47-d637b1acca05"/> </enhed> <enhed uuid="16a7afde-b092-4d e7f8f7cb24c4" bvn="10429fagmed" navn="senior - SSH elever"> <tilknyttet uuid="9ad9e858-3da2-453a-912c-bcd634739c3b"/> </enhed> <enhed uuid="17a3ebbd-6ba4-43ef-bb7d-d aa36" bvn="80393fagmed" navn="administration"> <tilknyttet uuid="aca4e9f2-54d7-40f7-bb22-7ee50dfa30f7"/> <tilknyttet uuid="c665226b-c3b baf2-2d5fa8d4eee1"/> <tilknyttet uuid="5515aa99-fed6-4b5b-95b6-9a418ab6bca6"/> <tilknyttet uuid="7502d04c-9d50-4bb4-bf b90fbc28"/> <tilknyttet uuid="46dfcf3c-e a610-0b20649d4353"/> <tilknyttet uuid="03c009b2-941e-4a98-8a24-53ed53e47add"/> <tilknyttet uuid="beec5b64-abc2-48f5-8f0f-94ad23471c03"/> <tilknyttet uuid="a2ee8c15-f fa5b3f9e97"/> <tilknyttet uuid="5da6f732-ef70-44ab-b59e-7aa48be319b0"/> </enhed> <enhed uuid="1996ede3-c708-48c2-bef c84448" bvn="10604fagmed" navn="fuglekær"> <tilknyttet uuid="56dd9da dc a229140f2657"/> <tilknyttet uuid="d17b1e20-d77d-4d2b-b407-13a399af2cc6"/> <tilknyttet uuid="a151d d c10a511111a"/> <tilknyttet uuid="76f7b1e ba6-b412-b a"/> <tilknyttet uuid="6ed626eb-fb94-4ef1-b0d7-0a8b4d82c9af"/> <tilknyttet uuid="3ab85d26-815f f30-71eab320576f"/> </enhed>... <enhedcount>149</enhedcount> <tilknyttedecount>618</tilknyttedecount> <qualityofservice><totaltimems>153</totaltimems></qualityofservice> </gettilknyttedeenhederresponse> 34

35 TilknytItSystemOrganisationEnhed Tilknyt et itsystem til en organisationenhed. Returnerer XML eller JSON. oeuuid String r UUID for enhed der eksisterer i leftorg itsystemuuids String r UUID for itsystemer der skal tilknyttes til organisation enhed Tabel 47: TilknytItSystemOrganisationEnhed parametre Eksempel - XML resultat: oeuuid=e0663d3a-b8bf-4c0d-bfb0-77daa2625da3 &itsystemuuids=41504f f494e54 <?xml version="1.0" encoding="utf-8"?> <tilknytitsystemorganisationenhedresponse> <success> <message>itsystemer 41504f f494e54 tylknyttet til organisation enhed e0663d3a-b8bf-4c0d-bfb0-77daa2625da3.</message> </success> <qualityofservice> <totaltimems>26</totaltimems> </qualityofservice> </tilknytitsystemorganisationenhedresponse> Eksempel - JSON resultat: oeuuid=e0663d3a-b8bf-4c0d-bfb0-77daa2625da3 &itsystemuuids=41504f f494e54 { } "tilknytitsystemorganisationenhedresponse":{ "hash":{ "status":"success", "message":"itsystemer 41504f f494e54 tylknyttet til organisation enhed e0663d3a-b8bf-4c0d-bfb0-77daa2625da3." }, "qualityofservice":{ "totaltimems":210 } } 35

36 EndAttachedItSystem Afslutter tilknytning mellem en organisationenhed og et eller flere itsystemer. Returnerer XML eller JSON. oeuuid String r UUID for enhed der eksisterer i leftorg itsystemuuids String r UUID for itsystemer hvis tilknytning til organisation enhed skal afsluttes Tabel 48: EndAttachedItSystem parametre Eksempel - XML resultat: itsystemuuids=41504f f494e54 <?xml version="1.0" encoding="utf-8"?> <endattacheditsystemresponse> <success> <message>tylknytning mellem ItSystemer f1b9ba81-8b bc24-0d0605c f f494e54 afsluttet.</message> </success> <qualityofservice> <totaltimems>44</totaltimems> </qualityofservice> </endattacheditsystemresponse> og organisation enhed Eksempel - JSON resultat: itsystemuuids=41504f f494e54 { } "endattacheditsystemresponse":{ "hash":{ "status":"success", "message":"tylknytning mellem ItSystemer f1b9ba81-8b bc24-0d0605c94073 } organisation enhed 41504f f494e54 afsluttet." }, "qualityofservice":{ "totaltimems":92 } og 36