Page History
...
Denne guide har som formål at give et overblik over <><xxx>.
<Denne guide er tilegnet klienter til NSP og specifikt den leverede komponent/service. Denne del skal være tilstrækkelig for en klientleverandør, som skal udvikle aftagersystemer. Heri tilgodeses specielt referencer til andre dokumenter, da en anvender også skal have en bredere forståelse af den anvendte komponent og eventuelle omgivelser.
Det er selvfølgelig også ret væsentligt at template udfyldes udtømmende, herunder i forhold til den logik og de regler, der skal følges for den måde servicen anvendes på, og som servicen selv efterlever>
Beskrivelse
<Formål og beskrivelse af komponenten/servicen>
Links til mere information
<Relevante links til andre dokumenter, herunder i forhold til de data services skal arbejde på, og den model de følger>
<Eventuel link til mere uddybende beskrivelse, intern på NSP og eksternt>
...
Grafisk fremstilling og sammenhængen
<Tegning(er) der letter forståelsen og viser beskrivelser af relevante sammenhængen>
Relevante use-cases
<Angiv use cases såfremt det er relevant>
Læsevejledning og forudsætninger
...
Definitioner og referencer
| Reference | Beskrivelse |
|---|---|
Dokument historik
| Dato | Ansvarlig | Beskrivelse |
|---|---|---|
| dd/mm-yyyy | Initiel version |
Adgang, brug og snitflader
...
| Tilgængelig | <Angiv på hvilke(n) NSP-installation(er) servicen/komponenten er tilgængelig> |
| Endpoint(s) | <Angiv udstillede endpoint(s), og hvad de hedder.> |
| WSDL | <Angiv henvisning til WSDL(er). For ekstern anvendbare services typisk på https://wsdl.nspop.dk/> |
| Beskrivelse af services | <Beskrivelser af service(s) / actions på endpoint(s). I lægmands termer beskrive hvad man kan forvente af de enkelte services.> |
| Namespaces etc | <Angiv eventuelt Namespaces, eksterne typer, ..> |
Snitfladebeskrivelse og
...
brug
<Beskrivelse af Snitfladerne, samt den logik og de regler, der skal følges for den måde servicen anvendes på, og som servicen selv efterlever.>
<snitflade 1>
<Beskrivelse af hver snitflade input/output>
...
| <navn> | ||
|---|---|---|
| Element | Beskrivelse | Påkrævet |
<snitflade 2, osv.
...
, med request/response>
Generelle koder, værdier, etc.
...
<Angiv eventuelle generelle koder, værdier, etc>
Fejlbeskeder
<Beskrivelse af fejlbeskeder, og i hvilke situationer man kan forvente at se disse i.
Noter omkring ting som går på tværs af services. Det kan være fejl som optræder generelt og som man skal være opmærksom på.>
Eksempler på request/response
Eksempler på request og response til de operationer der udstilles. De enkelte elementer er beskrevet under snitfladebeskrivelse. Klient proxier kan genereres udfra WSDL'en.
<eksempel 1 på ..>
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
<eksempel her> |
...
<beskriv Test muligheder, test-systemer og eventuelle testdata>
Eksempel kode og klient
Eksempel kode
<Eksempel kode. Det er meget lettere at lave sin egen implementering, hvis man kan kigge efter en anden ....>
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
<eksempel her, eller reference andet steds> |
Eksempel klient
...
<og evt. hvor det giver mening angiv eventuel eksempel klient, hvor det giver mening>
...
| language | xml |
|---|---|
| collapse | true |
samt hvordan og hvor det eventuelt kan eksekveres>