Platform API

GetEstates

Get all estates for the specified criteria

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

import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GeoEstateStageModel:
    geo_estate_stage_id: Optional[str] = None
    geo_estate_id: Optional[str] = None
    name: Optional[str] = None
    notes: Optional[str] = None
    record_status: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GeoEstateModel:
    geo_estate_id: Optional[str] = None
    name: Optional[str] = None
    notes: Optional[str] = None
    developer_contact_id: Optional[str] = None
    developer_name: Optional[str] = None
    developer_profile_photo_url: Optional[str] = None
    developer_profile_photo_thumbnail: Optional[str] = None
    record_status: Optional[str] = None
    stages: Optional[List[GeoEstateStageModel]] = None
    current_estate_stage_id: Optional[str] = None
    current_estate_stage_name: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetEstatesResponse:
    estates: Optional[List[GeoEstateModel]] = None
    response_status: Optional[ResponseStatus] = None


# @Api(Description="Get all estates for the specified criteria")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetEstates:
    """
    Get all estates for the specified criteria
    """

    # @ApiMember(Description="Get an estate that matches the specified ID.", Name="GeoEstateId")
    geo_estate_id: Optional[str] = None
    """
    Get an estate that matches the specified ID.
    """


    # @ApiMember(Description="Get estates with a matching record status. A=active I=inactive D=deleted.", Name="RecordStatus")
    record_status: Optional[str] = None
    """
    Get estates with a matching record status. A=active I=inactive D=deleted.
    """

Python GetEstates DTOs

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
		}
	}
}