| 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()),
});
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
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/xml
Content-Type: application/xml
Content-Length: length
<GetEstates xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
<GeoEstateId>00000000-0000-0000-0000-000000000000</GeoEstateId>
<RecordStatus>String</RecordStatus>
</GetEstates>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<GetEstatesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
<Estates xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eros.Saguna.Common.WebAPIModel.Models">
<d2p1:GeoEstateModel>
<d2p1:CurrentEstateStageId>00000000-0000-0000-0000-000000000000</d2p1:CurrentEstateStageId>
<d2p1:CurrentEstateStageName>String</d2p1:CurrentEstateStageName>
<d2p1:DeveloperContactId>00000000-0000-0000-0000-000000000000</d2p1:DeveloperContactId>
<d2p1:DeveloperName>String</d2p1:DeveloperName>
<d2p1:DeveloperProfilePhotoThumbnail>String</d2p1:DeveloperProfilePhotoThumbnail>
<d2p1:DeveloperProfilePhotoUrl>String</d2p1:DeveloperProfilePhotoUrl>
<d2p1:GeoEstateId>00000000-0000-0000-0000-000000000000</d2p1:GeoEstateId>
<d2p1:Name>String</d2p1:Name>
<d2p1:Notes>String</d2p1:Notes>
<d2p1:RecordStatus>String</d2p1:RecordStatus>
<d2p1:Stages>
<d2p1:GeoEstateStageModel>
<d2p1:GeoEstateId>00000000-0000-0000-0000-000000000000</d2p1:GeoEstateId>
<d2p1:GeoEstateStageId>00000000-0000-0000-0000-000000000000</d2p1:GeoEstateStageId>
<d2p1:Name>String</d2p1:Name>
<d2p1:Notes>String</d2p1:Notes>
<d2p1:RecordStatus>String</d2p1:RecordStatus>
</d2p1:GeoEstateStageModel>
</d2p1:Stages>
</d2p1:GeoEstateModel>
</Estates>
<ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:Message>String</d2p1:Message>
<d2p1:StackTrace>String</d2p1:StackTrace>
<d2p1:Errors>
<d2p1:ResponseError>
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:FieldName>String</d2p1:FieldName>
<d2p1:Message>String</d2p1:Message>
<d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringstring>
<d5p1:Key>String</d5p1:Key>
<d5p1:Value>String</d5p1:Value>
</d5p1:KeyValueOfstringstring>
</d2p1:Meta>
</d2p1:ResponseError>
</d2p1:Errors>
<d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:KeyValueOfstringstring>
<d3p1:Key>String</d3p1:Key>
<d3p1:Value>String</d3p1:Value>
</d3p1:KeyValueOfstringstring>
</d2p1:Meta>
</ResponseStatus>
</GetEstatesResponse>