Platform API

GetEstates

Get all estates for the specified criteria

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

import Foundation
import ServiceStack

/**
* Get all estates for the specified criteria
*/
// @Api(Description="Get all estates for the specified criteria")
public class GetEstates : Codable
{
    /**
    * Get an estate that matches the specified ID.
    */
    // @ApiMember(Description="Get an estate that matches the specified ID.", Name="GeoEstateId")
    public var geoEstateId:String

    /**
    * 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")
    public var recordStatus:String

    required public init(){}
}

public class GetEstatesResponse : Codable
{
    public var estates:[GeoEstateModel]
    public var responseStatus:ResponseStatus

    required public init(){}
}

public class GeoEstateModel : Codable
{
    public var geoEstateId:String
    public var name:String
    public var notes:String
    public var developerContactId:String
    public var developerName:String
    public var developerProfilePhotoUrl:String
    public var developerProfilePhotoThumbnail:String
    public var recordStatus:String
    public var stages:[GeoEstateStageModel]
    public var currentEstateStageId:String
    public var currentEstateStageName:String

    required public init(){}
}

public class GeoEstateStageModel : Codable
{
    public var geoEstateStageId:String
    public var geoEstateId:String
    public var name:String
    public var notes:String
    public var recordStatus:String

    required public init(){}
}

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