Serviceoperationer Puls
Stancode
Miljøportalsekretariatet
Punktkildeprojektet
Den 4. marts 2015
Indholdsfortegnelse
GENERELT FOR ALLE METODER I WEBSERVICEN
2
STANCODE.ISALIVE
3
STANCODE.OPDATERLISTER
4
Generelt for alle metoder i webservicen
Revisionshistorik
Dato
Rev. af
Version
Revision
2015-03-04
MHF
0.2
Opdateringer af endpoints mv.
2012-02-22
BC-HRJ
0.1
Dokument oprettet
Alle metoder i Stamdata Webservicen er pakket ind i en struktur som ses nedenfor:
Roller, CVR-nummer
og GUID hentes fra
SAML Token
Brugerrettigheder
til PULS findes
Loggingservice
kaldes.
Valid bruger?
Nej
Kald service
Returner fejl
Ja
Alle webservices er pakket ind i en struktur magen til denne.
Dvs. omkranset af logging og brugervalidering.
Loggingservice
kaldes.
Returner resultat
Det vil sige at alle metoder, beskrevet i dette dokument, er ”pakket” ind i denne struktur, og de kald og tjek der
er beskrevet her, udføres alle før og efter metoderne der er beskrevet senere.
Service Operation Definition
WSDL
Prod: http://services.puls.miljoeportal.dk/miljoeportal.surfacewater.pointsources.1.0.0/wsdl/Stancode.wsdl
Demo: http://services.puls.demo.miljoeportal.dk/miljoeportal.surfacewater.pointsources.1.0.0/wsdl/Stancode.wsdl
Service
Prod: http://services.puls.miljoeportal.dk/miljoeportal.surfacewater.pointsources.1.0.1/Stancode.svc
Demo: http://services.puls.demo.miljoeportal.dk/miljoeportal.surfacewater.pointsources.1.0.1/Stancode.svc
NemID-service
Prod: http://services.puls.miljoeportal.dk/miljoeportal.surfacewater.pointsources.1.0.1/NemID/Stancode.svc
Demo: http://services.puls.demo.miljoeportal.dk/miljoeportal.surfacewater.pointsources.1.0.1/NemID/Stancode.svc
B 3.1a PULS Serviceoperationer - Stancode.docx
2
Stancode.IsAlive
Indenfor Stancode Service beskrives et antal operationer, hver med sin definition herunder.
Revisionshistorik
Dato
Rev. af
Version
Revision
2015-01-19
SMu
0.3
Opdateret versions-info
2012-02-22
Morten
Høybye
Frederiksen
0.2
Diverse tilretninger.
2012-02-02
Søren Munk
0.1
Dokument oprettet
Styringsdata
Navn
Stancode.svc#IsAlive
Version
Status
Dato for frigivelse
Forretningsmæssig kontekst
Formål /beskrivelse
Service operations diagram
Operationen tester forbindelse til servicen og den bagvedliggende database.
Opret forbindelse til
database og
verificer at
Punktkilde-tabellen
findes
Er forbindelsen
OK?
Nej
Data som udveksles (input/output)
Ja
Returner
normalsvar
Returner fejlsvar
Operationen tager som input en dmp:MessageType-struktur (jf.
http://rep.oio.dk/dmp.dk/xml/schemas/2009/03/01/DMPMessagePayload%20v%201.2.xsd), idet
de indsendte parametre dog ignoreres.
Som output leveres en dmp:ResultMessageType (jf.
http://rep.oio.dk/dmp.dk/xml/schemas/2009/03/01/DMPResultMessage%20v%201.2.xsd) idet
indholdet afhænger af, om svaret er positivt eller negativt:
Et positivt svar kan give et svar som følgende:
<s:Envelope xmlns:s="http://www.w3.org/2003/05/soap-envelope">
<s:Header>
<ActivityId CorrelationId="6cdd5732-f4c0-4572-8699-7ba492f1c7ac"
xmlns="http://schemas.microsoft.com/2004/09/ServiceModel/Diagnostics">
2e7cdafc-450f-40c8-aaad-11881bf190ff
</ActivityId>
</s:Header>
<s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<IsAliveResponse xmlns="urn:oio:miljoeportal:surfacewater:pointsources:1.0.0">
<ResultCode xmlns="http://rep.oio.dk/dmp.dk/xml/schemas/2009/03/01/">0</ResultCode>
<ResultReason xmlns="http://rep.oio.dk/dmp.dk/xml/schemas/2009/03/01/">
Completed successfully
</ResultReason>
<ResultDetail xmlns="http://rep.oio.dk/dmp.dk/xml/schemas/2009/03/01/">
2012-02-22T08:12:13Z
</ResultDetail>
</IsAliveResponse>
</s:Body>
</s:Envelope>
Fejlhåndteringsreturdata
I tilfælde af fejl returneres en besked i samme struktur som et positivt resultat jf. ovenfor, men
eksempelvis med følgende indhold:
<s:Envelope xmlns:s="http://www.w3.org/2003/05/soap-envelope">
B 3.1a PULS Serviceoperationer - Stancode.docx
3
<s:Header>
<ActivityId CorrelationId="6cdd5732-f4c0-4572-8699-7ba492f1c7ac"
xmlns="http://schemas.microsoft.com/2004/09/ServiceModel/Diagnostics">
2e7cdafc-450f-40c8-aaad-11881bf190ff
</ActivityId>
</s:Header>
<s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<IsAliveResponse xmlns="urn:oio:miljoeportal:surfacewater:pointsources:1.0.0">
<ResultCode xmlns="http://rep.oio.dk/dmp.dk/xml/schemas/2009/03/01/">
-1
</ResultCode>
<ResultReason xmlns="http://rep.oio.dk/dmp.dk/xml/schemas/2009/03/01/">
Repository check failed
</ResultReason>
<ResultDetail xmlns="http://rep.oio.dk/dmp.dk/xml/schemas/2009/03/01/">
[Stack Trace]
</ResultDetail>
</IsAliveResponse>
</s:Body>
</s:Envelope>
Følgende fejltyper er defineret:

-1: Repository check failed (Der kunne ikke opnås forbindelse til databasen)
Fejlhåndtering
Ingen.
Sikkerhed
TBD: Roller
Anvendt / udbudt
Operationen er udviklet for DMP og påtænkes anvendt til intern monitorering.
Servicekvalitet
Afsendt besked vil som regel nå modtageren én gang.
Responstid
Under 10 sekunder.
Kalde-effekt kategori
Servicen kan kaldes efter behov.
Noter
Ingen.
Use Cases
Der henvises til beskrivelse af udarbejdede user stories for PULS-projektet.
Forretningsobjekter
Ingen.
Stancode.OpdaterLister
Revisionshistorik
Dato
Rev. af
Version
Revision
2015-01-19
SMu
0.2
Opdateret versions-info
2012-02-22
Søren Munk
0.1
Dokument oprettet
Styringsdata
Navn
Stancode.svc#OpdaterLister
Version
Status
Dato for frigivelse
Forretningsmæssig kontekst
Formål /beskrivelse
Service operations diagram
Operationen indsætter og opdaterer Stancode lister/tabeller den bagvedliggende database.
Importer
Stancodeliste 1008
Importer
Stancodeliste 1009
Importer
Stancodeliste 1025
Importer
Stancodeliste 1059
Importer
Stancodeliste 1071
Importer
Stancodeliste 1074
Importer reference
liste 102503
Tilrettelæg resultat
B 3.1a PULS Serviceoperationer - Stancode.docx
Importer
Stancodeliste 1069
4
Data som udveksles (input /
output)
Inputdata:
Samme som til IsAlive.
Outputdata:
<s:Envelope xmlns:s="http://www.w3.org/2003/05/soap-envelope">
<s:Header>
<ActivityId CorrelationId="84f2ab43-4a7a-4208-9042-ce6c56c56468"
xmlns="http://schemas.microsoft.com/2004/09/ServiceModel/Diagnostics">
f0927d10-882a-4fa1-bc2d-83a3b80d6ea7
</ActivityId>
</s:Header>
<s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<OpdaterListerResponse xmlns="urn:oio:miljoeportal:surfacewater:pointsources:1.0.0">
<ResultCode xmlns="http://rep.oio.dk/dmp.dk/xml/schemas/2009/03/01/">0</ResultCode>
<ResultReason xmlns="http://rep.oio.dk/dmp.dk/xml/schemas/2009/03/01/">
Completed successfully
</ResultReason>
<ResultDetail xmlns="http://rep.oio.dk/dmp.dk/xml/schemas/2009/03/01/">
Alle Stancode-lister blev opdateret korrekt
</ResultDetail>
</OpdaterListerResponse>
</s:Body>
</s:Envelope>
Fejlhåndteringsreturdata
I tilfælde af fejl returneres en besked i en struktur som angivet nedenfor, eksempelvis med følgende konstruerede indhold (en fejl, der skyldes manglende implementering af Stancode
100899):
<s:Envelope xmlns:s="http://www.w3.org/2003/05/soap-envelope">
<s:Header>
<ActivityId CorrelationId="e7388c7f-fa11-4229-8e0a-2f028395bc2b"
xmlns="http://schemas.microsoft.com/2004/09/ServiceModel/Diagnostics">
c93519a5-a56b-4890-948b-6fc6ef48569d
</ActivityId>
</s:Header>
<s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<OpdaterListerResponse xmlns="urn:oio:miljoeportal:surfacewater:pointsources:1.0.0">
<ResultCode xmlns="http://rep.oio.dk/dmp.dk/xml/schemas/2009/03/01/">-1</ResultCode>
<ResultReason xmlns="http://rep.oio.dk/dmp.dk/xml/schemas/2009/03/01/">
Der opstod en fejl
</ResultReason>
<ResultDetail xmlns="http://rep.oio.dk/dmp.dk/xml/schemas/2009/03/01/">
System.NotImplementedException: Stancode-liste 100899 er ikke implementeret at
StancodeBackend.Stancode.OpdaterLister() in
C:\Main\Backend\StancodeBackend\Stancode.cs:line 56 at WebserviceWebrolle.StancodeService.Stancode.OpdaterLister(OpdaterListerRequest request) in
C:\Main\Backend\WebserviceWebrolle\miljoeportal.surfacewater.pointsources.1.0.0\Stancode.
svc.cs:line 59
</ResultDetail>
</OpdaterListerResponse>
</s:Body>
</s:Envelope>
Fejlhåndtering
Fejl bliver returneret som SOAP-fault med information om fejlen
Sikkerhed
TBD: Roller
Anvendt / udbudt
Operationen er udviklet for DMP og påtænkes anvendt til opdatering af Stancode data.
Servicekvalitet
Afsendt besked vil som regel nå modtageren én gang.
Responstid
Under 120 sekunder.
Kalde-effekt kategori
Operationen kan kaldes efter behov; bemærk dog følgende. Det medfører nogen belastning på
systemet at importere alle Stancode data.
Noter
Ingen.
Use Cases
Der henvises til beskrivelse af udarbejdede user stories for PULS-projektet.
Forretningsobjekter
Følgende Stancode-lister hentes til følgende tabeller:
•
•
•
•
•
•
•
•
Sc1005SampleType => Proevetype
Sc1006SamplingEquipment => Proevetagningsudstyr
Sc1008Parameter => Parameter
Sc1009MeasurementUnit => Maaleenhed
Sc1010MeasurementMethod => Maalemetode
Sc1025Institution => Institution
Sc1030SampleFraction => Proevefraktion
Sc1059Smell => Lugt
B 3.1a PULS Serviceoperationer - Stancode.docx
5
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
Sc1060Colour => Farve
Sc1069TreatmentType => Rensningstype
Sc1070FloatingMaterial => Recipientscreening
Sc1071Appearance => Udseende
Sc1072Structure => Struktur
Sc1073DischargeType => Udledningstype
Sc1074SewerStructure => Kloakbygvaerk
Sc1075CalculationMethod => Beregningsmetode
Sc1076SampleLocationType => Maalestedstype
Sc1077Attribute => Resultatattribut
Sc1078PermissionStatus => Tilladelsesstatus
Sc1079AnalysisLocation => Analysested
Sc1080StorageTemperature => Opbevaringstemperatur
Sc1081InvestigationPurpose => Undersoegelsesformaal
Sc1082ImpactRecipientFromPointSource => Paavirkningsgrad
Sc1083SewerageType => Kloakeringstype
Sc1085TypeOfWasteWaterControl => Kontroltype
Sc1086CompanyType => Virksomhedstype
Sc1087FishFeed => Fiskefoder
Sc1088PlaceForMeasurementsForFlowTimeSeries => Vandfoeringsmaalested
Sc1089Legislation => Lovhjemmel
STD00337 => Referenceliste: 102503 => Kommune
B 3.1a PULS Serviceoperationer - Stancode.docx
6