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
namespace Eros.Subtle.Canvara.WebAPIModel.ServiceModel

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type GeoEstateStageModel() = 
        member val GeoEstateStageId:Guid = new Guid() with get,set
        member val GeoEstateId:Guid = new Guid() with get,set
        member val Name:String = null with get,set
        member val Notes:String = null with get,set
        member val RecordStatus:String = null with get,set

    [<AllowNullLiteral>]
    type GeoEstateModel() = 
        member val GeoEstateId:Guid = new Guid() with get,set
        member val Name:String = null with get,set
        member val Notes:String = null with get,set
        member val DeveloperContactId:Guid = new Guid() with get,set
        member val DeveloperName:String = null with get,set
        member val DeveloperProfilePhotoUrl:String = null with get,set
        member val DeveloperProfilePhotoThumbnail:String = null with get,set
        member val RecordStatus:String = null with get,set
        member val Stages:ResizeArray<GeoEstateStageModel> = null with get,set
        member val CurrentEstateStageId:Guid = new Guid() with get,set
        member val CurrentEstateStageName:String = null with get,set

    [<AllowNullLiteral>]
    type GetEstatesResponse() = 
        member val Estates:ResizeArray<GeoEstateModel> = null with get,set
        member val ResponseStatus:ResponseStatus = null with get,set

    ///<summary>
    ///Get all estates for the specified criteria
    ///</summary>
    [<Api(Description="Get all estates for the specified criteria")>]
    [<AllowNullLiteral>]
    type GetEstates() = 
        ///<summary>
        ///Get an estate that matches the specified ID.
        ///</summary>
        [<ApiMember(Description="Get an estate that matches the specified ID.", Name="GeoEstateId")>]
        member val GeoEstateId:Guid = new Guid() with 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")>]
        member val RecordStatus:String = null with get,set

F# GetEstates DTOs

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

HTTP + OTHER

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

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

HTTP/1.1 200 OK
Content-Type: text/jsonl
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"}}}