Service for client/collector conversation threads.

CloseConversation

Closes a conversation.

Examples

Sample usage in C# with generated client:

ConversationClient client = new ConversationClient();

GeneralResult result = client.CloseConversation("A4287D2A-F16C-4C38-A6E6-9F307626204D");

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:CloseConversation>
            <urn:ThreadGuid>A4287D2A-F16C-4C38-A6E6-9F307626204D</urn:ThreadGuid>
        </urn:CloseConversation>
    </soapenv:Body>
</soapenv:Envelope>

Input

request Mandatory

Request data
Object
CloseConversation

CloseConversation class
- ThreadGuid
  
  Unique identifier of conversation.
  
  string

Output

Returns result code 0 if conversation is closed
Error codes:

1: unknown error or error message from ARC server

Object

CloseConversationResult

Result of CloseConversation
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

CreateCollectionConversation

Creates a collection case conversation.

Supply either CaseLookup or DebtorLookup to identify the collection case where the conversation is started on.

Examples

Sample usage in C# with generated client:

ConversationClient client = new ConversationClient();

CreateConversationResult result = client.CreateCollectionConversation(
    Subject: "Let's discuss collection case",
    Message: "Hi, I have new information regarding this collection case. Matt.",
    CaseLookup: null,
    DebtorLookup: new DebtorLookup { DebtorIdentification = DebtorIdentificationType.DebtorReferenceNumber, DebtorIdentificationValue = "19580215-9557" }
);

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:CreateCollectionConversation>
            <urn:DebtorLookup>
                <urn:DebtorIdentification>DebtorReferenceNumber</urn:DebtorIdentification>
                <urn:DebtorIdentificationValue>19580215-9557</urn:DebtorIdentificationValue>
            </urn:DebtorLookup>
            <urn:Message>Hi, I have new information regarding this collection case. Matt.</urn:Message>
            <urn:Subject>Let's discuss collection case</urn:Subject>
        </urn:CreateCollectionConversation>
    </soapenv:Body>
</soapenv:Envelope>

Input

request Mandatory

Request data
Object
CreateCollectionConversation

CreateCollectionConversation.
- CaseLookup
  
  Optional information to lookup 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
- DebtorLookup
  
  Optional information to lookup debtor(s).
  Object
  
  DebtorLookup
  
  The way to find a debtor in DB by several predefined criteria.
  
  DebtorIdentification Mandatory
  
  Debtor identification type.
  
  Enum
  
  DebtorIdentificationType
  
  Debtor identification type.
  
  Custom
  
  Custom identification. NOT SUPPORTED.
  
  DebtorSESSNOrCompanyNo
  
  Identify by Swedish SSN or company number.
  
  DebtorNOSSNOrCompanyNo
  
  Identify by Norweigan SSN or company number.
  
  DebtorReferenceNumber
  
  Identify by debtor/client reference number.
  
  DebtorGuid
  
  Debtor identification.
  
  CustomerNo
  
  Customer number for the debtor at the creditor side. NOT SUPPORTED in DebtorAccess.EstablishSession.
  
  DebtorFISSNOrCompanyNo
  
  Identify by Finnish SSN or company number.
  
  DebtorIdentificationValue Mandatory
  
  Identification value corresponding to identification type.
  
  string
- Message
  
  Message text.
  
  string
- Subject
  
  Message subject.
  
  string

Output

Unique identifier of the inserted conversation.
Error codes:

1: unknown error or error message from ARC server

Object

CreateCollectionConversationResult

Result of CreateCollectionConversation.
Object
CreateConversationResult

General class for representing method output.
- 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
- ThreadGuid
  
  Topic unique identifier.
  
  string

CreateForum

Operation CreateForum is obsolete. This method is left for compatibility with old functionality which is practically not used anymore

Creates a topic.

Examples

Sample usage in C# with generated client:

ConversationClient client = new ConversationClient();

CreateConversationResult result = client.CreateForum(
    Description: "Let's talk about invoices"
);

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:CreateForum>
            <urn:Description>Let's talk about invoices</urn:Description>
        </urn:CreateForum>
    </soapenv:Body>
</soapenv:Envelope>

Input

request Mandatory

Request data
Object
CreateForum

CreateForum.
- Description
  
  Topic description.
  
  string

Output

Unique identifier of the created topic.
Error codes:

1: Unknown error

Object

CreateForumResult

Result of CreateForum.
Object
CreateConversationResult

General class for representing method output.
- 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
- ThreadGuid
  
  Topic unique identifier.
  
  string

CreateLedgerCustomerConversation

Creates a conversation connected to ledger account or customer.

Supply either InvoiceLookup or CustomerLookup to identify ledger account where the conversation is started on.

Examples

Sample usage in C# with generated client:

ConversationClient client = new ConversationClient();

