PublicRecord Class - quandis/qbo3-Documentation GitHub Wiki

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

PublicRecord properties

Column Type Required Description
Active string
ActiveStatus string
AttorneyContactID integer
AttorneyPublicRecord string
AuctionAmount double
AuctionBuyerID integer
AuctionComplete dateTime
AuctionContactID integer
AuctionDate dateTime
AuctionSellerID integer
BalanceAmount double
Batch integer
BookPage string
CanDelete string
CanInsert string
CanUpdate string
CourtID integer
CreatedDate dateTime
CreatedPersonID integer
DefaultAmount double
DefaultDate dateTime
DefendantContactID integer
Description string
DocketNumber string
DocumentNumber string
Extranet string
FilingDate dateTime
FinalStatus string
Form string
InDecisionID string
InImportFileID string
LinkedFrom string
LinkedTo string
MetaXml string Deprecated
Notes string
NotLinkedFrom string
NotLinkedTo string
Object string
ObjectID integer
OriginalAmount double
OriginationDate dateTime
ParentPublicRecordID integer
PlaintiffCurrentID integer
PlaintiffPreviousID integer
PublicRecord string yes Label for the table.
PublicRecordID integer yes Identity column and primary key for the table.
PublicRecordType string Enumerated values; set by power user in ObjectType table.
RecordingDate dateTime
Source string
SourceXML string
Status string
Tags string
UnreadNotifications string
UpdatedDate dateTime
UpdatedPersonID integer
VestingDescription string
ViewAsRole string
Worklist string

Related modules

Related Objects Module Relationship
Access Child
Attachments Attachment Child
AttorneyContact qbo.Contact.ContactObject Foreign Key
AuctionBuyer qbo.Contact.ContactObject Foreign Key
AuctionContact qbo.Contact.ContactObject Foreign Key
AuctionSeller qbo.Contact.ContactObject Foreign Key
Collections CollectionMember Child
ConfigurationEntryCollection ConfigurationEntry Child
Contacts Contact Child
Court qbo.Contact.CourtObject Foreign Key
Decisions Decision Child
DefendantContact qbo.Contact.ContactObject Foreign Key
Forms ImportForm Child
Labels CollectionMember Child
Ledgers Ledger Child
Messages Message Child
PlaintiffCurrent qbo.Contact.ContactObject Foreign Key
PlaintiffPrevious qbo.Contact.ContactObject Foreign Key
Regions Geography Child
Scores Score Child
SearchIndexes SearchIndex Child
Worklists SmartWorklistMember Child

Method signatures

Mortgage/PublicRecord.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 PublicRecord.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: PublicRecord.ashx/Search?PublicRecord=ABC123
  • Response:
