Reading guide

This document should be read together with “NemJournalisering 2.0 – Object model” and “NemJournalisering 2.0 – Concept clarification”.

For code examples, enumeration results, etc. see “NemJournalisering.WCF.chm”.

with Object Model.

Overall concept

Systems from EG Digital Welfare deliver data in a fixed format to the central data store. The data recipient then has the option of extracting lists of cases and retrieving the individual cases. Extracting lists of cases can be limited by date range, origin system and whether you want to include cases that have already been collected.

When the data recipient retrieves a case, it will be possible to mark the case as collected. It will also be possible to mark the individual parts of a case (e.g. a document) as collected. When all parts of a case are marked as collected (i.e. all documents, parties, actions and the case itself), the case will no longer appear in the case list. The individual parts of the case themselves hold a value for whether the data recipient in question has marked them as collected or not. If the source system later adds one or more new parts to a case (e.g. a document and an action) where the entire case has already been marked as collected, the case will appear in the case list again.

Terminology

Term

Interfaces

The interface is available via WCF service.

All types and objects necessary to handle inputs and outputs are exposed via the service.

Service addresses

Operation	https://integration21.kommuneinformation.dk/DataOutput.svc
RC	https://rc-integration21.kommuneinformation.dk/DataOutput.svc

WSDL Addresses

Operation	https://integration21.kommuneinformation.dk/DataOutput.svc?wsdl
RC	https://rc-integration21.kommuneinformation.dk/DataOutput.svc?wsdl

Table of Contents

maxLevel	2

Description
3rd party	A system that initiates the creation of a case in an EGDW system, possibly by sending unique identification of affiliation to own case. If the system is also to retrieve the created cases, the system will be referred to as both a third party and a data receiver.
Data receiver	A system that retrieves cases, etc. from NemJournalisering.
EGDW system	A system supplied by EG Digital Welfare.
MSMQ	Microsoft Message Queue.
Origin System	The system that has initiated the creation of the system.
Provider (ESDH provider)	Software designed to connect the NemJournalisering client to a given ESDH system.

Interfaces

The interface is available via WCF service.

All types and objects necessary to handle inputs and outputs are exposed via the service.

Service addresses

Production	https://integration21.kommuneinformation.dk/DataOutput.svc
Release Candidate (RC)	https://rc-integration21.kommuneinformation.dk/DataOutput.svc

WSDL Addresses

Production	https://integration21.kommuneinformation.dk/DataOutput.svc?wsdl
Release Candidate (RC)	https://rc-integration21.kommuneinformation.dk/DataOutput.svc?wsdl

Table of Contents

maxLevel	2

Methods

GetCaseList

Retrieves the case list based on the specified criteria. The case list will only contain cases where one or more parts of the case are not marked as collected. The case list will only contain cases that the user used at login has access to.

Expand

title	GetCaseList

Parameters

Name	Type	Description of the
Username	String	Username for login and for verification of access-rights, determining which cases can be collected.
Password	String	Password for the user.
OriginSystemType	OriginSystemType	Indication of which Origin System cases are to be collected from. If this is set to “Unknown”, it can be collected across all originating systems at once.
ExternalSystemType	ExternalSystemType	Indication of which system the data recipient calls the method with.
FromDateTime	DateTime	Minimum date from which cases are to be collected.
ToDateTime	DateTime	Maximum date for which cases are to be collected.
Includecollected	Bool	Determines whether cases should be collected even if the case and all parts of it are marked as collected.

Output

This method returns a list of Case objects that can be collected, cf. the specified parameters.

GetCaseIdList

Retrieves an array of case identities based on the specified criteria. The array will only contain cases where one or more parts of the case are not marked as collected. The array will only contain cases that the user used at login has access to.

Expand

title	GetCaseIdList

Parameters

Name	Type	Description of the
Username	String	Username for login and for verification of access-rights, determining which cases can be collected.
Password	String	Password for the user.
OriginSystemType	OriginSystemType	Indication of which Origin System cases are to be collected from. If this is set to “Unknown”, it can be collected across all originating systems at once.
ExternalSystemType	ExternalSystemType	Indication of which system the data recipient calls the method with.
FromDateTime	DateTime	Minimum date from which cases are to be collected.
ToDateTime	DateTime	Maximum date for which cases are to be collected.
Includecollected	Bool	Determines whether cases should be collected even if the case and all parts of it are marked as collected.

