Messages

Service for messages.

AssignMessageToMe

Assign message to me.
Assign message to me by specified parameters.

Examples

Sample usage in C# with generated client: 
MessagesClient client = new MessagesClient();

AssignMessageToMeResult result = client.AssignMessageToMe(new AssignMessageToMeRequest
{
    MessageGuid = "412",
    AssignToMe = true
});
Sample soap request: 
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:uuid:e657a351-ae8c-42c5-b083-ebe5dcda5c0b">
   <soapenv:Header/>
   <soapenv:Body>
      <urn:AssignMessageToMe>
         <urn:assignMessageToMeRequest>
            <urn:AssignToMe>true</urn:AssignToMe>
            <urn:MessageGuid>412</urn:MessageGuid>
         </urn:assignMessageToMeRequest>
      </urn:AssignMessageToMe>
   </soapenv:Body>
</soapenv:Envelope>

Input

  • request Mandatory

    Request data
    Object

    AssignMessageToMe

    AssignMessageToMe

    • assignMessageToMeRequest

      Information for message assignment.
      Object

      AssignMessageToMeRequest

      Assign message to me request.

      • AssignToMe Mandatory

        Assign to me.

        bool

      • MessageGuid Mandatory

        Message GUID.

        string

Output

Returns result code 0 if message assignment is successful.
Error codes:
  • 1 : error message from ARC server.
Object

AssignMessageToMeResponse

AssignMessageToMe response

  • AssignMessageToMeResult

    Result of AssignMessageToMe
    Object

    AssignMessageToMeResult

    Assign message to me result.

    • Result

      The result of the request. Indicating success or error.
      Object

      ResultType

      Common result type.

      • ResultCode Mandatory

        The result code 0 means ok, anything else usually indicates a warning or an error. Look at accompanying result text for more details on result.

        int

      • ResultText Mandatory

        Text information of the result. Usually contains a warning or error message when result code is indicating other than success.

        string

GetHandledMessages

Returns list of handled messages.
Returns list of handled messages according to specified parameters.

Examples

Sample usage in C# with generated client: 
MessagesClient client = new MessagesClient();

GetHandledMessagesResult result = client.GetHandledMessages(new GetHandledMessagesRequest
{
    PageLength = 100,
    PageNo = 1,
    MessageFilter = new MessageFilter
    {
        MessageType = MessageType.All,
        AssignedTo = "231",
        CaseStatus = "caseStatus",
        CaseNumber = "412",
        CreditorName = "creditorName",
        CreditorRefs = new CreditorRefs(){"ref1", "ref2", "ref3"},
        DueDate = new DateTime(2019, 01, 02),
        PostedAt = new DateTime(2019, 01, 01),
        FirstInvoiceNumber = "123",
        MainDebtorName = "mainDebtorName",
        MainDebtorSSN = "mainDebtorSSN",
        PostedToType = UserType.All
    },
    Sorting = new MessageSorting
    {
        MessageSortingType = MessageSortingType.DueDate,
        Descending = true
    }
});
Sample soap request: 
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:uuid:e657a351-ae8c-42c5-b083-ebe5dcda5c0b">
   <soapenv:Header/>
   <soapenv:Body>
      <urn:GetHandledMessages>
         <urn:getHandledMessagesRequest>
            <urn:MessageFilter>
               <urn:AssignedTo>231</urn:AssignedTo>
               <urn:CaseNumber>412</urn:CaseNumber>
               <urn:CaseStatus>caseStatus</urn:CaseStatus>
               <urn:CreditorName>creditorName</urn:CreditorName>
               <urn:CreditorRefs>
                  <urn:CreditorRefNo>CreditorRefNo</urn:CreditorRefNo>
               </urn:CreditorRefs>
               <urn:DueDate>2019-06-02</urn:DueDate>
               <urn:FirstInvoiceNumber>123</urn:FirstInvoiceNumber>
               <urn:MainDebtorName>mainDebtorName</urn:MainDebtorName>
               <urn:MainDebtorSSN>mainDebtorSSN</urn:MainDebtorSSN>
               <urn:MessageType>All</urn:MessageType>
               <urn:PostedAt>2019-06-01</urn:PostedAt>
               <urn:PostedToType>All</urn:PostedToType>
            </urn:MessageFilter>
            <urn:PageLength>100</urn:PageLength>
            <urn:PageNo>1</urn:PageNo>
            <urn:Sorting>
               <urn:Descending>true</urn:Descending>
               <urn:MessageSortingType>DueDate</urn:MessageSortingType>
            </urn:Sorting>
         </urn:getHandledMessagesRequest>
      </urn:GetHandledMessages>
   </soapenv:Body>
</soapenv:Envelope>