<PublicRecordCollection>
  <PublicRecordItem>
    <PublicRecordID>1</PublicRecordID>
    <PublicRecord>abc</PublicRecord>
    <DefendantContactID>
    </DefendantContactID>
    <ParentPublicRecordID>
    </ParentPublicRecordID>
    <PublicRecordType>
    </PublicRecordType>
    <Source>
    </Source>
    <CourtID>34</CourtID>
    <DocketNumber>
    </DocketNumber>
    <Description>
    </Description>
    <FilingDate>
    </FilingDate>
    <RecordingDate>
    </RecordingDate>
    <BookPage>
    </BookPage>
    <PlaintiffPreviousID>
    </PlaintiffPreviousID>
    <PlaintiffCurrentID>
    </PlaintiffCurrentID>
    <AttorneyContactID>
    </AttorneyContactID>
    <AttorneyPublicRecord>
    </AttorneyPublicRecord>
    <VestingDescription>
    </VestingDescription>
    <OriginalAmount>
    </OriginalAmount>
    <OriginationDate>
    </OriginationDate>
    <BalanceAmount>
    </BalanceAmount>
    <DefaultAmount>
    </DefaultAmount>
    <DefaultDate>
    </DefaultDate>
    <AuctionDate>
    </AuctionDate>
    <AuctionContactID>
    </AuctionContactID>
    <AuctionAmount>
    </AuctionAmount>
    <AuctionComplete>
    </AuctionComplete>
    <AuctionSellerID>
    </AuctionSellerID>
    <AuctionBuyerID>
    </AuctionBuyerID>
    <SourceXML>
    </SourceXML>
    <MetaXml>
    </MetaXml>
    <DocumentNumber>
    </DocumentNumber>
    <Notes>
    </Notes>
    <Object>
    </Object>
    <ObjectID>
    </ObjectID>
    <Status>
    </Status>
    <CreatedPersonID>26</CreatedPersonID>
    <CreatedDate>2017-06-20T09:23:31.02-07:00</CreatedDate>
    <UpdatedPersonID>26</UpdatedPersonID>
    <UpdatedDate>2017-09-07T13:34:19.467-07:00</UpdatedDate>
    <DefendantContact>
    </DefendantContact>
    <ParentPublicRecord>
    </ParentPublicRecord>
    <Court>Iowa Northern Bankruptcy Court</Court>
    <PlaintiffPrevious>
    </PlaintiffPrevious>
    <PlaintiffCurrent>
    </PlaintiffCurrent>
    <AttorneyContact>
    </AttorneyContact>
    <AuctionContact>
    </AuctionContact>
    <AuctionSeller>
    </AuctionSeller>
    <AuctionBuyer>
    </AuctionBuyer>
    <CreatedPerson>[email protected]</CreatedPerson>
    <UpdatedPerson>[email protected]</UpdatedPerson>
    <ParentLabel>
    </ParentLabel>
    <Grandparent>
    </Grandparent>
    <GrandparentID>
    </GrandparentID>
    <RecordCount>11</RecordCount>
  </PublicRecordItem>
  <PublicRecordItem>
    <PublicRecordID>3</PublicRecordID>
    <PublicRecord>abc</PublicRecord>
    <DefendantContactID>1771</DefendantContactID>
    <ParentPublicRecordID>
    </ParentPublicRecordID>
    <PublicRecordType>
    </PublicRecordType>
    <Source>
    </Source>
    <CourtID>
    </CourtID>
    <DocketNumber>
    </DocketNumber>
    <Description>
    </Description>
    <FilingDate>
    </FilingDate>
    <RecordingDate>
    </RecordingDate>
    <BookPage>
    </BookPage>
    <PlaintiffPreviousID>1772</PlaintiffPreviousID>
    <PlaintiffCurrentID>1773</PlaintiffCurrentID>
    <AttorneyContactID>1774</AttorneyContactID>
    <AttorneyPublicRecord>
    </AttorneyPublicRecord>
    <VestingDescription>
    </VestingDescription>
    <OriginalAmount>
    </OriginalAmount>
    <OriginationDate>
    </OriginationDate>
    <BalanceAmount>
    </BalanceAmount>
    <DefaultAmount>
    </DefaultAmount>
    <DefaultDate>
    </DefaultDate>
    <AuctionDate>
    </AuctionDate>
    <AuctionContactID>1775</AuctionContactID>
    <AuctionAmount>
    </AuctionAmount>
    <AuctionComplete>
    </AuctionComplete>
    <AuctionSellerID>1776</AuctionSellerID>
    <AuctionBuyerID>1777</AuctionBuyerID>
    <SourceXML>
    </SourceXML>
    <MetaXml>
    </MetaXml>
    <DocumentNumber>
    </DocumentNumber>
    <Notes>
    </Notes>
    <Object>
    </Object>
    <ObjectID>
    </ObjectID>
    <Status>
    </Status>
    <CreatedPersonID>26</CreatedPersonID>
    <CreatedDate>2017-06-20T10:13:39.72-07:00</CreatedDate>
    <UpdatedPersonID>26</UpdatedPersonID>
    <UpdatedDate>2017-06-20T10:24:44.67-07:00</UpdatedDate>
    <DefendantContact>1</DefendantContact>
    <ParentPublicRecord>
    </ParentPublicRecord>
    <Court>
    </Court>
    <PlaintiffPrevious>2</PlaintiffPrevious>
    <PlaintiffCurrent>3</PlaintiffCurrent>
    <AttorneyContact>4</AttorneyContact>
    <AuctionContact>5</AuctionContact>
    <AuctionSeller>6</AuctionSeller>
    <AuctionBuyer>7</AuctionBuyer>
    <CreatedPerson>[email protected]</CreatedPerson>
    <UpdatedPerson>[email protected]</UpdatedPerson>
    <ParentLabel>
    </ParentLabel>
    <Grandparent>
    </Grandparent>
    <GrandparentID>
    </GrandparentID>
    <RecordCount>11</RecordCount>
  </PublicRecordItem>
</PublicRecordCollection>

Mortgage/PublicRecord.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.

Mortgage/PublicRecord.ashx/Delete?ID={Where.IdList}

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

Mortgage/PublicRecord.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: PublicRecord.ashx/ListWhere?PublicRecordID=1,2,3
  • Response:
<PublicRecordCollection>
  <PublicRecordItem>
    <PublicRecordID>1</PublicRecordID>
    <PublicRecord>abc</PublicRecord>
  </PublicRecordItem>
  <PublicRecordItem>
    <PublicRecordID>3</PublicRecordID>
    <PublicRecord>abc</PublicRecord>
  </PublicRecordItem>
</PublicRecordCollection>
⚠️ **GitHub.com Fallback** ⚠️