Reo Class - quandis/qbo3-Documentation GitHub Wiki
The Mortgage module's Reo table is based on the MISMO data dictionary standard.
Column | Type | Required | Description |
---|---|---|---|
Active | string | ||
ActiveStatus | string | ||
ActiveWorkflow | string | ||
AssignedOrganizationID | integer | ||
AssignedPersonID | integer | ||
Batch | integer | ||
BidIncrement | double | ||
BidMinimum | double | ||
BuyerBrokerID | integer | ||
BuyerContactID | integer | ||
CanDelete | string | ||
CanInsert | string | ||
CanUpdate | string | ||
ClientID | integer | ||
ClientPersonID | integer | ||
Closed | string | ||
ClosedReason | string | ||
ClosingCompanyID | integer | ||
CostLedgerID | integer | ||
CreatedDate | dateTime | ||
CreatedPersonID | integer | ||
CurrentDecisionID | integer | ||
DateClosed | dateTime | ||
DateDue | dateTime | ||
DateOpened | dateTime | ||
DecisionStep | string | ||
DepositAmount | double | ||
DepositType | string | ||
Entity | string | ||
EntityParent | string | ||
EstimatedSaleDate | dateTime | ||
Extranet | string | ||
FieldServicesNeeded | string | ||
FinalStatus | string | ||
Form | string | ||
InDecisionID | string | ||
InImportFileID | string | ||
InsuredAsOf | dateTime | ||
LinkedFrom | string | ||
LinkedTo | string | ||
ListedDate | dateTime | ||
ListingAmount | double | ||
ListingBrokerID | integer | ||
ListingURL | string | ||
LockboxCode | string | ||
MetaXml | string | Deprecated | |
MidValuationAmount | double | ||
NetProceeds | double | ||
NotLinkedFrom | string | ||
NotLinkedTo | string | ||
Object | string | ||
ObjectID | integer | ||
OnHold | string | ||
Open | string | ||
OpenAsOf | string | ||
OpenedReason | string | ||
Priority | integer | ||
Process | string | ||
ProcessID | integer | ||
ProcessTemplateID | integer | ||
ProcessType | string | ||
PropertyID | integer | ||
PropertyManagementID | integer | ||
PropertyOwnerID | integer | ||
Reo | string | yes | Label for the table. |
ReoID | integer | yes | Identity column and primary key for the table. |
ReserveAmount | double | ||
SaleDate | dateTime | ||
SaleDateType | string | ||
SalePrice | double | ||
SellingBrokerID | integer | ||
Sibling | string | ||
SiblingID | integer | ||
SourceXml | string | Deprecated | |
State | string | ||
Status | string | ||
Strategy | string | ||
Tags | string | ||
TaxesDue | double | ||
TaxesDueDate | dateTime | ||
TitleCompanyID | integer | ||
UnreadNotifications | string | ||
UpdatedDate | dateTime | ||
UpdatedPersonID | integer | ||
VendorID | integer | ||
VendorPersonID | integer | ||
ViewAsRole | string | ||
Worklist | string |
Related Objects | Module | Relationship |
---|---|---|
Access | Child | |
AssignedOrganization | qbo.Contact.OrganizationObject | Foreign Key |
AssignedPerson | qbo.Security.PersonObject | Foreign Key |
Attachments | Attachment | Child |
BuyerBroker | qbo.Mortgage.BrokerObject | Foreign Key |
BuyerContact | qbo.Contact.ContactObject | Foreign Key |
Client | qbo.Contact.OrganizationObject | Foreign Key |
ClientPerson | qbo.Security.PersonObject | Foreign Key |
ClosingCompany | qbo.Contact.OrganizationObject | 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 |
ListingBroker | qbo.Mortgage.BrokerObject | Foreign Key |
Messages | Message | Child |
ProcessTemplate | qbo.Process.ProcessTemplateObject | Foreign Key |
Property | qbo.Mortgage.PropertyObject | Foreign Key |
PropertyOwner | qbo.Contact.OrganizationObject | Foreign Key |
Regions | Geography | Child |
Scores | Score | Child |
SearchIndexes | SearchIndex | Child |
SellingBroker | qbo.Mortgage.BrokerObject | Foreign Key |
TitleCompany | qbo.Contact.OrganizationObject | Foreign Key |
Vendor | qbo.Contact.OrganizationObject | Foreign Key |
VendorPerson | qbo.Security.PersonObject | Foreign Key |
Worklists | SmartWorklistMember | Child |
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 theReo.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:
Reo.ashx/Search?Reo=ABC123
- Response:
<ReoCollection>
<ReoItem>
<ReoID>4</ReoID>
<Reo>1000537952</Reo>
<PropertyID>805</PropertyID>
<ProcessID>515</ProcessID>
<SaleDate>
</SaleDate>
<SalePrice>
</SalePrice>
<ListingBrokerID>
</ListingBrokerID>
<SellingBrokerID>
</SellingBrokerID>
<BuyerBrokerID>
</BuyerBrokerID>
<BuyerContactID>
</BuyerContactID>
<ClosingCompanyID>
</ClosingCompanyID>
<LockboxCode>
</LockboxCode>
<ListingAmount>
</ListingAmount>
<ReserveAmount>
</ReserveAmount>
<BidMinimum>
</BidMinimum>
<BidIncrement>
</BidIncrement>
<DepositAmount>
</DepositAmount>
<TitleCompanyID>
</TitleCompanyID>
<PropertyOwnerID>
</PropertyOwnerID>
<ListingURL>
</ListingURL>
<DepositType>
</DepositType>
<Strategy>
</Strategy>
<TaxesDue>
</TaxesDue>
<TaxesDueDate>
</TaxesDueDate>
<InsuredAsOf>
</InsuredAsOf>
<ListedDate>
</ListedDate>
<PropertyManagementID>
</PropertyManagementID>
<FieldServicesNeeded>
</FieldServicesNeeded>
<MidValuationAmount>
</MidValuationAmount>
<NetProceeds>
</NetProceeds>
<EstimatedSaleDate>
</EstimatedSaleDate>
<SaleDateType>
</SaleDateType>
<Process>1000537952</Process>
<ProcessTemplateID>9</ProcessTemplateID>
<Sibling>Reo</Sibling>
<SiblingID>4</SiblingID>
<ProcessType>
</ProcessType>
<Priority>
</Priority>
<AssignedOrganizationID>423</AssignedOrganizationID>
<AssignedPersonID>
</AssignedPersonID>
<VendorID>
</VendorID>
<VendorPersonID>
</VendorPersonID>
<DateOpened>2017-06-01T00: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>Property</Object>
<ObjectID>809</ObjectID>
<Status>
</Status>
<CreatedPersonID>42</CreatedPersonID>
<CreatedDate>2017-06-15T08:42:13.683-07:00</CreatedDate>
<UpdatedPersonID>13</UpdatedPersonID>
<UpdatedDate>2017-06-15T11:20:49.653-07:00</UpdatedDate>
<Address>2220 COKEY RD</Address>
<City>Rocky Mount</City>
<State>NC</State>
<PostalCode>27801</PostalCode>
<Property>2220 COKEY RD</Property>
<ListingBroker>
</ListingBroker>
<SellingBroker>
</SellingBroker>
<BuyerBroker>
</BuyerBroker>
<BuyerContact>
</BuyerContact>
<ClosingCompany>
</ClosingCompany>
<TitleCompany>
</TitleCompany>
<PropertyOwner>
</PropertyOwner>
<ProcessTemplate>REO</ProcessTemplate>
<AssignedOrganization>Auction.com</AssignedOrganization>
<AssignedPerson>
</AssignedPerson>
<Vendor>
</Vendor>
<VendorPerson>
</VendorPerson>
<CostLedger>
</CostLedger>
<CurrentDecision>
</CurrentDecision>
<Client>
</Client>
<ClientPerson>
</ClientPerson>
<CreatedPerson>[email protected]</CreatedPerson>
<UpdatedPerson>[email protected]</UpdatedPerson>
<ParentLabel>2220 COKEY RD</ParentLabel>
<Grandparent>
</Grandparent>
<GrandparentID>
</GrandparentID>
<RecordCount>7</RecordCount>
<Address1>2220 COKEY RD</Address1>
<City1>Rocky Mount</City1>
<State1>NC</State1>
<PostalCode1>27801</PostalCode1>
</ReoItem>
<ReoItem>
<ReoID>7</ReoID>
<Reo>160832</Reo>
<PropertyID>808</PropertyID>
<ProcessID>518</ProcessID>
<SaleDate>
</SaleDate>
<SalePrice>
</SalePrice>
<ListingBrokerID>
</ListingBrokerID>
<SellingBrokerID>
</SellingBrokerID>
<BuyerBrokerID>
</BuyerBrokerID>
<BuyerContactID>
</BuyerContactID>
<ClosingCompanyID>
</ClosingCompanyID>
<LockboxCode>
</LockboxCode>
<ListingAmount>
</ListingAmount>
<ReserveAmount>
</ReserveAmount>
<BidMinimum>
</BidMinimum>
<BidIncrement>
</BidIncrement>
<DepositAmount>
</DepositAmount>
<TitleCompanyID>
</TitleCompanyID>
<PropertyOwnerID>
</PropertyOwnerID>
<ListingURL>
</ListingURL>
<DepositType>
</DepositType>
<Strategy>
</Strategy>
<TaxesDue>
</TaxesDue>
<TaxesDueDate>
</TaxesDueDate>
<InsuredAsOf>
</InsuredAsOf>
<ListedDate>
</ListedDate>
<PropertyManagementID>
</PropertyManagementID>
<FieldServicesNeeded>
</FieldServicesNeeded>
<MidValuationAmount>
</MidValuationAmount>
<NetProceeds>
</NetProceeds>
<EstimatedSaleDate>
</EstimatedSaleDate>
<SaleDateType>
</SaleDateType>
<Process>160832</Process>
<ProcessTemplateID>9</ProcessTemplateID>
<Sibling>Reo</Sibling>
<SiblingID>7</SiblingID>
<ProcessType>
</ProcessType>
<Priority>
</Priority>
<AssignedOrganizationID>423</AssignedOrganizationID>
<AssignedPersonID>
</AssignedPersonID>
<VendorID>
</VendorID>
<VendorPersonID>
</VendorPersonID>
<DateOpened>2017-04-20T00: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>Property</Object>
<ObjectID>810</ObjectID>
<Status>
</Status>
<CreatedPersonID>42</CreatedPersonID>
<CreatedDate>2017-06-15T08:51:11.887-07:00</CreatedDate>
<UpdatedPersonID>101</UpdatedPersonID>
<UpdatedDate>2017-06-15T13:52:21.38-07:00</UpdatedDate>
<Address>157 COUNTY RD 6816</Address>
<City>Natalia</City>
<State>TX</State>
<PostalCode>78059</PostalCode>
<Property>157 COUNTY RD 6816</Property>
<ListingBroker>
</ListingBroker>
<SellingBroker>
</SellingBroker>
<BuyerBroker>
</BuyerBroker>
<BuyerContact>
</BuyerContact>
<ClosingCompany>
</ClosingCompany>
<TitleCompany>
</TitleCompany>
<PropertyOwner>
</PropertyOwner>
<ProcessTemplate>REO</ProcessTemplate>
<AssignedOrganization>Auction.com</AssignedOrganization>
<AssignedPerson>
</AssignedPerson>
<Vendor>
</Vendor>
<VendorPerson>
</VendorPerson>
<CostLedger>
</CostLedger>
<CurrentDecision>
</CurrentDecision>
<Client>
</Client>
<ClientPerson>
</ClientPerson>
<CreatedPerson>[email protected]</CreatedPerson>
<UpdatedPerson>[email protected]</UpdatedPerson>
<ParentLabel>157 COUNTY RD 6816</ParentLabel>
<Grandparent>
</Grandparent>
<GrandparentID>
</GrandparentID>
<RecordCount>7</RecordCount>
<Address1>157 COUNTY RD 6816</Address1>
<City1>Natalia</City1>
<State1>TX</State1>
<PostalCode1>78059</PostalCode1>
</ReoItem>
</ReoCollection>
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.
The delete method will delete all records where ID={comma-delimited list of identifiers}
criteria.
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:
Reo.ashx/ListWhere?ReoID=1,2,3
- Response:
<ReoCollection>
<ReoItem>
<ReoID>3</ReoID>
<Reo>AAXYAGEVVE</Reo>
</ReoItem>
<ReoItem>
<ReoID>1</ReoID>
<Reo>test</Reo>
</ReoItem>
</ReoCollection>