Properties
The property endpoint is where you will retrieve information about the communities in your YGL account.
As with all endpoints that return a collection in our API, you can use oData queries to filter you results. In addition, the default page size returned is 20.
Request
| Name | Method | Description |
|---|---|---|
| /api/properties | GET | Information about your YGL communities |
| /api/properties/{PropertyId} | GET | Information about one of your YGL communities |
Response Values
| Name | Type | Definition |
|---|---|---|
| Address1 | string (50) | The first address line of the community |
| Address2 | string (50) | The second address line of the community |
| City | string (255) | The city of the community |
| Country | string (2) | The country code of the community |
| Division | string (40) | The division within YGL that the community belongs to |
| Name | string (255) | The name of the community |
| PropertyId | int | The unique identifier for the community in YGL |
| Region | string (40) | The region within YGL that the community belongs to |
| State | string (10) | The state the community is in |
| UpdatedBy | string (10) | The username of the last user to modify the community |
| UpdatedOn | DateTime | The date and time of the last modification to the community |
| Zip | string (30) | The zip code of the community |
Sample Requests
https://partner-api.youvegotleads.com/api/properties
https://partner-api.youvegotleads.com/api/properties?$filter=State+eq+'CA'
https://partner-api.youvegotleads.com/api/properties/95714
Sample Responses
Property Collection
[
{
"Name":"Vista Ridge at Mira Loma",
"PropertyId":95714,
"Region":"CA",
"Division":"Southwest",
"UpdatedOn":"2011-04-06T22:18:07.52",
"UpdatedBy":null,
"Address1":null,
"Address2":null,
"City":"Mira Loma",
"State":"CA",
"Zip":null,
"Country":"US"
},
{
"Name":"Vista Ridge of Bellevue (demo)",
"PropertyId":95771,
"Region":"WA",
"Division":"Northwest",
"UpdatedOn":"2011-04-06T22:18:07.52",
"UpdatedBy":null,
"Address1":null,
"Address2":null,
"City":"Bellevue",
"State":"WA",
"Zip":"98007",
"Country":"US"
},
{
"Name":"Vista Ridge of Scottsdale",
"PropertyId":95772,
"Region":"AZ",
"Division":"Southwest",
"UpdatedOn":"2011-04-06T22:18:07.52",
"UpdatedBy":null,
"Address1":null,
"Address2":null,
"City":"Scottsdale",
"State":"AZ",
"Zip":null,
"Country":"US"
},
{
"Name":"Vista Ridge at Turtle Creek",
"PropertyId":95773,
"Region":"TX",
"Division":"Southwest",
"UpdatedOn":"2011-04-06T22:18:07.52",
"UpdatedBy":null,
"Address1":null,
"Address2":null,
"City":"Dallas",
"State":"TX",
"Zip":null,
"Country":"US"
},
{
"Name":"Vista Ridge of Naperville",
"PropertyId":95774,
"Region":"IL",
"Division":"Midwest",
"UpdatedOn":"2011-04-06T22:18:07.52",
"UpdatedBy":null,
"Address1":null,
"Address2":null,
"City":"Naperville",
"State":"IL",
"Zip":null,
"Country":"US"
},
{
"Name":"Vista Ridge at Ann Arbor",
"PropertyId":95775,
"Region":"MI",
"Division":"Midwest",
"UpdatedOn":"2011-04-06T22:18:07.52",
"UpdatedBy":null,
"Address1":null,
"Address2":null,
"City":"Ann Arbor",
"State":"MI",
"Zip":null,
"Country":"US"
}
]
Single Property
{
"Name": "Vista Ridge at Mira Loma",
"PropertyId": 95714,
"Region": "CA",
"Division": "Southwest",
"UpdatedOn": "2011-04-06T22:18:07.52",
"UpdatedBy": null,
"Address1": null,
"Address2": null,
"City": "Mira Loma",
"State": "CA",
"Zip": null,
"Country": "US"
}