Output

This method returns an array of long, which contains case identities for the cases that can be collected, cf. the specified parameters.

GetCaseList001

Methods

GetCaseList

Retrieves the case list based on the specified criteria. The case list will only contain cases where one or more parts of the case are not marked as collected. The content of the case list will can be varied to only contain cases that the user used at login has access to.

Parameter set-up

where there are no collected documents, parties and actions.

Expand

title	GetCaseList001

Parameters

Name

Type

Description of the

User’s name

Username

String

User name

Username for login and

check

for verification of

rights in relation to

access-rights, determining which cases can be collected.

Passwords:

Password

String

Password for the user

in question

.
OriginSystemType	OriginSystemType	Indication of which

origin system

Origin System cases are to be collected from. If this is set to “Unknown”, it can be collected across all originating systems at once.
ExternalSystemType	ExternalSystemType	Indication of which system the data recipient calls the method with.
FromDateTime	DateTime	Minimum

date from which cases are to be collected.

date from which cases are to be collected.
ToDateTime	DateTime	Maximum date for which cases are to be collected.
WithNewDocuments	Bool	Determines whether the case list should contain cases where there are not collected documents.
WithNewParts	Bool	Determines whether the case list should contain cases where there are no collected parties.
WithNewEvents	Bool	Determines whether the case list should contain cases where there are no collected actions

ToDateTime

DateTime

Maximum date for which cases are to be collected

.
Includecollected	Bool	Determines whether cases should be collected even if the case and all parts of it are marked as collected.

Output

This method returns a

sequence

list of

the

Case

object

objects that

contains the cases that

can be collected, cf. the specified parameters.

GetCaseIdList

GetCaseIdList001

Retrieves an array of case identities based on the specified criteria. The array will only contain cases where one or more parts of the case are not marked as collectedthe specified criteria. The array will can be varied to only contain cases that the user used at login has access to.

Parameter set-up

where there are no collected documents, parties and actions.

Expand

title	GetCaseIdList001

Parameters

Name

Type

Description of the

User’s name

Username

String

User name

Username for login and

check

for verification of

rights in relation to

access-rights, determining which cases can be collected.

Passwords:

Password

String

Password for the user

in question

.
OriginSystemType	OriginSystemType	Indication of which

origin system

Origin System cases are to be collected from. If this is set to “Unknown”, it can be collected across all originating systems at once.
ExternalSystemType	ExternalSystemType	Indication of which system the data recipient calls the method with.
FromDateTime	DateTime	Minimum date from which cases are to be collected.
ToDateTime	DateTime

Minimum date from which cases are to be collected.

ToDateTime

DateTime

Maximum date for which cases are to be collected

	Maximum date for which cases are to be collected.
WithNewDocuments	Bool	Determines whether the case list should contain cases where there are not collected documents.
WithNewParts	Bool	Determines whether the case list should contain cases where there are no collected parties.
WithNewEvents	Bool	Determines whether the case list should contain cases where there are no collected actions.
Includecollected	Bool	Determines whether cases should be collected even if the case and all parts of it are marked as collected.

Output

This method returns an array of long, which contains case identities for the cases that can be collected, cf. the specified parameters.

GetCaseList001

GetCaseList002

Retrieves the case list based on the specified criteria. The content of the case list can be varied to only contain cases where there are no collected documents, parties and actions.

Parameter set-up

by searching in the case name and/or KLE.

Expand

title	GetCaseList002

Parameters

Name

Type

Description of the

User’s name

Username

String

User name

Username for login and

check

for verification of

rights in relation to

access-rights, determining which cases can be collected.

Passwords:

Password

String

Password for the user

in question

.
OriginSystemType	OriginSystemType	Indication of which

origin system

Origin System cases are to be collected from. If this is set to “Unknown”, it can be collected across all originating systems at once.
ExternalSystemType	ExternalSystemType	Indication of which system the data recipient calls the method

with

with.
CaseNameContains	String	Filtering by case name.
KLEStartsWith	String	Filtering on KLE.
FromDateTime	DateTime	Minimum date from which cases are to be collected.
ToDateTime	DateTime	Maximum date for

