Platform API

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 .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>