Input

  • request Mandatory

    Request data
    Object

    GetHandledMessages

    GetHandledMessages.

    • getHandledMessagesRequest

      Information to get hadled messages, pagination and sorting.
      Object

      GetHandledMessagesRequest

      Get handled messages request.

      • MessageFilter

        Message filter, default set to all.
        Object

        MessageFilter

        List message filter type.

        • AssignedTo

          Filter reports by specified assigned to value.

          string

        • CaseNumber

          Filter reports by specified case number.

          string

        • CaseStatus

          Filter reports by specified case status.

          string

        • CreditorName

          Filter reports by specified creditro name.

          string

        • CreditorRefs

          Filter reports by specified creditor reference number.
          Array

          string

        • DueDate

          Filter reports by specified due date.

          DateTime

        • FirstInvoiceNumber

          Filter reports by specified first invoice number.

          string

        • MainDebtorName

          Filter reports by specified main debtor name.

          string

        • MainDebtorSSN

          Filter reports by specified main debtor SSN.

          string

        • MessageType Mandatory

          Filter reports by specified message type.
          Enum

          MessageType

          Message type.

          • All

            All types.

          • Notification

            Notification type.

          • UserQuestion

            User question type.

          • Conversation

            Conversation type.

        • PostedAt

          Filter reports by specified posted at date.

          DateTime

        • PostedByType

          Filter reports by the specified type of user who sent the message
          Enum

          UserType

          User type.

          • None

            User type is undefined.

          • All

            All types.

          • CreditorUser

            Creditor user type.

          • SolicitorUser

            Solicitor user type.

          • CreditorAndSolicitorUser

            Creditor | Solicitor user type.

          • Debtor

            Debtor user type.

          • CreditorUserAndDebtor

            Creditor Debtor user type

          • SolicitorUserAndDebtor

            Solicito Debtor user type

          • CreditorAndSolicitorUserAndDebtor

            Creditor Solicitor Debtor user type

        • PostedToType

          Filter reports by the specified type of user who is assigned
          Enum

          UserType

          User type.

          • None

            User type is undefined.

          • All

            All types.

          • CreditorUser

            Creditor user type.

          • SolicitorUser

            Solicitor user type.

          • CreditorAndSolicitorUser

            Creditor | Solicitor user type.

          • Debtor

            Debtor user type.

          • CreditorUserAndDebtor

            Creditor Debtor user type

          • SolicitorUserAndDebtor

            Solicito Debtor user type

          • CreditorAndSolicitorUserAndDebtor

            Creditor Solicitor Debtor user type

        • UserActionCategory

          Filter messages by specified user action category code.

          string

      • PageLength

        Page lenght, default set to 100.

        int

      • PageNo

        Page number, default set to 1.

        int

      • Sorting

        Message sorting, default set to due date.
        Object

        MessageSorting

        Message sorting.

        • Descending

          Is descending?

          bool

        • MessageSortingType Mandatory

          Message sorting type.
          Enum

          MessageSortingType

          Message sorting type.

          • MessageType

            Message type.

          • FirstInvoiceNumber

            First invoice number.

          • CaseNumber

            Case number.

          • CreditorRefNo

            Credit reference number.

          • CreditorName

            Creditor Name.

          • MainDebtorSSN

            Main debtor SSN.

          • MainDebtorName

            Main debtor name.

          • DueDate

            Due date.

          • AssignedTo

            Assigned to.

          • PostedAt

            Posted at.

          • CaseStatus

            Case status.

          • UserActionCategory

            User action category.

Output

List of unhadled messages filtered by parameters. If filter format is incorrect - error is returned
Error codes:
  • 1 : error message from ARC server.
Object

GetHandledMessagesResponse

GetHandledMessages rsponse.

  • GetHandledMessagesResult

    Result of GetHandledMessages.
    Object

    GetHandledMessagesResult

    Get handled messages result.

    • MessageCount

      Returned messages count, default set to 0.

      int

    • Messages

      List of messages.
      Array
      Object

      Message

      Holds message information.

      • AssignedTo

        Assigned to.

        string

      • AssignedToEmail

        Email of the assignee.

        string

      • AssignedToFullName

        Full name or user code of the assignee.

        string

      • AssignedToType

        Type of the assignee.
        Enum

        UserType

        User type.

        • None

          User type is undefined.

        • All

          All types.

        • CreditorUser

          Creditor user type.

        • SolicitorUser

          Solicitor user type.

        • CreditorAndSolicitorUser

          Creditor | Solicitor user type.

        • Debtor

          Debtor user type.

        • CreditorUserAndDebtor

          Creditor Debtor user type

        • SolicitorUserAndDebtor

          Solicito Debtor user type

        • CreditorAndSolicitorUserAndDebtor

          Creditor Solicitor Debtor user type

      • CaseGuid

        guid of case

        string

      • CaseNumber

        Case number.

        string

      • CaseStatusCode

        status code of case

        string

      • CaseStatusText

        status description of case

        string

      • ConversationGuid

        Conversation GUID.

        string

      • ConversationSubject

        Conversation subject

        string

      • Creditor

        Creditor.

        string

      • CreditorName

        Creditor name.

        string

      • Documents

        documents linked to message
        Array
        Object

        HistoryDocument

        Detailed information about history action document.

        • CaseGuids

          List of unique identifiers of collection cases related to the document.
          Array

          string

        • DebtorGuids

          List of unique identifiers of debtors related to the collection cases of the document.
          Array

          string

        • DocumentDate

          Document creation date.

          DateTime

        • DocumentTypeCode

          Document code (one of predefined types idoc / invoice / gjeldsbrev / verdict / domforlik).

          string

        • FileName

          File name.

          string

        • HistoryGuid

          History action document's unique identifier.

          string

        • Important

          Document importancy flag.

          bool

        • Note

          Free extra information related to the document.

          string

        • UserEmail

          E-mail of the document author.

          string

        • UserFullName

          Full name of the document author.

          string

        • UserType

          Party type of the document author.
          Enum

          UserType

          User type.

          • None

            User type is undefined.

          • All

            All types.

          • CreditorUser

            Creditor user type.

          • SolicitorUser

            Solicitor user type.

          • CreditorAndSolicitorUser

            Creditor | Solicitor user type.

          • Debtor

            Debtor user type.

          • CreditorUserAndDebtor

            Creditor Debtor user type

          • SolicitorUserAndDebtor

            Solicito Debtor user type

          • CreditorAndSolicitorUserAndDebtor

            Creditor Solicitor Debtor user type

      • DueDate

        Due date.

        DateTime

      • FirstInvoiceNumber

        First invoice number.

        string

      • MainDebtorFullName

        Main debtor id full name

        string

      • MainDebtorIdNumber

        Main debtor id number

        string

      • MessageGuid

        Message GUID.

        string

      • MessageReplies

        List of message replies.
        Array
        Object

        FixedMessageReply

        Holds fixed message reply information.

        • FixedMessageReplyType

          Fixed message reply type.
          Enum

          FixedMessageReplyType

          Fixed message reply type.

          • FixedReply

            Fixed reply.

          • ReplyWithNote

            Reply with note.

          • ReplyWithAttachment

            Reply with attachment.

          • ReplyAsConversation

            Reply as conversation.

        • MessageCode

          Message code.

          string

        • MessageText

          Message text.

          string

      • MessageText

        Message text.

        string

      • MessageType

        Message type.
        Enum

        MessageType

        Message type.

        • All

          All types.

        • Notification

          Notification type.

        • UserQuestion

          User question type.

        • Conversation

          Conversation type.

      • PostedAt

        Posted at.

        DateTime

      • PostedByEmail

        contains the posting user’s email is it exists

        string

      • PostedByFullName

        contains the user name or user code of the user posted the message

        string

      • PostedByType

        contains the posting user’s party type
        Enum

        UserType

        User type.

        • None

          User type is undefined.

        • All

          All types.

        • CreditorUser

          Creditor user type.

        • SolicitorUser

          Solicitor user type.

        • CreditorAndSolicitorUser

          Creditor | Solicitor user type.

        • Debtor

          Debtor user type.

        • CreditorUserAndDebtor

          Creditor Debtor user type

        • SolicitorUserAndDebtor

          Solicito Debtor user type

        • CreditorAndSolicitorUserAndDebtor

          Creditor Solicitor Debtor user type

      • ReplyToMessageGuid

        Reply to message GUID.

        string

      • Unhandled

        Is message unhandled?

        bool

      • UserActionCategory

        User action category

        string

      • UserActionCategoryDescription

        User action category description

        string

      • UserQuestionAnswer

        Answer code user selected for question when confirming manual action

        string

      • UserQuestionAnswerDescription

        Description of answer code user selected for question when confirming manual action

        string

    • PageLength

      Page lenght, default set to 100.

      int

    • PageNo

      Page number, default set to 1.

      int

    • Result

      The result of the request. Indicating success or error.
      Object

      ResultType

      Common result type.

      • ResultCode Mandatory

        The result code 0 means ok, anything else usually indicates a warning or an error. Look at accompanying result text for more details on result.

        int

      • ResultText Mandatory

        Text information of the result. Usually contains a warning or error message when result code is indicating other than success.

        string

    • TotalPages

      Pages count, default set to 0.

      int