which cases are to be collected.

WithNewDocuments

Bool

Determines whether the case list should contain cases where there are not collected documents.

WithNewParts

Bool

Determines whether the case list should contain cases where there are no collected parties.

WithNewEvents

Bool

Determines whether the case list should contain cases where there are no collected actions

which cases are to be collected.
Includecollected	Bool	Determines whether

cases should be collected even if the case and all parts of it are

the case list should contain cases that are already marked as collected.

Output

This method returns a

sequence

list of

the

Case

object that contains the cases

objects that can be collected, cf. the specified parameters.

GetCaseIdList002

GetCaseIdList001

Retrieves an array of case identities based on the specified criteria. The array can be varied to only contain cases where there are no collected documents, parties and actions.

Parameter set-up

by searching in case name and/or KLE.

Expand

title	GetCaseIdList002

Parameters

Name

Type

Description of the

User’s name

Username

String

User name

Username for login and

check

for verification of

rights in relation to

access-rights, determining which cases can be collected.

Passwords:

Password

String

Password for the user

in question

.
OriginSystemType	OriginSystemType	Indication of which

origin system

Origin System cases are to be collected from. If this is set to “Unknown”, it can be collected across all originating systems at once.
ExternalSystemType	ExternalSystemType	Indication of which system the data recipient calls the

method with

method with.
CaseNameContains	String	Filtering by case name.
KLEStartsWith	String	Filtering on KLE.
FromDateTime	DateTime	Minimum date from which cases are to be collected.
ToDateTime	DateTime	Maximum

date for which cases are to be collected.

WithNewDocuments

Bool

Determines whether the case list should contain cases where there are not collected documents.

WithNewParts

Bool

Determines whether the case list should contain cases where there are no collected parties.

WithNewEvents

Bool

Determines whether the case list should contain cases where there are no collected actions

date for which cases are to be collected.
Includecollected	Bool	Determines whether

cases should be collected even if the case and all parts of it are

the case list should contain cases that are already marked as collected.

Output

This method returns an array of long, which contains case identities for the cases that can be collected, cf. the specified parameters.

GetCaseList002

GetKMDOperaCaseList

Retrieves the case list based on the specified criteria, where ExternalMetadata.ExternalMetadataOwner is set to KMDOpera. The content of the case list can be varied by searching in the case name and/or KLE.

Parameter set-up

to only contain cases where there are no collected documents, parties and actions.

Expand

title	GetKMDOperaCaseList

Parameters

Name

Type

Description of the

User’s name

Username

String

User name

Username for login and

check

for verification of

rights in relation to

access-rights, determining which cases can be collected.

Passwords:

Password

String

Password for the user

in question

.
OriginSystemType	OriginSystemType	Indication of which

origin system

Origin System cases are to be collected from. If this is set to “Unknown”, it can be collected across all originating systems at once.
ExternalSystemType	ExternalSystemType	Indication of which system the data recipient

calls the method with.

CaseNameContains

String

Filtering by case name.

KLEStartsWith

String

Filtering on KLE

calls the method with.
FromDateTime	DateTime	Minimum date from which cases are to be collected.
ToDateTime	DateTime	Maximum date for which cases are to be collected.
WithNewDocuments	Bool	Determines whether the case list should contain cases where there are not collected documents.

Includecollected

WithNewParts	Bool	Determines whether the case list should contain cases where there are no collected parties.
WithNewEvents	Bool	Determines whether the case list should contain cases

that are already marked as collected

where there are no collected actions.

Output

This method returns a

sequence

list of

the

Case

object

objects that

contains the cases that

can be collected, cf. the specified parameters.

GetCaseById

GetCaseIdList002

Retrieves an array of the case identities based on the specified criteria. The array can be varied by searching in case name and/or KLE.

Parameter set-up

provided CaseId. It is a precondition that the user has the proper set access rights.

Expand

title	GetCaseById

Parameters

Name

Type

Description of the

User’s name

Username

String

User name

Username for login and

check

for verification of

rights in relation to which cases

access-rights, determining whether the case can be collected.

Passwords:

Password

String

Password for the user

in question

.

OriginSystemType

CaseId

OriginSystemType

Long

