Platform API

GetEstates

Get all estates for the specified criteria

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


export class GeoEstateStageModel
{
    public GeoEstateStageId: string;
    public GeoEstateId: string;
    public Name: string;
    public Notes: string;
    public RecordStatus: string;

    public constructor(init?: Partial<GeoEstateStageModel>) { (Object as any).assign(this, init); }
}

export class GeoEstateModel
{
    public GeoEstateId: string;
    public Name: string;
    public Notes: string;
    public DeveloperContactId: string;
    public DeveloperName: string;
    public DeveloperProfilePhotoUrl: string;
    public DeveloperProfilePhotoThumbnail: string;
    public RecordStatus: string;
    public Stages: GeoEstateStageModel[];
    public CurrentEstateStageId: string;
    public CurrentEstateStageName: string;

    public constructor(init?: Partial<GeoEstateModel>) { (Object as any).assign(this, init); }
}

export class GetEstatesResponse
{
    public Estates: GeoEstateModel[];
    public ResponseStatus: ResponseStatus;

    public constructor(init?: Partial<GetEstatesResponse>) { (Object as any).assign(this, init); }
}

/** @description Get all estates for the specified criteria */
// @Api(Description="Get all estates for the specified criteria")
export class GetEstates
{
    /** @description Get an estate that matches the specified ID. */
    // @ApiMember(Description="Get an estate that matches the specified ID.", Name="GeoEstateId")
    public GeoEstateId: string;

    /** @description 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 RecordStatus: string;

    public constructor(init?: Partial<GetEstates>) { (Object as any).assign(this, init); }
}

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