GetMessagesForCase

Returns list of messages for case.
Returns list of messages for case according to specified parameters.

Examples

Sample usage in C# with generated client: 
MessagesClient client = new MessagesClient();

GetMessagesForCaseResult result = client.GetMessagesForCase(new GetMessagesForCaseRequest
{
    PageLength = 100,
    PageNo = 1,
    CaseLookup = new CaseLookup
    {
        CaseIdentification = CaseIdentificationType.CaseNumber,
        CaseIdentificationValue = "423423"
    },
    MessageFilter = new MessageFilter
    {
        MessageType = MessageType.All,
        AssignedTo = "231",
        CaseStatus = "caseStatus",
        CaseNumber = "412",
        CreditorName = "creditorName",
        CreditorRefs = new CreditorRefs(){"ref1", "ref2", "ref3"},
        DueDate = new DateTime(2019, 01, 02),
        PostedAt = new DateTime(2019, 01, 01),
        FirstInvoiceNumber = "123",
        MainDebtorName = "mainDebtorName",
        MainDebtorSSN = "mainDebtorSSN",
        PostedToType = UserType.All
    },
    Sorting = new MessageSorting
    {
        MessageSortingType = MessageSortingType.DueDate,
        Descending = true
    }
});
Sample soap request: 
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:uuid:e657a351-ae8c-42c5-b083-ebe5dcda5c0b">
   <soapenv:Header/>
   <soapenv:Body>
      <urn:GetMessagesForCase>
         <urn:getMessagesForCaseRequest>
            <urn:CaseLookup>
               <urn:CaseIdentification>CaseNumber</urn:CaseIdentification>
               <urn:CaseIdentificationValue>423423</urn:CaseIdentificationValue>
            </urn:CaseLookup>
            <urn:MessageFilter>
               <urn:AssignedTo>231</urn:AssignedTo>
               <urn:CaseNumber>412</urn:CaseNumber>
               <urn:CaseStatus>caseStatus</urn:CaseStatus>
               <urn:CreditorName>creditorName</urn:CreditorName>
               <urn:CreditorRefs>
                  <urn:CreditorRefNo>CreditorRefNo</urn:CreditorRefNo>
               </urn:CreditorRefs>
               <urn:DueDate>2019-06-02</urn:DueDate>
               <urn:FirstInvoiceNumber>123</urn:FirstInvoiceNumber>
               <urn:MainDebtorName>mainDebtorName</urn:MainDebtorName>
               <urn:MainDebtorSSN>mainDebtorSSN</urn:MainDebtorSSN>
               <urn:MessageType>All</urn:MessageType>
               <urn:PostedAt>2019-06-01</urn:PostedAt>
               <urn:PostedToType>All</urn:PostedToType>
            </urn:MessageFilter>
            <urn:PageLength>100</urn:PageLength>
            <urn:PageNo>1</urn:PageNo>
            <urn:Sorting>
               <urn:Descending>true</urn:Descending>
               <urn:MessageSortingType>DueDate</urn:MessageSortingType>
            </urn:Sorting>
         </urn:getMessagesForCaseRequest>
      </urn:GetMessagesForCase>
   </soapenv:Body>
</soapenv:Envelope>