Indication of which origin system cases are

ID of the case to be collected

from. If this is set to “Unknown”, it can be collected across all originating systems at once

.
ExternalSystemType	ExternalSystemType	Indication of which system the data recipient calls the method with.

CaseNameContains

String

Filtering by case name.

KLEStartsWith

String

Filtering on KLE.

FromDateTime

DateTime

Minimum date from which cases are to be collected.

ToDateTime

DateTime

Maximum date for which cases are to be collected.

Includecollected

Bool

Determines whether the case list should contain cases that are already marked as collected.

Output

This method returns an object of type Case.

MarkCaseCollected

Marks the case as collected by the user.

Expand

title	MarkCaseCollected

Input

Name	Type	Description of the
Username	String	Username for login and for verification of access-rights, determining whether the case can be marked as collected.
Password	String	Password for the user.
CaseId	Long	ID of the case to be marked as collected.
ExternalSystemType	ExternalSystemType	Indication of which system the data recipient calls the method with.
ExternalId	String	Any. ID from the data recipient’s system.
Recursive	Bool	Indication of whether all parts of the case (documents, parties and actions) should also be marked as collected.

Output

This method has no output.

RevokeCaseCollected

Revokes the case collected by the user.

Expand

title	RevokeCaseCollected

Input

Output

This method returns an array of long, which contains case identities for the cases that can be collected, cf. the specified parameters.

GetKMDOperaCaseList

Retrieves the case list based on the specified criteria, where ExternalMetadata.ExternalMetadataOwner is set to KMDOpera. The content of the case list can be varied to only contain cases where there are no collected documents, parties and actions.

Parameter set-up

Name
Type
Description of the

User’s name

Username

String

User name

Username for login and

check

for verification of

rights in relation to which cases can be collected.

access-rights, determining whether the case’s marking as collected can be revoked.

Password

Passwords:

String

Password for the user

in question

.

OriginSystemType

CaseId

OriginSystemType

Long

Indication of which origin system cases are to be collected from. If this is set to “Unknown”, it can be collected across all originating systems at once

ID of the case where the marking as collected is to be revoked.
ExternalSystemType	ExternalSystemType	Indication of which system the data recipient calls the method with.

FromDateTime

Revocation Reason

DateTime

Minimum date from which cases are to be collected.

ToDateTime

DateTime

Maximum date for which cases are to be collected.

WithNewDocuments

Bool

Determines whether the case list should contain cases where there are not collected documents.

WithNewParts

Bool

Determines whether the case list should contain cases where there are no collected parties.

WithNewEvents

Bool

Determines whether the case list should contain cases where there are no collected actions.

String	Can contain a description of why the case’s marking as collected is revoked.
Recursive	Bool	Indication of whether all the case’s shared (documents, parties and actions) markings as collected must also be revoked.

Output

This method has no output.

GetDocumentContent

Gets the content of the document to the case.

Expand

title	GetDocumentContent

Input

Output

This method returns a sequence of the Case object that contains the cases that can be collected, cf. the specified parameters.

GetCaseById

Parameter set-up

Name
Type
Description of the

User’s name

Username

String

User name for login and

check of

checking rights in relation to whether the

case

document content can be collected.

Passwords:

Password

String

Password for the user

in question

.

CaseId

DocumentId

Long

ID of

the case

document whose content is to be collected.

ExternalSystemType

Indication of which system the data recipient calls the method with.

Output

This method returns an array of bytes representing the content of the document.

MarkDocumentCollected

Marks the document collected on the case by the user.

Expand

title	MarkDocumentCollected

Output

This method returns an object of type Case.

MarkCaseCollected

Input

Name

Type

Description of the

User’s name

Username

String

User name

Username for login and

check

for verification of

rights in relation to

access-rights, determining whether the

case

document can be marked as collected.

Passwords:

Password

String

Password for the user

in question

.

CaseId

DocumentId

Long

ID of

the case

document to be marked as collected.
ExternalSystemType	ExternalSystemType	Indication of which system the data recipient calls the method with.
ExternalId	String	Any. ID from the data recipient’s system.

Output

This method has no output.

RevokeDocumentCollected

Revokes the document collected on the case by the user.

Recursive

Bool

