Skip to content

SOAP Methods: Other (not relevant for Service Providers)

michaelrangstrup edited this page Dec 27, 2023 · 1 revision

The list of methods on the following pages are only for DMP internal use. Third party system providers, who wish to integrate with the Rotter system, will not have access to any of the methods listed on this page.

Method: SetStatusIndberettet

A simple method that updates a [Indberetning] record and sets [Status]=1.

Business Rules

  • This method is called with an Indberetning Id and a string Kommentar

Input Object

Properties Type Note
ID Guid Indberetning that user wants to change
Comment String Comment on the status change

Output Object

Properties Type Note
Success String Indicates if the service is success or failed.
ReasonCode Int The number to identify the error. 0 means success.
ReasonMessage String Descriptive text to explain the code.
ErrorMessage String - General error message
- Unknown Indberetning ID: If {IndberetningID} does not exist in [Indberetning]. [ID_Indberetning]
-Illegal Myndighed Set Status Indberettet: IF user does NOT have the Web Service Right ”SetStatusIndberettetAnyMunicipalityRights” AND [Indberetning].[ID_Myndighed] of the Indberetning being restored is NOT the same as in the users token, THEN user does not have the right to Set status to ’Indberettet’ (=1) for the Indberetning.
- Illegal Status Change Set Status Indberettet: User is only allowed to use the method on [Indberetning] records where Status=0
- Lack Required Fields: If any of the fields as specified in the de-scription table for InputObject Indberetning is missing (see rules in column [I] shown in chapter UpdateIndberetning wrt Input Object), then give an error message as well as list the lacking field(s).
Errors String All errors occurred on server. One service call could fail for multiple errors.

Method: SetStatusGodkendt

A simple method that updates a [Indberetning] record and sets [Status]=2

Business Rules

  • This method is called with an Indberetning Id and a string Kommentar

Input Object

Properties Type Note
ID Guid Indberetning that user wants to change
Comment String Comment on the status change

Output Object

Properties Type Note
Success String Indicates if the service is success or failed.
ReasonCode Int The number to identify the error. 0 means success.
ReasonMessage String Descriptive text to explain the code.
ErrorMessage String - General error message
- Unknown Indberetning ID: If {IndberetningID} does not exist in [Indberetning]. [ID_Indberetning]
- Illegal Status Change Set Status Godkendt: User is only allowed to use the method on [Indberetning] records where Status=1
Errors String All errors occurred on server. One service call could fail for multiple errors.

Method: RejectIndberetning

A simple method that updates a [Indberetning] record and sets [Status]=0.

Business Rules

  • This method is called with an Indberetning Id and a string Kommentar

Input Object

Properties Type Note
ID Guid Indberetning that user wants to reject

Output Object

Properties Type Note
Success String Indicates if the service is success or failed.
ReasonCode Int The number to identify the error. 0 means success.
ReasonMessage String Descriptive text to explain the code.
ErrorMessage String - General error message
- Unknown Indberetning ID: If {IndberetningID} does not exist in [Indberetning]. [ID_Indberetning]
- Illegal Status Change Set Status Afvist: User is only allowed to use the method on [Indberetning] records where Status=1 or 2
Errors String All errors occurred on server. One service call could fail for multiple errors.

Method: UpdateIndberetning

The UpdateIndberetning method will be used to both create and edit Indberetning objects.

