Platform API

GetEstates

Get all estates for the specified criteria

The following routes are available for this service:
All Verbs	/api/estates

**GetEstates** Parameters:
Name	Parameter	Data Type	Required	Description
GeoEstateId	query	Guid	No	Get an estate that matches the specified ID.
RecordStatus	query	string	No	Get estates with a matching record status. A=active I=inactive D=deleted.

**GetEstatesResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Estates	form	List<GeoEstateModel>	No
ResponseStatus	form	ResponseStatus	No

**GeoEstateModel** Parameters:
Name	Parameter	Data Type	Required
GeoEstateId	form	Guid	No
Name	form	string	No
Notes	form	string	No
DeveloperContactId	form	Guid	No
DeveloperName	form	string	No
DeveloperProfilePhotoUrl	form	string	No
DeveloperProfilePhotoThumbnail	form	string	No
RecordStatus	form	string	No
Stages	form	List<GeoEstateStageModel>	No
CurrentEstateStageId	form	Guid	No
CurrentEstateStageName	form	string	No

**GeoEstateStageModel** Parameters:
Name	Parameter	Data Type	Required
GeoEstateStageId	form	Guid	No
GeoEstateId	form	Guid	No
Name	form	string	No
Notes	form	string	No
RecordStatus	form	string	No

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /api/estates HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	RecordStatus: String
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Estates: 
	[
		{
			Name: String,
			Notes: String,
			DeveloperName: String,
			DeveloperProfilePhotoUrl: String,
			DeveloperProfilePhotoThumbnail: String,
			RecordStatus: String,
			Stages: 
			[
				{
					Name: String,
					Notes: String,
					RecordStatus: String
				}
			],
			CurrentEstateStageName: String
		}
	],
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}