Indication of whether all parts of the case (documents, parties and actions) should also be marked as collected.

Output

This method has no output.

RevokeCaseCollected

Expand

title	RevokeDocumentCollected

Input

Name

Type

Description of the

User’s name

Username

String

User name

Username for login and

check

for verification of

rights in relation to

access-rights, determining whether the

case’s

document’s marking as collected can be revoked.

Passwords:

Password

String

Password for the user

in question

.

CaseId

DocumentId

Long

ID of the

case

document where the marking as collected is to be revoked.
ExternalSystemType	ExternalSystemType	Indication of which system the data recipient calls the method with.
Revocation

Reason

String

Can contain a description of why the case’s marking as collected is revoked.

Recursive

Bool

Indication of whether all the case’s shared (documents, parties and actions) markings as collected must also be

Reason

String

Can contain a description of why the document’s marking as collected is revoked.

Output

This method has no output.

GetDocumentContent

MarkEventCollected

Marks the event collected on the case by the user.

Expand

title	MarkEventCollected

Input

Name

Type

Description of the

User’s name

Username

String

User name

Username for login and

checking rights in relation to whether the document content can be

for verification of access-rights, determining whether the action can be marked as collected.

Passwords:

Password

String

Password for the user

in question

.

DocumentId

EventId

Long

ID

of document whose content is to be collected

for action to be marked as collected.
ExternalSystemType	ExternalSystemType	Indication of which system the data recipient calls the method with.
ExternalId	String	Any. ID from the data recipient’s system.

Output

This method

returns an array of bytes representing the content of the document.

has no output.

RevokeEventCollected

Revokes the event collected on the case by the user.

Expand

title	RevokeEventCollected

MarkDocumentCollected

Input

Name

Type

Description of the

User’s name

Username

String

User name

Username for login and

check

for verification of

rights in relation to

access-rights, determining whether the

document

action’s marking as collected can be

marked as collected

revoked.

Passwords:

Password

String

Password for the user

in question

.

DocumentId

EventId

Long

ID of

document

the action where the marking as collected is to be

marked as collected

revoked.
ExternalSystemType	ExternalSystemType	Indication of which system the data recipient calls the method with.

ExternalId

Revocation Reason

String

Any. ID from the data recipient’s system

Can contain a description of why the action’s marking as collected is revoked.

Output

This method has no output.

MarkPartCollected

Marks the part collected on the case by the user.

Expand

title	MarkPartCollected

RevokeDocumentCollected

Input

Name

Type

Description of the

User’s name

Username

String

User name

Username for login and

check

for verification of

rights in relation to whether the document’s marking as collected can be revoked.

access-rights, determining whether the party can be marked as collected.

Password

Passwords:

String

Password for the user

in question

.

DocumentId

PartId

Long

ID

of the document where the marking

for party to be marked as collected

is to be revoked

.
ExternalSystemType	ExternalSystemType	Indication of which system the data recipient calls the method with.

Revocation Reason

ExternalId

String

Can contain a description of why the document’s marking as collected is revoked

Any. ID from the data recipient’s system.

Output

This method has no output.

RevokeEventCollected

Revokes the event collected on the case by the user.

Expand

MarkEventCollected

title	RevokeEventCollected

Input

Name

Type

Description of the

User’s name

Username

String

User name

Username for login and

check

for verification of

rights in relation to

access-rights, determining whether the

action

party’s marking as collected can be

marked as collected

revoked.

Passwords:

Password

String

Password for the user

in question

.

EventId

PartId

Long

ID

for action

of the party where the marking as collected is to be

marked as collected

revoked.
ExternalSystemType	ExternalSystemType	Indication of which system the data recipient calls the method with.

ExternalId

Revocation Reason

String

Any. ID from the data recipient’s system

Can contain a description of why the party’s marking as collected is revoked.

Output

This method has no output.

RevokeEventCollected

Change log

Input

Info

Name

title

Type

Description of the

User’s name

String

User name for login and check of rights in relation to whether the action’s marking as collected can be revoked.

Passwords:

String

Password for the user in question.

EventId

Long

ID of the action where the marking as collected is to be revoked.

ExternalSystemType

Indication of which system the data recipient calls the method with.

Revocation Reason

String

Can contain a description of why the action’s marking as collected is revoked.