Input

  • request Mandatory

    Request data
    Object

    GetMessagesForCase

    GetMessagesForCase.

    • getMessagesForCaseRequest

      Information to get messages for case, pagination and sorting.
      Object

      GetMessagesForCaseRequest

      Get messages for case request.

      • CaseLookup Mandatory

        Information to lookup collection case(s).
        Object

        CaseLookup

        The way to find a collection case in DB by several predefined criteria.

        • CaseIdentification Mandatory

          Collection case identification type.
          Enum

          CaseIdentificationType

          Collection case identification type.

          • CaseGuid

            Case GUID identification.

          • CaseNumber

            Case number.

          • AccountReferenceNumber

            Account reference number provided by the client.

          • InvoiceNumber

            Invoice number of one on the debts provided by the client.

          • PaymentReferenceNumber

            Payment reference number (OCR).

          • CustomerNo

            Customer number for the debtor at the creditor side.

        • CaseIdentificationValue Mandatory

          Identification value corresponding to identification type.

          string

      • MessageFilter

        Message filter, default set to all.
        Object

        MessageFilter

        List message filter type.

        • AssignedTo

          Filter reports by specified assigned to value.

          string

        • CaseNumber

          Filter reports by specified case number.

          string

        • CaseStatus

          Filter reports by specified case status.

          string

        • CreditorName

          Filter reports by specified creditro name.

          string

        • CreditorRefs

          Filter reports by specified creditor reference number.
          Array

          string

        • DueDate

          Filter reports by specified due date.

          DateTime

        • FirstInvoiceNumber

          Filter reports by specified first invoice number.

          string

        • MainDebtorName

          Filter reports by specified main debtor name.

          string

        • MainDebtorSSN

          Filter reports by specified main debtor SSN.

          string

        • MessageType Mandatory

          Filter reports by specified message type.
          Enum

          MessageType

          Message type.

          • All

            All types.

          • Notification

            Notification type.

          • UserQuestion

            User question type.

          • Conversation

            Conversation type.

        • PostedAt

          Filter reports by specified posted at date.

          DateTime

        • PostedByType

          Filter reports by the specified type of user who sent the message
          Enum

          UserType

          User type.

          • None

            User type is undefined.

          • All

            All types.

          • CreditorUser

            Creditor user type.

          • SolicitorUser

            Solicitor user type.

          • CreditorAndSolicitorUser

            Creditor | Solicitor user type.

          • Debtor

            Debtor user type.

          • CreditorUserAndDebtor

            Creditor Debtor user type

          • SolicitorUserAndDebtor

            Solicito Debtor user type

          • CreditorAndSolicitorUserAndDebtor

            Creditor Solicitor Debtor user type

        • PostedToType

          Filter reports by the specified type of user who is assigned
          Enum

          UserType

          User type.

          • None

            User type is undefined.

          • All

            All types.

          • CreditorUser

            Creditor user type.

          • SolicitorUser

            Solicitor user type.

          • CreditorAndSolicitorUser

            Creditor | Solicitor user type.

          • Debtor

            Debtor user type.

          • CreditorUserAndDebtor

            Creditor Debtor user type

          • SolicitorUserAndDebtor

            Solicito Debtor user type

          • CreditorAndSolicitorUserAndDebtor

            Creditor Solicitor Debtor user type

        • UserActionCategory

          Filter messages by specified user action category code.

          string

      • PageLength

        Page lenght, default set to 100.

        int

      • PageNo

        Page number, default set to 1.

        int

      • Sorting

        Message sorting, default set to due date.
        Object

        MessageSorting

        Message sorting.

        • Descending

          Is descending?

          bool

        • MessageSortingType Mandatory

          Message sorting type.
          Enum

          MessageSortingType

          Message sorting type.

          • MessageType

            Message type.

          • FirstInvoiceNumber

            First invoice number.

          • CaseNumber

            Case number.

          • CreditorRefNo

            Credit reference number.

          • CreditorName

            Creditor Name.

          • MainDebtorSSN

            Main debtor SSN.

          • MainDebtorName

            Main debtor name.

          • DueDate

            Due date.

          • AssignedTo

            Assigned to.

          • PostedAt

            Posted at.

          • CaseStatus

            Case status.

          • UserActionCategory

            User action category.

Output

List of messages for case filtered by parameters. If filter format is incorrect - error is returned
Error codes:
  • 1 : error message from ARC server.
Object

GetMessagesForCaseResponse

