Abonnement
Tjenesteeier kan sette opp abonnement for et skjemasett.
Subscription
Subscription inneholder operasjoner relatert til abonnement på tjenester i Altinn.
SubmitSubscription
SubmitSubscription kalles for å lagre abonnement for ett eller flere skjemasett i Altinn. Det er mulig å sende abonnementsdata for mer enn ett oppgavesett i ett kall til SubmitSubscription. Skjemasettet må være definert som en tjeneste i tjenesteutviklingsløsningen og migrert til Altinn før en tjenesteeier kan sette opp abonnement for et skjemasett. Operasjon GetAvailableServices kan kalles for å sjekke om tjenesten for skjemasettet eksisterer i Altinn.
Tabellen under beskriver datakontrakten for operasjonen:
| Input | Beskrivelse |
|---|---|
| externalBatchId | Unik id for forsendelse. Denne defineres og settes av tjenesteeier. Returneres i kvittering. Identifikatoren kan senere benyttes av tjenesteeier for å hente ut kvittering for den gitte forsendelsen |
| SubscriptionDetails | Liste med SubscriptionDetailsBE-objekter som inneholder metadata og abonnement |
| Property | Beskrivelse |
| SubscriptionDetailsBE | |
| SubscriptionList | Liste med abonnement (SubscriptionBE-objekter) |
| SystemUserCode | Kode som unikt representerer kildesystem, f.eks. “ABC-123”. Format: XXX_YYYY. De tre første bokstavene er påkrevd og representerer tjenesteeier. De etter understreken representerer avdeling/system, og er valgfritt hvis det ikke finnes flere avdelinger/systemer innenfor samme tjenesteeier |
| SubscriptionBE | |
| ReporteeId | Fødselsnummer eller organisasjonsnummer som identifiserer hvem dataene gjelder |
| StartDate | Dato for når abonnementet skal aktiviseres (yyyy-MM-dd) |
| ExpirationDate | Dato for når abonnementet opphører (yyyy-MM-dd) |
| NextScheduleDate | Dato for når abonnementet skal instansieres neste gang (yyyy-MM-dd). Første dato settes av tjenesteeier, neste kalkuleres av runtiejobb i Altinn (basert på periodetype) |
| NextDueDate | Dato for når abonnementet/innsendingstjenesten må være fylt ut av bruker i portal/sluttbrukersystem (yyyy-MM-dd). Første dato settes av tjenesteeier, neste kalkuleres av runtiejobb i Altinn (basert på periodetype) |
| VisibleDate | Dato for når abonnementet skal være synlig i portal/for sluttbrukersystemer (yyyy-MM-dd) |
| SubscriptionPeriodType | Angir hvor ofte abonnementet skal instansieres (obligatorisk): Annual - årlig, Semiannual - to ganger årlig, Quarterly - tre ganger årlig, Tertiary - fire ganger årlig, Bimonthly - annenhver måned, Monthly - hver måned, Fortnightly - hver 15. dag, Weekly - hver uke, Daily - hver dag, Once -abonnementet instansieres én gang |
| IdentityFields | Liste (SubscriptionIdentityField-objekt) som inneholder identifiserende felter for det abonnementet. Settes kun hvis abonnementet skal kobles til et gitt preutfylt skjemasett |
| ExternalServiceEditionCode | Utgave av tjenesten det skal opprettes abonnement for |
| ExternalServiceCode | Unik identifikator for tjenesten det skal opprettes abonnement for |
| CaseId | Valgfri referanse til samhandlingstjeneste skjema skal knyttes til |
| SubscriptionIdentityField | |
| FieldValue | Verdi for identifiserende feltet. Må angis hvis abonnement skal kobles til et preutfylt skjemasett. Se avsnitt Identifiserende felter for mer info |
| ReceiptBE | |
| ReceiptId | Unik identifikator kvitteringen i Altinn. Benyttes for eksempel ved senere oppdatering av kvittering |
| ReceiptText | Tekst i kvitteringen |
| ReceiptHistory | Når en kvittering oppdateres så vil den gamle kvitteringsteksten flyttes og legges til øverst i denne historikken |
| LastChanged | Dato og tidspunkt for når kvitteringen sist ble endret (yyyy-MM-ddThh:mm:ss) |
| ReceiptTypeName | Angir hva kvittering gjelder. Mulige verdier: FormTask - Skjemasett, Correspondence - Melding, PINCODE - PIN-koder, Subscription - Abonnement, Outbound - Forsendelse sendt fra Altinn, PreFill - Preutfyllingsdata, Broker - Formidlingstjeneste, RegisterDLS - DLS registerdata, RegisterDSF - DSF registerdata, RegisterER - ER registerdata, RegisterDSFProperty, RegisterDSFStreet, RegisterDSFCountry, RegisterDSFUser, LookUp - Innsynstjeneste |
| ReceiptTemplate | Angir malen (XML) som skal benyttes for kvittering |
| ReceiptStatusCode | Status for forsendelse som kvitteringen gjelder: NotSet (standardverdi som brukes når status ikke er satt – skal ikke kunne mottas som verdi), OK, UnExpectedError, ValidationFailed, Rejected |
| ParentReceiptId | Dersom denne kvitteringen er en av flere kvitteringer for en forsendelse vil ParentReceiptId vise til ReceiptId som gjelder for hele forsendelsen (hovedkvittering) |
| References | Liste med ReferenceBE-objekter for kvitteringen |
| SubReceipts | Liste med tilhørende Receipt-objekter (dersom denne kvitteringen er en hovedkvittering) |
| ReferenceBE | |
| ReferenceValue | Selve referansen (verdien) satt på kvitteringen. Typisk forsendelsesreferansen |
| ReferenceTypeName | Angir type referanse: ExternalShipmentReference - Referansen viser til en referanse satt av sluttbrukersystem for en forsendelse, EndUserSystemReference - Benyttes ikke, SendersReference - Referanse satt av avsender for del av en forsendelse, ParentReference - Referansen viser til et hovedskjema, WorkFlowReference - Arbeidsflytreferanse, BatchReference - Referanse til en forsendelse mottatt i eller sendt fra Altinn, OutboundShipmentReference - Referanse til en forsendelse sendt fra Altinn, ReceiversReference - Mottakers referanse hvis kvitteringen blir oppdatert av mottaker av en forsendelse, OwnerPartyReference - Organisasjonsnummer eller personnummer til eier av kvitteringen, typisk den som har sendt inn en forsendelse. Settes av Altinn og kan ikke endres, PartyReference - Organisasjonsnummer eller personnummer til en part som får rettigheter til å hente og oppdatere kvitteringen. Altinn legger automatisk til mottaker av en forsendelse som en part på kvitteringen, ArchiveReference - Arkivreferanse |