This document should be read together 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
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.
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.
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.
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
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.
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.
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 a list of Case objects that can be collected, cf. the specified parameters.
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.
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.
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.
GetCaseList002
Retrieves the case list based on the specified criteria. The content of the case list can be varied by searching in the case name and/or KLE.
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.
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 a list of Case objects that can be collected, cf. the specified parameters.
GetCaseIdList002
Retrieves an array of case identities based on the specified criteria. The array can be varied by searching in case name and/or KLE.
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.
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 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.
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.
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.
Output
This method returns a list of Case objects that can be collected, cf. the specified parameters.
GetCaseById
Retrieves the case based on the provided CaseId. It is a precondition that the user has the proper set access rights.
Parameters
Name
Type
Description of the
Username
String
Username for login and for verification of access-rights, determining whether the case can be collected.
Password
String
Password for the user.
CaseId
Long
ID of the case to be collected.
ExternalSystemType
ExternalSystemType
Indication of which system the data recipient calls the method with.
Output
This method returns an object of type Case.
MarkCaseCollected
Marks the case as collected by the user.
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.
Input
Name
Type
Description of the
Username
String
Username for login and for verification of access-rights, determining whether the case’s marking as collected can be revoked.
Password
String
Password for the user.
CaseId
Long
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.
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 revoked.
Output
This method has no output.
GetDocumentContent
Gets the content of the document to the case.
Input
Name
Type
Description of the
Username
String
User name for login and checking rights in relation to whether the document content can be collected.
Password
String
Password for the user.
DocumentId
Long
ID of document whose content is to be collected.
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.
Input
Name
Type
Description of the
Username
String
Username for login and for verification of access-rights, determining whether the document can be marked as collected.
Password
String
Password for the user.
DocumentId
Long
ID of 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.
Input
Name
Type
Description of the
Username
String
Username for login and for verification of access-rights, determining whether the document’s marking as collected can be revoked.
Password
String
Password for the user.
DocumentId
Long
ID of the 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 document’s marking as collected is revoked.
Output
This method has no output.
MarkEventCollected
Marks the event collected on the case by the user.
Input
Name
Type
Description of the
Username
String
Username for login and for verification of access-rights, determining whether the action can be marked as collected.
Password
String
Password for the user.
EventId
Long
ID 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 has no output.
RevokeEventCollected
Revokes the event collected on the case by the user.
Input
Name
Type
Description of the
Username
String
Username for login and for verification of access-rights, determining whether the action’s marking as collected can be revoked.
Password
String
Password for the user.
EventId
Long
ID of the action 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 action’s marking as collected is revoked.
Output
This method has no output.
MarkPartCollected
Marks the part collected on the case by the user.
Input
Name
Type
Description of the
Username
String
Username for login and for verification of access-rights, determining whether the party can be marked as collected.
Password
String
Password for the user.
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
Revokes the event collected on the case by the user.
Input
Name
Type
Description of the
Username
String
Username for login and for verification of access-rights, determining whether the party’s marking as collected can be revoked.
Password
String
Password for the user.
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
This method has no output.
Change log
List order
The most recent entry is added to the top of the list.
Date
Changes
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.