GetMessagesForCase response.

  • GetMessagesForCaseResult

    Result of GetMessagesForCase.
    Object

    GetMessagesForCaseResult

    Get messages for case result.

    • MessageCount

      Returned messages count, default set to 0.

      int

    • Messages

      List of messages.
      Array
      Object

      Message

      Holds message information.

      • AssignedTo

        Assigned to.

        string

      • AssignedToEmail

        Email of the assignee.

        string

      • AssignedToFullName

        Full name or user code of the assignee.

        string

      • AssignedToType

        Type of the assignee.
        Enum

        UserType

        User type.

        • None

          User type is undefined.

        • All

          All types.

        • CreditorUser

          Creditor user type.

        • SolicitorUser

          Solicitor user type.

        • CreditorAndSolicitorUser

          Creditor | Solicitor user type.

        • Debtor

          Debtor user type.

        • CreditorUserAndDebtor

          Creditor Debtor user type

        • SolicitorUserAndDebtor

          Solicito Debtor user type

        • CreditorAndSolicitorUserAndDebtor

          Creditor Solicitor Debtor user type

      • CaseGuid

        guid of case

        string

      • CaseNumber

        Case number.

        string

      • CaseStatusCode

        status code of case

        string

      • CaseStatusText

        status description of case

        string

      • ConversationGuid

        Conversation GUID.

        string

      • ConversationSubject

        Conversation subject

        string

      • Creditor

        Creditor.

        string

      • CreditorName

        Creditor name.

        string

      • Documents

        documents linked to message
        Array
        Object

        HistoryDocument

        Detailed information about history action document.

        • CaseGuids

          List of unique identifiers of collection cases related to the document.
          Array

          string

        • DebtorGuids

          List of unique identifiers of debtors related to the collection cases of the document.
          Array

          string

        • DocumentDate

          Document creation date.

          DateTime

        • DocumentTypeCode

          Document code (one of predefined types idoc / invoice / gjeldsbrev / verdict / domforlik).

          string

        • FileName

          File name.

          string

        • HistoryGuid

          History action document's unique identifier.

          string

        • Important

          Document importancy flag.

          bool

        • Note

          Free extra information related to the document.

          string

        • UserEmail

          E-mail of the document author.

          string

        • UserFullName

          Full name of the document author.

          string

        • UserType

          Party type of the document author.
          Enum

          UserType

          User type.

          • None

            User type is undefined.

          • All

            All types.

          • CreditorUser

            Creditor user type.

          • SolicitorUser

            Solicitor user type.

          • CreditorAndSolicitorUser

            Creditor | Solicitor user type.

          • Debtor

            Debtor user type.

          • CreditorUserAndDebtor

            Creditor Debtor user type

          • SolicitorUserAndDebtor

            Solicito Debtor user type

          • CreditorAndSolicitorUserAndDebtor

            Creditor Solicitor Debtor user type

      • DueDate

        Due date.

        DateTime

      • FirstInvoiceNumber

        First invoice number.

        string

      • MainDebtorFullName

        Main debtor id full name

        string

      • MainDebtorIdNumber

        Main debtor id number

        string

      • MessageGuid

        Message GUID.

        string

      • MessageReplies

        List of message replies.
        Array
        Object

        FixedMessageReply

        Holds fixed message reply information.

        • FixedMessageReplyType

          Fixed message reply type.
          Enum

          FixedMessageReplyType

          Fixed message reply type.

          • FixedReply

            Fixed reply.

          • ReplyWithNote

            Reply with note.

          • ReplyWithAttachment

            Reply with attachment.

          • ReplyAsConversation

            Reply as conversation.

        • MessageCode

          Message code.

          string

        • MessageText

          Message text.

          string

      • MessageText

        Message text.

        string

      • MessageType

        Message type.
        Enum

        MessageType

        Message type.

        • All

          All types.

        • Notification

          Notification type.

        • UserQuestion

          User question type.

        • Conversation

          Conversation type.

      • PostedAt

        Posted at.

        DateTime

      • PostedByEmail

        contains the posting user’s email is it exists

        string

      • PostedByFullName

        contains the user name or user code of the user posted the message

        string

      • PostedByType

        contains the posting user’s party type
        Enum

        UserType

        User type.

        • None

          User type is undefined.

        • All

          All types.

        • CreditorUser

          Creditor user type.

        • SolicitorUser

          Solicitor user type.

        • CreditorAndSolicitorUser

          Creditor | Solicitor user type.

        • Debtor

          Debtor user type.

        • CreditorUserAndDebtor

          Creditor Debtor user type

        • SolicitorUserAndDebtor

          Solicito Debtor user type

        • CreditorAndSolicitorUserAndDebtor

          Creditor Solicitor Debtor user type

      • ReplyToMessageGuid

        Reply to message GUID.

        string

      • Unhandled

        Is message unhandled?

        bool

      • UserActionCategory

        User action category

        string

      • UserActionCategoryDescription

        User action category description

        string

      • UserQuestionAnswer

        Answer code user selected for question when confirming manual action

        string

      • UserQuestionAnswerDescription

        Description of answer code user selected for question when confirming manual action

        string

    • PageLength

      Page lenght, default set to 100.

      int

    • PageNo

      Page number, default set to 1.

      int

    • Result

      The result of the request. Indicating success or error.
      Object

      ResultType

      Common result type.

      • ResultCode Mandatory

        The result code 0 means ok, anything else usually indicates a warning or an error. Look at accompanying result text for more details on result.

        int

      • ResultText Mandatory

        Text information of the result. Usually contains a warning or error message when result code is indicating other than success.

        string

    • TotalPages

      Pages count, default set to 0.

      int

GetUnhandledMessages

Returns list of uhhandled messages.
Returns list of uhhandled messages according to specified parameters.

Examples

Sample usage in C# with generated client: 
MessagesClient client = new MessagesClient();

GetUnhandledMessagesResult result = client.GetUnhandledMessages(new GetUnhandledMessagesRequest
{
    PageLength = 100,
    PageNo = 1,
    MessageFilter = new MessageFilter
    {
        MessageType = MessageType.All,
        AssignedTo = "231",
        CaseStatus = "caseStatus",
        CaseNumber = "412",
        CreditorName = "creditorName",
        CreditorRefs = new CreditorRefs(){"ref1", "ref2", "ref3"},
        DueDate = new DateTime(2019, 01, 02),
        PostedAt = new DateTime(2019, 01, 01),
        FirstInvoiceNumber = "123",
        MainDebtorName = "mainDebtorName",
        MainDebtorSSN = "mainDebtorSSN",
        PostedToType = UserType.All
    },
    Sorting = new MessageSorting
    {
        MessageSortingType = MessageSortingType.DueDate,
        Descending = true
    }
});
Sample soap request: 
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:uuid:e657a351-ae8c-42c5-b083-ebe5dcda5c0b">
   <soapenv:Header/>
   <soapenv:Body>
      <urn:GetUnhandledMessages>
         <urn:getUnhandledMessagesRequest>
            <urn:MessageFilter>
               <urn:AssignedTo>231</urn:AssignedTo>
               <urn:CaseNumber>412</urn:CaseNumber>
               <urn:CaseStatus>caseStatus</urn:CaseStatus>
               <urn:CreditorName>creditorName</urn:CreditorName>
               <urn:CreditorRefs>
                  <urn:CreditorRefNo>CreditorRefNo</urn:CreditorRefNo>
               </urn:CreditorRefs>
               <urn:DueDate>2019-06-02</urn:DueDate>
               <urn:FirstInvoiceNumber>123</urn:FirstInvoiceNumber>
               <urn:MainDebtorName>mainDebtorName</urn:MainDebtorName>
               <urn:MainDebtorSSN>mainDebtorSSN</urn:MainDebtorSSN>
               <urn:MessageType>All</urn:MessageType>
               <urn:PostedAt>2019-06-01</urn:PostedAt>
               <urn:PostedToType>All</urn:PostedToType>
            </urn:MessageFilter>
            <urn:PageLength>100</urn:PageLength>
            <urn:PageNo>1</urn:PageNo>
            <urn:Sorting>
               <urn:Descending>true</urn:Descending>
               <urn:MessageSortingType>DueDate</urn:MessageSortingType>
            </urn:Sorting>
         </urn:getUnhandledMessagesRequest>
      </urn:GetUnhandledMessages>
   </soapenv:Body>
