Overview  Namespace  Component  Index  Help
DETAILS:	FRAMES | NO FRAMES

---

amenity - complexType of namespace http://yieldstar.com/ws/AppExchange/v1

This represents an amenity  

amenityChangeType - nested element in complexType of namespace http://yieldstar.com/ws/AppExchange/v1

If specified, defines if the amenity change type is a “insert”, “update”, or “delete" .  

AuthenticationFault - element of namespace http://yieldstar.com/ws/AppExchange/v1

This fault will occur when either the credentials are incorrect or the privileges for the provided user are incorrect.  

availableUnitsFloorPlan - complexType of namespace http://yieldstar.com/ws/AppExchange/v1

This represents a floor plan for available units.  

availableUnitsRequest - complexType of namespace http://yieldstar.com/ws/AppExchange/v1

This is the request to obtain the available units for the given property. 

availableUnitsResponse - complexType of namespace http://yieldstar.com/ws/AppExchange/v1

This represents the available units for the requested property.  

availableUnitsUnit - complexType of namespace http://yieldstar.com/ws/AppExchange/v1

 

baseFault - complexType of namespace http://yieldstar.com/ws/AppExchange/v1

This is the base fault for all possible faults in this service.  

building - nested element in complexType of namespace http://yieldstar.com/ws/AppExchange/v1

This is the building in which the unit is located.  

building - nested element in complexType of namespace http://yieldstar.com/ws/AppExchange/v1

This is the building in which the unit is located. 

building - nested element in complexType of namespace http://yieldstar.com/ws/AppExchange/v1

This is the building in which the unit is located. 

building - nested element in complexType of namespace http://yieldstar.com/ws/AppExchange/v1

This is the building for the unit.  

building - nested element in complexType of namespace http://yieldstar.com/ws/AppExchange/v1

This is the building in which the unit is located. 

clientBasedRequest - complexType of namespace http://yieldstar.com/ws/AppExchange/v1

This is the base request for all requests requiring a client name. 

clientBasedResponse - complexType of namespace http://yieldstar.com/ws/AppExchange/v1

This is the base response for all responses requiring a client name. 

clientName - nested element in complexType of namespace http://yieldstar.com/ws/AppExchange/v1

This is the client name to perform the request for.  

clientName - nested element in complexType of namespace http://yieldstar.com/ws/AppExchange/v1

This is the client name to perform the request for.  

concessionType - nested element in complexType of namespace http://yieldstar.com/ws/AppExchange/v1

Reserved for future use  

externalPropertyId - nested element in complexType of namespace http://yieldstar.com/ws/AppExchange/v1

This is the ID of the property to obtain information for. 

externalPropertyId - nested element in complexType of namespace http://yieldstar.com/ws/AppExchange/v1

Property ID for this response  

externalPropertyId - nested element in complexType of namespace http://yieldstar.com/ws/AppExchange/v1

This is the ID of the property to obtain information for. 

feature - nested element in complexType of namespace http://yieldstar.com/ws/AppExchange/v1

This is a list of the unit amenities for the unit.  

floorPlan - complexType of namespace http://yieldstar.com/ws/AppExchange/v1

This represents a floor plan belonging to a property  

floorPlanAmenitiesRequest - complexType of namespace http://yieldstar.com/ws/AppExchange/v1

This is the request required to obtain floor plan amenities. 

floorPlanAmenitiesResponse - complexType of namespace http://yieldstar.com/ws/AppExchange/v1

This is the amenity information for the requested floor plan.  

floorPlanDescription - nested element in complexType of namespace http://yieldstar.com/ws/AppExchange/v1

This is the marketing name of the floor plan.  

floorPlanParameterRequest - complexType of namespace http://yieldstar.com/ws/AppExchange/v1

This is the request required to obtain Nonmarket Unit Rent parameters of a floorplan  

floorPlanParameters - complexType of namespace http://yieldstar.com/ws/AppExchange/v1

Group containing floorplan name and List of parameters  

floorPlanParametersResponse - complexType of namespace http://yieldstar.com/ws/AppExchange/v1

This is the response for a floorplan parameters request  

floorPlanParams - complexType of namespace http://yieldstar.com/ws/AppExchange/v1

