Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Every major change on a document is recorded as an event (hendelse). For monitoring a portfolio of document, events will give you a good way to handle post processing.

Note that in order to get all statuses for pantedokument sent to broker, you must ugrade to version 6 of Hendelse API.

List events

«listHendelser» should be used in stead of polling for status on each document. Event monitoring is available in beta and production using the webservice HendelseWs (currently in version 6).

How to list events

Both listHendelser and listHendelserMedStatus returns a list of events from the given eventid (fraHendelsesIda given starting point. listHendelserMedStatus will also return the status of the document (same as calling the getStatus method, see documentation). The service takes a list of parameter to limit the result.

Params:

...

offers the following parameters to get the intended events:

Request/input parameters

Parameter

Purpose

Description

fraHendelsesId

eventid to start from

maxAntall

maximum number of events

statuser

limit to certain WsDokumentStatus-types

typer

event types as defined in WsHendelsesType

kunEksterne

True: Only documents created by using the DocumentWS.
False: Only created by using the web client at www.etinglysing.no.
Omitted: Returns both.

Response:

Type

Description

id

event id

type

one of WsHendelsesType

dokumentId

documentid in www.etinglysing.no

eksternEierId

document owner

nyStatus

new status

gammelStatus

old status

beskrivelse

status description in Norwegian

opprettet

event date

eksterntOpprettetDokument

document is created by using DocumentWS

dokumentRef

the

Set the starting point

The eventId of your last received event. Will return only newer events.

fraTidspunkt

Set the starting point

Only retrieve events having created timestamp newer or equal to this.

maxAntall

Limit the number of events

Maximum number of events to return.

statuser

Filter events

Only fetch events for this list of document statuses. See below for example statuses.

typer

Filter events

Only fetch events for these event types. See below for example event types

kilde

Filter events

Some customers use both the webservice and GUI in Etinglysing. kilde allows you to fetch events for documents created through the webservice (INTEGRASJON), the GUI (NETTLESER) or both (ALLE). If omitted, events from both sources will be returned.

Response:

Field

Description

id

EventId

type

Event type (see below for examples)

dokumentId

DocumentId in Etinglysing

eksternEierId

Document owner departmentId

nyStatus

New status

gammelStatus

Old status

beskrivelse

Status description in Norwegian

opprettet

Event created timestamp

eksterntOpprettetDokument

True if document is created by using the DocumentWS webservice.

dokumentRef

The document reference at the event time

oppdragsId

oppdragsid in www.etinglysing.no

List events with status

...

AssignmentId in Etinglysing if document is related to an assignment

Event types

This is a list of current event types. New event types can be added as Etinglysing keeps evolving and implements new features.

  • STATUSOVERGANG,

  • DOKUMENT_OPPRETTET,

  • DOKUMENT_FJERNET,

  • MELDING,

  • SENT_NOTIFICATION,

  • PREREQUISITE_OPPRETTET,

  • PREREQUISITE_SLETTET;

Document statuses

This is a list of current document statuses. New statuses can be added as Etinglysing keeps evolving and implements new features.

  • STATUSOVERGANG

  • DOKUMENT_OPPRETTET

  • DOKUMENT_FJERNET