</soapenv:Envelope>

Input

  • request Mandatory

    Request data
    Object

    GetUnhandledMessages

    GetUnhandledMessages.

    • getUnhandledMessagesRequest

      Information to get unhadled messages, pagination and sorting.
      Object

      GetUnhandledMessagesRequest

      Get unhandled messages request.

      • MessageFilter

        Message filter, default set to all.
        Object

        MessageFilter

        List message filter type.

        • AssignedTo

          Filter reports by specified assigned to value.

          string

        • CaseNumber

          Filter reports by specified case number.

          string

        • CaseStatus

          Filter reports by specified case status.

          string

        • CreditorName

          Filter reports by specified creditro name.

          string

        • CreditorRefs

          Filter reports by specified creditor reference number.
          Array

          string

        • DueDate

          Filter reports by specified due date.

          DateTime

        • FirstInvoiceNumber

          Filter reports by specified first invoice number.

          string

        • MainDebtorName

          Filter reports by specified main debtor name.

          string

        • MainDebtorSSN

          Filter reports by specified main debtor SSN.

          string

        • MessageType Mandatory

          Filter reports by specified message type.
          Enum

          MessageType

          Message type.

          • All

            All types.

          • Notification

            Notification type.

          • UserQuestion

            User question type.

          • Conversation

            Conversation type.

        • PostedAt

          Filter reports by specified posted at date.

          DateTime

        • PostedByType

          Filter reports by the specified type of user who sent the message
          Enum

          UserType

          User type.

          • None

            User type is undefined.

          • All

            All types.

          • CreditorUser

            Creditor user type.

          • SolicitorUser

            Solicitor user type.

          • CreditorAndSolicitorUser

            Creditor | Solicitor user type.

          • Debtor

            Debtor user type.

          • CreditorUserAndDebtor

            Creditor Debtor user type

          • SolicitorUserAndDebtor

            Solicito Debtor user type

          • CreditorAndSolicitorUserAndDebtor

            Creditor Solicitor Debtor user type

        • PostedToType

          Filter reports by the specified type of user who is assigned
          Enum

          UserType

          User type.

          • None

            User type is undefined.

          • All

            All types.

          • CreditorUser

            Creditor user type.

          • SolicitorUser

            Solicitor user type.

          • CreditorAndSolicitorUser

            Creditor | Solicitor user type.

          • Debtor

            Debtor user type.

          • CreditorUserAndDebtor

            Creditor Debtor user type

          • SolicitorUserAndDebtor

            Solicito Debtor user type

          • CreditorAndSolicitorUserAndDebtor

            Creditor Solicitor Debtor user type

        • UserActionCategory

          Filter messages by specified user action category code.

          string

      • PageLength

        Page lenght, default set to 100.

        int

      • PageNo

        Page number, default set to 1.

        int

      • Sorting

        Message sorting, default set to due date.
        Object

        MessageSorting

        Message sorting.

        • Descending

          Is descending?

          bool

        • MessageSortingType Mandatory

          Message sorting type.
          Enum

          MessageSortingType

          Message sorting type.

          • MessageType

            Message type.

          • FirstInvoiceNumber

            First invoice number.

          • CaseNumber

            Case number.

          • CreditorRefNo

            Credit reference number.

          • CreditorName

            Creditor Name.

          • MainDebtorSSN

            Main debtor SSN.

          • MainDebtorName

            Main debtor name.

          • DueDate

            Due date.

          • AssignedTo

            Assigned to.

          • PostedAt

            Posted at.

          • CaseStatus

            Case status.

          • UserActionCategory

            User action category.

Output

List of unhadled messages filtered by parameters. If filter format is incorrect - error is returned
Error codes:
  • 1 : error message from ARC server.
Object

GetUnhandledMessagesResponse