Group containing name of floorplan and List of floorplan parameters  

floorPlanRequest - complexType of namespace http://yieldstar.com/ws/AppExchange/v1

This is the request required to obtain floor plans for a property  

floorPlanResponse - complexType of namespace http://yieldstar.com/ws/AppExchange/v1

This is the response for a floor plans request  

floorPlansRequest - complexType of namespace http://yieldstar.com/ws/AppExchange/v1

This is the request required to obtain floor plans for a property  

floorPlansResponse - complexType of namespace http://yieldstar.com/ws/AppExchange/v1

This is the response for a floor plans request  

fullPropertyParameters - complexType of namespace http://yieldstar.com/ws/AppExchange/v1

Group containing name and List of parameters  

fullPropertyParametersRequest - complexType of namespace http://yieldstar.com/ws/AppExchange/v1

This is the request required to obtain pricing parameters for a property  

fullPropertyParametersResponse - complexType of namespace http://yieldstar.com/ws/AppExchange/v1

This is the response for a full property parameters request  

getAvailableUnits - element of namespace http://yieldstar.com/ws/AppExchange/v1

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 - element of namespace http://yieldstar.com/ws/AppExchange/v1

WSDL-friendly wrapper for availableUnitsResponse  

getClientBasedTBDLeasesResponse - complexType of namespace http://yieldstar.com/ws/AppExchange/v1

This must return the number of TBD leases, within a specified number of horizon days for Client.  

getClientTBDLeasesResponse - element of namespace http://yieldstar.com/ws/AppExchange/v1

This must return the number of TBD leases, within a specified number of horizon days.  

getFloorPlan - element of namespace http://yieldstar.com/ws/AppExchange/v1

Floor Plan - This operation returns a specific YieldStar floor plan for the specified property. 

getFloorPlanAmenities - element of namespace http://yieldstar.com/ws/AppExchange/v1

Floor Plan Amenities - This operation provides amenity information for a floor plan  

getFloorPlanAmenitiesResponse - element of namespace http://yieldstar.com/ws/AppExchange/v1

WSDL-friendly wrapper for floorPlanAmenitiesResponse  

getFloorPlanParameters - element of namespace http://yieldstar.com/ws/AppExchange/v1

FloorPlan Parameters - This operation provides floorPlan wise Parameters.  

getFloorPlanParametersResponse - element of namespace http://yieldstar.com/ws/AppExchange/v1

WSDL-friendly wrapper for floorPlanParametersResponse  

getFloorPlanResponse - element of namespace http://yieldstar.com/ws/AppExchange/v1

WSDL-friendly wrapper for floorPlanResponse  

getFloorPlans - element of namespace http://yieldstar.com/ws/AppExchange/v1

Floor Plans - This operation returns YieldStar floor plans for the specified property. 

getFloorPlansResponse - element of namespace http://yieldstar.com/ws/AppExchange/v1

WSDL-friendly wrapper for floorPlansResponse  

getFullPropertyParameters - element of namespace http://yieldstar.com/ws/AppExchange/v1

Property Parameters - This operation provides Unit Rent parameters for a given property in a more detail way.  

getFullPropertyParametersResponse - element of namespace http://yieldstar.com/ws/AppExchange/v1

WSDL-friendly wrapper for fullPropertyParametersResponse  

getLeaseTermRent - element of namespace http://yieldstar.com/ws/AppExchange/v1

This provides a matrix providing the specific rate for each combination of lease term and move-in date for a given unit. 

getLeaseTermRentPlus - element of namespace http://yieldstar.com/ws/AppExchange/v1

This provides a matrix providing the specific rate for each combination of lease term and move-in date for a given unit. 

getLeaseTermRentPlusResponse - element of namespace http://yieldstar.com/ws/AppExchange/v1

WSDL-friendly wrapper for leaseTermRentPlusResponse  

getLeaseTermRentQuoteId - element of namespace http://yieldstar.com/ws/AppExchange/v1

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 - element of namespace http://yieldstar.com/ws/AppExchange/v1

WSDL-friendly wrapper for leaseTermRentQuoteIdResponse  

