Message Class

The Message module's Message table is based on the MISMO data dictionary standard.

Message properties

Column	Type	Required	Description
Active	string
ActiveStatus	string
Batch	integer
BodyHTML	string
BodyText	string
CanDelete	string
CanInsert	string
CanUpdate	string
CreatedDate	dateTime
CreatedPersonID	integer
DateAdded	dateTime
Extranet	string
FinalStatus	string
Form	string
FromAddress	string
FromContactID	integer
FromName	string
HasTemplate	string
InDecisionID	string
InformationOnly	string
InImportFileID	string
LinkedFrom	string
LinkedTo	string
Message	string	yes	Label for the table.
MessageID	integer	yes	Identity column and primary key for the table.
MessageTemplateID	integer
MessageType	string		Enumerated values; set by power user in ObjectType table.
NotLinkedFrom	string
NotLinkedTo	string
Object	string
ObjectID	integer
ParentMessageID	integer
Priority	integer
Recipient	string
RecipientName	string
RecipientObject	string
SecureDelivery	boolean
Sent	string
Status	string
Tags	string
TemplateExtranet	string
Unread	string
UnreadNotifications	string
UpdatedDate	dateTime
UpdatedPersonID	integer
ViewAsRole	string
Worklist	string

Related modules

Related Objects	Module	Relationship
Access		Child
ActiveRecipients	MessageRecipient	Child
Attachments	Attachment	Child
Collections	CollectionMember	Child
ConfigurationEntryCollection	ConfigurationEntry	Child
Contacts	Contact	Child
Decisions	Decision	Child
Forms	ImportForm	Child
FromContact	qbo.Contact.ContactObject	Foreign Key
Labels	CollectionMember	Child
Ledgers	Ledger	Child
MessageTemplate	qbo.Message.MessageTemplateObject	Foreign Key
Recipients	MessageRecipient	Child
Regions	Geography	Child
Scores	Score	Child
SearchIndexes	SearchIndex	Child
Worklists	SmartWorklistMember	Child

Method signatures

Message/Message.ashx/Search?{Parameters}

The search method will return all records matching the {Parameters} criteria. For searches, {Parameters} may include any property listed in the table above. The following standard optional parameters also apply:

• Output: determines the formatting of the returned data. Valid values are Xml, Json, JsonP. If omitted, XHTML is returns based on the Message.Search.xslt template.
• DisplaySize: determines the maximum number of rows returned. Default is 25. DisplaySize=0 will return all matching rows.
• RecordStart: the starting record to return; defaults to 0. Used for pagination.
• OrderBy: a series of properties to order by.
• Request: Message.ashx/Search?Message=ABC123
• Response:

<MessageCollection>
  <MessageItem>
    <MessageID>1279686</MessageID>
    <Message>**URGENT** System Users Deactivated</Message>
    <MessageType>
    </MessageType>
    <Priority>
    </Priority>
    <SecureDelivery>
    </SecureDelivery>
    <FromAddress>
    </FromAddress>
    <FromName>
    </FromName>
    <FromContactID>
    </FromContactID>
    <DateAdded>
    </DateAdded>
    <BodyText>
    </BodyText>
    <BodyHTML>
        <div>
          <p>Dear Test Attorney,</p>
          <p>The following user accounts were deactivated due to lack of following re-certification guidelines.  If any of these accounts should remain active, you will need to log into the system, reactivate them, and re-certify them.  Please refer to the User Guide and Training Videos located in the Support link on the website for instructions on how to activate and re-certify your users. </p>
          <p>
  </p>
          <p>
            <ul>attorney@quandis.com | </ul>
          </p>
          <p>
  </p>
          <p>Thank you.</p>
        </div>
      </BodyHTML>
  <MessageTemplateID>1210</MessageTemplateID>
  <ParentMessageID>
  </ParentMessageID>
  <Object>Person</Object>
  <ObjectID>483</ObjectID>
  <Status>
  </Status>
  <CreatedPersonID>17</CreatedPersonID>
  <CreatedDate>2014-03-06T10:11:52.52-08:00</CreatedDate>
  <UpdatedPersonID>17</UpdatedPersonID>
  <UpdatedDate>2014-03-06T10:11:52.52-08:00</UpdatedDate>
  <FromContact>
  </FromContact>
  <MessageTemplate>Security Admin - Failed Certify Deactivate</MessageTemplate>
  <CreatedPerson>mbowerbank@quandis.com</CreatedPerson>
  <UpdatedPerson>mbowerbank@quandis.com</UpdatedPerson>
  <RecordCount>500</RecordCount>
  <RecipientCount>2</RecipientCount>
