Automatisk import service V1 REST

Automatisk import service V1
Her beskrives funksjonalitet for Automatisk import service V1. For å sikre bakoverkompatibilitet
for klientene så vil denne versjonen ikke endres.
Tilgang
For å benytte servicen må en bruke HTTP Basic autentication med mottakerid og service­passord.
Mottakere opprettes av KS­SvarUt administrator og service­passordet genereres av person med tilgang
via mottaker (/mottaker/)­siden.
Tjenester
Automatisk import tjeneste tilbyr følgende funksjonalitet:
hentNyeForsendelser
Tjeneste for å hente nye forsendelser som er klar for import.
URL:
/tjenester/svarinn/mottaker/hentNyeForsendelser
Metode
GET
URL
Parameter
­
Notis: Vi henter forsendelser for mottakerid som ble brukt i Basic autentiseringen.
Data
parameter
­
Suksess
respons
Returnerer en JSON­kodet liste av forsendelser som mottakeren har tilgang til. Datoen er
oppgitt som et Unix tidsstempel.
Kode: 200
Innhold:
[{
"id":"AAAAAAA‐AAAA‐AAAA‐AAAA‐AAAAAAAAAAAA",
"tittel":"En tittel",
"date":1412668736853,
"downloadUrl":"https://svarut.ks.no//tjenester/svarinn/forsendelse/BBBBBB
B‐BBBB‐BBBB‐BBBB‐BBBBBBBBBBBB",
"status":"Akseptert",
"metadataFraAvleverendeSystem":{
"sakssekvensnummer":0,
"saksaar":0,
"journalaar":0,
"journalsekvensnummer":0,
"journalpostnummer":0,
"journalposttype":"U",
"journalstatus":null,
"journaldato":null,
"dokumentetsDato":null,
"tittel":null},
"metadataIMottakendeSystem":{
"sakssekvensnummer":0,
"saksaar":0,
"journalaar":0,
"journalsekvensnummer":0,
"journalpostnummer":0,
"journalposttype":null,
"journalstatus":"I",
"journaldato":null,
"dokumentetsDato":"2014‐10‐21T09:30:13.310+02:00",
"tittel":null}
}]
Feilmeldinger
1. Manglende eller ugyldig autoriserings mottakerid/passord
Kode: 401
Innhold: Problem accessing /tjenester/svarinn/mottaker/BBBBBBB‐BBBB‐BBBB‐
BBBB‐BBBBBBBBBBBB/hentNyeForsendelser. Reason: Unauthorized
Eksempel
kall
(Javascript)
Mottakerid: BBBBBBB­BBBB­BBBB­BBBB­BBBBBBBBBBBB
Passord: )qNJfeqknl.aXu5CZFUpf2u&VvK4G0MBVnF.^b8B69OVZth1BS
Javascript funksjonen btoa lager Base64 koding av Mottakerid:Passord
var mottakerid = 'BBBBBBB‐BBBB‐BBBB‐BBBB‐BBBBBBBBBBBB';
var passord = 'AAAAAAAAAAA^AAAAAAAA(BBBBBBBBBBBB.BBBBBBBBB';
$.ajax({
url: '/tjenester/svarinn/mottaker/hentNyeForsendelser',
headers: {'Authorization': 'Basic '+window.btoa(mottakerid+':'+passord)},
success: function(data){}
});
Notater
Normalt løp i forsendelser blir utsatt i 2 timer hvis det er registrert mottaker på
organisasjonsnummeret for forsendelsen. Det vil si at forsendelsen er fryst i statusene
Akseptert, Varslet eller Sendt Digitalt slik at det er mulig å hente/lese forsendelsen før
eventuellt varsling/printing.
hentForsendelsefil
Tjeneste for å hente filen for en gitt forsendelse. Hvis forsendelsen består flere filer er de enten pakket i en
samlet PDF eller en .zip fil.
URL:
/tjenester/svarinn/forsendelse/:Forsendelseid
Metode
GET
URL
Parameter
Obligatorisk:
Data
parameter
­
Suksess
respons
Returnerer forsendelsesfilen
1. Forsendelseid ­ på formatet AAAAAAA­AAAA­AAAA­AAAA­AAAAAAAAAAAA
Kode: 200
Innhold:
%PDF‐1.4
.... Data ....
%iText‐5.5.2
startxref
11089
%%EOF
Feilmeldinger
1. Manglende eller ugyldig autoriserings mottakerid/passord
Kode: 401
Innhold: Problem accessing /tjenester/svarinn/forsendelse/BBBBBBB‐BBBB‐BBBB‐
BBBB‐BBBBBBBBBBBB. Reason: Unauthorized
2. Ugyldig forsendelseid
Kode: 401
Innhold: Problem accessing /tjenester/svarinn/forsendelse/BBBBBBB‐BBBB‐BBBB‐
BBBB‐BBBBBBBBBBBB. Reason: Du har ikke tilgang til å laste ned forsendelsen
Eksempel
kall
(Javascript)
Mottakerid: BBBBBBB­BBBB­BBBB­BBBB­BBBBBBBBBBBB
Passord: AAAAAAAAAAA^AAAAAAAA(BBBBBBBBBBBB.BBBBBBBBB
Javascript funksjonen btoa lager Base64 koding av Mottakerid:Passord
var mottakerid = 'BBBBBBB‐BBBB‐BBBB‐BBBB‐BBBBBBBBBBBB';
var passord = 'AAAAAAAAAAA^AAAAAAAA(BBBBBBBBBBBB.BBBBBBBBB';
var forsendelsesId = 'CCCCCCC‐CCCC‐CCCC‐CCCC‐CCCCCCCCCCCC';
$.ajax({
url: '/tjenester/svarinn/forsendelse/'+forsendelsesId,
headers: {'Authorization': 'Basic '+window.btoa(mottakerid+':'+passord)},
success: function(data){}
});
Notater
­
settForsendelseMottatt
Tjeneste for å kvittere på at en forsendelse er mottatt. Forsendelsesstatus vil bli satt til lest og
forsendelsen vil ikke bli sendt til print gitt at den ikke allerede har blitt sendt.
URL:
/tjenester/svarinn/kvitterMottak/forsendelse/:Forsendelseid
Metode
POST
URL
Parameter
Obligatorisk:
Data
parameter
­
Suksess
respons
Kode: 200
Feilmeldinger
1. Forsendelseid ­ på formatet AAAAAAA­AAAA­AAAA­AAAA­AAAAAAAAAAAA
Innhold: ­
1. Manglende eller ugyldig autoriserings mottakerid/passord
Kode: 401
Innhold: Problem accessing /tjenester/svarinn/forsendelse/BBBBBBB‐BBBB‐BBBB‐
BBBB‐BBBBBBBBBBBB. Reason: Unauthorized
2. Ugyldig forsendelseid
Kode: 401
Innhold: Problem accessing /tjenester/svarinn/forsendelse/BBBBBBB‐BBBB‐BBBB‐
BBBB‐BBBBBBBBBBBB. Reason: Du har ikke tilgang til å laste ned forsendelsen
Eksempel
kall
(Javascript)
Mottakerid: BBBBBBB­BBBB­BBBB­BBBB­BBBBBBBBBBBB
Passord: AAAAAAAAAAA^AAAAAAAA(BBBBBBBBBBBB.BBBBBBBBB
Javascript funksjonen btoa lager Base64 koding av Mottakerid:Passord
var mottakerid = 'BBBBBBB‐BBBB‐BBBB‐BBBB‐BBBBBBBBBBBB';
var passord = 'AAAAAAAAAAA^AAAAAAAA(BBBBBBBBBBBB.BBBBBBBBB';
var forsendelsesId = 'CCCCCCC‐CCCC‐CCCC‐CCCC‐CCCCCCCCCCCC';
$.ajax({
type: 'POST',
url: '/tjenester/svarinn/kvitterMottak/forsendelse/'+forsendelsesId,
headers: {'Authorization': 'Basic '+window.btoa(mottakerid+':'+passord)},
success: function(data){}
});
Notater
­