getLeaseTermRentResponse - element of namespace http://yieldstar.com/ws/AppExchange/v1

WSDL-friendly wrapper for leaseTermRentResponse  

getPOModelData - element of namespace http://yieldstar.com/ws/AppExchange/v1

This Operation provides properties Model Data including Sustainable occupancy and Seasonal expirations.  

getPOModelDataRequest - complexType of namespace http://yieldstar.com/ws/AppExchange/v1

This is an extended request for PO Model Data  

getPOModelDataResponse - element of namespace http://yieldstar.com/ws/AppExchange/v1

This provides information like Average lease terms, Average renewal, Sustainable occupancy and Seasonal expirations for the properties.  

getPoScreeningFloor - element of namespace http://yieldstar.com/ws/AppExchange/v1

 

getPoScreeningFloorReponse - element of namespace http://yieldstar.com/ws/AppExchange/v1

 

getProperties - element of namespace http://yieldstar.com/ws/AppExchange/v1

Properties - This operation provides property information for all properties  

getPropertiesResponse - element of namespace http://yieldstar.com/ws/AppExchange/v1

WSDL-friendly wrapper for propertiesResponse  

getProperty - element of namespace http://yieldstar.com/ws/AppExchange/v1

Property - This operation provides property information for a given property  

getPropertyParameters - element of namespace http://yieldstar.com/ws/AppExchange/v1

Property Parameters - This operation provides pricing parameters for a given property  

getPropertyParametersResponse - element of namespace http://yieldstar.com/ws/AppExchange/v1

WSDL-friendly wrapper for propertyParametersResponse  

getPropertyResponse - element of namespace http://yieldstar.com/ws/AppExchange/v1

WSDL-friendly wrapper for propertyResponse  

getPropertyTBDLeaseRequest - complexType of namespace http://yieldstar.com/ws/AppExchange/v1

This is an extended request for getTBDLeasesRequest per property  

getPropertyTBDLeasesResponse - complexType of namespace http://yieldstar.com/ws/AppExchange/v1

This is an extended request for getTBDLeases  

getRenewalLeaseTermRent - element of namespace http://yieldstar.com/ws/AppExchange/v1

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 - element of namespace http://yieldstar.com/ws/AppExchange/v1

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 - element of namespace http://yieldstar.com/ws/AppExchange/v1

WSDL-friendly wrapper for renewalLeaseTermRentQuoteIdResponse  

getRenewalLeaseTermRentResponse - element of namespace http://yieldstar.com/ws/AppExchange/v1

WSDL-friendly wrapper for renewalLeaseTermRentResponse  

getRentSummary - element of namespace http://yieldstar.com/ws/AppExchange/v1

Rent Summary - This service provides high level rent information for all currently available floor plans within the property.  

getRentSummaryResponse - element of namespace http://yieldstar.com/ws/AppExchange/v1

WSDL-friendly wrapper for rentSummaryResponse  

getTBDLeaseRequest - complexType of namespace http://yieldstar.com/ws/AppExchange/v1

This is an extended request for getTBDLeasesRequest  

getTBDLeaseResponse - complexType of namespace http://yieldstar.com/ws/AppExchange/v1

This is an extended request for getTBDLeases for individual bedroom count.  

getTBDLeases - element of namespace http://yieldstar.com/ws/AppExchange/v1

This must return the number of TBD leases, within a specified number of horizon days.  

getTBDLeasesRequest - complexType of namespace http://yieldstar.com/ws/AppExchange/v1

This is an extended request for getTBDLeases  

getTBDLeasesResponse - complexType of namespace http://yieldstar.com/ws/AppExchange/v1

This is an extended request for getTBDLeases.  

getTBDUnitsResponse - complexType of namespace http://yieldstar.com/ws/AppExchange/v1

WSDL-friendly wrapper for TBD - units  

getUnit - element of namespace http://yieldstar.com/ws/AppExchange/v1

Unit - This operation provides information for a given unit  

getUnitAmenities - element of namespace http://yieldstar.com/ws/AppExchange/v1

Unit Amenities - This operation provides amenity information for a unit  

getUnitAmenitiesResponse - element of namespace http://yieldstar.com/ws/AppExchange/v1