Output

This method has no output.

MarkPartCollected

Input

Name	Type	Description of the
User’s name	String	User name for login and check of rights in relation to whether the party can be marked as collected.
Passwords:	String	Password for the user in question.
PartId	Long	ID for party to be marked as collected.
ExternalSystemType	ExternalSystemType	Indication of which system the data recipient calls the method with.
ExternalId	String	Any. ID from the data recipient’s system.

Output

This method has no output.

RevokeEventCollected

Input

Name	Type	Description of the
User’s name	String	User name for login and check of rights in relation to whether the party’s marking as collected can be revoked.
Passwords:	String	Password for the user in question.
PartId	Long	ID of the party where the marking as collected is to be revoked.
ExternalSystemType	ExternalSystemType	Indication of which system the data recipient calls the method with.
Revocation Reason	String	Can contain a description of why the party’s marking as collected is revoked.

Output

List order

The most recent entry is added to the top of the list.

Date	Changes
1st May 2024	Documentation was updated and deployed to a Confluence page. The text was translated from Danish to English.
15th August 2013	The following methods have been added: `GetCaseIdList` `GetCaseIdList001` `GetCaseIdList002`
8th October 2012	Version 2.1 of the interface was released. Method `GetCaseList002` added. This should be considered as an overload for the `GetCaseList` method. Method `GetNFBECaseList` added. This is for internal use in EGKI only.
12th March 2012	The method `GetKMDOperaCaseList` has had the parameter `ExternalSystemType` removed, as this is always KMDOpera.
2nd December 2011	The `GetGroupInformation` method has been implemented. The `GetUserInformation` method has been implemented. `ExternalId` as a parameter has been added to the following methods: `MarkCaseTransferred` `MarkPartTransferred` `MarkDocumentTransferred` `MarkEventTransferred` The following methods have been renamed due to inconsistent naming: `MarkCaseTransferred` has been renamed to `MarkCaseCollected` `MarkDocumentTransferred` has been renamed to `MarkDocumentCollected` `MarkEventTransferred` has renamed to `MarkEventCollected` `MarkPartTransferred` has been renamed to `MarkPartCollected` `RevokeCaseTransferred` has been renamed to `RevokeCaseCollected` `RevokeDocumentTransferred` has been renamed to `RevokeDocumentCollected` `RevokeEventTransferred` has been renamed to `RevokeEventCollected` `RevokePartTransferrede` (which also had a typo) has been renamed to `RevokePartCollected` `RevocationReason` as a parameter has been added to the following methods: `RevokeDocumentCollected` `RevokeEventCollected` `RevokePartCollected`
14th November 2011	The `GetKMDOperaCaseList` method has been added.
27th October 2011	Major version was incorrectly named `1.0`. This has now been corrected to `2.0`. GetCaseList was missing the parameter `IncludeCollected` in the documentation. This has now been added. The method `GetCaseList001` was added. This is to be considered as an overload method to the method `GetCaseList`

This method has no output

.

Page tree

Page History

Versions Compared

Old Version 3

New Version Current

Key

Reading guide

Overall concept

Terminology

Interfaces

Service addresses

WSDL Addresses

Interfaces

Service addresses

WSDL Addresses

Methods

GetCaseList

Parameters

Output

GetCaseIdList

Output

GetCaseList001

GetCaseList

Output

GetCaseIdList001

Parameters

Output

GetCaseList002

Parameters

Output

GetCaseIdList002

GetCaseIdList001

Parameters

Output

GetKMDOperaCaseList

Parameters

Output

GetCaseById

GetCaseIdList002

Parameters

Output

MarkCaseCollected

Input

Output

RevokeCaseCollected

Input

Output

GetKMDOperaCaseList

NameTypeDescription of the

Output

GetDocumentContent

Input

Output

GetCaseById

NameTypeDescription of the

Output

MarkDocumentCollected

Output

Input

Output

RevokeDocumentCollected

Output

RevokeCaseCollected

Input

Output

MarkEventCollected

Input

Output

RevokeEventCollected

Input

Output

MarkPartCollected

Input

Output

RevokeEventCollected

Input

Output

Change log

Output

MarkPartCollected

Name
Type
Description of the

Name
Type
Description of the