VendorCommunication.asmx

GetMessagesForLoan

Retrieves all vendor messages available for the user for the specified loan and integration framework.

public string GetMessagesForLoan(string authTicket, string loanNumber, string framework, bool includeUnreadIndicators)

Parameters

authTicket - Ticket returned by AuthService.asmx.

loanNumber - The loan number to retrieve messages for.

framework - The integration framework to retrieve messages for. (Currently "Appraisal" is the only valid option)

includeUnreadIndicators - Indicates whether to include unread indicators for the current user.

Return Value

An LOXML formatted string. The result includes a status attribute [ERROR | OK]. ERROR responses include an error message. OK responses include an LOXML list of vendor messages.

Example

If the message list is successfully retrieved then the following is the response format:
     <LOXmlFormatversion="1.0">
     <result status="OK">
         <collection id="VendorMessages">
             <record>
                 <MessageId>{The ID of the vendor message}</MessageId>
                 <LoanId>{The Loan ID associated with the message}</LoanId>
                 <OrderNumber>{The appraisal order number associated with the message}</OrderNumber>
                 <SendingParty>{The name of the message sender}</SendingParty>
                 <ReceivingParty>{The name of the message recipient}</ReceivingParty>
                 <Subject>{The message subject}</Subject>
                 <Message>{The message body}</Message>
                 <Date>{The date the message was sent}</Date>
                 
                 <IsUnread>{Indicates whether the message is unread by the current user}</IsUnread>
             </record>
             
         </collection>
     </result>
     </LOXmlFormat>

If an error occurs then the following is the response format:
     <LOXmlFormatversion="1.0">
         <result status="ERROR">
             <message>{ERROR MESSAGE HERE}</message>
         </result>
     </LOXmlFormat>

SetMessageRead

Sets a vendor message as read for the current user.

public string SetMessageRead(string authTicket, string loanNumber, string framework, string messageId)

Parameters

authTicket - Ticket returned by AuthService.asmx.

loanNumber - The loan number to retrieve messages for.

framework - The integration framework to retrieve messages for. (Currently "Appraisal" is the only valid option)

messageId - The ID of the message to set as read. This is exposed through the output for GetMessagesForLoan.

Return Value

An LOXML formatted string. The result includes a status attribute [ERROR | OK]. ERROR responses include an error message.

Example

If the operation is successful, the following string will be returned:
<result status="OK" />

If the operation fails, the following string will be returned:
<result status="Error" ><error>{ERROR MESSAGE HERE}</error></result>

SendMessage

Transmits a message to a vendor on behalf of the current user.

public string SendMessage(string authTicket, string loanNumber, string framework, string orderNumber, string recipient, string subject, string body)

Parameters

authTicket - Ticket returned by AuthService.asmx.

loanNumber - The loan number to retrieve messages for.

framework - The integration framework to retrieve messages for. (Currently "Appraisal" is the only valid option)

orderNumber - The appraisal order number associated with this message. The recipient will be the vendor associated with the order.

recipient - The recipient of the message. Must be "Appraiser" or "AMC" for appraisal messages.

subject - The message subject.

body - The message body.

Return Value

An LOXML formatted string. The result includes a status attribute [ERROR | OK]. ERROR responses include an error message.

Example