Listing Class - quandis/qbo3-Documentation GitHub Wiki

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

Listing properties

Column Type Required Description
Active string
ActiveStatus string
AssignedOrganizationID integer
AssignedPersonID integer
Batch integer
BidIncrement double
BidMinimum double
BrokerBonusFlatRate double
BrokerBonusPercentage double
BrokerCommissionFlatRate double
BrokerCommissionPercentage double
BrokerCost double
BuyerType string
CanDelete string
CanInsert string
CanUpdate string
Comments string
CompletedDate dateTime
CreatedDate dateTime
CreatedPersonID integer
DepositAmount double
DepositType string
DueDate dateTime
EndDate dateTime
EscrowAmount double
Extranet string
FinalStatus string
Form string
InDecisionID string
InImportFileID string
LinkedFrom string
LinkedTo string
Listing string yes Label for the table.
ListingAmount double
ListingBrokerID integer
ListingID integer yes Identity column and primary key for the table.
ListingType string Enumerated values; set by power user in ObjectType table.
ListingURL string
LockboxCode string
MetaXml string Deprecated
MLSReference string
NotLinkedFrom string
NotLinkedTo string
Object string
ObjectID integer
OrderedDate dateTime
OrderedPersonID integer
PropertyID integer
ReserveAmount double
ReviewedDate dateTime
ReviewedPersonID integer
SourceXml string Deprecated
StartDate dateTime
Status string
Tags string
Terms string
UnreadNotifications string
UpdatedDate dateTime
UpdatedPersonID 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
Collections CollectionMember Child
ConfigurationEntryCollection ConfigurationEntry Child
Contacts Contact Child
Decisions Decision Child
Forms ImportForm Child
Labels CollectionMember Child
Ledgers Ledger Child
ListingBroker qbo.Contact.ContactObject Foreign Key
Messages Message Child
OrderedPerson qbo.Security.PersonObject Foreign Key
Property qbo.Mortgage.PropertyObject Foreign Key
Regions Geography Child
ReviewedPerson qbo.Security.PersonObject Foreign Key
Scores Score Child
SearchIndexes SearchIndex Child
Worklists SmartWorklistMember Child

Method signatures

Mortgage/Listing.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 Listing.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: Listing.ashx/Search?Listing=ABC123
  • Response:
<ListingCollection>
  <ListingItem>
    <ListingID>1</ListingID>
    <Listing>abc</Listing>
    <PropertyID>743</PropertyID>
    <ListingType>
    </ListingType>
    <MLSReference>
    </MLSReference>
    <ListingURL>
    </ListingURL>
    <ListingBrokerID>
    </ListingBrokerID>
    <BuyerType>
    </BuyerType>
    <BrokerCost>
    </BrokerCost>
    <ListingAmount>
    </ListingAmount>
    <EscrowAmount>
    </EscrowAmount>
    <StartDate>2017-06-15T00:00:00-07:00</StartDate>
    <EndDate>2017-06-30T00:00:00-07:00</EndDate>
    <OrderedDate>
    </OrderedDate>
    <OrderedPersonID>
    </OrderedPersonID>
    <DueDate>
    </DueDate>
    <CompletedDate>
    </CompletedDate>
    <ReviewedDate>
    </ReviewedDate>
    <ReviewedPersonID>
    </ReviewedPersonID>
    <Comments>
    </Comments>
    <BrokerCommissionPercentage>
    </BrokerCommissionPercentage>
    <BrokerCommissionFlatRate>
    </BrokerCommissionFlatRate>
    <BrokerBonusPercentage>
    </BrokerBonusPercentage>
    <BrokerBonusFlatRate>
    </BrokerBonusFlatRate>
    <Terms>
    </Terms>
    <AssignedOrganizationID>
    </AssignedOrganizationID>
    <AssignedPersonID>
    </AssignedPersonID>
    <SourceXml>
    </SourceXml>
    <MetaXml>
    </MetaXml>
    <LockboxCode>
    </LockboxCode>
    <ReserveAmount>
    </ReserveAmount>
    <BidMinimum>
    </BidMinimum>
    <BidIncrement>
    </BidIncrement>
    <DepositAmount>
    </DepositAmount>
    <DepositType>
    </DepositType>
    <Object>Property</Object>
    <ObjectID>743</ObjectID>
    <Status>
    </Status>
    <CreatedPersonID>26</CreatedPersonID>
    <CreatedDate>2017-06-15T11:09:36.217-07:00</CreatedDate>
    <UpdatedPersonID>26</UpdatedPersonID>
    <UpdatedDate>2017-06-15T11:09:36.217-07:00</UpdatedDate>
    <Address>100 N WILLOW AVENUE</Address>
    <City>TRUMANN</City>
    <State>AR</State>
    <PostalCode>72472</PostalCode>
    <Property>100 N WILLOW AVENUE</Property>
    <ListingBroker>
    </ListingBroker>
    <OrderedPerson>
    </OrderedPerson>
    <ReviewedPerson>
    </ReviewedPerson>
    <AssignedOrganization>
    </AssignedOrganization>
    <AssignedPerson>
    </AssignedPerson>
    <CreatedPerson>[email protected]</CreatedPerson>
    <UpdatedPerson>[email protected]</UpdatedPerson>
    <ParentLabel>100 N WILLOW AVENUE</ParentLabel>
    <Grandparent>
    </Grandparent>
    <GrandparentID>
    </GrandparentID>
    <RecordCount>1</RecordCount>
    <Address1>100 N WILLOW AVENUE</Address1>
    <City1>TRUMANN</City1>
    <State1>AR</State1>
    <PostalCode1>72472</PostalCode1>
  </ListingItem>
</ListingCollection>

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

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

Mortgage/Listing.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: Listing.ashx/ListWhere?ListingID=1,2,3
  • Response:
<ListingCollection>
  <ListingItem>
    <ListingID>1</ListingID>
    <Listing>abc</Listing>
  </ListingItem>
</ListingCollection>
⚠️ **GitHub.com Fallback** ⚠️