Platform API

GetEstates

Get all estates for the specified criteria

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

import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


/**
* Get all estates for the specified criteria
*/
@Api(Description="Get all estates for the specified criteria")
open class GetEstates
{
    /**
    * Get an estate that matches the specified ID.
    */
    @ApiMember(Description="Get an estate that matches the specified ID.", Name="GeoEstateId")
    open var GeoEstateId:UUID? = null

    /**
    * Get estates with a matching record status. A=active I=inactive D=deleted.
    */
    @ApiMember(Description="Get estates with a matching record status. A=active I=inactive D=deleted.", Name="RecordStatus")
    open var RecordStatus:String? = null
}

open class GetEstatesResponse
{
    open var Estates:ArrayList<GeoEstateModel>? = null
    open var ResponseStatus:ResponseStatus? = null
}

open class GeoEstateModel
{
    open var GeoEstateId:UUID? = null
    open var Name:String? = null
    open var Notes:String? = null
    open var DeveloperContactId:UUID? = null
    open var DeveloperName:String? = null
    open var DeveloperProfilePhotoUrl:String? = null
    open var DeveloperProfilePhotoThumbnail:String? = null
    open var RecordStatus:String? = null
    open var Stages:ArrayList<GeoEstateStageModel>? = null
    open var CurrentEstateStageId:UUID? = null
    open var CurrentEstateStageName:String? = null
}

open class GeoEstateStageModel
{
    open var GeoEstateStageId:UUID? = null
    open var GeoEstateId:UUID? = null
    open var Name:String? = null
    open var Notes:String? = null
    open var RecordStatus:String? = null
}

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