Platform API

GetEstates

Get all estates for the specified criteria

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

using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Eros.Subtle.Canvara.WebAPIModel.ServiceModel;
using Eros.Saguna.Common.WebAPIModel.Models;

namespace Eros.Saguna.Common.WebAPIModel.Models
{
    public partial class GeoEstateModel
    {
        public virtual Guid GeoEstateId { get; set; }
        public virtual string Name { get; set; }
        public virtual string Notes { get; set; }
        public virtual Guid DeveloperContactId { get; set; }
        public virtual string DeveloperName { get; set; }
        public virtual string DeveloperProfilePhotoUrl { get; set; }
        public virtual string DeveloperProfilePhotoThumbnail { get; set; }
        public virtual string RecordStatus { get; set; }
        public virtual List<GeoEstateStageModel> Stages { get; set; }
        public virtual Guid CurrentEstateStageId { get; set; }
        public virtual string CurrentEstateStageName { get; set; }
    }

    public partial class GeoEstateStageModel
    {
        public virtual Guid GeoEstateStageId { get; set; }
        public virtual Guid GeoEstateId { get; set; }
        public virtual string Name { get; set; }
        public virtual string Notes { get; set; }
        public virtual string RecordStatus { get; set; }
    }

}

namespace Eros.Subtle.Canvara.WebAPIModel.ServiceModel
{
    ///<summary>
    ///Get all estates for the specified criteria
    ///</summary>
    [Api(Description="Get all estates for the specified criteria")]
    public partial class GetEstates
    {
        ///<summary>
        ///Get an estate that matches the specified ID.
        ///</summary>
        [ApiMember(Description="Get an estate that matches the specified ID.", Name="GeoEstateId")]
        public virtual Guid GeoEstateId { get; set; }

        ///<summary>
        ///Get estates with a matching record status. A=active I=inactive D=deleted.
        ///</summary>
        [ApiMember(Description="Get estates with a matching record status. A=active I=inactive D=deleted.", Name="RecordStatus")]
        public virtual string RecordStatus { get; set; }
    }

    public partial class GetEstatesResponse
    {
        public virtual List<GeoEstateModel> Estates { get; set; }
        public virtual ResponseStatus ResponseStatus { get; set; }
    }

}

C# 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"}}}