CreateConversationResult result = client.CreateLedgerCustomerConversation(
    Subject: "Let's discuss ledger account",
    Message: "Hi, I have new information regarding this ledger. Bryan.",
    InvoiceLookup: new InvoiceLookup { InvoiceIdentification = InvoiceIdentificationType.InvoiceNumber, InvoiceIdentificationValue = "30077" },
    CustomerLookup: null
);

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:CreateLedgerCustomerConversation>
            <urn:InvoiceLookup>
                <urn:InvoiceIdentification>InvoiceNumber</urn:InvoiceIdentification>
                <urn:InvoiceIdentificationValue>33077</urn:InvoiceIdentificationValue>
            </urn:InvoiceLookup>
            <urn:Message>Hi, I have new information regarding this ledger. Bryan.</urn:Message>
            <urn:Subject>Let's discuss ledger account</urn:Subject>
        </urn:CreateLedgerCustomerConversation>
    </soapenv:Body>
</soapenv:Envelope>

Input

request Mandatory

Request data
Object
CreateLedgerCustomerConversation

CreateLedgerCustomerConversation.
- CustomerLookup
  
  Optional information to lookup customer(s).
  Object
  
  CustomerLookup
  
  A lookup for customer.
  
  CustomerIdentification Mandatory
  
  Type of customer identification to look up.
  
  Enum
  
  CustomerIdentificationType
  
  Customer identification type.
  
  Custom
  
  Custom identification.
  
  CustomerSESSNOrCompanyNo
  
  Identify by Swedish SSN or company number.
  
  CustomerNOSSNOrCompanyNo
  
  Identify by Norwegian SSN or company number.
  
  CustomerReferenceNumber
  
  Identify by customer reference number.
  
  CustomerGuid
  
  Customer identification.
  
  CustomerIdentificationValue Mandatory
  
  Customer identification to look up, depending on type it has different formats.
  
  string
  
  JuridicalType
  
  Type of customer, e.g. physical.
  
  Enum
  
  CustomerJuridicalType
  
  Juridical type of the customer.
  
  Physical
  
  Physical person, meaning a natural person.
  
  Company
  
  A company or other organisation.
  
  PersonalFirm
  
  A company that shares the juridical entity with a physical person.
- InvoiceLookup
  
  Optional information to lookup invoice(s).
  Object
  
  InvoiceLookup
  
  A lookup for invoice.
  
  CreditorRef
  
  Creditor reference.
  
  string
  
  InvoiceIdentification Mandatory
  
  Type of invoice identification to look up.
  
  Enum
  
  InvoiceIdentificationType
  
  Invoice identification type.
  
  InvoiceGuid
  
  Invoice identifier (GUID).
  
  InvoiceNumber
  
  Invoice number.
  
  LetterReference
  
  Letter reference.
  
  InvoiceIdentificationValue Mandatory
  
  Invoice identification to look up, depending on type it has different formats.
  
  string
- Message
  
  Message text.
  
  string
- Subject
  
  Message subject.
  
  string

Output

Unique identifier of the inserted conversation.
Error codes:

1: unknown error or error message from ARC server

Object

CreateLedgerCustomerConversationResult

Result of CreateLedgerCustomerConversation.
Object
CreateConversationResult

General class for representing method output.
- 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
- ThreadGuid
  
  Topic unique identifier.
  
  string

GetCollectionConversations

Returns list of conversations related to collection cases.

Examples

Sample usage in C# with generated client:

ConversationClient client = new ConversationClient();

GetCollectionConversationsResult result = client.GetCollectionConversations();

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:GetCollectionConversations />
    </soapenv:Body>
</soapenv:Envelope>

Input

request Mandatory

Request data
Object
GetCollectionConversations

GetCollectionConversations.

Output

List of conversations related to collection cases.
Error codes:

1: unknown error or error message from ARC server

Object

GetCollectionConversationsResult

Result of GetCollectionConversations.
Object
GetCollectionConversationsResult

General class for representing method output.
- CollectionConversations
  
  List of collection case conversations.
  Array
  
  Object
  
  CollectionConversation
  
  Holds information about collection case conversation.
  
  CaseGuid
  
  Collection case unique identifier.
  
  string
  
  CaseNumber
  
  Collection case number.
  
  string
  
  ClosureDate Mandatory
  
  Conversation closure date.
  
  DateTime
  
  ConversationGuid Mandatory
  
  Conversation unique identifier.
  
  string
  
  DebtorGuid
  
  Collection case debtor unique identifier.
  
  string
  
  DebtorName
  
  Collection case debtor name.
  
  string
  
  Messages Mandatory
  
  Conversation messages count.
  
  int
  
  Subject
  
  Conversation subject
  
  string
  
  Unread Mandatory
  
  Conversation unread messages count.
  
  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

GetForumList

Operation GetForumList is obsolete. This method is left for compatibility with old functionality which is practically not used anymore

Returns topics.

Examples

Sample usage in C# with generated client:

ConversationClient client = new ConversationClient();

GetForumListResult result = client.GetForumList();

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:GetForumList />
    </soapenv:Body>
</soapenv:Envelope>

Input

request Mandatory

Request data
Object
GetForumList