</MessageItem>
<MessageItem>
  <MessageID>1279687</MessageID>
  <Message>**URGENT** System Users Deactivated</Message>
  <MessageType>
  </MessageType>
  <Priority>
  </Priority>
  <SecureDelivery>
  </SecureDelivery>
  <FromAddress>
  </FromAddress>
  <FromName>
  </FromName>
  <FromContactID>
  </FromContactID>
  <DateAdded>
  </DateAdded>
  <BodyText>
  </BodyText>
  <BodyHTML>
        <div>
          <p>Dear Test Attorney,</p>
          <p>The following user accounts were deactivated due to lack of following re-certification guidelines.  If any of these accounts should remain active, you will need to log into the system, reactivate them, and re-certify them.  Please refer to the User Guide and Training Videos located in the Support link on the website for instructions on how to activate and re-certify your users. </p>
          <p>
</p>
          <p>
            <ul>attorney@quandis.com | </ul>
          </p>
          <p>
</p>
          <p>Thank you.</p>
        </div>
      </BodyHTML>
<MessageTemplateID>1210</MessageTemplateID>
<ParentMessageID>
</ParentMessageID>
<Object>Person</Object>
<ObjectID>483</ObjectID>
<Status>
</Status>
<CreatedPersonID>17</CreatedPersonID>
<CreatedDate>2014-03-06T10:13:22.44-08:00</CreatedDate>
<UpdatedPersonID>17</UpdatedPersonID>
<UpdatedDate>2014-03-06T10:13:22.44-08:00</UpdatedDate>
<FromContact>
</FromContact>
<MessageTemplate>Security Admin - Failed Certify Deactivate</MessageTemplate>
<CreatedPerson>mbowerbank@quandis.com</CreatedPerson>
<UpdatedPerson>mbowerbank@quandis.com</UpdatedPerson>
<RecordCount>500</RecordCount>
<RecipientCount>2</RecipientCount>
</MessageItem>
</MessageCollection>

Message/Message.ashx/Save?{Parameters}

The save method will return all records matching the {Parameters} criteria. {Parameters} may include any property listed in the table above along with child classes.

• Output: determines the formatting of the returned data. Valid values are Xml, Json, JsonP.
• Response: included in the response is {Table}ID; this is the primary key of the {Table} row created
• With the same Save method, you can also save data to related tables. By using a {Parent}_{Column} pattern, you can update the parent table's data in the same call.
• Child records may also be updated using a {Child}_{Index}_{Column} pattern.
• For child records that are templated, you may use the template name in lieu of an index.

Message/Message.ashx/Delete?ID={Where.IdList}

The delete method will delete all records where ID={comma-delimited list of identifiers} criteria.

Message/Message.ashx/ListWhere?{Parameters}

The ListWhere method will return all records matching the {Parameters} criteria. {Parameters} may include any property listed in the table.

• Output: determines the formatting of the returned data. Valid values are Xml, Json, JsonP.
• Response: 2 columns are returned - {Table}ID and {Table} columns.
• Request: Message.ashx/ListWhere?MessageID=1,2,3
• Response:

<MessageCollection>
  <MessageItem>
    <MessageID>1</MessageID>
    <Message>New Hold Added for Bankruptcy Ch 7</Message>
  </MessageItem>
  <MessageItem>
    <MessageID>2</MessageID>
    <Message>Case Review</Message>
  </MessageItem>
  <MessageItem>
    <MessageID>3</MessageID>
    <Message>Case Closure</Message>
  </MessageItem>
</MessageCollection>