Platform API

GetEstates

Get all estates for the specified criteria

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

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

Namespace Global

    Namespace Eros.Saguna.Common.WebAPIModel.Models

        Public Partial Class GeoEstateModel
            Public Overridable Property GeoEstateId As Guid
            Public Overridable Property Name As String
            Public Overridable Property Notes As String
            Public Overridable Property DeveloperContactId As Guid
            Public Overridable Property DeveloperName As String
            Public Overridable Property DeveloperProfilePhotoUrl As String
            Public Overridable Property DeveloperProfilePhotoThumbnail As String
            Public Overridable Property RecordStatus As String
            Public Overridable Property Stages As List(Of GeoEstateStageModel)
            Public Overridable Property CurrentEstateStageId As Guid
            Public Overridable Property CurrentEstateStageName As String
        End Class

        Public Partial Class GeoEstateStageModel
            Public Overridable Property GeoEstateStageId As Guid
            Public Overridable Property GeoEstateId As Guid
            Public Overridable Property Name As String
            Public Overridable Property Notes As String
            Public Overridable Property RecordStatus As String
        End Class
    End Namespace

    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 Overridable Property GeoEstateId As Guid

            '''<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 Overridable Property RecordStatus As String
        End Class

        Public Partial Class GetEstatesResponse
            Public Overridable Property Estates As List(Of GeoEstateModel)
            Public Overridable Property ResponseStatus As ResponseStatus
        End Class
    End Namespace
End Namespace

VB.NET GetEstates DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json
Content-Type: application/json
Content-Length: length

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

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