GetUnhandledMessages response.

  • GetUnhandledMessagesResult

    Result of GetUnhandledMessages.
    Object

    GetUnhandledMessagesResult

    Get unhandled messages result.

    • MessageCount

      Returned messages count, default set to 0.

      int

    • Messages

      List of messages.
      Array
      Object

      Message

      Holds message information.

      • AssignedTo

        Assigned to.

        string

      • AssignedToEmail

        Email of the assignee.

        string

      • AssignedToFullName

        Full name or user code of the assignee.

        string

      • AssignedToType

        Type of the assignee.
        Enum

        UserType

        User type.

        • None

          User type is undefined.

        • All

          All types.

        • CreditorUser

          Creditor user type.

        • SolicitorUser

          Solicitor user type.

        • CreditorAndSolicitorUser

          Creditor | Solicitor user type.

        • Debtor

          Debtor user type.

        • CreditorUserAndDebtor

          Creditor Debtor user type

        • SolicitorUserAndDebtor

          Solicito Debtor user type

        • CreditorAndSolicitorUserAndDebtor

          Creditor Solicitor Debtor user type

      • CaseGuid

        guid of case

        string

      • CaseNumber

        Case number.

        string

      • CaseStatusCode

        status code of case

        string

      • CaseStatusText

        status description of case

        string

      • ConversationGuid

        Conversation GUID.

        string

      • ConversationSubject

        Conversation subject

        string

      • Creditor

        Creditor.

        string

      • CreditorName

        Creditor name.

        string

      • Documents

        documents linked to message
        Array
        Object

        HistoryDocument

        Detailed information about history action document.

        • CaseGuids

          List of unique identifiers of collection cases related to the document.
          Array

          string

        • DebtorGuids

          List of unique identifiers of debtors related to the collection cases of the document.
          Array

          string

        • DocumentDate

          Document creation date.

          DateTime

        • DocumentTypeCode

          Document code (one of predefined types idoc / invoice / gjeldsbrev / verdict / domforlik).

          string

        • FileName

          File name.

          string

        • HistoryGuid

          History action document's unique identifier.

          string

        • Important

          Document importancy flag.

          bool

        • Note

          Free extra information related to the document.

          string

        • UserEmail

          E-mail of the document author.

          string

        • UserFullName

          Full name of the document author.

          string

        • UserType

          Party type of the document author.
          Enum

          UserType

          User type.

          • None

            User type is undefined.

          • All

            All types.

          • CreditorUser

            Creditor user type.

          • SolicitorUser

            Solicitor user type.

          • CreditorAndSolicitorUser

            Creditor | Solicitor user type.

          • Debtor

            Debtor user type.

          • CreditorUserAndDebtor

            Creditor Debtor user type

          • SolicitorUserAndDebtor

            Solicito Debtor user type

          • CreditorAndSolicitorUserAndDebtor

            Creditor Solicitor Debtor user type

      • DueDate

        Due date.

        DateTime

      • FirstInvoiceNumber

        First invoice number.

        string

      • MainDebtorFullName

        Main debtor id full name

        string

      • MainDebtorIdNumber

        Main debtor id number

        string

      • MessageGuid

        Message GUID.

        string

      • MessageReplies

        List of message replies.
        Array
        Object

        FixedMessageReply

        Holds fixed message reply information.

        • FixedMessageReplyType

          Fixed message reply type.
          Enum

          FixedMessageReplyType

          Fixed message reply type.

          • FixedReply

            Fixed reply.

          • ReplyWithNote

            Reply with note.

          • ReplyWithAttachment

            Reply with attachment.

          • ReplyAsConversation

            Reply as conversation.

        • MessageCode

          Message code.

          string

        • MessageText

          Message text.

          string

      • MessageText

        Message text.

        string

      • MessageType

        Message type.
        Enum

        MessageType

        Message type.

        • All

          All types.

        • Notification

          Notification type.

        • UserQuestion

          User question type.

        • Conversation

          Conversation type.

      • PostedAt

        Posted at.

        DateTime

      • PostedByEmail

        contains the posting user’s email is it exists

        string

      • PostedByFullName

        contains the user name or user code of the user posted the message

        string

      • PostedByType

        contains the posting user’s party type
        Enum

        UserType

        User type.

        • None

          User type is undefined.

        • All

          All types.

        • CreditorUser

          Creditor user type.

        • SolicitorUser

          Solicitor user type.

        • CreditorAndSolicitorUser

          Creditor | Solicitor user type.

        • Debtor

          Debtor user type.

        • CreditorUserAndDebtor

          Creditor Debtor user type

        • SolicitorUserAndDebtor

          Solicito Debtor user type

        • CreditorAndSolicitorUserAndDebtor

          Creditor Solicitor Debtor user type

      • ReplyToMessageGuid

        Reply to message GUID.

        string

      • Unhandled

        Is message unhandled?

        bool

      • UserActionCategory

        User action category

        string

      • UserActionCategoryDescription

        User action category description

        string

      • UserQuestionAnswer

        Answer code user selected for question when confirming manual action

        string

      • UserQuestionAnswerDescription

        Description of answer code user selected for question when confirming manual action

        string

    • PageLength

      Page lenght, default set to 100.

      int

    • PageNo

      Page number, default set to 1.

      int

    • Result

      The result of the request. Indicating success or error.
      Object

      ResultType

      Common result type.

      • ResultCode Mandatory

        The result code 0 means ok, anything else usually indicates a warning or an error. Look at accompanying result text for more details on result.

        int

      • ResultText Mandatory

        Text information of the result. Usually contains a warning or error message when result code is indicating other than success.

        string

    • TotalPages

      Pages count, default set to 0.

      int

Ping

Make a ping request to see that the service is up and running.
This operation enables to check if service is available. The service will return a result code 0 if everything went ok. If something went wrong it will return a result code other than 0 and the result text will contain information about error. However if service is unreachable, e.g. not started, the service will not respond at all.

Examples

Sample usage in C# with generated client: 
ConversationClient client = new MessagesClient();

try
{
    GeneralResult result = client.Ping();

    if (result.Result.ResultCode != 0)
    {
        throw new Exception(result.Result.ResultText ?? "Unknown error");
    }
}
catch(Exception e)
{
    throw new Exception("Failed to ping conversation service.", e);
}
Sample soap request: 
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:uuid:e657a351-ae8c-42c5-b083-ebe5dcda5c0b">
    <soapenv:Header/>
    <soapenv:Body>
        <urn:Ping/>
     </soapenv:Body>
</soapenv:Envelope>

Input

  • request Mandatory

    Request data
    Object

    Ping

    Ping

Output

Returns with result code 0 if ping was successful, otherwise read result text for error information.
Object

GeneralResultResponse

GeneralResult response

  • GeneralResult

    Result of GeneralResult
    Object

    GeneralResult

    A general result containing a result with result code and result text.

    • Result

      The result of the request.
      Object

      ResultType

      Common result type.

      • ResultCode Mandatory

        The result code 0 means ok, anything else usually indicates a warning or an error. Look at accompanying result text for more details on result.

        int

      • ResultText Mandatory

        Text information of the result. Usually contains a warning or error message when result code is indicating other than success.

        string

PostOrRespondToMessage

Post or respond to message.
Post or respond to message and add document by specified parameters.

