AppExchange Service

WSDL     API Documentation     Getting Started     AppExchange Batch Exports     SLA

Overview

AppExchange Service provides rent and availability information on units by floor plan and property.

Permitted Uses & Restrictions

AppExchange Service is not intended for batch processing and should be called only when presenting price to a prospective resident. Only relevant data should be stored.

Typical Use Case

Operations

getProperties

Description – This operation returns all property information for the specified client.
Input – This operation requires a client name. A fault will be returned if the client name does not exist or you do not have access to it.
Output – This operation returns common property information about every property for this client.

getProperty

Description – This operation returns a specific requested property.
Input – This operation requires a client name and a property ID. A fault will be returned if either piece of information is not present or invalid.
Output – This operation returns the requested property information.

getPropertyParameters

Description – This operation obtains pricing parameters for a specific property.
Input – This operation requires a client name and a property ID. A fault will be returned if either piece of information is not present or invalid.
Output – This operation returns the requested property’s pricing parameters.

getFloorPlans

Description – This operation returns all floor plans for the specified property.
Input – This operation requires a client name and a property ID. A fault will be returned if either piece of information is not present or invalid.
Output – This operation returns common floor plan information about every floor plan for this property.

getFloorPlan

Description – This operation returns a specific requested floor plan.
Input – This operation requires a client name, a property ID, and a floor plan name. A fault will be returned if any piece of information is not present or invalid.
Output – This operation returns the requested floor plan information.

getUnits

Description – This operation returns all units for the specified property. They can be filtered by floor plan.
Input – This operation requires a client name and a property ID. A fault will be returned if either piece of information is not present or invalid. Optionally, a floor plan name can be provided to obtain more targeted results.
Output – This operation returns common unit information about every unit in a property or floor plan (if specified).

getUnit

Description – This operation returns a specific requested unit.
Input – This operation requires a client name, a property ID, and a unit name. A fault will be returned if either piece of information is not present or invalid. Optionally, a building can be provided if necessary.
Output – This operation returns common the requested unit information.

getFloorPlanAmenities

Description – This operation returns all amenities applicable to the specified floor plan.
Input – This operation requires a client name, property ID, and floor plan name. If any of them are not specified or are invalid a fault will be returned.
Output – This operation returns amenity names and values applicable to this floor plan.

getUnitAmenities

Description – This operation returns all amenities applicable to the specified unit.
Input – This operation requires a client name, property ID, and unit name. If any of them are not specified or are invalid a fault will be returned. Optionally, a building can be provided if the unit name is ambiguous across buildings.
Output – This operation returns amenity names and values applicable to this unit.

getRentSummary

Description – This operation provides high level rent information for all currently available floor plans within the property.
Input – This operation requires a client name and a property ID. A fault will be returned if either piece of information is not present or invalid.
Output – This operation returns common rent information for the specified property.

getAvailableUnits

Description – This operation provides current status, 12-month rents, and best price terms and rents, for all current available units within the property.
Input – This operation requires a client name and a property ID. A fault will be returned if either piece of information is not present or invalid.
Output – This operation returns unit availability information for the specified property.

getLeaseTermRent

Description – This operation returns a matrix providing the specific rate for each combination of lease term and move-in date for a given unit.
Input – This operation requires a client name, property ID, building, and unit number/name. A fault will be returned if any piece of information is not present or invalid. Optionally, a minimum and maximum lease term can be specified to limit the results. Also optionally, a first and last move in date can be specified to limit the date range.
Output – This operation returns a collection of rates for the given unit. The range of lease terms is either the client-specific bounds or the provided lease term bounds.

getLeaseTermRentQuoteId

Description – This operation returns a matrix providing the specific rate for each combination of lease term and move-in date for a given unit plus a quote ID
Input – This operation is identical to the getLeaseTermRent above but the response adds a quote ID. This operation requires a client name, property ID, building, and unit number/name. A fault will be returned if any piece of information is not present or invalid. Optionally, a minimum and maximum lease term can be specified to limit the results. Also optionally, a first and last move in date can be specified to limit the date range.
Output – This operation returns a collection of rates for the given unit. The range of lease terms is either the client-specific bounds or the provided lease term bounds plus a quote ID

getLeaseTermRentPlus

Description – This operation is identical to the getLeaseTermRent above but the response adds the last date for which the price is valid. This operation returns a matrix providing the specific rate for each combination of lease term and move-in date for a given unit.
Input – This operation requires a client name, property ID, building, and unit number/name. A fault will be returned if any piece of information is not present or invalid. Optionally, a minimum and maximum lease term can be specified to limit the results. Also optionally, a first and last move in date can be specified to limit the date range.
Output – This operation returns a collection of rates for the given unit. The range of lease terms is either the client-specific bounds or the provided lease term bounds.

getRenewalLeaseTermRent

Description – This operation provides units that are within “Renewal Notice Days” of lease expiration, and those units for which renewal rates have been manually generated and accepted.
Input – This operation requires a client name, property ID, building, and unit number/name. A fault will be returned if any piece of information is not present or invalid. Optionally, a start date can be specified.
Output – This operation returns a collection of renewal rates for the given unit. Renewal Start date is returned in the output only if it was passed in as input.

getRenewalLeaseTermRentQuoteId

Description – This operation is identical to the getRenewalLeaseTermRent above but the response adds a quote ID. This operation provides units that are within “Renewal Notice Days” of lease expiration, and those units for which renewal rates have been manually generated and accepted.
Input – This operation requires a client name, property ID, building, and unit number/name. A fault will be returned if any piece of information is not present or invalid. Optionally, a start date can be specified.
Output – This operation returns a collection of renewal rates for the given unit plus a quote ID. Renewal Start date is returned in the output only if it was passed in as input.

saveRentsQuoteId

Description – This operation is called when third party system uses a rent from a matrix with associated YsQuoteId in a quote or renewal offer.
Input – This operation requires a client name, a quote ID, lease term, lease start date, quote or offer expriration date and rate type - (N) New Lease or (R) Renewal. A fault will be returned if any piece of information is not present or invalid.
Output – This operation returns a collection of results if multiple quote IDs are requested to be saved. Result contains YsQuoteId requested and outcome of the transaction. Outcome is presented as a string and can have potential values - Success or No approved renewals.

setUnitAvailability

Description – This operation provides the ability to update a unit’s availability. Note, this may be overridden with nightly data.
Input – This operation requires a client name, property ID, building, unit number/name, and an availability boolean. A fault will be returned if any piece of information is not present or invalid.
Output – None

setUnitAmenities

Description – This operation provides the ability to update one or more unit amenities. Note, this may be overridden with nightly data.
Input – This operation requires a client name, property ID, building, unit number/name, pms Amenity Code, amenity name, and amenity Change Type (insert/update/delete). A fault will be returned if any piece of information is not present or invalid.
Output – None