| |||||||
| DETAILS: DOCUMENTATION | | FRAMES | NO FRAMES | ||||||
| Element Summary | |
| AuthenticationFault | This fault will occur when either the credentials are incorrect or the privileges for the provided user are incorrect. |
| getAvailableUnits | Available Units - This operation provides status, 12-month rents, and best price terms and rents, for all available units within the property as of the latest data feed received from the Property Management System. |
| getAvailableUnitsResponse | WSDL-friendly wrapper for availableUnitsResponse |
| getClientTBDLeasesResponse | This must return the number of TBD leases, within a specified number of horizon days. |
| getFloorPlan | Floor Plan - This operation returns a specific YieldStar floor plan for the specified property. |
| getFloorPlanAmenities | Floor Plan Amenities - This operation provides amenity information for a floor plan |
| getFloorPlanAmenitiesResponse | WSDL-friendly wrapper for floorPlanAmenitiesResponse |
| getFloorPlanParameters | FloorPlan Parameters - This operation provides floorPlan wise Parameters. |
| getFloorPlanParametersResponse | WSDL-friendly wrapper for floorPlanParametersResponse |
| getFloorPlanResponse | WSDL-friendly wrapper for floorPlanResponse |
| getFloorPlans | Floor Plans - This operation returns YieldStar floor plans for the specified property. |
| getFloorPlansResponse | WSDL-friendly wrapper for floorPlansResponse |
| getFullPropertyParameters | Property Parameters - This operation provides Unit Rent parameters for a given property in a more detail way. |
| getFullPropertyParametersResponse | WSDL-friendly wrapper for fullPropertyParametersResponse |
| getLeaseTermRent | This provides a matrix providing the specific rate for each combination of lease term and move-in date for a given unit. |
| getLeaseTermRentPlus | This provides a matrix providing the specific rate for each combination of lease term and move-in date for a given unit. |
| getLeaseTermRentPlusResponse | WSDL-friendly wrapper for leaseTermRentPlusResponse |
| getLeaseTermRentQuoteId | This provides a matrix providing the specific rate for each combination of lease term and move-in date for a given unit as well quote ID. |
| getLeaseTermRentQuoteIdResponse | WSDL-friendly wrapper for leaseTermRentQuoteIdResponse |
| getLeaseTermRentResponse | WSDL-friendly wrapper for leaseTermRentResponse |
| getPOModelData | This Operation provides properties Model Data including Sustainable occupancy and Seasonal expirations. |
| getPOModelDataResponse | This provides information like Average lease terms, Average renewal, Sustainable occupancy and Seasonal expirations for the properties. |
| getPoScreeningFloor | |
| getPoScreeningFloorReponse | |
| getProperties | Properties - This operation provides property information for all properties |
| getPropertiesResponse | WSDL-friendly wrapper for propertiesResponse |
| getProperty | Property - This operation provides property information for a given property |
| getPropertyParameters | Property Parameters - This operation provides pricing parameters for a given property |
| getPropertyParametersResponse | WSDL-friendly wrapper for propertyParametersResponse |
| getPropertyResponse | WSDL-friendly wrapper for propertyResponse |
| getRenewalLeaseTermRent | This provides units that are within Renewal Notice Days of lease expiration, and those units for which renewal rates have been manually generated and accepted. |
| getRenewalLeaseTermRentQuoteId | This provides units that are within Renewal Notice Days of lease expiration, and those units for which renewal rates have been manually generated and accepted. |
| getRenewalLeaseTermRentQuoteIdResponse | WSDL-friendly wrapper for renewalLeaseTermRentQuoteIdResponse |
| getRenewalLeaseTermRentResponse | WSDL-friendly wrapper for renewalLeaseTermRentResponse |
| getRentSummary | Rent Summary - This service provides high level rent information for all currently available floor plans within the property. |
| getRentSummaryResponse | WSDL-friendly wrapper for rentSummaryResponse |
| getTBDLeases | This must return the number of TBD leases, within a specified number of horizon days. |
| getUnit | Unit - This operation provides information for a given unit |
| getUnitAmenities | Unit Amenities - This operation provides amenity information for a unit |
| getUnitAmenitiesResponse | WSDL-friendly wrapper for unitAmenitiesResponse |
| getUnitResponse | WSDL-friendly wrapper for unitResponse |
| getUnits | Units - This operation provides unit information for a properties (or a specific floor plan) |
| getUnitsResponse | WSDL-friendly wrapper for unitsResponse |
| getUnitsWithStatus | Units - This operation provides unit information for a properties with its designation status (or a specific floor plan) |
| getUnitsWithStatusResponse | WSDL-friendly wrapper for unitsResponse |
| InternalErrorFault | This fault will occur for any unexpected internal error in the service. |
| OperationFault | This fault occurs if there is any expected error in the operation. |
| saveRentsQuoteId | This provides is called when third party system uses rent from a matrix with associated QuoteId in a quote or renewal offer. |
| saveRentsQuoteIdResponse | This provides is called when third party system uses rent from a matrix with associated QuoteId in a quote or renewal offer. |
| setUnitAmenities | Set Unit Amenity - This operations provides the ability to set a unit amenity values . |
| setUnitAmenitiesResponse | WSDL-friendly wrapper for void response |
| setUnitAvailability | Set Unit Availability - This operations provides the ability to set a unit as either available or unavailable. |
| setUnitAvailabilityResponse | WSDL-friendly wrapper for void response |
| Complex Type Summary | |
| amenity | This represents an amenity |
| availableUnitsFloorPlan | This represents a floor plan for available units. |
| availableUnitsRequest | This is the request to obtain the available units for the given property. |
| availableUnitsResponse | This represents the available units for the requested property. |
| availableUnitsUnit | |
| availableUnitsUnit.building | This is the building for the unit. |
| availableUnitsUnit.feature | This is a list of the unit amenities for the unit. |
| availableUnitsUnit.status | This is the availability status of the unit. |
| availableUnitsUnit.unitNumber | This is the unit number for the available unit from the property management system. |
| availableUnitsUnit.unitType | This is the unit type for the unit. |
| baseFault | This is the base fault for all possible faults in this service. |
| clientBasedRequest | This is the base request for all requests requiring a client name. |
| clientBasedRequest.clientName | This is the client name to perform the request for. |
| clientBasedResponse | This is the base response for all responses requiring a client name. |
| clientBasedResponse.clientName | This is the client name to perform the request for. |
| floorPlan | This represents a floor plan belonging to a property |
| floorPlanAmenitiesRequest | This is the request required to obtain floor plan amenities. |
| floorPlanAmenitiesResponse | This is the amenity information for the requested floor plan. |
| floorPlanParameterRequest | This is the request required to obtain Nonmarket Unit Rent parameters of a floorplan |
| floorPlanParameters | Group containing floorplan name and List of parameters |
| floorPlanParametersResponse | This is the response for a floorplan parameters request |
| floorPlanParams | Group containing name of floorplan and List of floorplan parameters |
| floorPlanRequest | This is the request required to obtain floor plans for a property |
| floorPlanResponse | This is the response for a floor plans request |
| floorPlansRequest | This is the request required to obtain floor plans for a property |
| floorPlansResponse | This is the response for a floor plans request |
| fullPropertyParameters | Group containing name and List of parameters |
| fullPropertyParametersRequest | This is the request required to obtain pricing parameters for a property |
| fullPropertyParametersResponse | This is the response for a full property parameters request |
| getClientBasedTBDLeasesResponse | This must return the number of TBD leases, within a specified number of horizon days for Client. |
| getPOModelDataRequest | This is an extended request for PO Model Data |
| getPropertyTBDLeaseRequest | This is an extended request for getTBDLeasesRequest per property |
| getPropertyTBDLeaseRequest.externalPropertyId | This is the ID of the property to obtain information for. |
| getPropertyTBDLeasesResponse | This is an extended request for getTBDLeases |
| getTBDLeaseRequest | This is an extended request for getTBDLeasesRequest |
| getTBDLeaseResponse | This is an extended request for getTBDLeases for individual bedroom count. |
| getTBDLeasesRequest | This is an extended request for getTBDLeases |
| getTBDLeasesResponse | This is an extended request for getTBDLeases. |
| getTBDUnitsResponse | WSDL-friendly wrapper for TBD - units |
| idBasedRequest | All requests requiring a client and property ID extend from this. |
| idBasedRequest.externalPropertyId | This is the ID of the property to obtain information for. |
| idBasedResponse | Base response for all responses containing an ID |
| idBasedResponse.externalPropertyId | Property ID for this response |
| leaseTermRentPlusRequest | This is a standard request for lease term rents |
| leaseTermRentPlusResponse | This is the response for lease term rents |
| leaseTermRentQuoteIdRequest | This is an extended request for lease term rents with a quote ID |
| leaseTermRentQuoteIdResponse | This is the response for lease term rents with quote |
| leaseTermRentRequest | This is a standard request for lease term rents |
| leaseTermRentResponse | This is the response for lease term rents |
| leaseTermRentUnitPlusResponse | This is a response for an individual unit. |
| leaseTermRentUnitQuoteIdResponse | This is a response for an individual unit. |
| leaseTermRentUnitRate | This is a unit rate for an individual unit |
| leaseTermRentUnitRatePlus | This is a unit rate for an individual unit |
| leaseTermRentUnitRequest | This is a request for an individual unit. |
| leaseTermRentUnitResponse | This is a response for an individual unit. |
| parameter | This represents a parameter. |
| parameterWithMultipleValues | This represents a parameter. |
| pOModelDataResponse | This is the response for getPOModelData. |
| poScreeningFloorRequest | |
| poScreeningFloorResponse | |
| poScreeningSiteFloorRequest | |
| poScreeningSiteFloorResponse | |
| poScreeningSiteFloorResponse.building | This is the building in which the unit is located. |
| poScreeningSiteFloorResponse.pmsFloorPlan | Floor plan. |
| poScreeningSiteFloorResponse.unitNumber | This is the unit number for the available unit. |
| propCodesRequest | This is an extended request for PO Model Data request |
| propCodesRequest.propcode | This is the propcode of the property to obtain information for. |
| propertiesRequest | This is the request required to obtain properties for this client. |
| propertiesResponse | This is the response for a properties request |
| property | This represents a Price Optimizer property |
| property.state | This is the state of this property |
| propertyParametersRequest | This is the request required to obtain pricing parameters for a property |
| propertyParametersResponse | This is the response for a property parameters request |
| propertyRequest | This is the request required to obtain a property for this client |
| propertyResponse | This is the response for a property request |
| renewalLeaseTermRentQuoteIdRequest | This is a request for renewal rates with Quote ID. |
| renewalLeaseTermRentQuoteIdResponse | This is a response for renewal unit rates |
| renewalLeaseTermRentRequest | This is a request for renewal rates |
| renewalLeaseTermRentResponse | This is a response for renewal unit rates |
| renewalLeaseTermRentUnitQuoteIdResponse | This is the response for unit rates for an individual unit |
| renewalLeaseTermRentUnitRequest | This is a request for renewal rates on an individual unit. |
| renewalLeaseTermRentUnitResponse | This is the response for unit rates for an individual unit |
| rentSummaryFloorPlanUnitType | This represents a floor plan and unit type combination for the rent summary. |
| rentSummaryFloorPlanUnitType.concessionType | Reserved for future use |
| rentSummaryFloorPlanUnitType.floorPlanDescription | This is the marketing name of the floor plan. |
| rentSummaryRequest | This is the request required to obtain rent summary information. |
| rentSummaryResponse | This is the rent summary information for the requested property. |
| saveRentQuoteIdRequest | This is an extended request for lease term rents with a quote ID |
| saveRentQuoteIdResponse | This is the response for save rents with a quote. |
| saveRentsQuoteIdRequest | This is an extended request for lease term rents with a quote ID |
| saveUnitRentQuoteIdRequest | This is an extended request for saving rents with a quote ID |
| saveUnitRentQuoteIdResponse | This is a response for an individual quote. |
| setUnitAmenitiesRequest | This is the request to set Unit Amenities and the following fields are required unless specified otherwise A. |
| setUnitAmenityRequest | Each of the individual entries in the setUnitAmenities Request. |
| setUnitAmenityRequest.amenityChangeType | If specified, defines if the amenity change type is a “insert”, “update”, or “delete" . |
| setUnitAmenityResponse | This is a response for renewal unit rates |
| setUnitAmenityResponse.building | This is the building in which the unit is located. |
| setUnitAmenityResponse.unitName | This is the unit name to set the amenities. |
| TBDUnitResponse | This represents a TBD unit |
| unit | This represents a unit belonging to a floor plan |
| unitAmenitiesRequest | This is the request required to obtain floor plan amenities. |
| unitAmenitiesResponse | This is the amenity information for the requested unit. |
| unitAmenityResponse | Response for each of the individual entries in the setUnitAmenities Request. |
| unitAvailabilityRequest | This is a request to set a unit's availability. |
| unitRate | This represents a common unit rate for a unit |
| unitRateRequest | |
| unitRateRequest.building | This is the building in which the unit is located. |
| unitRateRequest.unitNumber | This is the unit number for the available unit. |
| unitRateResponse | |
| unitRateResponse.building | This is the building in which the unit is located. |
| unitRateResponse.unitNumber | This is the unit number for the available unit. |
| unitRequest | This is the request required to obtain a unit for a property |
| unitResponse | This is the response for a unit request |
| unitsRequest | This is the request required to obtain units for a property (or floor plan) |
| unitsResponse | This is the response for a units request |
| unitsWithStatusResponse | This is the response with designation status for a units request |
| Simple Type Summary | |
| unitAvailabilityStatus | This represents the availability of a unit. |
| unitDesignationStatus | This represents the designation status of a unit. |
By default, local element declarations belong to this schema's target namespace.
By default, local attribute declarations have no namespace.
AppExchange Service -
This service provides rent and availability information
on units by floor plan and property.
| |||||||
| DETAILS: DOCUMENTATION | | FRAMES | NO FRAMES | ||||||