GetForumList.

Output

List of topics.
Error codes:

1: Unknown error

Object

GetForumListResult

Result of GetForumList.
Object
GetForumListResult

General class for representing method output.
- Forums
  
  List of topics.
  Array
  
  Object
  
  Forum
  
  Holds information about topic.
  
  Description
  
  Topic description.
  
  string
  
  Messages
  
  Topic messages count.
  
  int
  
  ThreadGuid
  
  Topic unique identifier.
  
  string
  
  Unread
  
  Topic unread messages count.
  
  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

GetLedgerCustomerConversations

Returns list of conversations related to ledger accounts.

Examples

Sample usage in C# with generated client:

ConversationClient client = new ConversationClient();

GetLedgerCustomerConversationsResult result = client.GetLedgerCustomerConversations();

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:GetLedgerCustomerConversations />
    </soapenv:Body>
</soapenv:Envelope>

Input

request Mandatory

Request data
Object
GetLedgerCustomerConversations

GetLedgerCustomerConversations.

Output

List of conversations related to ledger accounts.
Error codes:

1: unknown error or error message from ARC server

Object

GetLedgerCustomerConversationsResult

GetLedgerCustomerConversations result.
Object
GetLedgerCustomerConversationsResult

General class for representing method output.
- LedgerCustomerConversations
  
  List of ledger account conversations.
  Array
  
  Object
  
  LedgerCustomerConversation
  
  Holds information about ledger account conversation.
  
  AccountNumber
  
  Customer account number.
  
  string
  
  CreditorReference
  
  Creditor reference.
  
  string
  
  CustomerGuid
  
  Ledger customer unique identifier.
  
  string
  
  CustomerName
  
  Ledger customer name.
  
  string
  
  InvoiceNumber
  
  Invoice number.
  
  string
  
  Messages Mandatory
  
  Conversation messages count.
  
  int
  
  ThreadGuid Mandatory
  
  Conversation unique identifier.
  
  string
  
  Unread Mandatory
  
  Conversation unread messages count.
  
  int
- Result Mandatory
  
  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

GetMessages

Returns list of conversation messages related to ledger account / collection case.

Examples

Sample usage in C# with generated client:

ConversationClient client = new ConversationClient();

GetMessagesResult result = client.GetMessages("A4287D2A-F16C-4C38-A6E6-9F307626204D");

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:GetMessages>
            <urn:ThreadGuid>A4287D2A-F16C-4C38-A6E6-9F307626204D</urn:ThreadGuid>
        </urn:GetMessages>
    </soapenv:Body>
</soapenv:Envelope>

Input

request Mandatory

Request data
Object
GetMessages

GetMessages.
- ThreadGuid
  
  Unique identifier of conversation.
  
  string

Output

List of messages for the conversation identified by unique identifier.
Error codes:

1: unknown error or error message from ARC server

Object

GetMessagesResult

Result of GetMessages.
Object
GetMessagesResult

General class for representing method output.
- Messages
  
  List of conversation messages.
  Array
  
  Object
  
  Message
  
  Holds information about conversation message.
  
  ConversationClosed Mandatory
  
  Conversation closed flag.
  
  bool
  
  ConversationGuid Mandatory
  
  Conversation unique identifier.
  
  string
  
  MessageGuid Mandatory
  
  Message unique identifier.
  
  string
  
  MessageText Mandatory
  
  Message text.
  
  string
  
  PostedAt Mandatory
  
  Message posting date.
  
  DateTime
  
  PostedBy Mandatory
  
  Message posting author.
  
  string
  
  ReplyToMessageGuid
  
  Unique identifier of the message being replied on.
  
  string
  
  Unread Mandatory
  
  Is the message unread.
  
  bool
- 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

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 ConversationClient();

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

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

PostMessage

Posts a conversation message.

Examples

Sample usage in C# with generated client:

ConversationClient client = new ConversationClient();

PostMessageResult result = client.PostMessage(
    ThreadGuid: "A4287D2A-F16C-4C38-A6E6-9F307626204D",
    MessageText: "New message from me",
    ReplyToMessageGuid: null
);

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:PostMessage>
            <urn:MessageText>New message from me</urn:MessageText>
            <urn:ThreadGuid>A4287D2A-F16C-4C38-A6E6-9F307626204D</urn:ThreadGuid>
        </urn:PostMessage>
    </soapenv:Body>
</soapenv:Envelope>

Input

request Mandatory

Request data
Object
PostMessage

PostMessage.
- MessageText
  
  Message text.
  
  string
- ReplyToMessageGuid
  
  Optional unique identifier of the message being replied on.
  
  string
- ThreadGuid
  
  Unique identifier of conversation.
  
  string

Output

Unique identifier of the inserted message.
Error codes:

1: unknown error or error message from ARC server

Object

PostMessageResult

Result of PostMessage.
Object
PostMessageResult

General class for representing method output.
- MessageGuid
  
  Message unique identifier.
  
  string
- Result Mandatory
  
  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