SOAP Methods: Communication

The following page describes the different methods used for contact information, notifications

Method: GetContactInfo

Gets contact information of the logged in user’s municipality and relevant settings for the logged in user.

Business Rules

• N/A

Input Object

Properties	Type	Note
N/A

Output Object

Properties	Type	Note
Brugernavn	String	Username of the user.
ContactEmails	Array of strings	Array of emails of the bekæmpelsesfirma, R2-bekæmper or municipality that the logged in user belongs to.
ContactSMS	Array of strings	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.
UserType	Enum	Options: - R1 - R2 - Other
Autorisationsnummer	String	A user can be pretagged with a autorisationsnummer. To learn more about autorisationsnummer, please contact https://mab.mst.dk/.
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.
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: SaveContactInfo

The SaveContactInfo method is used to save contact emails, sms and reminder value of a Myndighed or Bekaempelsesfirma

Business Rules

• N/A

Input Object

Properties	Type	Note
ContactEmails	Array of strings	Array of emails of the bekæmpelsesfirma, R2-bekæmper or municipality that the logged in user belongs to.
ContactSMS	Array of strings	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.
Errors	String	All errors occurred on server. One service call could fail for multiple errors.

Method: SearchNotification

The SearchNotification method is used to search Notification objects

Business Rules

• N/A

Input Object

Properties	Type	Note
RotteanmeldelseId	Object Reference	The id that the rotteanmeldelse belongs to. Nullable.
SenderMyndighedId	Object Reference	Id of the municipality who sent the message. Retrieve the possible values using the method: ReadMyndigheder
ReceiverMyndighedId	Object Reference	Id of the municipality to receive the message. Retrieve the possible values using the method: ReadMyndigheder
SenderBekaempelsesfirmaId	Object Reference	Id of the bekæmpelsesfirma or R2-bekæmper who sent the message. Retrieve the possible values using the method: ReadMyndigheder
ReceiverBekaempelsesfirmaId	Object Reference	Id of the bekæmpelsesfirma or R2-bekæmper to receive the message. Retrieve the possible values using the method: ReadMyndigheder
OprettetDatoFrom	Datetime	Get only notifications that were created after this date.
OprettetDatoTo	Datetime	Get only notifications that were created before this date.
ExecuteDatoFrom	Datetime	Notifications are often created before they need to be sent, simply system performance reasons. As a service Provider, you should always get only notifications where ExecuteDatoFrom >= today. Notifications that are to be executed later than today, may be removed by the system, if the prerequisites for their existence disappears based on changes in data.
ExecuteDatoTo	Datetime	Get only notifications that are to be executed before this date.
Messagetype	Enum	There are various types of triggers for notifications. Each of these have a different messagetype, that explains what trigger created them.

Output Object

Properties	Type	Note
Id	Guid	Unique identifier
Address	String	Full address in one field from related Rotteanmeldelse e.g. “Vesterbrogade 24, 1600 København”
SenderMyndighedId	Object Reference	Retrieve the possible values using the method: ReadMyndigheder
ReceiverMyndighedId	Object Reference	Retrieve the possible values using the method: ReadMyndigheder
SenderBekaempelsesfirmaId	Object Reference	Retrieve the possible values using the method: SearchBekaempelsesfirma
ReceiverBekaempelsesfirmaId	Object Reference	Retrieve the possible values using the method: SearchBekaempelsesfirma
Besked	String	The actual message to receiver. Formatted using the template for the message type.
OprettetAfBrugerId	Guid	User who created/updated the Rotteanmeldelse that triggered the notification
ExecuteDate	Datetime	The date the message will be executed
EmailIsExecuted	Bool	Whether an email notification was ever sent to receiver
SMSIsExecuted	Bool	Whether an SMS notification was ever sent to receiver
Messagetype	Enum	There are various types of triggers for notifications. Each of these have a different messagetype, that explains what trigger created them.
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. - Search Criteria Is Null
Errors	String	All errors occurred on server. One service call could fail for multiple errors.

Method: GetCurrentUser

The GetCurrentUser method is used to get personal information of current logged in user

Business Rules

• N/A

Input Object

Properties	Type	Note
N/A

Output Object

Properties	Type	Note
Brugernavn	String	Username
Emails	Strings	Email
Myndighed	Object Reference	Retrieve the possible values using the method: ReadMyndigheder
Bekaempelsesfirma	Object Reference	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 string	Roles of the logged in user from 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	General contact info
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.