WSDL-friendly wrapper for unitAmenitiesResponse  

getUnitResponse - element of namespace http://yieldstar.com/ws/AppExchange/v1

WSDL-friendly wrapper for unitResponse  

getUnits - element of namespace http://yieldstar.com/ws/AppExchange/v1

Units - This operation provides unit information for a properties (or a specific floor plan)  

getUnitsResponse - element of namespace http://yieldstar.com/ws/AppExchange/v1

WSDL-friendly wrapper for unitsResponse  

getUnitsWithStatus - element of namespace http://yieldstar.com/ws/AppExchange/v1

Units - This operation provides unit information for a properties with its designation status (or a specific floor plan)  

getUnitsWithStatusResponse - element of namespace http://yieldstar.com/ws/AppExchange/v1

WSDL-friendly wrapper for unitsResponse  

idBasedRequest - complexType of namespace http://yieldstar.com/ws/AppExchange/v1

All requests requiring a client and property ID extend from this. 

idBasedResponse - complexType of namespace http://yieldstar.com/ws/AppExchange/v1

Base response for all responses containing an ID  

InternalErrorFault - element of namespace http://yieldstar.com/ws/AppExchange/v1

This fault will occur for any unexpected internal error in the service. 

leaseTermRentPlusRequest - complexType of namespace http://yieldstar.com/ws/AppExchange/v1

This is a standard request for lease term rents  

leaseTermRentPlusResponse - complexType of namespace http://yieldstar.com/ws/AppExchange/v1

This is the response for lease term rents  

leaseTermRentQuoteIdRequest - complexType of namespace http://yieldstar.com/ws/AppExchange/v1

This is an extended request for lease term rents with a quote ID  

leaseTermRentQuoteIdResponse - complexType of namespace http://yieldstar.com/ws/AppExchange/v1

This is the response for lease term rents with quote  

leaseTermRentRequest - complexType of namespace http://yieldstar.com/ws/AppExchange/v1

This is a standard request for lease term rents  

leaseTermRentResponse - complexType of namespace http://yieldstar.com/ws/AppExchange/v1

This is the response for lease term rents  

leaseTermRentUnitPlusResponse - complexType of namespace http://yieldstar.com/ws/AppExchange/v1

This is a response for an individual unit. 

leaseTermRentUnitQuoteIdResponse - complexType of namespace http://yieldstar.com/ws/AppExchange/v1

This is a response for an individual unit. 

leaseTermRentUnitRate - complexType of namespace http://yieldstar.com/ws/AppExchange/v1

This is a unit rate for an individual unit  

leaseTermRentUnitRatePlus - complexType of namespace http://yieldstar.com/ws/AppExchange/v1

This is a unit rate for an individual unit  

leaseTermRentUnitRequest - complexType of namespace http://yieldstar.com/ws/AppExchange/v1

This is a request for an individual unit. 

leaseTermRentUnitResponse - complexType of namespace http://yieldstar.com/ws/AppExchange/v1

This is a response for an individual unit. 

OperationFault - element of namespace http://yieldstar.com/ws/AppExchange/v1

This fault occurs if there is any expected error in the operation.  

parameter - complexType of namespace http://yieldstar.com/ws/AppExchange/v1

This represents a parameter. 

parameterWithMultipleValues - complexType of namespace http://yieldstar.com/ws/AppExchange/v1

This represents a parameter.  

pmsFloorPlan - nested element in complexType of namespace http://yieldstar.com/ws/AppExchange/v1

Floor plan.  

pOModelDataResponse - complexType of namespace http://yieldstar.com/ws/AppExchange/v1

This is the response for getPOModelData.  

poScreeningFloorRequest - complexType of namespace http://yieldstar.com/ws/AppExchange/v1

 

poScreeningFloorResponse - complexType of namespace http://yieldstar.com/ws/AppExchange/v1

 

poScreeningSiteFloorRequest - complexType of namespace http://yieldstar.com/ws/AppExchange/v1

 

poScreeningSiteFloorResponse - complexType of namespace http://yieldstar.com/ws/AppExchange/v1

 

propcode - nested element in complexType of namespace http://yieldstar.com/ws/AppExchange/v1

