| All Verbs | /api/estates |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| GeoEstateId | query | Guid | No | Get an estate that matches the specified ID. |
| RecordStatus | query | string | No | Get estates with a matching record status. A=active I=inactive D=deleted. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Estates | form | List<GeoEstateModel> | No | |
| ResponseStatus | form | ResponseStatus | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| GeoEstateId | form | Guid | No | |
| Name | form | string | No | |
| Notes | form | string | No | |
| DeveloperContactId | form | Guid | No | |
| DeveloperName | form | string | No | |
| DeveloperProfilePhotoUrl | form | string | No | |
| DeveloperProfilePhotoThumbnail | form | string | No | |
| RecordStatus | form | string | No | |
| Stages | form | List<GeoEstateStageModel> | No | |
| CurrentEstateStageId | form | Guid | No | |
| CurrentEstateStageName | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| GeoEstateStageId | form | Guid | No | |
| GeoEstateId | form | Guid | No | |
| Name | form | string | No | |
| Notes | form | string | No | |
| RecordStatus | form | string | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
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: text/csv
Content-Type: text/csv
Content-Length: length
{"GeoEstateId":"00000000-0000-0000-0000-000000000000","RecordStatus":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
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"}}}