Examples

Sample usage in C# with generated client: 
MessagesClient client = new MessagesClient();

PostOrRespondToMessageResult result = client.PostOrRespondToMessage(new PostOrRespondToMessageRequest
{
    MessageGuid = "412",
    ReplyCode = "replyCode",
    CaseLookup = new CaseLookup
    {
        CaseIdentification = CaseIdentificationType.CaseNumber,
        CaseIdentificationValue = "423423"
    },
    AttachedDocument = new Document
    {
        Note = "Here a new file comes"
    },
    MessageText = "messageText",
    FixedMessageReplyType = FixedMessageReplyType.ReplyWithAttachment,
    CloseConversation = false,
    AssignToMe = true,
    ConversationGUID = "EEEE5203-0E30-4A30-9774-18D025B00715",
    ConversationSubject = "Test subject",
    MessageReplyType = MessageReplyType.ConfirmNotification
});
Sample soap request: 
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:uuid:e657a351-ae8c-42c5-b083-ebe5dcda5c0b">
   <soapenv:Header/>
   <soapenv:Body>
      <urn:PostOrRespondToMessage>
         <urn:postOrRespondToMessageRequest>
            <urn:AssignToMe>true</urn:AssignToMe>
            <urn:AttachedDocument>
               <urn:Note>Here a new file comes</urn:Note>
            </urn:AttachedDocument>
            <urn:CaseLookup>
               <urn:CaseIdentification>CaseNumber</urn:CaseIdentification>
               <urn:CaseIdentificationValue>423423</urn:CaseIdentificationValue>
            </urn:CaseLookup>
            <urn:CloseConversation>false</urn:CloseConversation>
            <urn:ConversationGUID>EEEE5203-0E30-4A30-9774-18D025B00715</urn:ConversationGUID>
            <urn:ConversationSubject>Test subject</urn:ConversationSubject>
            <urn:FixedMessageReplyType>ReplyWithAttachment</urn:FixedMessageReplyType>
            <urn:MessageGuid>412</urn:MessageGuid>
            <urn:MessageReplyType>ConfirmNotification</urn:MessageReplyType>
            <urn:MessageText>messageText</urn:MessageText>
            <urn:ReplyCode>replyCode</urn:ReplyCode>
         </urn:postOrRespondToMessageRequest>
      </urn:PostOrRespondToMessage>
   </soapenv:Body>
</soapenv:Envelope>

Input

  • request Mandatory

    Request data
    Object

    PostOrRespondToMessage

    PostOrRespondToMessage.

    • postOrRespondToMessageRequest

      Information to post or respond to message.
      Object

      PostOrRespondToMessageRequest

      Post or respond to message request.

      • AssignToMe Mandatory

        Assign to me flag.

        bool

      • AttachedDocument

        Attached document.
        Object

        Document

        Holds history action document information.

        • DocumentType

          Document code (one of predefined types idoc / invoice / gjeldsbrev / verdict / domforlik).

          string

        • ExternalLink

          Link to the document, if it has to be copied from external source.

          string

        • FileDataBase64

          Base64-encoded file body.

          string

        • Important

          Document importancy flag.

          bool

        • LoggedAt

          Document creation date.

          DateTime

        • Note Mandatory

          Free extra information related to the document.

          string

        • OriginalFileName

          The file name to be generated instead of an auto-generated one.

          string

      • CaseLookup

        Information to lookup collection case(s).
        Object

        CaseLookup

        The way to find a collection case in DB by several predefined criteria.

        • CaseIdentification Mandatory

          Collection case identification type.
          Enum

          CaseIdentificationType

          Collection case identification type.

          • CaseGuid

            Case GUID identification.

          • CaseNumber

            Case number.

          • AccountReferenceNumber

            Account reference number provided by the client.

          • InvoiceNumber

            Invoice number of one on the debts provided by the client.

          • PaymentReferenceNumber

            Payment reference number (OCR).

          • CustomerNo

            Customer number for the debtor at the creditor side.

        • CaseIdentificationValue Mandatory

          Identification value corresponding to identification type.

          string

      • CloseConversation

        Close conversation flag.

        bool

      • ConversationGUID

        Conversation GUID.

        string

      • ConversationSubject

        Conversation subject.

        string

      • FixedMessageReplyType

        Fixed message reply type.
        Enum

        FixedMessageReplyType

        Fixed message reply type.

        • FixedReply

          Fixed reply.

        • ReplyWithNote

          Reply with note.

        • ReplyWithAttachment

          Reply with attachment.

        • ReplyAsConversation

          Reply as conversation.

      • MessageGuid

        Message GUID.

        string

      • MessageReplyType Mandatory

        Message reply type.
        Enum

        MessageReplyType

        Message reply type.

        • StartConversation

          Start conversation.

        • ConfirmNotification

          Confirm notification.

        • ReplyUserQuestion

          Reply to user question.

        • ReplyInConversation

          Reply in conversation.

      • MessageText

        Message text.

        string

      • ReplyCode

        Reply code.

        string

      • UserActionCategory

        User action category.

        string

Output

Returns result code 0 if post or respond to message successful.
Error codes:
  • 1 : error message from ARC server.
Object

PostOrRespondToMessageResponse

PostOrRespondToMessage response.

  • PostOrRespondToMessageResult

    Result of PostOrRespondToMessage.
    Object

    PostOrRespondToMessageResult

    Post or respond to message result.

    • ConversationGuid

      Conversation guid

      string

    • MessageGuid

      Message guid

      string

    • Result

      The result of the request. Indicating success or error.
      Object

      ResultType

      Common result type.

      • ResultCode Mandatory

        The result code 0 means ok, anything else usually indicates a warning or an error. Look at accompanying result text for more details on result.

        int

      • ResultText Mandatory

        Text information of the result. Usually contains a warning or error message when result code is indicating other than success.

        string