Platform API

GetEstates

Get all estates for the specified criteria

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

import 'package:servicestack/servicestack.dart';

class GeoEstateStageModel implements IConvertible
{
    String? GeoEstateStageId;
    String? GeoEstateId;
    String? Name;
    String? Notes;
    String? RecordStatus;

    GeoEstateStageModel({this.GeoEstateStageId,this.GeoEstateId,this.Name,this.Notes,this.RecordStatus});
    GeoEstateStageModel.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        GeoEstateStageId = json['GeoEstateStageId'];
        GeoEstateId = json['GeoEstateId'];
        Name = json['Name'];
        Notes = json['Notes'];
        RecordStatus = json['RecordStatus'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'GeoEstateStageId': GeoEstateStageId,
        'GeoEstateId': GeoEstateId,
        'Name': Name,
        'Notes': Notes,
        'RecordStatus': RecordStatus
    };

    getTypeName() => "GeoEstateStageModel";
    TypeContext? context = _ctx;
}

class GeoEstateModel implements IConvertible
{
    String? GeoEstateId;
    String? Name;
    String? Notes;
    String? DeveloperContactId;
    String? DeveloperName;
    String? DeveloperProfilePhotoUrl;
    String? DeveloperProfilePhotoThumbnail;
    String? RecordStatus;
    List<GeoEstateStageModel>? Stages;
    String? CurrentEstateStageId;
    String? CurrentEstateStageName;

    GeoEstateModel({this.GeoEstateId,this.Name,this.Notes,this.DeveloperContactId,this.DeveloperName,this.DeveloperProfilePhotoUrl,this.DeveloperProfilePhotoThumbnail,this.RecordStatus,this.Stages,this.CurrentEstateStageId,this.CurrentEstateStageName});
    GeoEstateModel.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        GeoEstateId = json['GeoEstateId'];
        Name = json['Name'];
        Notes = json['Notes'];
        DeveloperContactId = json['DeveloperContactId'];
        DeveloperName = json['DeveloperName'];
        DeveloperProfilePhotoUrl = json['DeveloperProfilePhotoUrl'];
        DeveloperProfilePhotoThumbnail = json['DeveloperProfilePhotoThumbnail'];
        RecordStatus = json['RecordStatus'];
        Stages = JsonConverters.fromJson(json['Stages'],'List<GeoEstateStageModel>',context!);
        CurrentEstateStageId = json['CurrentEstateStageId'];
        CurrentEstateStageName = json['CurrentEstateStageName'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'GeoEstateId': GeoEstateId,
        'Name': Name,
        'Notes': Notes,
        'DeveloperContactId': DeveloperContactId,
        'DeveloperName': DeveloperName,
        'DeveloperProfilePhotoUrl': DeveloperProfilePhotoUrl,
        'DeveloperProfilePhotoThumbnail': DeveloperProfilePhotoThumbnail,
        'RecordStatus': RecordStatus,
        'Stages': JsonConverters.toJson(Stages,'List<GeoEstateStageModel>',context!),
        'CurrentEstateStageId': CurrentEstateStageId,
        'CurrentEstateStageName': CurrentEstateStageName
    };

    getTypeName() => "GeoEstateModel";
    TypeContext? context = _ctx;
}

class GetEstatesResponse implements IConvertible
{
    List<GeoEstateModel>? Estates;
    ResponseStatus? ResponseStatus;

    GetEstatesResponse({this.Estates,this.ResponseStatus});
    GetEstatesResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Estates = JsonConverters.fromJson(json['Estates'],'List<GeoEstateModel>',context!);
        ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Estates': JsonConverters.toJson(Estates,'List<GeoEstateModel>',context!),
        'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!)
    };

    getTypeName() => "GetEstatesResponse";
    TypeContext? context = _ctx;
}

/**
* Get all estates for the specified criteria
*/
// @Api(Description="Get all estates for the specified criteria")
class GetEstates implements IConvertible
{
    /**
    * Get an estate that matches the specified ID.
    */
    // @ApiMember(Description="Get an estate that matches the specified ID.", Name="GeoEstateId")
    String? GeoEstateId;

    /**
    * 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")
    String? RecordStatus;

    GetEstates({this.GeoEstateId,this.RecordStatus});
    GetEstates.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        GeoEstateId = json['GeoEstateId'];
        RecordStatus = json['RecordStatus'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'GeoEstateId': GeoEstateId,
        'RecordStatus': RecordStatus
    };

    getTypeName() => "GetEstates";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'pfapi.pstpf.com.au', types: <String, TypeInfo> {
    'GeoEstateStageModel': TypeInfo(TypeOf.Class, create:() => GeoEstateStageModel()),
    'GeoEstateModel': TypeInfo(TypeOf.Class, create:() => GeoEstateModel()),
    'List<GeoEstateStageModel>': TypeInfo(TypeOf.Class, create:() => <GeoEstateStageModel>[]),
    'GetEstatesResponse': TypeInfo(TypeOf.Class, create:() => GetEstatesResponse()),
    'List<GeoEstateModel>': TypeInfo(TypeOf.Class, create:() => <GeoEstateModel>[]),
    'GetEstates': TypeInfo(TypeOf.Class, create:() => GetEstates()),
});

Dart 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"}}}