APOS2 OIO Services
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 OIO Services tilgængelige i APOS2. Versioner Version Date Description 1.0.0 05/06/2013 Initial version 2.0.0 24/07/2013 URI er ændret 2
Indhold 1 Generelt om OIO services 4 1.0.1 Komponent opdelingen........................ 4 1.0.2 URL opbygning............................. 4 2 Anvendelse af services 5 2.1 Organisation.................................. 5 2.2 Klassifikation.................................. 5 2.3 Part....................................... 5 3 Services 5 3.1 Oversigt over Organisation.......................... 5 3.1.1 Organisation.............................. 5 3.1.2 OrganisationEnhed........................... 5 3.1.3 OrganisationFunktion......................... 6 3.1.4 Lokation................................. 6 3.1.5 Bruger.................................. 6 3.1.6 ItSystem................................ 6 3.1.7 Interessefaellesskab........................... 6 3.2 Oversigt over Klassifikation.......................... 6 3.2.1 Klassifikation.............................. 6 3.2.2 Facet.................................. 7 3.2.3 Klasse.................................. 7 3.3 Oversigt over Part............................... 7 3.3.1 Person.................................. 7 3.3.2 GeografiskAdresse........................... 7 3.3.3 KlassifikationKontaktkanal...................... 7 3
1 Generelt om OIO services 1.0.1 Komponent opdelingen Services er opdelt i komponenterne Organisation, Part og Klassifikation. Services på entiteter er således opdelt i den respektive komponenter de tilhører. Eks. OrganisationServiceLaesOIO er tilgængelig i Organisation komponenten, mens PersonServiceLaesOIO er tilgængelig i Part komponenten. 1.0.2 URL opbygning Service komponenterne er opdelt i 3, vist herunder, se tabel 1, for en forklaring af tokens i URL. Organisation komponent http://<server>[:<port>]/apos2-oio-organisation[-<miljø>]/<operation><entitet> Part komponent http://<server>[:<port>]/apos2-oio-part[-<miljø>]/<operation><entitet> Klassifikation komponent http://<server>[:<port>]/apos2-oio-klassifikation[-<miljø>]/<operation><entitet> 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 1: URL tokens Eksempel på URL til servicen OrganisationEnhedServiceImporterOIO på en test server http://s00270t:8080/apos2-app-organisation-test/organisationenhedserviceimporteroio 4
2 Anvendelse af services Et dokument POST es til operationen der skal udføres. Operationer for hvert domæne objekt er beskrevet i standardens XSD er. Hernder er referencer til XSD erne. I følgende sektion er URI er på service endpoints. 2.1 Organisation http://axapoint.com/xsd/organisationoperationer.xsd http://axapoint.com/xsd/organisationenhedoperationer.xsd http://axapoint.com/xsd/organisationfunktionoperationer.xsd http://axapoint.com/xsd/lokationoperationer.xsd http://axapoint.com/xsd/brugeroperationer.xsd http://axapoint.com/xsd/itsystemoperationer.xsd http://axapoint.com/xsd/interessefaellesskaboperationer.xsd 2.2 Klassifikation http://axapoint.com/xsd/klassifikation.xsd http://axapoint.com/xsd/facet.xsd http://axapoint.com/xsd/klasse.xsd 2.3 Part http://axapoint.com/xsd/person.xsd http://axapoint.com/xsd/geografiskadresse.xsd http://axapoint.com/xsd/klassifikationkontaktkanal.xsd 3 Services Her følger en komplet oversigt over services. 3.1 Oversigt over Organisation 3.1.1 Organisation http://host/apos2-oio-organisation/soegorganisation http://host/apos2-oio-organisation/listorganisation http://host/apos2-oio-organisation/laesorganisation http://host/apos2-oio-organisation/opretorganisation http://host/apos2-oio-organisation/retorganisation http://host/apos2-oio-organisation/sletorganisation http://host/apos2-oio-organisation/importerorganisation http://host/apos2-oio-organisation/passiverorganisation 3.1.2 OrganisationEnhed http://host/apos2-oio-organisation/soegorganisationenhed http://host/apos2-oio-organisation/listorganisationenhed http://host/apos2-oio-organisation/laesorganisationenhed http://host/apos2-oio-organisation/opretorganisationenhed http://host/apos2-oio-organisation/retorganisationenhed http://host/apos2-oio-organisation/sletorganisationenhed http://host/apos2-oio-organisation/importerorganisationenhed http://host/apos2-oio-organisation/passiverorganisationenhed 5
3.1.3 OrganisationFunktion http://host/apos2-oio-organisation/soegorganisationfunktion http://host/apos2-oio-organisation/listorganisationfunktion http://host/apos2-oio-organisation/laesorganisationfunktion http://host/apos2-oio-organisation/opretorganisationfunktion http://host/apos2-oio-organisation/retorganisationfunktion http://host/apos2-oio-organisation/sletorganisationfunktion http://host/apos2-oio-organisation/importerorganisationfunktion http://host/apos2-oio-organisation/passiverorganisationfunktion 3.1.4 Lokation http://host/apos2-oio-organisation/soeglokation http://host/apos2-oio-organisation/listlokation http://host/apos2-oio-organisation/laeslokation http://host/apos2-oio-organisation/opretlokation http://host/apos2-oio-organisation/retlokation http://host/apos2-oio-organisation/sletlokation http://host/apos2-oio-organisation/importerlokation http://host/apos2-oio-organisation/passiverlokation 3.1.5 Bruger http://host/apos2-oio-organisation/soegbruger http://host/apos2-oio-organisation/listbruger http://host/apos2-oio-organisation/laesbruger http://host/apos2-oio-organisation/opretbruger http://host/apos2-oio-organisation/retbruger http://host/apos2-oio-organisation/sletbruger http://host/apos2-oio-organisation/importerbruger http://host/apos2-oio-organisation/passiverbruger 3.1.6 ItSystem http://host/apos2-oio-organisation/soegitsystem http://host/apos2-oio-organisation/listitsystem http://host/apos2-oio-organisation/laesitsystem http://host/apos2-oio-organisation/opretitsystem http://host/apos2-oio-organisation/retitsystem http://host/apos2-oio-organisation/sletitsystem http://host/apos2-oio-organisation/importeritsystem http://host/apos2-oio-organisation/passiveritsystem 3.1.7 Interessefaellesskab http://host/apos2-oio-organisation/soeginteressefaellesskab http://host/apos2-oio-organisation/listinteressefaellesskab http://host/apos2-oio-organisation/laesinteressefaellesskab http://host/apos2-oio-organisation/opretinteressefaellesskab http://host/apos2-oio-organisation/retinteressefaellesskab http://host/apos2-oio-organisation/sletinteressefaellesskab http://host/apos2-oio-organisation/importerinteressefaellesskab http://host/apos2-oio-organisation/passiverinteressefaellesskab 3.2 Oversigt over Klassifikation 3.2.1 Klassifikation http://host/apos2-oio-klassifikation/soegklassifikation http://host/apos2-oio-klassifikation/listklassifikation http://host/apos2-oio-klassifikation/laesklassifikation http://host/apos2-oio-klassifikation/opretklassifikation http://host/apos2-oio-klassifikation/retklassifikation http://host/apos2-oio-klassifikation/sletklassifikation http://host/apos2-oio-klassifikation/importerklassifikation http://host/apos2-oio-klassifikation/passiverklassifikation 6
3.2.2 Facet http://host/apos2-oio-klassifikation/soegfacet http://host/apos2-oio-klassifikation/listfacet http://host/apos2-oio-klassifikation/laesfacet http://host/apos2-oio-klassifikation/opretfacet http://host/apos2-oio-klassifikation/retfacet http://host/apos2-oio-klassifikation/sletfacet http://host/apos2-oio-klassifikation/importerfacet http://host/apos2-oio-klassifikation/passiverfacet 3.2.3 Klasse http://host/apos2-oio-klassifikation/soegklasse http://host/apos2-oio-klassifikation/listklasse http://host/apos2-oio-klassifikation/laesklasse http://host/apos2-oio-klassifikation/opretklasse http://host/apos2-oio-klassifikation/retklasse http://host/apos2-oio-klassifikation/sletklasse http://host/apos2-oio-klassifikation/importerklasse http://host/apos2-oio-klassifikation/passiverklasse 3.3 Oversigt over Part 3.3.1 Person http://host/apos2-oio-part/soegperson http://host/apos2-oio-part/listperson http://host/apos2-oio-part/laesperson http://host/apos2-oio-part/opretperson http://host/apos2-oio-part/retperson http://host/apos2-oio-part/sletperson http://host/apos2-oio-part/importerperson http://host/apos2-oio-part/passiverperson 3.3.2 GeografiskAdresse http://host/apos2-oio-part/soeggeografiskadresse http://host/apos2-oio-part/listgeografiskadresse http://host/apos2-oio-part/laesgeografiskadresse http://host/apos2-oio-part/opretgeografiskadresse http://host/apos2-oio-part/retgeografiskadresse http://host/apos2-oio-part/sletgeografiskadresse http://host/apos2-oio-part/importergeografiskadresse http://host/apos2-oio-part/passivergeografiskadresse 3.3.3 KlassifikationKontaktkanal http://host/apos2-oio-part/soegklassifikationkontaktkanal http://host/apos2-oio-part/listklassifikationkontaktkanal http://host/apos2-oio-part/laesklassifikationkontaktkanal http://host/apos2-oio-part/opretklassifikationkontaktkanal http://host/apos2-oio-part/retklassifikationkontaktkanal http://host/apos2-oio-part/sletklassifikationkontaktkanal http://host/apos2-oio-part/importerklassifikationkontaktkanal http://host/apos2-oio-part/passiverklassifikationkontaktkanal 7