Eviction Class - quandis/qbo3-Documentation GitHub Wiki

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

Eviction properties

Column Type Required Description
Active string
ActiveStatus string
ActiveWorkflow string
AssignedOrganizationID integer
AssignedPersonID integer
Batch integer
BecamePastStandard string
CanDelete string
CanInsert string
CanUpdate string
ClientID integer
ClientPersonID integer
Closed string
ClosedReason string
CostLedgerID integer
CourtCaseNumber string
CreatedDate dateTime
CreatedPersonID integer
CurrentDecisionID integer
DateClosed dateTime
DateDue dateTime
DateOpened dateTime
DecisionStep string
DecisionTemplate string
Entity string
EntityParent string
Eviction string yes Label for the table.
EvictionID integer yes Identity column and primary key for the table.
ExcludePendingSteps string
Extranet string
FinalStatus string
Form string
InDecisionID string
InImportFileID string
LinkedFrom string
LinkedTo string
LitigationDelays string
LoanState string
MetaXml string Deprecated
NonCompliant string
NotLinkedFrom string
NotLinkedTo string
Object string
ObjectID integer
OccupancyStatus string
Open string
OpenAsOf string
OpenedReason string
OtherDelays string
PastStandardInflow string
PastStandardOutflow string
PlaintiffContactID integer
Priority integer
Process string
ProcessID integer
ProcessSiblingList string
ProcessTemplateID integer
ProcessType string
PropertyID integer
PropertyState string
RealtorContactID integer
ServicerID string
Sibling string
SiblingID integer
SourceXml string Deprecated
State string
Status string
Step string
StepExists string
Tags string
TimeSpan string
UnreadNotifications string
UpdatedDate dateTime
UpdatedPersonID integer
VendorID integer
VendorPersonID integer
ViewAsRole string
Worklist string

Related modules

Related Objects Module Relationship
Access Child
AssignedOrganization qbo.Contact.OrganizationObject Foreign Key
AssignedPerson qbo.Security.PersonObject Foreign Key
Attachments Attachment Child
Client qbo.Contact.OrganizationObject Foreign Key
ClientPerson qbo.Security.PersonObject Foreign Key
Collections CollectionMember Child
ConfigurationEntryCollection ConfigurationEntry Child
Contacts Contact Child
CostLedger qbo.Accounting.LedgerObject Foreign Key
CurrentDecision qbo.Decision.DecisionObject Foreign Key
Decisions Decision Child
Delays DecisionDelay Child
Forms ImportForm Child
Labels CollectionMember Child
Ledgers Ledger Child
Messages Message Child
PlaintiffContact qbo.Contact.ContactObject Foreign Key
ProcessTemplate qbo.Process.ProcessTemplateObject Foreign Key
Property qbo.Mortgage.PropertyObject Foreign Key
RealtorContact qbo.Contact.ContactObject Foreign Key
Regions Geography Child
Scores Score Child
SearchIndexes SearchIndex Child
Vendor qbo.Contact.OrganizationObject Foreign Key
VendorPerson qbo.Security.PersonObject Foreign Key
Worklists SmartWorklistMember Child

Method signatures

Mortgage/Eviction.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 Eviction.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: Eviction.ashx/Search?Eviction=ABC123
  • Response:
<EvictionCollection>
  <EvictionItem>
    <EvictionID>3</EvictionID>
    <Eviction>
      <<Auto>>
    </Eviction>
    <OccupancyStatus>
    </OccupancyStatus>
    <PropertyID>804677</PropertyID>
    <CourtCaseNumber>
    </CourtCaseNumber>
    <PlaintiffContactID>
    </PlaintiffContactID>
    <RealtorContactID>
    </RealtorContactID>
    <ProcessID>1836</ProcessID>
    <Process>
      <<Auto>>
    </Process>
    <ProcessTemplateID>
    </ProcessTemplateID>
    <Sibling>
    </Sibling>
    <SiblingID>191</SiblingID>
    <ProcessType>Tenant</ProcessType>
    <Priority>
    </Priority>
    <AssignedOrganizationID>
    </AssignedOrganizationID>
    <AssignedPersonID>
    </AssignedPersonID>
    <VendorID>
    </VendorID>
    <VendorPersonID>
    </VendorPersonID>
    <DateOpened>2013-04-10T00:00:00-07:00</DateOpened>
    <OpenedReason>
    </OpenedReason>
    <DateClosed>
    </DateClosed>
    <ClosedReason>
    </ClosedReason>
    <DateDue>
    </DateDue>
    <CostLedgerID>
    </CostLedgerID>
    <CurrentDecisionID>
    </CurrentDecisionID>
    <SourceXml>
    </SourceXml>
    <MetaXml>
    </MetaXml>
    <ClientID>
    </ClientID>
    <ClientPersonID>
    </ClientPersonID>
    <Object>Loan</Object>
    <ObjectID>725611</ObjectID>
    <Status>Open</Status>
    <CreatedPersonID>486</CreatedPersonID>
    <CreatedDate>2013-04-10T12:38:05.887-07:00</CreatedDate>
    <UpdatedPersonID>
    </UpdatedPersonID>
    <UpdatedDate>
    </UpdatedDate>
    <Address>13 LAMP POST DRIVE</Address>
    <City>CHILI</City>
    <State>NY</State>
    <PostalCode>14624</PostalCode>
    <Property>13 LAMP POST DRIVE</Property>
    <PlaintiffContact>
    </PlaintiffContact>
    <RealtorContact>
    </RealtorContact>
    <ProcessTemplate>
    </ProcessTemplate>
    <AssignedOrganization>
    </AssignedOrganization>
    <AssignedPerson>
    </AssignedPerson>
    <Vendor>
    </Vendor>
    <VendorPerson>
    </VendorPerson>
    <CostLedger>
    </CostLedger>
    <CurrentDecision>
    </CurrentDecision>
    <Client>
    </Client>
    <ClientPerson>
    </ClientPerson>
    <CreatedPerson>[email protected]</CreatedPerson>
    <UpdatedPerson>
    </UpdatedPerson>
    <RecordCount>1</RecordCount>
  </EvictionItem>
</EvictionCollection>

Mortgage/Eviction.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/Eviction.ashx/Delete?ID={Where.IdList}

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

Mortgage/Eviction.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: Eviction.ashx/ListWhere?EvictionID=1,2,3
  • Response:
<EvictionCollection>
  <EvictionItem>
    <EvictionID>3</EvictionID>
    <Eviction>EV-123454</Eviction>
  </EvictionItem>
  <EvictionItem>
    <EvictionID>2</EvictionID>
    <Eviction>123d1243</Eviction>
  </EvictionItem>
</EvictionCollection>
⚠️ **GitHub.com Fallback** ⚠️