This is the propcode of the property to obtain information for. 

propCodesRequest - complexType of namespace http://yieldstar.com/ws/AppExchange/v1

This is an extended request for PO Model Data request  

propertiesRequest - complexType of namespace http://yieldstar.com/ws/AppExchange/v1

This is the request required to obtain properties for this client.  

propertiesResponse - complexType of namespace http://yieldstar.com/ws/AppExchange/v1

This is the response for a properties request  

property - complexType of namespace http://yieldstar.com/ws/AppExchange/v1

This represents a Price Optimizer property  

propertyParametersRequest - complexType of namespace http://yieldstar.com/ws/AppExchange/v1

This is the request required to obtain pricing parameters for a property  

propertyParametersResponse - complexType of namespace http://yieldstar.com/ws/AppExchange/v1

This is the response for a property parameters request  

propertyRequest - complexType of namespace http://yieldstar.com/ws/AppExchange/v1

This is the request required to obtain a property for this client  

propertyResponse - complexType of namespace http://yieldstar.com/ws/AppExchange/v1

This is the response for a property request  

renewalLeaseTermRentQuoteIdRequest - complexType of namespace http://yieldstar.com/ws/AppExchange/v1

This is a request for renewal rates with Quote ID.  

renewalLeaseTermRentQuoteIdResponse - complexType of namespace http://yieldstar.com/ws/AppExchange/v1

This is a response for renewal unit rates  

renewalLeaseTermRentRequest - complexType of namespace http://yieldstar.com/ws/AppExchange/v1

This is a request for renewal rates  

renewalLeaseTermRentResponse - complexType of namespace http://yieldstar.com/ws/AppExchange/v1

This is a response for renewal unit rates  

renewalLeaseTermRentUnitQuoteIdResponse - complexType of namespace http://yieldstar.com/ws/AppExchange/v1

This is the response for unit rates for an individual unit  

renewalLeaseTermRentUnitRequest - complexType of namespace http://yieldstar.com/ws/AppExchange/v1

This is a request for renewal rates on an individual unit. 

renewalLeaseTermRentUnitResponse - complexType of namespace http://yieldstar.com/ws/AppExchange/v1

This is the response for unit rates for an individual unit  

rentSummaryFloorPlanUnitType - complexType of namespace http://yieldstar.com/ws/AppExchange/v1

This represents a floor plan and unit type combination for the rent summary.  

rentSummaryRequest - complexType of namespace http://yieldstar.com/ws/AppExchange/v1

This is the request required to obtain rent summary information. 

rentSummaryResponse - complexType of namespace http://yieldstar.com/ws/AppExchange/v1

This is the rent summary information for the requested property.  

saveRentQuoteIdRequest - complexType of namespace http://yieldstar.com/ws/AppExchange/v1

This is an extended request for lease term rents with a quote ID  

saveRentQuoteIdResponse - complexType of namespace http://yieldstar.com/ws/AppExchange/v1

This is the response for save rents with a quote.  

saveRentsQuoteId - element of namespace http://yieldstar.com/ws/AppExchange/v1

This provides is called when third party system uses rent from a matrix with associated QuoteId in a quote or renewal offer.  

saveRentsQuoteIdRequest - complexType of namespace http://yieldstar.com/ws/AppExchange/v1

This is an extended request for lease term rents with a quote ID  

saveRentsQuoteIdResponse - element of namespace http://yieldstar.com/ws/AppExchange/v1

This provides is called when third party system uses rent from a matrix with associated QuoteId in a quote or renewal offer.  

saveUnitRentQuoteIdRequest - complexType of namespace http://yieldstar.com/ws/AppExchange/v1

This is an extended request for saving rents with a quote ID  

saveUnitRentQuoteIdResponse - complexType of namespace http://yieldstar.com/ws/AppExchange/v1

This is a response for an individual quote.  

setUnitAmenities - element of namespace http://yieldstar.com/ws/AppExchange/v1

Set Unit Amenity - This operations provides the ability to set a unit amenity values . 

setUnitAmenitiesRequest - complexType of namespace http://yieldstar.com/ws/AppExchange/v1

This is the request to set Unit Amenities and the following fields are required unless specified otherwise A. 

