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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<GetEstates xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
  <GeoEstateId>00000000-0000-0000-0000-000000000000</GeoEstateId>
  <RecordStatus>String</RecordStatus>
</GetEstates>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetEstatesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
  <Estates xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eros.Saguna.Common.WebAPIModel.Models">
    <d2p1:GeoEstateModel>
      <d2p1:CurrentEstateStageId>00000000-0000-0000-0000-000000000000</d2p1:CurrentEstateStageId>
      <d2p1:CurrentEstateStageName>String</d2p1:CurrentEstateStageName>
      <d2p1:DeveloperContactId>00000000-0000-0000-0000-000000000000</d2p1:DeveloperContactId>
      <d2p1:DeveloperName>String</d2p1:DeveloperName>
      <d2p1:DeveloperProfilePhotoThumbnail>String</d2p1:DeveloperProfilePhotoThumbnail>
      <d2p1:DeveloperProfilePhotoUrl>String</d2p1:DeveloperProfilePhotoUrl>
      <d2p1:GeoEstateId>00000000-0000-0000-0000-000000000000</d2p1:GeoEstateId>
      <d2p1:Name>String</d2p1:Name>
      <d2p1:Notes>String</d2p1:Notes>
      <d2p1:RecordStatus>String</d2p1:RecordStatus>
      <d2p1:Stages>
        <d2p1:GeoEstateStageModel>
          <d2p1:GeoEstateId>00000000-0000-0000-0000-000000000000</d2p1:GeoEstateId>
          <d2p1:GeoEstateStageId>00000000-0000-0000-0000-000000000000</d2p1:GeoEstateStageId>
          <d2p1:Name>String</d2p1:Name>
          <d2p1:Notes>String</d2p1:Notes>
          <d2p1:RecordStatus>String</d2p1:RecordStatus>
        </d2p1:GeoEstateStageModel>
      </d2p1:Stages>
    </d2p1:GeoEstateModel>
  </Estates>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</GetEstatesResponse>