Business Rules

  • This method is called with IndberetningUpdate object.
  • If the identifier of the Indberetning business object is set to GUID.EMPTY, then it means that the method will create a new Indbe-retning. If the value is different from GUID.EMPTY, then the method will look to update an existing object. Whenever the method is used, the response will include the IndberetningID as well as ServiceResult. It is expected that applications using the web service will save the Indbe-retningID together with the object so as to later be able to update the object – as well as to ensure that the object was properly updated via the service.
  • There is a special treatment for unknown {Indbe-retning}.{BekaempelsesmiddelLeverandoer}.{BekaempelsesfirmaCVR}, {Indberetning}.{GiftanvendelseBekaempelsesfirma}.{BekaempelsesfirmaCVR} If the CVR is legal (8 digit number and does not exist in [Bekaempelsesfirma] table, then:
    a. Create new [Bekaempelsesfirma] record; Set:
    a.i.[Bekaempelsesfirma].[Navn] = ”Ukendt {0}” where {0} is now() datetime
    a.ii.[CVR]= {BekaempelsesfirmaCVR}
    a.iii.[IsBekaempelsesfirma]=True
    a.iv.[IsGiftLeverandoer]=False
    a.v.[Active]=False
    b.Send email to all useres where [Bruger].[AdminInfoModtager]=True
    b.i.Subject ”Ukendt CVR tilføjet Rottedatabasen”
    b.ii.Text ”Følgende ukendte CVR er tilføjet til Rottedatabasen: {0}” where {0} is the CVR of the new [Bekaempelsesfirma] record

Input Object

Properties Type Note
ID Guid Unique. If it is GUID.EMPTY, a new record is to be created.
Aar Int The year for the Indberetning.
Bekaempelsesudfoerende Int This value decides who handles rat extermination in the municipality. Possible values are:
- “Kommunen”
- “Bekæmpelsesfirma”
- “Begge dele”
BekaempelsesfirmaId Guid Referenced Bekaempelsesfirma if value chosen in Bekaempelsesudfoerende was 2 or 3.
Retrieve the possible values using the method: SearchBekaempelsesfirma
BekaempelsesfirmaCvr String Referenced Bekaempelsesfirma if value chosen in Bekaempelsesudfoerende was 2 or 3.
AnsvarligNavn String The name of the person responsible for the Indberetning.
AnsvarligTelefon String The phone number of the person responsible for the Indberetning.
AnsvarligEmail String The email of the person responsible for the Indberetning.
OrienteringAfBorgere Bool Whether citizens have been informed of the work.
OrienteringBegrundelse String Reason that citizens have NOT been informed.
HandlingsplanRevideret Bool Whether an action plan has been updated for the Myndighed for the Year.
HandlingsplanRevisionsDato Datetime The date the action plan was last updated.
HandlingsplanLink String A link for the action plan.
HandlingsplanOpkraevesGebyr String Information on whether citizens have to pay for the action plan.
KloakBekaempelse String Whether the Myndighed performs Kloakbekaempelse.
KloakUdfoerende Int Possible values:
- 1: Kommunen
- 2: Spildevandsforsyningsselskabet
- 3: Begge dele
KloakBetaler Int Possible values:
- 1: Kommunen
- 2: Spildevandsforsyningsselskabet
- 3: Begge dele
KloakAntalRottespaerer Int Statistical data
KloakAntalElektroniskeFaelder Int Statistical data
Firmakontraktsum Decimal Statistical data
KommunalBekaempelseSum Decimal Statistical data
IndkoebSum Decimal Statistical data
LoenudgifterSum Decimal Statistical data
AntalRottespaerer Int Statistical data
AntalKommunaleInstitutioner Int Statistical data
AntalInstitutionerMedRottespaerer Int Statistical data
AntalSikringsordninger Int Statistical data
AntalPaabudResistensstrategi Int Statistical data
AntalPaabudOplysningerOmGift Int Statistical data
AntalPaabudBygningsgennemgang Int Statistical data
AntalPaabudAndre Int Statistical data
Bemaerkning String Free text field
MyndighedId Guid Retrieve the possible values using the method: ReadMyndigheder
BekaempelsesmiddelLeverandoers BekaempelsesfirmaId: Object Reference Retrieve the possible values using the method: SearchBekaempelsesfirma. Offer only those where IsGiftleverandoer = TRUE.
BekaempelsesfirmaCvr: String Unique and not null or empty; 8 digit string.
GiftAnvendelseBekaempelsesfirmas Maengde: double Amount of poison used
BekaempelsesfirmaId: Guid Retrieve the possible values using the method: SearchBekaempelsesfirma
BekaempelsesfirmaCvr: string Unique and not null or empty; 8 digit string.
GifttypeId: Guid The categorization of the poison. Retrieve the possible values using the method: ReadGifttyper
GiftId: Guid Retrieve the possible values using the method: ReadGift
TilsynspligtigeEjendomme Int Statistical data
RestriktionPrivatfirma Bool Statistical data
RestriktionPrivatErhverv Bool Statistical data
AntalPrivateInstitutioner Int Statistical data
AntalPrivateInstitutionerMedRottespaerer Int Statistical data
AntalRottespaererPaaPrivate Int Statistical data
AntalPrivateNejTilRottespaerer Int Statistical data
AntalPaabudSikringsordning Int Statistical data
AntalPaabudBekaempelse Int Statistical data
GiftAnvendelseKloaks Maengde: double Amount of poison used
Ansvarlig: int Who was responsible for using the poison:
- 1: Kommunen
- 2: Spildevandsforsyningsselskabet
Gift: Metadata Poison used. Retrieve the possible values using the method: ReadGift
Gifttype: Metadata The categorization of the poison. Retrieve the possible values using the method: ReadGifttyper
Gifttype: Metadata The categorization of the poison. Retrieve the possible values using the method: ReadGifttyper

Output Object

Properties Type Note
Success String Indicates if the service is success or failed.
ReasonCode Int The number to identify the error. 0 means success.
ReasonMessage String Descriptive text to explain the code.
ErrorMessage String - General error message
- Unknown Indberetning ID: If {IndberetningID} is not GUID.EMPTY and does not exist in [Indberetning]. [ID_Indberetning]
- Cannot Update Deleted Indberetning: User is trying to update a Indberetning object where [Indberetning].[IsDeleted]=1
- Illegal Myndighed Update (UPDATE CASE): IF user does NOT have the Web Service Right ”UpdateIndberetningAllMunicipalityRights” AND db value for existing [Indberetning].[ID_Myndighed] of the Indberetning db record (not value of InputObject) being updated is NOT the same as in the users token, THEN user does not have the right to update the Indberetning.
- Illegal Myndighed Update (GENERAL CASE): IF user does NOT have the Web Service Right ”UpdateIndberetningAllMunicipalityRights” AND attribute value for {Indberetning}.{MyndighedID} of the Indberetning InputObject (not value of existing database record) is NOT the same as in the users token, THEN user does not have the right to create/update the Indberetning.
- Doublet Aar Myndighed: If {Indberetning}.{Aar} is the same as another [Indberetning].[Aar] on the database (aside from itself of course) AND where this [Indberetning].[IsDeleted] = False, then the user is making a doublet Myndighed/Aar record, which should not be allowed
- Already Indleveret Cannot Be Updated: If [Indberetning].[Status]>0 then it cannot be edited
- Lack Required Fields: If any of the fields as specified in the de-scription table for InputObject Indberetning is missing (see rules in column [R] above), then give an error message as well as list the lacking field(s).
- Illegal Identifiers: Checks that all specified Foreign Keys are legal then give an error message as well as list the problem attribute(s).
Errors String All errors occurred on server. One service call could fail for multiple errors.

Method: SearchIndberetning

The method for SearchIndberetning is both used for search as well as read, since the method returns full Indberetning objects. If needing to just return all information for one Indberetning, you would this use the SearchIndberetning with just the ID of the Indberetning as filter (ensuring you just get this one object returned).

Business Rules

  • This method is called with IndberetningSearch. The search structure will use just those attributes where value is not null. Between all attributes there are ”AND” clauses.
  • If user does NOT have the role SearchIndberetningAllMunicipali-tyRights, then it does not return Indberetning records WHERE (Status>0 AND MunicipalityID != the municipality of the user in context)
  • The result is limited up to 2000 records.

Input Object

Properties Type Note
MyndighedId Guid Retrieve the possible values using the method: ReadMyndigheder
AarFrom Int Any value in this field will mean that only Indberetning from the same year or later will be returned.
AarTo Int Any value in this field will mean that only Indberetning from the same year or earlier will be returned.
Ids Guid[] If this has any value, the method just returns Indberetning objects matching these IDs. Other criteria will be ignored when this criteria is used.
MaxRecords Int The max number of records to be returned from the search. System may have a default if none is set by the System Provider to avoid unnecessary load on the database.

Output Object

Properties Type Note
Id Guid The unique identifier of the object.
Aar Int The year for the Indberetning.
Bekaempelsesudfoerende Int This value decides who handles rat extermination in the municipality. Possible values are:
- “Kommunen”
- “Bekæmpelsesfirma”
- “Begge dele”
Bekaempelsesfirma Metadata Referenced Bekaempelsesfirma if value chosen in Bekaempelsesudfoerende was 2 or 3.
AnsvarligNavn String The name of the person responsible for the Indberetning.
AnsvarligTelefon String The phone number of the person responsible for the Indberetning.
AnsvarligEmail String The email of the person responsible for the Indberetning.
OrienteringAfBorgere Bool Whether citizens have been informed of the work
OrienteringBegrundelse String Reason that citizens have NOT been informed.
HandlingsplanRevideret Bool Whether an action plan has been updated for the Myndighed for the Year.
HandlingsplanRevisionsDato Datetime The date the action plan was last updated
HandlingsplanLink String A link for the action plan.
HandlingsplanOpkraevesGebyr String Information on whether citizens have to pay for the action plan.
KloakBekaempelse String Whether the Myndighed performs Kloakbekaempelse.
KloakUdfoerende Int Possible values:
- 1: Kommunen
- 2: Spildevandsforsyningsselskabet
- 3: Begge dele
KloakBetaler Int Possible values:
- 1: Kommunen
- 2: Spildevandsforsyningsselskabet
- 3: Begge dele
KloakAntalRottespaerer Int Statistical data
KloakAntalElektroniskeFaelder Int Statistical data
Firmakontraktsum Decimal Statistical data
KommunalBekaempelseSum Decimal Statistical data
IndkoebSum Decimal Statistical data
LoenudgifterSum Decimal Statistical data
AntalRottespaerer Int Statistical data
AntalKommunaleInstitutioner Int Statistical data
AntalInstitutionerMedRottespaerer Int Statistical data
AntalSikringsordninger Int Statistical data
AntalPaabudResistensstrategi Int Statistical data
AntalPaabudOplysningerOmGift Int Statistical data
AntalPaabudBygningsgennemgang Int Statistical data
AntalPaabudAndre Int Statistical data
Bemaerkning String Free text field
MyndighedId Guid Retrieve the possible values using the method: ReadMyndigheder
BekaempelsesmiddelLeverandoers List Retrieve the possible values using the method: SearchBekaempelsesfirma (where IsGiftleverandoer=1)
GiftAnvendelseBekaempelsesfirmas Maengde: Double Amount of poison used
BekaempelsesfirmaId: Guid Retrieve the possible values using the method: SearchBekaempelsesfirma
BekaempelsesfirmaCvr: String Unique and not null or empty; 8 digit string.
GifttypeId: Guid The categorization of the poison. Retrieve the possible values using the method: ReadGifttyper
GiftId: Guid Retrieve the possible values using the method: ReadGift
AntalTilsyn Int Auto-calculated value that shows how many Tilsyn objects that are in the same Year and Myndighed as this Indberetning.
AntalRotteanmeldelser Int Auto-calculated value that shows how many Rotteanmeldelse objects that are in the same Year and Myndighed as this Indberetning.
TilsynspligtigeEjendomme Int Statistical data
RestriktionPrivatFirma Bool Statistical data
RestriktionPrivatErhverv Bool Statistical data
AntalPrivateInstitutioner Int Statistical data
AntalPrivateInstitutionerMedRottespaerer Int Statistical data
AntalRottespaererPaaPrivate Int Statistical data
AntalPrivateNejTilRottespaerer Int Statistical data
AntalPaabudSikringsordning Int Statistical data
AntalPaabudBekaempelse Int Statistical data
GiftAnvendelseKloaks Maengde: Double Amount of poison used
Ansvarlig: Int Who was responsible for using the poison:
1: Kommunen
2: Spildevandsforsyningsselskabet
Gift: GiftMetadata Poison used. Retrieve the possible values using the method: ReadGift
Gifttype: Metadata The categorization of the poison. Retrieve the possible values using the method: ReadGifttyper
OprettetAfBruger AuditInformation Information on the user that created this object.
AendretAfBruger AuditInformation Information on the user that last changed this object
StatusAendrings AendretAfBruger: Object Information on the user who changed the status for the related Indberetning object.
Kommentar: String Any comment that was added with this change of status. Typically comments from the person sending in the Indberetning object to the one who needs to approve it.
Status: Integer The status of the object. There are three possible states:
1: Kladde
2: Indberettet
3: Godkendt
Success String Indicates if the service is success or failed.
ReasonCode Int The number to identify the error. 0 means success.
ReasonMessage String Descriptive text to explain the code.
ErrorMessage String General error message
Errors String All errors occurred on server. One service call could fail for multiple errors.

Method: DeleteIndberetning

A simple method that updates a [Indberetning] record and sets [IsDeleted]=True

Business Rules

  • N/A

Input Object

Properties Type Note
Id Guid Unique identifier of the record to be deleted

Output Object

Properties Type Note
Success String Indicates if the service is success or failed.
ReasonCode Int The number to identify the error. 0 means success.
ReasonMessage String Descriptive text to explain the code.
ErrorMessage String - General error message
Errors String All errors occurred on server. One service call could fail for multiple errors.

Method: RestoreIndberetning

Restore a deleted Indberetning

Business Rules

  • N/A

Input Object

Properties Type Note
Id Guid Required

Output Object

Properties Type Note
Success String Indicates if the service is success or failed.
ReasonCode Int The number to identify the error. 0 means success.
ReasonMessage String Descriptive text to explain the code.
ErrorMessage String - General error message
- Unknown Indberetning ID: If {IndberetningID} does not exist in [Indberetning]. [ID_Indberetning]
- Illegal Myndighed Delete: IF user does NOT have the Web Service Right ”DeleteIndberetningAllMunicipalityRights” AND [Ejendom].[ID_Myndighed] of the Indberetning being deleted is NOT the same as in the users token, THEN user does not have the right to update the Indberetning
- Already Indleveret Cannot Be Deleted: If [Indberetning].[Status]>0 then it cannot be deleted
Errors String All errors occurred on server. One service call could fail for multiple errors.

Method: UpdateMinEjendom

The UpdateMinEjendom method will be used to both create and edit Ejendom objects

Business Rules

  • This method is called with MinEjendomUpdate object.
  • If the identifier of the Ejendom business object is set to GUID.EMPTY, then it means that the method will create a new Ejendom. If the value is different from GUID.EMPTY, then the method will look to update an existing object. Whenever the method is used, the response will include the MinEjendomID as well as ServiceResult.

Input Object

Properties Type Note
ID Guid Unique. If it is GUID.EMPTY, a new record is to be created.
Ejendomsnummer Int A property number that can be found via DAWA. Is combined with MunicipalityCode to form a distinct identity.
Vejnavn String The name of the street of the Ejendom. Should be exactly formatted as in DAWA to ensure the system will accept it.
Vejkode String A street code that can be found via DAWA. Is combined with Husnr and Postnr to form a distinct identity.
Husnr String The house number of the Ejendom. Should be exactly formatted as in DAWA to ensure the system will accept it.
Postnr Int The zip code of the Ejendom. Should be exactly formatted as in DAWA to ensure the system will accept it.
Side String Typically used to state more detailed address information like apartment number. In Denmark, often in the format “2. tv.”
Ejendomstype2 Enum Enum for type of “Ejendom” - is a required value but since it is a recently added Property, many older Ejendom objects will be missing this value.
Possible values are:
”Tilsynspligtig ejendom”
”Beboelsesejendom”
”Fødevarevirksomhed”
”Anden industri”
”Kommunal institution m.v.”
”Privat-, statslig- eller regional institution m.v.”
”Andet”
Position X and Y Geospatial position of the Ejendom identified by x and y coordinates.
Koordinatsystem Enum Geospatial position of the Ejendom identified by x and y coordinates. The Coordinate System identifies the system used to interpret the coordinates.
Possible values are:
32632 - UTM 32N (ETRS89)
25832 - Standard (25832)
3857 - Web Marcator
4322 - Lat/lon (DD)
MyndighedId Guid Retrieve the possible values using the method: ReadMyndigheder

Output Object

Properties Type Note
MinEjendomId Guid Id of the newly created Ejendom record
Success String Indicates if the service is success or failed.
ReasonCode Int The number to identify the error. 0 means success.
ReasonMessage String Descriptive text to explain the code.
ErrorMessage String - General error message
- Unknown Mine Ejendom ID: If {MinEjendomID} is not 0 and does not exist in [MinEjendom]. [MinEjendomId]
- Lack Required Fields: If any of the fields as specified in the description table for InputObject MinEjendom is missing, then give an error message as well as list the lacking field(s)
Errors String All errors occurred on server. One service call could fail for multiple errors.

Method: DeleteMinEjendom

A simple method that deletes an [Ejendom] record.

Business Rules

  • N/A

Input Object

Properties Type Note
Id Guid Unique identifier of the record to be deleted

Output Object

Properties Type Note
Success String Indicates if the service is success or failed.
ReasonCode Int The number to identify the error. 0 means success.
ReasonMessage String Descriptive text to explain the code.
ErrorMessage String - General error message
- Unknown Ejendom ID: If {MinEjendomID} does not exist in [MinEjendom]. [Id]
- In Use Cannot Delete: If there are any foreign keys pointing to this Ejendom record from Sikringsordning, Tilsyn or Rotteanmeldelse, then deletion should not be allowed
Errors String All errors occurred on server. One service call could fail for multiple errors.

Method: SearchMinEjendomInAll

The method SearchMinEjendomInAll is used to get a list of MinEjendom with provided filters

Business Rules

  • When Ids is specified all others filter will be ignored
  • The search structure will use just those attributes where value is not null. Between all attributes there are ”AND” clauses.
  • The result is limited up to 1000 records.

Input Object

Properties Type Note
MaxRecords Int The max number of records to be returned from the search. System may have a default if none is set by the System Provider to avoid unnecessary load on the database.
Ids Array of Guids Return a specific set of Objects based on their Ids
MyndighedId Guid Retrieve the possible values using the method: ReadMyndigheder
Ejendomstype2 String Enum for type of “Ejendom” - is a required value but since it is a recently added Property, many older Ejendom objects will be missing this value.
Possible values are:
”Tilsynspligtig ejendom”
”Beboelsesejendom”
”Fødevarevirksomhed”
”Anden industri”
”Kommunal institution m.v.”
”Privat-, statslig- eller regional institution m.v.”
”Andet”
BekaempelsesfirmaCvr String The owner of ”MinEjendom” is always a Bekæmpelsesfirma or R2-bekæmper. This reference to CVR registers which one.
PageInfo PageInfo For support of paging
FreeTextSearch String Search for an address by part of its address, city or municipality name.

Output Object

Properties Type Note
Id Guid Id of the ”MinEjendom” for update. Leave empty if creating a new MinEjendom.
Ejendomsnummer Int Code of the Ejendom as found via DAWA. Service Providers must use DAWA to ensure that the service will validate it correctly.
Vejnavn String The name of the street of the Ejendom. Should be exactly formatted as in DAWA to ensure the system will accept it.
Vejkode String A street code that can be found via DAWA. Is combined with Husnr and Postnr to form a distinct identity.
Husnr String The house number of the Ejendom. Should be exactly formatted as in DAWA to ensure the system will accept it.
Postnr Int The zip code of the Ejendom. Should be exactly formatted as in DAWA to ensure the system will accept it.
Ejendomstype2 String Enum for type of “Ejendom” - is a required value but since it is a recently added Property, many older Ejendom objects will be missing this value.
Possible values are:
”Tilsynspligtig ejendom”
”Beboelsesejendom”
”Fødevarevirksomhed”
”Anden industri”
”Kommunal institution m.v.”
”Privat-, statslig- eller regional institution m.v.”
”Andet”
Side String Typically used to state more detailed address information like apartment number. In Denmark, often in the format “2. tv.”
MyndighedId Metadata Retrieve the possible values using the method: ReadMyndigheder
Position X and Y Geospatial position of the Ejendom identified by x and y coordinates.
Koordinatsystem Enum Geospatial position of the Ejendom identified by x and y coordinates. The Coordinate System identifies the system used to interpret the coordinates.
Possible values are:
32632 - UTM 32N (ETRS89)
25832 - Standard (25832)
3857 - Web Marcator
4322 - Lat/lon (DD)
Zone Metadata Retrieve the possible values using the method: ReadZone
Success String Indicates if the service is success or failed.
ReasonCode Int The number to identify the error. 0 means success.
ReasonMessage String Descriptive text to explain the code.
ErrorMessage String - General error message
- ?
Errors String All errors occurred on server. One service call could fail for multiple errors.

Method: UpdateBekaempelsesfirma

The UpdateBekaempelsesfirma method is used to create or update a Bekaempelsesfirma

Business Rules

  • If the identifier of the Bekaempelsesfirma business object is set to GUID.EMPTY, then it means that the method will create a new Bekaempelsesfirma . If the value is different from GUID.EMPTY, then the method will look to update an existing object. Whenever the method is used, the response will include the BekaempelsesfirmaID as well as ServiceResult. It is expected that applications using the web service will save the BekaempelsesfirmaID together with the object so as to later be able to update the object – as well as to ensure that the object was properly updated via the service.

Input Object

Properties Type Note
ID Guid Unique. If it is GUID.EMPTY, a new record is to be created.
Navn String Unique for the same type of data.
Adresse String Address
Cvr String Unique and not null or empty; 8 digit string.
FirmaLukketDato Datetime Date only of when the company was closed. Null if not closed.
IsBekaempelsesfirma Bool Set to true if the company is a Bekæmpelsesfirma.
IsGiftleverandoer Bool Set to true if you want Bekaempelsesfirma as option in GiftLeverandør selection in Indberetning.
Aktiv Bool Whether the object is active. When not active it cannot be used as chosen reference value for new objects, but it can update existing objects and keeping reference to the value.
IsR2 Bool Set to true if the item can be used by R2-bekæmpere.
ContactEmails String Array of emails of the bekæmpelsesfirma, R2-bekæmper or municipality that the logged in user belongs to.
ContactSMS String SMS Notifications not yet supported, so should not be used for now!
Array of phone numbers of the bekæmpelsesfirma, R2-bekæmper or municipality that the logged in user belongs to.
Opfoelgningsvarsel Int A number (from 0 to 6) specifying the number of days in advance that the user wants to be warned that he needs to do follow up visit on a Rotteanmeldelse.

Output Object

Properties Type Note
Success String Indicates if the service is success or failed.
ReasonCode Int The number to identify the error. 0 means success.
ReasonMessage String Descriptive text to explain the code.
ErrorMessage String - General error message
- Bekaempelsesfirma CVR Is Invalid
- Bekaempelsesfirma Is Not Exist
- Bekaempelsesfirma CVR Is Not Unique
Errors String All errors occurred on server. One service call could fail for multiple errors.

Method: DeleteBekaempelsesfirma

A simple method to delete Bekaempelsesfirma object

Business Rules

  • N/A

Input Object

Properties Type Note
BekaempelsesfirmaId Guid Unique identifier of the record to be deleted. Retrieve the possible values using the method: SearchBekaempelsesfirma

Output Object

Properties Type Note
Success String Indicates if the service is success or failed.
ReasonCode Int The number to identify the error. 0 means success.
ReasonMessage String Descriptive text to explain the code.
ErrorMessage String - General error message
- Bekaempelsesfirma Is Reference By Other Object: when Bekaempelsesfirma is reference by: Rotteanmeldelse, Bruger, BFGift, BekaempelsesfirmaPaabud, BekaempelsesmiddelLeverandoer, GiftAnvendelseBekaempelsesfirma, Indberetning, Sikringsordning
Errors String All errors occurred on server. One service call could fail for multiple errors.

Method: UpdateZoner

This method updates the complete list of [Zone] records in the data-base. It is used for both update, edit and delete actions.

Business Rules

  • This method is called with an array of Zone.
  • When Zone.Id set to 00000000-0000-0000-0000-000000000000, it will mean that a new record is to be created.
  • Zone.Navn must be unique and not null
  • Zone.Index the order in which the object appear in a list and must be unique for each record.
  • Zone.IsDelete is not applicable for this operation.
  • Records that exist in Database - and which can be deleted and do not exist in the input object - will be deleted.

Input Object

Properties Type Note
ID Guid Unique. If it is GUID.EMPTY, a new record is to be created.
Navn String Unique for the same type of data.
Index Int The order in which the object appears in a list. It must be unique for each object of the same type.
Aktiv Bool Whether the object is active. When not active it cannot be used as chosen reference value for new objects, but it can update existing objects and keeping reference to the value.

Output Object

Properties Type Note
Success String Indicates if the service is success or failed.
ReasonCode Int The number to identify the error. 0 means success.
ReasonMessage String Descriptive text to explain the code.
ErrorMessage String - General error message
- Missing ID: Validate that all Id in array of Zone Objects, which are different from GUID.EMPTY, exists in the database.
- Faulty Deletion: Check that all [Zone] records, that exist in database and have relations to [Ejendom], also exist in in the returned array of Zone Objects. If they do not, it means that the web service user has deleted a Zone Object, that must not be deleted.
- Illegal Naming: Check that all Zone Objects have unique names (within the array) and none of the names are more than 255 chars and that none are null or consist of just spaces.
- Illegal Index Numbers: Check that all Zone Objects have unique index numbers (within the array) and that none of the index numbers are null
Errors String All errors occurred on server. One service call could fail for multiple errors.

Method: UpdateGifttyper

This method updates the complete list of [Gifttyper] records in the database. It is used for both update, edit and delete actions.

Business Rules

  • This method is called with an array of Gifttyper.
  • When Gifttyper.Id set to 00000000-0000-0000-0000-000000000000, it will mean that a new record is to be created.
  • Gifttyper.Navn must be unique and not null
  • Gifttyper.Index the order in which the object appear in a list and must be unique for each record.
  • Gifttyper.IsDelete is not applicable for this operation.
  • Gifttyper.CountUsage is not applicable for this operation.
  • Records that exist in Database - and which can be deleted and do not exist in the input object - will be deleted.

Input Object

Properties Type Note
ID Guid Unique. If it is GUID.EMPTY, a new record is to be created.
Navn String Unique for the same type of data.
Index Int The order in which the object appears in a list. It must be unique for each object of the same type.
Aktiv Bool Whether the object is active. When not active it cannot be used as chosen reference value for new objects, but it can update existing objects and keeping reference to the value.

Output Object

Properties Type Note
Success String Indicates if the service is success or failed.
ReasonCode Int The number to identify the error. 0 means success.
ReasonMessage String Descriptive text to explain the code.
ErrorMessage String - General error message
- Missing ID: Validate that all Id in array of Gifttyper Objects, which are different from GUID.EMPTY, exists in the database.
- Faulty Deletion: Check that all [Gifttyper] records, that exist in da-tabase and have relations to [Gift], also exist in in the returned ar-ray of Gifttyper Objects. If they do not, it means that the web service user has deleted a Gifttyper Object, that must not be deleted.
- Illegal Naming: Check that all Gifttyper Objects have unique names (within the array) and none of the names are more than 255 chars and that none are null or consist of just spaces.
- Illegal Index Numbers: Check that all Gifttyper Objects have unique index numbers (within the array) and that none of the in-dex numbers are null.
Errors String All errors occurred on server. One service call could fail for multiple errors.

Method: UpdateBekaempelsesfirmaPaabudstyper

This method updates the complete list of [Bekaempelsesfir-maPaabudstype] records in the database. It is used for both update, edit and delete actions.

Business Rules

  • This method is called with an array of BekaempelsesfirmaPaabudstype.
  • When BekaempelsesfirmaPaabudstype.Id set to 00000000-0000-0000-0000-000000000000, it will mean that a new record is to be created.
  • BekaempelsesfirmaPaabudstype.Navn must be unique and not null
  • BekaempelsesfirmaPaabudstype.Index the order in which the object appear in a list and must be unique for each record.
  • BekaempelsesfirmaPaabudstype.IsDelete is not applicable for this operation.
  • BekaempelsesfirmaPaabudstype.CountUsage is not applicable for this operation.
  • Records that exist in Database - and which can be deleted and do not exist in the input object - will be deleted.

Input Object

Properties Type Note
ID Guid Unique. If it is GUID.EMPTY, a new record is to be created.
Navn String Unique for the same type of data.
Index Int The order in which the object appears in a list. It must be unique for each object of the same type.
Aktiv Bool Whether the object is active. When not active it cannot be used as chosen reference value for new objects, but it can update existing objects and keeping reference to the value.

Output Object

Properties Type Note
Success String Indicates if the service is success or failed.
ReasonCode Int The number to identify the error. 0 means success.
ReasonMessage String Descriptive text to explain the code.
ErrorMessage String General error message
Errors String All errors occurred on server. One service call could fail for multiple errors.

Method: UpdateAarsager

This method updates the complete list of [Aarsager] records in the database. It is used for both update, edit and delete actions.

Business Rules

  • N/A.

Input Object

Properties Type Note
ID Guid Unique. If it is GUID.EMPTY, a new record is to be created.
Navn String Unique for the same type of data.
Index Int The order in which the object appears in a list. It must be unique for each object of the same type.
Aktiv Bool Whether the object is active. When not active it cannot be used as chosen reference value for new objects, but it can update existing objects and keeping reference to the value.
IsR2 Bool Set to true if the item can be used by R2-bekæmpere.

Output Object

Properties Type Note
Success String Indicates if the service is success or failed.
ReasonCode Int The number to identify the error. 0 means success.
ReasonMessage String Descriptive text to explain the code.
ErrorMessage String General error message
Errors String All errors occurred on server. One service call could fail for multiple errors.

Method: UpdatePaabudstyper

This method updates the complete list of [Paabudstyper] records in the database. It is used for both update, edit and delete actions.

Business Rules

  • This method is called with an array of Paabudstyper.
  • When Paabudstyper.Id set to 00000000-0000-0000-0000-000000000000, it will mean that a new record is to be created.
  • Paabudstyper.Navn must be unique and not null
  • Paabudstyper.Index the order in which the object appear in a list and must be unique for each record.
  • Paabudstyper.IsDelete is not applicable for this operation.
  • Paabudstyper.CountUsage is not applicable for this operation.
  • Records that exist in Database - and which can be deleted and do not exist in the input object - will be deleted.

Input Object

Properties Type Note
ID Guid Unique. If it is GUID.EMPTY, a new record is to be created.
Navn String Unique for the same type of data.
Index Int The order in which the object appears in a list. It must be unique for each object of the same type.
Aktiv Bool Whether the object is active. When not active it cannot be used as chosen reference value for new objects, but it can update existing objects and keeping reference to the value.
IsR2 Bool Set to true if the item can be used by R2-bekæmpere.

Output Object

Properties Type Note
Success String Indicates if the service is success or failed.
ReasonCode Int The number to identify the error. 0 means success.
ReasonMessage String Descriptive text to explain the code.
ErrorMessage String - General error message
- Missing ID: Validate that all Id in array of PaabudstyperObjects, which are different from GUID.EMPTY, exists in the database.
- Faulty Deletion: Check that all [Paabudstyper] records, that exist in database and have relations to [Paabud], also exist in in the re-turned array of PaabudstyperObjects. If they do not, it means that the web service user has deleted a PaabudstyperObject, that must not be deleted.
- Illegal Naming: Check that all PaabudstyperObjects have unique names (within the array) and none of the names are more than 255 chars and that none are null or consist of just spaces.
- Illegal Index Numbers: Check that all PaabudstyperObjects have unique index numbers (within the array) and that none of the index numbers are null.
Errors String All errors occurred on server. One service call could fail for multiple errors.

Method: UpdateTilsynsresultater

This method updates the complete list of [Tilsynsresultater] records in the database. It is used for both update, edit and delete actions.

Business Rules

  • This method is called with an array of Tilsynsresultater.
  • When Tilsynsresultater.Id set to 00000000-0000-0000-0000-000000000000, it will mean that a new record is to be created.
  • Tilsynsresultater.Navn must be unique and not null
  • Tilsynsresultater.Index the order in which the object appear in a list and must be unique for each record.
  • Tilsynsresultater.IsDelete is not applicable for this operation.
  • Tilsynsresultater.CountUsage is not applicable for this operation.
  • Records that exist in Database - and which can be deleted and do not exist in the input object - will be deleted.

Input Object

Properties Type Note
ID Guid Unique. If it is GUID.EMPTY, a new record is to be created.
Navn String Unique for the same type of data.
Index Int The order in which the object appears in a list. It must be unique for each object of the same type.
Aktiv Bool Whether the object is active. When not active it cannot be used as chosen reference value for new objects, but it can update existing objects and keeping reference to the value.

Output Object

Properties Type Note
Success String Indicates if the service is success or failed.
ReasonCode Int The number to identify the error. 0 means success.
ReasonMessage String Descriptive text to explain the code.
ErrorMessage String - General error message
- Missing ID: Validate that all Id in array of Tilsynsresultater Ob-jects, which are different from GUID.EMPTY, exists in the database.
- Faulty Deletion: Check that all [Tilsynsresultater] records, that exist in database and have relations to [Tilsyn], also exist in in the returned array of Tilsynsresultater Objects. If they do not, it means that the web service user has deleted a Tilsynsresultater Object, that must not be deleted.
- Illegal Naming: Check that all Tilsynsresultater Objects have unique names (within the array) and none of the names are more than 255 chars and that none are null or consist of just spaces.
- Illegal Index Numbers: Check that all Tilsynsresultater Objects have unique index numbers (within the array) and that none of the index numbers are null.
Errors String All errors occurred on server. One service call could fail for multiple errors.

Method: UpdateBFGift

The UpdateBFGift method will be used to both create and edit BFGift objects.

Business Rules

  • This method is called with BFGiftUpdate object. If the identifier of the BFGift business object is set to GUID.EMPTY, then it means that the method will create a new BFGift. If the value is different from GUID.EMPTY, then the method will look to update an existing object. Whenever the method is used, the response will include the BFGiftID as well as ServiceResult. It is expected that applications using the web service will save the BFGiftID together with the object so as to later be able to update the object – as well as to ensure that the object was properly updated via the service.
  • There is a special treatment for unknown {BFGift}.{BekaempelsesfirmaCVR}
    If the CVR is legal (8 digit number and does not exist in [Bekaempelsesfirma] table, then:
    a.Create new [Bekaempelsesfirma] record; Set:
    i.[Bekaempelsesfirma].[Navn] = ”Ukendt {0}” where {0} is now() datetime
    ii.[CVR]= {BekaempelsesfirmaCVR}
    iii.[IsBekaempelsesfirma]=True
    iv.[IsGiftLeverandoer]=False
    v.[Active]=False
    b.Send email to all useres where [Bruger].[AdminInfoModtager]=True
    vi.Subject ”Ukendt CVR tilføjet Rottedatabasen”
    vii.Text ”Følgende ukendte CVR er tilføjet til Rottedatabasen: {0}” where {0} is the CVR of the new [Bekaempelsesfirma] record

Input Object

Properties Type Note
ID Guid Unique. If it is GUID.EMPTY, a new record is to be created.
Maengde Decimal Amount of poison used
Aar Int Year
MyndighedId Guid Retrieve the possible values using the method: ReadMyndigheder
GiftId Guid Retrieve the possible values using the method: ReadGift
GifttypeId Guid The categorization of the poison. Retrieve the possible values using the method: ReadGifttyper
Bekaempelsesfirmald Guid Retrieve the possible values using the method: ReadBekaempelsesfirma
BekaempelsesfirmaCvr String Unique and not null or empty; 8 digit string.

Output Object

Properties Type Note
Success String Indicates if the service is success or failed.
ReasonCode Int The number to identify the error. 0 means success.
ReasonMessage String Descriptive text to explain the code.
ErrorMessage String - General error message
- Unknown BFGift ID: If {BFGiftID} is not 0 and does not exist in [BFGift]. [ID_BFGift]
- Illegal Bekaempelsesfirma Update (UPDATE CASE): For a user whose CVR is Bekaempelsesfirma. IF user does not have the Web Service Right ”UpdateBFGiftAllCVRRights” AND User’s CVR does not exist in [Bekaempelsesfirma].[CVR] column AND db value for existing [BFGift].[ID_Bekaempelsesfirma] of the BFGift db record (not value of InputObject) being updated is NOT the same as in the users token AND value for {BFGift}.{BekaempelsesfirmaID} of the BFGift InputObject is not the same as in the users token, THEN user does not have the right to update the BFGift record.
- Illegal Bekaempelsesfirma Update (GENERAL CASE): For a user whose CVR is Bekaempelsesfirma. IF user does not have the Web Service Right ”UpdateBFGiftAllCVRRights” AND User’s CVR does not exist in [Bekaempelsesfirma].[CVR] column AND value for {BFGift}.{BekaempelsesfirmaID} of the BFGift InputObject is not the same as in the users token, THEN user does not have the right to update the BFGift record.
- Illegal Myndighed Update (UPDATE CASE): For a user whose CVR is Myndighed. IF user does not have the Web Service Right ”UpdateBFGiftAllCVRRights” AND User’s CVR does not exist in [Myndighed].[MynCVR] column AND db value for existing [BFGift].[ID_Myndighed] of the BFGift db record (not value of In-putObject) being updated is NOT the same as in the users token AND value for {BFGift}.{MyndighedID} of the BFGift InputObject is not the same as in the users token, THEN user does not have the right to update the BFGift record.
- Illegal Myndighed Update (GENERAL CASE): For a user whose CVR is Myndighed. IF user does not have the Web Service Right ”UpdateBFGiftAllCVRRights” AND User’s CVR does not exist in [Myndighed].[MynCVR] column AND value for {BFGift}.{MyndighedID} of the BFGift InputObject is not the same as in the users token, THEN user does not have the right to up-date the BFGift record.
- Year Already Closed Update (GENERAL CASE): If attribute value {BFGift}.{Aar} for the Myndighed of the BFGift being creat-ed/updated (see Myndighed via attribute {BFGift}.{MyndighedID}) is in the same year and myndighed as an Indberetning (see year from column [Indberetning].[Aar] and Myndighed from [Indberetning].[ID_Myndighed]), THEN give an error if the [Status] of the indberetning is equal to 1 (Indberettet) OR 2 (Godkendt).
- Year Already Closed Update (UPDATE CASE): If db value [BFGift].[Aar] for the Myndighed of the BFGift being updated (see Myndighed via [BFGift].[ID_Myndighed]) is in the same year and myndighed as an Indberetning (see year from column [Indberetning].[Aar] and Myndighed from [Indbe-retning].[ID_Myndighed]), THEN give an error if the [Status] of the indberetning is equal to 1 (Indberettet) OR 2 (Godkendt).
- Lack Required Fields: If any of the fields as specified in the de-scription table for InputObject BekaempelsesfirmaPaabud is missing, then give an error message as well as list the lacking field(s).
- Not Owned Sikringsordning: If has association with a Sikringsordning. For a user whose CVR is Bekaempelsesfirma. IF {BFGift.SikringsordningID} is pointing to a [Sikringsordning] record where [Sikringsordning].[ID_Bekaempelsesfirma] != the Bekaempelsesfirma of the user or Sikringsordning.Bekaempelsesfirma = null
- Not Owned Sikringsordning: If has association with a Sikringsordning. For a user whose CVR is Myndighed. IF {BFGift.SikringsordningID} is pointing to a [Sikringsordning]->[Ejendom] record where [Ejendom].[ID_Myndighed] != the Myn-dighed of the user.
- Inconsistency BFGift Sikringsordning: If has association with a Sikringsordning. If {BFGift.MyndighedID} != [Sikringsordning].[Ejendom].[ID_Myndighed] OR {BFGift.BekaempelsesfirmaID} != [Sikringsordning].[ID_Bekaempelsesfirma]
- Use Of Inactive Field (GENERAL CASE): If any option from any of the metadata records are saved to the new BFGift object, where the metadata object is Inactive.
- Use Of Inactive Field (UPDATE CASE): If any option from any of the metadata records are saved to the new BFGift object, where the metadata object is Inactive AND the metadata object was not already chosen before update for the specific BFGift.
Errors String All errors occurred on server. One service call could fail for multiple errors.

Method: SearchBFGift

The method for SearchBFGift is both used for search as well as read, since the method returns full BFGift objects. If needing to just return all information for one BFGift, you would use the SearchBFGift with just the ID of the BFGift as filter (ensuring you just get this one object re-turned)

Business Rules

  • The search structure will use just those attributes where value is not null. Between all attributes there is ”AND” clauses; exception is within the attributes that take arrays of IDs (e.g. BFGiftID) – within each ID in these arrays is ”OR” clauses.
  • IF the user does NOT have the role SearchBFGiftAllCVRRights then ONLY return the {GiftID} records that the user has the right to see. Those that he has the rights to see depends on CVR from his token. If the CVR is from a Myndighed, then the user can get returned all [BFGift] records where [BFGift].[ID_Myndighed] same as user’s CVR claim value. If the CVR is from a Bekaempelsesfirma, then the user can get returned all [BFGift] records where [BFGift].[ID_Bekaempelsesfirma] is the same as user’s CVR claim
  • The result is limited up to 2000 records.

Input Object

Properties Type Note
Ids Guid Return a specific set of Objects based on their Ids
MaxRecords Int The max number of records to be returned from the search. System may have a default if none is set by the System Provider to avoid unnecessary load on the database.
Aar Int A year formatted as YYYY e.g. ‘2019’
MyndighedId Guid Retrieve the possible values using the method: ReadMyndigheder
GiftId Guid Retrieve the possible values using the method: ReadGift

Output Object

Properties Type Note
Id Guid
Maengde Decimal
Aar Int A year formatted as YYYY e.g. ‘2019’
Myndighed Metadata Retrieve the possible values using the method: ReadMyndigheder
Gift Metadata
Gifttype Metadata
Bekaempelsesfirma Metadata
OprettetAfBruger AuditInformation
AendretAfBruger AuditInformation
Success String Indicates if the service is success or failed.
ReasonCode Int The number to identify the error. 0 means success.
ReasonMessage String Descriptive text to explain the code.
ErrorMessage String General error message
Errors String All errors occurred on server. One service call could fail for multiple errors.

Method: DeleteBFGift

A simple method that deletes a [BFGift] record.

Business Rules

  • N/A

Input Object

Properties Type Note
ID Guid Unique identifier of the record to be deleted.

Output Object

Properties Type Note
Success String Indicates if the service is success or failed.
ReasonCode Int The number to identify the error. 0 means success.
ReasonMessage String Descriptive text to explain the code.
ErrorMessage String - General error message
- Unknown Ejendom ID: If {EjendomID} does not exist in [Ejendom]. [ID_Ejendom]
- Illegal Myndighed Delete: For a user whose CVR is Myndighed. IF user does not have the Web Service Right ”UpdateBFGiftAllCVRRights” AND User’s CVR does not exist in [Myndighed].[MynCVR] column AND db value for existing [BFGift].[ID_Myndighed] of the BFGift db record being deleted is NOT the same as in the users token THEN user does not have the right to delete the BFGift record.
- Illegal Bekaempelsesfirma Delete: For a user whose CVR is Bekaempelsesfirma. IF user does not have the Web Service Right ”UpdateBFGiftAllCVRRights” AND User’s CVR does not exist in [Bekaempelsesfirma].[CVR] column AND db value for [BFGift].[ID_Bekaempelsesfirma] of the BFGift db record being deleted is NOT the same as in the users token, THEN user does not have the right to update the BFGift record.
- Year Already Closed Delete: If db value [BFGift].[Aar] for the Myndighed of the BFGift being updated (see Myndighed via [BFGift].
- [ID_Myndighed]) is in the same year and myndighed as an Giftindberetning (see year from column [Indberetning].[Aar] and Myndighed from [Indberetning].[ID_Myndighed]), THEN give an error if the [Status] of the indberetning is equal to 1 (Indberettet) OR 2 (Godkendt)
Errors String All errors occurred on server. One service call could fail for multiple errors.

Method: UpdateGift

This method updates the complete list of [Gift] records in the database. It is used for both update, edit and delete actions.

Business Rules

  • This method is called with an array of Gift.
  • When Gift.Id set to 00000000-0000-0000-0000-000000000000, it will mean that a new record is to be created.
  • Gift.Navn must be unique and not null
  • Gift.Index the order in which the object appear in a list and must be unique for each record.
  • Gift.IsDelete is not applicable for this operation.
  • Gift.CountUsage is not applicable for this operation.
  • Records that exist in Database - and which can be deleted and do not exist in the input object - will be deleted.

Input Object

Properties Type Note
ID Guid Unique. If it is GUID.EMPTY, a new record is to be created.
Navn String Unique for the same type of data and not null or empty.
Index Int The order in which the object appears in a list. It must be unique for each object of the same type.
MinVaerdi Double Nullable. The idea behind this field is to define the minimum value for Maengde that should be allowed for this type of Gift in connection with create/update Rotteanmeldelse object. For now it is although not used for any validations and can be ignored.
MaxVaerdi Double Nullable. The idea behind this field is to define the maximum value for Maengde that should be allowed for this type of Gift in connection with create/update Rotteanmeldelse object. For now it is although not used for any validations and can be ignored.
Aktiv Bool Whether the object is active. When not active it cannot be used as chosen reference value for new objects, but it can update existing objects and keeping reference to the value.
Styrke Int
IsR2 Bool Set to true if the item can be used by R2-bekæmpere.

Output Object

Properties Type Note
Success String Indicates if the service is success or failed.
ReasonCode Int The number to identify the error. 0 means success.
ReasonMessage String Descriptive text to explain the code.
ErrorMessage String - General error message
- Missing ID: Validate that all Id in array of Gift Objects, which are different from GUID.EMPTY, exists in the database.
- Faulty Deletion: Check that all [Gift] records, that exist in data-base and have relations to [GiftanvendelseRotteanmeldelse], also exist in in the returned array of Gift Objects. If they do not, it means that the web service user has deleted a Gift Object, that must not be deleted.
Illegal Naming: Check that all Gift Objects have unique names (within the array) and none of the names are more than 255 chars and that none are null or consist of just spaces.
- Illegal Index Numbers: Check that all Gift Objects have unique in-dex numbers (within the array) and that none of the index numbers are null.
- Illegal min-max values: check if a Gift Object has values of Min-Max; and Max is larger than Min.
Errors String All errors occurred on server. One service call could fail for multiple errors.

Method: UpdateIngenRoegProeveAarsager

This method updates the complete list of [IngenRoegProeveAarsag] records in the database. It is used for both update, edit and delete actions.

Business Rules

  • This method is called with an array of IngenRoegProeveAarsag.
  • When IngenRoegProeveAarsag.Id set to 00000000-0000-0000-0000-000000000000, it will mean that a new record is to be created.
  • IngenRoegProeveAarsag.Navn must be unique and not null
  • IngenRoegProeveAarsag.Index the order in which the object appear in a list and must be unique for each record.
  • IngenRoegProeveAarsag.IsDelete is not applicable for this oper-ation.
  • IngenRoegProeveAarsag.CountUsage is not applicable for this operation.
  • Records that exist in Database - and which can be deleted and do not exist in the input object - will be deleted.

Input Object

Properties Type Note
ID Guid Unique. If it is GUID.EMPTY, a new record is to be created.
Navn String Unique for the same type of data.
Index Int The order in which the object appears in a list. It must be unique for each object of the same type.
Aktiv Bool Whether the object is active. When not active it cannot be used as chosen reference value for new objects, but it can update existing objects and keeping reference to the value.

Output Object

Properties Type Note
Success String Indicates if the service is success or failed.
ReasonCode Int The number to identify the error. 0 means success.
ReasonMessage String Descriptive text to explain the code.
ErrorMessage String - General error message
- Missing ID: Validate that all Id in array of IngenRoegProeveAar-sagObjects, which are different from GUID.EMPTY, exists in the database.
- Faulty Deletion: Check that all [IngenRoegProeveAarsag] rec-ords, that exist in database and have relations to [Rotteanmeldelse], also exist in in the returned array of Ingen-RoegProeveAarsagObjects. If they do not, it means that the web service user has deleted a IngenRoegProeveAarsagObject, that must not be deleted.
- Illegal Naming: Check that all IngenRoegProeveAarsag Objects have unique names (within the array) and none of the names are more than 255 chars and that none are null or consist of just spaces.
- Illegal Index Numbers: Check that all IngenRoegProeveAarsagObjects have unique index numbers (within the array) and that none of the index numbers are null.
Errors String All errors occurred on server. One service call could fail for multiple errors.

Method: UpdateRotterObserveret

This method updates the complete list of [RotterObserveret] records in the database. It is used for both update, edit and delete actions.

Business Rules

  • This method is called with an array of RotterObserveret.
  • When RotterObserveret.Id set to 00000000-0000-0000-0000-000000000000, it will mean that a new record is to be created.
  • RotterObserveret.Navn must be unique and not null
  • RotterObserveret.Index the order in which the object appear in a list and must be unique for each record.
  • RotterObserveret.IsDelete is not applicable for this operation.
  • RotterObserveret.CountUsage is not applicable for this operation.
  • Records that exist in Database - and which can be deleted and do not exist in the input object - will be deleted.

Input Object

Properties Type Note
ID Guid Unique. If it is GUID.EMPTY, a new record is to be created.
Navn Index Unique for the same type of data.
Aktiv Bool Whether the object is active. When not active it cannot be used as chosen reference value for new objects, but it can update existing objects and keeping reference to the value.

Output Object

Properties Type Note
Success String Indicates if the service is success or failed.
ReasonCode Int The number to identify the error. 0 means success.
ReasonMessage String Descriptive text to explain the code.
ErrorMessage String - General error message
- Missing ID: Validate that all Id in array of RotterObserveretObjects, which are different from GUID.EMPTY, exists in the database.
- Faulty Deletion: Check that all [RotterObserveret] records, that exist in database and have relations to [RotterObserveretRotteanmeldelse], also exist in in the returned array of Rot-terObserveretObjects. If they do not, it means that the web service user has deleted a RotterObserveret Object, that must not be deleted.
- Illegal Naming: Check that all RotterObserveret Objects have unique names (within the array) and none of the names are more than 255 chars and that none are null or consist of just spaces.
- Illegal Index Numbers: Check that all RotterObserveret Objects have unique index numbers (within the array) and that none of the index numbers are null.
Errors String All errors occurred on server. One service call could fail for multiple errors.

Method: UpdateEjendomstyper

This method updates the complete list of [Ejendomstype] records in the database. It is used for both update, edit and delete actions.

Business Rules

  • This method is called with an array of Ejendomstype.
  • When Ejendomstype.Id set to 00000000-0000-0000-0000-000000000000, it will mean that a new record is to be created.
  • Ejendomstype.Navn must be unique and not null
  • Ejendomstype.Index the order in which the object appear in a list and must be unique for each record.
  • Ejendomstype.IsDelete is not applicable for this operation.
  • Records that exist in Database - and which can be deleted and do not exist in the input object - will be deleted.

Input Object

Properties Type Note
ID Guid Unique. If it is GUID.EMPTY, a new record is to be created.
Navn String Unique for the same type of data.
Index Int The order in which the object appears in a list. It must be unique for each object of the same type.
Aktiv Bool Whether the object is active. When not active it cannot be used as chosen reference value for new objects, but it can update existing objects and keeping reference to the value.
Branchekode Int
Landbrug Bool

Output Object

Properties Type Note
Success String Indicates if the service is success or failed.
ReasonCode Int The number to identify the error. 0 means success.
ReasonMessage String Descriptive text to explain the code.
ErrorMessage String - General error message
- Missing ID: Validate that all Id in array of Ejendomstype Objects, which are different from GUID.EMPTY, exists in the database.
- Faulty Deletion: Check that all [Ejendomstype] records, that exist in database and have relations to [Ejendom], also exist in in the returned array of Ejendomstype Objects. If they do not, it means that the web service user has deleted a Ejendomstype Object, that must not be deleted.
- Illegal Naming: Check that all Ejendomstype Objects have unique names (within the array) and none of the names are more than 255 chars and that none are null or consist of just spaces.
- Illegal Index Numbers: Check that all Ejendomstype Objects have unique index numbers (within the array) and that none of the index numbers are null.
Errors String All errors occurred on server. One service call could fail for multiple errors.

Method: UpdateDyr

This method updates the complete list of [Dyr] records in the database. It is used for both update, edit and delete actions.

Business Rules

  • This method is called with an array of Dyr.
  • When Dyr.Id set to 00000000-0000-0000-0000-000000000000, it will mean that a new record is to be created.
  • Dyr.Navn must be unique and not null
  • Dyr.Index the order in which the object appear in a list and must be unique for each record.
  • Dyr.IsDelete is not applicable for this operation.
  • Dyr.CountUsage is not applicable for this operation.
  • Records that exist in Database - and which can be deleted and do not exist in the input object - will be deleted.

Input Object

Properties Type Note
ID Guid Unique. If it is GUID.EMPTY, a new record is to be created.
Navn String Unique for the same type of data.
Index Int The order in which the object appears in a list. It must be unique for each object of the same type.
Aktiv Bool Whether the object is active. When not active it cannot be used as chosen reference value for new objects, but it can update existing objects and keeping reference to the value.
CountUsage Int Number of times the option has been used in Rotteanmeldelse
IsR2 Bool Set to true if the item can be used by R2-bekæmpere.

Output Object

Properties Type Note
Success String Indicates if the service is success or failed.
ReasonCode Int The number to identify the error. 0 means success.
ReasonMessage String Descriptive text to explain the code.
ErrorMessage String - General error message
- Missing ID: Validate that all Id in array of DyrObjects, which are different from GUID.EMPTY, exists in the database.
- Faulty Deletion: Check that all [Dyr] records, that exist in data-base and have relations to [Rotteanmeldelse], also exist in in the returned array of DyrObjects. If they do not, it means that the web service user has deleted a DyrObject, that must not be deleted.
- Illegal Naming: Check that all DyrObjects have unique names (within the array) and none of the names are more than 255 chars and that none are null or consist of just spaces.
- Illegal Index Numbers: Check that all DyrObjects have unique index numbers (within the array) and that none of the index numbers are null.
Errors String All errors occurred on server. One service call could fail for multiple errors.

Method: UpdateIngenBekaempelseAarsager

This method updates the complete list of [IngenBekaempelseAarsag] records in the database. It is used for both update, edit and delete actions.

Business Rules

  • This method is called with an array of IngenBekaempelseAarsag.
  • When IngenBekaempelseAarsag.Id set to 00000000-0000-0000-0000-000000000000, it will mean that a new record is to be created.
  • IngenBekaempelseAarsag.Navn must be unique and not null
  • IngenBekaempelseAarsag.Index the order in which the object appear in a list and must be unique for each record.
  • IngenBekaempelseAarsag.IsDelete is not applicable for this operation.
  • IngenBekaempelseAarsag.CountUsage is not applicable for this operation.
  • Records that exist in Database - and which can be deleted and do not exist in the input object - will be deleted.

Input Object

Properties Type Note
ID Guid Unique. If it is GUID.EMPTY, a new record is to be created.
Navn String Unique for the same type of data.
Index Int The order in which the object appears in a list. It must be unique for each object of the same type.
Aktiv Bool Whether the object is active. When not active it cannot be used as chosen reference value for new objects, but it can update existing objects and keeping reference to the value.
IsR2 Bool Set to true if the item can be used by R2-bekæmpere.

Output Object

Properties Type Note
Success String Indicates if the service is success or failed.
ReasonCode Int The number to identify the error. 0 means success.
ReasonMessage String Descriptive text to explain the code.
ErrorMessage String - General error message
- Missing ID: Validate that all Id in array of IngenBekaempelseAar-sagerObjects, which are different from GUID.EMPTY, exists in the database.
- Faulty Deletion: Check that all [IngenBekaempelseAarsager] rec-ords, that exist in database and have relations to [Rotteanmeldelse], also exist in in the returned array of In-genBekaempelseAarsagerObjects. If they do not, it means that the web service user has deleted a IngenBekaempelseAarsagerObject, that must not be deleted.
- Illegal Naming: Check that all IngenBekaempelseAarsager Ob-jects have unique names (within the array) and none of the names are more than 255 chars and that none are null or consist of just spaces.
- Illegal Index Numbers: Check that all IngenBekaempelseAar-sagerObjects have unique index numbers (within the array) and that none of the index numbers are null.
Errors String All errors occurred on server. One service call could fail for multiple errors.

Method: UpdateBekaempelsestyper

This method updates the complete list of [Bekaempelsestyper] records in the database. It is used for both update, edit and delete actions.

Business Rules

  • This method is called with an array of Bekaempelsestyper.
  • When Bekaempelsestyper.Id set to 00000000-0000-0000-0000-000000000000, it will mean that a new record is to be created.
  • Bekaempelsestyper.Navn must be unique and not null
  • Bekaempelsestyper.Index the order in which the object appear in a list and must be unique for each record.
  • Bekaempelsestyper.IsDelete is not applicable for this operation.
  • Bekaempelsestyper.CountUsage is not applicable for this operation.
  • Records that exist in Database - and which can be deleted and do not exist in the input object - will be deleted.

Input Object

Properties Type Note
ID Guid Unique. If it is GUID.EMPTY, a new record is to be created.
Navn String Unique for the same type of data.
Index Int The order in which the object appears in a list. It must be unique for each object of the same type.
Aktiv Bool Whether the object is active. When not active it cannot be used as chosen reference value for new objects, but it can update existing objects and keeping reference to the value.
IsGift Bool Used to identify when the Bekaempelsestype is a type of trap.
IsFaelde Bool Used to identify when the Bekaempelsestype is a type of poison.

Output Object

Properties Type Note
Success String Indicates if the service is success or failed.
ReasonCode Int The number to identify the error. 0 means success.
ReasonMessage String Descriptive text to explain the code.
ErrorMessage String - General error message
- Missing ID: Validate that all Id in array of BekaempelsestyperOb-jects, which are different from GUID.EMPTY, exists in the database.
- Faulty Deletion: Check that all [Bekaempelsestyper] records, that exist in database and have relations to [Bekaempel-sestypeRotteanmeldelse], also exist in in the returned array of BekaempelsestyperObjects. If they do not, it means that the web service user has deleted a BekaempelsestyperObject, that must not be deleted
- Illegal Naming: Check that all Bekaempelsestyper Objects have unique names (within the array) and none of the names are more than 255 chars and that none are null or consist of just spaces.
- Illegal Index Numbers: Check that all Bekaempelsestyper Objects have unique index numbers (within the array) and that none of the index numbers are null.
-
Errors String All errors occurred on server. One service call could fail for multiple errors.

Method: SetBrugerAutorisationsnummer

The SetBrugerAutorisationsnummer method is used to set a provided Authorization Number to a specific User.

Business Rules

  • N/A

Input Object

Properties Type Note
BrugerID Guid User reference
Autorisationsnummer String Autorisationsnummer

Output Object

Properties Type Note
Success String Indicates if the service is success or failed.
ReasonCode Int The number to identify the error. 0 means success.
ReasonMessage String Descriptive text to explain the code.
ErrorMessage String - General error message
- User Is Not Exist
- Authorization Number Is Already Exist
Errors String All errors occurred on server. One service call could fail for multiple errors.

Method: UpdateMyndigheder

This method updates the complete list of [Myndighed] records in the database. It is used for both update, edit and delete actions.

Business Rules

  • This method is called with an array of MyndighedObject.
  • When Myndighed.Id set to 00000000-0000-0000-0000-000000000000, it means a new record is to be created.
  • Myndighed.Navn must be unique and not null
  • Myndighed.Cvr must be unique and not null; format must be 8 number string
  • Myndighed.IsDelete is not applicable for this operation.
  • Records are in db but in input array shall be deleted.

Input Object

Properties Type Note
ID Guid Unique. If it is GUID.EMPTY, a new record is to be created.
Navn String Unique for the same type of data.
Cvr String Unique and not null or empty; 8 digit string.
IsKommune Bool It is only Myndighed of type Kommune on which can be registered Rottebekaempelse, Indberetning, etc. So to make this possible, this value should be set to True.
Aktiv Bool Whether the object is active. When not active it cannot be used as chosen reference value for new objects, but it can update existing objects and keeping reference to the value.
MuniciplaityCode Int
ContactEmails String Array of emails of the bekæmpelsesfirma, R2-bekæmper or municipality that the logged in user belongs to.
ContactSMS String SMS Notifications not yet supported, so should not be used for now!
Array of phone numbers of the bekæmpelsesfirma, R2-bekæmper or municipality that the logged in user belongs to.

Output Object

Properties Type Note
Success String Indicates if the service is success or failed.
ReasonCode Int The number to identify the error. 0 means success.
ReasonMessage String Descriptive text to explain the code.
ErrorMessage String - General error message
- Myndighed Missing ID: Validate that all Id in array of MyndighedObjects, which are different from GUID.EMPTY, exists in the database. It is an error if some exist in array but do not exist in database
- Faulty Deletion: Check that all [Myndighed] records, that exist in database and have relations to [Indberetning], [BekaempelsesfirmaPaabud], [Rotteanmeldelse] OR [Ejendom], also exist in in the returned array of MyndighedObjects. If they do not, it means that the web service user has deleted a MyndighedObject that must not be deleted,
- Illegal Naming: Check that all MyndighedObjects have unique names (within the array) and none of the names are more than 255 chars and that none are null or consist of just spaces.
- Illegal CVR: Check that all MyndighedObjects have unique CVR (within the array) and none of the names are illegally formatted (legal format is 8 number string e.g. (12345678) and that none are null.
Errors String All errors occurred on server. One service call could fail for multiple errors.

Method: UpdateAdminInfoModtager

The purpose of this method is to turn on/off sending emails to a specific user when there is a critical issue happening. If value is currently True, then method will set it to False. If value is currently False, then method will set it to True.

Business Rules

  • N/A

Input Object

Properties Type Note
Brugernavn String

Output Object

Properties Type Note
Id Guid
Brugernavn String
Email String
MyndighedCVR String Unique and not null or empty; 8 digit string.
MyndighedNavn String
MyndighedID Object Reference Retrieve the possible values using the method: ReadMyndigheder
BekaempelsesfirmaCVR String Unique and not null or empty; 8 digit string.
BekaempelsesfirmaNavn String
BekaempelsesfirmaId Guid Retrieve the possible values using the method: SearchBekaempelsesfirma
AdminInfoModtager Bool Whether this user will receive notifications intended for system administrator. Typically information on completed Indberetninger.
Autorisationsnummer String If an autorisationsnummer from MAB was added to the user, then we can get it retrieved. To learn more about autorisationsnummer, please contact https://mab.mst.dk/.
Success String Indicates if the service is success or failed.
ReasonCode Int The number to identify the error. 0 means success.
ReasonMessage String Descriptive text to explain the code.
ErrorMessage String - General error message
- Illegal Brugernavn: The username does not exist
Errors String All errors occurred on server. One service call could fail for multiple errors.

Method: UpdateIndbyggertal

This method updates an array of [Indbyggertal] records in the database that share the same value in [Indbyggertal].[Aar]. It is used for both update, edit and delete actions.

Business Rules

  • This method is called with an Aar and an array of IndbyggertalUpdate.
  • Aar must be in range from 2000 to 2100.
  • Indbyggertal.MyndighedId not null
  • Indbyggertal.Indbyggertal not null and must be in range from 0 to 10000000.
  • Delete all [Indbyggertal] records where Aar = [Indbyggertal].[Aar] then insert new ones.

Input Object

Properties Type Note
MyndighedId Guid Retrieve the possible values using the method: ReadMyndigheder
Indbyggertal Int In range from 0 to 10000000
Aar Int A year formatted as YYYY e.g. ‘2019’

Output Object

Properties Type Note
Success String Indicates if the service is success or failed.
ReasonCode Int The number to identify the error. 0 means success.
ReasonMessage String Descriptive text to explain the code.
ErrorMessage String - General error message
- Faulty Myndighed ID: Validate that all MyndighedId in array of IndbyggertalObjects, exist in [Myndighed].[ID_Myndighed].
- Doublet Myndighed ID: Validate that all MyndighedId in array of IndbyggertalObjects, are unique in the array being imported
- Not Valid Year: Validate that there exists a value in {Aar} that is an integer from 2000 to 2100.
- Not Valid Indbyggertal: Validate that Indbyggertal is an integer from 0 to 10,000,000
Errors String All errors occurred on server. One service call could fail for multiple errors.

Method: ReadIndbyggertal

This method is used to retrieve a complete list of Indbyggertal by a specific year.

Business Rules

  • This method sends a year {Aar} to the server and returns the complete list of [Indbyggertal] records from the database where {Aar}=[Indbyggertal].[Aar].

Input Object

Properties Type Note
Aar Int A year formatted as YYYY e.g. ‘2019’

Output Object

Properties Type Note
Id Guid Unique identifier
MyndighedId Guid Retrieve the possible values using the method: ReadMyndigheder
Indbyggertal Int In range from 0 to 10000000
Success String Indicates if the service is success or failed.
ReasonCode Int The number to identify the error. 0 means success.
ReasonMessage String Descriptive text to explain the code.
ErrorMessage String - General error message
- Not Valid Year: Validate that the year is an integer from 2000 to 2100.
Errors String All errors occurred on server. One service call could fail for multiple errors.

Method: DeleteIndbyggertal

This method deletes all [Indbyggertal] records in the database that have the same Aar as input

Business Rules

  • This method is called with an Aar and deletes all [Indbyggertal] records in the database that have the same Aar as input

Input Object

Properties Type Note
Aar Int

Output Object

Properties Type Note
Success String Indicates if the service is success or failed.
ReasonCode Int The number to identify the error. 0 means success.
ReasonMessage String Descriptive text to explain the code.
ErrorMessage String - General error message
- Not Valid Year: Validate that Aar is an integer from 2000 to 2100.
Errors String All errors occurred on server. One service call could fail for multiple errors.

Method: CheckIndberetningIsDone

The method checks it is possible to change the status of Indberetning object to Indberettet. It used to warn user in advance about the possibility of changing Indberetning’s status to Indberettet.

Business Rules

  • N/A

Input Object

Properties Type Note
ID IndberetningID

Output Object

Properties Type Note
Success String Indicates if the service is success or failed.
ReasonCode Int The number to identify the error. 0 means success.
ReasonMessage String Descriptive text to explain the code.
ErrorMessage String - General error message
- Lacking fields
Errors String All errors occurred on server. One service call could fail for multiple errors.

Method: LookupCvr

The LookupCvr method is used to get related information of input CVR

Business Rules

  • CVR must be a valid number

Input Object

Properties Type Note
Cvrnr Int Unique and not null or empty; 8 digit string.

Output Object

Properties Type Note
Cvrnr Int Unique and not null or empty; 8 digit string.
Navn String Name of the company
Postnr Int The zip code of the Ejendom. Should be exactly formatted as in DAWA to ensure the system will accept it.
Bynavn String City of the company
Kommunenavn String Municipality of the company
Success String Indicates if the service is success or failed.
ReasonCode Int The number to identify the error. 0 means success.
ReasonMessage String Descriptive text to explain the code.
ErrorMessage String - General error message
- CVR is not exist
Errors String All errors occurred on server. One service call could fail for multiple errors.

Method: ReadBruger

The method is used to retrieve users. The method can be called with a specific username and will then return the user with this username. The method can also be called without specifying a username, in which case it will return all users that exist on the database.

Business Rules

  • A brugernavn is a username (a string) that corresponds with a unique username in the underlying Rottedata database. By use of a specific brugernavn the service will retrieve and return user whose username starts with brugernavn. By not specifying any brugernavn, the service will retrieve and return all users.

Input Object

Properties Type Note
Brugernavn String Username

Output Object

Properties Type Note
Id Guid Unique
Brugernavn String Unique and not null or empty
Email String User’s registered email
MyndighedCVR String This value will be null when bekaempelsesfirmaCVR has a value.
MyndighedNavn String This value will be null when bekaempelsesfirmaNavn has a value.
MyndighedID Object Reference This value will be null when bekaempelsesfirmaId has a value. Retrieve the possible values using the method: ReadMyndigheder
BekaempelsesfirmaCVR String This value will be null when MyndighedCVR has a value.
BekaempelsesfirmaNavn String This value will be null when MyndighedNavn has a value.
BekaempelsesfirmaId Guid This value will be null when MyndighedNavn has a value.Retrieve the possible values using the method: SearchBekaempelsesfirma
AdminInfoModtager Bool Whether this user will receive notifications intended for system administrator. Typically information on completed Indberetninger.
Autorisationsnummer String A user can be pretagged with a autorisationsnummer. To learn more about autorisationsnummer, please contact https://mab.mst.dk/.
Success String Indicates if the service is success or failed.
ReasonCode Int The number to identify the error. 0 means success.
ReasonMessage String Descriptive text to explain the code.
ErrorMessage String - General error message
-
Errors String All errors occurred on server. One service call could fail for multiple errors.

Method: GetBy

The GetBy method is used to get one and only specific user using username

Business Rules

  • N/A

Input Object

Properties Type Note
Navn String Username

Output Object

Properties Type Note
Brugernavn String Unique and not null or empty
Email String User’s registered email
MyndighedId Object Reference This value will be null when BekaempelsesfirmaId has a value. Retrieve the possible values using the method: ReadMyndigheder
BekaempelsesfirmaId This value will be null when MyndighedId has a value. Retrieve the possible values using the method: SearchBekaempelsesfirma
AdminInfoModtager Bool Whether this user will receive notifications intended for system administrator. Typically information on completed Indberetninger.
Roles Array of Strings Roles that this user received from the Identity and Access Management system, i.e. the roles in the token.
Autorisationsnummer String If an autorisationsnummer from MAB was added to the user, then we can get it retrieved. To learn more about autorisationsnummer, please contact https://mab.mst.dk/.
ContactInfo Object Contact information of the user
Success String Indicates if the service is success or failed.
ReasonCode Int The number to identify the error. 0 means success.
ReasonMessage String Descriptive text to explain the code.
ErrorMessage String General error message
Errors String All errors occurred on server. One service call could fail for multiple errors.
Clone this wiki locally