| All Verbs | /api/estates |
|---|
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; }
}
}
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>