setUnitAmenitiesResponse - element of namespace http://yieldstar.com/ws/AppExchange/v1

WSDL-friendly wrapper for void response  

setUnitAmenityRequest - complexType of namespace http://yieldstar.com/ws/AppExchange/v1

Each of the individual entries in the setUnitAmenities Request. 

setUnitAmenityResponse - complexType of namespace http://yieldstar.com/ws/AppExchange/v1

This is a response for renewal unit rates  

setUnitAvailability - element of namespace http://yieldstar.com/ws/AppExchange/v1

Set Unit Availability - This operations provides the ability to set a unit as either available or unavailable. 

setUnitAvailabilityResponse - element of namespace http://yieldstar.com/ws/AppExchange/v1

WSDL-friendly wrapper for void response  

state - nested element in complexType of namespace http://yieldstar.com/ws/AppExchange/v1

This is the state of this property  

status - nested element in complexType of namespace http://yieldstar.com/ws/AppExchange/v1

This is the availability status of the unit.  

TBDUnitResponse - complexType of namespace http://yieldstar.com/ws/AppExchange/v1

This represents a TBD unit  

unit - complexType of namespace http://yieldstar.com/ws/AppExchange/v1

This represents a unit belonging to a floor plan  

unitAmenitiesRequest - complexType of namespace http://yieldstar.com/ws/AppExchange/v1

This is the request required to obtain floor plan amenities. 

unitAmenitiesResponse - complexType of namespace http://yieldstar.com/ws/AppExchange/v1

This is the amenity information for the requested unit.  

unitAmenityResponse - complexType of namespace http://yieldstar.com/ws/AppExchange/v1

Response for each of the individual entries in the setUnitAmenities Request.  

unitAvailabilityRequest - complexType of namespace http://yieldstar.com/ws/AppExchange/v1

This is a request to set a unit's availability. 

unitAvailabilityStatus - simpleType of namespace http://yieldstar.com/ws/AppExchange/v1

This represents the availability of a unit. 

unitDesignationStatus - simpleType of namespace http://yieldstar.com/ws/AppExchange/v1

This represents the designation status of a unit. 

unitName - nested element in complexType of namespace http://yieldstar.com/ws/AppExchange/v1

This is the unit name to set the amenities.  

unitNumber - nested element in complexType of namespace http://yieldstar.com/ws/AppExchange/v1

This is the unit number for the available unit.  

unitNumber - nested element in complexType of namespace http://yieldstar.com/ws/AppExchange/v1

This is the unit number for the available unit.  

unitNumber - nested element in complexType of namespace http://yieldstar.com/ws/AppExchange/v1

This is the unit number for the available unit from the property management system.  

unitNumber - nested element in complexType of namespace http://yieldstar.com/ws/AppExchange/v1

This is the unit number for the available unit.  

unitRate - complexType of namespace http://yieldstar.com/ws/AppExchange/v1

This represents a common unit rate for a unit  

unitRateRequest - complexType of namespace http://yieldstar.com/ws/AppExchange/v1

 

unitRateResponse - complexType of namespace http://yieldstar.com/ws/AppExchange/v1

 

unitRequest - complexType of namespace http://yieldstar.com/ws/AppExchange/v1

This is the request required to obtain a unit for a property  

unitResponse - complexType of namespace http://yieldstar.com/ws/AppExchange/v1

This is the response for a unit request  

unitsRequest - complexType of namespace http://yieldstar.com/ws/AppExchange/v1

This is the request required to obtain units for a property (or floor plan)  

unitsResponse - complexType of namespace http://yieldstar.com/ws/AppExchange/v1

This is the response for a units request  

unitsWithStatusResponse - complexType of namespace http://yieldstar.com/ws/AppExchange/v1

This is the response with designation status for a units request  

unitType - nested element in complexType of namespace http://yieldstar.com/ws/AppExchange/v1

This is the unit type for the unit.  

---

Overview  Namespace  Component  Index  Help
DETAILS:	FRAMES | NO FRAMES

---

Submit a bug or a feature.
Created by xsddoc, a sub project of xframe, hosted at http://xframe.sourceforge.net.