Platform API

<back to all web services

GetEstates

Get all estates for the specified criteria

import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    /**
    * Get all estates for the specified criteria
    */
    @Api(Description="Get all estates for the specified criteria")
    public static class GetEstates
    {
        /**
        * Get an estate that matches the specified ID.
        */
        @ApiMember(Description="Get an estate that matches the specified ID.", Name="GeoEstateId")
        public UUID GeoEstateId = null;

        /**
        * Get estates with a matching record status. A=active I=inactive D=deleted.
        */
        @ApiMember(Description="Get estates with a matching record status. A=active I=inactive D=deleted.", Name="RecordStatus")
        public String RecordStatus = null;
        
        public UUID getGeoEstateId() { return GeoEstateId; }
        public GetEstates setGeoEstateId(UUID value) { this.GeoEstateId = value; return this; }
        public String getRecordStatus() { return RecordStatus; }
        public GetEstates setRecordStatus(String value) { this.RecordStatus = value; return this; }
    }

    public static class GetEstatesResponse
    {
        public ArrayList<GeoEstateModel> Estates = null;
        public ResponseStatus ResponseStatus = null;
        
        public ArrayList<GeoEstateModel> getEstates() { return Estates; }
        public GetEstatesResponse setEstates(ArrayList<GeoEstateModel> value) { this.Estates = value; return this; }
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public GetEstatesResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
    }

    public static class GeoEstateModel
    {
        public UUID GeoEstateId = null;
        public String Name = null;
        public String Notes = null;
        public UUID DeveloperContactId = null;
        public String DeveloperName = null;
        public String DeveloperProfilePhotoUrl = null;
        public String DeveloperProfilePhotoThumbnail = null;
        public String RecordStatus = null;
        public ArrayList<GeoEstateStageModel> Stages = null;
        public UUID CurrentEstateStageId = null;
        public String CurrentEstateStageName = null;
        
        public UUID getGeoEstateId() { return GeoEstateId; }
        public GeoEstateModel setGeoEstateId(UUID value) { this.GeoEstateId = value; return this; }
        public String getName() { return Name; }
        public GeoEstateModel setName(String value) { this.Name = value; return this; }
        public String getNotes() { return Notes; }
        public GeoEstateModel setNotes(String value) { this.Notes = value; return this; }
        public UUID getDeveloperContactId() { return DeveloperContactId; }
        public GeoEstateModel setDeveloperContactId(UUID value) { this.DeveloperContactId = value; return this; }
        public String getDeveloperName() { return DeveloperName; }
        public GeoEstateModel setDeveloperName(String value) { this.DeveloperName = value; return this; }
        public String getDeveloperProfilePhotoUrl() { return DeveloperProfilePhotoUrl; }
        public GeoEstateModel setDeveloperProfilePhotoUrl(String value) { this.DeveloperProfilePhotoUrl = value; return this; }
        public String getDeveloperProfilePhotoThumbnail() { return DeveloperProfilePhotoThumbnail; }
        public GeoEstateModel setDeveloperProfilePhotoThumbnail(String value) { this.DeveloperProfilePhotoThumbnail = value; return this; }
        public String getRecordStatus() { return RecordStatus; }
        public GeoEstateModel setRecordStatus(String value) { this.RecordStatus = value; return this; }
        public ArrayList<GeoEstateStageModel> getStages() { return Stages; }
        public GeoEstateModel setStages(ArrayList<GeoEstateStageModel> value) { this.Stages = value; return this; }
        public UUID getCurrentEstateStageId() { return CurrentEstateStageId; }
        public GeoEstateModel setCurrentEstateStageId(UUID value) { this.CurrentEstateStageId = value; return this; }
        public String getCurrentEstateStageName() { return CurrentEstateStageName; }
        public GeoEstateModel setCurrentEstateStageName(String value) { this.CurrentEstateStageName = value; return this; }
    }

    public static class GeoEstateStageModel
    {
        public UUID GeoEstateStageId = null;
        public UUID GeoEstateId = null;
        public String Name = null;
        public String Notes = null;
        public String RecordStatus = null;
        
        public UUID getGeoEstateStageId() { return GeoEstateStageId; }
        public GeoEstateStageModel setGeoEstateStageId(UUID value) { this.GeoEstateStageId = value; return this; }
        public UUID getGeoEstateId() { return GeoEstateId; }
        public GeoEstateStageModel setGeoEstateId(UUID value) { this.GeoEstateId = value; return this; }
        public String getName() { return Name; }
        public GeoEstateStageModel setName(String value) { this.Name = value; return this; }
        public String getNotes() { return Notes; }
        public GeoEstateStageModel setNotes(String value) { this.Notes = value; return this; }
        public String getRecordStatus() { return RecordStatus; }
        public GeoEstateStageModel setRecordStatus(String value) { this.RecordStatus = value; return this; }
    }

}

Java GetEstates DTOs

POST /api/estates HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	RecordStatus: String
}

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

{
	Estates: 
	[
		{
			Name: String,
			Notes: String,
			DeveloperName: String,
			DeveloperProfilePhotoUrl: String,
			DeveloperProfilePhotoThumbnail: String,
			RecordStatus: String,
			Stages: 
			[
				{
					Name: String,
					Notes: String,
					RecordStatus: String
				}
			],
			CurrentEstateStageName: String
		}
	],
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}