Platform API

<back to all web services

GetEstates

Get all estates for the specified criteria

The following routes are available for this service:
All Verbs/api/estates
"use strict";
export class GeoEstateStageModel {
    /** @param {{GeoEstateStageId?:string,GeoEstateId?:string,Name?:string,Notes?:string,RecordStatus?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    GeoEstateStageId;
    /** @type {string} */
    GeoEstateId;
    /** @type {string} */
    Name;
    /** @type {string} */
    Notes;
    /** @type {string} */
    RecordStatus;
}
export class GeoEstateModel {
    /** @param {{GeoEstateId?:string,Name?:string,Notes?:string,DeveloperContactId?:string,DeveloperName?:string,DeveloperProfilePhotoUrl?:string,DeveloperProfilePhotoThumbnail?:string,RecordStatus?:string,Stages?:GeoEstateStageModel[],CurrentEstateStageId?:string,CurrentEstateStageName?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    GeoEstateId;
    /** @type {string} */
    Name;
    /** @type {string} */
    Notes;
    /** @type {string} */
    DeveloperContactId;
    /** @type {string} */
    DeveloperName;
    /** @type {string} */
    DeveloperProfilePhotoUrl;
    /** @type {string} */
    DeveloperProfilePhotoThumbnail;
    /** @type {string} */
    RecordStatus;
    /** @type {GeoEstateStageModel[]} */
    Stages;
    /** @type {string} */
    CurrentEstateStageId;
    /** @type {string} */
    CurrentEstateStageName;
}
export class GetEstatesResponse {
    /** @param {{Estates?:GeoEstateModel[],ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {GeoEstateModel[]} */
    Estates;
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class GetEstates {
    /** @param {{GeoEstateId?:string,RecordStatus?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description Get an estate that matches the specified ID. */
    GeoEstateId;
    /**
     * @type {string}
     * @description Get estates with a matching record status. A=active I=inactive D=deleted. */
    RecordStatus;
}

JavaScript GetEstates DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

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/csv
Content-Type: text/csv
Content-Length: length

{"GeoEstateId":"00000000-0000-0000-0000-000000000000","RecordStatus":"String"}

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Estates":[{"GeoEstateId":"00000000-0000-0000-0000-000000000000","Name":"String","Notes":"String","DeveloperContactId":"00000000-0000-0000-0000-000000000000","DeveloperName":"String","DeveloperProfilePhotoUrl":"String","DeveloperProfilePhotoThumbnail":"String","RecordStatus":"String","Stages":[{"GeoEstateStageId":"00000000-0000-0000-0000-000000000000","GeoEstateId":"00000000-0000-0000-0000-000000000000","Name":"String","Notes":"String","RecordStatus":"String"}],"CurrentEstateStageId":"00000000-0000-0000-0000-000000000000","CurrentEstateStageName":"String"}],"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}