| All Verbs | /api/estates |
|---|
<?php namespace dtos;
use DateTime;
use Exception;
use DateInterval;
use JsonSerializable;
use ServiceStack\{IReturn,IReturnVoid,IGet,IPost,IPut,IDelete,IPatch,IMeta,IHasSessionId,IHasBearerToken,IHasVersion};
use ServiceStack\{ICrud,ICreateDb,IUpdateDb,IPatchDb,IDeleteDb,ISaveDb,AuditBase,QueryDb,QueryDb2,QueryData,QueryData2,QueryResponse};
use ServiceStack\{ResponseStatus,ResponseError,EmptyResponse,IdResponse,ArrayList,KeyValuePair2,StringResponse,StringsResponse,Tuple2,Tuple3,ByteArray};
use ServiceStack\{JsonConverters,Returns,TypeContext};
class GeoEstateStageModel implements JsonSerializable
{
public function __construct(
/** @var string */
public string $GeoEstateStageId='',
/** @var string */
public string $GeoEstateId='',
/** @var string|null */
public ?string $Name=null,
/** @var string|null */
public ?string $Notes=null,
/** @var string|null */
public ?string $RecordStatus=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['GeoEstateStageId'])) $this->GeoEstateStageId = $o['GeoEstateStageId'];
if (isset($o['GeoEstateId'])) $this->GeoEstateId = $o['GeoEstateId'];
if (isset($o['Name'])) $this->Name = $o['Name'];
if (isset($o['Notes'])) $this->Notes = $o['Notes'];
if (isset($o['RecordStatus'])) $this->RecordStatus = $o['RecordStatus'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->GeoEstateStageId)) $o['GeoEstateStageId'] = $this->GeoEstateStageId;
if (isset($this->GeoEstateId)) $o['GeoEstateId'] = $this->GeoEstateId;
if (isset($this->Name)) $o['Name'] = $this->Name;
if (isset($this->Notes)) $o['Notes'] = $this->Notes;
if (isset($this->RecordStatus)) $o['RecordStatus'] = $this->RecordStatus;
return empty($o) ? new class(){} : $o;
}
}
class GeoEstateModel implements JsonSerializable
{
public function __construct(
/** @var string */
public string $GeoEstateId='',
/** @var string|null */
public ?string $Name=null,
/** @var string|null */
public ?string $Notes=null,
/** @var string */
public string $DeveloperContactId='',
/** @var string|null */
public ?string $DeveloperName=null,
/** @var string|null */
public ?string $DeveloperProfilePhotoUrl=null,
/** @var string|null */
public ?string $DeveloperProfilePhotoThumbnail=null,
/** @var string|null */
public ?string $RecordStatus=null,
/** @var array<GeoEstateStageModel>|null */
public ?array $Stages=null,
/** @var string */
public string $CurrentEstateStageId='',
/** @var string|null */
public ?string $CurrentEstateStageName=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['GeoEstateId'])) $this->GeoEstateId = $o['GeoEstateId'];
if (isset($o['Name'])) $this->Name = $o['Name'];
if (isset($o['Notes'])) $this->Notes = $o['Notes'];
if (isset($o['DeveloperContactId'])) $this->DeveloperContactId = $o['DeveloperContactId'];
if (isset($o['DeveloperName'])) $this->DeveloperName = $o['DeveloperName'];
if (isset($o['DeveloperProfilePhotoUrl'])) $this->DeveloperProfilePhotoUrl = $o['DeveloperProfilePhotoUrl'];
if (isset($o['DeveloperProfilePhotoThumbnail'])) $this->DeveloperProfilePhotoThumbnail = $o['DeveloperProfilePhotoThumbnail'];
if (isset($o['RecordStatus'])) $this->RecordStatus = $o['RecordStatus'];
if (isset($o['Stages'])) $this->Stages = JsonConverters::fromArray('GeoEstateStageModel', $o['Stages']);
if (isset($o['CurrentEstateStageId'])) $this->CurrentEstateStageId = $o['CurrentEstateStageId'];
if (isset($o['CurrentEstateStageName'])) $this->CurrentEstateStageName = $o['CurrentEstateStageName'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->GeoEstateId)) $o['GeoEstateId'] = $this->GeoEstateId;
if (isset($this->Name)) $o['Name'] = $this->Name;
if (isset($this->Notes)) $o['Notes'] = $this->Notes;
if (isset($this->DeveloperContactId)) $o['DeveloperContactId'] = $this->DeveloperContactId;
if (isset($this->DeveloperName)) $o['DeveloperName'] = $this->DeveloperName;
if (isset($this->DeveloperProfilePhotoUrl)) $o['DeveloperProfilePhotoUrl'] = $this->DeveloperProfilePhotoUrl;
if (isset($this->DeveloperProfilePhotoThumbnail)) $o['DeveloperProfilePhotoThumbnail'] = $this->DeveloperProfilePhotoThumbnail;
if (isset($this->RecordStatus)) $o['RecordStatus'] = $this->RecordStatus;
if (isset($this->Stages)) $o['Stages'] = JsonConverters::toArray('GeoEstateStageModel', $this->Stages);
if (isset($this->CurrentEstateStageId)) $o['CurrentEstateStageId'] = $this->CurrentEstateStageId;
if (isset($this->CurrentEstateStageName)) $o['CurrentEstateStageName'] = $this->CurrentEstateStageName;
return empty($o) ? new class(){} : $o;
}
}
class GetEstatesResponse implements JsonSerializable
{
public function __construct(
/** @var array<GeoEstateModel>|null */
public ?array $Estates=null,
/** @var ResponseStatus|null */
public ?ResponseStatus $ResponseStatus=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['Estates'])) $this->Estates = JsonConverters::fromArray('GeoEstateModel', $o['Estates']);
if (isset($o['ResponseStatus'])) $this->ResponseStatus = JsonConverters::from('ResponseStatus', $o['ResponseStatus']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->Estates)) $o['Estates'] = JsonConverters::toArray('GeoEstateModel', $this->Estates);
if (isset($this->ResponseStatus)) $o['ResponseStatus'] = JsonConverters::to('ResponseStatus', $this->ResponseStatus);
return empty($o) ? new class(){} : $o;
}
}
/** @description Get all estates for the specified criteria */
// @Api(Description="Get all estates for the specified criteria")
class GetEstates implements JsonSerializable
{
public function __construct(
/** @description Get an estate that matches the specified ID. */
// @ApiMember(Description="Get an estate that matches the specified ID.", Name="GeoEstateId")
/** @var string */
public string $GeoEstateId='',
/** @description 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")
/** @var string|null */
public ?string $RecordStatus=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['GeoEstateId'])) $this->GeoEstateId = $o['GeoEstateId'];
if (isset($o['RecordStatus'])) $this->RecordStatus = $o['RecordStatus'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->GeoEstateId)) $o['GeoEstateId'] = $this->GeoEstateId;
if (isset($this->RecordStatus)) $o['RecordStatus'] = $this->RecordStatus;
return empty($o) ? new class(){} : $o;
}
}
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>