{ "openapi": "3.0.4", "info": { "title": "Domain Public API", "description": "See https://developer.domain.com.au for more information", "termsOfService": "https://developer.domain.com.au/docs/latest/support/terms", "contact": { "name": "Domain Developer Support", "email": "api@domain.com.au" }, "version": "latest" }, "servers": [ { "url": "https://api.domain.com.au/", "description": "Primary" }, { "url": "https://api.domain.com.au/sandbox/", "description": "Sandbox" } ], "paths": { "/v1/addressLocators": { "get": { "tags": [ "AddressLocators" ], "summary": "Address Locator API", "description": "Retrieves address matching ids for use in other services.", "operationId": "AddressLocators_Get", "parameters": [ { "name": "searchLevel", "in": "query", "description": "Requested search level. Valid values are: Address, and Suburb.", "required": true, "schema": { "type": "string" } }, { "name": "unitNumber", "in": "query", "description": "Unit number of the address.", "schema": { "type": "string" } }, { "name": "streetNumber", "in": "query", "description": "Street number of the address.", "schema": { "type": "string" } }, { "name": "streetName", "in": "query", "description": "Street name of the address.", "schema": { "type": "string" } }, { "name": "streetType", "in": "query", "description": "Street type of the address. Can take long or short street type", "schema": { "type": "string" } }, { "name": "suburb", "in": "query", "description": "Suburb name of the address.", "required": true, "schema": { "type": "string" } }, { "name": "state", "in": "query", "description": "State abbreviation of the address.", "required": true, "schema": { "type": "string" } }, { "name": "postcode", "in": "query", "description": "Postcode of the address.", "schema": { "pattern": "^\\d{4}$", "type": "string" } } ], "responses": { "200": { "description": "Retrieve address IDs that may be used to query information from other endpoints." }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "500": { "description": "Unexpected error" } }, "security": [ { "apikey": [] }, { "oauth2": [ "api_addresslocators_read" ] } ], "x-domain-endpointcost": 1, "x-domain-usercontextrequired": false, "x-domain-environment": "Any" } }, "/v1/agencies": { "get": { "tags": [ "Agencies" ], "summary": "Retrieves summary of agencies matching the specified criteria.", "description": "\nThe ```q``` parameter supports:\r\n", "operationId": "Agencies_Search", "parameters": [ { "name": "q", "in": "query", "description": "Search phrase. e.g. name:\"Agency XYZ\"", "schema": { "type": "string" } }, { "name": "pageNumber", "in": "query", "description": "Page number for paginated results", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "description": "Page size for paginated results", "schema": { "type": "integer", "format": "int32", "default": 20 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Agencies.V2.AgencySummary" } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "apikey": [] }, { "oauth2": [ "api_agencies_read" ] } ], "x-domain-endpointcost": 1, "x-domain-usercontextrequired": false, "x-domain-environment": "Any" }, "head": { "tags": [ "Agencies" ], "summary": "Retrieves summary of agency search.", "description": "Given a specified agency search criteria, this endpoint can be used to ascertain the result count that can be expected.\r\n\r\nSee `X-Total-Count` header for result count.", "operationId": "Agencies_Head", "parameters": [ { "name": "q", "in": "query", "description": "Search phrase. e.g. name:\"Agency XYZ\"", "schema": { "type": "string" } }, { "name": "pageNumber", "in": "query", "description": "Page number for paginated results", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "description": "Page size for paginated results", "schema": { "type": "integer", "format": "int32", "default": 20 } } ], "responses": { "204": { "description": "No Content" }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "apikey": [] }, { "oauth2": [ "api_agencies_read" ] } ], "x-domain-endpointcost": 1, "x-domain-usercontextrequired": false, "x-domain-environment": "Any" } }, "/v1/agencies/_testAgency": { "post": { "tags": [ "Agencies" ], "summary": "Create a test agency for sandbox testing", "description": "Enables automatic creation of a test agency in our sandbox environment.", "operationId": "Agencies_CreateTestAgency", "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Agencies.V2.Agency" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "apikey": [] }, { "oauth2": [ "api_agencies_write" ] } ], "x-domain-endpointcost": 1, "x-domain-usercontextrequired": true, "x-domain-environment": "Sandbox" } }, "/v1/agencies/{id}": { "get": { "tags": [ "Agencies" ], "summary": "Retrieves a specific agency details.", "operationId": "Agencies_Get", "parameters": [ { "name": "id", "in": "path", "description": "Agency identifier", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Agencies.V2.Agency" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "apikey": [] }, { "oauth2": [ "api_agencies_read" ] } ], "x-domain-endpointcost": 1, "x-domain-usercontextrequired": false, "x-domain-environment": "Any" } }, "/v1/agencies/{id}/listings": { "get": { "tags": [ "Agencies" ], "summary": "Retrieves listings across all channels for a specific agency matching specified criteria.", "description": "Note that the result page size is clamped at 200. Requesting a page size greater than this will be treated as if only a page size of 200 were requested.", "operationId": "Agencies_GetListings", "parameters": [ { "name": "id", "in": "path", "description": "Id of the agency", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "listingStatusFilter", "in": "query", "description": "Filter for listing status", "schema": { "enum": [ "live", "liveAndArchived" ], "type": "string", "description": "Which listings to filter based on status in lifecycle", "default": "live" } }, { "name": "dateUpdatedSince", "in": "query", "description": "Filter to remove listings not updated since before the given date time", "schema": { "type": "string", "format": "date-time" } }, { "name": "pageNumber", "in": "query", "description": "Page number for paginated results", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "description": "Page size for paginated results", "schema": { "type": "integer", "format": "int32", "default": 20 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Listings.V1.Listing" } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "apikey": [] }, { "oauth2": [ "api_listings_read" ] } ], "x-domain-endpointcost": 1, "x-domain-usercontextrequired": false, "x-domain-environment": "Any" } }, "/v1/agencies/{id}/statistics": { "get": { "tags": [ "Agencies" ], "summary": "Retrieves statistics for a specific agency.", "operationId": "Agencies_GetStatistics", "parameters": [ { "name": "id", "in": "path", "description": "Agency identifier", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "timePeriod", "in": "query", "description": "Period to report on, Valid values are: `last7Days`, `last90Days`, `wholeCampaign`. Default is `last7Days`.", "schema": { "enum": [ "last7Days", "last90Days", "wholeCampaign" ], "type": "string", "description": "Defines StatisticsTimePeriod", "default": "last7Days" } }, { "name": "statusFilter", "in": "query", "description": "Status to filter, Valid values are: `Live`, `LiveAndArchived`. Default is `LiveAndArchived`", "schema": { "enum": [ "live", "liveAndArchived" ], "type": "string", "description": "Which listings to filter based on status in lifecycle", "default": "liveAndArchived" } }, { "name": "channel", "in": "query", "description": "Filter statistics for the given channel", "schema": { "enum": [ "residential", "commercial", "business" ], "type": "string", "description": "Channel of the listing", "default": "residential" } }, { "name": "pageNumber", "in": "query", "description": "Page number", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "description": "Page size", "schema": { "type": "integer", "format": "int32", "default": 20 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ListingPerformance.v1.Statistics" } } } } } }, "security": [ { "apikey": [] }, { "oauth2": [ "api_agencies_read" ] } ], "x-domain-endpointcost": 1, "x-domain-usercontextrequired": true, "x-domain-environment": "Any" } }, "/v1/agents/{id}": { "get": { "tags": [ "Agents" ], "summary": "Retrieves a specific agent details, including contact information.", "operationId": "Agents_Get", "parameters": [ { "name": "id", "in": "path", "description": "Agent identifier", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Agencies.V1.Agent" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "apikey": [] }, { "oauth2": [ "api_agencies_read" ] } ], "x-domain-endpointcost": 1, "x-domain-usercontextrequired": false, "x-domain-environment": "Any" } }, "/v1/agents/{id}/listings": { "get": { "tags": [ "Agents" ], "summary": "Gets listing using the contact id", "operationId": "Agents_GetListings", "parameters": [ { "name": "id", "in": "path", "description": "Id of the agent (contact)", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "dateUpdatedSince", "in": "query", "description": "Filter to remove listings not updated since before the given date time", "schema": { "type": "string", "format": "date-time" } }, { "name": "includedArchivedListings", "in": "query", "description": "Filter to remove listings that have been archived", "schema": { "type": "boolean", "default": false } }, { "name": "pageNumber", "in": "query", "description": "Page number for paginated results", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "description": "Page size for paginated results", "schema": { "type": "integer", "format": "int32", "default": 20 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Listings.V1.Listing" } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "apikey": [] }, { "oauth2": [ "api_listings_read" ] } ], "x-domain-endpointcost": 1, "x-domain-usercontextrequired": false, "x-domain-environment": "Any" } }, "/v1/agents/{id}/statistics": { "get": { "tags": [ "Agents" ], "summary": "Retrieves stats for the listings of a given agent", "operationId": "Agents_GetStatistics", "parameters": [ { "name": "id", "in": "path", "description": "Agent identifier", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "timePeriod", "in": "query", "description": "The time period to show statistics for. Valid values are: `last7Days`, `last90Days`, `wholeCampaign`", "schema": { "enum": [ "last7Days", "last90Days", "wholeCampaign" ], "type": "string", "description": "Defines StatisticsTimePeriod", "default": "last7Days" } }, { "name": "statusFilter", "in": "query", "description": "Listing filter", "schema": { "enum": [ "live", "liveAndArchived" ], "type": "string", "description": "Which listings to filter based on status in lifecycle", "default": "liveAndArchived" } }, { "name": "channel", "in": "query", "description": "Filter statistics for the given channel", "schema": { "enum": [ "residential", "commercial", "business" ], "type": "string", "description": "Channel of the listing", "default": "residential" } }, { "name": "pageNumber", "in": "query", "description": "Page number for paginated results", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "description": "Page size for paginated results", "schema": { "type": "integer", "format": "int32", "default": 20 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ListingPerformance.v1.Statistics" } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "apikey": [] }, { "oauth2": [ "api_agencies_read" ] } ], "x-domain-endpointcost": 1, "x-domain-usercontextrequired": true, "x-domain-environment": "Primary" } }, "/v1/agents/search": { "get": { "tags": [ "Agents" ], "summary": "Search for agents by name.", "description": "The returned Agent ID can be used to get an agent details by ID. See `GET /agents/{id}/`", "operationId": "Agents_Search", "parameters": [ { "name": "query", "in": "query", "description": "The name, or portion of name, to search for.", "required": true, "schema": { "type": "string" } }, { "name": "pageNumber", "in": "query", "description": "Page number for paginated results", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Page size for paginated results (maximum 20)", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Domain.AgentSearch.v1.Model.AutoSuggestAgentResultDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Domain.AgentSearch.v1.Model.AutoSuggestAgentResultDto" } } }, "text/html": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Domain.AgentSearch.v1.Model.AutoSuggestAgentResultDto" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Domain.AgentSearch.v1.Model.AutoSuggestAgentResultDto" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Domain.AgentSearch.v1.Model.AutoSuggestAgentResultDto" } } } } } }, "security": [ { "apikey": [] }, { "oauth2": [ "api_agencies_read" ] } ], "x-domain-usercontextrequired": false, "x-domain-endpointcost": 1, "x-domain-environment": "Primary" } }, "/v1/authorities": { "post": { "tags": [ "Authorities" ], "summary": "Creates a new authority into the system.", "description": "Creates a new authority into the system.", "operationId": "Authorities_Create", "requestBody": { "description": "Authority information to be created.", "content": { "application/vnd.realtimeagent.authorities.v1+json": { "schema": { "$ref": "#/components/schemas/Authorities.v1.AuthorityRequest" } } }, "required": true }, "responses": { "200": { "description": "authority created", "content": { "application/vnd.realtimeagent.authorities.v1+json": { "schema": { "$ref": "#/components/schemas/Authorities.v1.AuthorityResponse" } } } }, "400": { "description": "invalid input, object invalid" }, "401": { "description": "Unauthorized access." }, "409": { "description": "an existing authority already exists" } }, "security": [ { "apikey": [] }, { "oauth2": [ "api_authorities_write" ] } ], "x-domain-endpointcost": 1, "x-domain-usercontextrequired": false, "x-domain-environment": "Primary" } }, "/v1/authorities/{id}": { "get": { "tags": [ "Authorities" ], "summary": "Retrieve a single authority", "description": "Retrieve authority details based on the given ID.", "operationId": "Authorities_GetById", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Details of a single authority.", "content": { "application/vnd.realtimeagent.authorities.v1+json": { "schema": { "$ref": "#/components/schemas/Authorities.v1.AuthorityResponse" } } } }, "400": { "description": "invalid input, object invalid" }, "401": { "description": "Unauthorized access." }, "404": { "description": "Authority does not exist." } }, "security": [ { "apikey": [] }, { "oauth2": [ "api_authorities_write" ] } ], "x-domain-endpointcost": 1, "x-domain-usercontextrequired": false, "x-domain-environment": "Primary" }, "put": { "tags": [ "Authorities" ], "summary": "full update an existing authority.", "description": "Executes a full update on an existing authority.", "operationId": "Authorities_UpdateById", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "Authority information to be updated.", "content": { "application/vnd.realtimeagent.authorities.v1+json": { "schema": { "$ref": "#/components/schemas/Authorities.v1.AuthorityResponse" } } }, "required": true }, "responses": { "200": { "description": "authority updated", "content": { "application/vnd.realtimeagent.authorities.v1+json": { "schema": { "$ref": "#/components/schemas/Authorities.v1.AuthorityResponse" } } } }, "400": { "description": "invalid input, object invalid" }, "401": { "description": "Unauthorized access." }, "404": { "description": "Authority does not exist." } }, "security": [ { "apikey": [] }, { "oauth2": [ "api_authorities_write" ] } ], "x-domain-endpointcost": 1, "x-domain-usercontextrequired": false, "x-domain-environment": "Primary" } }, "/v1/authorities/{id}/attachments": { "get": { "tags": [ "Authorities" ], "summary": "Download a compressed file that contains all files attached to an authority.", "description": "Download a compressed file(`.zip`) that contains all files attached to an authority based on the given authority `id`.", "operationId": "Authorities_DownloadAttachments", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "The downloaded compressed file", "content": { "multipart/form-data": { "schema": { "type": "string", "format": "binary" } } } }, "401": { "description": "Unauthorized access." }, "404": { "description": "Authority does not exist." } }, "security": [ { "apikey": [] }, { "oauth2": [ "api_authorities_write" ] } ], "x-domain-endpointcost": 1, "x-domain-usercontextrequired": false, "x-domain-environment": "Primary" }, "post": { "tags": [ "Authorities" ], "summary": "Upload multiple files to an authority.", "description": "Upload multiple files to be attached to an authority based on the given `id`.", "operationId": "Authorities_UploadAttachment", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "The files to be uploaded.", "content": { "multipart/form-data": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Authorities.v1.Attachments" } } } } }, "responses": { "201": { "description": "The files that were uploaded.", "content": { "application/vnd.realtimeagent.authorities.v1+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Authorities.v1.Attachments" } } } } }, "400": { "description": "invalid input, object invalid" }, "401": { "description": "Unauthorized access." }, "404": { "description": "Authority does not exist." } }, "security": [ { "apikey": [] }, { "oauth2": [ "api_authorities_write" ] } ], "x-domain-endpointcost": 1, "x-domain-usercontextrequired": false, "x-domain-environment": "Primary" } }, "/v1/authorities/{id}/vendors/{vendorId}/attachments": { "post": { "tags": [ "Authorities" ], "summary": "Upload multiple files to be attached to a specific vendor in an authority.", "description": "Upload multiple files to be attached to a specific vendor in an authority.", "operationId": "Authorities_UploadVendorAttachment", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "vendorId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "The files to be uploaded.", "content": { "multipart/form-data": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Authorities.v1.Attachments" } } } } }, "responses": { "201": { "description": "The files that were uploaded.", "content": { "application/vnd.realtimeagent.authorities.v1+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Authorities.v1.VendorAttachments" } } } } }, "400": { "description": "invalid input, object invalid" }, "401": { "description": "Unauthorized access." }, "404": { "description": "Authority/Vendor does not exist." } }, "security": [ { "apikey": [] }, { "oauth2": [ "api_authorities_write" ] } ], "x-domain-endpointcost": 1, "x-domain-usercontextrequired": false, "x-domain-environment": "Primary" } }, "/v1/authorities/webhooks/subscription": { "put": { "tags": [ "Authorities" ], "summary": "Subscribe to an agency for all its authorities", "description": "Subscribe to an agency to get notified on changes made to the authorities in that agencies scope.", "operationId": "Authorities_Subscribe", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Authorities.v1.SubscriptionRequest" } } } }, "responses": { "201": { "description": "Subscription created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Authorities.v1.SubscriptionResponse" } } } }, "400": { "description": "invalid input, object invalid" }, "401": { "description": "Unauthorized access." } }, "security": [ { "apikey": [] }, { "oauth2": [ "api_webhooks_write" ] } ], "x-domain-optionalscopes": "api_authorities_write", "x-domain-endpointcost": 1, "x-domain-usercontextrequired": false, "x-domain-environment": "Primary" } }, "/v1/authorities/webhooks/subscription/{subscriptionId}": { "delete": { "tags": [ "Authorities" ], "summary": "Delete a subscription using subscriptionId", "description": "Delete a subscription using subscriptionId.", "operationId": "Authorities_Unsubscribe", "parameters": [ { "name": "subscriptionId", "in": "path", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success." }, "400": { "description": "invalid input, object invalid" }, "401": { "description": "Unauthorized access." } }, "security": [ { "apikey": [] }, { "oauth2": [ "api_webhooks_write" ] } ], "x-domain-endpointcost": 1, "x-domain-usercontextrequired": false, "x-domain-environment": "Primary" } }, "/v1/campaign/listing-performance": { "get": { "tags": [ "CampaignReporting" ], "summary": "Retrieves listing performance metrics for the New Developer Listings (linked to New Developer Projects) managed by advertisers.", "operationId": "Campaign_GetListingPerformance_Report", "parameters": [ { "name": "listingId", "in": "query", "schema": { "type": "string" } }, { "name": "projectId", "in": "query", "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "endDate", "in": "query", "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CampaignAPI.v1.ListingPerformanceDataResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/CampaignAPI.v1.HttpValidationProblemDetails" } } } }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "security": [ { "apikey": [] }, { "oauth2": [ "api_campaignperformance_read", "api_listingperformance_read" ] } ], "x-domain-endpointcost": 1, "x-domain-usercontextrequired": false, "x-domain-environment": "Any" } }, "/v1/campaign/project-performance": { "get": { "tags": [ "CampaignReporting" ], "summary": "Retrieves project performance metrics for the New Developer Projects managed by advertisers.", "operationId": "Campaign_GetProjectPerformance_Report", "parameters": [ { "name": "projectId", "in": "query", "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "endDate", "in": "query", "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CampaignAPI.v1.ProjectPerformanceDataResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/CampaignAPI.v1.HttpValidationProblemDetails" } } } }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "security": [ { "apikey": [] }, { "oauth2": [ "api_campaignperformance_read", "api_projectperformance_read" ] } ], "x-domain-endpointcost": 1, "x-domain-usercontextrequired": false, "x-domain-environment": "Any" } }, "/v2/dataset/{datasetName}/{key}": { "get": { "tags": [ "Dataset" ], "summary": "Get a value of a given key for a dataset", "operationId": "dataset_get", "parameters": [ { "name": "datasetName", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "key", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Request successfull. Responds with the value of the key of the dataset from the latest uploaded data" }, "400": { "description": "Dataset/Uploads/backing resources not found" }, "401": { "description": "Request is Unauthorized" }, "500": { "description": "Internal server error" } }, "security": [ { "apikey": [] }, { "oauth2": [ "api_dataset_read" ] } ], "x-domain-endpointcost": 1, "x-domain-usercontextrequired": false, "x-domain-environment": "Any" } }, "/v2/demographics/{state}/{suburb}/{postcode}": { "get": { "tags": [ "Demographics" ], "summary": "Demographics API", "description": "Search for demographics in a given geographic level.", "operationId": "Demographics_Get_ByNamedSuburb", "parameters": [ { "name": "state", "in": "path", "description": "The Australian state abbreviation\n", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "NSW" }, { "name": "suburb", "in": "path", "description": "Suburb name to retrieve data for\n", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "Pyrmont" }, { "name": "postcode", "in": "path", "description": "Suburb Post Code for suburbs with official post codes.\n", "required": true, "style": "simple", "schema": { "pattern": "^\\d{4}$", "type": "string" }, "example": "2009" }, { "name": "year", "in": "query", "description": "Census Year of data to return", "style": "form", "schema": { "enum": [ 2011, 2016, 2021 ], "type": "integer" } }, { "name": "types", "in": "query", "description": "Comma separated list of census topics to retrieve demographic data for e.g. \"Rent,TransportToWork\"\nPossible values include:\n- AgeGroupOfPopulation\n- CountryOfBirth\n- NatureOfOccupancy\n- Occupation\n- GeographicalPopulation\n- DwellingStructure\n- EducationAttendance\n- HousingLoanRepayment\n- MaritalStatus\n- Religion\n- TransportToWork\n- FamilyComposition\n- HouseholdIncome\n- Rent\n- LabourForceStatus\n", "style": "form", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Historical data returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DemographicsResponse" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "500": { "description": "Unexpected error" } }, "security": [ { "apikey": [] }, { "oauth2": [ "api_demographics_read" ] } ], "x-domain-endpointcost": 1, "x-domain-usercontextrequired": false, "x-domain-environment": "Primary" } }, "/v1/disclaimers": { "get": { "tags": [ "Disclaimers" ], "summary": "Disclaimers", "description": "Retrieve disclaimers for given ids.", "operationId": "Disclaimers_Get", "parameters": [ { "name": "ids", "in": "query", "description": "Comma-separated list of IDs. Eg. \"APM,NSWVG, VICVG\"", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Disclaimers data returned" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "500": { "description": "Unexpected error" } }, "security": [ { "apikey": [] }, { "oauth2": [ "api_properties_read" ] } ], "x-domain-endpointcost": 1, "x-domain-usercontextrequired": false, "x-domain-environment": "Any" } }, "/v1/disclaimers/product/{product}": { "get": { "tags": [ "Disclaimers" ], "summary": "Disclaimers by Product", "description": "Retrieves disclaimers for given product.", "operationId": "Disclaimers_GetByProduct", "parameters": [ { "name": "product", "in": "path", "description": "Product which disclaimers are to be retrieved. Possible values include:\n- PropertyData\n- AURIN\n- HomePriceGuide\n", "required": true, "schema": { "enum": [ "PropertyData", "AURIN", "HomePriceGuide" ], "type": "string" } } ], "responses": { "200": { "description": "Disclaimers data returned" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "500": { "description": "Unexpected error" } }, "security": [ { "apikey": [] }, { "oauth2": [ "api_properties_read" ] } ], "x-domain-endpointcost": 1, "x-domain-usercontextrequired": false, "x-domain-environment": "Any" } }, "/v1/enquiries": { "get": { "tags": [ "Enquiries" ], "summary": "Searches enquiries based on agents or agencies.", "operationId": "Enquiries_Search", "parameters": [ { "name": "agencyId", "in": "query", "description": "Agency identifier", "schema": { "type": "integer", "format": "int32" } }, { "name": "agentId", "in": "query", "description": "Agent identifier", "schema": { "type": "integer", "format": "int32" } }, { "name": "from", "in": "query", "description": "Enquiries received from", "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "description": "Enquiries received up to", "schema": { "type": "string", "format": "date-time" } }, { "name": "pageNumber", "in": "query", "description": "Page number for paginated results (25 per page)", "schema": { "type": "integer", "format": "int32", "default": 1 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Enquiries.V1.EnquiryReport" } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "apikey": [] }, { "oauth2": [ "api_enquiries_read", "api_enquiries_write" ] } ], "x-domain-endpointcost": 1, "x-domain-usercontextrequired": true, "x-domain-environment": "Any" }, "post": { "tags": [ "Enquiries" ], "summary": "Sends an enquiry for listing, agency, etc... (based on the enquiry type and referenceid).\r\nRecipients and template will be automatically selected.", "operationId": "Enquiries_Post", "requestBody": { "description": "The enquiry object", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Domain.Public.Adapter.Web.Api.Models.v1.Enquiries.Enquiry" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Domain.Public.Adapter.Web.Api.Models.v1.Enquiries.Enquiry" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Domain.Public.Adapter.Web.Api.Models.v1.Enquiries.Enquiry" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Domain.Public.Adapter.Web.Api.Models.v1.Enquiries.Enquiry" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Domain.Public.Adapter.Web.Api.Models.v1.Enquiries.Enquiry" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/Domain.Public.Adapter.Web.Api.Models.v1.Enquiries.Enquiry" } } }, "required": true, "x-bodyName": "enquiry" }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Domain.EnquiryService.v1.Model.GroupEnquiryServiceModelsEnquiryResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Domain.EnquiryService.v1.Model.GroupEnquiryServiceModelsEnquiryResponse" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Domain.EnquiryService.v1.Model.GroupEnquiryServiceModelsEnquiryResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Domain.EnquiryService.v1.Model.GroupEnquiryServiceModelsEnquiryResponse" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Domain.EnquiryService.v1.Model.GroupEnquiryServiceModelsEnquiryResponse" } } } } }, "security": [ { "apikey": [] }, { "oauth2": [ "api_enquiries_write" ] } ], "x-domain-usercontextrequired": false, "x-domain-endpointcost": 1, "x-domain-environment": "Any" } }, "/v1/enquiries/{id}": { "get": { "tags": [ "Enquiries" ], "summary": "Retrieve the details of a specific enquiry", "operationId": "Enquiries_Get", "parameters": [ { "name": "id", "in": "path", "description": "Id of the enquiry", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Enquiries.V1.EnquiryReport" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "apikey": [] }, { "oauth2": [ "api_enquiries_read", "api_enquiries_write" ] } ], "x-domain-endpointcost": 1, "x-domain-usercontextrequired": false, "x-domain-environment": "Any" } }, "/v1/leadscope/predictions/{participantId}": { "get": { "tags": [ "Leadscope" ], "summary": "URL to download a list of agency predictions", "operationId": "LeadScope_GetById", "parameters": [ { "name": "participantId", "in": "path", "description": "Participant ID", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "URL to download a list of agency predictions", "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string" } } } } } }, "204": { "description": "No predictions found" } }, "security": [ { "apikey": [] }, { "oauth2": [ "api_agencies_read" ] } ], "x-domain-endpointcost": 1, "x-domain-usercontextrequired": false, "x-domain-environment": "Primary" } }, "/v1/listings/{id}": { "get": { "tags": [ "Listings" ], "summary": "Retrieve details of listing using the listing id", "operationId": "Listings_Get", "parameters": [ { "name": "id", "in": "path", "description": "Id of the listing", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Listings.V1.Listing" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "apikey": [] }, { "oauth2": [ "api_listings_read", "api_listings_write" ] } ], "x-domain-endpointcost": 1, "x-domain-usercontextrequired": false, "x-domain-environment": "Any" } }, "/v1/listings/{id}/enquiries": { "get": { "tags": [ "Listings" ], "summary": "Retrieve details of all enquiries received for a specific listing", "operationId": "Listings_GetEnquiries", "parameters": [ { "name": "id", "in": "path", "description": "Listing Id", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Page number for paginated results (25 per page)", "schema": { "type": "integer", "format": "int32", "default": 1 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Enquiries.V1.EnquiryReport" } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "apikey": [] }, { "oauth2": [ "api_enquiries_read", "api_enquiries_write" ] } ], "x-domain-endpointcost": 1, "x-domain-usercontextrequired": false, "x-domain-environment": "Any" } }, "/v1/listings/{id}/statistics": { "get": { "tags": [ "Listings" ], "summary": "Retrieve details of listing using the listing id", "operationId": "Listings_GetListingStatistics", "parameters": [ { "name": "id", "in": "path", "description": "Id of the listing", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "timePeriod", "in": "query", "description": "The period of time to see the listing performance for (not including today). Defaults to Last7Days", "schema": { "enum": [ "last7Days", "last90Days", "wholeCampaign" ], "type": "string", "description": "Defines StatisticsTimePeriod", "default": "last7Days" } }, { "name": "channel", "in": "query", "description": "Filter statistics for the given channel. Defaults to listing Channel.", "schema": { "enum": [ "residential", "commercial", "business" ], "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListingPerformance.v1.StatisticReport" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "apikey": [] }, { "oauth2": [ "api_listings_read" ] } ], "x-domain-endpointcost": 1, "x-domain-usercontextrequired": true, "x-domain-environment": "Any" } }, "/v1/listings/business": { "put": { "tags": [ "Listings" ], "summary": "Creates or updates a business listing", "operationId": "Listings_UpsertBusinessListing", "requestBody": { "description": "The business listing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Domain.ListingAdminService.v1.Model.BusinessListing" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Domain.ListingAdminService.v1.Model.BusinessListing" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Domain.ListingAdminService.v1.Model.BusinessListing" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Domain.ListingAdminService.v1.Model.BusinessListing" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Domain.ListingAdminService.v1.Model.BusinessListing" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/Domain.ListingAdminService.v1.Model.BusinessListing" } } }, "required": true, "x-bodyName": "listing" }, "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Domain.ListingAdminService.v1.Model.ListingResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Domain.ListingAdminService.v1.Model.ListingResponse" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Domain.ListingAdminService.v1.Model.ListingResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Domain.ListingAdminService.v1.Model.ListingResponse" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Domain.ListingAdminService.v1.Model.ListingResponse" } } } }, "202": { "description": "Accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Domain.ListingAdminService.v1.Model.ListingResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Domain.ListingAdminService.v1.Model.ListingResponse" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Domain.ListingAdminService.v1.Model.ListingResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Domain.ListingAdminService.v1.Model.ListingResponse" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Domain.ListingAdminService.v1.Model.ListingResponse" } } } } }, "security": [ { "apikey": [] }, { "oauth2": [ "api_listings_write" ] } ], "x-domain-usercontextrequired": false, "x-domain-endpointcost": 1, "x-domain-environment": "Any" } }, "/v1/listings/business/_search": { "post": { "tags": [ "Listings" ], "summary": "Retrieves business listings matching the specified criteria.", "operationId": "Listings_DetailedBusinessSearch", "requestBody": { "description": "Search parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Domain.Public.Adapter.Web.Api.Models.v1.Listings.Business.SearchRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Domain.Public.Adapter.Web.Api.Models.v1.Listings.Business.SearchRequest" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Domain.Public.Adapter.Web.Api.Models.v1.Listings.Business.SearchRequest" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Domain.Public.Adapter.Web.Api.Models.v1.Listings.Business.SearchRequest" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Domain.Public.Adapter.Web.Api.Models.v1.Listings.Business.SearchRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/Domain.Public.Adapter.Web.Api.Models.v1.Listings.Business.SearchRequest" } } }, "required": true, "x-bodyName": "parameters" }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Domain.Public.Adapter.Web.Api.Models.v1.Listings.Business.Listing" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Domain.Public.Adapter.Web.Api.Models.v1.Listings.Business.Listing" } } }, "text/html": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Domain.Public.Adapter.Web.Api.Models.v1.Listings.Business.Listing" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Domain.Public.Adapter.Web.Api.Models.v1.Listings.Business.Listing" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Domain.Public.Adapter.Web.Api.Models.v1.Listings.Business.Listing" } } } } } }, "security": [ { "apikey": [] }, { "oauth2": [ "api_listings_read", "api_listings_write" ] } ], "x-domain-usercontextrequired": false, "x-domain-endpointcost": 1, "x-domain-environment": "Primary" } }, "/v2/listings/business/offmarket": { "post": { "tags": [ "Listings" ], "summary": "Creates an externally sold business listing; or takes an existing business listing off the market.", "operationId": "listings_upsertbusinessoffmarket", "requestBody": { "description": "Listing data", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListingAdmin.v2.BusinessOffMarketListing" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ListingAdmin.v2.BusinessOffMarketListing" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ListingAdmin.v2.BusinessOffMarketListing" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ListingAdmin.v2.BusinessOffMarketListing" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ListingAdmin.v2.BusinessOffMarketListing" } } }, "required": true, "x-bodyName": "listing" }, "responses": { "200": { "description": "Listing data hasn't been changed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListingAdmin.v2.ListingResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ListingAdmin.v2.ListingResponse" } } } }, "202": { "description": "Listing data has been accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListingAdmin.v2.ListingResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ListingAdmin.v2.ListingResponse" } } } }, "400": { "description": "Listing data is not valid" } }, "security": [ { "apikey": [] }, { "oauth2": [ "api_listings_write" ] } ], "x-domain-endpointcost": 1, "x-domain-usercontextrequired": false, "x-domain-environment": "Any" } }, "/v2/listings/commercial": { "put": { "tags": [ "Listings" ], "summary": "Creates a commercial listing.", "operationId": "listings_upsertcommerciallisting", "requestBody": { "description": "Listing data", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListingAdmin.v2.CommercialListingV2" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ListingAdmin.v2.CommercialListingV2" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ListingAdmin.v2.CommercialListingV2" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ListingAdmin.v2.CommercialListingV2" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ListingAdmin.v2.CommercialListingV2" } } }, "required": true, "x-bodyName": "listing" }, "responses": { "200": { "description": "Listing data hasn't been changed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListingAdmin.v2.ListingResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ListingAdmin.v2.ListingResponse" } } } }, "202": { "description": "Listing data has been accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListingAdmin.v2.ListingResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ListingAdmin.v2.ListingResponse" } } } }, "400": { "description": "Listing data is not valid" } }, "security": [ { "apikey": [] }, { "oauth2": [ "api_listings_write" ] } ], "x-domain-endpointcost": 1, "x-domain-usercontextrequired": false, "x-domain-environment": "Any" } }, "/v1/listings/commercial/_search": { "post": { "tags": [ "Listings" ], "summary": "Retrieves commercial listings matching the specified criteria.", "operationId": "Listings_DetailedCommercialSearch", "requestBody": { "description": "Search parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Domain.Public.Adapter.Web.Api.Models.v1.Listings.Commercial.SearchRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Domain.Public.Adapter.Web.Api.Models.v1.Listings.Commercial.SearchRequest" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Domain.Public.Adapter.Web.Api.Models.v1.Listings.Commercial.SearchRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/Domain.Public.Adapter.Web.Api.Models.v1.Listings.Commercial.SearchRequest" } } }, "required": true, "x-bodyName": "parameters" }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Domain.Public.Adapter.Web.Api.Models.v1.Listings.Commercial.Listing" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Domain.Public.Adapter.Web.Api.Models.v1.Listings.Commercial.Listing" } } }, "text/html": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Domain.Public.Adapter.Web.Api.Models.v1.Listings.Commercial.Listing" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Domain.Public.Adapter.Web.Api.Models.v1.Listings.Commercial.Listing" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Domain.Public.Adapter.Web.Api.Models.v1.Listings.Commercial.Listing" } } } } } }, "security": [ { "apikey": [] }, { "oauth2": [ "api_listings_read", "api_listings_write" ] } ], "x-domain-usercontextrequired": false, "x-domain-endpointcost": 1, "x-domain-environment": "Primary" } }, "/v2/listings/commercial/offmarket": { "post": { "tags": [ "Listings" ], "summary": "Creates an externally sold or leased commercial listing; or takes an existing commercial listing off the market.", "operationId": "listings_upsertcommercialoffmarket", "requestBody": { "description": "Listing data", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListingAdmin.v2.CommercialOffMarketListing" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ListingAdmin.v2.CommercialOffMarketListing" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ListingAdmin.v2.CommercialOffMarketListing" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ListingAdmin.v2.CommercialOffMarketListing" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ListingAdmin.v2.CommercialOffMarketListing" } } }, "required": true, "x-bodyName": "listing" }, "responses": { "200": { "description": "Listing data hasn't been changed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListingAdmin.v2.ListingResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ListingAdmin.v2.ListingResponse" } } } }, "202": { "description": "Listing data has been accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListingAdmin.v2.ListingResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ListingAdmin.v2.ListingResponse" } } } }, "400": { "description": "Listing data is not valid" } }, "security": [ { "apikey": [] }, { "oauth2": [ "api_listings_write" ] } ], "x-domain-endpointcost": 1, "x-domain-usercontextrequired": false, "x-domain-environment": "Any" } }, "/v1/listings/locations": { "get": { "tags": [ "Listings" ], "summary": "Suggests listing locations", "description": "The resulting suggested location can be of type \"suburb\" / \"area\" / \"region\".\r\n\r\nThe `name` property corresponds to the type of location returned.\r\n\r\nThe area name / region name can be fed into the corresponding fields search fields. See [`v1/listings/residential/_search`](/docs/v1/apis/pkg_agents_listings/references/listings_detailedresidentialsearch)", "operationId": "ListingLocations_Search", "parameters": [ { "name": "terms", "in": "query", "description": "Suburb / area / region prefix, or postcode", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Domain.Public.Adapter.Web.Api.Models.v1.Listings.ListingLocation" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Domain.Public.Adapter.Web.Api.Models.v1.Listings.ListingLocation" } } }, "text/html": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Domain.Public.Adapter.Web.Api.Models.v1.Listings.ListingLocation" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Domain.Public.Adapter.Web.Api.Models.v1.Listings.ListingLocation" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Domain.Public.Adapter.Web.Api.Models.v1.Listings.ListingLocation" } } } } } }, "security": [ { "apikey": [] }, { "oauth2": [ "api_listings_read", "api_listings_write" ] } ], "x-domain-usercontextrequired": false, "x-domain-endpointcost": 1, "x-domain-environment": "Any" } }, "/v1/listings/processingReports": { "get": { "tags": [ "Listings" ], "summary": "Searches processing reports", "operationId": "Listings_GetListingReportByReference", "parameters": [ { "name": "agencyId", "in": "query", "description": "Domain agency Id", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "providerAdId", "in": "query", "description": "External provider advertisement identifier", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Domain.ListingAdminService.v1.Model.ListingReport" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Domain.ListingAdminService.v1.Model.ListingReport" } } }, "text/html": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Domain.ListingAdminService.v1.Model.ListingReport" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Domain.ListingAdminService.v1.Model.ListingReport" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Domain.ListingAdminService.v1.Model.ListingReport" } } } } } }, "security": [ { "apikey": [] }, { "oauth2": [ "api_listings_read" ] } ], "x-domain-usercontextrequired": false, "x-domain-endpointcost": 1, "x-domain-environment": "Any" } }, "/v1/listings/processingReports/{id}": { "get": { "tags": [ "Listings" ], "summary": "Gets the processing report", "operationId": "Listings_GetListingReport", "parameters": [ { "name": "id", "in": "path", "description": "Report id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Domain.ListingAdminService.v1.Model.ListingReport" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Domain.ListingAdminService.v1.Model.ListingReport" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Domain.ListingAdminService.v1.Model.ListingReport" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Domain.ListingAdminService.v1.Model.ListingReport" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Domain.ListingAdminService.v1.Model.ListingReport" } } } } }, "security": [ { "apikey": [] }, { "oauth2": [ "api_listings_read" ] } ], "x-domain-usercontextrequired": false, "x-domain-endpointcost": 1, "x-domain-environment": "Any" } }, "/v1/listings/residential": { "put": { "tags": [ "Listings" ], "summary": "Creates or updates a residential listing", "operationId": "Listings_UpsertResidentialListing", "requestBody": { "description": "The residential listing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Domain.ListingAdminService.v1.Model.ResidentialListing" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Domain.ListingAdminService.v1.Model.ResidentialListing" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Domain.ListingAdminService.v1.Model.ResidentialListing" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Domain.ListingAdminService.v1.Model.ResidentialListing" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Domain.ListingAdminService.v1.Model.ResidentialListing" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/Domain.ListingAdminService.v1.Model.ResidentialListing" } } }, "required": true, "x-bodyName": "listing" }, "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Domain.ListingAdminService.v1.Model.ListingResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Domain.ListingAdminService.v1.Model.ListingResponse" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Domain.ListingAdminService.v1.Model.ListingResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Domain.ListingAdminService.v1.Model.ListingResponse" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Domain.ListingAdminService.v1.Model.ListingResponse" } } } }, "202": { "description": "Accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Domain.ListingAdminService.v1.Model.ListingResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Domain.ListingAdminService.v1.Model.ListingResponse" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Domain.ListingAdminService.v1.Model.ListingResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Domain.ListingAdminService.v1.Model.ListingResponse" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Domain.ListingAdminService.v1.Model.ListingResponse" } } } } }, "security": [ { "apikey": [] }, { "oauth2": [ "api_listings_write" ] } ], "x-domain-usercontextrequired": false, "x-domain-endpointcost": 1, "x-domain-environment": "Any" } }, "/v1/listings/residential/_search": { "post": { "tags": [ "Listings" ], "summary": "Retrieves residential listings matching the specified criteria.", "description": "Search results are limited to the first 1000 results.\r\n\r\nIf the number of results is greater, the intention is to refine the search by adding more restrictive parameters, to find a relevant set of results.", "operationId": "Listings_DetailedResidentialSearch", "requestBody": { "description": "Search parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Domain.SearchService.v2.Model.DomainSearchWebApiV2ModelsSearchParameters" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Domain.SearchService.v2.Model.DomainSearchWebApiV2ModelsSearchParameters" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Domain.SearchService.v2.Model.DomainSearchWebApiV2ModelsSearchParameters" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Domain.SearchService.v2.Model.DomainSearchWebApiV2ModelsSearchParameters" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Domain.SearchService.v2.Model.DomainSearchWebApiV2ModelsSearchParameters" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/Domain.SearchService.v2.Model.DomainSearchWebApiV2ModelsSearchParameters" } } }, "required": true, "x-bodyName": "parameters" }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Domain.SearchService.v2.Model.DomainSearchContractsV2SearchResult" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Domain.SearchService.v2.Model.DomainSearchContractsV2SearchResult" } } }, "text/html": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Domain.SearchService.v2.Model.DomainSearchContractsV2SearchResult" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Domain.SearchService.v2.Model.DomainSearchContractsV2SearchResult" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Domain.SearchService.v2.Model.DomainSearchContractsV2SearchResult" } } } } } }, "security": [ { "apikey": [] }, { "oauth2": [ "api_listings_read", "api_listings_write" ] } ], "x-domain-usercontextrequired": false, "x-domain-endpointcost": 1, "x-domain-environment": "Primary" } }, "/v2/listings/residential/offmarket": { "post": { "tags": [ "Listings" ], "summary": "Creates an externally sold or leased residential listing; or takes an existing residential listing off the market.", "operationId": "listings_upsertresidentialoffmarket", "requestBody": { "description": "Listing data", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListingAdmin.v2.ResidentialOffMarketListing" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ListingAdmin.v2.ResidentialOffMarketListing" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ListingAdmin.v2.ResidentialOffMarketListing" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ListingAdmin.v2.ResidentialOffMarketListing" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ListingAdmin.v2.ResidentialOffMarketListing" } } }, "required": true, "x-bodyName": "listing" }, "responses": { "200": { "description": "Listing data hasn't been changed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListingAdmin.v2.ListingResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ListingAdmin.v2.ListingResponse" } } } }, "202": { "description": "Listing data has been accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListingAdmin.v2.ListingResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ListingAdmin.v2.ListingResponse" } } } }, "400": { "description": "Listing data is not valid" } }, "security": [ { "apikey": [] }, { "oauth2": [ "api_listings_write" ] } ], "x-domain-endpointcost": 1, "x-domain-usercontextrequired": false, "x-domain-environment": "Any" } }, "/v1/listingSearch/residential/search": { "post": { "tags": [ "ListingSearch" ], "summary": "Retrieves residential listings matching the specified criteria.", "description": "Search results are limited to the first 1000 results.\r\n\r\nIf the number of results is greater, the intention is to refine the search by adding more restrictive parameters, to find a relevant set of results.", "operationId": "Listings_ResidentialSearch", "requestBody": { "description": "Search parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchService.v2.DomainSearchWebApiV2ModelsSearchParameters" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SearchService.v2.DomainSearchWebApiV2ModelsSearchParameters" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SearchService.v2.DomainSearchWebApiV2ModelsSearchParameters" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchService.v2.DomainSearchContractsV2SearchResults" } } } }, "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" }, "504": { "description": "Gateway Timeout" }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "apikey": [] }, { "oauth2": [ "api_listings_read" ] } ], "x-domain-endpointcost": 1, "x-domain-usercontextrequired": false, "x-domain-environment": "Primary" } }, "/v1/listingSearch/residential/searchSold": { "post": { "tags": [ "ListingSearch" ], "summary": "Retrieves sold residential listings matching the specified criteria.", "description": "Search results are limited to the first 1000 results.\r\n\r\nIf the number of results is greater, the intention is to refine the search by adding more restrictive parameters, to find a relevant set of results.", "operationId": "Listings_DetailedSoldResidentialSearch", "requestBody": { "description": "Search parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchService.v2.DomainSearchWebApiV2ModelsSoldSearchParameters" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SearchService.v2.DomainSearchWebApiV2ModelsSoldSearchParameters" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SearchService.v2.DomainSearchWebApiV2ModelsSoldSearchParameters" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchService.v2.DomainSearchContractsV2SearchResults" } } } }, "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" }, "504": { "description": "Gateway Timeout" }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "apikey": [] }, { "oauth2": [ "api_listings_read" ] } ], "x-domain-endpointcost": 1, "x-domain-usercontextrequired": false, "x-domain-environment": "Primary" } }, "/v1/locations/profiles/{domainLocationId}": { "get": { "tags": [ "Locations" ], "summary": "Get location data based on the given domainLocationId", "operationId": "LocationProfiles_Get", "parameters": [ { "name": "domainLocationId", "in": "path", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Domain.LocationProfilesService.v1.Model.Location" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Domain.LocationProfilesService.v1.Model.Location" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Domain.LocationProfilesService.v1.Model.Location" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Domain.LocationProfilesService.v1.Model.Location" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Domain.LocationProfilesService.v1.Model.Location" } } } }, "401": { "description": "Unauthorised" }, "404": { "description": "Not Found" } }, "security": [ { "apikey": [] }, { "oauth2": [ "api_locations_read" ] } ], "x-domain-usercontextrequired": false, "x-domain-endpointcost": 1, "x-domain-environment": "Any" } }, "/v1/me": { "get": { "tags": [ "Me" ], "summary": "Retrieve information about the currently authorised request", "operationId": "Me_Profile", "responses": { "200": { "description": "User information", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Me.V1.MyDetails" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "apikey": [] }, { "oauth2": [] } ], "x-domain-optionalscopes": "openid email", "x-domain-endpointcost": 1, "x-domain-usercontextrequired": false, "x-domain-environment": "Any" } }, "/v1/me/agencies": { "get": { "tags": [ "Me" ], "summary": "Retrieve list of agencies with which the current client is associated", "operationId": "Me_GetMyAgencies", "responses": { "200": { "description": "Agency information", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Me.V1.AgencySummary" } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "apikey": [] }, { "oauth2": [ "api_agencies_read" ] } ], "x-domain-endpointcost": 1, "x-domain-usercontextrequired": true, "x-domain-environment": "Any" } }, "/v1/me/providers": { "get": { "tags": [ "Me" ], "summary": "Retrieve list of provider Ids with which the current client is associated", "operationId": "Me_GetMyProviders", "responses": { "200": { "description": "Provider information", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Me.V1.ProviderSummary" } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "apikey": [] }, { "oauth2": [ "api_listings_write" ] } ], "x-domain-endpointcost": 1, "x-domain-usercontextrequired": false, "x-domain-environment": "Any" } }, "/v2/premarket/listings": { "post": { "tags": [ "PreMarket" ], "summary": "Creates or updates a pre-portal listing.", "operationId": "PreMarket_Post", "requestBody": { "description": "Pre-portal listing request.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PreMarket.v1.ListingRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PreMarket.v1.ListingRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PreMarket.v1.ListingRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PreMarket.v1.ListingRequest" } } } }, "responses": { "202": { "description": "Accepted", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PreMarket.v1.CreateOrUpdateListingResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PreMarket.v1.CreateOrUpdateListingResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PreMarket.v1.CreateOrUpdateListingResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PreMarket.v1.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PreMarket.v1.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PreMarket.v1.ProblemDetails" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PreMarket.v1.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PreMarket.v1.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PreMarket.v1.ProblemDetails" } } } } }, "security": [ { "apikey": [] }, { "oauth2": [ "api_listings_write" ] } ], "x-domain-endpointcost": 1, "x-domain-usercontextrequired": false, "x-domain-environment": "Primary" } }, "/v2/premarket/listings/{id}": { "get": { "tags": [ "PreMarket" ], "summary": "Retrieves a pre-portal listing.", "operationId": "PreMarket_Get", "parameters": [ { "name": "id", "in": "path", "description": "Pre-portal listing ID.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PreMarket.v1.ListingResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PreMarket.v1.ListingResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PreMarket.v1.ListingResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PreMarket.v1.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PreMarket.v1.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PreMarket.v1.ProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PreMarket.v1.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PreMarket.v1.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PreMarket.v1.ProblemDetails" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PreMarket.v1.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PreMarket.v1.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PreMarket.v1.ProblemDetails" } } } } }, "security": [ { "apikey": [] }, { "oauth2": [ "api_listings_read" ] } ], "x-domain-endpointcost": 1, "x-domain-usercontextrequired": false, "x-domain-environment": "Primary" }, "patch": { "tags": [ "PreMarket" ], "summary": "Patches a pre-portal listing.", "operationId": "PreMarket_Patch", "parameters": [ { "name": "id", "in": "path", "description": "Pre-portal listing ID.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "```\r\nExamples:\r\n[\r\n{\r\n\t\"op\": \"replace\",\r\n\t\"path\": \"/bedrooms\",\r\n\t\"value\": 3\r\n },\r\n{\r\n\t\"op\": \"replace\",\r\n\t\"path\": \"/listingStatus\",\r\n\t\"value\": \"sold\"\r\n},\r\n{\r\n\t\"op\": \"remove\",\r\n\t\"path\": \"/StatementOfInformation\"\r\n},\r\n{\r\n\t\"op\": \"add\",\r\n\t\"path\": \"/contacts/-\",\r\n\t\"value\": {\r\n\t\t\"firstName\": \"lily\",\r\n\t\t\"lastName\": \"li\",\r\n\t\t\"email\": \"lily.li@domain.com.au\",\r\n\t\t\"phone\": \"0411111111\",\r\n\t\t\"mobile\": null,\r\n\t\t\"fax\": null\r\n\t}\r\n}\r\n]\r\n```", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PreMarket.v1.ListingRequestJsonPatchDocument" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PreMarket.v1.ListingRequestJsonPatchDocument" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PreMarket.v1.ListingRequestJsonPatchDocument" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PreMarket.v1.ListingRequestJsonPatchDocument" } } } }, "responses": { "202": { "description": "Accepted", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PreMarket.v1.ListingRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PreMarket.v1.ListingRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PreMarket.v1.ListingRequest" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PreMarket.v1.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PreMarket.v1.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PreMarket.v1.ProblemDetails" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PreMarket.v1.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PreMarket.v1.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PreMarket.v1.ProblemDetails" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PreMarket.v1.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PreMarket.v1.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PreMarket.v1.ProblemDetails" } } } } }, "security": [ { "apikey": [] }, { "oauth2": [ "api_listings_write" ] } ], "x-domain-endpointcost": 1, "x-domain-usercontextrequired": false, "x-domain-environment": "Primary" } }, "/v1/Products/LimitedInventory/{inventoryReservationId}/Unreserve": { "put": { "tags": [ "Products" ], "summary": "Unreserves (cancels) an existing limited inventory reservation.", "operationId": "LimitedInventory_Unreserve", "parameters": [ { "name": "inventoryReservationId", "in": "path", "description": "The reservation identifier.", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "Cancellation details including AgencyId.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/BookingV2Api.v1.UnreserveInventoryRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BookingV2Api.v1.UnreserveInventoryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BookingV2Api.v1.UnreserveInventoryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BookingV2Api.v1.UnreserveInventoryRequest" } } } }, "responses": { "200": { "description": "Successfully unreserved." }, "400": { "description": "Validation or business logic failure.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BookingV2Api.v1.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BookingV2Api.v1.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BookingV2Api.v1.ProblemDetails" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Reservation not found." }, "409": { "description": "Already cancelled." }, "500": { "description": "Unexpected server error.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BookingV2Api.v1.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BookingV2Api.v1.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BookingV2Api.v1.ProblemDetails" } } } } }, "security": [ { "apikey": [] }, { "oauth2": [ "api_agencies_write" ] } ], "x-domain-endpointcost": 1, "x-domain-usercontextrequired": false, "x-domain-environment": "Any" } }, "/v1/Products/LimitedInventory/Availability": { "post": { "tags": [ "Products" ], "summary": "Retrieves batch availability for limited inventory products.", "operationId": "LimitedInventory_GetBatchAvailability", "requestBody": { "description": "The request containing the batch availability parameters.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/BookingV2Api.v1.GetBatchLimitedInventoryAvailabilityRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BookingV2Api.v1.GetBatchLimitedInventoryAvailabilityRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BookingV2Api.v1.GetBatchLimitedInventoryAvailabilityRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BookingV2Api.v1.GetBatchLimitedInventoryAvailabilityRequest" } } } }, "responses": { "200": { "description": "Successfully get all availability.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BookingV2Api.v1.GetBatchLimitedInventoryAvailabilityResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BookingV2Api.v1.GetBatchLimitedInventoryAvailabilityResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BookingV2Api.v1.GetBatchLimitedInventoryAvailabilityResponse" } } } }, "207": { "description": "Unable to get availability to some combination of Product Type and Listing Category.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BookingV2Api.v1.GetBatchLimitedInventoryAvailabilityResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BookingV2Api.v1.GetBatchLimitedInventoryAvailabilityResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BookingV2Api.v1.GetBatchLimitedInventoryAvailabilityResponse" } } } }, "400": { "description": "Returns any validation or business logic error.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BookingV2Api.v1.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BookingV2Api.v1.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BookingV2Api.v1.ProblemDetails" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Unable to get availability to all combination of Product Type and Listing Category", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BookingV2Api.v1.GetBatchLimitedInventoryAvailabilityResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BookingV2Api.v1.GetBatchLimitedInventoryAvailabilityResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BookingV2Api.v1.GetBatchLimitedInventoryAvailabilityResponse" } } } }, "500": { "description": "If an internal server error occurs.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BookingV2Api.v1.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BookingV2Api.v1.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BookingV2Api.v1.ProblemDetails" } } } } }, "security": [ { "apikey": [] }, { "oauth2": [ "api_agencies_read" ] } ], "x-domain-endpointcost": 1, "x-domain-usercontextrequired": false, "x-domain-environment": "Any" } }, "/v1/Products/LimitedInventory/ReserveByBatch": { "post": { "tags": [ "Products" ], "summary": "Reserves inventory for a batch of products based on the provided request.", "operationId": "LimitedInventory_ReserveByBatch", "requestBody": { "description": "The Domain.Booking.v2.Common.Models.RequestDto.ReserveInventoryByBatchRequest containing the batch reservation details, including product identifiers and quantities.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/BookingV2Api.v1.ReserveInventoryByBatchRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BookingV2Api.v1.ReserveInventoryByBatchRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BookingV2Api.v1.ReserveInventoryByBatchRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BookingV2Api.v1.ReserveInventoryByBatchRequest" } } } }, "responses": { "200": { "description": "All reservations successful", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BookingV2Api.v1.ReserveInventoryByBatchResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BookingV2Api.v1.ReserveInventoryByBatchResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BookingV2Api.v1.ReserveInventoryByBatchResponse" } } } }, "207": { "description": "Some reservations failed", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BookingV2Api.v1.ReserveInventoryByBatchResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BookingV2Api.v1.ReserveInventoryByBatchResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BookingV2Api.v1.ReserveInventoryByBatchResponse" } } } }, "400": { "description": "Validation error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BookingV2Api.v1.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BookingV2Api.v1.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BookingV2Api.v1.ProblemDetails" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Reservations processed without success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BookingV2Api.v1.ReserveInventoryByBatchResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BookingV2Api.v1.ReserveInventoryByBatchResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BookingV2Api.v1.ReserveInventoryByBatchResponse" } } } }, "500": { "description": "All reservations failed or internal server error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BookingV2Api.v1.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BookingV2Api.v1.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BookingV2Api.v1.ProblemDetails" } } } } }, "security": [ { "apikey": [] }, { "oauth2": [ "api_agencies_write" ] } ], "x-domain-endpointcost": 1, "x-domain-usercontextrequired": false, "x-domain-environment": "Any" } }, "/v1/Products/LimitedInventory/UnreserveByBatch": { "put": { "tags": [ "Products" ], "summary": "Unreserve inventory items by batch.", "operationId": "LimitedInventory_UnreserveByBatch", "requestBody": { "description": "The request containing the batch reservation details to be unreserved.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/BookingV2Api.v1.UnreserveInventoryByBatchRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BookingV2Api.v1.UnreserveInventoryByBatchRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BookingV2Api.v1.UnreserveInventoryByBatchRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BookingV2Api.v1.UnreserveInventoryByBatchRequest" } } } }, "responses": { "200": { "description": "All batch unreservation successful", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BookingV2Api.v1.UnreserveInventoryByBatchResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BookingV2Api.v1.UnreserveInventoryByBatchResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BookingV2Api.v1.UnreserveInventoryByBatchResponse" } } } }, "207": { "description": "Some unreservation failed", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BookingV2Api.v1.UnreserveInventoryByBatchResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BookingV2Api.v1.UnreserveInventoryByBatchResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BookingV2Api.v1.UnreserveInventoryByBatchResponse" } } } }, "400": { "description": "Validation error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BookingV2Api.v1.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BookingV2Api.v1.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BookingV2Api.v1.ProblemDetails" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "422": { "description": "Unreserve by batch processed without success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BookingV2Api.v1.UnreserveInventoryByBatchResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BookingV2Api.v1.UnreserveInventoryByBatchResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BookingV2Api.v1.UnreserveInventoryByBatchResponse" } } } }, "500": { "description": "All batch unreservation failed or internal server error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BookingV2Api.v1.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BookingV2Api.v1.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BookingV2Api.v1.ProblemDetails" } } } } }, "security": [ { "apikey": [] }, { "oauth2": [ "api_agencies_write" ] } ], "x-domain-endpointcost": 1, "x-domain-usercontextrequired": false, "x-domain-environment": "Any" } }, "/v1/Products/Listings/QuoteByAgency": { "post": { "tags": [ "Products" ], "summary": "Gets a listing price quote based on the agency, channel and location details", "operationId": "ListingPrice_QuoteByAgency", "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/BookingV2Api.v1.GetListingPriceQuoteByAgencyRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BookingV2Api.v1.GetListingPriceQuoteByAgencyRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BookingV2Api.v1.GetListingPriceQuoteByAgencyRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BookingV2Api.v1.GetListingPriceQuoteByAgencyRequest" } } } }, "responses": { "200": { "description": "Successfully retrieved quote.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BookingV2Api.v1.GetListingPriceQuoteByAgencyResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BookingV2Api.v1.GetListingPriceQuoteByAgencyResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BookingV2Api.v1.GetListingPriceQuoteByAgencyResponse" } } } }, "400": { "description": "Invalid request.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BookingV2Api.v1.ValidationProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BookingV2Api.v1.ValidationProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BookingV2Api.v1.ValidationProblemDetails" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal server error.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BookingV2Api.v1.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BookingV2Api.v1.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BookingV2Api.v1.ProblemDetails" } } } } }, "security": [ { "apikey": [] }, { "oauth2": [ "api_agencies_read" ] } ], "x-domain-endpointcost": 1, "x-domain-usercontextrequired": false, "x-domain-environment": "Any" } }, "/v1/Products/Listings/QuoteBySuburbs": { "post": { "tags": [ "Products" ], "summary": "Gets a listing price quote based on the provided suburb details.", "operationId": "ListingPrice_QuoteBySuburbs", "requestBody": { "description": "The request containing suburb details.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/BookingV2Api.v1.GetQuoteListingPriceBySuburbsRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BookingV2Api.v1.GetQuoteListingPriceBySuburbsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BookingV2Api.v1.GetQuoteListingPriceBySuburbsRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BookingV2Api.v1.GetQuoteListingPriceBySuburbsRequest" } } } }, "responses": { "200": { "description": "Successfully retrieved quote.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BookingV2Api.v1.GetQuoteListingPriceBySuburbsResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BookingV2Api.v1.GetQuoteListingPriceBySuburbsResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BookingV2Api.v1.GetQuoteListingPriceBySuburbsResponse" } } } }, "400": { "description": "Invalid request.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BookingV2Api.v1.ValidationProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BookingV2Api.v1.ValidationProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BookingV2Api.v1.ValidationProblemDetails" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal server error.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BookingV2Api.v1.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BookingV2Api.v1.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BookingV2Api.v1.ProblemDetails" } } } } }, "security": [ { "apikey": [] }, { "oauth2": [ "api_agencies_read" ] } ], "x-domain-endpointcost": 1, "x-domain-usercontextrequired": false, "x-domain-environment": "Any" } }, "/v1/products/ratefornewlisting": { "post": { "tags": [ "Products" ], "summary": "Get updated pricing information for a hypothetical listing", "operationId": "Products_RateForNewListing", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Bookings.V2.RateForNewListingRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Bookings.V2.RateForNewListingRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Bookings.V2.RateForNewListingRequest" } } } }, "responses": { "200": { "description": "Pricing information for the given listing details", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Bookings.V2.RateForNewListing" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "apikey": [] }, { "oauth2": [ "api_agencies_read" ] } ], "x-domain-endpointcost": 1, "x-domain-usercontextrequired": true, "x-domain-environment": "Primary" } }, "/v1/products/ratefornewsocialboost": { "post": { "tags": [ "Products" ], "summary": "Get updated pricing information for a hypothetical listing", "operationId": "SocialBoost_RateForNewSocialBoost", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SocialBoost.v1.RateForNewSocialBoostRequestModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SocialBoost.v1.RateForNewSocialBoostRequestModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SocialBoost.v1.RateForNewSocialBoostRequestModel" } } } }, "responses": { "200": { "description": "Pricing information for the given listing details", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SocialBoost.v1.RateForNewSocialBoost" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "apikey": [] }, { "oauth2": [ "api_agencies_read" ] } ], "x-domain-endpointcost": 1, "x-domain-usercontextrequired": true, "x-domain-environment": "Primary" } }, "/v1/projects": { "get": { "tags": [ "Projects" ], "summary": "Searches projects", "description": "Note that the result page size is clamped at 100. Requesting a page size greater than this will be treated as if only a page size of 100 were requested.", "operationId": "Projects_Search", "parameters": [ { "name": "agencyId", "in": "query", "description": "Restricts to the provided agency", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Page number for paginated results", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "description": "Page size for paginated results", "schema": { "type": "integer", "format": "int32", "default": 20 } }, { "name": "projectStatus", "in": "query", "description": "The set of projects to return, defaults to `live` only", "schema": { "enum": [ "live", "inActive" ], "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Listings.V2.Project" } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "apikey": [] }, { "oauth2": [ "api_listings_read" ] } ], "x-domain-endpointcost": 1, "x-domain-usercontextrequired": false, "x-domain-environment": "Any" } }, "/v1/projects/{id}": { "get": { "tags": [ "Projects" ], "summary": "Details of project", "operationId": "Projects_Get", "parameters": [ { "name": "id", "in": "path", "description": "Id of the project", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Listings.V2.Project" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "apikey": [] }, { "oauth2": [ "api_listings_read" ] } ], "x-domain-endpointcost": 1, "x-domain-usercontextrequired": false, "x-domain-environment": "Any" } }, "/v1/projects/{id}/enquiries": { "get": { "tags": [ "Projects" ], "summary": "Retrieve details of all enquiries received for a specific new development project", "operationId": "Projects_GetEnquiries", "parameters": [ { "name": "id", "in": "path", "description": "New Development Project Id", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Page number for paginated results (25 per page)", "schema": { "type": "integer", "format": "int32", "default": 1 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Enquiries.V1.EnquiryReport" } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "apikey": [] }, { "oauth2": [ "api_enquiries_read", "api_enquiries_write" ] } ], "x-domain-endpointcost": 1, "x-domain-usercontextrequired": false, "x-domain-environment": "Any" } }, "/v1/projects/{id}/listings": { "get": { "tags": [ "Projects" ], "summary": "Project listings", "operationId": "Projects_GetChildListings", "parameters": [ { "name": "id", "in": "path", "description": "Id of the project", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Listings.V2.Listing" } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "apikey": [] }, { "oauth2": [ "api_listings_read", "api_listings_write" ] } ], "x-domain-endpointcost": 1, "x-domain-usercontextrequired": false, "x-domain-environment": "Any" } }, "/v1/projects/{id}/listings/statistics": { "get": { "tags": [ "Projects" ], "summary": "Retrieves statistics for a specific project with a breakdown for listings.", "operationId": "Projects_GetChildListingsStatistics", "parameters": [ { "name": "id", "in": "path", "description": "project identifier", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "timePeriod", "in": "query", "description": "Period to report on, Valid values are: `last7Days`, `last90Days`, `wholeCampaign`. Default is `last7Days`.", "schema": { "enum": [ "last7Days", "last90Days", "wholeCampaign" ], "type": "string", "description": "Defines StatisticsTimePeriod", "default": "last7Days" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListingPerformance.v1.ProjectListingStatisticsReport" } } } } }, "security": [ { "apikey": [] }, { "oauth2": [ "api_listings_read" ] } ], "x-domain-endpointcost": 1, "x-domain-usercontextrequired": true, "x-domain-environment": "Any" } }, "/v1/projects/{id}/statistics": { "get": { "tags": [ "Projects" ], "summary": "Retrieves statistics for a specific project.", "operationId": "Projects_GetStatistics", "parameters": [ { "name": "id", "in": "path", "description": "project identifier", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "timePeriod", "in": "query", "description": "Period to report on, Valid values are: `last7Days`, `last90Days`, `wholeCampaign`. Default is `last7Days`.", "schema": { "enum": [ "last7Days", "last90Days", "wholeCampaign" ], "type": "string", "description": "Defines StatisticsTimePeriod", "default": "last7Days" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListingPerformance.v1.ProjectStatisticsReport" } } } } }, "security": [ { "apikey": [] }, { "oauth2": [ "api_listings_read" ] } ], "x-domain-endpointcost": 1, "x-domain-usercontextrequired": true, "x-domain-environment": "Any" } }, "/v1/properties/_suggest": { "get": { "tags": [ "Properties" ], "summary": "Search for suggested addresses for the given terms", "description": "Applicable [policies](/docs/latest/support/policies) apply here include APM attribution.", "operationId": "Properties_Suggest", "parameters": [ { "name": "terms", "in": "query", "description": "The address to search", "required": true, "schema": { "type": "string" }, "example": "1 Smith Street, Smithfield, NSW" }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "description": "the size of the page. Defaults to 15 if unspecified", "default": 20 } }, { "name": "channel", "in": "query", "description": "Restrict the suggestions to this type of property: `All` (default), `Residential`, `Commercial`", "schema": { "enum": [ "All", "Residential", "Commercial" ], "type": "string", "default": "All" } } ], "responses": { "200": { "description": "Sample record details", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TypeAhead.v2.PropertiesSuggest" } } } }, "400": { "description": "Bad request" }, "404": { "description": "Properties not found" }, "500": { "description": "Unexpected error" } }, "security": [ { "apikey": [] }, { "oauth2": [ "api_properties_read" ] } ], "x-domain-endpointcost": 0, "x-domain-usercontextrequired": false, "x-domain-environment": "Any" } }, "/v1/properties/{id}": { "get": { "tags": [ "Properties" ], "summary": "Property ID", "description": "A propertyId is a Domain specific ID of particular property, usually in the form of an alphanumeric code: RF-8884-AK.", "operationId": "Properties_Get", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Property.Enrichment.v2.Property" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "A property with the specified ID was not found" }, "500": { "description": "Unexpected error" } }, "security": [ { "apikey": [] }, { "oauth2": [ "api_properties_read" ] } ], "x-domain-endpointcost": 1, "x-domain-usercontextrequired": false, "x-domain-environment": "Primary" } }, "/v2/properties/{propertyId}/listings": { "get": { "tags": [ "Properties" ], "summary": "Retrieve list of listings for the given property id", "operationId": "listings_bypropertyid", "parameters": [ { "name": "propertyId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "updatedSince", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "listedSince", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "saleMode", "in": "query", "schema": { "enum": [ "sale", "rent", "both" ], "type": "string", "default": "both" } } ], "responses": { "200": { "description": "Listings for the property id", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Listings.V2.Listing" } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "apikey": [] }, { "oauth2": [ "api_listings_read" ] } ], "x-domain-endpointcost": 1, "x-domain-usercontextrequired": false, "x-domain-environment": "Any" } }, "/v1/properties/{propertyId}/priceEstimate": { "get": { "tags": [ "Properties" ], "summary": "Price estimates based on propertyId", "operationId": "Properties_GetPriceEstimate", "parameters": [ { "name": "propertyId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DomainAvm.PI.v1.PropertyPriceEstimate" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DomainAvm.PI.v1.PropertyPriceEstimate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DomainAvm.PI.v1.PropertyPriceEstimate" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DomainAvm.PI.v1.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DomainAvm.PI.v1.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DomainAvm.PI.v1.ProblemDetails" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DomainAvm.PI.v1.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DomainAvm.PI.v1.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DomainAvm.PI.v1.ProblemDetails" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DomainAvm.PI.v1.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DomainAvm.PI.v1.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DomainAvm.PI.v1.ProblemDetails" } } } } }, "security": [ { "apikey": [] }, { "oauth2": [ "api_properties_read" ] } ], "x-domain-mapping-templates": { "Basic": "$", "Detailed": "$", "Full": "$" }, "x-domain-endpointcost": 1, "x-domain-usercontextrequired": false, "x-domain-environment": "Primary" } }, "/v1/properties/{propertyId}/rentalEstimate": { "get": { "tags": [ "Properties" ], "summary": "Rental estimates based on propertyId", "operationId": "Properties_GetRentalEstimate", "parameters": [ { "name": "propertyId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DomainAvm.PI.v1.RentalEstimate" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DomainAvm.PI.v1.RentalEstimate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DomainAvm.PI.v1.RentalEstimate" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DomainAvm.PI.v1.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DomainAvm.PI.v1.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DomainAvm.PI.v1.ProblemDetails" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DomainAvm.PI.v1.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DomainAvm.PI.v1.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DomainAvm.PI.v1.ProblemDetails" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DomainAvm.PI.v1.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DomainAvm.PI.v1.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DomainAvm.PI.v1.ProblemDetails" } } } } }, "security": [ { "apikey": [] }, { "oauth2": [ "api_properties_read" ] } ], "x-domain-endpointcost": 1, "x-domain-usercontextrequired": false, "x-domain-environment": "Primary" } }, "/v1/properties/images": { "get": { "tags": [ "Properties" ], "summary": "Property images", "description": "Search for a specific property and provide property images from latest sale/rental activity if found. Supply either propertyId, gnafId or all address fields (with flatNumber optional)", "operationId": "property_images_get", "parameters": [ { "name": "propertyId", "in": "query", "schema": { "type": "string" } }, { "name": "gnafId", "in": "query", "schema": { "type": "string" } }, { "name": "flatNumber", "in": "query", "schema": { "type": "string" } }, { "name": "streetNumber", "in": "query", "schema": { "type": "string" } }, { "name": "streetName", "in": "query", "schema": { "type": "string" } }, { "name": "streetType", "in": "query", "schema": { "type": "string" } }, { "name": "postcode", "in": "query", "schema": { "type": "string" } }, { "name": "suburbName", "in": "query", "schema": { "type": "string" } }, { "name": "state", "in": "query", "schema": { "enum": [ "ACT", "NSW", "NT", "QLD", "SA", "TAS", "VIC", "WA", "OT" ], "type": "string" } } ], "responses": { "200": { "description": "Property matching specified criteria was found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Property.Enrichment.v2.ImageResults" } } } }, "300": { "description": "Multiple records found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Property.Enrichment.v2.MultiplePropertyResults" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "A property with the specified ID was not found" }, "500": { "description": "Unexpected error" } }, "security": [ { "apikey": [] }, { "oauth2": [ "api_properties_read" ] } ], "x-domain-endpointcost": 1, "x-domain-usercontextrequired": false, "x-domain-environment": "Primary" } }, "/v1/properties/listingHistory": { "get": { "tags": [ "Properties" ], "summary": "Property Listing History", "description": "Search for a specific property and provide property with comprehensive list of all sale/rental listing activity for this property. Supply either propertyId, gnafId or all address fields (with flatNumber optional)", "operationId": "property_listing_history_get", "parameters": [ { "name": "propertyId", "in": "query", "schema": { "type": "string" } }, { "name": "gnafId", "in": "query", "schema": { "type": "string" } }, { "name": "flatNumber", "in": "query", "schema": { "type": "string" } }, { "name": "streetNumber", "in": "query", "schema": { "type": "string" } }, { "name": "streetName", "in": "query", "schema": { "type": "string" } }, { "name": "streetType", "in": "query", "schema": { "type": "string" } }, { "name": "postcode", "in": "query", "schema": { "type": "string" } }, { "name": "suburbName", "in": "query", "schema": { "type": "string" } }, { "name": "state", "in": "query", "schema": { "enum": [ "ACT", "NSW", "NT", "QLD", "SA", "TAS", "VIC", "WA", "OT" ], "type": "string" } } ], "responses": { "200": { "description": "Property matching specified criteria was found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Property.Enrichment.v2.PropertyListingResults" } } } }, "300": { "description": "Multiple records found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Property.Enrichment.v2.MultiplePropertyResults" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "A property with the specified ID was not found" }, "500": { "description": "Unexpected error" } }, "security": [ { "apikey": [] }, { "oauth2": [ "api_properties_read" ] } ], "x-domain-endpointcost": 1, "x-domain-usercontextrequired": false, "x-domain-environment": "Primary" } }, "/v1/properties/salesHistory": { "get": { "tags": [ "Properties" ], "summary": "Sales Listing History", "description": "Search for a specific property's activities and provide sale/rental activity if found. Supply either propertyId, gnafId, or all address fields (with flatNumber optional)", "operationId": "property_sales_history_get", "parameters": [ { "name": "propertyId", "in": "query", "schema": { "type": "string" } }, { "name": "gnafId", "in": "query", "schema": { "type": "string" } }, { "name": "flatNumber", "in": "query", "schema": { "type": "string" } }, { "name": "streetNumber", "in": "query", "schema": { "type": "string" } }, { "name": "streetName", "in": "query", "schema": { "type": "string" } }, { "name": "streetType", "in": "query", "schema": { "type": "string" } }, { "name": "postcode", "in": "query", "schema": { "type": "string" } }, { "name": "suburbName", "in": "query", "schema": { "type": "string" } }, { "name": "state", "in": "query", "schema": { "enum": [ "ACT", "NSW", "NT", "QLD", "SA", "TAS", "VIC", "WA", "OT" ], "type": "string" } } ], "responses": { "200": { "description": "Property matching specified criteria was found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Property.Enrichment.v2.SaleHistory" } } } }, "300": { "description": "Multiple records found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Property.Enrichment.v2.MultiplePropertyResults" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "A property with the specified ID was not found" }, "500": { "description": "Unexpected error" } }, "security": [ { "apikey": [] }, { "oauth2": [ "api_properties_read" ] } ], "x-domain-endpointcost": 1, "x-domain-usercontextrequired": false, "x-domain-environment": "Primary" } }, "/v1/propertyenrichment": { "get": { "tags": [ "Properties" ], "summary": "Property", "description": "Search for a specific property and provide property information and latest sale/rental activity if found. Supply either propertyId, gnafId, latitude/longitude, or all address fields (with flatNumber optional)", "operationId": "propertyenrichment_get", "parameters": [ { "name": "propertyId", "in": "query", "schema": { "type": "string" } }, { "name": "gnafId", "in": "query", "schema": { "type": "string" } }, { "name": "flatNumber", "in": "query", "schema": { "type": "string" } }, { "name": "streetNumber", "in": "query", "schema": { "type": "string" } }, { "name": "streetName", "in": "query", "schema": { "type": "string" } }, { "name": "streetType", "in": "query", "schema": { "type": "string" } }, { "name": "postcode", "in": "query", "schema": { "type": "string" } }, { "name": "suburbName", "in": "query", "schema": { "type": "string" } }, { "name": "state", "in": "query", "schema": { "enum": [ "ACT", "NSW", "NT", "QLD", "SA", "TAS", "VIC", "WA", "OT" ], "type": "string" } } ], "responses": { "200": { "description": "Property matching specified criteria was found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Property.Enrichment.v2.PropertyResults" } } } }, "300": { "description": "Multiple records found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Property.Enrichment.v2.MultiplePropertyResults" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "A property with the specified ID was not found" }, "500": { "description": "Unexpected error" } }, "security": [ { "apikey": [] }, { "oauth2": [ "api_properties_read" ] } ], "x-domain-endpointcost": 1, "x-domain-usercontextrequired": false, "x-domain-environment": "Primary" } }, "/v1/propertyReports": { "get": { "tags": [ "Properties" ], "summary": "Retrieves a property report based on query parameters", "operationId": "PropertyReports_Get", "parameters": [ { "name": "propertyType", "in": "query", "description": "Type of property `House`, `Unit`", "required": true, "schema": { "type": "string" } }, { "name": "streetNumber", "in": "query", "description": "Street number", "required": true, "schema": { "type": "string" } }, { "name": "streetName", "in": "query", "description": "Street name", "required": true, "schema": { "type": "string" } }, { "name": "suburb", "in": "query", "description": "Suburb e.g. `Pyrmont`", "required": true, "schema": { "type": "string" } }, { "name": "state", "in": "query", "description": "State e.g. `NSW`", "required": true, "schema": { "type": "string" } }, { "name": "unitNumber", "in": "query", "description": "Unit number", "schema": { "type": "string" } }, { "name": "streetType", "in": "query", "description": "Street type e.g. `Pl`", "schema": { "type": "string" } }, { "name": "postcode", "in": "query", "description": "Postcode e.g. `2009`", "schema": { "type": "string" } }, { "name": "areaSize", "in": "query", "description": "Area size", "schema": { "type": "integer", "format": "int32" } }, { "name": "bedrooms", "in": "query", "description": "Number of bedrooms", "schema": { "type": "integer", "format": "int32" } }, { "name": "bathrooms", "in": "query", "description": "Number of bathrooms", "schema": { "type": "integer", "format": "int32" } }, { "name": "parking", "in": "query", "description": "Number of parking spots", "schema": { "type": "integer", "format": "int32" } }, { "name": "preparedFor", "in": "query", "description": "\"Prepared for\" information", "schema": { "type": "string" } }, { "name": "productCode", "in": "query", "description": "Report product code", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Domain.PropertyReportService.v1.Model.PropertyReportGenerationResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Domain.PropertyReportService.v1.Model.PropertyReportGenerationResult" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Domain.PropertyReportService.v1.Model.PropertyReportGenerationResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Domain.PropertyReportService.v1.Model.PropertyReportGenerationResult" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Domain.PropertyReportService.v1.Model.PropertyReportGenerationResult" } } } } }, "security": [ { "apikey": [] }, { "oauth2": [ "api_propertyreports_read" ] } ], "x-domain-usercontextrequired": false, "x-domain-endpointcost": 1, "x-domain-environment": "Any" } }, "/v1/avm/{propertyId}": { "get": { "tags": [ "PropertyAvm" ], "summary": "Creates a valuation for a given property id.\r\nIt uses a combination of the cache valuation and Domain API calls to populate the report.", "operationId": "PropertyAvm_Get", "parameters": [ { "name": "propertyId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A Valuation for a given property id", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DomainAvm.v1.AvmResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DomainAvm.v1.AvmResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DomainAvm.v1.AvmResponse" } } } }, "400": { "description": "Your request is bad", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DomainAvm.v1.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DomainAvm.v1.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DomainAvm.v1.ProblemDetails" } } } }, "401": { "description": "Your request is unauthorised" }, "403": { "description": "Your request is forbidden" }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DomainAvm.v1.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DomainAvm.v1.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DomainAvm.v1.ProblemDetails" } } } }, "500": { "description": "We have had an internal error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DomainAvm.v1.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DomainAvm.v1.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DomainAvm.v1.ProblemDetails" } } } } }, "security": [ { "apikey": [] }, { "oauth2": [ "api_avm_read" ] } ], "x-domain-endpointcost": 1, "x-domain-usercontextrequired": false, "x-domain-environment": "Any" } }, "/v1/avmReport/{propertyId}": { "get": { "tags": [ "PropertyAvm" ], "summary": "Creates a valuation PDF report for a given property id.\r\nIt uses a combination of the cache valuation and Domain API calls to populate the report.", "operationId": "PropertyAvm_ReportGet", "parameters": [ { "name": "propertyId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "showEstimate", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "A Valuation for a given property id", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DomainAvm.v1.AvmReportResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DomainAvm.v1.AvmReportResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DomainAvm.v1.AvmReportResponse" } } } }, "400": { "description": "Your request is bad", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DomainAvm.v1.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DomainAvm.v1.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DomainAvm.v1.ProblemDetails" } } } }, "401": { "description": "Your request is unauthorised" }, "403": { "description": "Your request is forbidden" }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DomainAvm.v1.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DomainAvm.v1.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DomainAvm.v1.ProblemDetails" } } } }, "500": { "description": "We have had an internal error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DomainAvm.v1.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DomainAvm.v1.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DomainAvm.v1.ProblemDetails" } } } } }, "security": [ { "apikey": [] }, { "oauth2": [ "api_avm_read" ] } ], "x-domain-endpointcost": 1, "x-domain-usercontextrequired": false, "x-domain-environment": "Any" } }, "/v2/property/features": { "get": { "tags": [ "PropertyFeatures" ], "summary": "Property features", "description": "Request to find property's features by a PropertyID, a GnafID or Address. Only one of `propertyId`, `gnafId`, or `address` should be provided.", "operationId": "Property_Features", "parameters": [ { "name": "propertyId", "in": "query", "schema": { "type": "string" } }, { "name": "gnafId", "in": "query", "schema": { "type": "string" } }, { "name": "flatNumber", "in": "query", "schema": { "type": "string" } }, { "name": "streetNumber", "in": "query", "schema": { "type": "string" } }, { "name": "streetName", "in": "query", "schema": { "type": "string" } }, { "name": "streetType", "in": "query", "schema": { "type": "string" } }, { "name": "postcode", "in": "query", "schema": { "type": "string" } }, { "name": "suburb", "in": "query", "schema": { "type": "string" } }, { "name": "state", "in": "query", "schema": { "enum": [ "ACT", "NSW", "NT", "QLD", "SA", "TAS", "VIC", "WA", "OT" ], "type": "string" } } ], "responses": { "200": { "description": "Successfully found compatable property", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Property.Enrichment.v2.PropertyFeatures" } } } }, "300": { "description": "Successfully found multiple compatable properties", "content": { "application/json": { "schema": { "type": "object", "properties": { "properties": { "$ref": "#/components/schemas/Property.Enrichment.v2.MultipleAddressBasic" } } } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" }, "500": { "description": "Unexpected error" } }, "security": [ { "apikey": [] }, { "oauth2": [ "api_properties_read" ] } ], "x-domain-endpointcost": 1, "x-domain-usercontextrequired": false, "x-domain-environment": "Any" } }, "/v2/properties/search/like/{searchType}": { "get": { "tags": [ "PropertyLike" ], "summary": "Comparable properties search", "description": "Return list of comparable properties within a radius of specified property by PropertyID, a GnafID or full address. Only one of `propertyId`, `gnafId` or `address` should be provided. The list sorted by bedrooms, bathrooms and car space comparability to specified property, and then by distance", "operationId": "PropertyLike_Comparables", "parameters": [ { "name": "searchType", "in": "path", "description": "Type of property search (sold, rent, or sale).", "required": true, "schema": { "enum": [ "sale", "rent", "sold" ], "type": "string" } }, { "name": "radius", "in": "query", "description": "Radius of search in km.", "schema": { "maximum": 50, "type": "integer", "default": 5 } }, { "name": "period", "in": "query", "description": "Time period in months for searching SOLD comparables.", "schema": { "maximum": 36, "type": "integer", "default": 12 } }, { "name": "propertyId", "in": "query", "schema": { "type": "string" } }, { "name": "gnafId", "in": "query", "schema": { "type": "string" } }, { "name": "flatNumber", "in": "query", "schema": { "type": "string" } }, { "name": "streetNumber", "in": "query", "schema": { "type": "string" } }, { "name": "streetName", "in": "query", "schema": { "type": "string" } }, { "name": "streetType", "in": "query", "schema": { "type": "string" } }, { "name": "postcode", "in": "query", "schema": { "type": "string" } }, { "name": "suburb", "in": "query", "schema": { "type": "string" } }, { "name": "state", "in": "query", "schema": { "enum": [ "ACT", "NSW", "NT", "QLD", "SA", "TAS", "VIC", "WA", "OT" ], "type": "string" } } ], "responses": { "200": { "description": "Successfully found compatable properties", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Property.Enrichment.v2.SearchItemOutput" } } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" }, "500": { "description": "Unexpected error" } }, "security": [ { "apikey": [] }, { "oauth2": [ "api_properties_read" ] } ], "x-domain-endpointcost": 1, "x-domain-usercontextrequired": false, "x-domain-environment": "Any" } }, "/v1/propertyradar/portfolio": { "post": { "tags": [ "PropertyRadar" ], "summary": "Create Portfolio", "description": "Creates a portfolio and returns portfolio id", "operationId": "PropertyRadar_CreatePortfolio", "requestBody": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/PropertyActivityAPI.v1.PortfolioDetails" }, { "type": "object", "properties": { "empty": { "maxProperties": 0, "type": "object", "description": "Create an empty portfolio" } }, "additionalProperties": false } ] } } }, "required": true }, "responses": { "200": { "description": "Portfolio created successfully - Portfolio ID returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PropertyActivityAPI.v1.PortfolioCreated" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "500": { "description": "Unexpected error" } }, "security": [ { "apikey": [] }, { "oauth2": [ "api_propertyportfolio_write" ] } ], "x-domain-endpointcost": 1, "x-domain-usercontextrequired": false, "x-domain-environment": "Any" } }, "/v1/propertyradar/portfolio/{PortfolioId}": { "get": { "tags": [ "PropertyRadar" ], "summary": "View Properties in Portfolio", "description": "List property and gnaf id's for an existing portfolio", "operationId": "PropertyRadar_ViewPortfolio", "parameters": [ { "name": "PortfolioId", "in": "path", "required": true, "schema": { "pattern": "^PORTFOLIO_[0-9A-Fa-f]{32}$", "type": "string" } } ], "responses": { "200": { "description": "List of property and gnaf id's", "content": { "application/json": { "schema": { "type": "object", "properties": { "PortfolioId": { "pattern": "^PORTFOLIO_[0-9A-Fa-f]{32}$", "type": "string", "example": "PORTFOLIO_7eedc8e01b2942eaaa396de4b512f6a1" }, "Properties": { "type": "object", "properties": { "PropertyIds": { "type": "array", "items": { "type": "string" }, "example": [ "AB-2872-NY", "RF-8884-AK" ] }, "GnafIds": { "type": "array", "items": { "type": "string" }, "example": [ "GAVIC419677979", "GANSW710292212" ] } } } } } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "500": { "description": "Unexpected error" } }, "security": [ { "apikey": [] }, { "oauth2": [ "api_propertyportfolio_read" ] } ], "x-domain-endpointcost": 1, "x-domain-usercontextrequired": false, "x-domain-environment": "Any" }, "post": { "tags": [ "PropertyRadar" ], "summary": "Add Properties to Portfolio", "description": "Adds properties to a portfolio by property id's and/or gnaf id's", "operationId": "PropertyRadar_AddToPortfolio", "parameters": [ { "name": "PortfolioId", "in": "path", "required": true, "schema": { "pattern": "^PORTFOLIO_[0-9A-Fa-f]{32}$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PropertyActivityAPI.v1.PortfolioDetails" } } }, "required": true }, "responses": { "204": { "description": "Properties added successfully" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "500": { "description": "Unexpected error" } }, "security": [ { "apikey": [] }, { "oauth2": [ "api_propertyportfolio_write" ] } ], "x-domain-endpointcost": 1, "x-domain-usercontextrequired": false, "x-domain-environment": "Any" }, "delete": { "tags": [ "PropertyRadar" ], "summary": "Delete Portfolio", "description": "Deletes a portfolio and all associated properties", "operationId": "PropertyRadar_DeletePortfolio", "parameters": [ { "name": "PortfolioId", "in": "path", "required": true, "schema": { "pattern": "^PORTFOLIO_[0-9A-Fa-f]{32}$", "type": "string" } } ], "responses": { "204": { "description": "Portfolio deleted successfully" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "500": { "description": "Unexpected error" } }, "security": [ { "apikey": [] }, { "oauth2": [ "api_propertyportfolio_write" ] } ], "x-domain-endpointcost": 1, "x-domain-usercontextrequired": false, "x-domain-environment": "Any" } }, "/v1/propertyradar/portfolio/{PortfolioId}/properties": { "get": { "tags": [ "PropertyRadar" ], "summary": "View Properties in Portfolio - Detailed", "description": "List property and gnaf id's with details for an existing portfolio, along with market status and last listed information. Results are returned one page at a time, with a default page size of 500000 records. Records are returned in alphabetical order, with Property ID's first followed by GNAF ID's.For PageSize greater than 10000, please don't use Domain Portal UI", "operationId": "PropertyRadar_ViewPortfolioFull", "parameters": [ { "name": "PortfolioId", "in": "path", "required": true, "schema": { "pattern": "^PORTFOLIO_[0-9A-Fa-f]{32}$", "type": "string" } }, { "name": "Page", "in": "query", "description": "The page of data to return", "schema": { "minimum": 1, "type": "integer", "default": 1 } }, { "name": "PageSize", "in": "query", "description": "The number of records per page", "schema": { "maximum": 1000000, "minimum": 1, "type": "integer", "default": 500000 } } ], "responses": { "200": { "description": "List of property and gnaf id's", "content": { "application/json": { "schema": { "type": "object", "properties": { "Data": { "type": "object", "properties": { "PortfolioId": { "pattern": "^PORTFOLIO_[0-9A-Fa-f]{32}$", "type": "string", "example": "PORTFOLIO_7eedc8e01b2942eaaa396de4b512f6a1" }, "Properties": { "type": "object", "properties": { "PropertyIds": { "type": "array", "items": { "type": "object", "properties": { "PropertyId": { "type": "string", "example": "AB-2872-NY" }, "MarketStatus": { "enum": [ "on-market", "off-market", null ], "type": "string", "description": "Whether the property is currently on the market. \"null\" = unknown", "nullable": true, "example": "on-market" }, "SaleRentFlag": { "enum": [ "sale", "rent", null ], "type": "string", "description": "if MarketStatus = \"on-market\", then whether the property is for sale or rent, otherwise \"null\"", "nullable": true, "example": "sale" }, "LastListedDate": { "type": "string", "description": "if MarketStatus = \"on-market\", then the date when the property was listed for sale or rent, otherwise \"null\"", "format": "date", "nullable": true, "example": "2024-04-20" } } } }, "GnafIds": { "type": "array", "items": { "type": "object", "properties": { "GnafId": { "type": "string", "example": "GAVIC419677979" }, "MarketStatus": { "enum": [ "on-market", "off-market", null ], "type": "string", "description": "Whether the property is currently on the market. null = unknown", "nullable": true, "example": "off-market" }, "SaleRentFlag": { "enum": [ "sale", "rent", null ], "type": "string", "description": "if MarketStatus = \"on-market\", then whether the property is for sale or rent, otherwise \"null\"", "nullable": true, "example": null }, "LastListedDate": { "type": "string", "description": "if MarketStatus = \"on-market\", then the date when the property was listed for sale or rent, otherwise \"null\"", "format": "date", "nullable": true, "example": null } } } } } } } }, "Pagination": { "type": "object", "properties": { "Total": { "type": "integer", "description": "The total number of property and gnaf id's in the portfolio", "example": 560000 }, "Page": { "type": "integer", "description": "Current page being returned", "example": 1 }, "PageSize": { "type": "integer", "description": "The maximum number of property + gnaf id's per page", "example": 100000 }, "TotalPages": { "type": "integer", "description": "The total number of available pages of data", "example": 6 }, "PrevPage": { "type": "string", "description": "A link to the previous page of data (if applicable)", "nullable": true }, "NextPage": { "type": "string", "description": "A link to the next page of data (if applicable)", "nullable": true, "example": "/portfolio/PORTFOLIO_7eedc8e01b2942eaaa396de4b512f6a1/properties?page=2" } } } } } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "500": { "description": "Unexpected error" } }, "security": [ { "apikey": [] }, { "oauth2": [ "api_propertyportfolio_read" ] } ], "x-domain-endpointcost": 1, "x-domain-usercontextrequired": false, "x-domain-environment": "Any" } }, "/v1/propertyradar/portfolio/{PortfolioId}/properties/{PropertyId}": { "get": { "tags": [ "PropertyRadar" ], "summary": "View Single Property in Portfolio - Detailed", "description": "Show market status and last listed information for a single property in a portfolio.", "operationId": "PropertyRadar_viewPortfolioFullSingle", "parameters": [ { "name": "PortfolioId", "in": "path", "required": true, "schema": { "pattern": "^PORTFOLIO_[0-9A-Fa-f]{32}$", "type": "string" } }, { "name": "PropertyId", "in": "path", "required": true, "schema": { "pattern": "^[A-Z]{2}-\\d{4}-[A-Z]{2}$", "type": "string" } } ], "responses": { "200": { "description": "Property market status details", "content": { "application/json": { "schema": { "type": "object", "properties": { "PropertyId": { "type": "string", "example": "AB-2872-NY" }, "MarketStatus": { "enum": [ "on-market", "off-market", null ], "type": "string", "description": "Whether the property is currently on the market. \"null\" = unknown", "nullable": true, "example": "on-market" }, "SaleRentFlag": { "enum": [ "sale", "rent", null ], "type": "string", "description": "if MarketStatus = \"on-market\", then whether the property is for sale or rent, otherwise \"null\"", "nullable": true, "example": "sale" }, "LastListedDate": { "type": "string", "description": "if MarketStatus = \"on-market\", then the date when the property was listed for sale or rent, otherwise \"null\"", "format": "date", "nullable": true, "example": "2024-04-20" } } } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "500": { "description": "Unexpected error" } }, "security": [ { "apikey": [] }, { "oauth2": [ "api_propertyportfolio_read" ] } ], "x-domain-endpointcost": 1, "x-domain-usercontextrequired": false, "x-domain-environment": "Any" } }, "/v1/propertyradar/portfolio/{PortfolioId}/properties/gnaf/{GnafId}": { "get": { "tags": [ "PropertyRadar" ], "summary": "View Single Property in Portfolio - Detailed", "description": "Show market status and last listed information for a single property in a portfolio.", "operationId": "PropertyRadar_viewPortfolioFullSingleByGnafId", "parameters": [ { "name": "PortfolioId", "in": "path", "required": true, "schema": { "pattern": "^PORTFOLIO_[0-9A-Fa-f]{32}$", "type": "string" } }, { "name": "GnafId", "in": "path", "required": true, "schema": { "pattern": "^GA[A-Z]{3}\\d{9}$", "type": "string" } } ], "responses": { "200": { "description": "Property market status details", "content": { "application/json": { "schema": { "type": "object", "properties": { "PropertyId": { "type": "string", "example": "AB-2872-NY" }, "GnafId": { "type": "string", "example": "GANSW110266652" }, "MarketStatus": { "enum": [ "on-market", "off-market", null ], "type": "string", "description": "Whether the property is currently on the market. \"null\" = unknown", "nullable": true, "example": "on-market" }, "SaleRentFlag": { "enum": [ "sale", "rent", null ], "type": "string", "description": "if MarketStatus = \"on-market\", then whether the property is for sale or rent, otherwise \"null\"", "nullable": true, "example": "sale" }, "LastListedDate": { "type": "string", "description": "if MarketStatus = \"on-market\", then the date when the property was listed for sale or rent, otherwise \"null\"", "format": "date", "nullable": true, "example": "2024-04-20" } } } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "500": { "description": "Unexpected error" } }, "security": [ { "apikey": [] }, { "oauth2": [ "api_propertyportfolio_read" ] } ], "x-domain-endpointcost": 1, "x-domain-usercontextrequired": false, "x-domain-environment": "Any" } }, "/v1/propertyradar/portfolio/{PortfolioId}/property/delete": { "post": { "tags": [ "PropertyRadar" ], "summary": "Remove Properties from Portfolio", "description": "Removes properties from a portfolio by property id's and/or gnaf id's, returning any id's that did not exist within the portfolio", "operationId": "PropertyRadar_RemoveFromPortfolio", "parameters": [ { "name": "PortfolioId", "in": "path", "required": true, "schema": { "pattern": "^PORTFOLIO_[0-9A-Fa-f]{32}$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PropertyActivityAPI.v1.PortfolioDetails" } } }, "required": true }, "responses": { "200": { "description": "Existing properties removed successfully, properties not in portfolio returned in response", "content": { "application/json": { "schema": { "type": "object", "properties": { "MissingPropertyIds": { "type": "array", "items": { "type": "string" }, "example": [ "AA-0000-AA", "BB-000-BB" ] }, "MissingGnafIds": { "type": "array", "items": { "type": "string" }, "example": [ "AAAA000000000", "BBBB000000000" ] } } } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "500": { "description": "Unexpected error" } }, "security": [ { "apikey": [] }, { "oauth2": [ "api_propertyportfolio_write" ] } ], "x-domain-endpointcost": 1, "x-domain-usercontextrequired": false, "x-domain-environment": "Any" } }, "/v1/propertyradar/portfoliosummary": { "get": { "tags": [ "PropertyRadar" ], "summary": "List Portfolios", "description": "List all portfolios for the customer with a count of associated property and gnaf id's", "operationId": "PropertyRadar_ListPortfolios", "responses": { "200": { "description": "List of portfolios", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PropertyActivityAPI.v1.PortfolioList" } } } }, "400": { "description": "Bad request" }, "500": { "description": "Unexpected error" } }, "security": [ { "apikey": [] }, { "oauth2": [ "api_propertyportfolio_read" ] } ], "x-domain-endpointcost": 1, "x-domain-usercontextrequired": false, "x-domain-environment": "Any" } }, "/v2/properties/search/radius/{searchType}": { "post": { "tags": [ "PropertySearch" ], "summary": "Point Radius Search", "description": "Make a search request to find properties within a point radius of a PropertyID, a GnafID, an Address, or a set of lat-lon coordinates. Only one of `propertyId`, `gnafId`, or `latitude` & `longitude`, or `address` should be provided.", "operationId": "PropertySearch_ByRadius", "parameters": [ { "name": "searchType", "in": "path", "description": "Type of property search (sold, rent, or sale).", "required": true, "schema": { "enum": [ "sale", "rent", "sold" ], "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "oneOf": [ { "allOf": [ { "$ref": "#/components/schemas/Property.Enrichment.v2.PointRadiusPropertyId" }, { "$ref": "#/components/schemas/Property.Enrichment.v2.PointRadiusParams" } ] }, { "allOf": [ { "$ref": "#/components/schemas/Property.Enrichment.v2.PointRadiusGnafId" }, { "$ref": "#/components/schemas/Property.Enrichment.v2.PointRadiusParams" } ] }, { "allOf": [ { "$ref": "#/components/schemas/Property.Enrichment.v2.PointRadiusLatLon" }, { "$ref": "#/components/schemas/Property.Enrichment.v2.PointRadiusParams" } ] }, { "allOf": [ { "$ref": "#/components/schemas/Property.Enrichment.v2.PropertyAddress-v2" }, { "$ref": "#/components/schemas/Property.Enrichment.v2.PointRadiusParams" } ] } ] } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "required": [ "items" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/Property.Enrichment.v2.SearchItemOutput" } } } } } } }, "400": { "description": "Bad request (likely missing required fields or incorrect parameters)." }, "401": { "description": "Unauthorized" }, "404": { "description": "A property with the specified ID was not found." }, "500": { "description": "Unexpected error" } }, "security": [ { "apikey": [] }, { "oauth2": [ "api_properties_read" ] } ], "x-domain-endpointcost": 1, "x-domain-usercontextrequired": false, "x-domain-environment": "Any" } }, "/v2/property/zoning-perils": { "get": { "tags": [ "PropertyZoningPerils" ], "summary": "Property perils", "description": "Request to find property's perils by a PropertyID, a GnafID or Address. Only one of `propertyId`, `gnafId`, or `address` should be provided.", "operationId": "Property_Zoning_Perils", "parameters": [ { "name": "propertyId", "in": "query", "schema": { "type": "string" } }, { "name": "gnafId", "in": "query", "schema": { "type": "string" } }, { "name": "flatNumber", "in": "query", "schema": { "type": "string" } }, { "name": "streetNumber", "in": "query", "schema": { "type": "string" } }, { "name": "streetName", "in": "query", "schema": { "type": "string" } }, { "name": "streetType", "in": "query", "schema": { "type": "string" } }, { "name": "postcode", "in": "query", "schema": { "type": "string" } }, { "name": "suburb", "in": "query", "schema": { "type": "string" } }, { "name": "state", "in": "query", "schema": { "enum": [ "ACT", "NSW", "NT", "QLD", "SA", "TAS", "VIC", "WA", "OT" ], "type": "string" } } ], "responses": { "200": { "description": "Successfully found compatable property", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Property.Enrichment.v2.PropertyPerils" } } } }, "300": { "description": "Successfully found multiple compatable properties", "content": { "application/json": { "schema": { "type": "object", "properties": { "properties": { "$ref": "#/components/schemas/Property.Enrichment.v2.MultipleAddressBasic" } } } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" }, "500": { "description": "Unexpected error" } }, "security": [ { "apikey": [] }, { "oauth2": [ "api_properties_read" ] } ], "x-domain-endpointcost": 1, "x-domain-usercontextrequired": false, "x-domain-environment": "Any" } }, "/v1/salesResults/_head": { "get": { "tags": [ "SalesResults" ], "summary": "Get weekly results info", "operationId": "SalesResults_Head", "responses": { "200": { "description": "Retrieves metadata regarding sales result data of the latest Saturday", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuctionResults.v1.infoResponse" } } } }, "401": { "description": "Unauthorized" }, "500": { "description": "Unexpected error" } }, "security": [ { "apikey": [] }, { "oauth2": [ "api_salesresults_read" ] } ], "x-domain-endpointcost": 1, "x-domain-usercontextrequired": false, "x-domain-environment": "Primary" } }, "/v1/salesResults/{city}": { "get": { "tags": [ "SalesResults" ], "summary": "Get weekly results summary", "operationId": "SalesResults_Get", "parameters": [ { "name": "city", "in": "path", "required": true, "schema": { "type": "string", "description": "City. Supported cities are: Sydney, Melbourne, Brisbane, Adelaide, Canberra" } } ], "responses": { "200": { "description": "Success. Retrieves summary of sales results for a given city for last Saturday", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuctionResults.v1.summaryResponse" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "500": { "description": "Unexpected error" } }, "security": [ { "apikey": [] }, { "oauth2": [ "api_salesresults_read" ] } ], "x-domain-endpointcost": 1, "x-domain-usercontextrequired": false, "x-domain-environment": "Primary" } }, "/v1/salesResults/{city}/listings": { "get": { "tags": [ "SalesResults" ], "summary": "Get weekly results details", "operationId": "SalesResults_Listings", "parameters": [ { "name": "city", "in": "path", "required": true, "schema": { "type": "string", "description": "City. Supported cities are: Sydney, Melbourne, Brisbane, Adelaide, Canberra" } } ], "responses": { "200": { "description": "Success. Retrieves listing events collection for last Saturday", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AuctionResults.v1.listingEventItem" } } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "500": { "description": "Unexpected error" } }, "security": [ { "apikey": [] }, { "oauth2": [ "api_salesresults_read" ] } ], "x-domain-endpointcost": 1, "x-domain-usercontextrequired": false, "x-domain-environment": "Primary" } }, "/v2/salesResults/saturday": { "get": { "tags": [ "SalesResults" ], "summary": "Saturday report", "operationId": "SalesResults_SaturdayReport", "responses": { "200": { "description": "Success. Retrieves Domain Saturday Auction Report for the last Saturday", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuctionResults.v1.saturdayAuctionResultResponse" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "500": { "description": "Unexpected error" } }, "security": [ { "apikey": [] }, { "oauth2": [ "api_salesresults_read" ] } ], "x-domain-endpointcost": 1, "x-domain-usercontextrequired": false, "x-domain-environment": "Primary" } }, "/v2/salesResults/weeklyMedia": { "get": { "tags": [ "SalesResults" ], "summary": "Weekly media report", "operationId": "SalesResults_WeeklyMediaReport", "responses": { "200": { "description": "Success. Retrieves Domain Weekly Auction Report for the last Saturday", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuctionResults.v1.weeklyMediaResultResponse" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "500": { "description": "Unexpected error" } }, "security": [ { "apikey": [] }, { "oauth2": [ "api_salesresults_read" ] } ], "x-domain-endpointcost": 1, "x-domain-usercontextrequired": false, "x-domain-environment": "Primary" } }, "/v2/schools/{id}": { "get": { "tags": [ "Schools" ], "summary": "Retrieve the details of a school by Id", "description": "Domain School Ids can be obtained from the search by location endpoint.", "operationId": "Schools_Get_ById", "parameters": [ { "name": "id", "in": "path", "description": "School id", "required": true, "schema": { "type": "integer", "format": "int32" }, "example": 1234 } ], "responses": { "200": { "description": "Schools data returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Schools.V2.School" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "apikey": [] }, { "oauth2": [ "api_locations_read" ] } ], "x-domain-endpointcost": 1, "x-domain-usercontextrequired": false, "x-domain-environment": "Primary" } }, "/v2/schools/{latitude}/{longitude}": { "get": { "tags": [ "Schools" ], "summary": "Search for a school in a location", "operationId": "Schools_Search_ByLocation", "parameters": [ { "name": "latitude", "in": "path", "description": "Latitude to search", "required": true, "schema": { "type": "number", "format": "double" }, "example": -33.8 }, { "name": "longitude", "in": "path", "description": "Longitude to search", "required": true, "schema": { "type": "number", "format": "double" }, "example": 150.9 } ], "responses": { "200": { "description": "Schools data returned", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Schools.V2.SchoolWithDistance" } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "apikey": [] }, { "oauth2": [ "api_locations_read" ] } ], "x-domain-endpointcost": 1, "x-domain-usercontextrequired": false, "x-domain-environment": "Primary" } }, "/v1/statistics/{event}": { "post": { "tags": [ "Statistics" ], "summary": "Record a statistic event along with its associated metadata (if applicable)", "operationId": "Statistics_Post", "parameters": [ { "name": "event", "in": "path", "description": "The event type", "required": true, "schema": { "enum": [ "listingViewed", "listingImageGalleryViewed", "listingImageViewed", "listingMapViewed", "listingVideoViewed", "listingFloorPlanViewed", "listingAddedToShortlist", "listingAgentCalled", "listingAgentPhoneRevealed", "listingNotesAdded", "listingEmailedToAFriend", "listingEnquirySent", "loanEventRaised" ], "type": "string" } } ], "requestBody": { "description": "A JSON object dictionary of the metadata associated with the event.", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } }, "text/html": { "schema": { "type": "object" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object" } } }, "required": true, "x-bodyName": "eventMetaData" }, "responses": { "202": { "description": "The statistic event has been queued for reporting." }, "400": { "description": "There was a validation error with the supplied data. Check the error message for details" } }, "security": [ { "apikey": [] }, { "oauth2": [ "api_statistics_write" ] } ], "x-domain-usercontextrequired": false, "x-domain-endpointcost": 1, "x-domain-environment": "Any" } }, "/v1/suburbHistorical/{state}/{suburb}/{postcode}": { "get": { "tags": [ "Statistics" ], "summary": "Suburb Historical", "description": "Retrieve suburb historical data (up to 5 years) by state, suburb and postcode", "operationId": "SuburbHistorical_Get", "parameters": [ { "name": "state", "in": "path", "description": "The Australian state abbreviation\n", "required": true, "style": "simple", "schema": { "enum": [ "NSW", "VIC", "QLD", "SA", "WA", "TAS", "NT", "ACT" ], "type": "string" }, "example": "NSW" }, { "name": "suburb", "in": "path", "description": "Suburb name to retrieve data for\n", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "Pyrmont" }, { "name": "postcode", "in": "path", "description": "Suburb Post Code for suburbs with official post codes.\n", "required": true, "style": "simple", "schema": { "pattern": "^\\d{4}$", "type": "string" }, "example": "2009" }, { "name": "propertyCategory", "in": "query", "description": "Category of sales results to show\nAvailable values : house, unit\nDefault value : house\n", "style": "form", "schema": { "enum": [ "House", "Unit" ], "type": "string" } }, { "name": "periodSize", "in": "query", "description": "Unit of the measurement period to use\nDefault value : quarters\n", "style": "form", "schema": { "enum": [ "months", "quarters", "years" ], "type": "string" } }, { "name": "hasBedroomSplits", "in": "query", "description": "Whether to include bedroom splits in summary data. When true or omitted, returns aggregated data plus splits by bedroom count. When false, returns only the total aggregated record. \nDefault value : true\n", "style": "form", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Historical data returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuburbSummaryAndHistorical" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "500": { "description": "Unexpected error" } }, "security": [ { "apikey": [] }, { "oauth2": [ "api_suburbhistorical_read" ] } ], "x-domain-endpointcost": 1, "x-domain-usercontextrequired": false, "x-domain-environment": "Any" } }, "/v2/suburbPerformanceStatistics/{state}/{suburb}": { "get": { "tags": [ "Statistics" ], "summary": "Suburb Performance by State/Suburb", "description": "Retrieve suburb performance data by state and suburb", "operationId": "SuburbPerformance_Get_ByNamedSuburb_WithoutPostcode", "parameters": [ { "name": "state", "in": "path", "description": "The Australian state abbreviation\n", "required": true, "style": "simple", "schema": { "enum": [ "NSW", "VIC", "QLD", "SA", "WA", "TAS", "NT", "ACT" ], "type": "string" }, "example": "NSW" }, { "name": "suburb", "in": "path", "description": "Suburb name to retrieve data for\n", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "Pyrmont" }, { "name": "propertyCategory", "in": "query", "description": "Category of sales results to show\nAvailable values : house, unit\nDefault value : house\n", "style": "form", "schema": { "enum": [ "House", "Unit" ], "type": "string" } }, { "name": "bedrooms", "in": "query", "description": "Number of bedrooms to use in the sales search\n", "style": "form", "schema": { "type": "integer" }, "example": 3 }, { "name": "periodSize", "in": "query", "description": "Unit of the measurement period to use\nDefault value : quarters\n", "style": "form", "schema": { "enum": [ "quarters", "halfYears", "years" ], "type": "string" } }, { "name": "startingPeriodRelativeToCurrent", "in": "query", "description": "When to start stats from. 1 = current period, 2 = previous period, etc.\nDefault value : 1\n", "style": "form", "schema": { "type": "integer" } }, { "name": "totalPeriods", "in": "query", "description": "Number of total periods to show statistics for. i.e. 4 Quarters would be 1 full year\nDefault value : 4\n", "style": "form", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Statistics data returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuburbPerformance" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "500": { "description": "Unexpected error" } }, "security": [ { "apikey": [] }, { "oauth2": [ "api_suburbperformance_read" ] } ], "x-domain-endpointcost": 1, "x-domain-usercontextrequired": false, "x-domain-environment": "Any" } }, "/v2/suburbPerformanceStatistics/{state}/{suburb}/{postcode}": { "get": { "tags": [ "Statistics" ], "summary": "Suburb Performance by State/Suburb/Postcode", "description": "Retrieve suburb performance data by state, suburb and postcode", "operationId": "SuburbPerformance_Get_ByNamedSuburb", "parameters": [ { "name": "state", "in": "path", "description": "The Australian state abbreviation\n", "required": true, "style": "simple", "schema": { "enum": [ "NSW", "VIC", "QLD", "SA", "WA", "TAS", "NT", "ACT" ], "type": "string" }, "example": "NSW" }, { "name": "suburb", "in": "path", "description": "Suburb name to retrieve data for\n", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "Pyrmont" }, { "name": "postcode", "in": "path", "description": "Suburb Post Code for suburbs with official post codes.\n", "required": true, "style": "simple", "schema": { "pattern": "^\\d{4}$", "type": "string" }, "example": "2009" }, { "name": "propertyCategory", "in": "query", "description": "Category of sales results to show\nAvailable values : house, unit\nDefault value : house\n", "style": "form", "schema": { "enum": [ "House", "Unit" ], "type": "string" } }, { "name": "bedrooms", "in": "query", "description": "Number of bedrooms to use in the sales search\n", "style": "form", "schema": { "type": "integer" }, "example": 3 }, { "name": "periodSize", "in": "query", "description": "Unit of the measurement period to use\nDefault value : quarters\n", "style": "form", "schema": { "enum": [ "quarters", "halfYears", "years" ], "type": "string" } }, { "name": "startingPeriodRelativeToCurrent", "in": "query", "description": "When to start stats from. 1 = current period, 2 = previous period, etc.\nDefault value : 1\n", "style": "form", "schema": { "type": "integer" } }, { "name": "totalPeriods", "in": "query", "description": "Number of total periods to show statistics for. i.e. 4 Quarters would be 1 full year\nDefault value : 4\n", "style": "form", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Statistics data returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuburbPerformance" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "500": { "description": "Unexpected error" } }, "security": [ { "apikey": [] }, { "oauth2": [ "api_suburbperformance_read" ] } ], "x-domain-endpointcost": 1, "x-domain-usercontextrequired": false, "x-domain-environment": "Any" } }, "/v1/suburbSummary/{state}/{suburb}/{postcode}": { "get": { "tags": [ "Statistics" ], "summary": "Suburb Summary", "description": "Retrieve suburb summary data (up to 12 months) by state, suburb and postcode", "operationId": "SuburbSummary_Get", "parameters": [ { "name": "state", "in": "path", "description": "The Australian state abbreviation\n", "required": true, "style": "simple", "schema": { "enum": [ "NSW", "VIC", "QLD", "SA", "WA", "TAS", "NT", "ACT" ], "type": "string" }, "example": "NSW" }, { "name": "suburb", "in": "path", "description": "Suburb name to retrieve data for\n", "required": true, "style": "simple", "schema": { "type": "string" }, "example": "Pyrmont" }, { "name": "postcode", "in": "path", "description": "Suburb Post Code for suburbs with official post codes.\n", "required": true, "style": "simple", "schema": { "pattern": "^\\d{4}$", "type": "string" }, "example": "2009" }, { "name": "propertyCategory", "in": "query", "description": "Category of sales results to show\nAvailable values : house, unit\nDefault value : house\n", "style": "form", "schema": { "enum": [ "House", "Unit" ], "type": "string" } }, { "name": "periodSize", "in": "query", "description": "Unit of the measurement period to use\nDefault value : quarters\n", "style": "form", "schema": { "enum": [ "months", "quarters", "years" ], "type": "string" } }, { "name": "hasBedroomSplits", "in": "query", "description": "Whether to include bedroom splits in summary data. When true or omitted, returns aggregated data plus splits by bedroom count. When false, returns only the total aggregated record. \nDefault value : true\n", "style": "form", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Summary data returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuburbSummaryAndHistorical" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "500": { "description": "Unexpected error" } }, "security": [ { "apikey": [] }, { "oauth2": [ "api_suburbsummary_read" ] } ], "x-domain-endpointcost": 1, "x-domain-usercontextrequired": false, "x-domain-environment": "Any" } }, "/v1/subscriptions/{id}": { "get": { "tags": [ "Webhooks" ], "summary": "Retrieve the details of a single subscription", "operationId": "Webhooks_GetSubscription", "parameters": [ { "name": "id", "in": "path", "description": "Subscription identifier", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Webhooks.v1.WebhookSubscription" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "apikey": [] }, { "oauth2": [ "api_webhooks_write" ] } ], "x-domain-endpointcost": 1, "x-domain-usercontextrequired": false, "x-domain-environment": "Any" }, "delete": { "tags": [ "Webhooks" ], "summary": "Delete a single subscription", "operationId": "Webhooks_DeleteSubscription", "parameters": [ { "name": "id", "in": "path", "description": "Subscription identifier", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "apikey": [] }, { "oauth2": [ "api_webhooks_write" ] } ], "x-domain-endpointcost": 1, "x-domain-usercontextrequired": false, "x-domain-environment": "Any" } }, "/v1/webhooks/{id}/subscriptions": { "get": { "tags": [ "Webhooks" ], "summary": "List all subscriptions to the specified webhook", "operationId": "Webhooks_ListSubscriptions", "parameters": [ { "name": "id", "in": "path", "description": "Subscriber (Webhook) ID", "required": true, "schema": { "type": "string" } }, { "name": "pageNumber", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "default": 20 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Webhooks.v1.WebhookSubscription" } } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "apikey": [] }, { "oauth2": [ "api_webhooks_write" ] } ], "x-domain-endpointcost": 1, "x-domain-usercontextrequired": false, "x-domain-environment": "Any" }, "put": { "tags": [ "Webhooks" ], "summary": "Create a subscription to notifications", "operationId": "Webhooks_CreateSubscription", "parameters": [ { "name": "id", "in": "path", "description": "Subscriber (Webhook) Id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "New Subscription Details", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Webhooks.v1.AddSubscriptionRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Webhooks.v1.AddSubscriptionRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Webhooks.v1.AddSubscriptionRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Webhooks.v1.WebhookSubscription" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Webhooks.v1.WebhookSubscription" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "apikey": [] }, { "oauth2": [ "api_webhooks_write" ] } ], "x-domain-endpointcost": 1, "x-domain-usercontextrequired": true, "x-domain-environment": "Any" } } }, "components": { "schemas": { "Agencies.V2.AgencySummary": { "type": "object", "properties": { "inSuburb": { "type": "boolean", "description": "Gets or Sets InSuburb", "nullable": true }, "querySuburb": { "type": "string", "description": "Gets or Sets QuerySuburb", "nullable": true }, "hasRecentlySold": { "type": "boolean", "description": "Gets or Sets HasRecentlySold", "nullable": true }, "id": { "type": "integer", "description": "Gets or Sets Id", "format": "int32", "nullable": true }, "name": { "type": "string", "description": "Gets or Sets Name", "nullable": true }, "suburb": { "type": "string", "description": "Gets or Sets Suburb", "nullable": true }, "logoUrl": { "type": "string", "description": "Gets or Sets LogoUrl", "nullable": true }, "baseUrl": { "type": "string", "description": "Gets or Sets BaseUrl", "nullable": true }, "address1": { "type": "string", "description": "Gets or Sets Address1", "nullable": true }, "address2": { "type": "string", "description": "Gets or Sets Address2", "nullable": true }, "telephone": { "type": "string", "description": "Gets or Sets Telephone", "nullable": true }, "rentalTelephone": { "type": "string", "description": "Gets or Sets RentalTelephone", "nullable": true }, "mobile": { "type": "string", "description": "Gets or Sets Mobile", "nullable": true }, "fax": { "type": "string", "description": "Gets or Sets Fax", "nullable": true }, "state": { "type": "string", "description": "Gets or Sets State", "nullable": true }, "description": { "type": "string", "description": "Gets or Sets Description", "nullable": true }, "email": { "type": "string", "description": "Gets or Sets Email", "nullable": true }, "rentalEmail": { "type": "string", "description": "Gets or Sets RentalEmail", "nullable": true }, "homePageSearchOptions": { "type": "string", "description": "Gets or Sets HomePageSearchOptions", "nullable": true }, "accountType": { "type": "integer", "description": "Gets or Sets AccountType", "format": "int32", "nullable": true }, "numberForSale": { "type": "integer", "description": "Gets or Sets NumberForSale", "format": "int32", "nullable": true }, "numberForRent": { "type": "integer", "description": "Gets or Sets NumberForRent", "format": "int32", "nullable": true }, "domainUrl": { "type": "string", "description": "Gets or Sets DomainUrl", "nullable": true }, "showTabSoldLastYear": { "type": "boolean", "description": "Gets or Sets ShowTabSoldLastYear", "nullable": true } }, "additionalProperties": false, "description": "AgencySummary", "x-data-access-level-info": { "Basic": [ "AccountType", "Address1", "Address2", "BaseUrl", "Description", "DomainUrl", "Email", "Fax", "HasRecentlySold", "HomePageSearchOptions", "Id", "InSuburb", "LogoUrl", "Mobile", "Name", "NumberForRent", "NumberForSale", "QuerySuburb", "RentalEmail", "RentalTelephone", "ShowTabSoldLastYear", "State", "Suburb", "Telephone" ], "Detailed": [ "AccountType", "Address1", "Address2", "BaseUrl", "Description", "DomainUrl", "Email", "Fax", "HasRecentlySold", "HomePageSearchOptions", "Id", "InSuburb", "LogoUrl", "Mobile", "Name", "NumberForRent", "NumberForSale", "QuerySuburb", "RentalEmail", "RentalTelephone", "ShowTabSoldLastYear", "State", "Suburb", "Telephone" ], "Full": [ "AccountType", "Address1", "Address2", "BaseUrl", "Description", "DomainUrl", "Email", "Fax", "HasRecentlySold", "HomePageSearchOptions", "Id", "InSuburb", "LogoUrl", "Mobile", "Name", "NumberForRent", "NumberForSale", "QuerySuburb", "RentalEmail", "RentalTelephone", "ShowTabSoldLastYear", "State", "Suburb", "Telephone" ] } }, "ProblemDetails": { "type": "object", "properties": { "type": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "status": { "type": "integer", "format": "int32", "nullable": true }, "detail": { "type": "string", "nullable": true }, "instance": { "type": "string", "nullable": true } }, "additionalProperties": {}, "x-data-access-level-info": { "Basic": [ "*" ], "Detailed": [ "*" ], "Full": [ "*" ] } }, "Agencies.V2.AgencyPhoto": { "type": "object", "properties": { "url": { "maxLength": 250, "minLength": 0, "type": "string", "description": "Gets or Sets Url", "nullable": true } }, "additionalProperties": false, "description": "AgencyPhoto", "x-data-access-level-info": { "Basic": [ "*" ], "Detailed": [ "*" ], "Full": [ "*" ] } }, "Agencies.V2.AgencyProfile": { "type": "object", "properties": { "agencyPhotos": { "type": "array", "items": { "$ref": "#/components/schemas/Agencies.V2.AgencyPhoto" }, "description": "Gets or Sets AgencyPhotos", "nullable": true }, "profileWebsite": { "maxLength": 50, "minLength": 0, "type": "string", "description": "Gets or Sets ProfileWebsite", "nullable": true }, "agencyBanner": { "maxLength": 100, "minLength": 0, "type": "string", "description": "Gets or Sets AgencyBanner", "nullable": true }, "agencyWebsite": { "maxLength": 100, "minLength": 0, "type": "string", "description": "Gets or Sets AgencyWebsite", "nullable": true }, "agencyLogoStandard": { "maxLength": 100, "minLength": 0, "type": "string", "description": "Gets or Sets AgencyLogoStandard", "nullable": true }, "agencyLogoSmall": { "maxLength": 100, "minLength": 0, "type": "string", "description": "Gets or Sets AgencyLogoSmall", "nullable": true }, "logoColour": { "maxLength": 10, "minLength": 0, "type": "string", "description": "Gets or Sets LogoColour", "nullable": true }, "primaryAgencyColour": { "maxLength": 10, "minLength": 0, "type": "string", "description": "Gets or Sets PrimaryAgencyColour", "nullable": true }, "backgroundColour": { "maxLength": 10, "minLength": 0, "type": "string", "description": "Gets or Sets BackgroundColour", "nullable": true }, "mapLatitude": { "type": "string", "description": "Gets or Sets MapLatitude", "nullable": true }, "mapLongitude": { "type": "string", "description": "Gets or Sets MapLongitude", "nullable": true }, "mapCertainty": { "maximum": 2147483647, "minimum": -2147483648, "type": "integer", "description": "Gets or Sets MapCertainty", "format": "int32", "nullable": true }, "agencyVideoUrl": { "maxLength": 250, "minLength": 0, "type": "string", "description": "Gets or Sets AgencyVideoUrl", "nullable": true }, "agencyDescription": { "type": "string", "description": "Gets or Sets AgencyDescription", "nullable": true }, "agencyDescriptionCre": { "type": "string", "description": "Gets or Sets AgencyDescriptionCre", "nullable": true }, "creProfileWebsite": { "maxLength": 50, "minLength": 0, "type": "string", "description": "Gets or Sets CreProfileWebsite", "nullable": true }, "agencyCreBanner": { "maxLength": 100, "minLength": 0, "type": "string", "description": "Gets or Sets AgencyCreBanner", "nullable": true }, "agencyCreWebsite": { "maxLength": 100, "minLength": 0, "type": "string", "description": "Gets or Sets AgencyCreWebsite", "nullable": true }, "agencyCreLogoStandard": { "maxLength": 100, "minLength": 0, "type": "string", "description": "Gets or Sets AgencyCreLogoStandard", "nullable": true }, "numberForSale": { "type": "integer", "description": "Gets or Sets NumberForSale", "format": "int32", "nullable": true }, "numberForRent": { "type": "integer", "description": "Gets or Sets NumberForRent", "format": "int32", "nullable": true }, "numberForSaleCommercial": { "type": "integer", "description": "Gets or Sets NumberForSaleCommercial", "format": "int32", "nullable": true }, "numberForRentCommercial": { "type": "integer", "description": "Gets or Sets NumberForRentCommercial", "format": "int32", "nullable": true }, "creAgencyVideoUrl": { "maxLength": 240, "minLength": 0, "type": "string", "description": "Gets or Sets CreAgencyVideoUrl", "nullable": true } }, "additionalProperties": false, "description": "AgencyProfile", "x-data-access-level-info": { "Basic": [ "AgencyBanner", "AgencyCreBanner", "AgencyCreLogoStandard", "AgencyCreWebsite", "AgencyDescription", "AgencyDescriptionCre", "AgencyLogoStandard", "AgencyLogoSmall", "BackgroundColour", "LogoColour", "PrimaryAgencyColour", "AgencyWebsite", "CreProfileWebsite", "MapCertainty", "MapLatitude", "MapLongitude", "NumberForRent", "NumberForRentCommercial", "NumberForSale", "NumberForSaleCommercial", "ProfileWebsite" ], "Detailed": [ "AgencyBanner", "AgencyCreBanner", "AgencyCreLogoStandard", "AgencyCreWebsite", "AgencyDescription", "AgencyDescriptionCre", "AgencyLogoStandard", "AgencyLogoSmall", "BackgroundColour", "LogoColour", "PrimaryAgencyColour", "AgencyWebsite", "CreProfileWebsite", "MapCertainty", "MapLatitude", "MapLongitude", "NumberForRent", "NumberForRentCommercial", "NumberForSale", "NumberForSaleCommercial", "ProfileWebsite", "CreAgencyVideoUrl", "AgencyVideoUrl", "AgencyPhotos" ], "Full": [ "AgencyBanner", "AgencyCreBanner", "AgencyCreLogoStandard", "AgencyCreWebsite", "AgencyDescription", "AgencyDescriptionCre", "AgencyLogoStandard", "AgencyLogoSmall", "BackgroundColour", "LogoColour", "PrimaryAgencyColour", "AgencyWebsite", "CreProfileWebsite", "MapCertainty", "MapLatitude", "MapLongitude", "NumberForRent", "NumberForRentCommercial", "NumberForSale", "NumberForSaleCommercial", "ProfileWebsite", "CreAgencyVideoUrl", "AgencyVideoUrl", "AgencyPhotos" ] } }, "Agencies.V2.AgencyDetails": { "required": [ "contractState", "excludeFromAgencyRanking", "hideMarketPriceEstimate", "limitEmailDomain", "postcode", "state", "streetAddress1", "suburb" ], "type": "object", "properties": { "streetAddress1": { "maxLength": 100, "minLength": 0, "type": "string", "description": "Gets or Sets StreetAddress1" }, "streetAddress2": { "maxLength": 100, "minLength": 0, "type": "string", "description": "Gets or Sets StreetAddress2", "nullable": true }, "suburb": { "maxLength": 25, "minLength": 0, "type": "string", "description": "Gets or Sets Suburb" }, "state": { "maxLength": 3, "minLength": 0, "type": "string", "description": "Gets or Sets State" }, "postcode": { "maxLength": 4, "minLength": 0, "type": "string", "description": "Gets or Sets Postcode" }, "agencyWebsite": { "maxLength": 100, "minLength": 0, "type": "string", "description": "Gets or Sets AgencyWebsite", "nullable": true }, "principalName": { "maxLength": 50, "minLength": 0, "type": "string", "description": "Gets or Sets PrincipalName", "nullable": true }, "principalEmail": { "maxLength": 150, "minLength": 0, "type": "string", "description": "Gets or Sets PrincipalEmail", "nullable": true }, "showPastSalesPrices": { "type": "boolean", "description": "Gets or Sets ShowPastSalesPrices", "nullable": true }, "isAgencyReportEnabled": { "type": "boolean", "description": "Gets or Sets IsAgencyReportEnabled", "nullable": true }, "salesEmail": { "maxLength": 100, "minLength": 0, "type": "string", "description": "Gets or Sets SalesEmail", "nullable": true }, "rentalEmail": { "maxLength": 100, "minLength": 0, "type": "string", "description": "Gets or Sets RentalEmail", "nullable": true }, "isPromotionalTelephoneActive": { "type": "boolean", "description": "Gets or Sets IsPromotionalTelephoneActive", "nullable": true }, "hideMarketPriceEstimate": { "type": "boolean", "description": "Gets or Sets HideMarketPriceEstimate" }, "limitEmailDomain": { "type": "boolean", "description": "Gets or Sets LimitEmailDomain" }, "showTabSoldLastYear": { "type": "boolean", "description": "Gets or Sets ShowTabSoldLastYear", "nullable": true } }, "additionalProperties": false, "description": "AgencyDetails", "x-data-access-level-info": { "Basic": [ "AgencyWebsite", "Postcode", "PrincipalName", "State", "Suburb", "StreetAddress1", "StreetAddress2" ], "Detailed": [ "AgencyWebsite", "Postcode", "PrincipalName", "State", "Suburb", "StreetAddress1", "StreetAddress2", "PrincipalEmail", "RentalEmail", "SalesEmail" ], "Full": [ "AgencyWebsite", "Postcode", "PrincipalName", "State", "Suburb", "StreetAddress1", "StreetAddress2", "PrincipalEmail", "RentalEmail", "SalesEmail", "HideMarketPriceEstimate", "IsAgencyReportEnabled", "IsPromotionalTelephoneActive", "LimitEmailDomain", "ShowPastSalesPrices", "ShowTabSoldLastYear" ] } }, "Agencies.V2.ContactInAgencyList": { "type": "object", "properties": { "agencyId": { "type": "integer", "description": "Gets or Sets AgencyId", "format": "int32", "nullable": true }, "id": { "type": "integer", "description": "Gets or Sets Id", "format": "int32", "nullable": true }, "email": { "type": "string", "description": "Gets or Sets Email", "nullable": true }, "firstName": { "type": "string", "description": "Gets or Sets FirstName", "nullable": true }, "mobile": { "type": "string", "description": "Gets or Sets Mobile", "nullable": true }, "photo": { "type": "string", "description": "Gets or Sets Photo", "nullable": true }, "lastName": { "type": "string", "description": "Gets or Sets LastName", "nullable": true }, "isActiveProfilePage": { "type": "string", "description": "Gets or Sets IsActiveProfilePage", "nullable": true }, "phone": { "type": "string", "description": "Gets or Sets Phone", "nullable": true }, "saleActive": { "type": "boolean", "description": "Gets or Sets SaleActive", "nullable": true }, "rentalActive": { "type": "boolean", "description": "Gets or Sets RentalActive", "nullable": true }, "secondaryEmail": { "type": "string", "description": "Gets or Sets SecondaryEmail", "nullable": true }, "facebookUrl": { "type": "string", "description": "Gets or Sets FacebookUrl", "nullable": true }, "twitterUrl": { "type": "string", "description": "Gets or Sets TwitterUrl", "nullable": true }, "agentVideo": { "type": "string", "description": "Gets or Sets AgentVideo", "nullable": true }, "profileText": { "type": "string", "description": "Gets or Sets ProfileText", "nullable": true }, "isHideSoldLeasedListings": { "type": "boolean", "description": "Gets or Sets IsHideSoldLeasedListings", "nullable": true }, "googlePlusUrl": { "type": "string", "description": "Gets or Sets GooglePlusUrl", "nullable": true }, "personalWebsiteUrl": { "type": "string", "description": "Gets or Sets PersonalWebsiteUrl", "nullable": true }, "linkedInUrl": { "type": "string", "description": "Gets or Sets LinkedInUrl", "nullable": true }, "fax": { "type": "string", "description": "Gets or Sets Fax", "nullable": true }, "mugShotNew": { "type": "string", "description": "Gets or Sets MugShotNew", "nullable": true }, "contactTypeCode": { "type": "integer", "description": "Gets or Sets ContactTypeCode", "format": "int32", "nullable": true }, "receivesRequests": { "type": "boolean", "description": "Gets or Sets ReceivesRequests", "nullable": true }, "creAgentVideoURL": { "type": "string", "description": "Gets or Sets CreAgentVideoURL", "nullable": true }, "receiveScheduledReportEmail": { "type": "boolean", "description": "Gets or Sets ReceiveScheduledReportEmail", "nullable": true } }, "additionalProperties": false, "description": "ContactInAgencyList", "x-data-access-level-info": { "Basic": [ "AgencyId", "Id", "ContactTypeCode", "FacebookUrl", "FirstName", "LastName", "GooglePlusUrl", "MugShotNew", "Phone", "Photo", "ProfileText", "TwitterUrl" ], "Detailed": [ "AgencyId", "Id", "ContactTypeCode", "FacebookUrl", "FirstName", "LastName", "GooglePlusUrl", "MugShotNew", "Phone", "Photo", "ProfileText", "TwitterUrl", "AgentVideo", "CreAgentVideoURL", "Email", "LinkedInUrl", "Mobile", "PersonalWebsiteUrl", "SecondaryEmail" ], "Full": [ "AgencyId", "Id", "ContactTypeCode", "FacebookUrl", "FirstName", "LastName", "GooglePlusUrl", "MugShotNew", "Phone", "Photo", "ProfileText", "TwitterUrl", "AgentVideo", "CreAgentVideoURL", "Email", "LinkedInUrl", "Mobile", "PersonalWebsiteUrl", "SecondaryEmail", "Fax", "IsActiveProfilePage", "IsHideSoldLeasedListings", "ReceiveScheduledReportEmail", "ReceivesRequests", "RentalActive", "SaleActive" ] } }, "Agencies.V2.EmailPhone": { "type": "object", "properties": { "email": { "maxLength": 100, "minLength": 0, "type": "string", "description": "Gets or Sets Email", "nullable": true }, "phone": { "maxLength": 50, "minLength": 0, "type": "string", "description": "Gets or Sets Phone", "nullable": true } }, "additionalProperties": false, "description": "EmailPhone", "x-data-access-level-info": { "Basic": [ "*" ], "Detailed": [ "*" ], "Full": [ "*" ] } }, "Agencies.V2.EmailDomain": { "type": "object", "properties": { "domain": { "maxLength": 50, "minLength": 0, "type": "string", "description": "Gets or Sets Domain", "nullable": true } }, "additionalProperties": false, "description": "EmailDomain", "x-data-access-level-info": { "Basic": [ "*" ], "Detailed": [ "*" ], "Full": [ "*" ] } }, "Agencies.V2.GeneralAgencyContactDetails": { "type": "object", "properties": { "email": { "maxLength": 100, "minLength": 0, "type": "string", "description": "Gets or Sets Email", "nullable": true }, "fax": { "maxLength": 50, "minLength": 0, "type": "string", "description": "Gets or Sets Fax", "nullable": true }, "phone": { "maxLength": 50, "minLength": 0, "type": "string", "description": "Gets or Sets Phone", "nullable": true }, "mobile": { "maxLength": 20, "minLength": 0, "type": "string", "description": "Gets or Sets Mobile", "nullable": true } }, "additionalProperties": false, "description": "GeneralAgencyContactDetails", "x-data-access-level-info": { "Basic": [ "*" ], "Detailed": [ "*" ], "Full": [ "*" ] } }, "Agencies.V2.AgencyContactDetails": { "type": "object", "properties": { "businessSale": { "$ref": "#/components/schemas/Agencies.V2.EmailPhone" }, "businessRent": { "$ref": "#/components/schemas/Agencies.V2.EmailPhone" }, "commercialLease": { "$ref": "#/components/schemas/Agencies.V2.EmailPhone" }, "commercialSale": { "$ref": "#/components/schemas/Agencies.V2.EmailPhone" }, "emailDomains": { "type": "array", "items": { "$ref": "#/components/schemas/Agencies.V2.EmailDomain" }, "description": "Gets or Sets EmailDomains", "nullable": true }, "general": { "$ref": "#/components/schemas/Agencies.V2.GeneralAgencyContactDetails" }, "residentialRent": { "$ref": "#/components/schemas/Agencies.V2.EmailPhone" }, "residentialSale": { "$ref": "#/components/schemas/Agencies.V2.EmailPhone" } }, "additionalProperties": false, "description": "AgencyContactDetails", "x-data-access-level-info": { "Basic": [ "*" ], "Detailed": [ "*" ], "Full": [ "*" ] } }, "Agencies.V2.AgencyOptions": { "required": [ "agentDirectoryListing", "leaseListingsGstOption", "receiveLookForPropertyRequests", "receivePropertyValuationRequests", "receiveSellPropertyRequests", "saleListingsGstOption" ], "type": "object", "properties": { "saleListingsGstOption": { "type": "integer", "description": "Gets or Sets SaleListingsGstOption", "format": "int32" }, "leaseListingsGstOption": { "type": "integer", "description": "Gets or Sets LeaseListingsGstOption", "format": "int32" }, "receiveLookForPropertyRequests": { "type": "boolean", "description": "Gets or Sets ReceiveLookForPropertyRequests" }, "receiveSellPropertyRequests": { "type": "boolean", "description": "Gets or Sets ReceiveSellPropertyRequests" }, "receivePropertyValuationRequests": { "type": "boolean", "description": "Gets or Sets ReceivePropertyValuationRequests" }, "agentDirectoryListing": { "type": "boolean", "description": "Gets or Sets AgentDirectoryListing" } }, "additionalProperties": false, "description": "AgencyOptions", "x-data-access-level-info": { "Basic": [ "*" ], "Detailed": [ "*" ], "Full": [ "*" ] } }, "Agencies.V2.Agency": { "type": "object", "properties": { "accountType": { "enum": [ "none", "residential", "commercialLight", "commercialFull", "developer", "holiday", "business" ], "type": "string", "description": "Gets or Sets AccountType", "nullable": true }, "profile": { "$ref": "#/components/schemas/Agencies.V2.AgencyProfile" }, "dateUpdated": { "type": "string", "description": "Gets or Sets DateUpdated", "format": "date-time", "nullable": true }, "name": { "type": "string", "description": "Gets or Sets Name", "nullable": true }, "details": { "$ref": "#/components/schemas/Agencies.V2.AgencyDetails" }, "id": { "maximum": 2147483647, "minimum": -2147483648, "type": "integer", "description": "Gets or Sets Id", "format": "int32", "nullable": true }, "creId": { "type": "integer", "description": "Gets or Sets CreId", "format": "int32", "nullable": true }, "agents": { "type": "array", "items": { "$ref": "#/components/schemas/Agencies.V2.ContactInAgencyList" }, "description": "Gets or Sets Agents", "nullable": true }, "contactDetails": { "$ref": "#/components/schemas/Agencies.V2.AgencyContactDetails" }, "homepassEnabled": { "type": "boolean", "description": "Gets or Sets HomepassEnabled", "nullable": true }, "suburbsServed": { "type": "string", "description": "Gets or Sets SuburbsServed", "nullable": true }, "subscribedToAgencyPerformanceReport": { "type": "boolean", "description": "Gets or Sets SubscribedToAgencyPerformanceReport", "nullable": true }, "agencyOptions": { "$ref": "#/components/schemas/Agencies.V2.AgencyOptions" }, "welcomeMessage": { "type": "string", "description": "Gets or Sets WelcomeMessage", "nullable": true }, "adFormat": { "type": "string", "description": "Gets or Sets AdFormat", "nullable": true }, "providerAgencyId": { "type": "string", "description": "Gets or Sets ProviderAgencyId", "nullable": true } }, "additionalProperties": false, "description": "Agency", "x-data-access-level-info": { "Basic": [ "AccountType", "Agents", "ContactDetails", "CreId", "Details", "Id", "Name", "Profile", "SuburbsServed" ], "Detailed": [ "AccountType", "Agents", "ContactDetails", "CreId", "Details", "Id", "Name", "Profile", "SuburbsServed", "DateUpdated" ], "Full": [ "AccountType", "Agents", "ContactDetails", "CreId", "Details", "Id", "Name", "Profile", "SuburbsServed", "DateUpdated", "AdFormat", "AgencyOptions", "HomepassEnabled", "ProviderAgencyId", "SubscribedToAgencyPerformanceReport", "WelcomeMessage" ] } }, "Listings.V1.AddressParts": { "type": "object", "properties": { "stateAbbreviation": { "enum": [ "nsw", "vic", "sa", "nt", "tas", "act", "qld", "wa" ], "type": "string", "description": "Gets or Sets StateAbbreviation", "nullable": true }, "displayType": { "enum": [ "fullAddress", "streetAndSuburb", "suburbOnly", "regionOnly", "areaOnly", "stateOnly" ], "type": "string", "description": "Gets or Sets DisplayType", "nullable": true }, "streetNumber": { "type": "string", "description": "Street number", "nullable": true }, "unitNumber": { "type": "string", "description": "Unit number.", "nullable": true }, "street": { "type": "string", "description": "Street address", "nullable": true }, "suburb": { "type": "string", "description": "Suburb of the address", "nullable": true }, "suburbId": { "type": "integer", "description": "Domain suburb identifier for address lookup via the domain location api", "format": "int32", "nullable": true }, "postcode": { "type": "string", "description": "Postcode of the address", "nullable": true }, "displayAddress": { "type": "string", "description": "Advertiser's preference in displaying their listing's address", "nullable": true } }, "additionalProperties": false, "description": "Encapsulates the parts that make up an Address", "x-data-access-level-info": { "Basic": [ "DisplayAddress", "DisplayType", "StateAbbreviation", "Postcode", "Suburb", "SuburbId", "UnitNumber", "StreetNumber", "Street" ], "Detailed": [ "DisplayAddress", "DisplayType", "StateAbbreviation", "Postcode", "Suburb", "SuburbId", "UnitNumber", "StreetNumber", "Street" ], "Full": [ "DisplayAddress", "DisplayType", "StateAbbreviation", "Postcode", "Suburb", "SuburbId", "UnitNumber", "StreetNumber", "Street" ] } }, "Listings.v1.AdvertiserIdentifiers": { "type": "object", "properties": { "advertiserType": { "enum": [ "agency", "private" ], "type": "string", "description": "Gets or Sets AdvertiserType", "nullable": true }, "advertiserId": { "type": "integer", "description": "Advertiser's identifier", "format": "int32", "nullable": true }, "contactIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Identifier of each contact the advertiser has associated with the listing", "nullable": true }, "agentIds": { "type": "array", "items": { "type": "string" }, "description": "Identifier of each agent the advertiser has associated with the listing", "nullable": true }, "conjunctionContactIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Identifier of each conjunctional contact associated with the listing", "nullable": true }, "conjunctionAgentIds": { "type": "array", "items": { "type": "string" }, "description": "Identifier of each conjunctional agent associated with the listing", "nullable": true } }, "additionalProperties": false, "description": "Encapsulates the listing's advertiser identifiers", "x-data-access-level-info": { "Basic": [ "*" ], "Detailed": [ "*" ], "Full": [ "*" ] } }, "Listings.V1.AustralianPropertyMonitorsIdentifiers": { "type": "object", "properties": { "addressId": { "type": "integer", "description": "APM address identifier", "format": "int32", "nullable": true }, "streetId": { "type": "integer", "description": "APM street identifier", "format": "int32", "nullable": true }, "suburbId": { "type": "integer", "description": "APM suburb identifier", "format": "int32", "nullable": true }, "cadastreId": { "type": "integer", "description": "APM cadastre identifier", "format": "int64", "nullable": true }, "postcodeId": { "type": "integer", "description": "APM postcode identifier", "format": "int32", "nullable": true }, "stateId": { "type": "integer", "description": "State identifier", "format": "int32", "nullable": true }, "state": { "type": "string", "description": "APM State", "nullable": true }, "propertyTypeId": { "type": "integer", "description": "APM property type identifier", "format": "int32", "nullable": true }, "propertyTypeCategoryId": { "type": "integer", "description": "APM property category type identifier", "format": "int32", "nullable": true }, "streetNumber": { "type": "string", "description": "APM washed and standardized address component for the street number, (including any prefixes, suffixed and composite numbers e.g. \\\"2-4a\\\")", "nullable": true } }, "additionalProperties": false, "description": "APM Identifiers", "x-data-access-level-info": { "Basic": [], "Detailed": [ "SuburbId" ], "Full": [ "SuburbId", "AddressId", "CadastreId", "PostcodeId", "PropertyTypeCategoryId", "PropertyTypeId", "State", "StateId", "StreetId", "StreetNumber" ] } }, "Listings.v1.GeoLocation": { "type": "object", "properties": { "latitude": { "type": "number", "description": "Latitude of the property", "format": "double", "nullable": true }, "longitude": { "type": "number", "description": "Longitude of the property", "format": "double", "nullable": true } }, "additionalProperties": false, "description": "Encapsulates the details of a geo location, long/lat", "x-data-access-level-info": { "Basic": [ "*" ], "Detailed": [ "*" ], "Full": [ "*" ] } }, "Listings.v1.Inspection": { "type": "object", "properties": { "recurrence": { "enum": [ "none", "weekly" ], "type": "string", "description": "Gets or Sets Recurrence", "nullable": true }, "openingDateTime": { "type": "string", "description": "Opening date and time of the inspection. e.g. 2015-01-01T12:00:00. Not provided by bulk uploaded listings, in these cases refer to the inspection description field. DateTime is in a local timezone.", "format": "date-time", "nullable": true }, "closingDateTime": { "type": "string", "description": "Closing date and time of the inspection. e.g. 2015-01-01T12:00:00 Not provided by bulk uploaded listings, in these cases refer to the inspection description field. DateTime is in a local timezone.", "format": "date-time", "nullable": true }, "description": { "type": "string", "description": "Description of the inspection provided by the Advertiser. When listings are bulk uploaded, inspection times are provided as a string. Other inspection details will not be provided", "nullable": true } }, "additionalProperties": false, "description": "Encapsulates the details of a Listing's Inspection", "x-data-access-level-info": { "Basic": [ "*" ], "Detailed": [ "*" ], "Full": [ "*" ] } }, "Listings.v1.PropertyInspections": { "type": "object", "properties": { "inspections": { "type": "array", "items": { "$ref": "#/components/schemas/Listings.v1.Inspection" }, "description": "Inspection details for the property. e.g. opening and closing times", "nullable": true }, "pastInspections": { "type": "array", "items": { "$ref": "#/components/schemas/Listings.v1.Inspection" }, "description": "Inspection details for the property. e.g. opening and closing times", "nullable": true }, "isByAppointmentOnly": { "type": "boolean", "description": "True or False indicating whether the inspection is by appointment only", "nullable": true } }, "additionalProperties": false, "description": "Property Inspection(s) details", "x-data-access-level-info": { "Basic": [ "*" ], "Detailed": [ "*" ], "Full": [ "*" ] } }, "Listings.v1.ListingMedia": { "required": [ "url" ], "type": "object", "properties": { "category": { "enum": [ "image", "video", "others" ], "type": "string", "description": "Gets or Sets Category", "nullable": true }, "type": { "enum": [ "photo", "mp4", "youtube", "floorplan", "vimeo", "notSpecified" ], "type": "string", "description": "Gets or Sets Type", "nullable": true }, "url": { "minLength": 1, "type": "string", "description": "The URL to the property media" } }, "additionalProperties": false, "description": "Encapsulates media associated with a Listing", "x-data-access-level-info": { "Basic": [ "*" ], "Detailed": [ "*" ], "Full": [ "*" ] } }, "Listings.V1.PriceDetails": { "type": "object", "properties": { "gstOption": { "enum": [ "na", "inc", "ex" ], "type": "string", "description": "Gets or Sets GstOption", "nullable": true }, "priceType": { "enum": [ "gross", "net" ], "type": "string", "description": "Gets or Sets PriceType", "nullable": true }, "priceUnit": { "enum": [ "totalAmount", "perSqm" ], "type": "string", "description": "Gets or Sets PriceUnit", "nullable": true }, "price": { "type": "number", "description": "Price of the property", "format": "double", "nullable": true }, "priceFrom": { "type": "integer", "description": "Price starting range of the property", "format": "int32", "nullable": true }, "priceTo": { "type": "integer", "description": "Upper price range of the property", "format": "int32", "nullable": true }, "pricePrefix": { "type": "string", "description": "Display price for the advertisement", "nullable": true }, "canDisplayPrice": { "type": "boolean", "description": "Flag indicating whether the advertiser has chosen to display the property price", "nullable": true }, "hiddenReasons": { "type": "array", "items": { "enum": [ "byAgency", "qldRestriction" ], "type": "string", "description": "Reason for price hidden * `ByAgency` - Agency doesn't want to show prcie * `QLDRestriction` - Price can not be shown due to QLD restrictions" }, "description": "Reasons when price need to be hidden", "nullable": true }, "displayPrice": { "type": "string", "description": "A string provided by the Advertiser representing the ByIdListingPriceQueryResult of the Listing e.g. Over $1,000,000 This should be the default price field for client to use", "nullable": true }, "bond": { "type": "number", "description": "Rental bond", "format": "double", "nullable": true }, "priceReduction": { "type": "boolean", "description": "Indicates if this property is under price reduction", "nullable": true } }, "additionalProperties": false, "description": "Encapsulates a listing's price information", "x-data-access-level-info": { "Basic": [ "DisplayPrice", "Bond", "CanDisplayPrice", "Price", "PriceFrom", "PriceTo", "PricePrefix" ], "Detailed": [ "DisplayPrice", "Bond", "CanDisplayPrice", "Price", "PriceFrom", "PriceTo", "PricePrefix" ], "Full": [ "DisplayPrice", "Bond", "CanDisplayPrice", "Price", "PriceFrom", "PriceTo", "PricePrefix", "HiddenReasons", "GstOption", "PriceUnit", "PriceType", "PriceReduction" ] } }, "Listings.v1.ProviderDetails": { "type": "object", "properties": { "providerSystem": { "type": "string", "description": "Feed provider ID", "nullable": true }, "providerAdID": { "type": "string", "description": "Unique ID within provider system", "nullable": true } }, "additionalProperties": false, "description": "Information for the listing provider. e.g. bulkuploader information", "x-data-access-level-info": { "Basic": [ "*" ], "Detailed": [ "*" ], "Full": [ "*" ] } }, "Listings.V1.RentalDetails": { "type": "object", "properties": { "rentalMethod": { "enum": [ "notStated", "rent", "share", "holiday", "lease" ], "type": "string", "description": "Gets or Sets RentalMethod", "nullable": true }, "source": { "enum": [ "internal", "external" ], "type": "string", "description": "Gets or Sets Source", "nullable": true }, "leasedDate": { "type": "string", "description": "The Date the listing was leased. DateTime is in a local timezone.", "format": "date-time", "nullable": true }, "leasedPrice": { "type": "integer", "description": "The last leased price entered by the Advertiser This price will only be visible if allowed by the Advertiser and the listing as been leased", "format": "int32", "nullable": true }, "canDisplayPrice": { "type": "boolean", "description": "Indicates whether this instance can display price", "nullable": true }, "leasedMonths": { "type": "integer", "description": "The number of months the property was last leased for This will only be visible if the property has been leased", "format": "int32", "nullable": true }, "termOfLeaseFrom": { "type": "integer", "description": "Lease term range from", "format": "int32", "nullable": true }, "termOfLeaseTo": { "type": "integer", "description": "Lease term range to", "format": "int32", "nullable": true }, "leaseOutgoings": { "type": "integer", "description": "Outgoing cost of current lease", "format": "int32", "nullable": true } }, "additionalProperties": false, "description": "The rental detail's of the listing in case of it being for rent or leased", "x-data-access-level-info": { "Basic": [ "*" ], "Detailed": [ "*" ], "Full": [ "*" ] } }, "Listings.V1.SoldDetails": { "type": "object", "properties": { "soldAction": { "enum": [ "notStated", "auction", "privateTreaty", "withdrawn", "soldPriorToAuction" ], "type": "string", "description": "Gets or Sets SoldAction", "nullable": true }, "source": { "enum": [ "internal", "external" ], "type": "string", "description": "Gets or Sets Source", "nullable": true }, "soldPrice": { "type": "integer", "description": "The last sold price entered by the Advertiser. This price will only be visible if allowed by the Advertiser and the listing as been sold", "format": "int32", "nullable": true }, "governmentRecordedSoldPrice": { "type": "integer", "description": "The government recorded sold price sourced from APM", "format": "int32", "nullable": true }, "soldDate": { "type": "string", "description": "The Date the listing was sold. DateTime is in a local timezone.", "format": "date-time", "nullable": true }, "canDisplayPrice": { "type": "boolean", "description": "Indicates whether this instance can display price", "nullable": true } }, "additionalProperties": false, "description": "Sold details in the case of the listing being sold.", "x-data-access-level-info": { "Basic": [ "CanDisplayPrice", "SoldAction", "SoldDate", "SoldPrice", "Source" ], "Detailed": [ "CanDisplayPrice", "SoldAction", "SoldDate", "SoldPrice", "Source" ], "Full": [ "CanDisplayPrice", "SoldAction", "SoldDate", "SoldPrice", "Source", "GovernmentRecordedSoldPrice" ] } }, "Listings.v1.AuctionSchedule": { "type": "object", "properties": { "locationDescription": { "type": "string", "description": "Description and location of the auction provided by advertiser", "nullable": true }, "openingDateTime": { "type": "string", "description": "Opening date and time of the auction. e.g. 2015-01-01T12:00:00 DateTime is in a local timezone.", "format": "date-time", "nullable": true }, "terms": { "type": "string", "description": "Terms of the auction", "nullable": true }, "url": { "maxLength": 255, "type": "string", "description": "On-line URL of the auction", "nullable": true } }, "additionalProperties": false, "description": "Encapsulates the details of a Property being Auctioned.", "x-data-access-level-info": { "Basic": [ "*" ], "Detailed": [ "*" ], "Full": [ "*" ] } }, "Listings.v1.AuctionDetails": { "type": "object", "properties": { "auctionSchedule": { "$ref": "#/components/schemas/Listings.v1.AuctionSchedule" }, "auctionedPrice": { "type": "integer", "description": "The auctioned price entered by the Advertiser. This price will only be visible if allowed by the Advertiser and the listing as been auctioned", "format": "int32", "nullable": true }, "auctionedDate": { "type": "string", "description": "The listing's last auctioned date and time specified by the Advertiser. This will only be visible if the listing has been auctioned. DateTime is in a local timezone.", "format": "date-time", "nullable": true } }, "additionalProperties": false, "description": "The detail's of the auction in case of a listing for sale being auctioned or sold by auction", "x-data-access-level-info": { "Basic": [ "*" ], "Detailed": [ "*" ], "Full": [ "*" ] } }, "Listings.v1.TenderDetails": { "type": "object", "properties": { "tenderRecipientName": { "type": "string", "description": "Tender recipient name", "nullable": true }, "tenderAddress": { "type": "string", "description": "Tender address", "nullable": true }, "tenderEndDate": { "type": "string", "description": "Tender closing date. DateTime is in a local timezone.", "format": "date-time", "nullable": true } }, "additionalProperties": false, "description": "Tender details", "x-data-access-level-info": { "Basic": [ "*" ], "Detailed": [ "*" ], "Full": [ "*" ] } }, "Listings.v1.TenantDetails": { "type": "object", "properties": { "leaseDateVariable": { "type": "boolean", "description": "Is tenant lease date variable", "nullable": true }, "leaseOptions": { "type": "string", "description": "Leasing options available to a prospective tenant", "nullable": true }, "tenantInfoTermOfLeaseFrom": { "type": "integer", "description": "The from range of the tenant's current lease", "format": "int32", "nullable": true }, "tenantInfoTermOfLeaseTo": { "type": "integer", "description": "The to range of the tenant's current lease", "format": "int32", "nullable": true }, "tenantName": { "type": "string", "description": "Name of the current tenant of the property", "nullable": true }, "tenantRentDetails": { "type": "string", "description": "Information regarding current rental", "nullable": true }, "leaseStartDate": { "type": "string", "description": "The date on which the tenants lease began, or is due to begin. DateTime is in a local timezone.", "format": "date-time", "nullable": true }, "leaseEndDate": { "type": "string", "description": "The date on which the tenants lease is due to end. DateTime is in a local timezone.", "format": "date-time", "nullable": true } }, "additionalProperties": false, "description": "Tenant Details", "x-data-access-level-info": { "Basic": [ "*" ], "Detailed": [ "*" ], "Full": [ "*" ] } }, "Listings.V1.SaleDetails": { "type": "object", "properties": { "saleMethod": { "enum": [ "notStated", "auction", "privateTreaty", "tender", "expressionOfInterest" ], "type": "string", "description": "Gets or Sets SaleMethod", "nullable": true }, "soldDetails": { "$ref": "#/components/schemas/Listings.V1.SoldDetails" }, "auctionDetails": { "$ref": "#/components/schemas/Listings.v1.AuctionDetails" }, "tenderDetails": { "$ref": "#/components/schemas/Listings.v1.TenderDetails" }, "tenantDetails": { "$ref": "#/components/schemas/Listings.v1.TenantDetails" }, "annualReturn": { "type": "integer", "description": "Integer value of percentage return on this property or business", "format": "int32", "nullable": true }, "saleTerms": { "type": "string", "description": "Information relating to aspects of the sale, such as required deposit, settlement time", "nullable": true } }, "additionalProperties": false, "description": "The sale detail's of the listing in case of it being for sale or sold", "x-data-access-level-info": { "Basic": [ "*" ], "Detailed": [ "*" ], "Full": [ "*" ] } }, "Listings.v1.BasicPrice": { "type": "object", "properties": { "from": { "type": "integer", "description": "Lowest price the property is expected to sell/rent for to set search price.", "format": "int32", "nullable": true }, "to": { "type": "integer", "description": "Highest price the property is expected to sell/rent for to set search price.", "format": "int32", "nullable": true } }, "additionalProperties": false, "description": "Basic price information", "x-data-access-level-info": { "Basic": [ "*" ], "Detailed": [ "*" ], "Full": [ "*" ] } }, "Listings.v1.PastSaleData": { "type": "object", "properties": { "unitNumber": { "type": "string", "description": "Property unit number", "nullable": true }, "streetNumber": { "type": "string", "description": "Property street number", "nullable": true }, "street": { "type": "string", "description": "Property Street name", "nullable": true }, "suburb": { "type": "string", "description": "Property suburb name", "nullable": true }, "postcode": { "type": "string", "description": "Property postcode", "nullable": true }, "state": { "type": "string", "description": "Property state", "nullable": true }, "displayAddress": { "type": "string", "description": "display formatted address", "nullable": true, "readOnly": true }, "dateOfSale": { "type": "string", "description": "Registered date of the sale", "nullable": true }, "soldPrice": { "type": "integer", "description": "Property sold price", "format": "int64", "nullable": true } }, "additionalProperties": false, "description": "Information for past property sales", "x-data-access-level-info": { "Basic": [ "*" ], "Detailed": [ "*" ], "Full": [ "*" ] } }, "Listings.v1.ComparableData": { "type": "object", "properties": { "comparableProperty": { "type": "array", "items": { "$ref": "#/components/schemas/Listings.v1.PastSaleData" }, "description": "Comparable properties that are of a similar standard or condition to the property for sale", "nullable": true }, "declarationText": { "type": "string", "description": "Text description if there are less than three comparable sales available", "nullable": true } }, "additionalProperties": false, "description": "Information regarding the past comparable property sales that influenced the setting of the estimation price", "x-data-access-level-info": { "Basic": [ "*" ], "Detailed": [ "*" ], "Full": [ "*" ] } }, "Listings.v1.MedianPriceData": { "type": "object", "properties": { "priceType": { "enum": [ "house", "apartmentUnitFlat", "vacantLand" ], "type": "string", "description": "Gets or Sets PriceType", "nullable": true }, "suburb": { "type": "string", "description": "Name of the suburb median price is based on.", "nullable": true }, "postcode": { "type": "string", "description": "Postcode of the suburb", "nullable": true }, "medianPrice": { "type": "integer", "description": "Median price for the suburb.", "format": "int32", "nullable": true }, "source": { "type": "string", "description": "Where median price data comes from", "nullable": true }, "sourceDateFrom": { "type": "string", "description": "Start date of the median price source time period", "nullable": true }, "sourceDateTo": { "type": "string", "description": "End date of the median price source time period", "nullable": true }, "sourceCollectionDate": { "type": "string", "description": "The collection date of the median price source", "nullable": true } }, "additionalProperties": false, "description": "Information regarding median house/unit price for the suburb", "x-data-access-level-info": { "Basic": [ "*" ], "Detailed": [ "*" ], "Full": [ "*" ] } }, "Listings.v1.StatementOfInformation": { "type": "object", "properties": { "estimatedPrice": { "$ref": "#/components/schemas/Listings.v1.BasicPrice" }, "comparableData": { "$ref": "#/components/schemas/Listings.v1.ComparableData" }, "suburbMedianPrice": { "$ref": "#/components/schemas/Listings.v1.MedianPriceData" }, "documentationUrl": { "type": "string", "description": "Link to the statement of information documentation file", "nullable": true } }, "additionalProperties": false, "description": "Statement of Information Regarding sale listing", "x-data-access-level-info": { "Basic": [ "*" ], "Detailed": [ "*" ], "Full": [ "*" ] } }, "Listings.V1.Listing": { "required": [ "advertiserIdentifiers", "id", "propertyTypes" ], "type": "object", "properties": { "objective": { "enum": [ "sale", "rent" ], "type": "string", "description": "Gets or Sets Objective", "nullable": true }, "status": { "enum": [ "unknown", "archived", "underOffer", "sold", "leased", "newDevelopment", "recentlyUpdated", "new", "live", "pending", "depositTaken" ], "type": "string", "description": "Gets or Sets Status", "nullable": true }, "saleMode": { "enum": [ "buy", "rent", "share", "sold", "leased", "archived" ], "type": "string", "description": "Gets or Sets SaleMode", "nullable": true }, "channel": { "enum": [ "residential", "commercial", "business" ], "type": "string", "description": "Gets or Sets Channel", "nullable": true }, "id": { "type": "integer", "description": "The identifier which uniquely identifies the listing.", "format": "int32" }, "addressParts": { "$ref": "#/components/schemas/Listings.V1.AddressParts" }, "advertiserIdentifiers": { "$ref": "#/components/schemas/Listings.v1.AdvertiserIdentifiers" }, "apmIdentifiers": { "$ref": "#/components/schemas/Listings.V1.AustralianPropertyMonitorsIdentifiers" }, "bathrooms": { "type": "number", "description": "Total number of bathrooms in the property", "format": "float", "nullable": true }, "bedrooms": { "type": "number", "description": "Total number of bedrooms in the property; Studio apartments have a value of \\\"0\\\"", "format": "float", "nullable": true }, "buildingArea": { "type": "string", "description": "The building area display value of the property e.g. 160 ha", "nullable": true }, "buildingAreaSqm": { "type": "number", "description": "The properties building area in square meters", "format": "double", "nullable": true }, "carspaces": { "type": "number", "description": "Total number of car spaces in the property.", "format": "float", "nullable": true }, "dateAvailable": { "type": "string", "description": "The date the property is available. DateTime is in a local timezone.", "format": "date-time", "nullable": true }, "dateCreated": { "type": "string", "description": "The date/time the listing was created. DateTime is in AEST (Australian Eastern Standard Time) or AEDT (Australian Eastern Daylight Time) timezone.", "format": "date-time", "nullable": true }, "dateUpdated": { "type": "string", "description": "The date/time the listing had major update. DateTime is in AEST (Australian Eastern Standard Time) or AEDT (Australian Eastern Daylight Time) timezone.", "format": "date-time", "nullable": true }, "dateMinorUpdated": { "type": "string", "description": "When minor update applied to the listing. DateTime is in AEST (Australian Eastern Standard Time) or AEDT (Australian Eastern Daylight Time) timezone.", "format": "date-time", "nullable": true }, "datePurged": { "type": "string", "description": "The date/time the listing was purged. It's only returned for archived listings. DateTime is in AEST (Australian Eastern Standard Time) or AEDT (Australian Eastern Daylight Time) timezone.", "format": "date-time", "nullable": true }, "dateListed": { "type": "string", "description": "The date/time last listed. DateTime is in AEST (Australian Eastern Standard Time) or AEDT (Australian Eastern Daylight Time) timezone.", "format": "date-time", "nullable": true }, "description": { "type": "string", "description": "The long description of the property provided by the advertiser.", "nullable": true }, "devProjectId": { "type": "integer", "description": "The ID of the development project - null if no associated project", "format": "int32", "nullable": true }, "energyEfficiencyRating": { "type": "integer", "description": "Energy Efficiency Rating value for ACT properties", "format": "int32", "nullable": true }, "features": { "type": "array", "items": { "type": "string" }, "description": "The property features specified by the advertiser", "nullable": true }, "geoLocation": { "$ref": "#/components/schemas/Listings.v1.GeoLocation" }, "headline": { "type": "string", "description": "The short description of the property provided by the advertiser.", "nullable": true }, "inspectionDetails": { "$ref": "#/components/schemas/Listings.v1.PropertyInspections" }, "isNewDevelopment": { "type": "boolean", "description": "Indicates whether the property is a new development", "nullable": true }, "landArea": { "type": "string", "description": "The land area display string for the property e.g. 160 sqm", "nullable": true }, "landAreaSqm": { "type": "number", "description": "The properties land area in square meters", "format": "double", "nullable": true }, "media": { "type": "array", "items": { "$ref": "#/components/schemas/Listings.v1.ListingMedia" }, "description": "The media associated with the property provided by the advertiser", "nullable": true }, "priceDetails": { "$ref": "#/components/schemas/Listings.V1.PriceDetails" }, "propertyId": { "type": "string", "description": "The identifier which uniquely identifies the property being advertised. This may be empty if the Address of property is poorly described", "nullable": true }, "propertyTypes": { "type": "array", "items": { "enum": [ "unknown", "accessoriesParts", "accommodationTourism", "accounting", "acreageSemiRural", "adult", "advertisingMarketing", "aerial", "aeronautical", "agedCare", "agricultural", "air", "aircraft", "alarms", "alcoholLiquor", "amusements", "animalRelated", "apartmentUnitFlat", "aquaculture", "aquaticMarineMarinaBerth", "artsCrafts", "autoElectrical", "automotive", "backpackerHostel", "bakery", "barsNightclubs", "beautyHealth", "beautyProducts", "beautySalon", "bikeAndMotorcycle", "blockOfUnits", "boardingKennels", "boatsMarineMarinaBerth", "bookkeeping", "brokerage", "builder", "buildingAndConstruction", "bus", "butcher", "cafeCoffeeShop", "car", "carBusTruck", "carDealership", "carRental", "carSpace", "carWash", "caravanPark", "carpenter", "catering", "childCare", "civil", "cleaning", "cleaningAndMaintenance", "clinicalPractice", "clothingAccessories", "clothingFootwear", "communication", "communications", "computerIT", "computerAndInternet", "construction", "convenienceStore", "copyLaminate", "courier", "cropHarvesting", "customs", "dairyFarming", "deli", "dental", "detailing", "developmentLand", "developmentSite", "distributors", "drivingSchools", "duplex", "educationTraining", "educational", "electrical", "employmentRecruitment", "entertainment", "entertainmentTechnology", "export", "farm", "farming", "fertiliser", "finance", "financialServices", "fishingForestry", "floristNursery", "foodBeverage", "foodBeverageHospitality", "franchiseBusinessOpportunities", "freight", "fruitVegFreshProduce", "fruitPicking", "functionCentre", "furnitureTimber", "gambling", "gardenHousehold", "gardenNurseries", "gardening", "glassCeramic", "guestHouseBB", "hairdresser", "healthBeauty", "healthSpa", "hire", "homeGarden", "homeBased", "newHomeDesigns", "homewareHardware", "hospital", "hotel", "hotelLeisure", "house", "newHouseLand", "huntingTrap", "import", "importExportWholesale", "industrialManufacturing", "industrialWarehouse", "insemination", "insurance", "internet", "irrigationServices", "juiceBar", "landClearing", "newLand", "landscaping", "laundryDryCleaning", "legal", "leisureEntertainment", "limousineTaxi", "livestock", "internationalCommercial", "machinery", "machineryMetal", "managementRights", "manufacturers", "manufacturingEngineering", "marine", "massage", "mechanicalRepair", "media", "medical", "medicalConsulting", "medicalPractice", "miningEarthMoving", "mobileServices", "motel", "motorcycle", "musicRelated", "mustering", "nails", "naturalTherapies", "newApartments", "newsagency", "nursery", "nursingHome", "offices", "officeSupplies", "oilGas", "panelBeating", "paperPrinting", "parkingCarSpace", "penthouse", "pestRelated", "pharmacies", "plastic", "plumbing", "poolWater", "postOffices", "printPhoto", "professional", "propertyRealEstate", "rail", "recreationSport", "recruitment", "repair", "resort", "restaurant", "retail", "retailer", "retirement", "retirementVillage", "road", "rural", "ruralCommercialFarming", "scientific", "sea", "security", "semiDetached", "serviceStation", "services", "shearing", "showroomsBulkyGoods", "specialistFarm", "sportsComplexGym", "studio", "supermarket", "takeawayFood", "taxi", "terrace", "themePark", "tours", "townhouse", "training", "transportDistribution", "travel", "truck", "vacantLand", "vending", "villa", "water", "welding", "wholesale", "wholesalers", "woolClassing", "wreckers", "servicedOffices", "other", "alcoholGrocery", "cafeRestaurants", "discountStore", "ecoFriendly", "green", "grocery", "specialityRetail", "storage", "travelAgency", "varietyStore", "chickenShop", "seafoodShop", "deliCafe", "cropping", "viticulture", "mixedFarming", "grazing", "horticulture", "equine", "farmlet", "orchard", "ruralLifestyle", "onlineBusiness" ], "type": "string", "description": "Available types of Properties * `Unknown` - Unknown * `AccessoriesParts` - Accessories & Parts * `AccommodationTourism` - Accommodation & Tourism * `Accounting` - Accounting * `AcreageSemiRural` - Acreage/Semi-Rural * `Adult` - Adult * `AdvertisingMarketing` - Advertising / Marketing * `Aerial` - Aerial * `Aeronautical` - Aeronautical * `AgedCare` - Aged Care * `Agricultural` - Agricultural * `Air` - Air * `Aircraft` - Aircraft * `Alarms` - Alarms * `AlcoholLiquor` - Alcohol / Liquor * `Amusements` - Amusements * `AnimalRelated` - Animal Related * `ApartmentUnitFlat` - Apartment/Unit/Flat * `Aquaculture` - Aquaculture commercial/rural type * `AquaticMarineMarinaBerth` - Aquatic / Marine / Marina Berth * `ArtsCrafts` - Arts / Crafts * `AutoElectrical` - Auto Electrical * `Automotive` - Automotive & Marine * `BackpackerHostel` - Backpacker / Hostel * `Bakery` - Bakery * `BarsNightclubs` - Bars / Nightclubs * `BeautyHealth` - Beauty & Health * `BeautyProducts` - Beauty Products * `BeautySalon` - Beauty Salon * `BikeAndMotorcycle` - Bike & Motorcycle * `BlockOfUnits` - Block of Units * `BoardingKennels` - Boarding Kennels * `BoatsMarineMarinaBerth` - Boats / Marine / Marina Berth * `Bookkeeping` - Bookkeeping * `Brokerage` - Brokerage * `Builder` - Builder * `BuildingAndConstruction` - Building & Construction * `Bus` - Bus * `Butcher` - Butcher * `CafeCoffeeShop` - Caf� * `Car` - Car * `CarBusTruck` - Car / Bus / Truck * `CarDealership` - Car Dealership * `CarRental` - Car Rental * `CarSpace` - Car Space * `CarWash` - Car Wash * `CaravanPark` - Caravan Park * `Carpenter` - Carpenter * `Catering` - Catering * `ChildCare` - Child Care * `Civil` - Civil * `Cleaning` - Cleaning Services * `CleaningAndMaintenance` - Cleaning & Maintenance * `ClinicalPractice` - Clinical Practice * `ClothingAccessories` - Clothing & Accessories * `ClothingFootwear` - Clothing / Footwear * `Communication` - Communication * `Communications` - Communications * `ComputerIT` - Computer & IT * `ComputerAndInternet` - Computer & Internet * `Construction` - Construction * `ConvenienceStore` - Convenience Store * `CopyLaminate` - Copy / Laminate * `Courier` - Courier * `CropHarvesting` - Crop Harvesting * `Customs` - Customs * `DairyFarming` - Dairy Farming commercial/rural type * `Deli` - Deli * `Dental` - Dental * `Detailing` - Detailing * `DevelopmentLand` - Development Land * `DevelopmentSite` - Development Site * `Distributors` - Distributors * `DrivingSchools` - Driving Schools * `Duplex` - Duplex * `EducationTraining` - Education & Training * `Educational` - Educational * `Electrical` - Electrical * `EmploymentRecruitment` - Employment / Recruitment * `Entertainment` - Entertainment * `EntertainmentTechnology` - Entertainment / Technology * `Export` - Export * `Farm` - Farm * `Farming` - Farming * `Fertiliser` - Fertiliser * `Finance` - Finance * `FinancialServices` - Financial Services * `FishingForestry` - Fishing / Forestry commercial/rural type * `FloristNursery` - Florist / Nursery * `FoodBeverage` - Food / Beverage * `FoodBeverageHospitality` - Food / Beverage / Hospitality * `FranchiseBusinessOpportunities` - Franchise & Business * `Freight` - Freight * `FruitVegFreshProduce` - Fruit & Veg / Fresh Produce * `FruitPicking` - Fruit Picking * `FunctionCentre` - Function Centre * `FurnitureTimber` - Furniture / Timber * `Gambling` - Gambling * `GardenHousehold` - Garden / Household * `GardenNurseries` - Garden / Nurseries * `Gardening` - Gardening * `GlassCeramic` - Glass / Ceramic * `GuestHouseBB` - Guest House / B&B * `Hairdresser` - Hair Dresser * `HealthBeauty` - Health / Beauty * `HealthSpa` - Health Spa * `Hire` - Hire * `HomeGarden` - Home & Garden * `HomeBased` - Home Based * `NewHomeDesigns` - New Home Designs * `HomewareHardware` - Homeware / Hardware * `Hospital` - Hospital * `Hotel` - Hotel * `HotelLeisure` - Hotel / Leisure commercial type * `House` - House * `NewHouseLand` - New House Land * `HuntingTrap` - Hunting / Trap * `Import` - Import * `ImportExportWholesale` - Import / Export / Wholesale * `IndustrialManufacturing` - Industrial & Manufacturing * `IndustrialWarehouse` - Industrial Warehouse /// commercial type * `Insemination` - Insemination * `Insurance` - Insurance * `Internet` - Internet * `IrrigationServices` - Irrigation Services commercial/rural type * `JuiceBar` - Juice Bar * `LandClearing` - Land Clearing * `NewLand` - New Land * `Landscaping` - Landscaping * `LaundryDryCleaning` - Laundry / Dry Cleaning * `Legal` - Legal * `LeisureEntertainment` - Leisure & Entertainment * `LimousineTaxi` - Limousine / Taxi * `Livestock` - Livestock commercial/rural type * `InternationalCommercial` - International Commercial commercial type * `Machinery` - Machinery * `MachineryMetal` - Machinery & Metal * `ManagementRights` - Management Rights * `Manufacturers` - Manufacturers * `ManufacturingEngineering` - Manufacturing / Engineering * `Marine` - Marine * `Massage` - Massage * `MechanicalRepair` - Mechanical Repair * `Media` - Media * `Medical` - Medical / Hospital * `MedicalConsulting` - Medical Consulting commercial type * `MedicalPractice` - Medical Practice * `MiningEarthMoving` - Mining / Earth Moving * `MobileServices` - Mobile Services * `Motel` - Motel * `Motorcycle` - Motorcycle * `MusicRelated` - Music Related * `Mustering` - Mustering * `Nails` - Nails * `NaturalTherapies` - Natural Therapies * `NewApartments` - New Apartments * `Newsagency` - Newsagency * `Nursery` - Nursery * `NursingHome` - Nursing Home * `Offices` - Offices commercial type * `OfficeSupplies` - Office Supplies * `OilGas` - Oil / Gas * `PanelBeating` - Panel Beating * `PaperPrinting` - Paper / Printing * `ParkingCarSpace` - Parking / Car Space commercial type * `Penthouse` - Penthouse * `PestRelated` - Pest Related * `Pharmacies` - Pharmacies * `Plastic` - Plastic * `Plumbing` - Plumbing * `PoolWater` - Pool / Water * `PostOffices` - Post Office * `PrintPhoto` - Print Photo * `Professional` - Professional * `PropertyRealEstate` - Real Estate * `Rail` - Rail * `RecreationSport` - Recreation / Sport * `Recruitment` - Recruitment * `Repair` - Repair * `Resort` - Resort * `Restaurant` - Restaurant * `Retail` - Retail commercial type * `Retailer` - Retailer * `Retirement` - Retirement * `RetirementVillage` - Retirement Village * `Road` - Road * `Rural` - Rural & Farming * `RuralCommercialFarming` - Rural Commercial Farming * `Scientific` - Scientific * `Sea` - Sea * `Security` - Security * `SemiDetached` - Semi-Detached * `ServiceStation` - Service Station * `Services` - Services * `Shearing` - Shearing * `ShowroomsBulkyGoods` - Showrooms/Bulky Goods commercial type * `SpecialistFarm` - Specialist Farm * `SportsComplexGym` - Gym / Sports Complex * `Studio` - Studio * `Supermarket` - Supermarket * `TakeawayFood` - Takeaway Food * `Taxi` - Taxi * `Terrace` - Terrace * `ThemePark` - Theme Park * `Tours` - Tours * `Townhouse` - Townhouse * `Training` - Training * `TransportDistribution` - Transport & Distribution * `Travel` - Travel * `Truck` - Truck * `VacantLand` - Vacant Land * `Vending` - Vending * `Villa` - Villa * `Water` - Water * `Welding` - Welding * `Wholesale` - Wholesale * `Wholesalers` - Wholesalers * `WoolClassing` - Wool Classing * `Wreckers` - Wreckers * `ServicedOffices` - Serviced Offices commercial type * `Other` - Other commercial type * `AlcoholGrocery` - Grocery & Alcohol * `CafeRestaurants` - Cafe / Restaurants * `DiscountStore` - Discount Store * `EcoFriendly` - Eco Friendly * `Green` - Green * `Grocery` - Grocery * `SpecialityRetail` - Speciality / Retail * `Storage` - Storage * `TravelAgency` - Travel Agency * `VarietyStore` - Variety Store * `ChickenShop` - Chicken Shop commercial type * `SeafoodShop` - Seafood Shop commercial type * `DeliCafe` - Deli Cafe commercial type * `Cropping` - Cropping commercial/rural type * `Viticulture` - Viticulture commercial/rural type * `MixedFarming` - Mixed Farming commercial type * `Grazing` - Grazing commercial/rural type * `Horticulture` - Horticulture commercial/rural type * `Equine` - Equine commercial/rural type * `Farmlet` - Farmlet commercial/rural type * `Orchard` - Orchard commercial/rural type * `RuralLifestyle` - Rural Lifestyle commercial/rural type * `OnlineBusiness` - Online Business" }, "description": "Types of the property" }, "providerDetails": { "$ref": "#/components/schemas/Listings.v1.ProviderDetails" }, "rentalDetails": { "$ref": "#/components/schemas/Listings.V1.RentalDetails" }, "saleDetails": { "$ref": "#/components/schemas/Listings.V1.SaleDetails" }, "isWithdrawn": { "type": "boolean", "description": "Indicates if the property has been withdrawn from the market The value will be 'true' When a listing is taken off market without being sold or leased.", "nullable": true }, "seoUrl": { "type": "string", "description": "Listing SEO URL", "nullable": true }, "virtualTourUrl": { "type": "string", "description": "The Listing's Virtual Tour URL.", "nullable": true }, "homepassEnabled": { "type": "boolean", "description": "If Homepass is enabled for the listing (agency)", "nullable": true }, "statementOfInformation": { "$ref": "#/components/schemas/Listings.v1.StatementOfInformation" }, "numberOfDwellings": { "type": "integer", "description": "Number of dwellings for current listing", "format": "int32", "nullable": true }, "highlights": { "type": "array", "items": { "type": "string" }, "description": "Highlight items for the listing", "nullable": true } }, "additionalProperties": false, "description": "Listing", "x-data-access-level-info": { "Basic": [ "Id", "Status" ], "Detailed": [ "Id", "Status", "ApmIdentifiers", "NumberOfDwellings", "PropertyId", "RentalDetails", "AddressParts", "AdvertiserIdentifiers", "Bathrooms", "Bedrooms", "BuildingAreaSqm", "Carspaces", "Channel", "DateAvailable", "DateListed", "DateUpdated", "Description", "DevProjectId", "EnergyEfficiencyRating", "Features", "GeoLocation", "Headline", "Highlights", "InspectionDetails", "IsNewDevelopment", "LandAreaSqm", "Media", "Objective", "PriceDetails", "PropertyTypes", "SaleDetails", "SaleMode", "SeoUrl", "StatementOfInformation", "VirtualTourUrl" ], "Full": [ "Id", "Status", "ApmIdentifiers", "NumberOfDwellings", "PropertyId", "RentalDetails", "AddressParts", "AdvertiserIdentifiers", "Bathrooms", "Bedrooms", "BuildingAreaSqm", "Carspaces", "Channel", "DateAvailable", "DateListed", "DateUpdated", "Description", "DevProjectId", "EnergyEfficiencyRating", "Features", "GeoLocation", "Headline", "Highlights", "InspectionDetails", "IsNewDevelopment", "LandAreaSqm", "Media", "Objective", "PriceDetails", "PropertyTypes", "SaleDetails", "SaleMode", "SeoUrl", "StatementOfInformation", "VirtualTourUrl", "BuildingArea", "LandArea", "DateCreated", "DateMinorUpdated", "DatePurged", "ProviderDetails", "HomepassEnabled", "IsWithdrawn" ] } }, "ListingPerformance.v1.Statistics": { "type": "object", "properties": { "listingId": { "type": "integer", "description": "Domain Advertisement Id", "format": "int64", "nullable": true, "readOnly": true }, "totalListingViews": { "type": "integer", "description": "Total number of views for the listing details", "format": "int32", "nullable": true, "readOnly": true }, "totalPhotoViews": { "type": "integer", "description": "Total number of listing photo views", "format": "int32", "nullable": true, "readOnly": true }, "totalPhotoGalleryViews": { "type": "integer", "description": "Total number of listing photo gallery views", "format": "int32", "nullable": true, "readOnly": true }, "totalFloorplanViews": { "type": "integer", "description": "Total number of floorplan views", "format": "int32", "nullable": true, "readOnly": true }, "totalMapViews": { "type": "integer", "description": "Total number of address map views", "format": "int32", "nullable": true, "readOnly": true }, "totalVideoViews": { "type": "integer", "description": "Total number of vedio views", "format": "int32", "nullable": true, "readOnly": true }, "totalEbrochureViews": { "type": "integer", "description": "Total number of Ebrochure views", "format": "int32", "nullable": true, "readOnly": true }, "totalAgentDetailViews": { "type": "integer", "description": "Total number of agent detail views", "format": "int32", "nullable": true, "readOnly": true }, "totalShortlisted": { "type": "integer", "description": "Total number of times the listing was shortlisted", "format": "int32", "nullable": true, "readOnly": true }, "totalPrinted": { "type": "integer", "description": "Total number of time the listing detail was printed", "format": "int32", "nullable": true, "readOnly": true }, "totalAgentPhoneNumberReveals": { "type": "integer", "description": "Total number of times the agent phone number was revealed for contact", "format": "int32", "nullable": true, "readOnly": true }, "totalEnquiries": { "type": "integer", "description": "Total number of enquiries", "format": "int32", "nullable": true, "readOnly": true }, "totalEmailToFriend": { "type": "integer", "description": "Total number of times the listing link was emailed", "format": "int32", "nullable": true, "readOnly": true }, "totalSharedViaSocialMedia": { "type": "integer", "description": "Total number of shares via social media", "format": "int32", "nullable": true, "readOnly": true }, "totalInspectionTimeSaving": { "type": "integer", "description": "Total numnber of times when the inspection was saved to calendar", "format": "int32", "nullable": true, "readOnly": true }, "totalCallToAgentFromMobile": { "type": "integer", "description": "Total number of calls made to agent from inside the listing", "format": "int32", "nullable": true, "readOnly": true }, "percentageWebsiteViews": { "type": "number", "description": "Percentage of total views from website", "format": "double", "nullable": true, "readOnly": true }, "percentageMobileSiteViews": { "type": "number", "description": "Percentage of total views from mobile site", "format": "double", "nullable": true, "readOnly": true }, "percentageSmartPhoneViews": { "type": "number", "description": "Percentage of total views from smart phone apps", "format": "double", "nullable": true, "readOnly": true }, "percentageTabletViews": { "type": "number", "description": "Percentage of total views from tablets", "format": "double", "nullable": true, "readOnly": true } }, "additionalProperties": false, "description": "Listing statistics", "x-data-access-level-info": { "Basic": [ "*" ], "Detailed": [ "*" ], "Full": [ "*" ] } }, "Agencies.V1.Agent": { "type": "object", "properties": { "dateUpdated": { "type": "string", "description": "Gets or Sets DateUpdated", "format": "date-time", "nullable": true }, "agencyId": { "type": "integer", "description": "Gets or Sets AgencyId", "format": "int32", "nullable": true }, "agentId": { "type": "integer", "description": "Gets or Sets AgentId", "format": "int32", "nullable": true }, "email": { "type": "string", "description": "Gets or Sets Email", "nullable": true }, "firstName": { "type": "string", "description": "Gets or Sets FirstName", "nullable": true }, "mobile": { "type": "string", "description": "Gets or Sets Mobile", "nullable": true }, "photo": { "type": "string", "description": "Gets or Sets Photo", "nullable": true }, "lastName": { "type": "string", "description": "Gets or Sets LastName", "nullable": true }, "isActiveProfilePage": { "type": "string", "description": "Gets or Sets IsActiveProfilePage", "nullable": true }, "phone": { "type": "string", "description": "Gets or Sets Phone", "nullable": true }, "saleActive": { "type": "boolean", "description": "Gets or Sets SaleActive", "nullable": true }, "rentalActive": { "type": "boolean", "description": "Gets or Sets RentalActive", "nullable": true }, "secondaryEmail": { "type": "string", "description": "Gets or Sets SecondaryEmail", "nullable": true }, "facebookUrl": { "type": "string", "description": "Gets or Sets FacebookUrl", "nullable": true }, "twitterUrl": { "type": "string", "description": "Gets or Sets TwitterUrl", "nullable": true }, "agentVideo": { "type": "string", "description": "Gets or Sets AgentVideo", "nullable": true }, "profileText": { "type": "string", "description": "Gets or Sets ProfileText", "nullable": true }, "isHideSoldLeasedListings": { "type": "boolean", "description": "Gets or Sets IsHideSoldLeasedListings", "nullable": true }, "googlePlusUrl": { "type": "string", "description": "Gets or Sets GooglePlusUrl", "nullable": true }, "personalWebsiteUrl": { "type": "string", "description": "Gets or Sets PersonalWebsiteUrl", "nullable": true }, "linkedInUrl": { "type": "string", "description": "Gets or Sets LinkedInUrl", "nullable": true }, "fax": { "type": "string", "description": "Gets or Sets Fax", "nullable": true }, "mugShotURL": { "type": "string", "description": "Gets or Sets MugShotURL", "nullable": true }, "mugShotNew": { "type": "string", "description": "Gets or Sets MugShotNew", "nullable": true }, "contactTypeCode": { "type": "integer", "description": "Gets or Sets ContactTypeCode", "format": "int32", "nullable": true }, "receivesRequests": { "type": "boolean", "description": "Gets or Sets ReceivesRequests", "nullable": true }, "creAgentVideoURL": { "type": "string", "description": "Gets or Sets CreAgentVideoURL", "nullable": true }, "receiveScheduledReportEmail": { "type": "boolean", "description": "Gets or Sets ReceiveScheduledReportEmail", "nullable": true }, "profileUrl": { "type": "string", "description": "Gets or Sets ProfileUrl", "nullable": true }, "jobPosition": { "type": "string", "description": "Gets or Sets JobPosition", "nullable": true } }, "additionalProperties": false, "description": "AgentDto", "x-data-access-level-info": { "Basic": [ "AgencyId", "AgentId", "ContactTypeCode", "FacebookUrl", "FirstName", "GooglePlusUrl", "JobPosition", "LastName", "MugShotNew", "MugShotURL", "Phone", "Photo", "ProfileText", "ProfileUrl", "TwitterUrl" ], "Detailed": [ "AgencyId", "AgentId", "ContactTypeCode", "FacebookUrl", "FirstName", "GooglePlusUrl", "JobPosition", "LastName", "MugShotNew", "MugShotURL", "Phone", "Photo", "ProfileText", "ProfileUrl", "TwitterUrl", "AgentVideo", "CreAgentVideoURL", "Email", "LinkedInUrl", "Mobile", "PersonalWebsiteUrl", "SecondaryEmail" ], "Full": [ "AgencyId", "AgentId", "ContactTypeCode", "FacebookUrl", "FirstName", "GooglePlusUrl", "JobPosition", "LastName", "MugShotNew", "MugShotURL", "Phone", "Photo", "ProfileText", "ProfileUrl", "TwitterUrl", "AgentVideo", "CreAgentVideoURL", "Email", "LinkedInUrl", "Mobile", "PersonalWebsiteUrl", "SecondaryEmail", "DateUpdated", "Fax", "IsActiveProfilePage", "IsHideSoldLeasedListings", "ReceiveScheduledReportEmail", "ReceivesRequests", "RentalActive", "SaleActive" ] } }, "Domain.AgentSearch.v1.Model.AutoSuggestAgentResultDto": { "type": "object", "properties": { "agentId": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "agencyName": { "type": "string" }, "suburb": { "type": "string" }, "state": { "type": "string" }, "profileUrl": { "type": "string" }, "thumbnail": { "type": "string" } }, "x-data-access-level-info": { "Basic": [ "*" ], "Detailed": [ "*" ], "Full": [ "*" ] } }, "Authorities.v1.Address": { "required": [ "country", "number", "postcode", "state", "street", "suburb" ], "type": "object", "properties": { "country": { "type": "string", "example": "Australia" }, "number": { "type": "string", "example": "123123/45" }, "postcode": { "type": "string", "example": "2000" }, "state": { "type": "string", "example": "New South Wales" }, "street": { "type": "string", "example": "Sample St" }, "suburb": { "type": "string", "example": "Sydney" } } }, "Authorities.v1.MarketingCampaignItemRequest": { "type": "object", "properties": { "itemId": { "type": "string" }, "finalPrice": { "type": "string", "format": "decimal", "example": "4000.00" }, "vendorPrice": { "type": "string", "format": "decimal", "example": "4000.00" }, "description": { "type": "string", "nullable": true }, "selected": { "type": "boolean", "default": true }, "hidden": { "type": "boolean", "default": false } } }, "Authorities.v1.MarketingCampaignRequest": { "required": [ "campaignType" ], "properties": { "advertising": { "type": "string", "description": "advertising cost of this marketing campaign", "format": "decimal", "example": "3000.00" }, "campaignType": { "type": "string", "description": "Available options are: `To Be Advised`, `Paper Based`, `Campaign Track`, `Realhub`", "example": "Paper Based" }, "marketingCampaignItems": { "type": "array", "items": { "$ref": "#/components/schemas/Authorities.v1.MarketingCampaignItemRequest" } }, "comments": { "type": "string", "format": "json", "example": "{\"children\":[{\"children\":null,\"hidden\":false,\"hides_children\":false,\"placeholders\":null,\"remove_css_class\":null,\"selected\":false,\"tag_key\":null,\"text\":\"Written Request\",\"text_convertible\":true,\"type\":\"option_radio\"}],\"hidden\":false,\"placeholders\":null,\"required\":false,\"text\":null,\"text_convertible\":true,\"type\":\"group_radio\"}" }, "commentsFallback": { "type": "string", "example": "" }, "discountAmount": { "type": "string", "format": "decimal", "nullable": true, "example": "1000.00" }, "discountPercent": { "type": "string", "format": "decimal", "nullable": true, "example": "10.00" }, "expense": { "type": "string", "description": "Available options are: `Signing of this Authority`, `Written request`, `Specific Date`, `Signing of this Form 6`, `Signing of this Agency Agreement`, `Upon Invoice or Account`, `Prior to the commencement of marketing campaign`, `On Settlement or Withdrawal whichever occurs first`, `Vendor to pay through Campaign Agent v2`, `Vendor to pay through Market Now`, `Vendor to pay through Rello`, `Vendor to pay through List Ready`", "nullable": true, "example": "Signing of this Authority" }, "other": { "type": "string", "format": "decimal", "example": "1000.00" }, "payableOn": { "type": "string", "format": "date", "nullable": true, "example": "2016-10-22" }, "total": { "type": "string", "description": "Total cost of this marketing campaign. Total of the items cost if there are items or (advertising + other) cost for other types", "format": "decimal", "example": "4000.00" }, "realhubQuoteId": { "type": "string", "nullable": true, "example": "1234567890" } } }, "Authorities.v1.IndividualRequest": { "required": [ "address", "email", "firstName", "lastName", "mobile", "phoneNumber" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true, "example": "cf52bbf4-8d00-45e5-917a-8f27631a7da0" }, "address": { "$ref": "#/components/schemas/Authorities.v1.Address" }, "dateOfBirth": { "type": "string", "format": "date", "nullable": true, "example": "2022-07-16" }, "email": { "type": "string", "format": "email", "example": "johndoe@email.com" }, "firstName": { "type": "string", "example": "John" }, "lastName": { "type": "string", "example": "Smith" }, "middleName": { "type": "string", "example": "Doe" }, "mobile": { "type": "string", "example": "1234567890" }, "phoneNumber": { "type": "string", "example": "1234567890" }, "title": { "type": "string", "example": "" }, "type": { "type": "string", "description": "Available options are: `individual`, `company`", "readOnly": true, "example": "individual" } } }, "Authorities.v1.CompanyRequest": { "required": [ "address", "email" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true, "example": "cf52bbf4-8d00-45e5-917a-8f27631a7da0" }, "address": { "$ref": "#/components/schemas/Authorities.v1.Address" }, "email": { "type": "string", "format": "email", "example": "johndoe@email.com" }, "name": { "type": "string", "example": "Company Name" }, "phoneNumber": { "type": "string", "example": "1234567890" }, "fax": { "type": "string", "example": "1234567890" }, "abn": { "type": "string", "example": "1234567890" }, "acn": { "type": "string", "example": "1234567890" }, "gstRegistered": { "type": "boolean", "nullable": true, "example": false }, "type": { "type": "string", "description": "Available options are: `individual`, `company`", "readOnly": true, "example": "company" } } }, "Authorities.v1.VendorRequest": { "required": [ "contact", "authority", "nature", "order" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true, "example": "cf52bbf4-8d00-45e5-917a-8f27631a7da0" }, "contact": { "$ref": "#/components/schemas/Authorities.v1.IndividualRequest" }, "contactRepresented": { "$ref": "#/components/schemas/Authorities.v1.CompanyRequest" }, "conciergeOptedIn": { "type": "boolean", "nullable": true, "example": false }, "nature": { "type": "string", "example": "Legal Representative" }, "trust": { "type": "string", "nullable": true }, "order": { "type": "integer", "example": 1 }, "authorityAttachments": { "type": "array", "items": { "type": "string", "description": "ID of an attachment.", "format": "uuid", "example": "ceb22e1d-419a-480f-a1df-ce53914acf5e" }, "description": "An array of attachment IDs." } } }, "Authorities.v1.AgentRequest": { "required": [ "name", "email" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true, "example": "cf52bbf4-8d00-45e5-917a-8f27631a7da0" }, "name": { "type": "string", "example": "John Doe" }, "email": { "type": "string", "format": "email", "example": "johndoe@email.com" }, "user": { "type": "string", "format": "uuid", "example": "cf52bbf4-8d00-45e5-917a-8f27631a7da0" }, "mobile": { "type": "string", "example": "0123456789" }, "officeNumber": { "type": "string", "example": "0123456789" }, "licenseNumber": { "type": "string", "example": "0123456789" } } }, "Authorities.v1.CrmDetails": { "required": [ "type", "id" ], "type": "object", "properties": { "type": { "type": "string", "example": "D" }, "id": { "type": "string", "example": "1234567890" } }, "description": "Details of CRM" }, "Authorities.v1.AuthorityRequest": { "required": [ "address", "agency", "bathrooms", "bedrooms", "parking", "propertyType", "type" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true, "example": "cf52bbf4-8d00-45e5-917a-8f27631a7da0" }, "address": { "$ref": "#/components/schemas/Authorities.v1.Address" }, "marketingCampaigns": { "type": "array", "items": { "$ref": "#/components/schemas/Authorities.v1.MarketingCampaignRequest" } }, "vendors": { "type": "array", "items": { "$ref": "#/components/schemas/Authorities.v1.VendorRequest" } }, "agents": { "type": "array", "items": { "$ref": "#/components/schemas/Authorities.v1.AgentRequest" } }, "bathrooms": { "type": "integer", "writeOnly": true, "example": 2 }, "bedrooms": { "type": "integer", "writeOnly": true, "example": 3 }, "parking": { "type": "integer", "writeOnly": true, "example": 1 }, "propertyType": { "type": "string", "description": "Available options are: `ApartmentUnitFlat`, `House`, `Townhouse`, `VacantLand`", "writeOnly": true, "example": "ApartmentUnitFlat" }, "created": { "type": "string", "format": "date-time", "readOnly": true, "example": "2016-10-22T09:29:24.8137700+11:00" }, "modified": { "type": "string", "format": "date-time", "readOnly": true, "example": "2016-10-22T09:29:24.8137700+11:00" }, "status": { "type": "string", "description": "Available options are: `draft`, `missing sign`, `executed`", "readOnly": true, "example": "executed" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true, "example": "2016-10-22T09:29:24.8137700+11:00" }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true, "example": "2016-10-22T09:29:24.8137700+11:00" }, "administrationFee": { "type": "string", "example": "" }, "agentDetailsDate": { "type": "string", "format": "date-time", "example": "2016-08-29T09:12:33.0010000+00:00" }, "auctionDate": { "type": "string", "format": "date-time", "example": "2016-08-29T09:12:33.0010000+00:00" }, "auctionType": { "type": "string", "example": "Onsite" }, "chattelsExcluded": { "type": "string", "example": "Value" }, "chattelsIncluded": { "type": "array", "items": { "type": "string", "example": "value" } }, "continuingPeriod": { "type": "number", "example": 90 }, "espRangeHigher": { "type": "number", "example": 200000 }, "espRangeLower": { "type": "number", "example": 100000 }, "exclusivePeriod": { "type": "number", "example": 60 }, "exclusivePeriodStartDate": { "type": "string", "format": "date-time", "example": "2016-08-29T09:12:33.0010000+00:00" }, "exclusiveSoldAs": { "type": "string", "description": "Available options are: `Private Sale`, `Expression of Interest with the reserve to be advised prior to closing date`", "nullable": true, "example": "Private Sale" }, "isOwnersCorporationManaged": { "type": "boolean", "example": false }, "isPropertyTenanted": { "type": "boolean", "example": false }, "occupationState": { "type": "string", "description": "Available options are: `With vacant possession`, `Subject to any tenancy`, `Both`", "nullable": true, "example": "Both" }, "optOutInformation": { "type": "boolean", "example": false }, "payableIn": { "type": "array", "items": { "type": "string", "format": "int", "example": "30" } }, "paymentMethod": { "type": "string", "description": "Available options are: `Full purchase price`, `Payment of full deposit`", "nullable": true, "example": "Payment of full deposit" }, "paymentSum": { "type": "number", "example": 100000 }, "reservePrice": { "type": "number", "example": 100000 }, "salePriceGstType": { "type": "string", "example": "l" }, "saleSignPermission": { "type": "boolean", "example": false }, "searchCriteriaAmount": { "type": "number", "example": 100000 }, "searchCriteriaPriceType": { "type": "string", "description": "Available options are: `amount`, `range`, `other`", "example": "amount" }, "transactionType": { "type": "string", "example": "AUTH" }, "type": { "type": "string", "description": "Available options are: `Exclusive Auction`, `Exclusive Sale`, `General Sale`, `Appraisal`", "example": "Exclusive Sale" }, "vendorMktPriceNa": { "type": "boolean", "example": true }, "waivedCoolingOff": { "type": "boolean", "example": false }, "lot": { "maxLength": 32, "type": "string" }, "plan": { "maxLength": 32, "type": "string" }, "titleReference": { "maxLength": 32, "type": "string" }, "certificateOfTitleType": { "type": "string", "description": "This field is unique to SA" }, "certificateOfTitleFolio": { "type": "string", "description": "This field is unique to SA" }, "certificateOfTitleVolume": { "type": "string", "description": "This field is unique to SA" }, "improvedLand": { "type": "boolean", "description": "This field is unique to SA", "default": false }, "crmDetails": { "$ref": "#/components/schemas/Authorities.v1.CrmDetails" } } }, "Authorities.v1.MarketingCampaignItemResponse": { "required": [ "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/Authorities.v1.MarketingCampaignItemRequest" }, { "type": "object" } ], "properties": { "id": { "type": "string", "format": "uuid", "example": "0557934b-b9f8-4d88-bd5a-9c69d5bf0beb" } } }, "Authorities.v1.MarketingCampaignResponse": { "required": [ "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/Authorities.v1.MarketingCampaignRequest" }, { "type": "object" } ], "properties": { "marketingCampaignItems": { "type": "array", "items": { "$ref": "#/components/schemas/Authorities.v1.MarketingCampaignItemResponse" } }, "id": { "type": "string", "format": "uuid", "example": "0557934b-b9f8-4d88-bd5a-9c69d5bf0beb" } } }, "Authorities.v1.IndividualResponse": { "required": [ "id", "address", "email", "firstName", "lastName", "mobile", "phoneNumber" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/Authorities.v1.IndividualRequest" }, { "type": "object" } ], "properties": { "id": { "type": "string", "format": "uuid", "example": "cf52bbf4-8d00-45e5-917a-8f27631a7da0" } } }, "Authorities.v1.CompanyResponse": { "required": [ "id", "email", "address" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/Authorities.v1.CompanyRequest" }, { "type": "object" } ], "properties": { "id": { "type": "string", "format": "uuid", "example": "cf52bbf4-8d00-45e5-917a-8f27631a7da0" } } }, "Authorities.v1.VendorResponse": { "required": [ "id", "contact", "authority", "nature", "order" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/Authorities.v1.VendorRequest" }, { "type": "object" } ], "properties": { "id": { "type": "string", "format": "uuid", "example": "cf52bbf4-8d00-45e5-917a-8f27631a7da0" }, "contact": { "$ref": "#/components/schemas/Authorities.v1.IndividualResponse" }, "contactRepresented": { "$ref": "#/components/schemas/Authorities.v1.CompanyResponse" } } }, "Authorities.v1.AgentResponse": { "required": [ "id", "name", "email" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/Authorities.v1.AgentRequest" }, { "type": "object" } ], "properties": { "id": { "type": "string", "format": "uuid", "example": "cf52bbf4-8d00-45e5-917a-8f27631a7da0" } } }, "Authorities.v1.AuthorityResponse": { "required": [ "id", "address", "agency", "bathrooms", "bedrooms", "parking", "property_type", "type" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/Authorities.v1.AuthorityRequest" }, { "type": "object" } ], "properties": { "id": { "type": "string", "format": "uuid", "example": "cf52bbf4-8d00-45e5-917a-8f27631a7da0" }, "marketingCampaigns": { "type": "array", "items": { "$ref": "#/components/schemas/Authorities.v1.MarketingCampaignResponse" } }, "vendors": { "type": "array", "items": { "$ref": "#/components/schemas/Authorities.v1.VendorResponse" } }, "agents": { "type": "array", "items": { "$ref": "#/components/schemas/Authorities.v1.AgentResponse" } } } }, "Authorities.v1.Attachments": { "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true, "example": "0557934b-b9f8-4d88-bd5a-9c69d5bf0beb" }, "attachment": { "type": "string", "format": "binary", "writeOnly": true, "example": "/path/to/file" }, "fileType": { "type": "string", "writeOnly": true, "example": "Available options are marketingAttachments, commissionAttachments, espAttachment" } } }, "Authorities.v1.VendorAttachments": { "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true, "example": "0557934b-b9f8-4d88-bd5a-9c69d5bf0beb" }, "attachment": { "type": "string", "format": "binary", "writeOnly": true, "example": "/path/to/file" } } }, "Authorities.v1.SubscriptionRequest": { "type": "object", "properties": { "webhookId": { "type": "string", "example": "whk_7d9c8f4a0cb54b948a010bb56ea98fe0" } } }, "Authorities.v1.SubscriptionResponse": { "type": "object", "properties": { "subscriptionId": { "type": "string", "example": "123" } } }, "CampaignAPI.v1.Leads": { "type": "object", "properties": { "total": { "type": "integer", "format": "int32" }, "emailEnquiries": { "type": "integer", "format": "int32" }, "phoneLeads": { "type": "integer", "format": "int32" }, "phoneReveals": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "CampaignAPI.v1.Shares": { "type": "object", "properties": { "total": { "type": "integer", "format": "int32" }, "listingLinkCopied": { "type": "integer", "format": "int32" }, "sharedViaSocial": { "type": "integer", "format": "int32" }, "sharedViaEmail": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "CampaignAPI.v1.ListingPerformanceResponse": { "required": [ "agencyName", "domainAgencyId", "ioNumber", "leads", "listingId", "projectId", "projectName", "shares" ], "type": "object", "properties": { "listingId": { "type": "string", "nullable": true }, "projectId": { "type": "string", "nullable": true }, "projectName": { "type": "string", "nullable": true }, "domainAgencyId": { "type": "string", "nullable": true }, "agencyName": { "type": "string", "nullable": true }, "ioNumber": { "type": "string", "nullable": true }, "date": { "type": "string", "format": "date" }, "leads": { "$ref": "#/components/schemas/CampaignAPI.v1.Leads" }, "photoViews": { "type": "integer", "format": "int32" }, "mapViews": { "type": "integer", "format": "int32" }, "pageViews": { "type": "integer", "format": "int32" }, "floorPlanViews": { "type": "integer", "format": "int32" }, "shares": { "$ref": "#/components/schemas/CampaignAPI.v1.Shares" }, "shortlisted": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "CampaignAPI.v1.ListingPerformanceDataResponse": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/CampaignAPI.v1.ListingPerformanceResponse" }, "nullable": true } }, "additionalProperties": false }, "CampaignAPI.v1.HttpValidationProblemDetails": { "type": "object", "properties": { "type": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "status": { "type": "integer", "format": "int32", "nullable": true }, "detail": { "type": "string", "nullable": true }, "instance": { "type": "string", "nullable": true }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "nullable": true } }, "additionalProperties": {} }, "CampaignAPI.v1.ProjectPerformanceResponse": { "required": [ "domainAgencyId", "ioNumber", "projectId" ], "type": "object", "properties": { "date": { "type": "string", "format": "date" }, "domainAgencyId": { "type": "string", "nullable": true }, "ioNumber": { "type": "string", "nullable": true }, "projectId": { "type": "string", "nullable": true }, "projectName": { "type": "string", "nullable": true }, "pageViews": { "type": "integer", "format": "int32" }, "saveAndShares": { "type": "integer", "format": "int32" }, "totalLeads": { "type": "integer", "format": "int32" }, "emailEnquiries": { "type": "integer", "format": "int32" }, "phoneLeads": { "type": "integer", "format": "int32" }, "phoneReveals": { "type": "integer", "format": "int32" }, "agentDetailsViews": { "type": "integer", "format": "int32" }, "photoViews": { "type": "integer", "format": "int32" }, "videoViews": { "type": "integer", "format": "int32" }, "mapViews": { "type": "integer", "format": "int32" }, "spend": { "type": "number", "format": "double", "nullable": true }, "cpe": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false }, "CampaignAPI.v1.ProjectPerformanceDataResponse": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/CampaignAPI.v1.ProjectPerformanceResponse" }, "nullable": true } }, "additionalProperties": false }, "DemographicsResponse": { "type": "object", "properties": { "demographics": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string" }, "total": { "type": "integer" }, "year": { "type": "integer" }, "items": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "type": "integer" }, "composition": { "type": "string" } } } } } } } } }, "Enquiries.V1.Recipient": { "required": [ "address" ], "type": "object", "properties": { "recipientType": { "enum": [ "primary", "secondary", "hidden" ], "type": "string", "description": "Gets or Sets RecipientType", "nullable": true }, "address": { "minLength": 1, "type": "string", "description": "Delivery address ( email address, phone number etc. ) of the recipient" } }, "additionalProperties": false, "description": "Recipient of an Group.Enquiry.Model.Enquiry", "x-data-access-level-info": { "Basic": [ "*" ], "Detailed": [ "*" ], "Full": [ "*" ] } }, "Enquiries.V1.RecipientDeliveryStatus": { "type": "object", "properties": { "deliveryStatus": { "enum": [ "queued", "delivered", "failed", "deferred" ], "type": "string", "description": "Gets or Sets DeliveryStatus", "nullable": true }, "recipient": { "$ref": "#/components/schemas/Enquiries.V1.Recipient" }, "date": { "type": "string", "description": "Last time when the email delivery status was polled", "format": "date-time", "nullable": true } }, "additionalProperties": false, "description": "Used for reporting enquiry delivery statusses to recipients", "x-data-access-level-info": { "Basic": [ "*" ], "Detailed": [ "*" ], "Full": [ "*" ] } }, "Enquiries.V1.Sender": { "type": "object", "properties": { "firstName": { "type": "string", "nullable": true }, "lastName": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "phoneNumber": { "type": "string", "nullable": true }, "postcode": { "type": "string", "nullable": true } }, "additionalProperties": false, "x-data-access-level-info": { "Basic": [ "*" ], "Detailed": [ "*" ], "Full": [ "*" ] } }, "Enquiries.V1.EnquiryReport": { "type": "object", "properties": { "deliveryMethod": { "enum": [ "email", "sms" ], "type": "string", "nullable": true }, "enquiryType": { "enum": [ "listing", "devProject", "newDevLanding", "agencyProfile", "agentProfile", "contractRequest", "vendorEnquiry", "prePortalListing", "suburbVendorEnquiry" ], "type": "string", "nullable": true }, "id": { "type": "string", "nullable": true }, "message": { "type": "string", "nullable": true }, "metaData": { "type": "object", "additionalProperties": { "type": "string" }, "nullable": true, "x-data-access-level-info": { "Basic": [ "*" ], "Detailed": [ "*" ], "Full": [ "*" ] } }, "recipientsDeliveryStatus": { "type": "array", "items": { "$ref": "#/components/schemas/Enquiries.V1.RecipientDeliveryStatus" }, "nullable": true }, "referenceId": { "type": "integer", "format": "int32", "nullable": true }, "sender": { "$ref": "#/components/schemas/Enquiries.V1.Sender" }, "dateReceived": { "type": "string", "format": "date-time", "nullable": true }, "agencyId": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false, "x-data-access-level-info": { "Basic": [ "*" ], "Detailed": [ "*" ], "Full": [ "*" ] } }, "Domain.Public.Adapter.Web.Api.Models.v1.Enquiries.Sender": { "type": "object", "properties": { "firstName": { "type": "string", "description": "Sender first name" }, "lastName": { "type": "string", "description": "Sender lastname/surname" }, "email": { "type": "string", "description": "Sender email address" }, "phoneNumber": { "type": "string", "description": "Sender phone number" }, "postcode": { "pattern": "^\\d*$", "type": "string", "description": "Postcode of sender's location" } }, "description": "Contains enquiry sender details" }, "Domain.Public.Adapter.Web.Api.Models.v1.Enquiries.Enquiry": { "type": "object", "properties": { "deliveryMethod": { "enum": [ "email", "sms" ], "type": "string", "description": "Delivery method of the enquiry" }, "enquiryType": { "enum": [ "listing", "devProject", "newDevLanding", "agencyProfile", "agentProfile", "contractRequest", "vendorEnquiry", "prePortalListing" ], "type": "string", "description": "Type of enquiry" }, "referenceId": { "type": "integer", "description": "Listing identifier", "format": "int32" }, "id": { "type": "string", "description": "Enquiry identifier" }, "sender": { "$ref": "#/components/schemas/Domain.Public.Adapter.Web.Api.Models.v1.Enquiries.Sender" }, "subject": { "type": "string", "description": "Enquiry subject" }, "message": { "type": "string", "description": "Enquiry message" }, "metaData": { "type": "object", "additionalProperties": { "type": "string" }, "description": "MetaData of the enquiry" } }, "description": "An enquiry with associated reference (eg. listing)" }, "Domain.EnquiryService.v1.Model.GroupEnquiryServiceModelsEnquiryResponse": { "type": "object", "properties": { "s3Key": { "type": "string" }, "message": { "type": "string" }, "enquiryReceiptTimestamp": { "type": "string", "format": "date-time" }, "warnings": { "type": "array", "items": { "type": "string" } } }, "x-data-access-level-info": { "Basic": [ "*" ], "Detailed": [ "*" ], "Full": [ "*" ] } }, "ListingPerformance.v1.DailyStatistics": { "type": "object", "properties": { "listingId": { "type": "integer", "description": "Domain Advertisement Id", "format": "int64", "nullable": true, "readOnly": true }, "totalListingViews": { "type": "integer", "description": "Total number of views for the listing details", "format": "int32", "nullable": true, "readOnly": true }, "totalPhotoViews": { "type": "integer", "description": "Total number of listing photo views", "format": "int32", "nullable": true, "readOnly": true }, "totalPhotoGalleryViews": { "type": "integer", "description": "Total number of listing photo gallery views", "format": "int32", "nullable": true, "readOnly": true }, "totalFloorplanViews": { "type": "integer", "description": "Total number of floorplan views", "format": "int32", "nullable": true, "readOnly": true }, "totalMapViews": { "type": "integer", "description": "Total number of address map views", "format": "int32", "nullable": true, "readOnly": true }, "totalVideoViews": { "type": "integer", "description": "Total number of vedio views", "format": "int32", "nullable": true, "readOnly": true }, "totalEbrochureViews": { "type": "integer", "description": "Total number of Ebrochure views", "format": "int32", "nullable": true, "readOnly": true }, "totalAgentDetailViews": { "type": "integer", "description": "Total number of agent detail views", "format": "int32", "nullable": true, "readOnly": true }, "totalShortlisted": { "type": "integer", "description": "Total number of times the listing was shortlisted", "format": "int32", "nullable": true, "readOnly": true }, "totalPrinted": { "type": "integer", "description": "Total number of time the listing detail was printed", "format": "int32", "nullable": true, "readOnly": true }, "totalAgentPhoneNumberReveals": { "type": "integer", "description": "Total number of times the agent phone number was revealed for contact", "format": "int32", "nullable": true, "readOnly": true }, "totalEnquiries": { "type": "integer", "description": "Total number of enquiries", "format": "int32", "nullable": true, "readOnly": true }, "totalEmailToFriend": { "type": "integer", "description": "Total number of times the listing link was emailed", "format": "int32", "nullable": true, "readOnly": true }, "totalSharedViaSocialMedia": { "type": "integer", "description": "Total number of shares via social media", "format": "int32", "nullable": true, "readOnly": true }, "totalInspectionTimeSaving": { "type": "integer", "description": "Total numnber of times when the inspection was saved to calendar", "format": "int32", "nullable": true, "readOnly": true }, "totalCallToAgentFromMobile": { "type": "integer", "description": "Total number of calls made to agent from inside the listing", "format": "int32", "nullable": true, "readOnly": true }, "percentageWebsiteViews": { "type": "number", "description": "Percentage of total views from website", "format": "double", "nullable": true, "readOnly": true }, "percentageMobileSiteViews": { "type": "number", "description": "Percentage of total views from mobile site", "format": "double", "nullable": true, "readOnly": true }, "percentageSmartPhoneViews": { "type": "number", "description": "Percentage of total views from smart phone apps", "format": "double", "nullable": true, "readOnly": true }, "percentageTabletViews": { "type": "number", "description": "Percentage of total views from tablets", "format": "double", "nullable": true, "readOnly": true }, "eventDate": { "type": "string", "description": "Date of statistics events", "format": "date-time", "nullable": true } }, "additionalProperties": false, "x-data-access-level-info": { "Basic": [ "*" ], "Detailed": [ "*" ], "Full": [ "*" ] } }, "ListingPerformance.v1.StatisticReport": { "type": "object", "properties": { "summary": { "$ref": "#/components/schemas/ListingPerformance.v1.Statistics" }, "dailyBreakdown": { "type": "array", "items": { "$ref": "#/components/schemas/ListingPerformance.v1.DailyStatistics" }, "description": "Listing statistic breakdown for the period", "nullable": true } }, "additionalProperties": false, "description": "Statistics report for single listing", "x-data-access-level-info": { "Basic": [ "*" ], "Detailed": [ "*" ], "Full": [ "*" ] } }, "Domain.ListingAdminService.v1.Model.LandArea": { "type": "object", "properties": { "unit": { "enum": [ "squareMetres", "acres", "hectares", "squareFeet", "squareYards", "squares" ], "type": "string", "description": "Unit of measure" }, "value": { "type": "number", "description": "Area. Will be rounded to 2 decimals.", "format": "double" }, "from": { "type": "number", "description": "Minimum area", "format": "double" }, "to": { "type": "number", "description": "Maximum area", "format": "double" } }, "description": "Area information, Either single value or from and To must be provided" }, "Domain.ListingAdminService.v1.Model.Parking": { "type": "object", "properties": { "parkingType": { "enum": [ "onSite", "onStreet", "noParking" ], "type": "string", "description": "Can have the value \\\"OnSite\\\", \\\"OnStreet\\\", \\\"NoParking\\\". Default \\\"NoParking\\\"" }, "numberOnSite": { "type": "integer", "description": "Number On Site", "format": "int32" }, "information": { "type": "string", "description": "Additional information regarding the parking condition" } }, "description": "Parking Details" }, "Domain.ListingAdminService.v1.Model.PropertyPdf": { "type": "object", "properties": { "type": { "enum": [ "commercialPdf", "newDevBrochurePdf", "floorplanPdf", "devProjectPdf" ], "type": "string", "description": "Type of the PDF" }, "url": { "type": "string", "description": "Url of the PDF" }, "description": { "type": "string", "description": "Description of the PDF" } }, "description": "PDF file related to the listing" }, "Domain.ListingAdminService.v1.Model.PropertyMedia": { "type": "object", "properties": { "resourceType": { "enum": [ "photograph", "floorPlan", "video", "virtualTour", "webLink" ], "type": "string", "description": "Type of the resource" }, "url": { "type": "string", "description": "shows the place from where file can be downloaded" } }, "description": "Resource related to the listing" }, "Domain.ListingAdminService.v1.Model.GeoLocation": { "type": "object", "properties": { "latitude": { "type": "number", "description": "Latitude", "format": "double" }, "longitude": { "type": "number", "description": "Longitude", "format": "double" } }, "description": "Contains geocoding of an address" }, "Domain.ListingAdminService.v1.Model.Address": { "type": "object", "properties": { "displayOption": { "enum": [ "unspecified", "fullAddress", "streetAndSuburb", "suburbOnly", "regionOnly", "areaOnly", "stateOnly" ], "type": "string", "description": "What granularity to display the properties location at. For residential listings, the accepted displayOption values are `FullAddress`, `StreetAndSuburb` or `SuburbOnly`." }, "state": { "enum": [ "nsw", "vic", "act", "sa", "wa", "tas", "qld", "nt" ], "type": "string", "description": "State" }, "unitNumber": { "type": "string", "description": "Unit number for apartments, maximum 30 characters" }, "street": { "type": "string", "description": "Street name, maximum 100 characters" }, "suggestedGeoLocation": { "$ref": "#/components/schemas/Domain.ListingAdminService.v1.Model.GeoLocation" }, "streetNumber": { "type": "string", "description": "Street number, maximum 20 characters" }, "suburb": { "type": "string", "description": "Suburb name , maximum 50 characters" }, "postcode": { "type": "string", "description": "Postcode" } }, "description": "Address structure for property" }, "Domain.ListingAdminService.v1.Model.Area": { "type": "object", "properties": { "unit": { "enum": [ "squareMetres", "acres", "hectares", "squareFeet", "squareYards", "squares" ], "type": "string", "description": "Unit of measure, defaults to SquareMetres if not provided." }, "value": { "type": "number", "description": "Area. Will be rounded to 2 decimals.", "format": "double" }, "from": { "type": "number", "description": "Minimum area", "format": "double" }, "to": { "type": "number", "description": "Maximum area", "format": "double" } }, "description": "Area information, Either single value or from and To must be provided" }, "Domain.ListingAdminService.v1.Model.BusinessProperty": { "type": "object", "properties": { "propertyType": { "type": "array", "items": { "enum": [ "accessoriesParts", "accommodationTourism", "accounting", "adult", "advertisingMarketing", "aerial", "aeronautical", "agedCare", "agricultural", "air", "aircraft", "alarms", "alcoholLiquor", "amusements", "animalRelated", "aquaculture", "aquaticMarineMarinaBerth", "artsCrafts", "autoElectrical", "automotive", "backpackerHostel", "bakery", "barsNightclubs", "beautyHealth", "beautyProducts", "beautySalon", "bikeAndMotorcycle", "boardingKennels", "boatsMarineMarinaBerth", "bookkeeping", "brokerage", "builder", "buildingAndConstruction", "bus", "butcher", "cafeCoffeeShop", "car", "carBusTruck", "carDealership", "carRental", "carWash", "caravanPark", "carpenter", "catering", "childCare", "civil", "cleaning", "cleaningAndMaintenance", "clinicalPractice", "clothingAccessories", "clothingFootwear", "communication", "communications", "computerIT", "computerAndInternet", "construction", "convenienceStore", "copyLaminate", "courier", "cropHarvesting", "customs", "dairyFarming", "deli", "dental", "detailing", "distributors", "drivingSchools", "educationTraining", "educational", "electrical", "employmentRecruitment", "entertainment", "entertainmentTechnology", "export", "farming", "fertiliser", "finance", "financialServices", "fishingForestry", "floristNursery", "foodBeverage", "foodBeverageHospitality", "franchiseBusinessOpportunities", "freight", "fruitVegFreshProduce", "fruitPicking", "functionCentre", "furnitureTimber", "gambling", "gardenHousehold", "gardenNurseries", "gardening", "glassCeramic", "guestHouseBB", "hairdresser", "healthBeauty", "healthSpa", "hire", "homeGarden", "homeBased", "homewareHardware", "hospital", "hotel", "huntingTrap", "import", "importExportWholesale", "industrialManufacturing", "insemination", "insurance", "internet", "irrigationServices", "juiceBar", "landClearing", "landscaping", "laundryDryCleaning", "legal", "leisureEntertainment", "limousineTaxi", "livestock", "machinery", "machineryMetal", "managementRights", "manufacturers", "manufacturingEngineering", "marine", "massage", "mechanicalRepair", "media", "medical", "medicalPractice", "miningEarthMoving", "mobileServices", "motel", "motorcycle", "musicRelated", "mustering", "nails", "naturalTherapies", "newsagency", "nursery", "nursingHome", "officeSupplies", "oilGas", "panelBeating", "paperPrinting", "parkingCarSpace", "pestRelated", "pharmacies", "plastic", "plumbing", "poolWater", "postOffices", "printPhoto", "professional", "propertyRealEstate", "rail", "recreationSport", "recruitment", "repair", "resort", "restaurant", "retail", "retailer", "retirement", "retirementVillage", "road", "rural", "scientific", "sea", "security", "serviceStation", "services", "shearing", "sportsComplexGym", "supermarket", "takeawayFood", "taxi", "themePark", "tours", "training", "transportDistribution", "travel", "truck", "vending", "water", "welding", "wholesale", "wholesalers", "woolClassing", "wreckers", "alcoholGrocery", "cafeRestaurants", "discountStore", "ecoFriendly", "green", "grocery", "specialityRetail", "storage", "travelAgency", "varietyStore", "chickenShop", "seafoodShop", "deliCafe", "cropping", "viticulture", "grazing", "horticulture", "equine", "farmlet", "orchard", "ruralLifestyle", "onlineBusiness" ], "type": "string" }, "description": "Business property types ['accessoriesParts', 'accommodationTourism', 'accounting', 'adult', 'advertisingMarketing', 'aerial', 'aeronautical', 'agedCare', 'agricultural', 'air', 'aircraft', 'alarms', 'alcoholLiquor', 'amusements', 'animalRelated', 'aquaculture', 'aquaticMarineMarinaBerth', 'artsCrafts', 'autoElectrical', 'automotive', 'backpackerHostel', 'bakery', 'barsNightclubs', 'beautyHealth', 'beautyProducts', 'beautySalon', 'bikeAndMotorcycle', 'boardingKennels', 'boatsMarineMarinaBerth', 'bookkeeping', 'brokerage', 'builder', 'buildingAndConstruction', 'bus', 'butcher', 'cafeCoffeeShop', 'car', 'carBusTruck', 'carDealership', 'carRental', 'carWash', 'caravanPark', 'carpenter', 'catering', 'childCare', 'civil', 'cleaning', 'cleaningAndMaintenance', 'clinicalPractice', 'clothingAccessories', 'clothingFootwear', 'communication', 'communications', 'computerIT', 'computerAndInternet', 'construction', 'convenienceStore', 'copyLaminate', 'courier', 'cropHarvesting', 'customs', 'dairyFarming', 'deli', 'dental', 'detailing', 'distributors', 'drivingSchools', 'educationTraining', 'educational', 'electrical', 'employmentRecruitment', 'entertainment', 'entertainmentTechnology', 'export', 'farming', 'fertiliser', 'finance', 'financialServices', 'fishingForestry', 'floristNursery', 'foodBeverage', 'foodBeverageHospitality', 'franchiseBusinessOpportunities', 'freight', 'fruitVegFreshProduce', 'fruitPicking', 'functionCentre', 'furnitureTimber', 'gambling', 'gardenHousehold', 'gardenNurseries', 'gardening', 'glassCeramic', 'guestHouseBB', 'hairdresser', 'healthBeauty', 'healthSpa', 'hire', 'homeGarden', 'homeBased', 'homewareHardware', 'hospital', 'hotel', 'huntingTrap', 'import', 'importExportWholesale', 'industrialManufacturing', 'insemination', 'insurance', 'internet', 'irrigationServices', 'juiceBar', 'landClearing', 'landscaping', 'laundryDryCleaning', 'legal', 'leisureEntertainment', 'limousineTaxi', 'livestock', 'machinery', 'machineryMetal', 'managementRights', 'manufacturers', 'manufacturingEngineering', 'marine', 'massage', 'mechanicalRepair', 'media', 'medical', 'medicalPractice', 'miningEarthMoving', 'mobileServices', 'motel', 'motorcycle', 'musicRelated', 'mustering', 'nails', 'naturalTherapies', 'newsagency', 'nursery', 'nursingHome', 'officeSupplies', 'oilGas', 'panelBeating', 'paperPrinting', 'parkingCarSpace', 'pestRelated', 'pharmacies', 'plastic', 'plumbing', 'poolWater', 'postOffices', 'printPhoto', 'professional', 'propertyRealEstate', 'rail', 'recreationSport', 'recruitment', 'repair', 'resort', 'restaurant', 'retail', 'retailer', 'retirement', 'retirementVillage', 'road', 'rural', 'scientific', 'sea', 'security', 'serviceStation', 'services', 'shearing', 'sportsComplexGym', 'supermarket', 'takeawayFood', 'taxi', 'themePark', 'tours', 'training', 'transportDistribution', 'travel', 'truck', 'vending', 'water', 'welding', 'wholesale', 'wholesalers', 'woolClassing', 'wreckers', 'alcoholGrocery', 'cafeRestaurants', 'discountStore', 'ecoFriendly', 'green', 'grocery', 'specialityRetail', 'storage', 'travelAgency', 'varietyStore', 'chickenShop', 'seafoodShop', 'deliCafe', 'cropping', 'viticulture', 'grazing', 'horticulture', 'equine', 'farmlet', 'orchard', 'ruralLifestyle', 'onlineBusiness']." }, "landArea": { "$ref": "#/components/schemas/Domain.ListingAdminService.v1.Model.LandArea" }, "parking": { "$ref": "#/components/schemas/Domain.ListingAdminService.v1.Model.Parking" }, "pdfs": { "type": "array", "items": { "$ref": "#/components/schemas/Domain.ListingAdminService.v1.Model.PropertyPdf" }, "description": "List of PDF files related to the listing" }, "isMarkedForLiveability": { "type": "boolean", "description": "Is the property liveability compliant" }, "propertyName": { "type": "string", "description": "Name of the property up to 70 characters" }, "location": { "type": "string", "description": "Short location information up to 30 character, e.g.: Greenhills Beach" }, "images": { "type": "array", "items": { "$ref": "#/components/schemas/Domain.ListingAdminService.v1.Model.PropertyMedia" }, "description": "List of image files, photos or floor plans related to the listing." }, "address": { "$ref": "#/components/schemas/Domain.ListingAdminService.v1.Model.Address" }, "area": { "$ref": "#/components/schemas/Domain.ListingAdminService.v1.Model.Area" } }, "description": "Business Property" }, "Domain.ListingAdminService.v1.Model.LeaseHoldDetail": { "type": "object", "properties": { "leaseholdRentPeriod": { "enum": [ "perMonth", "perAnnum" ], "type": "string", "description": "Rent period for the existing lease, can be: ['perMonth', 'perAnnum']" }, "leaseholdPriceUnit": { "enum": [ "totalAmount", "perSqm" ], "type": "string", "description": "Price unit for the existing lease, can be: ['totalAmount', 'perSqm']" }, "leaseholdTerm": { "type": "integer", "description": "Term of existing lease", "format": "int32" }, "leaseholdStart": { "type": "string", "description": "Start of existing lease", "format": "date-time" }, "leaseholdRent": { "type": "number", "description": "Rent amount for the existing lease", "format": "double" } }, "description": "Contains additional details about a business listing" }, "Domain.ListingAdminService.v1.Model.SaleInfo": { "type": "object", "properties": { "annualSales": { "type": "number", "description": "Annual sales amount for the business", "format": "double" }, "annualProfit": { "type": "number", "description": "Annual profit amount for the business", "format": "double" }, "stockValue": { "type": "number", "description": "Stock value of the business", "format": "double" } }, "description": "Contains details about a business sales info" }, "Domain.ListingAdminService.v1.Model.Price": { "type": "object", "properties": { "displayText": { "type": "string", "description": "When provided this will be shown instead of the price range, e.g.: \\\"Offers over $450K considered\\\"" }, "from": { "type": "integer", "description": "Lowest price the property is expected to sell/rent for to set search price. For a fixed price, set this value the same as To", "format": "int32" }, "to": { "type": "integer", "description": "Highest price the property is expected to sell/rent for to set search price. For a fixed price, set this value the same as From", "format": "int32" } }, "description": "Pricing Information" }, "Domain.ListingAdminService.v1.Model.Inspection": { "type": "object", "properties": { "from": { "type": "string", "description": "Format: yyyy-mm-dd HH:mm:ss eg: 2015-10-20 13:30:00", "format": "date-time" }, "to": { "type": "string", "description": "Format: yyyy-mm-dd HH:mm:ss, eg: 2015-10-20 14:30:00", "format": "date-time" }, "repeat": { "type": "boolean", "description": "Specifies if the inspection is recurring weekly" } }, "description": "Inspection times" }, "Domain.ListingAdminService.v1.Model.InspectionDetails": { "type": "object", "properties": { "inspectionDescription": { "type": "string", "description": "Free text field for inspections" }, "inspections": { "type": "array", "items": { "$ref": "#/components/schemas/Domain.ListingAdminService.v1.Model.Inspection" }, "description": "Inspection times of the listing" } }, "description": "Inspection details" }, "Domain.ListingAdminService.v1.Model.Contact": { "type": "object", "properties": { "domainAgentId": { "type": "integer", "description": "Domain ID of the contact person at the agency", "format": "int32" }, "firstName": { "type": "string", "description": "First name. Maximum 50 characters." }, "lastName": { "type": "string", "description": "Last name. Maximum 50 characters." }, "phone": { "type": "string", "description": "Phone. Maximum 20 characters." }, "fax": { "type": "string", "description": "Fax. Maximum 20 characters." }, "mobile": { "type": "string", "description": "Mobile. Maximum 20 characters." }, "email": { "type": "string", "description": "Email. Maximum 100 characters." }, "receiveEmails": { "type": "boolean", "description": "Indicates whether the contact person should receive emails for the listing" } }, "description": "Contact domain model" }, "Domain.ListingAdminService.v1.Model.SupplementaryMetadata": { "type": "object", "properties": { "measurementUnit": { "enum": [ "squareMetres", "hectares", "millimetres", "dse" ], "type": "string", "description": "Measurement unit" }, "name": { "type": "string", "description": "Name" }, "description": { "type": "string", "description": "Description" }, "measurement": { "type": "number", "description": "Measurement", "format": "double" } }, "description": "Supplementary metadata" }, "Domain.ListingAdminService.v1.Model.ListingSupplementary": { "type": "object", "properties": { "name": { "type": "string", "description": "Name" }, "description": { "type": "string", "description": "Description" }, "types": { "type": "array", "items": { "type": "string" }, "description": "Types" }, "metadata": { "type": "array", "items": { "$ref": "#/components/schemas/Domain.ListingAdminService.v1.Model.SupplementaryMetadata" }, "description": "Metadata" } }, "description": "Listing supplementary" }, "Domain.ListingAdminService.v1.Model.BusinessListing": { "type": "object", "properties": { "listingAction": { "enum": [ "sale", "rent", "saleAndLease" ], "type": "string", "description": "Sale or Rent" }, "contactPreference": { "enum": [ "byPhone" ], "type": "string", "description": "Indicates the listing preferred contact method. Default by both phone and email if not provided." }, "underOfferOrContract": { "type": "boolean", "description": "Set for Sale listings only" }, "nabers": { "type": "number", "description": "The NABERS Rating is the energy efficiency rating that the property has been measured to have. This rating is measured in increments of .5 and can range from 0 to 6. The NABERS rating is required for spaces within office buildings of 1000 square metres or more. For more information on the NABERS rating system please visit http://www.nabers.gov.au", "format": "double" }, "propertyDetails": { "$ref": "#/components/schemas/Domain.ListingAdminService.v1.Model.BusinessProperty" }, "leaseHoldDetails": { "$ref": "#/components/schemas/Domain.ListingAdminService.v1.Model.LeaseHoldDetail" }, "saleInfo": { "$ref": "#/components/schemas/Domain.ListingAdminService.v1.Model.SaleInfo" }, "freeholdCommercialAdId": { "type": "integer", "description": "The ad id of the commercial property with a freehold that the business belongs to. Leasehold and freehold are mutually exclusive properties, only specify one", "format": "int32" }, "price": { "$ref": "#/components/schemas/Domain.ListingAdminService.v1.Model.Price" }, "domainAdId": { "type": "integer", "description": "Domain Advertisement Id, not applicable for creating new ads. Mandatory when updating a listing that belongs to an agency that is in the process of being migrated between listing providers.", "format": "int32" }, "domainAgencyID": { "type": "integer", "description": "The Domain Agency Id number", "format": "int32" }, "providerAdId": { "type": "string", "description": "External Advertisement Id of up to 50 characters will be stored.<br /> This value is used to identify an Advertisement for updates and should be unique for listing provider.<br /> This value is case-insensitive (meaning AAAA will update aaaa)." }, "features": { "type": "string", "description": "Comma-separated list of features. 1000 characters in length. Select as appropriate or write your own. INSIDE: Air conditioning, Ensuite, Floorboards, Indoor Spa, Gym, Alarm System, Intercom, Built in wardrobes, Furnished, Internal Laundry, Pets allowed, Cable or Satellite, Gas, Broadband internet access, Bath, Fireplace(s), Separate Dining Room, Heating, Dishwasher, Study. OUTSIDE: Tennis Court, Secure Parking, Shed, Fully fenced, Balcony / Deck, Garden / Courtyard, Swimming Pool, Outdoor Spa. LOCATION: Ground floor, Water Views, North Facing, City Views. ECO FRIENDLY: Double glazed windows, Energy efficient appliances, Water efficient appliances, Wall / ceiling insulation, Rainwater storage tank, Greywater system, Water efficient fixtures, Solar hot water, Solar panels" }, "description": { "type": "string", "description": "Description of the property. 6000 characters in length. The following HTML elements are permitted: &lt;br /&gt;, &lt;p&gt;&lt;/p&gt;, &amp;nbsp;. HTML must be well-formed. Carriage Returns are interpreted as line breaks. Foreign characters must be HTML encoded, e.g., façade for façade. Unicode characters which are unsupported by Latin-1 (ISO-8859-1 range from U+0080 to U+00FF), will be removed https://en.wikipedia.org/wiki/ISO/IEC_8859-1" }, "summary": { "type": "string", "description": "'Headline' Any HTML stripped out. If the Summary is less than 80 characters long then the description is concatenated to it and the total trimmed to 250 characters." }, "inspectionDetails": { "$ref": "#/components/schemas/Domain.ListingAdminService.v1.Model.InspectionDetails" }, "media": { "type": "array", "items": { "$ref": "#/components/schemas/Domain.ListingAdminService.v1.Model.PropertyMedia" }, "description": "Links to VideoURL, virtual tour or weblink. Maximum length of media URLs is 255 characters." }, "contacts": { "type": "array", "items": { "$ref": "#/components/schemas/Domain.ListingAdminService.v1.Model.Contact" }, "description": "Minimum required attributes: First name, last name and E-mail. If the DomainAgentId is provided, contact information will be based on the existing agent found for that id. Otherwise first name, last name and email will be used to find the matching contact. A new contact will be created if no contact can be found." }, "otherEnquiryEmail": { "type": "string", "description": "Sets an additional Email Address to which enquiries on the Listing will be sent" }, "receiveEmailsToDefaultAddress": { "type": "boolean", "description": "Send email enquiries to the default address for this listing type" }, "isRural": { "type": "boolean", "description": "True if the property is rural" }, "supplementary": { "type": "array", "items": { "$ref": "#/components/schemas/Domain.ListingAdminService.v1.Model.ListingSupplementary" }, "description": "Rural attributes *Improvements* (optional) Available `types` (fixed list, optional): * Machinery Shed * Shearing Shed * Workshop * Shearers Quarters * Silos * Other Housing * Managers Accommodation *Fencing* (optional) `description` (string, optional): free text fencing description, maximum 250 characters. *Yards* (optional) Available `types` (fixed list, optional): * Sheep * Cattle *Homestead* (optional) `description` (string, optional): description of the homestead and construction, maximum 250 characters. `metadata` (optional) * `area` (decimal, optional): homestead area in square metres. Available `types` (fixed list, optional): * Office * Ensuite * Tennis Court * Mains Gas * Floorboards * Internal Laundry *Water* (optional) `description` (string, optional): water comments, maximum 250 characters. Available `types` (fixed list, optional): * Tank * Well * Reticulated * Bores * Springs * Creeks * Dams * River *Crops* (optional) `description` (string, optional): description of the crops, maximum 250 characters. `metadata` (optional) * `croppedAnnually` (decimal, optional): average annual area cropped in hectares. * `fallowAnnually` (decimal, optional): average annual fallow area in hectares. * `pastures` (string, optional): description of pastures available, maximum 250 characters. *Livestock* (optional) `description` (string, optional): additional comments, maximum 250 characters. `metadata` (optional) * `capacity` (decimal, optional): property carrying capacity in DSE (unit of carry capacity). Available `types` (fixed list, optional): * Sheep * Pigs * Cattle * Poultry * Horses * Exotic * Goats * Stud *Inclusions* (optional) `description` (string, optional): description of plant and machinery included in sale, maximum 250 characters. `metadata` (optional) * `livestock` (string, optional): description of livestock included in sale, maximum 250 characters. * `crop` (string, optional): description of crops included in sale, maximum 250 characters. *Irrigation* (optional) `description` (string, optional): irrigation comments, maximum 250 characters `metadata` (optional) * `rainfall` (decimal, optional): annual rainfall in millimetres." } }, "description": "Business Listing" }, "Domain.ListingAdminService.v1.Model.ListingResponse": { "type": "object", "properties": { "processStatus": { "enum": [ "queued", "processing", "processed", "searchable", "failed", "error" ], "type": "string", "description": "Status of listing been processed" }, "id": { "type": "string", "description": "The listing job Id. This job will eventually be processed." }, "agencyId": { "type": "integer", "description": "Agency Id from Domain.", "format": "int32" }, "providerId": { "type": "string", "description": "Provider Id for the agency." }, "providerAdId": { "type": "string", "description": "Listing identifier provided by CRM." }, "versionId": { "type": "string", "description": "Version Id" } }, "description": "Represent the listing job.", "x-data-access-level-info": { "Basic": [ "*" ], "Detailed": [ "*" ], "Full": [ "*" ] } }, "Domain.Public.Adapter.Web.Api.Models.v1.Listings.Business.LocationSearch": { "type": "object", "properties": { "area": { "type": "string", "description": "Location area" }, "postcode": { "type": "string", "description": "Location postcode" }, "region": { "type": "string", "description": "Location region" }, "state": { "enum": [ "act", "nsw", "qld", "vic", "sa", "wa", "nt", "tas" ], "type": "string", "description": "State" }, "suburb": { "type": "string", "description": "Suburb" } }, "description": "Search request location details" }, "Domain.Public.Adapter.Web.Api.Models.v1.Listings.Business.PriceSearch": { "type": "object", "properties": { "min": { "type": "integer", "description": "Minimum price. null - no minimum price limit", "format": "int32" }, "max": { "type": "integer", "description": "Maximum price. null - no maximum price limit", "format": "int32" } }, "description": "Search criteria. Price" }, "Domain.Public.Adapter.Web.Api.Models.v1.Listings.Business.SearchRequest": { "type": "object", "properties": { "pageNumber": { "type": "integer", "description": "", "format": "int32" }, "advertiserId": { "type": "integer", "description": "AdvertiserId e.g. An Agency ID", "format": "int32" }, "propertyTypes": { "type": "array", "items": { "enum": [ "unknown", "accessoriesParts", "accommodationTourism", "accounting", "acreageSemiRural", "adult", "advertisingMarketing", "aerial", "aeronautical", "agedCare", "agricultural", "air", "aircraft", "alarms", "alcoholLiquor", "amusements", "animalRelated", "apartmentUnitFlat", "aquaculture", "aquaticMarineMarinaBerth", "artsCrafts", "autoElectrical", "automotive", "backpackerHostel", "bakery", "barsNightclubs", "beautyHealth", "beautyProducts", "beautySalon", "bedAndBreakfast", "bikeAndMotorcycle", "blockOfUnits", "boardingKennels", "boatsMarineMarinaBerth", "bookkeeping", "brokerage", "builder", "buildingAndConstruction", "bus", "butcher", "cafeCoffeeShop", "car", "carBusTruck", "carDealership", "carRental", "carSpace", "carWash", "caravanPark", "carpenter", "catering", "childCare", "civil", "cleaning", "cleaningAndMaintenance", "clinicalPractice", "clothingAccessories", "clothingFootwear", "communication", "communications", "computerIT", "computerAndInternet", "construction", "convenienceStore", "copyLaminate", "courier", "cropHarvesting", "customs", "dairyFarming", "deli", "dental", "detailing", "developmentLand", "developmentSite", "distributors", "drivingSchools", "duplex", "educationTraining", "educational", "electrical", "employmentRecruitment", "entertainment", "entertainmentTechnology", "export", "farm", "farming", "fertiliser", "finance", "financialServices", "fishingForestry", "floristNursery", "foodBeverage", "foodBeverageHospitality", "franchiseBusinessOpportunities", "freight", "fruitVegFreshProduce", "fruitPicking", "functionCentre", "furnitureTimber", "gambling", "gardenHousehold", "gardenNurseries", "gardening", "glassCeramic", "guestHouseBB", "guesthouse", "hairdresser", "healthBeauty", "healthSpa", "hire", "homeGarden", "homeBased", "newHomeDesigns", "homewareHardware", "hospital", "hotel", "hotelLeisure", "hotelMotelPub", "house", "newHouseLand", "huntingTrap", "import", "importExportWholesale", "industrialManufacturing", "industrialWarehouse", "insemination", "insurance", "internationalNewDevelopment", "internet", "irrigationServices", "juiceBar", "landClearing", "newLand", "landscaping", "laundryDryCleaning", "legal", "leisureEntertainment", "limousineTaxi", "livestock", "internationalCommercial", "machinery", "machineryMetal", "managementRights", "manufacturers", "manufacturingEngineering", "marine", "massage", "mechanicalRepair", "media", "medical", "medicalConsulting", "medicalPractice", "miningEarthMoving", "mobileServices", "motel", "motorcycle", "musicRelated", "mustering", "nails", "naturalTherapies", "newApartments", "newsagency", "nursery", "nursingHome", "offices", "officeSupplies", "oilGas", "onStreet", "panelBeating", "paperPrinting", "parkingCarSpace", "penthouse", "pestRelated", "pharmacies", "plastic", "plumbing", "poolWater", "postOffices", "printPhoto", "professional", "propertyRealEstate", "rail", "recreationSport", "recruitment", "repair", "resort", "restaurant", "retail", "retailer", "retirementVillage", "road", "rural", "ruralCommercialFarming", "scientific", "sea", "security", "semiDetached", "serviceStation", "serviced", "services", "shearing", "showroomsBulkyGoods", "specialistFarm", "sportsComplexGym", "studio", "supermarket", "takeawayFood", "taxi", "terrace", "themePark", "tours", "townhouse", "training", "transportDistribution", "travel", "truck", "vacantLand", "vending", "villa", "water", "welding", "wholesale", "wholesalers", "withShowroomWarehouse", "withinShoppingComplex", "woolClassing", "wreckers", "tattersalls", "servicedOffices", "other", "alcoholGrocery", "cafeRestaurant", "discountStore", "ecoFriendly", "green", "grocery", "specialityRetail", "storage", "travelAgency", "varietyStore", "franchiseNew", "business" ], "type": "string" }, "description": "Listing property types" }, "keywords": { "type": "array", "items": { "type": "string" }, "description": "Search listings by keyword" }, "brandId": { "type": "integer", "description": "The franchise brand ID", "format": "int32" }, "franchiseGroupId": { "type": "integer", "description": "The franchise group ID. A franchise group owns multiple franchise brands.", "format": "int32" }, "locations": { "type": "array", "items": { "$ref": "#/components/schemas/Domain.Public.Adapter.Web.Api.Models.v1.Listings.Business.LocationSearch" }, "description": "Location search criteria" }, "pageSize": { "type": "integer", "description": "Search results page size", "format": "int32" }, "price": { "$ref": "#/components/schemas/Domain.Public.Adapter.Web.Api.Models.v1.Listings.Business.PriceSearch" }, "sort": { "enum": [ "default", "newestFirst", "lowTotalPriceFirst", "hightTotalPriceFirst", "suburbAsc", "suburbDesc" ], "type": "string", "description": "Sorting order" }, "searchMode": { "enum": [ "forSale", "franchiseOpportunity", "franchiseBrand" ], "type": "string", "description": "Search mode" } }, "description": "Represents a CRE Business Search Request" }, "Domain.Public.Adapter.Web.Api.Models.v1.Listings.Business.Ad": { "type": "object", "properties": { "adType": { "type": "string", "description": "Product type" }, "url": { "type": "string", "description": "URL of property details page on CRE website" } }, "description": "Listing details" }, "Domain.Public.Adapter.Web.Api.Models.v1.Listings.Business.AdvertiserImages": { "type": "object", "properties": { "agencyBannerImageUrl": { "type": "string", "description": "Agency branding banner image URL" }, "agencyBannerWideImageUrl": { "type": "string", "description": "Not used" }, "logoUrl": { "type": "string", "description": "Agency logo. Note: CRE has two logo sizes." } }, "description": "Agency images (logos, banners)" }, "Domain.Public.Adapter.Web.Api.Models.v1.Listings.Business.PhoneNumber": { "type": "object", "properties": { "displayLabel": { "type": "string", "description": "Diplay label" }, "type": { "type": "string", "description": "Type: \\\"fax\\\", \\\"mobile\\\", \\\"telephone\\\"" }, "number": { "type": "string", "description": "Phone number" } }, "description": "Phone number details" }, "Domain.Public.Adapter.Web.Api.Models.v1.Listings.Business.Contact": { "type": "object", "properties": { "id": { "type": "integer", "description": "Agent identifier", "format": "int32" }, "firstName": { "type": "string", "description": "First name. Not available in CRE" }, "lastName": { "type": "string", "description": "Last name. Not available in CRE" }, "imageUrl": { "type": "string", "description": "Image URL" }, "displayFullName": { "type": "string", "description": "Full name" }, "phoneNumbers": { "type": "array", "items": { "$ref": "#/components/schemas/Domain.Public.Adapter.Web.Api.Models.v1.Listings.Business.PhoneNumber" }, "description": "Phone numbers" }, "emailAddress": { "type": "string", "description": "E-mail address" }, "address": { "type": "string", "description": "Full address" } }, "description": "Contact" }, "Domain.Public.Adapter.Web.Api.Models.v1.Listings.Business.Advertiser": { "type": "object", "properties": { "address": { "type": "string", "description": "agency address" }, "id": { "type": "integer", "description": "Agency ID", "format": "int32" }, "name": { "type": "string", "description": "Agency Name" }, "preferredColorHex": { "type": "string", "description": "Agency color" }, "images": { "$ref": "#/components/schemas/Domain.Public.Adapter.Web.Api.Models.v1.Listings.Business.AdvertiserImages" }, "contacts": { "type": "array", "items": { "$ref": "#/components/schemas/Domain.Public.Adapter.Web.Api.Models.v1.Listings.Business.Contact" }, "description": "Agency contacts" }, "isConjunctional": { "type": "boolean", "description": "Checks whether advertiser is conjunctional or not" } }, "description": "Agency details" }, "Domain.Public.Adapter.Web.Api.Models.v1.Listings.Business.GeoLocation": { "type": "object", "properties": { "latitude": { "type": "number", "description": "Latitude", "format": "double" }, "longitude": { "type": "number", "description": "Longitude", "format": "double" } }, "description": "Geographic coordinate" }, "Domain.Public.Adapter.Web.Api.Models.v1.Listings.Business.Media": { "type": "object", "properties": { "dateCreated": { "type": "string", "description": "Not used", "format": "date-time" }, "imageUrl": { "type": "string", "description": "Resource URL" }, "mediaType": { "type": "string", "description": "Media type: \\\"image\\\", \\\"video\\\"" }, "type": { "type": "string", "description": "Type: \\\"youtube\\\", \\\"vimeo\\\", \\\"mp4\\\"" }, "videoUrl": { "type": "string", "description": "Video URL" } }, "description": "Listing media" }, "Domain.Public.Adapter.Web.Api.Models.v1.Listings.Business.AddressComponents": { "type": "object", "properties": { "area": { "type": "string", "description": "Listing Area" }, "district": { "type": "string", "description": "Not used" }, "postcode": { "type": "string", "description": "Postcode" }, "region": { "type": "string", "description": "Listing Region" }, "stateShort": { "type": "string", "description": "AUS State. 2 or 3 characters" }, "street": { "type": "string", "description": "Street address" }, "streetNumber": { "type": "string", "description": "Street number" }, "suburb": { "type": "string", "description": "Suburb" }, "unitNumber": { "type": "string", "description": "Unit number" } }, "description": "Address components" }, "Domain.Public.Adapter.Web.Api.Models.v1.Listings.Business.Metadata": { "type": "object", "properties": { "addressComponents": { "$ref": "#/components/schemas/Domain.Public.Adapter.Web.Api.Models.v1.Listings.Business.AddressComponents" } }, "description": "Listing metadata" }, "Domain.Public.Adapter.Web.Api.Models.v1.Listings.Business.Listing": { "type": "object", "properties": { "ad": { "$ref": "#/components/schemas/Domain.Public.Adapter.Web.Api.Models.v1.Listings.Business.Ad" }, "price": { "type": "string", "description": "Formatted listing price" }, "advertiser": { "$ref": "#/components/schemas/Domain.Public.Adapter.Web.Api.Models.v1.Listings.Business.Advertiser" }, "geoLocation": { "$ref": "#/components/schemas/Domain.Public.Adapter.Web.Api.Models.v1.Listings.Business.GeoLocation" }, "propertyArea": { "type": "string", "description": "Building size" }, "propertyType": { "type": "string", "description": "Property type" }, "address": { "type": "string", "description": "Full address" }, "headline": { "type": "string", "description": "Headline" }, "hasVideo": { "type": "boolean", "description": "Has video?" }, "media": { "type": "array", "items": { "$ref": "#/components/schemas/Domain.Public.Adapter.Web.Api.Models.v1.Listings.Business.Media" }, "description": "Media resources for listing (images, video, floor plans)" }, "auctionDate": { "type": "string", "description": "Auction date" }, "id": { "type": "integer", "description": "AdID", "format": "int32" }, "metadata": { "$ref": "#/components/schemas/Domain.Public.Adapter.Web.Api.Models.v1.Listings.Business.Metadata" }, "carspaceCount": { "type": "integer", "description": "Car parking spaces count", "format": "int32" } }, "description": "Listing details for univesal app", "x-data-access-level-info": { "Basic": [ "*" ], "Detailed": [ "*" ], "Full": [ "*" ] } }, "ListingAdmin.v2.SaleInfo": { "required": [ "annualSales", "annualProfit", "stockValue" ], "type": "object", "properties": { "annualSales": { "type": "number", "description": "Annual sales amount for the business", "format": "double" }, "annualProfit": { "type": "number", "description": "Annual profit amount for the business", "format": "double" }, "stockValue": { "type": "number", "description": "Stock value of the business", "format": "double" } }, "description": "Contains details about a business sales info" }, "ListingAdmin.v2.Contact": { "type": "object", "properties": { "domainAgentId": { "type": "integer", "description": "Domain ID of the contact person at the agency", "format": "int32" }, "firstName": { "type": "string", "description": "First name. Maximum 50 characters." }, "lastName": { "type": "string", "description": "Last name. Maximum 50 characters." }, "phone": { "type": "string", "description": "Phone. Maximum 20 characters." }, "fax": { "type": "string", "description": "Fax. Maximum 20 characters." }, "mobile": { "type": "string", "description": "Mobile. Maximum 20 characters." }, "email": { "type": "string", "description": "Email. Maximum 100 characters." }, "receiveEmails": { "type": "boolean", "description": "Indicates whether the contact person should receive emails for the listing" } }, "description": "Contact domain model" }, "ListingAdmin.v2.SoldDetails": { "required": [ "soldType", "soldPrice" ], "type": "object", "properties": { "soldType": { "enum": [ "auction", "privateTreaty", "priorToAuction" ], "type": "string", "description": "Sold Type" }, "soldPrice": { "maximum": 2147483647, "minimum": 0, "type": "integer", "description": "Price property was sold for", "format": "int32" }, "displaySoldPrice": { "type": "boolean", "description": "Indicates how the price will be displayed for free to the general public, default to true if value not provided" } }, "description": "Sold Details" }, "ListingAdmin.v2.LeasedDetails": { "type": "object", "properties": { "leasedPrice": { "maximum": 2147483647, "minimum": 0, "type": "integer", "description": "Optional. The weekly rental price.", "format": "int32" }, "leasedDuration": { "maximum": 2147483647, "minimum": 0, "type": "integer", "description": "The duration of the lease in weeks.", "format": "int32" } }, "description": "Leased Details" }, "ListingAdmin.v2.OffMarketDetailsBase": { "required": [ "offMarketAction", "actionDate" ], "type": "object", "properties": { "offMarketAction": { "enum": [ "withDrawn", "sold", "leased" ], "type": "string", "description": "Off Market Action" }, "actionDate": { "type": "string", "description": "The date property was sold, leased or withdrawn", "format": "date-time" }, "soldDetails": { "$ref": "#/components/schemas/ListingAdmin.v2.SoldDetails" }, "leasedDetails": { "$ref": "#/components/schemas/ListingAdmin.v2.LeasedDetails" }, "comment": { "type": "string", "description": "Extra details for off market action" } }, "description": "Off market details base" }, "ListingAdmin.v2.Parking": { "type": "object", "properties": { "parkingType": { "enum": [ "onSite", "onStreet", "noParking" ], "type": "string", "description": "Can have the value \"OnSite\", \"OnStreet\", \"NoParking\". Default \"NoParking\"" }, "numberOnSite": { "maximum": 2147483647, "minimum": 0, "type": "integer", "description": "Number On Site", "format": "int32" }, "information": { "maxLength": 200, "minLength": 0, "type": "string", "description": "Additional information regarding the parking condition" } }, "description": "Parking Details" }, "ListingAdmin.v2.PropertyMedia": { "required": [ "url" ], "type": "object", "properties": { "resourceType": { "enum": [ "photograph", "floorPlan", "video", "virtualTour", "webLink" ], "type": "string", "description": "Type of the resource" }, "url": { "pattern": "^http[s]?:+.*", "type": "string", "description": "shows the place from where file can be downloaded" } }, "description": "Resource related to the listing" }, "ListingAdmin.v2.GeoLocation": { "type": "object", "properties": { "latitude": { "type": "number", "description": "Latitude", "format": "double" }, "longitude": { "type": "number", "description": "Longitude", "format": "double" } }, "description": "Contains geocoding of an address" }, "ListingAdmin.v2.Address": { "required": [ "street", "suburb", "postcode", "state" ], "type": "object", "properties": { "unitNumber": { "maxLength": 30, "minLength": 0, "type": "string", "description": "Unit number for apartments, maximum 30 characters" }, "street": { "maxLength": 100, "minLength": 0, "type": "string", "description": "Street name, maximum 100 characters" }, "displayOption": { "enum": [ "unspecified", "fullAddress", "streetAndSuburb", "suburbOnly", "regionOnly", "areaOnly", "stateOnly" ], "type": "string", "description": "What granularity to display the properties location at. \r\nFor residential listings, the accepted displayOption values are \"FullAddress\", \"StreetAndSuburb\" or \"SuburbOnly\"." }, "suggestedGeoLocation": { "$ref": "#/components/schemas/ListingAdmin.v2.GeoLocation" }, "streetNumber": { "maxLength": 20, "minLength": 0, "type": "string", "description": "Street number, maximum 20 characters" }, "suburb": { "maxLength": 50, "minLength": 0, "type": "string", "description": "Suburb name , maximum 50 characters" }, "postcode": { "pattern": "^[0-9]{3,4}$", "type": "string", "description": "Postcode" }, "state": { "enum": [ "nsw", "vic", "act", "sa", "wa", "tas", "qld", "nt" ], "type": "string", "description": "State" } }, "description": "Address structure for property" }, "ListingAdmin.v2.Area": { "type": "object", "properties": { "value": { "maximum": 2147483647, "minimum": 0, "type": "number", "description": "Area. Will be rounded to 2 decimals.", "format": "double" }, "from": { "maximum": 2147483647, "minimum": 0, "type": "number", "description": "Minimum area", "format": "double" }, "to": { "maximum": 2147483647, "minimum": 0, "type": "number", "description": "Maximum area", "format": "double" }, "unit": { "enum": [ "squareMetres", "acres", "hectares", "squareFeet", "squareYards", "squares" ], "type": "string", "description": "Unit of measure, defaults to SquareMetres if not provided." } }, "description": "Area information, Either single value or from and To must be provided" }, "ListingAdmin.v2.LandArea": { "required": [ "unit" ], "type": "object", "properties": { "unit": { "enum": [ "squareMetres", "acres", "hectares", "squareFeet", "squareYards", "squares" ], "type": "string", "description": "Unit of measure" }, "value": { "maximum": 2147483647, "minimum": 0, "type": "number", "description": "Area. Will be rounded to 2 decimals.", "format": "double" }, "from": { "maximum": 2147483647, "minimum": 0, "type": "number", "description": "Minimum area", "format": "double" }, "to": { "maximum": 2147483647, "minimum": 0, "type": "number", "description": "Maximum area", "format": "double" } }, "description": "Area information, Either single value or from and To must be provided" }, "ListingAdmin.v2.BusinessOffMarketProperty": { "required": [ "propertyType", "address" ], "type": "object", "properties": { "propertyType": { "type": "array", "items": { "enum": [ "accessoriesParts", "accommodationTourism", "accounting", "adult", "advertisingMarketing", "aerial", "aeronautical", "agedCare", "agricultural", "air", "aircraft", "alarms", "alcoholLiquor", "amusements", "animalRelated", "aquaculture", "aquaticMarineMarinaBerth", "artsCrafts", "autoElectrical", "automotive", "backpackerHostel", "bakery", "barsNightclubs", "beautyHealth", "beautyProducts", "beautySalon", "bikeAndMotorcycle", "boardingKennels", "boatsMarineMarinaBerth", "bookkeeping", "brokerage", "builder", "buildingAndConstruction", "bus", "butcher", "cafeCoffeeShop", "car", "carBusTruck", "carDealership", "carRental", "carWash", "caravanPark", "carpenter", "catering", "childCare", "civil", "cleaning", "cleaningAndMaintenance", "clinicalPractice", "clothingAccessories", "clothingFootwear", "communication", "communications", "computerIT", "computerAndInternet", "construction", "convenienceStore", "copyLaminate", "courier", "cropHarvesting", "customs", "dairyFarming", "deli", "dental", "detailing", "distributors", "drivingSchools", "educationTraining", "educational", "electrical", "employmentRecruitment", "entertainment", "entertainmentTechnology", "export", "farming", "fertiliser", "finance", "financialServices", "fishingForestry", "floristNursery", "foodBeverage", "foodBeverageHospitality", "franchiseBusinessOpportunities", "freight", "fruitVegFreshProduce", "fruitPicking", "functionCentre", "furnitureTimber", "gambling", "gardenHousehold", "gardenNurseries", "gardening", "glassCeramic", "guestHouseBB", "hairdresser", "healthBeauty", "healthSpa", "hire", "homeGarden", "homeBased", "homewareHardware", "hospital", "hotel", "huntingTrap", "import", "importExportWholesale", "industrialManufacturing", "insemination", "insurance", "internet", "irrigationServices", "juiceBar", "landClearing", "landscaping", "laundryDryCleaning", "legal", "leisureEntertainment", "limousineTaxi", "livestock", "machinery", "machineryMetal", "managementRights", "manufacturers", "manufacturingEngineering", "marine", "massage", "mechanicalRepair", "media", "medical", "medicalPractice", "miningEarthMoving", "mobileServices", "motel", "motorcycle", "musicRelated", "mustering", "nails", "naturalTherapies", "newsagency", "nursery", "nursingHome", "officeSupplies", "oilGas", "panelBeating", "paperPrinting", "parkingCarSpace", "pestRelated", "pharmacies", "plastic", "plumbing", "poolWater", "postOffices", "printPhoto", "professional", "propertyRealEstate", "rail", "recreationSport", "recruitment", "repair", "resort", "restaurant", "retail", "retailer", "retirement", "retirementVillage", "road", "rural", "scientific", "sea", "security", "serviceStation", "services", "shearing", "sportsComplexGym", "supermarket", "takeawayFood", "taxi", "themePark", "tours", "training", "transportDistribution", "travel", "truck", "vending", "water", "welding", "wholesale", "wholesalers", "woolClassing", "wreckers", "alcoholGrocery", "cafeRestaurant", "discountStore", "ecoFriendly", "green", "grocery", "specialityRetail", "storage", "travelAgency", "varietyStore", "chickenShop", "seafoodShop", "deliCafe", "cropping", "viticulture", "grazing", "horticulture", "equine", "farmlet", "orchard", "ruralLifestyle", "onlineBusiness" ], "type": "string" }, "description": "Business property types ['accessoriesParts', 'accommodationTourism', 'accounting', 'adult', 'advertisingMarketing', 'aerial', 'aeronautical', 'agedCare', 'agricultural', 'air', 'aircraft', 'alarms', 'alcoholLiquor', 'amusements', 'animalRelated', 'aquaculture', 'aquaticMarineMarinaBerth', 'artsCrafts', 'autoElectrical', 'automotive', 'backpackerHostel', 'bakery', 'barsNightclubs', 'beautyHealth', 'beautyProducts', 'beautySalon', 'bikeAndMotorcycle', 'boardingKennels', 'boatsMarineMarinaBerth', 'bookkeeping', 'brokerage', 'builder', 'buildingAndConstruction', 'bus', 'butcher', 'cafeCoffeeShop', 'car', 'carBusTruck', 'carDealership', 'carRental', 'carWash', 'caravanPark', 'carpenter', 'catering', 'childCare', 'civil', 'cleaning', 'cleaningAndMaintenance', 'clinicalPractice', 'clothingAccessories', 'clothingFootwear', 'communication', 'communications', 'computerIT', 'computerAndInternet', 'construction', 'convenienceStore', 'copyLaminate', 'courier', 'cropHarvesting', 'customs', 'dairyFarming', 'deli', 'dental', 'detailing', 'distributors', 'drivingSchools', 'educationTraining', 'educational', 'electrical', 'employmentRecruitment', 'entertainment', 'entertainmentTechnology', 'export', 'farming', 'fertiliser', 'finance', 'financialServices', 'fishingForestry', 'floristNursery', 'foodBeverage', 'foodBeverageHospitality', 'franchiseBusinessOpportunities', 'freight', 'fruitVegFreshProduce', 'fruitPicking', 'functionCentre', 'furnitureTimber', 'gambling', 'gardenHousehold', 'gardenNurseries', 'gardening', 'glassCeramic', 'guestHouseBB', 'hairdresser', 'healthBeauty', 'healthSpa', 'hire', 'homeGarden', 'homeBased', 'homewareHardware', 'hospital', 'hotel', 'huntingTrap', 'import', 'importExportWholesale', 'industrialManufacturing', 'insemination', 'insurance', 'internet', 'irrigationServices', 'juiceBar', 'landClearing', 'landscaping', 'laundryDryCleaning', 'legal', 'leisureEntertainment', 'limousineTaxi', 'livestock', 'machinery', 'machineryMetal', 'managementRights', 'manufacturers', 'manufacturingEngineering', 'marine', 'massage', 'mechanicalRepair', 'media', 'medical', 'medicalPractice', 'miningEarthMoving', 'mobileServices', 'motel', 'motorcycle', 'musicRelated', 'mustering', 'nails', 'naturalTherapies', 'newsagency', 'nursery', 'nursingHome', 'officeSupplies', 'oilGas', 'panelBeating', 'paperPrinting', 'parkingCarSpace', 'pestRelated', 'pharmacies', 'plastic', 'plumbing', 'poolWater', 'postOffices', 'printPhoto', 'professional', 'propertyRealEstate', 'rail', 'recreationSport', 'recruitment', 'repair', 'resort', 'restaurant', 'retail', 'retailer', 'retirement', 'retirementVillage', 'road', 'rural', 'scientific', 'sea', 'security', 'serviceStation', 'services', 'shearing', 'sportsComplexGym', 'supermarket', 'takeawayFood', 'taxi', 'themePark', 'tours', 'training', 'transportDistribution', 'travel', 'truck', 'vending', 'water', 'welding', 'wholesale', 'wholesalers', 'woolClassing', 'wreckers', 'alcoholGrocery', 'cafeRestaurant', 'discountStore', 'ecoFriendly', 'green', 'grocery', 'specialityRetail', 'storage', 'travelAgency', 'varietyStore', 'chickenShop', 'seafoodShop', 'deliCafe', 'cropping', 'viticulture', 'grazing', 'horticulture', 'equine', 'farmlet', 'orchard', 'ruralLifestyle', 'onlineBusiness']." }, "parking": { "$ref": "#/components/schemas/ListingAdmin.v2.Parking" }, "images": { "type": "array", "items": { "$ref": "#/components/schemas/ListingAdmin.v2.PropertyMedia" }, "description": "List of image files, photos or floor plans related to the listing.\r\nSupported image file formats: AVIF, BMP, GIF, HEIF/HEIC, JPEG, JPEG 2000, PNG, TIFF, WebP.\r\nThe file size is restricted to maximum 100MB.\r\nWe recommend against using transparent backgrounds.\r\nSome image formats, such as PNG, support transparency, but when images with transparent areas are resized, they may be converted to a format that doesn’t support transparency, such as JPEG.\r\nBy default, transparent areas are converted to black, but the application displaying the image may convert the transparent area to the most appropriate colour for the area where the image is being placed." }, "address": { "$ref": "#/components/schemas/ListingAdmin.v2.Address" }, "area": { "$ref": "#/components/schemas/ListingAdmin.v2.Area" }, "landArea": { "$ref": "#/components/schemas/ListingAdmin.v2.LandArea" } }, "description": "Business off market property" }, "ListingAdmin.v2.BusinessOffMarketListing": { "required": [ "domainAgencyID", "providerAdId", "listingAction", "offMarketDetails", "propertyDetails" ], "type": "object", "properties": { "saleInfo": { "$ref": "#/components/schemas/ListingAdmin.v2.SaleInfo" }, "listingProvider": { "type": "string", "description": "A string identifying the data provider" }, "domainAgencyID": { "maximum": 2147483647, "minimum": 0, "type": "integer", "description": "The Domain Agency ID", "format": "int32" }, "providerAdId": { "maxLength": 50, "minLength": 0, "type": "string", "description": "External Advertisement Id of up to 50 characters will be stored.
\r\nThis value is used to identify an Advertisement for updates and should be unique for listing provider.
\r\nThis value is case-insensitive (meaning AAAA will update aaaa)." }, "description": { "maxLength": 6000, "minLength": 0, "type": "string", "description": "Description of the property.\r\n6000 characters in length. The following HTML elements are permitted: <br />, <p></p>, &nbsp;. HTML must be well-formed.\r\nCarriage Returns are interpreted as line breaks. Foreign characters must be HTML encoded, e.g., façade for façade.\r\nUnicode characters which are unsupported by Latin-1 (ISO-8859-1 range from U+0080 to U+00FF), will be removed https://en.wikipedia.org/wiki/ISO/IEC_8859-1" }, "summary": { "maxLength": 250, "minLength": 0, "type": "string", "description": "'Headline' Any HTML stripped out. If the Summary is less than 80 characters long then the description is concatenated to it and the total trimmed to 250 characters." }, "contacts": { "type": "array", "items": { "$ref": "#/components/schemas/ListingAdmin.v2.Contact" }, "description": "Minimum required attributes: First name, last name and E-mail.\r\nIf the DomainAgentId is provided, contact information will be based on the existing agent found for that id.\r\nOtherwise first name, last name and email will be used to find the matching contact. A new contact will be created if no contact can be found." }, "listingAction": { "enum": [ "sale", "rent" ], "type": "string", "description": "Sale or Rent" }, "offMarketDetails": { "$ref": "#/components/schemas/ListingAdmin.v2.OffMarketDetailsBase" }, "propertyDetails": { "$ref": "#/components/schemas/ListingAdmin.v2.BusinessOffMarketProperty" } }, "description": "Business off market listing" }, "ListingAdmin.v2.ListingResponse": { "type": "object", "properties": { "id": { "type": "string", "description": "The listing job Id. \r\nThis job will eventually be processed." }, "agencyId": { "type": "integer", "description": "Agency Id from Domain.", "format": "int32" }, "providerId": { "type": "string", "description": "Provider Id for the agency." }, "providerAdId": { "type": "string", "description": "Listing identifier provided by CRM." }, "versionId": { "type": "string", "description": "Version Id" }, "processStatus": { "enum": [ "queued", "processing", "processed", "searchable", "failed", "error" ], "type": "string", "description": "Status of listing been processed" } }, "description": "Represent the listing job." }, "ListingAdmin.v2.CommercialPrice": { "required": [ "from", "to" ], "type": "object", "properties": { "priceUnitType": { "enum": [ "totalAmount", "perSqm" ], "type": "string", "description": "Price Unit type. Can have the values \"TotalAmount\", \"PerSqm\". Default = \"TotalAmount\"" }, "priceType": { "enum": [ "gross", "net" ], "type": "string", "description": "Type can have the values \"Gross\", \"Net\". Default \"Net\"" }, "gstOptionType": { "enum": [ "nA", "inc", "ex" ], "type": "string", "description": "GST Option Type. Can have the values \"NA\", \"Inc\", \"Ex\". Default = \"NA\"" }, "priceReduction": { "type": "boolean", "description": "Indicates if this property is under price reduction" }, "displayText": { "maxLength": 80, "minLength": 0, "type": "string", "description": "When provided this will be shown instead of the price range, e.g.: \"Offers over $450K considered\"" }, "depositTaken": { "type": "boolean", "description": "When provided this will be shown instead of the price range, e.g.: \"Offers over $450K considered\"" }, "from": { "maximum": 2147483647, "minimum": 0, "type": "integer", "description": "Lowest price the property is expected to sell/rent for to set search price. For a fixed price, set this value the same as To", "format": "int32" }, "to": { "maximum": 2147483647, "minimum": 0, "type": "integer", "description": "Highest price the property is expected to sell/rent for to set search price. \r\nFor a fixed price, set this value the same as From", "format": "int32" } }, "description": "Commercial component for price" }, "ListingAdmin.v2.Lease": { "type": "object", "properties": { "termOfLeaseFrom": { "maximum": 2147483647, "minimum": 0, "type": "integer", "description": "Integer value of lease term range from", "format": "int32" }, "termOfLeaseTo": { "maximum": 2147483647, "minimum": 0, "type": "integer", "description": "Integer value of lease term range to", "format": "int32" }, "leaseOutgoings": { "maximum": 2147483647, "minimum": 0, "type": "integer", "description": "Outgoing cost of current lease", "format": "int32" } }, "description": "Properties for lease listings" }, "ListingAdmin.v2.EOI": { "required": [ "endDate" ], "type": "object", "properties": { "address": { "maxLength": 100, "minLength": 0, "type": "string", "description": "Street address, up to 100 characters" }, "endDate": { "type": "string", "description": "End date of EOI", "format": "date-time" }, "recipientName": { "maxLength": 50, "minLength": 0, "type": "string", "description": "The recipient name of the EOI, up to 50 characters" } }, "description": "Express of Interest" }, "ListingAdmin.v2.Tenant": { "type": "object", "properties": { "leaseStart": { "type": "string", "description": "The date on which the tenants lease began, or is due to begin.", "format": "date-time" }, "leaseEnd": { "type": "string", "description": "The date on which the tenants lease is due to end", "format": "date-time" }, "name": { "maxLength": 100, "minLength": 0, "type": "string", "description": "Name of the current tenant of the property, up to 100 characters" }, "rentalDetails": { "maxLength": 100, "minLength": 0, "type": "string", "description": "Information regarding current rental, up to 100 characters" }, "leaseOptions": { "maxLength": 100, "minLength": 0, "type": "string", "description": "Leasing options available to a prospective tenant, up to 100 characters" }, "tenantInfoTermOfLeaseFrom": { "maximum": 2147483647, "minimum": 0, "type": "integer", "description": "The from range of the tenant's current lease", "format": "int32" }, "tenantInfoTermOfLeaseTo": { "maximum": 2147483647, "minimum": 0, "type": "integer", "description": "The to range of the tenant's current lease", "format": "int32" }, "leaseDateVariable": { "type": "boolean", "description": "Is tenant lease date variable" } }, "description": "Tenant Information" }, "ListingAdmin.v2.Tender": { "type": "object", "properties": { "recipientName": { "maxLength": 50, "minLength": 0, "type": "string", "description": "The recipient name of the tender, up to 50 characters" }, "address": { "maxLength": 100, "minLength": 0, "type": "string", "description": "Street address, up to 100 characters." }, "endDate": { "type": "string", "description": "Closing Date", "format": "date-time" } }, "description": "Tender Information" }, "ListingAdmin.v2.SpecificUnitDetail": { "type": "object", "properties": { "name": { "maxLength": 15, "minLength": 0, "type": "string", "description": "Unit number" }, "size": { "type": "integer", "description": "Unit size", "format": "int32" }, "price": { "type": "number", "description": "Unit price", "format": "double" }, "notes": { "maxLength": 70, "minLength": 0, "type": "string", "description": "Additional notes" }, "isSoldOrLeased": { "type": "boolean", "description": "Is it available?" }, "occupancy": { "enum": [ "tenanted", "vacant" ], "type": "string", "description": "Occupancy type" }, "priceUnit": { "enum": [ "totalAmount", "perSqm" ], "type": "string", "description": "Price unit type" }, "leasePriceForSaleorLease": { "type": "number", "description": "Lease price for sale or lease", "format": "double" } }, "description": "offered units details" }, "ListingAdmin.v2.CommercialAuction": { "required": [ "dateTime" ], "type": "object", "properties": { "auctionTerms": { "maxLength": 200, "minLength": 0, "type": "string", "description": "Terms for the auctions, up to 200 characters. Example: \"10% deposit, balance 60 days\"" }, "dateTime": { "type": "string", "description": "Date of the auction. format: yyyy-MM-ddTHH:mm:ss", "format": "date-time" }, "location": { "maxLength": 100, "minLength": 0, "type": "string", "description": "Optional. Venue for the Auction. String max 100 characters. If the Location is omitted, or included but empty, the Venue will default to \"On Site\"." }, "url": { "pattern": "^http[s]?:+.*", "type": "string", "description": "Optional on-line auction URL. Must be a valid URL and maximum 255 characters. If an empty string is received, the property will be re-set." } }, "description": "Commercial Auction Details" }, "ListingAdmin.v2.PropertyPdf": { "required": [ "url" ], "type": "object", "properties": { "url": { "pattern": "^http[s]?:+.*", "type": "string", "description": "Url of the PDF" }, "type": { "enum": [ "commercialPdf", "newDevBrochurePdf", "floorplanPdf", "devProjectPdf", "devProjectMasterplanPdf" ], "type": "string", "description": "Type of the PDF. `DevProjectPdf` PDF files are only visible, if the listing is a child listing of an active development project." }, "description": { "maxLength": 255, "minLength": 0, "type": "string", "description": "Description of the PDF" } }, "description": "PDF file related to the listing" }, "ListingAdmin.v2.CommercialProperty": { "required": [ "propertyType", "address" ], "type": "object", "properties": { "propertyType": { "type": "array", "items": { "enum": [ "aquaculture", "dairyFarming", "developmentLand", "fishingForestry", "hotelLeisure", "industrialWarehouse", "irrigationServices", "livestock", "internationalCommercial", "medicalConsulting", "offices", "parkingCarSpace", "retail", "ruralCommercialFarming", "showroomsBulkyGoods", "servicedOffices", "other", "cropping", "viticulture", "mixedFarming", "grazing", "horticulture", "equine", "farmlet", "orchard", "ruralLifestyle" ], "type": "string" }, "description": "Commercial property types ['aquaculture', 'dairyFarming', 'developmentLand', 'fishingForestry', 'hotelLeisure', 'industrialWarehouse', 'irrigationServices', 'livestock', 'internationalCommercial', 'medicalConsulting', 'offices', 'parkingCarSpace', 'retail', 'ruralCommercialFarming', 'showroomsBulkyGoods', 'servicedOffices', 'other', 'cropping', 'viticulture', 'mixedFarming', 'grazing', 'horticulture', 'equine', 'farmlet', 'orchard', 'ruralLifestyle']." }, "buildingType": { "enum": [ "whole", "part", "nA" ], "type": "string", "description": "Building Type" }, "parking": { "$ref": "#/components/schemas/ListingAdmin.v2.Parking" }, "pdfs": { "type": "array", "items": { "$ref": "#/components/schemas/ListingAdmin.v2.PropertyPdf" }, "description": "List of PDF files related to the listing" }, "propertyName": { "maxLength": 70, "minLength": 0, "type": "string", "description": "Name of the property up to 70 characters" }, "location": { "maxLength": 30, "minLength": 0, "type": "string", "description": "Short location information up to 30 character, e.g.: Greenhills Beach" }, "images": { "type": "array", "items": { "$ref": "#/components/schemas/ListingAdmin.v2.PropertyMedia" }, "description": "List of image files, photos or floor plans related to the listing.\r\nSupported image file formats: AVIF, BMP, GIF, HEIF/HEIC, JPEG, JPEG 2000, PNG, TIFF, WebP.\r\nThe file size is restricted to maximum 100MB.\r\nWe recommend against using transparent backgrounds.\r\nSome image formats, such as PNG, support transparency, but when images with transparent areas are resized, they may be converted to a format that doesn’t support transparency, such as JPEG.\r\nBy default, transparent areas are converted to black, but the application displaying the image may convert the transparent area to the most appropriate colour for the area where the image is being placed." }, "address": { "$ref": "#/components/schemas/ListingAdmin.v2.Address" }, "area": { "$ref": "#/components/schemas/ListingAdmin.v2.Area" }, "landArea": { "$ref": "#/components/schemas/ListingAdmin.v2.LandArea" } }, "description": "Commercial Property" }, "ListingAdmin.v2.AgentContact": { "required": [ "agencyId" ], "type": "object", "properties": { "agencyId": { "type": "integer", "description": "Conjunction agent's agency", "format": "int32" }, "domainAgentId": { "type": "integer", "description": "Domain ID of the contact person at the agency", "format": "int32" }, "firstName": { "type": "string", "description": "First name. Maximum 50 characters." }, "lastName": { "type": "string", "description": "Last name. Maximum 50 characters." }, "phone": { "type": "string", "description": "Phone. Maximum 20 characters." }, "fax": { "type": "string", "description": "Fax. Maximum 20 characters." }, "mobile": { "type": "string", "description": "Mobile. Maximum 20 characters." }, "email": { "type": "string", "description": "Email. Maximum 100 characters." }, "receiveEmails": { "type": "boolean", "description": "Indicates whether the contact person should receive emails for the listing" } }, "description": "Represents a agent or conjunction agent domain model\r\nThe only difference to normal contacts is agent contacts needs to have their agency specified" }, "ListingAdmin.v2.Inspection": { "required": [ "from", "to" ], "type": "object", "properties": { "from": { "type": "string", "description": "Format: yyyy-mm-dd HH:mm:ss eg: 2015-10-20 13:30:00", "format": "date-time" }, "to": { "type": "string", "description": "Format: yyyy-mm-dd HH:mm:ss, eg: 2015-10-20 14:30:00", "format": "date-time" }, "repeat": { "type": "boolean", "description": "Specifies if the inspection is recurring weekly" } }, "description": "Inspection times" }, "ListingAdmin.v2.InspectionDetails": { "type": "object", "properties": { "inspectionDescription": { "maxLength": 500, "minLength": 0, "type": "string", "description": "Free text field for inspections" }, "inspections": { "type": "array", "items": { "$ref": "#/components/schemas/ListingAdmin.v2.Inspection" }, "description": "Inspection times of the listing" } }, "description": "Inspection details" }, "ListingAdmin.v2.SupplementaryMetadata": { "required": [ "name" ], "type": "object", "properties": { "name": { "maxLength": 250, "minLength": 0, "type": "string", "description": "Name" }, "description": { "maxLength": 250, "minLength": 0, "type": "string", "description": "Description" }, "measurement": { "maximum": 2147483647, "minimum": 0, "type": "number", "description": "Measurement", "format": "double" }, "measurementUnit": { "enum": [ "squareMetres", "hectares", "millimetres", "dse" ], "type": "string", "description": "Measurement unit" } }, "description": "Supplementary metadata" }, "ListingAdmin.v2.ListingSupplementary": { "required": [ "name" ], "type": "object", "properties": { "name": { "maxLength": 250, "minLength": 0, "type": "string", "description": "Name" }, "description": { "maxLength": 250, "minLength": 0, "type": "string", "description": "Description" }, "types": { "type": "array", "items": { "type": "string" }, "description": "Types" }, "metadata": { "type": "array", "items": { "$ref": "#/components/schemas/ListingAdmin.v2.SupplementaryMetadata" }, "description": "Metadata" } }, "description": "Listing supplementary" }, "ListingAdmin.v2.CommercialListingV2": { "required": [ "propertyDetails", "domainAgencyID", "providerAdId", "listingAction" ], "type": "object", "properties": { "salePrice": { "$ref": "#/components/schemas/ListingAdmin.v2.CommercialPrice" }, "leasePrice": { "$ref": "#/components/schemas/ListingAdmin.v2.CommercialPrice" }, "lease": { "$ref": "#/components/schemas/ListingAdmin.v2.Lease" }, "eoi": { "$ref": "#/components/schemas/ListingAdmin.v2.EOI" }, "tenant": { "$ref": "#/components/schemas/ListingAdmin.v2.Tenant" }, "tender": { "$ref": "#/components/schemas/ListingAdmin.v2.Tender" }, "occupancyType": { "enum": [ "tenanted", "vacant" ], "type": "string", "description": "Occupancy. Can be 'Tenanted', 'Vacant'" }, "annualReturn": { "type": "integer", "description": "Integer value of percentage return on this property or business.", "format": "int32" }, "unitsOffered": { "maximum": 2147483647, "minimum": 0, "type": "integer", "description": "Integer value of units offered for sale or lease", "format": "int32" }, "unitDetails": { "type": "array", "items": { "$ref": "#/components/schemas/ListingAdmin.v2.SpecificUnitDetail" }, "description": "Units details" }, "nabers": { "maximum": 6, "minimum": 0, "type": "number", "description": "The NABERS Rating is the energy efficiency rating that the property has been measured to have. \r\nThis rating is measured in increments of .5 and can range from 0 to 6. \r\nThe NABERS rating is required for spaces within office buildings of 1000 square metres or more.\r\nFor more information on the NABERS rating system please visit http://www.nabers.gov.au", "format": "double" }, "saleTerms": { "maxLength": 50, "minLength": 0, "type": "string", "description": "Information relating to aspects of the sale, such as required deposit, settlement time. Up to 50 characters, optional. Ignored for lease listings" }, "auction": { "$ref": "#/components/schemas/ListingAdmin.v2.CommercialAuction" }, "propertyDetails": { "$ref": "#/components/schemas/ListingAdmin.v2.CommercialProperty" }, "conjunctionAgents": { "type": "array", "items": { "$ref": "#/components/schemas/ListingAdmin.v2.AgentContact" }, "description": "List of conjunction agents" }, "highlights": { "type": "array", "items": { "type": "string" }, "description": "Highlight Items" }, "underOfferOrContract": { "type": "boolean", "description": "Set for Sale listings only" }, "domainAdId": { "maximum": 2147483647, "minimum": 0, "type": "integer", "description": "Domain Advertisement Id, not applicable for creating new ads.\r\nMandatory when updating a listing that belongs to an agency that\r\nis in the process of being migrated between listing providers.", "format": "int32" }, "listingProvider": { "type": "string", "description": "A string identifying the data provider" }, "domainAgencyID": { "maximum": 2147483647, "minimum": 0, "type": "integer", "description": "The Domain Agency Id number", "format": "int32" }, "providerAdId": { "maxLength": 50, "minLength": 0, "type": "string", "description": "External Advertisement Id of up to 50 characters will be stored.
\r\nThis value is used to identify an Advertisement for updates and should be unique for listing provider.
\r\nThis value is case-insensitive (meaning AAAA will update aaaa)." }, "features": { "maxLength": 1000, "minLength": 0, "type": "string", "description": " Comma-separated list of features. 1000 characters in length. Select as appropriate or write your own.\r\nINSIDE: Air conditioning, Ensuite, Floorboards, Indoor Spa, Gym, Alarm System, Intercom, Built in wardrobes, Furnished, Internal Laundry, Pets allowed, Cable or Satellite, Gas, Broadband internet access, Bath, Fireplace(s), Separate Dining Room, Heating, Dishwasher, Study.\r\nOUTSIDE: Tennis Court, Secure Parking, Shed, Fully fenced, Balcony / Deck, Garden / Courtyard, Swimming Pool, Outdoor Spa.\r\nLOCATION: Ground floor, Water Views, North Facing, City Views.\r\nECO FRIENDLY: Double glazed windows, Energy efficient appliances, Water efficient appliances, Wall / ceiling insulation, Rainwater storage tank, Greywater system, Water efficient fixtures, Solar hot water, Solar panels" }, "description": { "maxLength": 6000, "minLength": 0, "type": "string", "description": "Description of the property.\r\n6000 characters in length. The following HTML elements are permitted: <br />, <p></p>, &nbsp;. HTML must be well-formed.\r\nCarriage Returns are interpreted as line breaks. Foreign characters must be HTML encoded, e.g., façade for façade.\r\nUnicode characters which are unsupported by Latin-1 (ISO-8859-1 range from U+0080 to U+00FF), will be removed https://en.wikipedia.org/wiki/ISO/IEC_8859-1" }, "summary": { "maxLength": 250, "minLength": 0, "type": "string", "description": "'Headline' Any HTML stripped out. If the Summary is less than 80 characters long then the description is concatenated to it and the total trimmed to 250 characters." }, "inspectionDetails": { "$ref": "#/components/schemas/ListingAdmin.v2.InspectionDetails" }, "media": { "type": "array", "items": { "$ref": "#/components/schemas/ListingAdmin.v2.PropertyMedia" }, "description": "Links to VideoURL, virtual tour or weblink. Maximum length of media URLs is 255 characters." }, "listingAction": { "enum": [ "sale", "rent", "saleAndLease" ], "type": "string", "description": "Sale or Rent" }, "contactPreference": { "enum": [ "byPhone" ], "type": "string", "description": "Indicates the listing preferred contact method. Default by both phone and email if not provided." }, "contacts": { "type": "array", "items": { "$ref": "#/components/schemas/ListingAdmin.v2.Contact" }, "description": "Minimum required attributes: First name, last name and E-mail.\r\nIf the DomainAgentId is provided, contact information will be based on the existing agent found for that id.\r\nOtherwise first name, last name and email will be used to find the matching contact. A new contact will be created if no contact can be found." }, "otherEnquiryEmail": { "type": "string", "description": "Sets up to 3 additional email addresses, separated by commas, to which enquiries on the listing will be sent." }, "receiveEmailsToDefaultAddress": { "type": "boolean", "description": "Send email enquiries to the default address for this listing type" }, "isRural": { "type": "boolean", "description": "True if the property is rural" }, "supplementary": { "type": "array", "items": { "$ref": "#/components/schemas/ListingAdmin.v2.ListingSupplementary" }, "description": "Rural attributes\r\n\r\n*Improvements* (optional)\r\n\r\nAvailable `types` (fixed list, optional):\r\n* Machinery Shed\r\n* Shearing Shed\r\n* Workshop\r\n* Shearers Quarters\r\n* Silos\r\n* Other Housing\r\n* Managers Accommodation\r\n\r\n*Fencing* (optional)\r\n\r\n`description` (string, optional): free text fencing description, maximum 250 characters.\r\n\r\n*Yards* (optional)\r\n\r\nAvailable `types` (fixed list, optional):\r\n* Sheep\r\n* Cattle\r\n\r\n*Homestead* (optional)\r\n\r\n`description` (string, optional): description of the homestead and construction, maximum 250 characters.\r\n\r\n`metadata` (optional)\r\n* `area` (decimal, optional): homestead area in square metres.\r\n\r\nAvailable `types` (fixed list, optional):\r\n* Office\r\n* Ensuite\r\n* Tennis Court\r\n* Mains Gas\r\n* Floorboards\r\n* Internal Laundry\r\n\r\n*Water* (optional)\r\n\r\n`description` (string, optional): water comments, maximum 250 characters.\r\n\r\nAvailable `types` (fixed list, optional):\r\n* Tank\r\n* Well\r\n* Reticulated\r\n* Bores\r\n* Springs\r\n* Creeks\r\n* Dams\r\n* River\r\n\r\n*Crops* (optional)\r\n\r\n`description` (string, optional): description of the crops, maximum 250 characters.\r\n\r\n`metadata` (optional)\r\n* `croppedAnnually` (decimal, optional): average annual area cropped in hectares.\r\n* `fallowAnnually` (decimal, optional): average annual fallow area in hectares.\r\n* `pastures` (string, optional): description of pastures available, maximum 250 characters.\r\n\r\n*Livestock* (optional)\r\n\r\n`description` (string, optional): additional comments, maximum 250 characters.\r\n\r\n`metadata` (optional)\r\n* `capacity` (decimal, optional): property carrying capacity in DSE (unit of carry capacity).\r\n\r\nAvailable `types` (fixed list, optional):\r\n* Sheep\r\n* Pigs\r\n* Cattle\r\n* Poultry\r\n* Horses\r\n* Exotic\r\n* Goats\r\n* Stud\r\n\r\n*Inclusions* (optional)\r\n\r\n`description` (string, optional): description of plant and machinery included in sale, maximum 250 characters.\r\n\r\n`metadata` (optional)\r\n* `livestock` (string, optional): description of livestock included in sale, maximum 250 characters.\r\n* `crop` (string, optional): description of crops included in sale, maximum 250 characters.\r\n\r\n*Irrigation* (optional)\r\n\r\n`description` (string, optional): irrigation comments, maximum 250 characters\r\n\r\n`metadata` (optional)\r\n* `rainfall` (decimal, optional): annual rainfall in millimetres." } }, "description": "Commercial Listing V2", "example": { "salePrice": { "priceUnitType": "totalAmount", "priceType": "gross", "gstOptionType": "ex", "priceReduction": true, "displayText": "Price Guide $2,200,000", "depositTaken": false, "from": 2200000, "to": 2200000 }, "leasePrice": { "priceUnitType": "totalAmount", "priceType": "gross", "gstOptionType": "ex", "priceReduction": true, "displayText": "Price Guide $2,200", "depositTaken": false, "from": 2200, "to": 2200 }, "lease": { "termOfLeaseFrom": 1, "termOfLeaseTo": 3, "leaseOutgoings": 3200 }, "tenant": { "leaseStart": "2025-05-08T21:08:47.7658790+10:00", "leaseEnd": "2026-05-08T21:08:47.7658790+10:00", "name": "John Smith", "rentalDetails": "Annual CPI reviews", "leaseOptions": "5+5 year lease which commenced May 2013", "tenantInfoTermOfLeaseFrom": 2, "tenantInfoTermOfLeaseTo": 3, "leaseDateVariable": false }, "tender": { "recipientName": "Joe Russ", "address": "10,Pyrmont st, Pyrmont,NSW 2011", "endDate": "2026-04-18T21:08:47.7658790+10:00" }, "occupancyType": "tenanted", "annualReturn": 10, "unitsOffered": 1, "nabers": 4.5, "saleTerms": "will be started after 3 days", "auction": { "auctionTerms": "10% deposit, balance 60 days.", "dateTime": "2026-04-08T21:08:47.7658790+10:00", "location": "On Site", "url": "https://ljhookermosman.agentboxcrm.com.au/www/fp-1-1P3679-1721283621.html" }, "propertyDetails": { "propertyType": [ "retail" ], "buildingType": "whole", "parking": { "parkingType": "noParking", "numberOnSite": 0 }, "pdfs": [], "images": [ { "resourceType": "floorPlan", "url": "http://www.ljhookermosman.agentboxcrm.com.au/fp-1-1P3679-1721283621.jpg" }, { "resourceType": "photograph", "url": "http://www.ljhookermosman.agentboxcrm.com.au/lt-1-1P3679-0316165440.jpg" }, { "resourceType": "photograph", "url": "http://www.ljhookermosman.agentboxcrm.com.au/lt-1-1P3679-0316165441.jpg" } ], "address": { "unitNumber": "Suite 11A", "street": "Military Road", "displayOption": "fullAddress", "streetNumber": "287", "suburb": "Cremorne", "postcode": "2090", "state": "nsw" }, "area": { "value": 174, "unit": "squareMetres" }, "landArea": { "unit": "squareMetres", "value": 194 } }, "conjunctionAgents": [ { "agencyId": 12346, "domainAgentId": 484442, "firstName": "Sam", "lastName": "Karri", "phone": "02 8356 7127", "fax": "23444 444 44", "mobile": "0411 345 877", "email": "a@a.com", "receiveEmails": true } ], "highlights": [ "Hightlight 1", "Hightlight 2", "Hightlight 3" ], "underOfferOrContract": false, "listingProvider": "YOUR_LISTING_PROVIDER", "domainAgencyID": 13, "providerAdId": "YOUR_PROVIDER_AD_ID", "features": " Air conditioning, Alarm System, Intercom", "description": "Situated within Cremorne Town Shopping Centre, anchored by Supa IGA supermarket, this property represents a fantastic opportunity to own a tenanted strata retail shop in a successful shopping centre.", "summary": "Entry Level Investment Opportunity!", "inspectionDetails": { "inspections": [ { "from": "2026-04-08T17:00:00.0000000+10:00", "to": "2026-04-08T18:00:00.0000000+10:00", "repeat": false }, { "from": "2026-04-10T17:00:00.0000000+10:00", "to": "2026-04-10T18:00:00.0000000+10:00", "repeat": false }, { "from": "2026-04-12T17:00:00.0000000+10:00", "to": "2026-04-12T18:00:00.0000000+10:00", "repeat": false }, { "from": "2026-04-14T17:00:00.0000000+10:00", "to": "2026-04-14T18:00:00.0000000+10:00", "repeat": false }, { "from": "2026-04-16T17:00:00.0000000+10:00", "to": "2026-04-16T18:00:00.0000000+10:00", "repeat": false } ] }, "media": [ { "resourceType": "video", "url": "http://www.ljhookermosman.agentboxcrm.com.au/fp-1-1P3679-1721283621.mp4" }, { "resourceType": "virtualTour", "url": "http://www.ljhookermosman.agentboxcrm.com.au/fp-1-1P3679-1721283621.html" }, { "resourceType": "webLink", "url": "http://www.ljhookermosman.agentboxcrm.com.au/fp-1-1P3679-1721283621.html" } ], "listingAction": "saleAndLease", "contacts": [ { "domainAgentId": 881492, "firstName": "Jack", "lastName": "King", "phone": "02 8356 7127", "fax": "23444 444 44", "mobile": "0411 245 777", "email": "a@a.com", "receiveEmails": true } ], "otherEnquiryEmail": "b@a.com,d@c.co,f@e.io", "receiveEmailsToDefaultAddress": false } }, "Domain.Public.Adapter.Web.Api.Models.v1.Listings.Commercial.PriceSearch": { "type": "object", "properties": { "min": { "type": "integer", "description": "Minimum price. null - no minimum price limit", "format": "int32" }, "max": { "type": "integer", "description": "Maximum price. null - no maximum price limit", "format": "int32" }, "type": { "enum": [ "totalAmount", "perSqm" ], "type": "string", "description": "Price type" } }, "description": "Search criteria. Price" }, "Domain.Public.Adapter.Web.Api.Models.v1.Listings.Commercial.LocationSearch": { "type": "object", "properties": { "area": { "type": "string", "description": "Location area" }, "postcode": { "type": "string", "description": "Location postcode" }, "region": { "type": "string", "description": "Location region" }, "state": { "enum": [ "act", "nsw", "qld", "vic", "sa", "wa", "nt", "tas" ], "type": "string", "description": "State" }, "street": { "type": "string", "description": "Street address" }, "suburb": { "type": "string", "description": "Suburb" } }, "description": "Search request location details" }, "Domain.Public.Adapter.Web.Api.Models.v1.Listings.Commercial.GeoPoint": { "type": "object", "properties": { "lat": { "type": "number", "description": "Location latitude", "format": "double" }, "long": { "type": "number", "description": "Location longitude", "format": "double" } }, "description": "Geographic coordinate" }, "Domain.Public.Adapter.Web.Api.Models.v1.Listings.Commercial.GeoWindow": { "type": "object", "properties": { "polygon": { "type": "array", "items": { "$ref": "#/components/schemas/Domain.Public.Adapter.Web.Api.Models.v1.Listings.Commercial.GeoPoint" }, "description": "List of points making polygon" }, "boundingBox": { "type": "array", "items": { "$ref": "#/components/schemas/Domain.Public.Adapter.Web.Api.Models.v1.Listings.Commercial.GeoPoint" }, "description": "Bounding box. Not used" } }, "description": "Polygon which specifies geographical area for listing search" }, "Domain.Public.Adapter.Web.Api.Models.v1.Listings.Commercial.ParkingSearch": { "type": "object", "properties": { "type": { "enum": [ "onSite", "onStreet", "noParking" ], "type": "string", "description": "Parking type" }, "carspaces": { "type": "integer", "description": "Minimum carspace count", "format": "int32" } }, "description": "Listing search. Parking search criteria" }, "Domain.Public.Adapter.Web.Api.Models.v1.Listings.Commercial.SearchRequest": { "type": "object", "properties": { "pageNumber": { "type": "integer", "description": "", "format": "int32" }, "advertiserId": { "type": "integer", "description": "Agency ID", "format": "int32" }, "pageSize": { "type": "integer", "description": "Search results page size", "format": "int32" }, "propertyTypes": { "type": "array", "items": { "enum": [ "unknown", "accessoriesParts", "accommodationTourism", "accounting", "acreageSemiRural", "adult", "advertisingMarketing", "aerial", "aeronautical", "agedCare", "agricultural", "air", "aircraft", "alarms", "alcoholLiquor", "amusements", "animalRelated", "apartmentUnitFlat", "aquaculture", "aquaticMarineMarinaBerth", "artsCrafts", "autoElectrical", "automotive", "backpackerHostel", "bakery", "barsNightclubs", "beautyHealth", "beautyProducts", "beautySalon", "bedAndBreakfast", "bikeAndMotorcycle", "blockOfUnits", "boardingKennels", "boatsMarineMarinaBerth", "bookkeeping", "brokerage", "builder", "buildingAndConstruction", "bus", "butcher", "cafeCoffeeShop", "car", "carBusTruck", "carDealership", "carRental", "carSpace", "carWash", "caravanPark", "carpenter", "catering", "childCare", "civil", "cleaning", "cleaningAndMaintenance", "clinicalPractice", "clothingAccessories", "clothingFootwear", "communication", "communications", "computerIT", "computerAndInternet", "construction", "convenienceStore", "copyLaminate", "courier", "cropHarvesting", "customs", "dairyFarming", "deli", "dental", "detailing", "developmentLand", "developmentSite", "distributors", "drivingSchools", "duplex", "educationTraining", "educational", "electrical", "employmentRecruitment", "entertainment", "entertainmentTechnology", "export", "farm", "farming", "fertiliser", "finance", "financialServices", "fishingForestry", "floristNursery", "foodBeverage", "foodBeverageHospitality", "franchiseBusinessOpportunities", "freight", "fruitVegFreshProduce", "fruitPicking", "functionCentre", "furnitureTimber", "gambling", "gardenHousehold", "gardenNurseries", "gardening", "glassCeramic", "guestHouseBB", "guesthouse", "hairdresser", "healthBeauty", "healthSpa", "hire", "homeGarden", "homeBased", "newHomeDesigns", "homewareHardware", "hospital", "hotel", "hotelLeisure", "hotelMotelPub", "house", "newHouseLand", "huntingTrap", "import", "importExportWholesale", "industrialManufacturing", "industrialWarehouse", "insemination", "insurance", "internationalNewDevelopment", "internet", "irrigationServices", "juiceBar", "landClearing", "newLand", "landscaping", "laundryDryCleaning", "legal", "leisureEntertainment", "limousineTaxi", "livestock", "internationalCommercial", "machinery", "machineryMetal", "managementRights", "manufacturers", "manufacturingEngineering", "marine", "massage", "mechanicalRepair", "media", "medical", "medicalConsulting", "medicalPractice", "miningEarthMoving", "mobileServices", "motel", "motorcycle", "musicRelated", "mustering", "nails", "naturalTherapies", "newApartments", "newsagency", "nursery", "nursingHome", "offices", "officeSupplies", "oilGas", "onStreet", "panelBeating", "paperPrinting", "parkingCarSpace", "penthouse", "pestRelated", "pharmacies", "plastic", "plumbing", "poolWater", "postOffices", "printPhoto", "professional", "propertyRealEstate", "rail", "recreationSport", "recruitment", "repair", "resort", "restaurant", "retail", "retailer", "retirementVillage", "road", "rural", "ruralCommercialFarming", "scientific", "sea", "security", "semiDetached", "serviceStation", "serviced", "services", "shearing", "showroomsBulkyGoods", "specialistFarm", "sportsComplexGym", "studio", "supermarket", "takeawayFood", "taxi", "terrace", "themePark", "tours", "townhouse", "training", "transportDistribution", "travel", "truck", "vacantLand", "vending", "villa", "water", "welding", "wholesale", "wholesalers", "withShowroomWarehouse", "withinShoppingComplex", "woolClassing", "wreckers", "tattersalls", "servicedOffices", "other", "alcoholGrocery", "cafeRestaurant", "discountStore", "ecoFriendly", "green", "grocery", "specialityRetail", "storage", "travelAgency", "varietyStore", "franchiseNew", "business" ], "type": "string" }, "description": "Listing property types" }, "price": { "$ref": "#/components/schemas/Domain.Public.Adapter.Web.Api.Models.v1.Listings.Commercial.PriceSearch" }, "locations": { "type": "array", "items": { "$ref": "#/components/schemas/Domain.Public.Adapter.Web.Api.Models.v1.Listings.Commercial.LocationSearch" }, "description": "Location search criteria" }, "keywords": { "type": "array", "items": { "type": "string" }, "description": "Search listings by keyword" }, "geoWindow": { "$ref": "#/components/schemas/Domain.Public.Adapter.Web.Api.Models.v1.Listings.Commercial.GeoWindow" }, "landAreaMin": { "type": "integer", "description": "Minimum land area", "format": "int32" }, "landAreaMax": { "type": "integer", "description": "Maximum land area", "format": "int32" }, "buildingSizeMin": { "type": "integer", "description": "Minimum building area", "format": "int32" }, "buildingSizeMax": { "type": "integer", "description": "Maximum building area", "format": "int32" }, "searchMode": { "enum": [ "forSale", "forLease", "sold", "leased" ], "type": "string", "description": "Search mode" }, "occupancy": { "type": "string", "description": "Occupancy" }, "sort": { "enum": [ "default", "newestFirst", "cheapestTotalFirst", "cheapestPerSqmFirst", "mostExpensiveTotalFirst", "mostExpensivePerSqmFirst", "suburbAsc", "suburbDesc", "buildingSizeAsc", "buildingSizeDesc" ], "type": "string", "description": "Sorting order" }, "saleType": { "enum": [ "standardSale", "auction", "expressionOfInterest", "tender" ], "type": "string", "description": "Sale type" }, "propertyTitle": { "enum": [ "freehold", "strata", "noBuilding" ], "type": "string", "description": "Property title" }, "parking": { "$ref": "#/components/schemas/Domain.Public.Adapter.Web.Api.Models.v1.Listings.Commercial.ParkingSearch" }, "exclusionTypes": { "type": "array", "items": { "enum": [ "surroundingSuburbs", "withoutPrice" ], "type": "string" }, "description": "Exclusion Types" }, "annualReturn": { "type": "integer", "description": "Minimum annual return (in percents)", "format": "int32" } }, "description": "Listing search criteria" }, "Domain.Public.Adapter.Web.Api.Models.v1.Listings.Commercial.Ad": { "type": "object", "properties": { "adType": { "type": "string", "description": "Product type" }, "url": { "type": "string", "description": "URL of property details page on CRE website" } }, "description": "Listing details" }, "Domain.Public.Adapter.Web.Api.Models.v1.Listings.Commercial.AdvertiserImages": { "type": "object", "properties": { "agencyBannerImageUrl": { "type": "string", "description": "Agency branding banner image URL" }, "agencyBannerWideImageUrl": { "type": "string", "description": "Not used" }, "logoUrl": { "type": "string", "description": "Agency logo. Note: CRE has two logo sizes." } }, "description": "Agency images (logos, banners)" }, "Domain.Public.Adapter.Web.Api.Models.v1.Listings.Commercial.PhoneNumber": { "type": "object", "properties": { "displayLabel": { "type": "string", "description": "Diplay label" }, "type": { "type": "string", "description": "Type: \\\"fax\\\", \\\"mobile\\\", \\\"telephone\\\"" }, "number": { "type": "string", "description": "Phone number" } }, "description": "Phone number details" }, "Domain.Public.Adapter.Web.Api.Models.v1.Listings.Commercial.Contact": { "type": "object", "properties": { "id": { "type": "integer", "description": "Agent identifier", "format": "int32" }, "firstName": { "type": "string", "description": "First name. Not available in CRE" }, "lastName": { "type": "string", "description": "Last name. Not available in CRE" }, "imageUrl": { "type": "string", "description": "Image URL" }, "displayFullName": { "type": "string", "description": "Full name" }, "phoneNumbers": { "type": "array", "items": { "$ref": "#/components/schemas/Domain.Public.Adapter.Web.Api.Models.v1.Listings.Commercial.PhoneNumber" }, "description": "Phone numbers" }, "emailAddress": { "type": "string", "description": "E-mail address" }, "address": { "type": "string", "description": "Full address" } }, "description": "Contact" }, "Domain.Public.Adapter.Web.Api.Models.v1.Listings.Commercial.Advertiser": { "type": "object", "properties": { "address": { "type": "string", "description": "agency address" }, "id": { "type": "integer", "description": "Agency ID", "format": "int32" }, "name": { "type": "string", "description": "Agency Name" }, "preferredColorHex": { "type": "string", "description": "Agency color" }, "images": { "$ref": "#/components/schemas/Domain.Public.Adapter.Web.Api.Models.v1.Listings.Commercial.AdvertiserImages" }, "contacts": { "type": "array", "items": { "$ref": "#/components/schemas/Domain.Public.Adapter.Web.Api.Models.v1.Listings.Commercial.Contact" }, "description": "Agency contacts" }, "isConjunctional": { "type": "boolean", "description": "Checks whether advertiser is conjunctional or not" } }, "description": "Agency details" }, "Domain.Public.Adapter.Web.Api.Models.v1.Listings.Commercial.GeoLocation": { "type": "object", "properties": { "latitude": { "type": "number", "description": "Latitude", "format": "double" }, "longitude": { "type": "number", "description": "Longitude", "format": "double" } }, "description": "Geographic coordinate" }, "Domain.Public.Adapter.Web.Api.Models.v1.Listings.Commercial.Media": { "type": "object", "properties": { "dateCreated": { "type": "string", "description": "Not used", "format": "date-time" }, "imageUrl": { "type": "string", "description": "Resource URL" }, "mediaType": { "type": "string", "description": "Media type: \\\"image\\\", \\\"video\\\"" }, "type": { "type": "string", "description": "Type: \\\"youtube\\\", \\\"vimeo\\\", \\\"mp4\\\"" }, "videoUrl": { "type": "string", "description": "Video URL" } }, "description": "Listing media" }, "Domain.Public.Adapter.Web.Api.Models.v1.Listings.Commercial.AddressComponents": { "type": "object", "properties": { "area": { "type": "string", "description": "Listing Area" }, "district": { "type": "string", "description": "Not used" }, "postcode": { "type": "string", "description": "Postcode" }, "region": { "type": "string", "description": "Listing Region" }, "stateShort": { "type": "string", "description": "AUS State. 2 or 3 characters" }, "street": { "type": "string", "description": "Street address" }, "streetNumber": { "type": "string", "description": "Street number" }, "suburb": { "type": "string", "description": "Suburb" }, "unitNumber": { "type": "string", "description": "Unit number" } }, "description": "Address components" }, "Domain.Public.Adapter.Web.Api.Models.v1.Listings.Commercial.Metadata": { "type": "object", "properties": { "addressComponents": { "$ref": "#/components/schemas/Domain.Public.Adapter.Web.Api.Models.v1.Listings.Commercial.AddressComponents" } }, "description": "Listing metadata" }, "Domain.Public.Adapter.Web.Api.Models.v1.Listings.Commercial.Listing": { "type": "object", "properties": { "ad": { "$ref": "#/components/schemas/Domain.Public.Adapter.Web.Api.Models.v1.Listings.Commercial.Ad" }, "price": { "type": "string", "description": "Formatted listing price" }, "advertiser": { "$ref": "#/components/schemas/Domain.Public.Adapter.Web.Api.Models.v1.Listings.Commercial.Advertiser" }, "geoLocation": { "$ref": "#/components/schemas/Domain.Public.Adapter.Web.Api.Models.v1.Listings.Commercial.GeoLocation" }, "propertyArea": { "type": "string", "description": "Building size" }, "propertyType": { "type": "string", "description": "Property type" }, "address": { "type": "string", "description": "Full address" }, "headline": { "type": "string", "description": "Headline" }, "hasVideo": { "type": "boolean", "description": "Has video?" }, "media": { "type": "array", "items": { "$ref": "#/components/schemas/Domain.Public.Adapter.Web.Api.Models.v1.Listings.Commercial.Media" }, "description": "Media resources for listing (images, video, floor plans)" }, "auctionDate": { "type": "string", "description": "Auction date" }, "id": { "type": "integer", "description": "AdID", "format": "int32" }, "metadata": { "$ref": "#/components/schemas/Domain.Public.Adapter.Web.Api.Models.v1.Listings.Commercial.Metadata" }, "carspaceCount": { "type": "integer", "description": "Car parking spaces count", "format": "int32" } }, "description": "Listing details for univesal app", "x-data-access-level-info": { "Basic": [ "*" ], "Detailed": [ "*" ], "Full": [ "*" ] } }, "ListingAdmin.v2.CommercialOffMarketProperty": { "required": [ "propertyType", "address" ], "type": "object", "properties": { "propertyType": { "type": "array", "items": { "enum": [ "aquaculture", "dairyFarming", "developmentLand", "fishingForestry", "hotelLeisure", "industrialWarehouse", "irrigationServices", "livestock", "internationalCommercial", "medicalConsulting", "offices", "parkingCarSpace", "retail", "ruralCommercialFarming", "showroomsBulkyGoods", "servicedOffices", "other", "cropping", "viticulture", "mixedFarming", "grazing", "horticulture", "equine", "farmlet", "orchard", "ruralLifestyle" ], "type": "string" }, "description": "Commercial property types ['aquaculture', 'dairyFarming', 'developmentLand', 'fishingForestry', 'hotelLeisure', 'industrialWarehouse', 'irrigationServices', 'livestock', 'internationalCommercial', 'medicalConsulting', 'offices', 'parkingCarSpace', 'retail', 'ruralCommercialFarming', 'showroomsBulkyGoods', 'servicedOffices', 'other', 'cropping', 'viticulture', 'mixedFarming', 'grazing', 'horticulture', 'equine', 'farmlet', 'orchard', 'ruralLifestyle']." }, "buildingType": { "enum": [ "whole", "part", "nA" ], "type": "string", "description": "Building Type" }, "parking": { "$ref": "#/components/schemas/ListingAdmin.v2.Parking" }, "images": { "type": "array", "items": { "$ref": "#/components/schemas/ListingAdmin.v2.PropertyMedia" }, "description": "List of image files, photos or floor plans related to the listing.\r\nSupported image file formats: AVIF, BMP, GIF, HEIF/HEIC, JPEG, JPEG 2000, PNG, TIFF, WebP.\r\nThe file size is restricted to maximum 100MB.\r\nWe recommend against using transparent backgrounds.\r\nSome image formats, such as PNG, support transparency, but when images with transparent areas are resized, they may be converted to a format that doesn’t support transparency, such as JPEG.\r\nBy default, transparent areas are converted to black, but the application displaying the image may convert the transparent area to the most appropriate colour for the area where the image is being placed." }, "address": { "$ref": "#/components/schemas/ListingAdmin.v2.Address" }, "area": { "$ref": "#/components/schemas/ListingAdmin.v2.Area" }, "landArea": { "$ref": "#/components/schemas/ListingAdmin.v2.LandArea" } }, "description": "Commercial off market property" }, "ListingAdmin.v2.CommercialOffMarketListing": { "required": [ "domainAgencyID", "providerAdId", "listingAction", "offMarketDetails", "propertyDetails" ], "type": "object", "properties": { "unitsOffered": { "maximum": 2147483647, "minimum": 0, "type": "integer", "description": "Integer value of units offered for sale or lease", "format": "int32" }, "unitDetails": { "type": "array", "items": { "$ref": "#/components/schemas/ListingAdmin.v2.SpecificUnitDetail" }, "description": "Units details" }, "annualReturn": { "type": "integer", "description": "Integer value of percentage return on this property or business.", "format": "int32" }, "nabers": { "maximum": 6, "minimum": 0, "type": "number", "description": "The NABERS Rating is the energy efficiency rating that the property has been measured to have. \r\nThis rating is measured in increments of .5 and can range from 0 to 6. \r\nThe NABERS rating is required for spaces within office buildings of 1000 square metres or more.\r\nFor more information on the NABERS rating system please visit http://www.nabers.gov.au", "format": "double" }, "highlights": { "type": "array", "items": { "type": "string" }, "description": "Highlight Items" }, "listingProvider": { "type": "string", "description": "A string identifying the data provider" }, "domainAgencyID": { "maximum": 2147483647, "minimum": 0, "type": "integer", "description": "The Domain Agency ID", "format": "int32" }, "providerAdId": { "maxLength": 50, "minLength": 0, "type": "string", "description": "External Advertisement Id of up to 50 characters will be stored.
\r\nThis value is used to identify an Advertisement for updates and should be unique for listing provider.
\r\nThis value is case-insensitive (meaning AAAA will update aaaa)." }, "description": { "maxLength": 6000, "minLength": 0, "type": "string", "description": "Description of the property.\r\n6000 characters in length. The following HTML elements are permitted: <br />, <p></p>, &nbsp;. HTML must be well-formed.\r\nCarriage Returns are interpreted as line breaks. Foreign characters must be HTML encoded, e.g., façade for façade.\r\nUnicode characters which are unsupported by Latin-1 (ISO-8859-1 range from U+0080 to U+00FF), will be removed https://en.wikipedia.org/wiki/ISO/IEC_8859-1" }, "summary": { "maxLength": 250, "minLength": 0, "type": "string", "description": "'Headline' Any HTML stripped out. If the Summary is less than 80 characters long then the description is concatenated to it and the total trimmed to 250 characters." }, "contacts": { "type": "array", "items": { "$ref": "#/components/schemas/ListingAdmin.v2.Contact" }, "description": "Minimum required attributes: First name, last name and E-mail.\r\nIf the DomainAgentId is provided, contact information will be based on the existing agent found for that id.\r\nOtherwise first name, last name and email will be used to find the matching contact. A new contact will be created if no contact can be found." }, "listingAction": { "enum": [ "sale", "rent" ], "type": "string", "description": "Sale or Rent" }, "offMarketDetails": { "$ref": "#/components/schemas/ListingAdmin.v2.OffMarketDetailsBase" }, "propertyDetails": { "$ref": "#/components/schemas/ListingAdmin.v2.CommercialOffMarketProperty" } }, "description": "Commercial off market listing" }, "Domain.Public.Adapter.Web.Api.Models.v1.Listings.ListingLocation": { "type": "object", "properties": { "name": { "type": "string", "description": "Name" }, "state": { "type": "string", "description": "State" }, "postcode": { "type": "string", "description": "Postcode" }, "area": { "type": "string", "description": "Area" }, "region": { "type": "string", "description": "Region" }, "type": { "type": "string", "description": "Type" } }, "description": "Listing location", "x-data-access-level-info": { "Basic": [ "*" ], "Detailed": [ "*" ], "Full": [ "*" ] } }, "Domain.ListingAdminService.v1.Model.ModelEvent": { "type": "object", "properties": { "severity": { "enum": [ "Info", "Warning", "Error" ], "type": "string", "description": "Severity of the Event" }, "issueType": { "enum": [ "Internal", "External" ], "type": "string", "description": "Type of the issue" }, "message": { "type": "string", "description": "Message associated with the event" } }, "description": "Processing Event, use to show information, warnings or Errors", "x-data-access-level-info": { "Basic": [ "*" ], "Detailed": [ "*" ], "Full": [ "*" ] } }, "Domain.ListingAdminService.v1.Model.ReportVersion": { "type": "object", "properties": { "operations": { "type": "array", "items": { "type": "string" }, "description": "Operations performed on a completed version ['none', 'dataReceived', 'processStarted', 'priceValidated', 'geoCoded', 'pdfsProcessed', 'primaryImagesProcessed', 'allImagesProcessed', 'listingDataSaved', 'listingDeleted', 'reportEmailSent', 'offMarketProcessed', 'listingIndexed', 'propertyTypesProcessed', 'contactsProcessed', 'messagesPublished', 'listingSentLive', 'listingUpdated', 'listingRestored', 'allImageSizesProcessed', 'patchProcessed', 'externalSaleProcessed', 'soiProcessed', 'duplicateDetection', 'listingMerged', 'supplementaryProcessed', 'listingHeldInMigration', 'linkedProjectsProcessed', 'linkedListingsProcessed', 'allMediaProcessed', 'projectProcessed', 'projectDeleted']." }, "versionId": { "type": "string", "description": "Version Id" }, "processedDate": { "type": "string", "description": "Date this version of data been processed", "format": "date-time" }, "dataUrl": { "type": "string", "description": "Url to access s3 file" }, "processCount": { "type": "integer", "description": "Retry count", "format": "int32" } }, "description": "Report Version", "x-data-access-level-info": { "Basic": [ "*" ], "Detailed": [ "*" ], "Full": [ "*" ] } }, "Domain.ListingAdminService.v1.Model.ListingReport": { "type": "object", "properties": { "processStatus": { "enum": [ "queued", "processing", "processed", "searchable", "failed", "error" ], "type": "string", "description": "Status of listing been processed * Queued - We received request * Processing - Request been processed * Processed - Successful processed request * Failed - Processing failed * Error - Individual errors encountered" }, "agencyId": { "type": "integer", "description": "AgencyId from Domain", "format": "int64" }, "providerId": { "type": "string", "description": "ProviderId for the agency" }, "providerAdId": { "type": "string", "description": "Listing identifier provided by CRM" }, "adId": { "type": "array", "items": { "type": "integer", "format": "int64" }, "description": "Advertisement Id from domain" }, "qualityScore": { "type": "integer", "description": "Quality score of the listing, based on data completeness", "format": "int32" }, "events": { "type": "array", "items": { "$ref": "#/components/schemas/Domain.ListingAdminService.v1.Model.ModelEvent" }, "description": "All Events associated with this processing request" }, "versions": { "type": "array", "items": { "$ref": "#/components/schemas/Domain.ListingAdminService.v1.Model.ReportVersion" }, "description": "version list" } }, "description": "Represent current listing status and aggregation of status messages", "x-data-access-level-info": { "Basic": [ "*" ], "Detailed": [ "*" ], "Full": [ "*" ] } }, "Domain.ListingAdminService.v1.Model.Auction": { "type": "object", "properties": { "dateTime": { "type": "string", "description": "Date of the auction. format: yyyy-MM-ddTHH:mm:ss", "format": "date-time" }, "location": { "type": "string", "description": "Optional. Venue for the Auction. String max 100 characters. If the Location is omitted, or included but empty, the Venue will default to \\\"On Site\\\"." }, "url": { "type": "string", "description": "Optional on-line auction URL. Must be a valid URL and maximum 255 characters. If an empty string is received, the property will be re-set." } }, "description": "Auction Details" }, "Domain.ListingAdminService.v1.Model.ParkingDetails": { "type": "object", "properties": { "parkingType": { "enum": [ "onSite", "onStreet", "noParking", "garage", "carport", "outdoor" ], "type": "string", "description": "Can have the value \\\"OnSite\\\", \\\"OnStreet\\\", \\\"NoParking\\\". Default: \\\"NoParking\\\"" }, "numberOfSpaces": { "type": "integer", "description": "Number of parking spaces on site", "format": "int32" } }, "description": "Parking Details" }, "Domain.ListingAdminService.v1.Model.ParkingInfo": { "type": "object", "properties": { "details": { "type": "array", "items": { "$ref": "#/components/schemas/Domain.ListingAdminService.v1.Model.ParkingDetails" }, "description": "Details for available parking spaces" }, "information": { "type": "string", "description": "Additional information regarding the parking condition" } }, "description": "Parking Details" }, "Domain.ListingAdminService.v1.Model.ResidentialProperty": { "type": "object", "properties": { "propertyType": { "type": "array", "items": { "enum": [ "acreageSemiRural", "apartmentUnitFlat", "aquaculture", "blockOfUnits", "carSpace", "dairyFarming", "developmentSite", "duplex", "farm", "fishingForestry", "newHomeDesigns", "house", "newHouseLand", "irrigationServices", "newLand", "livestock", "newApartments", "penthouse", "retirement", "rural", "semiDetached", "specialistFarm", "studio", "terrace", "townhouse", "vacantLand", "villa", "cropping", "viticulture", "mixedFarming", "grazing", "horticulture", "equine", "farmlet", "orchard", "ruralLifestyle" ], "type": "string" }, "description": "'Retirement' requires at least one more property type to be specified with it (for example: \\\"Retirement\\\", \\\"ApartmentUnitFlat\\\") ['acreageSemiRural', 'apartmentUnitFlat', 'aquaculture', 'blockOfUnits', 'carSpace', 'dairyFarming', 'developmentSite', 'duplex', 'farm', 'fishingForestry', 'newHomeDesigns', 'house', 'newHouseLand', 'irrigationServices', 'newLand', 'livestock', 'newApartments', 'penthouse', 'retirement', 'rural', 'semiDetached', 'specialistFarm', 'studio', 'terrace', 'townhouse', 'vacantLand', 'villa', 'cropping', 'viticulture', 'mixedFarming', 'grazing', 'horticulture', 'equine', 'farmlet', 'orchard', 'ruralLifestyle']." }, "bedRooms": { "type": "integer", "description": "Number of bedrooms", "format": "int32" }, "bathRooms": { "type": "integer", "description": "Number of bathrooms", "format": "int32" }, "parkingInfo": { "$ref": "#/components/schemas/Domain.ListingAdminService.v1.Model.ParkingInfo" }, "energyEfficiencyRating": { "type": "number", "description": "Optional, although must be set for ACT dwellings for sale. Valid values range from 0 to 10 inclusive, in increments of 0.5", "format": "double" }, "pdfs": { "type": "array", "items": { "$ref": "#/components/schemas/Domain.ListingAdminService.v1.Model.PropertyPdf" }, "description": "List of PDF files related to the listing" }, "isMarkedForLiveability": { "type": "boolean", "description": "Is the property liveability compliant" }, "propertyName": { "type": "string", "description": "Name of the property up to 70 characters" }, "location": { "type": "string", "description": "Short location information up to 30 character, e.g.: Greenhills Beach" }, "images": { "type": "array", "items": { "$ref": "#/components/schemas/Domain.ListingAdminService.v1.Model.PropertyMedia" }, "description": "List of image files, photos or floor plans related to the listing." }, "address": { "$ref": "#/components/schemas/Domain.ListingAdminService.v1.Model.Address" }, "area": { "$ref": "#/components/schemas/Domain.ListingAdminService.v1.Model.Area" }, "landArea": { "$ref": "#/components/schemas/Domain.ListingAdminService.v1.Model.LandArea" } }, "description": "Residential Property" }, "Domain.ListingAdminService.v1.Model.BasicPrice": { "type": "object", "properties": { "from": { "type": "integer", "description": "Lowest price the property is expected to sell/rent for to set search price. For a fixed price, set this value the same as To", "format": "int32" }, "to": { "type": "integer", "description": "Highest price the property is expected to sell/rent for to set search price. For a fixed price, set this value the same as From", "format": "int32" } }, "description": "Basic price information" }, "Domain.ListingAdminService.v1.Model.PastSaleAddress": { "type": "object", "properties": { "state": { "enum": [ "nsw", "vic", "act", "sa", "wa", "tas", "qld", "nt" ], "type": "string", "description": "State" }, "unitNumber": { "type": "string", "description": "Unit number for apartments, maximum 30 characters" }, "streetNumber": { "type": "string", "description": "Street number, maximum 20 characters" }, "street": { "type": "string", "description": "Street name, maximum 100 characters" }, "suburb": { "type": "string", "description": "Suburb name , maximum 50 characters" }, "postcode": { "type": "string", "description": "Postcode" } }, "description": "Address for past sold listing" }, "Domain.ListingAdminService.v1.Model.PastSaleData": { "type": "object", "properties": { "address": { "$ref": "#/components/schemas/Domain.ListingAdminService.v1.Model.PastSaleAddress" }, "dateOfSale": { "type": "string", "description": "Registered date of the sale", "format": "date-time" }, "soldPrice": { "type": "integer", "description": "Price property has been sold", "format": "int32" } }, "description": "Information for past property sales" }, "Domain.ListingAdminService.v1.Model.ComparableData": { "type": "object", "properties": { "comparableProperty": { "type": "array", "items": { "$ref": "#/components/schemas/Domain.ListingAdminService.v1.Model.PastSaleData" }, "description": "To be comparable, property must be Of a similar standard or condition to the property for sale And Sold in the last six months and be within two kilometres of the property for sale (if the property for sale is in the Melbourne metropolitan area) Or Sold in the last 18 months and be within five kilometres of the property for sale (if the property for sale is outside the Melbourne metropolitan area)." }, "declarationText": { "type": "string", "description": "Text description should be provided If you reasonably believe that there are less than three comparable sales within the prescribed period outlined above for ComparableProperty {Domain.Listing.Admin.Model.Entities.ComparableData.ComparableProperty} Required when no past sale property data was provided" } }, "description": "Information regarding past comparable property sales that influenced the setting of teh estimationPrice" }, "Domain.ListingAdminService.v1.Model.MedianPriceData": { "type": "object", "properties": { "priceType": { "enum": [ "house", "apartmentUnitFlat", "vacantLand" ], "type": "string", "description": "Type of property this median price is based on ." }, "suburb": { "type": "string", "description": "Name of the suburb median price is based on." }, "postcode": { "type": "string", "description": "Postcode of the suburb" }, "medianPrice": { "type": "integer", "description": "Median price for the suburb .", "format": "int32" }, "source": { "type": "string", "description": "Where the Median Price come from" }, "sourceDateFrom": { "type": "string", "description": "Median Price Source Data From Date", "format": "date-time" }, "sourceDateTo": { "type": "string", "description": "Median Price Source Data To Date", "format": "date-time" }, "declarationText": { "type": "string", "description": "Declaration text should be provided when no median price data available" } }, "description": "Information regarding median house/unit price for the suburb" }, "Domain.ListingAdminService.v1.Model.StatementOfInformation": { "type": "object", "properties": { "estimatedPrice": { "$ref": "#/components/schemas/Domain.ListingAdminService.v1.Model.BasicPrice" }, "comparableData": { "$ref": "#/components/schemas/Domain.ListingAdminService.v1.Model.ComparableData" }, "suburbMedianPrice": { "$ref": "#/components/schemas/Domain.ListingAdminService.v1.Model.MedianPriceData" }, "documentationUrl": { "type": "string", "description": "Link to the statement of information documentation file. Must be a PDF file. File should be less than 10 MB in size The Statement of Information must be updated if there is a change in the indicative selling price." } }, "description": "Statement of Information Regarding sale listing" }, "Domain.ListingAdminService.v1.Model.ListingProject": { "type": "object", "properties": { "id": { "type": "integer", "description": "Domain's development project identifier. If the value is not provided, the listing will be unlinked.", "format": "int32" }, "order": { "type": "integer", "description": "Listing's order. If the value is not provided, the listing will be last.", "format": "int32" } }, "description": "Listing development project details." }, "Domain.ListingAdminService.v1.Model.ResidentialListing": { "type": "object", "properties": { "lifeStyleType": { "enum": [ "firstHome", "investment", "retirement", "seaChange", "treeChange", "youngFamilies" ], "type": "string", "description": "Lifestyle type" }, "listingAction": { "enum": [ "sale", "rent", "saleAndLease" ], "type": "string", "description": "Sale or Rent" }, "contactPreference": { "enum": [ "byPhone" ], "type": "string", "description": "Indicates the listing preferred contact method. Default by both phone and email if not provided." }, "underOfferOrContract": { "type": "boolean", "description": "Set for Sale listings only" }, "auction": { "$ref": "#/components/schemas/Domain.ListingAdminService.v1.Model.Auction" }, "bond": { "type": "integer", "description": "Optional. Ignored for sale listings", "format": "int32" }, "availableFrom": { "type": "string", "description": "Optional. Sets the Date from which a Rental or Share property is available. Date format: yyyy-mm-dd", "format": "date-time" }, "propertyDetails": { "$ref": "#/components/schemas/Domain.ListingAdminService.v1.Model.ResidentialProperty" }, "isNewDevelopment": { "type": "boolean", "description": "True if the property is a new development" }, "statementOfInformation": { "$ref": "#/components/schemas/Domain.ListingAdminService.v1.Model.StatementOfInformation" }, "price": { "$ref": "#/components/schemas/Domain.ListingAdminService.v1.Model.Price" }, "project": { "$ref": "#/components/schemas/Domain.ListingAdminService.v1.Model.ListingProject" }, "domainAdId": { "type": "integer", "description": "Domain Advertisement Id, not applicable for creating new ads. Mandatory when updating a listing that belongs to an agency that is in the process of being migrated between listing providers.", "format": "int32" }, "domainAgencyID": { "type": "integer", "description": "The Domain Agency Id number", "format": "int32" }, "providerAdId": { "type": "string", "description": "External Advertisement Id of up to 50 characters will be stored.<br /> This value is used to identify an Advertisement for updates and should be unique for listing provider.<br /> This value is case-insensitive (meaning AAAA will update aaaa)." }, "features": { "type": "string", "description": "Comma-separated list of features. 1000 characters in length. Select as appropriate or write your own. INSIDE: Air conditioning, Ensuite, Floorboards, Indoor Spa, Gym, Alarm System, Intercom, Built in wardrobes, Furnished, Internal Laundry, Pets allowed, Cable or Satellite, Gas, Broadband internet access, Bath, Fireplace(s), Separate Dining Room, Heating, Dishwasher, Study. OUTSIDE: Tennis Court, Secure Parking, Shed, Fully fenced, Balcony / Deck, Garden / Courtyard, Swimming Pool, Outdoor Spa. LOCATION: Ground floor, Water Views, North Facing, City Views. ECO FRIENDLY: Double glazed windows, Energy efficient appliances, Water efficient appliances, Wall / ceiling insulation, Rainwater storage tank, Greywater system, Water efficient fixtures, Solar hot water, Solar panels" }, "description": { "type": "string", "description": "Description of the property. 6000 characters in length. The following HTML elements are permitted: &lt;br /&gt;, &lt;p&gt;&lt;/p&gt;, &amp;nbsp;. HTML must be well-formed. Carriage Returns are interpreted as line breaks. Foreign characters must be HTML encoded, e.g., façade for façade. Unicode characters which are unsupported by Latin-1 (ISO-8859-1 range from U+0080 to U+00FF), will be removed https://en.wikipedia.org/wiki/ISO/IEC_8859-1" }, "summary": { "type": "string", "description": "'Headline' Any HTML stripped out. If the Summary is less than 80 characters long then the description is concatenated to it and the total trimmed to 250 characters." }, "inspectionDetails": { "$ref": "#/components/schemas/Domain.ListingAdminService.v1.Model.InspectionDetails" }, "media": { "type": "array", "items": { "$ref": "#/components/schemas/Domain.ListingAdminService.v1.Model.PropertyMedia" }, "description": "Links to VideoURL, virtual tour or weblink. Maximum length of media URLs is 255 characters." }, "contacts": { "type": "array", "items": { "$ref": "#/components/schemas/Domain.ListingAdminService.v1.Model.Contact" }, "description": "Minimum required attributes: First name, last name and E-mail. If the DomainAgentId is provided, contact information will be based on the existing agent found for that id. Otherwise first name, last name and email will be used to find the matching contact. A new contact will be created if no contact can be found." }, "otherEnquiryEmail": { "type": "string", "description": "Sets an additional Email Address to which enquiries on the Listing will be sent" }, "receiveEmailsToDefaultAddress": { "type": "boolean", "description": "Send email enquiries to the default address for this listing type" }, "isRural": { "type": "boolean", "description": "True if the property is rural" }, "supplementary": { "type": "array", "items": { "$ref": "#/components/schemas/Domain.ListingAdminService.v1.Model.ListingSupplementary" }, "description": "Rural attributes *Improvements* (optional) Available `types` (fixed list, optional): * Machinery Shed * Shearing Shed * Workshop * Shearers Quarters * Silos * Other Housing * Managers Accommodation *Fencing* (optional) `description` (string, optional): free text fencing description, maximum 250 characters. *Yards* (optional) Available `types` (fixed list, optional): * Sheep * Cattle *Homestead* (optional) `description` (string, optional): description of the homestead and construction, maximum 250 characters. `metadata` (optional) * `area` (decimal, optional): homestead area in square metres. Available `types` (fixed list, optional): * Office * Ensuite * Tennis Court * Mains Gas * Floorboards * Internal Laundry *Water* (optional) `description` (string, optional): water comments, maximum 250 characters. Available `types` (fixed list, optional): * Tank * Well * Reticulated * Bores * Springs * Creeks * Dams * River *Crops* (optional) `description` (string, optional): description of the crops, maximum 250 characters. `metadata` (optional) * `croppedAnnually` (decimal, optional): average annual area cropped in hectares. * `fallowAnnually` (decimal, optional): average annual fallow area in hectares. * `pastures` (string, optional): description of pastures available, maximum 250 characters. *Livestock* (optional) `description` (string, optional): additional comments, maximum 250 characters. `metadata` (optional) * `capacity` (decimal, optional): property carrying capacity in DSE (unit of carry capacity). Available `types` (fixed list, optional): * Sheep * Pigs * Cattle * Poultry * Horses * Exotic * Goats * Stud *Inclusions* (optional) `description` (string, optional): description of plant and machinery included in sale, maximum 250 characters. `metadata` (optional) * `livestock` (string, optional): description of livestock included in sale, maximum 250 characters. * `crop` (string, optional): description of crops included in sale, maximum 250 characters. *Irrigation* (optional) `description` (string, optional): irrigation comments, maximum 250 characters `metadata` (optional) * `rainfall` (decimal, optional): annual rainfall in millimetres." } }, "description": "Residential Listing" }, "Domain.SearchService.v2.Model.DomainSearchWebApiV2ModelsSearchLocation": { "type": "object", "properties": { "state": { "enum": [ "ACT", "NSW", "QLD", "VIC", "SA", "WA", "NT", "TAS" ], "type": "string" }, "region": { "type": "string" }, "area": { "type": "string" }, "suburb": { "type": "string" }, "postCode": { "type": "string" }, "includeSurroundingSuburbs": { "type": "boolean" }, "surroundingRadiusInMeters": { "type": "integer", "format": "int32" } } }, "Domain.SearchService.v2.Model.DomainSearchWebApiV2ModelsSchoolCatchment": { "type": "object", "properties": { "name": { "type": "string" }, "state": { "type": "string" }, "postcode": { "type": "string" } } }, "Domain.SearchService.v2.Model.DomainSearchWebApiV2ModelsCustomSortElement": { "type": "object", "properties": { "field": { "enum": [ "AdId", "PromoLevelScore", "FreshnessLevel", "ProductBoost", "DateUpdated", "DateListed", "SuburbName", "PriceDisplayOption", "SoldDate", "Price", "EarliestInspectionOpenTime", "EarliestAuctionTime", "DateAvailable" ], "type": "string" }, "direction": { "enum": [ "Ascending", "Descending" ], "type": "string" } } }, "Domain.SearchService.v2.Model.DomainSearchWebApiV2ModelsCustomSort": { "type": "object", "properties": { "elements": { "type": "array", "items": { "$ref": "#/components/schemas/Domain.SearchService.v2.Model.DomainSearchWebApiV2ModelsCustomSortElement" } }, "boostPrimarySuburbs": { "type": "boolean" } } }, "Domain.SearchService.v2.Model.SystemNullableDomainSearchWebApiV2ModelsSortBy": { "type": "object", "properties": { "sortKey": { "enum": [ "Default", "Suburb", "Price", "DateUpdated", "InspectionTime", "AuctionTime", "SoldDate", "DefaultThenDateUpdated", "DateAvailable", "DateListed" ], "type": "string" }, "direction": { "enum": [ "Ascending", "Descending" ], "type": "string" } } }, "Domain.SearchService.v2.Model.DomainSearchWebApiV2ModelsGeoPoint": { "type": "object", "properties": { "lat": { "type": "number", "format": "double" }, "lon": { "type": "number", "format": "double" } } }, "Domain.SearchService.v2.Model.DomainSearchWebApiV2ModelsBox": { "type": "object", "properties": { "topLeft": { "$ref": "#/components/schemas/Domain.SearchService.v2.Model.DomainSearchWebApiV2ModelsGeoPoint" }, "bottomRight": { "$ref": "#/components/schemas/Domain.SearchService.v2.Model.DomainSearchWebApiV2ModelsGeoPoint" } } }, "Domain.SearchService.v2.Model.DomainSearchWebApiV2ModelsCircle": { "type": "object", "properties": { "center": { "$ref": "#/components/schemas/Domain.SearchService.v2.Model.DomainSearchWebApiV2ModelsGeoPoint" }, "radiusInMeters": { "type": "integer", "format": "int32" } } }, "Domain.SearchService.v2.Model.DomainSearchWebApiV2ModelsPolygon": { "type": "object", "properties": { "points": { "type": "array", "items": { "$ref": "#/components/schemas/Domain.SearchService.v2.Model.DomainSearchWebApiV2ModelsGeoPoint" } } } }, "Domain.SearchService.v2.Model.DomainSearchWebApiV2ModelsGeoWindow": { "type": "object", "properties": { "box": { "$ref": "#/components/schemas/Domain.SearchService.v2.Model.DomainSearchWebApiV2ModelsBox" }, "circle": { "$ref": "#/components/schemas/Domain.SearchService.v2.Model.DomainSearchWebApiV2ModelsCircle" }, "polygon": { "$ref": "#/components/schemas/Domain.SearchService.v2.Model.DomainSearchWebApiV2ModelsPolygon" } } }, "Domain.SearchService.v2.Model.DomainSearchWebApiV2ModelsTagQuery": { "type": "object", "properties": { "criteria": { "enum": [ "Include", "Exclude" ], "type": "string" }, "tag": { "type": "string" } } }, "Domain.SearchService.v2.Model.DomainSearchWebApiV2ModelsSearchParameters": { "type": "object", "properties": { "listingType": { "enum": [ "Sale", "Rent", "Share", "Sold", "NewHomes" ], "type": "string" }, "propertyTypes": { "type": "array", "items": { "enum": [ "AcreageSemiRural", "ApartmentUnitFlat", "Aquaculture", "BlockOfUnits", "CarSpace", "DairyFarming", "DevelopmentSite", "Duplex", "Farm", "FishingForestry", "NewHomeDesigns", "House", "NewHouseLand", "IrrigationServices", "NewLand", "Livestock", "NewApartments", "Penthouse", "RetirementVillage", "Rural", "SemiDetached", "SpecialistFarm", "Studio", "Terrace", "Townhouse", "VacantLand", "Villa", "Cropping", "Viticulture", "MixedFarming", "Grazing", "Horticulture", "Equine", "Farmlet", "Orchard", "RuralLifestyle" ], "type": "string" } }, "propertyFeatures": { "type": "array", "items": { "enum": [ "AirConditioning", "BuiltInWardrobes", "CableOrSatellite", "Ensuite", "Floorboards", "Gas", "InternalLaundry", "PetsAllowed", "SecureParking", "SwimmingPool", "Furnished", "GroundFloor", "WaterViews", "NorthFacing", "CityViews", "IndoorSpa", "Gym", "AlarmSystem", "Intercom", "BroadbandInternetAccess", "Bath", "Fireplace", "SeparateDiningRoom", "Heating", "Dishwasher", "Study", "TennisCourt", "Shed", "FullyFenced", "BalconyDeck", "GardenCourtyard", "OutdoorSpa", "DoubleGlazedWindows", "EnergyEfficientAppliances", "WaterEfficientAppliances", "WallCeilingInsulation", "RainwaterStorageTank", "GreywaterSystem", "WaterEfficientFixtures", "SolarHotWater", "SolarPanels" ], "type": "string" } }, "listingAttributes": { "type": "array", "items": { "enum": [ "HasPhotos", "HasPrice", "NotUpForAuction", "NotUnderContract", "MarkedAsNew" ], "type": "string" } }, "propertyEstablishedType": { "enum": [ "Any", "New", "Established" ], "type": "string" }, "minBedrooms": { "type": "number", "format": "float" }, "maxBedrooms": { "type": "number", "format": "float" }, "minBathrooms": { "type": "number", "format": "float" }, "maxBathrooms": { "type": "number", "format": "float" }, "minCarspaces": { "type": "integer", "format": "int32" }, "maxCarspaces": { "type": "integer", "format": "int32" }, "minPrice": { "type": "integer", "format": "int32" }, "maxPrice": { "type": "integer", "format": "int32" }, "minLandArea": { "type": "integer", "format": "int32" }, "maxLandArea": { "type": "integer", "format": "int32" }, "advertiserIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "adIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "excludeAdIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "locations": { "type": "array", "items": { "$ref": "#/components/schemas/Domain.SearchService.v2.Model.DomainSearchWebApiV2ModelsSearchLocation" } }, "schoolCatchments": { "type": "array", "items": { "$ref": "#/components/schemas/Domain.SearchService.v2.Model.DomainSearchWebApiV2ModelsSchoolCatchment" } }, "locationTerms": { "type": "string" }, "keywords": { "type": "array", "items": { "type": "string" } }, "newDevOnly": { "type": "boolean" }, "inspectionFrom": { "type": "string", "format": "date-time" }, "inspectionTo": { "type": "string", "format": "date-time" }, "auctionFrom": { "type": "string", "format": "date-time" }, "auctionTo": { "type": "string", "format": "date-time" }, "dateAvailableFrom": { "type": "string", "format": "date-time" }, "dateAvailableTo": { "type": "string", "format": "date-time" }, "ruralOnly": { "type": "boolean" }, "excludePriceWithheld": { "type": "boolean" }, "excludeDepositTaken": { "type": "boolean" }, "topspotKeywords": { "type": "array", "items": { "type": "string" } }, "customSort": { "$ref": "#/components/schemas/Domain.SearchService.v2.Model.DomainSearchWebApiV2ModelsCustomSort" }, "sort": { "$ref": "#/components/schemas/Domain.SearchService.v2.Model.SystemNullableDomainSearchWebApiV2ModelsSortBy" }, "pageSize": { "type": "integer", "format": "int32" }, "geoWindow": { "$ref": "#/components/schemas/Domain.SearchService.v2.Model.DomainSearchWebApiV2ModelsGeoWindow" }, "updatedSince": { "type": "string", "format": "date-time" }, "listedSince": { "type": "string", "format": "date-time" }, "includeInspectionAggregations": { "type": "boolean" }, "aggregations": { "type": "array", "items": { "type": "string" } }, "tags": { "type": "array", "items": { "$ref": "#/components/schemas/Domain.SearchService.v2.Model.DomainSearchWebApiV2ModelsTagQuery" } }, "pageNumber": { "type": "integer", "format": "int32" } } }, "Domain.SearchService.v2.Model.DomainSearchContractsV2Contact": { "type": "object", "properties": { "name": { "type": "string" }, "photoUrl": { "type": "string" } } }, "Domain.SearchService.v2.Model.DomainSearchContractsV2Advertiser": { "type": "object", "properties": { "type": { "enum": [ "Agency", "Private" ], "type": "string" }, "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "logoUrl": { "type": "string" }, "preferredColourHex": { "type": "string" }, "bannerUrl": { "type": "string" }, "contacts": { "type": "array", "items": { "$ref": "#/components/schemas/Domain.SearchService.v2.Model.DomainSearchContractsV2Contact" } } } }, "Domain.SearchService.v2.Model.DomainSearchContractsV2PriceDetails": { "type": "object", "properties": { "price": { "type": "integer", "format": "int32" }, "priceFrom": { "type": "integer", "format": "int32" }, "priceTo": { "type": "integer", "format": "int32" }, "displayPrice": { "type": "string" } } }, "Domain.SearchService.v2.Model.DomainSearchContractsV2Media": { "type": "object", "properties": { "category": { "enum": [ "Image" ], "type": "string" }, "url": { "type": "string" } } }, "Domain.SearchService.v2.Model.DomainSearchContractsV2PropertyDetails": { "type": "object", "properties": { "state": { "enum": [ "ACT", "NSW", "QLD", "VIC", "SA", "WA", "NT", "TAS" ], "type": "string" }, "features": { "type": "array", "items": { "enum": [ "Unrecognised", "AirConditioning", "BuiltInWardrobes", "CableOrSatellite", "Ensuite", "Floorboards", "Gas", "InternalLaundry", "PetsAllowed", "SecureParking", "SwimmingPool", "Furnished", "GroundFloor", "WaterViews", "NorthFacing", "CityViews", "IndoorSpa", "Gym", "AlarmSystem", "Intercom", "BroadbandInternetAccess", "Bath", "Fireplace", "SeparateDiningRoom", "Heating", "Dishwasher", "Study", "TennisCourt", "Shed", "FullyFenced", "BalconyDeck", "GardenCourtyard", "OutdoorSpa", "DoubleGlazedWindows", "EnergyEfficientAppliances", "WaterEfficientAppliances", "WallCeilingInsulation", "RainwaterStorageTank", "GreywaterSystem", "WaterEfficientFixtures", "SolarHotWater", "SolarPanels" ], "type": "string" } }, "propertyType": { "enum": [ "Unknown", "AcreageSemiRural", "ApartmentUnitFlat", "Aquaculture", "BlockOfUnits", "CarSpace", "DairyFarming", "DevelopmentSite", "Duplex", "Farm", "FishingForestry", "NewHomeDesigns", "House", "NewHouseLand", "IrrigationServices", "NewLand", "Livestock", "NewApartments", "Penthouse", "RetirementVillage", "Rural", "SemiDetached", "SpecialistFarm", "Studio", "Terrace", "Townhouse", "VacantLand", "Villa", "Cropping", "Viticulture", "MixedFarming", "Grazing", "Horticulture", "Equine", "Farmlet", "Orchard", "RuralLifestyle" ], "type": "string" }, "allPropertyTypes": { "type": "array", "items": { "enum": [ "Unknown", "AcreageSemiRural", "ApartmentUnitFlat", "Aquaculture", "BlockOfUnits", "CarSpace", "DairyFarming", "DevelopmentSite", "Duplex", "Farm", "FishingForestry", "NewHomeDesigns", "House", "NewHouseLand", "IrrigationServices", "NewLand", "Livestock", "NewApartments", "Penthouse", "RetirementVillage", "Rural", "SemiDetached", "SpecialistFarm", "Studio", "Terrace", "Townhouse", "VacantLand", "Villa", "Cropping", "Viticulture", "MixedFarming", "Grazing", "Horticulture", "Equine", "Farmlet", "Orchard", "RuralLifestyle" ], "type": "string" } }, "bathrooms": { "type": "number", "format": "float" }, "bedrooms": { "type": "number", "format": "float" }, "carspaces": { "type": "integer", "format": "int32" }, "unitNumber": { "type": "string" }, "streetNumber": { "type": "string" }, "street": { "type": "string" }, "area": { "type": "string" }, "region": { "type": "string" }, "suburb": { "type": "string" }, "suburbId": { "type": "integer", "format": "int32" }, "postcode": { "type": "string" }, "displayableAddress": { "type": "string" }, "latitude": { "type": "number", "format": "float" }, "longitude": { "type": "number", "format": "float" }, "mapCertainty": { "type": "integer", "format": "int32" }, "landArea": { "type": "number", "format": "double" }, "buildingArea": { "type": "number", "format": "double" }, "onlyShowProperties": { "type": "array", "items": { "type": "string" } }, "displayAddressType": { "type": "string" }, "isRural": { "type": "boolean" }, "topSpotKeywords": { "type": "array", "items": { "type": "string" } }, "isNew": { "type": "boolean" }, "tags": { "type": "array", "items": { "type": "string" } } } }, "Domain.SearchService.v2.Model.DomainSearchContractsV2AuctionSchedule": { "type": "object", "properties": { "time": { "type": "string", "format": "date-time" }, "auctionLocation": { "type": "string" } } }, "Domain.SearchService.v2.Model.DomainSearchContractsV2Inspection": { "type": "object", "properties": { "openingTime": { "type": "string", "format": "date-time" }, "closingTime": { "type": "string", "format": "date-time" } } }, "Domain.SearchService.v2.Model.DomainSearchContractsV2InspectionSchedule": { "type": "object", "properties": { "byAppointment": { "type": "boolean" }, "recurring": { "type": "boolean" }, "times": { "type": "array", "items": { "$ref": "#/components/schemas/Domain.SearchService.v2.Model.DomainSearchContractsV2Inspection" } } } }, "Domain.SearchService.v2.Model.DomainSearchContractsV2SoldData": { "type": "object", "properties": { "source": { "enum": [ "Agency", "Apm" ], "type": "string" }, "saleMethod": { "enum": [ "NotStated", "SoldByAuction", "SoldByPrivateTreaty", "Withdrawn", "SoldPriorToAuction" ], "type": "string" }, "soldDate": { "type": "string", "format": "date-time" }, "soldPrice": { "type": "integer", "format": "int32" } } }, "Domain.SearchService.v2.Model.DomainSearchContractsV2PropertyListing": { "type": "object", "properties": { "promoLevel": { "enum": [ "Standard", "StandardPP", "Elite", "ElitePP", "PremiumPlus" ], "type": "string" }, "listingType": { "enum": [ "Sale", "Rent", "Share", "Sold", "NewHomes" ], "type": "string" }, "id": { "type": "integer", "format": "int32" }, "projectId": { "type": "integer", "format": "int32" }, "advertiser": { "$ref": "#/components/schemas/Domain.SearchService.v2.Model.DomainSearchContractsV2Advertiser" }, "priceDetails": { "$ref": "#/components/schemas/Domain.SearchService.v2.Model.DomainSearchContractsV2PriceDetails" }, "media": { "type": "array", "items": { "$ref": "#/components/schemas/Domain.SearchService.v2.Model.DomainSearchContractsV2Media" } }, "propertyDetails": { "$ref": "#/components/schemas/Domain.SearchService.v2.Model.DomainSearchContractsV2PropertyDetails" }, "headline": { "type": "string" }, "summaryDescription": { "type": "string" }, "hasFloorplan": { "type": "boolean" }, "hasVideo": { "type": "boolean" }, "labels": { "type": "array", "items": { "type": "string" } }, "auctionSchedule": { "$ref": "#/components/schemas/Domain.SearchService.v2.Model.DomainSearchContractsV2AuctionSchedule" }, "dateAvailable": { "type": "string", "format": "date-time" }, "dateListed": { "type": "string", "format": "date-time" }, "inspectionSchedule": { "$ref": "#/components/schemas/Domain.SearchService.v2.Model.DomainSearchContractsV2InspectionSchedule" }, "soldData": { "$ref": "#/components/schemas/Domain.SearchService.v2.Model.DomainSearchContractsV2SoldData" }, "listingSlug": { "type": "string" } } }, "Domain.SearchService.v2.Model.DomainSearchContractsV2Project": { "type": "object", "properties": { "promoLevel": { "enum": [ "Standard", "Premium" ], "type": "string" }, "state": { "enum": [ "ACT", "NSW", "QLD", "VIC", "SA", "WA", "NT", "TAS" ], "type": "string" }, "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "bannerUrl": { "type": "string" }, "preferredColorHex": { "type": "string" }, "logoUrl": { "type": "string" }, "labels": { "type": "array", "items": { "type": "string" } }, "displayableAddress": { "type": "string" }, "suburb": { "type": "string" }, "suburbId": { "type": "integer", "format": "int32" }, "features": { "type": "array", "items": { "type": "string" } }, "media": { "type": "array", "items": { "$ref": "#/components/schemas/Domain.SearchService.v2.Model.DomainSearchContractsV2Media" } }, "projectSlug": { "type": "string" } } }, "Domain.SearchService.v2.Model.DomainSearchContractsV2SearchResult": { "type": "object", "properties": { "type": { "enum": [ "PropertyListing", "Project" ], "type": "string" }, "listing": { "$ref": "#/components/schemas/Domain.SearchService.v2.Model.DomainSearchContractsV2PropertyListing" }, "listings": { "type": "array", "items": { "$ref": "#/components/schemas/Domain.SearchService.v2.Model.DomainSearchContractsV2PropertyListing" } }, "project": { "$ref": "#/components/schemas/Domain.SearchService.v2.Model.DomainSearchContractsV2Project" } }, "x-data-access-level-info": { "Basic": [ "Type", "Listing", "Listings", "Project" ], "Detailed": [ "Type", "Listing", "Listings", "Project" ], "Full": [ "Type", "Listing", "Listings", "Project" ] } }, "ListingAdmin.v2.ParkingDetails": { "required": [ "parkingType", "numberOfSpaces" ], "type": "object", "properties": { "parkingType": { "enum": [ "onSite", "onStreet", "noParking", "garage", "carport", "outdoor" ], "type": "string", "description": "Can have the value \"OnSite\", \"OnStreet\", \"NoParking\". Default: \"NoParking\"" }, "numberOfSpaces": { "maximum": 2147483647, "minimum": 0, "type": "integer", "description": "Number of parking spaces on site", "format": "int32" } }, "description": "Parking Details" }, "ListingAdmin.v2.ParkingInfo": { "type": "object", "properties": { "details": { "type": "array", "items": { "$ref": "#/components/schemas/ListingAdmin.v2.ParkingDetails" }, "description": "Details for available parking spaces" }, "information": { "maxLength": 200, "minLength": 0, "type": "string", "description": "Additional information regarding the parking condition" } }, "description": "Parking Details" }, "ListingAdmin.v2.ResidentialOffMarketProperty": { "required": [ "propertyType", "address" ], "type": "object", "properties": { "propertyType": { "type": "array", "items": { "enum": [ "acreageSemiRural", "apartmentUnitFlat", "aquaculture", "blockOfUnits", "carSpace", "dairyFarming", "developmentSite", "duplex", "farm", "fishingForestry", "newHomeDesigns", "house", "newHouseLand", "irrigationServices", "newLand", "livestock", "newApartments", "penthouse", "retirement", "rural", "semiDetached", "specialistFarm", "studio", "terrace", "townhouse", "vacantLand", "villa", "cropping", "viticulture", "mixedFarming", "grazing", "horticulture", "equine", "farmlet", "orchard", "ruralLifestyle" ], "type": "string" }, "description": "Residential property types
\r\n'Retirement' requires at least one more property type to be specified with it (for example: \"Retirement\", \"ApartmentUnitFlat\") ['acreageSemiRural', 'apartmentUnitFlat', 'aquaculture', 'blockOfUnits', 'carSpace', 'dairyFarming', 'developmentSite', 'duplex', 'farm', 'fishingForestry', 'newHomeDesigns', 'house', 'newHouseLand', 'irrigationServices', 'newLand', 'livestock', 'newApartments', 'penthouse', 'retirement', 'rural', 'semiDetached', 'specialistFarm', 'studio', 'terrace', 'townhouse', 'vacantLand', 'villa', 'cropping', 'viticulture', 'mixedFarming', 'grazing', 'horticulture', 'equine', 'farmlet', 'orchard', 'ruralLifestyle']." }, "bedRooms": { "maximum": 2147483647, "minimum": 0, "type": "integer", "description": "Number of bedrooms", "format": "int32" }, "bathRooms": { "maximum": 2147483647, "minimum": 0, "type": "integer", "description": "Number of bathrooms", "format": "int32" }, "parkingInfo": { "$ref": "#/components/schemas/ListingAdmin.v2.ParkingInfo" }, "images": { "type": "array", "items": { "$ref": "#/components/schemas/ListingAdmin.v2.PropertyMedia" }, "description": "List of image files, photos or floor plans related to the listing.\r\nSupported image file formats: AVIF, BMP, GIF, HEIF/HEIC, JPEG, JPEG 2000, PNG, TIFF, WebP.\r\nThe file size is restricted to maximum 100MB.\r\nWe recommend against using transparent backgrounds.\r\nSome image formats, such as PNG, support transparency, but when images with transparent areas are resized, they may be converted to a format that doesn’t support transparency, such as JPEG.\r\nBy default, transparent areas are converted to black, but the application displaying the image may convert the transparent area to the most appropriate colour for the area where the image is being placed." }, "address": { "$ref": "#/components/schemas/ListingAdmin.v2.Address" }, "area": { "$ref": "#/components/schemas/ListingAdmin.v2.Area" }, "landArea": { "$ref": "#/components/schemas/ListingAdmin.v2.LandArea" } }, "description": "Residential off market property" }, "ListingAdmin.v2.ResidentialOffMarketListing": { "required": [ "domainAgencyID", "providerAdId", "listingAction", "offMarketDetails", "propertyDetails" ], "type": "object", "properties": { "listingProvider": { "type": "string", "description": "A string identifying the data provider" }, "domainAgencyID": { "maximum": 2147483647, "minimum": 0, "type": "integer", "description": "The Domain Agency ID", "format": "int32" }, "providerAdId": { "maxLength": 50, "minLength": 0, "type": "string", "description": "External Advertisement Id of up to 50 characters will be stored.
\r\nThis value is used to identify an Advertisement for updates and should be unique for listing provider.
\r\nThis value is case-insensitive (meaning AAAA will update aaaa)." }, "description": { "maxLength": 6000, "minLength": 0, "type": "string", "description": "Description of the property.\r\n6000 characters in length. The following HTML elements are permitted: <br />, <p></p>, &nbsp;. HTML must be well-formed.\r\nCarriage Returns are interpreted as line breaks. Foreign characters must be HTML encoded, e.g., façade for façade.\r\nUnicode characters which are unsupported by Latin-1 (ISO-8859-1 range from U+0080 to U+00FF), will be removed https://en.wikipedia.org/wiki/ISO/IEC_8859-1" }, "summary": { "maxLength": 250, "minLength": 0, "type": "string", "description": "'Headline' Any HTML stripped out. If the Summary is less than 80 characters long then the description is concatenated to it and the total trimmed to 250 characters." }, "contacts": { "type": "array", "items": { "$ref": "#/components/schemas/ListingAdmin.v2.Contact" }, "description": "Minimum required attributes: First name, last name and E-mail.\r\nIf the DomainAgentId is provided, contact information will be based on the existing agent found for that id.\r\nOtherwise first name, last name and email will be used to find the matching contact. A new contact will be created if no contact can be found." }, "listingAction": { "enum": [ "sale", "rent" ], "type": "string", "description": "Sale or Rent" }, "offMarketDetails": { "$ref": "#/components/schemas/ListingAdmin.v2.OffMarketDetailsBase" }, "propertyDetails": { "$ref": "#/components/schemas/ListingAdmin.v2.ResidentialOffMarketProperty" } }, "description": "Residential off market listing" }, "SearchService.v2.DomainSearchWebApiV2ModelsSearchLocation": { "type": "object", "properties": { "state": { "enum": [ "ACT", "NSW", "QLD", "VIC", "SA", "WA", "NT", "TAS" ], "type": "string", "description": "Gets or Sets State" }, "region": { "type": "string", "description": "See http://location-api.domain.com.au/locations/regions", "nullable": true }, "area": { "type": "string", "description": "See http://location-api.domain.com.au/locations/areas", "nullable": true }, "suburb": { "type": "string", "description": "The name of the suburb i.e Sydney", "nullable": true }, "postCode": { "type": "string", "description": "The post code for the suburb i.e 2000", "nullable": true }, "includeSurroundingSuburbs": { "type": "boolean", "description": "Return listing in surrounding suburbs
This works only if a location is a complete suburb match (State, Suburb, Postcode)", "nullable": true }, "surroundingRadiusInMeters": { "maximum": 200000, "minimum": 1, "type": "integer", "description": "RadiusInMeters to add to the search area
It will be used to construct a circular search area based on suburb mid point.
This area will be searched in additional to the provided suburb (i.e. the results will belong to either suburb Or Circular area) Radius Search works only for Suburb and will limit the results on selected suburb's state. i.e. If calculated circular area overlapes with a different state, overlapping area will be ignored.
Minimum Value: 1
Maximum Value: 200000", "format": "int32", "nullable": true }, "definesPostcodeOnly": { "type": "boolean", "description": "If `true`, this instance has a postcode and nothing more.", "nullable": true, "readOnly": true } }, "additionalProperties": false, "description": "DomainSearchWebApiV2ModelsSearchLocation", "x-data-access-level-info": { "Basic": [ "*" ], "Detailed": [ "*" ], "Full": [ "*" ] } }, "SearchService.v2.DomainSearchWebApiV2ModelsSchoolCatchment": { "type": "object", "properties": { "name": { "type": "string", "description": "Gets or Sets Name", "nullable": true }, "state": { "type": "string", "description": "Gets or Sets State", "nullable": true }, "postcode": { "type": "string", "description": "Gets or Sets Postcode", "nullable": true } }, "additionalProperties": false, "description": "DomainSearchWebApiV2ModelsSchoolCatchment", "x-data-access-level-info": { "Basic": [ "*" ], "Detailed": [ "*" ], "Full": [ "*" ] } }, "SearchService.v2.DomainSearchWebApiV2ModelsCustomSortElement": { "type": "object", "properties": { "field": { "enum": [ "AdId", "PromoLevelScore", "FreshnessLevel", "ProductBoost", "DateUpdated", "DateListed", "SuburbName", "PriceDisplayOption", "SoldDate", "Price", "EarliestInspectionOpenTime", "EarliestAuctionTime", "DateAvailable" ], "type": "string", "description": "Gets or Sets Field" }, "direction": { "enum": [ "Ascending", "Descending" ], "type": "string", "description": "Gets or Sets Direction" } }, "additionalProperties": false, "description": "DomainSearchWebApiV2ModelsCustomSortElement", "x-data-access-level-info": { "Basic": [ "*" ], "Detailed": [ "*" ], "Full": [ "*" ] } }, "SearchService.v2.DomainSearchWebApiV2ModelsCustomSort": { "type": "object", "properties": { "elements": { "type": "array", "items": { "$ref": "#/components/schemas/SearchService.v2.DomainSearchWebApiV2ModelsCustomSortElement" }, "description": "The elements (field + direction) that comprise the custom sort. Order is significant, so each sort element will be applied in the order that it appears in the array. If this array is `null` or empty, no sort order will be applied, other than potentially surrounding suburbs boost.", "nullable": true }, "boostPrimarySuburbs": { "type": "boolean", "description": "Gets or Sets BoostPrimarySuburbs", "nullable": true } }, "additionalProperties": false, "description": "Defines a sort order comprised of 0 or more elements (Domain.Search.Web.Api.v2.Models.CustomSortElement).
Each element is applied in the order specified. An element is a combination of field (Domain.Search.Web.Api.v2.Models.CustomSortField) and direction (Domain.Search.Web.Api.v2.Models.SortDirection).", "x-data-access-level-info": { "Basic": [ "*" ], "Detailed": [ "*" ], "Full": [ "*" ] } }, "SearchService.v2.DomainSearchWebApiV2ModelsSortBy": { "type": "object", "properties": { "sortKey": { "enum": [ "Default", "Suburb", "Price", "DateUpdated", "InspectionTime", "AuctionTime", "SoldDate", "DefaultThenDateUpdated", "DateAvailable", "DateListed" ], "type": "string", "description": "Gets or Sets SortKey" }, "direction": { "enum": [ "Ascending", "Descending" ], "type": "string", "description": "Gets or Sets Direction" } }, "additionalProperties": false, "description": "DomainSearchWebApiV2ModelsSortBy", "x-data-access-level-info": { "Basic": [ "*" ], "Detailed": [ "*" ], "Full": [ "*" ] } }, "SearchService.v2.DomainSearchWebApiV2ModelsGeoPoint": { "type": "object", "properties": { "lat": { "type": "number", "description": "Latitude coordinate", "format": "double", "nullable": true }, "lon": { "type": "number", "description": "Longitude coordinate", "format": "double", "nullable": true } }, "additionalProperties": false, "description": "DomainSearchWebApiV2ModelsGeoPoint", "x-data-access-level-info": { "Basic": [ "*" ], "Detailed": [ "*" ], "Full": [ "*" ] } }, "SearchService.v2.DomainSearchWebApiV2ModelsBox": { "type": "object", "properties": { "topLeft": { "$ref": "#/components/schemas/SearchService.v2.DomainSearchWebApiV2ModelsGeoPoint" }, "bottomRight": { "$ref": "#/components/schemas/SearchService.v2.DomainSearchWebApiV2ModelsGeoPoint" } }, "additionalProperties": false, "description": "DomainSearchWebApiV2ModelsBox", "x-data-access-level-info": { "Basic": [ "*" ], "Detailed": [ "*" ], "Full": [ "*" ] } }, "SearchService.v2.DomainSearchWebApiV2ModelsCircle": { "required": [ "radiusInMeters" ], "type": "object", "properties": { "center": { "$ref": "#/components/schemas/SearchService.v2.DomainSearchWebApiV2ModelsGeoPoint" }, "radiusInMeters": { "maximum": 2147483647, "minimum": 0, "type": "integer", "description": "Gets or Sets RadiusInMeters", "format": "int32" } }, "additionalProperties": false, "description": "DomainSearchWebApiV2ModelsCircle", "x-data-access-level-info": { "Basic": [ "*" ], "Detailed": [ "*" ], "Full": [ "*" ] } }, "SearchService.v2.DomainSearchWebApiV2ModelsPolygon": { "type": "object", "properties": { "points": { "type": "array", "items": { "$ref": "#/components/schemas/SearchService.v2.DomainSearchWebApiV2ModelsGeoPoint" }, "description": "You must provide at least three points to form a polygon", "nullable": true } }, "additionalProperties": false, "description": "DomainSearchWebApiV2ModelsPolygon", "x-data-access-level-info": { "Basic": [ "*" ], "Detailed": [ "*" ], "Full": [ "*" ] } }, "SearchService.v2.DomainSearchWebApiV2ModelsGeoWindow": { "type": "object", "properties": { "box": { "$ref": "#/components/schemas/SearchService.v2.DomainSearchWebApiV2ModelsBox" }, "circle": { "$ref": "#/components/schemas/SearchService.v2.DomainSearchWebApiV2ModelsCircle" }, "polygon": { "$ref": "#/components/schemas/SearchService.v2.DomainSearchWebApiV2ModelsPolygon" } }, "additionalProperties": false, "description": "Define different geo filter shapes", "x-data-access-level-info": { "Basic": [ "*" ], "Detailed": [ "*" ], "Full": [ "*" ] } }, "SearchService.v2.DomainSearchWebApiV2ModelsTagQuery": { "type": "object", "properties": { "tag": { "type": "string", "description": "The tag value.", "nullable": true }, "criteria": { "enum": [ "Include", "Exclude" ], "type": "string", "description": "Gets or Sets Criteria" } }, "additionalProperties": false, "description": "Used to indicate whether listings with a given Domain.Search.Web.Api.v2.Models.TagQuery.Tag should be included or excluded, based on the Domain.Search.Web.Api.v2.Models.TagCriteria.", "x-data-access-level-info": { "Basic": [ "*" ], "Detailed": [ "*" ], "Full": [ "*" ] } }, "SearchService.v2.DomainSearchWebApiV2ModelsSearchParameters": { "type": "object", "properties": { "listingType": { "enum": [ "Sale", "Rent", "Share", "Sold", "NewHomes" ], "type": "string", "description": "Gets or Sets ListingType" }, "saleMethods": { "type": "array", "items": { "enum": [ "NotStated", "Auction", "PrivateTreaty", "Tender", "ExpressionOfInterest" ], "type": "string", "description": "Defines Domain.Search.Web.Api.V2.Models.SaleMethod" }, "description": "Gets or Sets SaleMethods", "nullable": true }, "minBedrooms": { "type": "number", "description": "Filter listing by minimum number of bedrooms", "format": "float", "nullable": true }, "maxBedrooms": { "type": "number", "description": "Filter listing by maximum number of bedrooms", "format": "float", "nullable": true }, "minBathrooms": { "type": "number", "description": "Filter listing by minimum number of bathrooms", "format": "float", "nullable": true }, "maxBathrooms": { "type": "number", "description": "Filter listing by maximum number of bathrooms 0.5 means no shower", "format": "float", "nullable": true }, "minCarspaces": { "maximum": 2147483647, "minimum": 0, "type": "integer", "description": "Filter listing by minimum number of car spaces", "format": "int32", "nullable": true }, "maxCarspaces": { "maximum": 2147483647, "minimum": 0, "type": "integer", "description": "Filter listing by maximum number of car spaces", "format": "int32", "nullable": true }, "minPrice": { "maximum": 2147483647, "minimum": 0, "type": "integer", "description": "Filter listing at or above a minimum price", "format": "int32", "nullable": true }, "maxPrice": { "maximum": 2147483647, "minimum": 0, "type": "integer", "description": "Filter listing at or below a maximum price", "format": "int32", "nullable": true }, "minLandArea": { "maximum": 2147483647, "minimum": 0, "type": "integer", "description": "Min Land Area in square meters", "format": "int32", "nullable": true }, "maxLandArea": { "maximum": 2147483647, "minimum": 0, "type": "integer", "description": "Max Land Area in square meters", "format": "int32", "nullable": true }, "advertiserIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Return listings only created by these agencies.", "nullable": true }, "adIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Filter based on Ad Ids (Include in search result if AdID is in this list)", "nullable": true }, "excludeAdIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Filter out listings with Ad Ids (Exclude listings from search result if AdID is in this list)", "nullable": true }, "propertyTypes": { "type": "array", "items": { "enum": [ "AcreageSemiRural", "ApartmentUnitFlat", "Aquaculture", "BlockOfUnits", "CarSpace", "DairyFarming", "DevelopmentSite", "Duplex", "Farm", "FishingForestry", "NewHomeDesigns", "House", "NewHouseLand", "IrrigationServices", "NewLand", "Livestock", "NewApartments", "Penthouse", "RetirementVillage", "Rural", "SemiDetached", "SpecialistFarm", "Studio", "Terrace", "Townhouse", "VacantLand", "Villa", "Cropping", "Viticulture", "MixedFarming", "Grazing", "Horticulture", "Equine", "Farmlet", "Orchard", "RuralLifestyle" ], "type": "string", "description": "Defines Domain.Search.Web.Api.v2.Models.PropertyType" }, "description": "Filter by one or more types of properties", "nullable": true }, "propertyFeatures": { "type": "array", "items": { "enum": [ "AirConditioning", "BuiltInWardrobes", "CableOrSatellite", "Ensuite", "Floorboards", "Gas", "InternalLaundry", "PetsAllowed", "SecureParking", "SwimmingPool", "Furnished", "GroundFloor", "WaterViews", "NorthFacing", "CityViews", "IndoorSpa", "Gym", "AlarmSystem", "Intercom", "BroadbandInternetAccess", "Bath", "Fireplace", "SeparateDiningRoom", "Heating", "Dishwasher", "Study", "TennisCourt", "Shed", "FullyFenced", "BalconyDeck", "GardenCourtyard", "OutdoorSpa", "DoubleGlazedWindows", "EnergyEfficientAppliances", "WaterEfficientAppliances", "WallCeilingInsulation", "RainwaterStorageTank", "GreywaterSystem", "WaterEfficientFixtures", "SolarHotWater", "SolarPanels" ], "type": "string", "description": "Defines Domain.Search.Web.Api.v2.Models.SearchPropertyFeature" }, "description": "Filter by one or more property features such as Gas or AC", "nullable": true }, "locations": { "type": "array", "items": { "$ref": "#/components/schemas/SearchService.v2.DomainSearchWebApiV2ModelsSearchLocation" }, "description": "Filter by the locations either suburb, area, region or state
Can also be used to search suburb and some area around it if radius is provided.
Invalid locations will return no results.
If Domain.Search.Web.Api.v2.Models.SearchLocation.IncludeSurroundingSuburbs is set to `true`, surrounding suburbs will also be searched for.", "nullable": true }, "schoolCatchments": { "type": "array", "items": { "$ref": "#/components/schemas/SearchService.v2.DomainSearchWebApiV2ModelsSchoolCatchment" }, "description": "one or more school identifiers to find the listings in their catchment area", "nullable": true }, "locationTerms": { "type": "string", "description": "Filter by location terms. This can be used in conjunction with Locations", "nullable": true }, "keywords": { "type": "array", "items": { "type": "string" }, "description": "Filter by one or more keywords that a listing should contain", "nullable": true }, "listingAttributes": { "type": "array", "items": { "enum": [ "HasPhotos", "HasPrice", "NotUpForAuction", "NotUnderContract", "MarkedAsNew", "HasMatterport" ], "type": "string", "description": "Defines Domain.Search.Web.Api.v2.Models.ListingAttribute" }, "description": "Limit the results to listing with specific attributes", "nullable": true }, "newDevOnly": { "type": "boolean", "description": "Gets or Sets NewDevOnly", "nullable": true }, "inspectionFrom": { "type": "string", "description": "Filter listings with inspection time on or from the date specified. Strings of the format: yyyy-MM-dd are acceptable.", "format": "date-time", "nullable": true }, "inspectionTo": { "type": "string", "description": "Filter listings with inspection time on or before date specified. Strings of the format: yyyy-MM-dd are acceptable.", "format": "date-time", "nullable": true }, "auctionFrom": { "type": "string", "description": "Filter listings with auction time on or from the date specified. Strings of the format: yyyy-MM-dd are acceptable.", "format": "date-time", "nullable": true }, "auctionTo": { "type": "string", "description": "Filter listings with auction on or before from the date specified. Strings of the format: yyyy-MM-dd are acceptable.", "format": "date-time", "nullable": true }, "dateAvailableFrom": { "type": "string", "description": "Return only those listings whose DateAvailable is null, or is at or after the specified time. Strings of the format: yyyy-MM-dd are acceptable.", "format": "date-time", "nullable": true }, "dateAvailableTo": { "type": "string", "description": "Return only those listings whose DateAvailable is null, or is at or before the specified time. Strings of the format: yyyy-MM-dd are acceptable.", "format": "date-time", "nullable": true }, "ruralOnly": { "type": "boolean", "description": "if true, the response will include only listings flagged with IsRural", "nullable": true }, "excludePriceWithheld": { "type": "boolean", "description": "If `true`, exclude listings whose price has been withheld.", "nullable": true }, "excludeDepositTaken": { "type": "boolean", "description": "If `true`c>, exclude listings (rental) has deposit taken", "nullable": true }, "topspotKeywords": { "type": "array", "items": { "type": "string" }, "description": "Search by topspot keywords", "nullable": true }, "customSort": { "$ref": "#/components/schemas/SearchService.v2.DomainSearchWebApiV2ModelsCustomSort" }, "sort": { "$ref": "#/components/schemas/SearchService.v2.DomainSearchWebApiV2ModelsSortBy" }, "page": { "type": "integer", "description": "The specific result page to return. Defaults to 1 when omitted or less than zero.", "format": "int32", "nullable": true }, "pageSize": { "maximum": 200, "minimum": 0, "type": "integer", "description": "Specify the number of result items in a page", "format": "int32", "nullable": true }, "geoWindow": { "$ref": "#/components/schemas/SearchService.v2.DomainSearchWebApiV2ModelsGeoWindow" }, "updatedSince": { "type": "string", "description": "Only return listings that have been updated since the specified date. Strings of the format: yyyy-MM-dd are acceptable.", "format": "date-time", "nullable": true }, "listedSince": { "type": "string", "description": "Only return listings that have been listed since the specified date. Strings of the format: yyyy-MM-dd are acceptable.", "format": "date-time", "nullable": true }, "propertyEstablishedType": { "enum": [ "Any", "New", "Established" ], "type": "string", "description": "Gets or Sets PropertyEstablishedType" }, "includeInspectionAggregations": { "type": "boolean", "description": "Gets or Sets IncludeInspectionAggregations", "nullable": true }, "tags": { "type": "array", "items": { "$ref": "#/components/schemas/SearchService.v2.DomainSearchWebApiV2ModelsTagQuery" }, "description": "
Filter listings based on a combination of tag value and inclusion/exclusion criteria. For all of the tags whose criteria is \\\"include\\\": include only those listings in the search results that have one or more of these tags. For all of the tags whose criteria is \\\"exclude\\\": exclude listings that have one or more of these tags from the search results.
Example: return only those listings that have the \\\"red\\\" or \\\"blue\\\" tags, but exclude any that also have a \\\"green\\\" tag. \\\"tags\\\": [ { \\\"criteria\\\": \\\"include\\\", \\\"Tag\\\": \\\"red\\\" }, { \\\"criteria\\\": \\\"include\\\", \\\"tag\\\": \\\"blue\\\" }, { \\\"criteria\\\": \\\"exclude\\\", \\\"tag\\\": \\\"green\\\" } ]
Summary of the available tags and their meanings. retirement Property is suitable for retirement. rural Rural listing. newdevelopment A newly-developed property. ", "nullable": true }, "aggregations": { "type": "array", "items": { "type": "string" }, "description": "Gets or Sets Aggregations", "nullable": true } }, "additionalProperties": false, "description": "Represents a v2 search request. Top-level parameters are combined as a logical conjunction (i.e. like a SQL 'AND'). Responses will contain both standalone listings and development Domain.Search.Contracts.v2.Projects. Projects contain up to 4 matching child listings. Note that it's currently not possible to exclude projects from search results. Both standalone and child listings are modelled using the Domain.Search.Contracts.v2.PropertyListing class. Please do not make properties on this DTO nullable if you would like to enforce validation failures when they are explicitly provided a null value", "x-data-access-level-info": { "Basic": [ "*" ], "Detailed": [ "*" ], "Full": [ "*" ] } }, "SearchService.v2.DomainSearchContractsV2Contact": { "type": "object", "properties": { "name": { "type": "string", "description": "Gets or Sets Name", "nullable": true }, "photoUrl": { "type": "string", "description": "Gets or Sets PhotoUrl", "nullable": true } }, "additionalProperties": false, "description": "DomainSearchContractsV2Contact", "x-data-access-level-info": { "Basic": [ "*" ], "Detailed": [ "*" ], "Full": [ "*" ] } }, "SearchService.v2.DomainSearchContractsV2Advertiser": { "type": "object", "properties": { "id": { "type": "integer", "description": "Gets or Sets Id", "format": "int32", "nullable": true }, "type": { "enum": [ "Agency", "Private" ], "type": "string", "description": "Gets or Sets Type" }, "name": { "type": "string", "description": "Gets or Sets Name", "nullable": true }, "logoUrl": { "type": "string", "description": "Gets or Sets LogoUrl", "nullable": true }, "preferredColourHex": { "type": "string", "description": "Gets or Sets PreferredColourHex", "nullable": true }, "bannerUrl": { "type": "string", "description": "Gets or Sets BannerUrl", "nullable": true }, "contacts": { "type": "array", "items": { "$ref": "#/components/schemas/SearchService.v2.DomainSearchContractsV2Contact" }, "description": "Gets or Sets Contacts", "nullable": true } }, "additionalProperties": false, "description": "DomainSearchContractsV2Advertiser", "x-data-access-level-info": { "Basic": [ "*" ], "Detailed": [ "*" ], "Full": [ "*" ] } }, "SearchService.v2.DomainSearchContractsV2PriceDetails": { "type": "object", "properties": { "price": { "type": "integer", "description": "Gets or Sets Price", "format": "int32", "nullable": true }, "priceFrom": { "type": "integer", "description": "Gets or Sets PriceFrom", "format": "int32", "nullable": true }, "priceTo": { "type": "integer", "description": "Gets or Sets PriceTo", "format": "int32", "nullable": true }, "displayPrice": { "type": "string", "description": "Gets or Sets DisplayPrice", "nullable": true }, "canDisplayPrice": { "type": "boolean", "description": "Gets or Sets CanDisplayPrice", "nullable": true }, "depositTaken": { "type": "boolean", "description": "Gets or Sets DepositTaken", "nullable": true }, "saleMethod": { "enum": [ "NotStated", "Auction", "PrivateTreaty", "Tender", "ExpressionOfInterest" ], "type": "string", "description": "Gets or Sets SaleMethod" } }, "additionalProperties": false, "description": "DomainSearchContractsV2PriceDetails", "x-data-access-level-info": { "Basic": [ "*" ], "Detailed": [ "*" ], "Full": [ "*" ] } }, "SearchService.v2.DomainSearchContractsV2Media": { "type": "object", "properties": { "category": { "enum": [ "Image" ], "type": "string", "description": "Gets or Sets Category" }, "type": { "enum": [ "Photo", "Floorplan" ], "type": "string", "description": "Gets or Sets Type" }, "url": { "type": "string", "description": "Gets or Sets Url", "nullable": true } }, "additionalProperties": false, "description": "DomainSearchContractsV2Media", "x-data-access-level-info": { "Basic": [ "*" ], "Detailed": [ "*" ], "Full": [ "*" ] } }, "SearchService.v2.DomainSearchContractsV2PropertyDetails": { "type": "object", "properties": { "bathrooms": { "type": "number", "description": "Gets or Sets Bathrooms", "format": "float", "nullable": true }, "bedrooms": { "type": "number", "description": "Gets or Sets Bedrooms", "format": "float", "nullable": true }, "carspaces": { "type": "integer", "description": "Gets or Sets Carspaces", "format": "int32", "nullable": true }, "unitNumber": { "type": "string", "description": "Gets or Sets UnitNumber", "nullable": true }, "streetNumber": { "type": "string", "description": "Gets or Sets StreetNumber", "nullable": true }, "street": { "type": "string", "description": "Gets or Sets Street", "nullable": true }, "area": { "type": "string", "description": "Gets or Sets Area", "nullable": true }, "region": { "type": "string", "description": "Gets or Sets Region", "nullable": true }, "suburb": { "type": "string", "description": "Gets or Sets Suburb", "nullable": true }, "suburbId": { "type": "integer", "description": "Gets or Sets SuburbId", "format": "int32", "nullable": true }, "postcode": { "type": "string", "description": "Gets or Sets Postcode", "nullable": true }, "state": { "enum": [ "ACT", "NSW", "QLD", "VIC", "SA", "WA", "NT", "TAS" ], "type": "string", "description": "Gets or Sets State" }, "displayableAddress": { "type": "string", "description": "Gets or Sets DisplayableAddress", "nullable": true }, "features": { "type": "array", "items": { "enum": [ "Unrecognised", "AirConditioning", "BuiltInWardrobes", "CableOrSatellite", "Ensuite", "Floorboards", "Gas", "InternalLaundry", "PetsAllowed", "SecureParking", "SwimmingPool", "Furnished", "GroundFloor", "WaterViews", "NorthFacing", "CityViews", "IndoorSpa", "Gym", "AlarmSystem", "Intercom", "BroadbandInternetAccess", "Bath", "Fireplace", "SeparateDiningRoom", "Heating", "Dishwasher", "Study", "TennisCourt", "Shed", "FullyFenced", "BalconyDeck", "GardenCourtyard", "OutdoorSpa", "DoubleGlazedWindows", "EnergyEfficientAppliances", "WaterEfficientAppliances", "WallCeilingInsulation", "RainwaterStorageTank", "GreywaterSystem", "WaterEfficientFixtures", "SolarHotWater", "SolarPanels" ], "type": "string", "description": "Defines Domain.Search.Contracts.v2.PropertyFeature" }, "description": "Gets or Sets Features", "nullable": true }, "latitude": { "type": "number", "description": "Gets or Sets Latitude", "format": "float", "nullable": true }, "longitude": { "type": "number", "description": "Gets or Sets Longitude", "format": "float", "nullable": true }, "mapCertainty": { "type": "integer", "description": "Gets or Sets MapCertainty", "format": "int32", "nullable": true }, "propertyType": { "enum": [ "Unknown", "AcreageSemiRural", "ApartmentUnitFlat", "Aquaculture", "BlockOfUnits", "CarSpace", "DairyFarming", "DevelopmentSite", "Duplex", "Farm", "FishingForestry", "NewHomeDesigns", "House", "NewHouseLand", "IrrigationServices", "NewLand", "Livestock", "NewApartments", "Penthouse", "RetirementVillage", "Rural", "SemiDetached", "SpecialistFarm", "Studio", "Terrace", "Townhouse", "VacantLand", "Villa", "Cropping", "Viticulture", "MixedFarming", "Grazing", "Horticulture", "Equine", "Farmlet", "Orchard", "RuralLifestyle" ], "type": "string", "description": "Gets or Sets PropertyType" }, "allPropertyTypes": { "type": "array", "items": { "enum": [ "Unknown", "AcreageSemiRural", "ApartmentUnitFlat", "Aquaculture", "BlockOfUnits", "CarSpace", "DairyFarming", "DevelopmentSite", "Duplex", "Farm", "FishingForestry", "NewHomeDesigns", "House", "NewHouseLand", "IrrigationServices", "NewLand", "Livestock", "NewApartments", "Penthouse", "RetirementVillage", "Rural", "SemiDetached", "SpecialistFarm", "Studio", "Terrace", "Townhouse", "VacantLand", "Villa", "Cropping", "Viticulture", "MixedFarming", "Grazing", "Horticulture", "Equine", "Farmlet", "Orchard", "RuralLifestyle" ], "type": "string", "description": "Defines Domain.Search.Contracts.v2.PropertyType" }, "description": "Gets or Sets AllPropertyTypes", "nullable": true }, "landArea": { "type": "number", "description": "Gets or Sets LandArea", "format": "double", "nullable": true }, "buildingArea": { "type": "number", "description": "Gets or Sets BuildingArea", "format": "double", "nullable": true }, "onlyShowProperties": { "type": "array", "items": { "type": "string" }, "description": "Gets or Sets OnlyShowProperties", "nullable": true }, "displayAddressType": { "type": "string", "description": "Gets or Sets DisplayAddressType", "nullable": true }, "isRural": { "type": "boolean", "description": "Gets or Sets IsRural", "nullable": true }, "topSpotKeywords": { "type": "array", "items": { "type": "string" }, "description": "Gets or Sets TopSpotKeywords", "nullable": true }, "isNew": { "type": "boolean", "description": "Gets or Sets IsNew", "nullable": true }, "tags": { "type": "array", "items": { "type": "string" }, "description": "Gets or Sets Tags", "nullable": true } }, "additionalProperties": false, "description": "DomainSearchContractsV2PropertyDetails", "x-data-access-level-info": { "Basic": [ "*" ], "Detailed": [ "*" ], "Full": [ "*" ] } }, "SearchService.v2.DomainSearchContractsV2MatterportInterior": { "type": "object", "properties": { "matterportKey": { "type": "string", "description": "Gets or Sets MatterportKey", "nullable": true }, "matterportThumbnailUri": { "type": "string", "description": "Gets or Sets MatterportThumbnailUri", "nullable": true } }, "additionalProperties": false, "description": "DomainSearchContractsV2MatterportInterior", "x-data-access-level-info": { "Basic": [ "*" ], "Detailed": [ "*" ], "Full": [ "*" ] } }, "SearchService.v2.DomainSearchContractsV2MatterportExterior": { "type": "object", "properties": { "attachmentId": { "type": "integer", "description": "Gets or Sets AttachmentId", "format": "int64", "nullable": true }, "gaussianSplatKey": { "type": "string", "description": "Gets or Sets GaussianSplatKey", "nullable": true }, "gaussianThumbnailUri": { "type": "string", "description": "Gets or Sets GaussianThumbnailUri", "nullable": true } }, "additionalProperties": false, "description": "DomainSearchContractsV2MatterportExterior", "x-data-access-level-info": { "Basic": [ "*" ], "Detailed": [ "*" ], "Full": [ "*" ] } }, "SearchService.v2.DomainSearchContractsV2Matterport": { "type": "object", "properties": { "interior": { "$ref": "#/components/schemas/SearchService.v2.DomainSearchContractsV2MatterportInterior" }, "exterior": { "$ref": "#/components/schemas/SearchService.v2.DomainSearchContractsV2MatterportExterior" } }, "additionalProperties": false, "description": "DomainSearchContractsV2Matterport", "x-data-access-level-info": { "Basic": [ "*" ], "Detailed": [ "*" ], "Full": [ "*" ] } }, "SearchService.v2.DomainSearchContractsV2AuctionSchedule": { "type": "object", "properties": { "time": { "type": "string", "description": "Gets or Sets Time", "format": "date-time", "nullable": true }, "auctionLocation": { "type": "string", "description": "Gets or Sets AuctionLocation", "nullable": true } }, "additionalProperties": false, "description": "DomainSearchContractsV2AuctionSchedule", "x-data-access-level-info": { "Basic": [ "*" ], "Detailed": [ "*" ], "Full": [ "*" ] } }, "SearchService.v2.DomainSearchContractsV2Inspection": { "type": "object", "properties": { "openingTime": { "type": "string", "description": "Gets or Sets OpeningTime", "format": "date-time", "nullable": true }, "closingTime": { "type": "string", "description": "Gets or Sets ClosingTime", "format": "date-time", "nullable": true } }, "additionalProperties": false, "description": "DomainSearchContractsV2Inspection", "x-data-access-level-info": { "Basic": [ "*" ], "Detailed": [ "*" ], "Full": [ "*" ] } }, "SearchService.v2.DomainSearchContractsV2InspectionSchedule": { "type": "object", "properties": { "byAppointment": { "type": "boolean", "description": "Gets or Sets ByAppointment", "nullable": true }, "recurring": { "type": "boolean", "description": "Gets or Sets Recurring", "nullable": true }, "times": { "type": "array", "items": { "$ref": "#/components/schemas/SearchService.v2.DomainSearchContractsV2Inspection" }, "description": "Gets or Sets Times", "nullable": true } }, "additionalProperties": false, "description": "DomainSearchContractsV2InspectionSchedule", "x-data-access-level-info": { "Basic": [ "*" ], "Detailed": [ "*" ], "Full": [ "*" ] } }, "SearchService.v2.DomainSearchContractsV2SoldData": { "type": "object", "properties": { "source": { "enum": [ "Agency", "Apm" ], "type": "string", "description": "Gets or Sets Source" }, "soldDate": { "type": "string", "description": "Gets or Sets SoldDate", "format": "date-time", "nullable": true }, "soldPrice": { "type": "integer", "description": "Gets or Sets SoldPrice", "format": "int32", "nullable": true }, "saleMethod": { "enum": [ "NotStated", "SoldByAuction", "SoldByPrivateTreaty", "Withdrawn", "SoldPriorToAuction" ], "type": "string", "description": "Gets or Sets SaleMethod" } }, "additionalProperties": false, "description": "DomainSearchContractsV2SoldData", "x-data-access-level-info": { "Basic": [ "*" ], "Detailed": [ "*" ], "Full": [ "*" ] } }, "SearchService.v2.DomainSearchContractsV2PropertyListing": { "type": "object", "properties": { "id": { "type": "integer", "description": "Gets or Sets Id", "format": "int32", "nullable": true }, "projectId": { "type": "integer", "description": "Gets or Sets ProjectId", "format": "int32", "nullable": true }, "promoLevel": { "enum": [ "Standard", "StandardPP", "Elite", "ElitePP", "PremiumPlus" ], "type": "string", "description": "Gets or Sets PromoLevel" }, "listingType": { "enum": [ "Sale", "Rent", "Share", "Sold", "NewHomes" ], "type": "string", "description": "Gets or Sets ListingType" }, "advertiser": { "$ref": "#/components/schemas/SearchService.v2.DomainSearchContractsV2Advertiser" }, "priceDetails": { "$ref": "#/components/schemas/SearchService.v2.DomainSearchContractsV2PriceDetails" }, "media": { "type": "array", "items": { "$ref": "#/components/schemas/SearchService.v2.DomainSearchContractsV2Media" }, "description": "Gets or Sets Media", "nullable": true }, "propertyDetails": { "$ref": "#/components/schemas/SearchService.v2.DomainSearchContractsV2PropertyDetails" }, "headline": { "type": "string", "description": "Gets or Sets Headline", "nullable": true }, "summaryDescription": { "type": "string", "description": "Gets or Sets SummaryDescription", "nullable": true }, "hasFloorplan": { "type": "boolean", "description": "Gets or Sets HasFloorplan", "nullable": true }, "hasVideo": { "type": "boolean", "description": "Gets or Sets HasVideo", "nullable": true }, "matterport": { "$ref": "#/components/schemas/SearchService.v2.DomainSearchContractsV2Matterport" }, "labels": { "type": "array", "items": { "type": "string" }, "description": "Gets or Sets Labels", "nullable": true }, "auctionSchedule": { "$ref": "#/components/schemas/SearchService.v2.DomainSearchContractsV2AuctionSchedule" }, "dateAvailable": { "type": "string", "description": "Gets or Sets DateAvailable", "format": "date-time", "nullable": true }, "dateListed": { "type": "string", "description": "Gets or Sets DateListed", "format": "date-time", "nullable": true }, "inspectionSchedule": { "$ref": "#/components/schemas/SearchService.v2.DomainSearchContractsV2InspectionSchedule" }, "soldData": { "$ref": "#/components/schemas/SearchService.v2.DomainSearchContractsV2SoldData" }, "listingSlug": { "type": "string", "description": "Gets or Sets ListingSlug", "nullable": true } }, "additionalProperties": false, "description": "DomainSearchContractsV2PropertyListing", "x-data-access-level-info": { "Basic": [ "*" ], "Detailed": [ "*" ], "Full": [ "*" ] } }, "SearchService.v2.DomainSearchContractsV2Project": { "type": "object", "properties": { "id": { "type": "integer", "description": "Gets or Sets Id", "format": "int32", "nullable": true }, "name": { "type": "string", "description": "Gets or Sets Name", "nullable": true }, "promoLevel": { "enum": [ "Standard", "Premium" ], "type": "string", "description": "Gets or Sets PromoLevel" }, "bannerUrl": { "type": "string", "description": "Gets or Sets BannerUrl", "nullable": true }, "preferredColorHex": { "type": "string", "description": "Gets or Sets PreferredColorHex", "nullable": true }, "logoUrl": { "type": "string", "description": "Gets or Sets LogoUrl", "nullable": true }, "labels": { "type": "array", "items": { "type": "string" }, "description": "Gets or Sets Labels", "nullable": true }, "displayableAddress": { "type": "string", "description": "Gets or Sets DisplayableAddress", "nullable": true }, "suburb": { "type": "string", "description": "Gets or Sets Suburb", "nullable": true }, "suburbId": { "type": "integer", "description": "Gets or Sets SuburbId", "format": "int32", "nullable": true }, "state": { "enum": [ "ACT", "NSW", "QLD", "VIC", "SA", "WA", "NT", "TAS" ], "type": "string", "description": "Gets or Sets State" }, "features": { "type": "array", "items": { "type": "string" }, "description": "Gets or Sets Features", "nullable": true }, "media": { "type": "array", "items": { "$ref": "#/components/schemas/SearchService.v2.DomainSearchContractsV2Media" }, "description": "Gets or Sets Media", "nullable": true }, "projectSlug": { "type": "string", "description": "Gets or Sets ProjectSlug", "nullable": true }, "priceFrom": { "type": "integer", "description": "Gets or Sets PriceFrom", "format": "int32", "nullable": true } }, "additionalProperties": false, "description": "DomainSearchContractsV2Project", "x-data-access-level-info": { "Basic": [ "*" ], "Detailed": [ "*" ], "Full": [ "*" ] } }, "SearchService.v2.DomainSearchContractsV2SearchResult": { "type": "object", "properties": { "type": { "enum": [ "PropertyListing", "Project" ], "type": "string", "description": "Gets or Sets Type" }, "listing": { "$ref": "#/components/schemas/SearchService.v2.DomainSearchContractsV2PropertyListing" }, "listings": { "type": "array", "items": { "$ref": "#/components/schemas/SearchService.v2.DomainSearchContractsV2PropertyListing" }, "description": "Gets or Sets Listings", "nullable": true }, "project": { "$ref": "#/components/schemas/SearchService.v2.DomainSearchContractsV2Project" } }, "additionalProperties": false, "description": "DomainSearchContractsV2SearchResult", "x-data-access-level-info": { "Basic": [ "*" ], "Detailed": [ "*" ], "Full": [ "*" ] } }, "SearchService.v2.DomainSearchContractsV2ResultMetadata": { "type": "object", "properties": { "aggregations": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "type": "integer", "format": "int64" }, "nullable": true, "x-data-access-level-info": { "Basic": [ "*" ], "Detailed": [ "*" ], "Full": [ "*" ] } }, "description": "Gets or Sets Aggregations", "nullable": true, "x-data-access-level-info": { "Basic": [ "*" ], "Detailed": [ "*" ], "Full": [ "*" ] } }, "surroundingSuburbsListingsCount": { "type": "integer", "description": "Gets or Sets SurroundingSuburbsListingsCount", "format": "int64", "nullable": true }, "newHomesCount": { "type": "integer", "description": "Gets or Sets NewHomesCount", "format": "int64", "nullable": true }, "ruralListingsCount": { "type": "integer", "description": "Gets or Sets RuralListingsCount", "format": "int64", "nullable": true }, "medianPrice": { "type": "integer", "description": "Gets or Sets MedianPrice", "format": "int32", "nullable": true }, "totalListingsExcludingChildren": { "type": "integer", "description": "Gets or Sets TotalListingsExcludingChildren", "format": "int64", "nullable": true }, "surroundingSuburbsListingsExcludingChildren": { "type": "integer", "description": "Gets or Sets SurroundingSuburbsListingsExcludingChildren", "format": "int64", "nullable": true } }, "additionalProperties": false, "description": "DomainSearchContractsV2ResultMetadata", "x-data-access-level-info": { "Basic": [ "*" ], "Detailed": [ "*" ], "Full": [ "*" ] } }, "SearchService.v2.DomainSearchContractsV2SearchResults": { "type": "object", "properties": { "results": { "type": "array", "items": { "$ref": "#/components/schemas/SearchService.v2.DomainSearchContractsV2SearchResult" }, "description": "Gets or Sets Results", "nullable": true }, "totalResults": { "type": "integer", "description": "Gets or Sets TotalResults", "format": "int64", "nullable": true }, "totalPages": { "type": "integer", "description": "Gets or Sets TotalPages", "format": "int64", "nullable": true }, "page": { "type": "integer", "description": "Gets or Sets Page", "format": "int32", "nullable": true }, "metadata": { "$ref": "#/components/schemas/SearchService.v2.DomainSearchContractsV2ResultMetadata" }, "actualTotalResults": { "type": "integer", "description": "Gets or Sets ActualTotalResults", "format": "int64", "nullable": true }, "actualTotalResultsExceedsMaximum": { "type": "boolean", "description": "Gets or Sets ActualTotalResultsExceedsMaximum", "nullable": true } }, "additionalProperties": false, "description": "DomainSearchContractsV2SearchResults", "x-data-access-level-info": { "Basic": [ "*" ], "Detailed": [ "*" ], "Full": [ "*" ] } }, "SearchService.v2.DomainSearchWebApiV2ModelsSoldSearchParameters": { "type": "object", "properties": { "listingType": { "enum": [ "Sale", "Rent", "Share", "Sold", "NewHomes" ], "type": "string", "description": "Gets or Sets ListingType" }, "saleMethods": { "type": "array", "items": { "enum": [ "NotStated", "Auction", "PrivateTreaty", "Tender", "ExpressionOfInterest" ], "type": "string", "description": "Defines Domain.Search.Web.Api.V2.Models.SaleMethod" }, "description": "Gets or Sets SaleMethods", "nullable": true }, "minBedrooms": { "type": "number", "description": "Filter listing by minimum number of bedrooms", "format": "float", "nullable": true }, "maxBedrooms": { "type": "number", "description": "Filter listing by maximum number of bedrooms", "format": "float", "nullable": true }, "minBathrooms": { "type": "number", "description": "Filter listing by minimum number of bathrooms", "format": "float", "nullable": true }, "maxBathrooms": { "type": "number", "description": "Filter listing by maximum number of bathrooms 0.5 means no shower", "format": "float", "nullable": true }, "minCarspaces": { "maximum": 2147483647, "minimum": 0, "type": "integer", "description": "Filter listing by minimum number of car spaces", "format": "int32", "nullable": true }, "maxCarspaces": { "maximum": 2147483647, "minimum": 0, "type": "integer", "description": "Filter listing by maximum number of car spaces", "format": "int32", "nullable": true }, "minPrice": { "maximum": 2147483647, "minimum": 0, "type": "integer", "description": "Filter listing at or above a minimum price", "format": "int32", "nullable": true }, "maxPrice": { "maximum": 2147483647, "minimum": 0, "type": "integer", "description": "Filter listing at or below a maximum price", "format": "int32", "nullable": true }, "minLandArea": { "maximum": 2147483647, "minimum": 0, "type": "integer", "description": "Min Land Area in square meters", "format": "int32", "nullable": true }, "maxLandArea": { "maximum": 2147483647, "minimum": 0, "type": "integer", "description": "Max Land Area in square meters", "format": "int32", "nullable": true }, "advertiserIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Return listings only created by these agencies.", "nullable": true }, "adIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Filter based on Ad Ids (Include in search result if AdID is in this list)", "nullable": true }, "excludeAdIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Filter out listings with Ad Ids (Exclude listings from search result if AdID is in this list)", "nullable": true }, "propertyTypes": { "type": "array", "items": { "enum": [ "AcreageSemiRural", "ApartmentUnitFlat", "Aquaculture", "BlockOfUnits", "CarSpace", "DairyFarming", "DevelopmentSite", "Duplex", "Farm", "FishingForestry", "NewHomeDesigns", "House", "NewHouseLand", "IrrigationServices", "NewLand", "Livestock", "NewApartments", "Penthouse", "RetirementVillage", "Rural", "SemiDetached", "SpecialistFarm", "Studio", "Terrace", "Townhouse", "VacantLand", "Villa", "Cropping", "Viticulture", "MixedFarming", "Grazing", "Horticulture", "Equine", "Farmlet", "Orchard", "RuralLifestyle" ], "type": "string", "description": "Defines Domain.Search.Web.Api.v2.Models.PropertyType" }, "description": "Filter by one or more types of properties", "nullable": true }, "propertyFeatures": { "type": "array", "items": { "enum": [ "AirConditioning", "BuiltInWardrobes", "CableOrSatellite", "Ensuite", "Floorboards", "Gas", "InternalLaundry", "PetsAllowed", "SecureParking", "SwimmingPool", "Furnished", "GroundFloor", "WaterViews", "NorthFacing", "CityViews", "IndoorSpa", "Gym", "AlarmSystem", "Intercom", "BroadbandInternetAccess", "Bath", "Fireplace", "SeparateDiningRoom", "Heating", "Dishwasher", "Study", "TennisCourt", "Shed", "FullyFenced", "BalconyDeck", "GardenCourtyard", "OutdoorSpa", "DoubleGlazedWindows", "EnergyEfficientAppliances", "WaterEfficientAppliances", "WallCeilingInsulation", "RainwaterStorageTank", "GreywaterSystem", "WaterEfficientFixtures", "SolarHotWater", "SolarPanels" ], "type": "string", "description": "Defines Domain.Search.Web.Api.v2.Models.SearchPropertyFeature" }, "description": "Filter by one or more property features such as Gas or AC", "nullable": true }, "locations": { "type": "array", "items": { "$ref": "#/components/schemas/SearchService.v2.DomainSearchWebApiV2ModelsSearchLocation" }, "description": "Filter by the locations either suburb, area, region or state
Can also be used to search suburb and some area around it if radius is provided.
Invalid locations will return no results.
If Domain.Search.Web.Api.v2.Models.SearchLocation.IncludeSurroundingSuburbs is set to `true`, surrounding suburbs will also be searched for.", "nullable": true }, "schoolCatchments": { "type": "array", "items": { "$ref": "#/components/schemas/SearchService.v2.DomainSearchWebApiV2ModelsSchoolCatchment" }, "description": "one or more school identifiers to find the listings in their catchment area", "nullable": true }, "locationTerms": { "type": "string", "description": "Filter by location terms. This can be used in conjunction with Locations", "nullable": true }, "keywords": { "type": "array", "items": { "type": "string" }, "description": "Filter by one or more keywords that a listing should contain", "nullable": true }, "listingAttributes": { "type": "array", "items": { "enum": [ "HasPhotos", "HasPrice", "NotUpForAuction", "NotUnderContract", "MarkedAsNew", "HasMatterport" ], "type": "string", "description": "Defines Domain.Search.Web.Api.v2.Models.ListingAttribute" }, "description": "Limit the results to listing with specific attributes", "nullable": true }, "newDevOnly": { "type": "boolean", "description": "Gets or Sets NewDevOnly", "nullable": true }, "inspectionFrom": { "type": "string", "description": "Filter listings with inspection time on or from the date specified. Strings of the format: yyyy-MM-dd are acceptable.", "format": "date-time", "nullable": true }, "inspectionTo": { "type": "string", "description": "Filter listings with inspection time on or before date specified. Strings of the format: yyyy-MM-dd are acceptable.", "format": "date-time", "nullable": true }, "auctionFrom": { "type": "string", "description": "Filter listings with auction time on or from the date specified. Strings of the format: yyyy-MM-dd are acceptable.", "format": "date-time", "nullable": true }, "auctionTo": { "type": "string", "description": "Filter listings with auction on or before from the date specified. Strings of the format: yyyy-MM-dd are acceptable.", "format": "date-time", "nullable": true }, "dateAvailableFrom": { "type": "string", "description": "Return only those listings whose DateAvailable is null, or is at or after the specified time. Strings of the format: yyyy-MM-dd are acceptable.", "format": "date-time", "nullable": true }, "dateAvailableTo": { "type": "string", "description": "Return only those listings whose DateAvailable is null, or is at or before the specified time. Strings of the format: yyyy-MM-dd are acceptable.", "format": "date-time", "nullable": true }, "ruralOnly": { "type": "boolean", "description": "if true, the response will include only listings flagged with IsRural", "nullable": true }, "excludePriceWithheld": { "type": "boolean", "description": "If `true`, exclude listings whose price has been withheld.", "nullable": true }, "excludeDepositTaken": { "type": "boolean", "description": "If `true`c>, exclude listings (rental) has deposit taken", "nullable": true }, "topspotKeywords": { "type": "array", "items": { "type": "string" }, "description": "Search by topspot keywords", "nullable": true }, "customSort": { "$ref": "#/components/schemas/SearchService.v2.DomainSearchWebApiV2ModelsCustomSort" }, "sort": { "$ref": "#/components/schemas/SearchService.v2.DomainSearchWebApiV2ModelsSortBy" }, "page": { "type": "integer", "description": "The specific result page to return. Defaults to 1 when omitted or less than zero.", "format": "int32", "nullable": true }, "geoWindow": { "$ref": "#/components/schemas/SearchService.v2.DomainSearchWebApiV2ModelsGeoWindow" }, "updatedSince": { "type": "string", "description": "Only return listings that have been updated since the specified date. Strings of the format: yyyy-MM-dd are acceptable.", "format": "date-time", "nullable": true }, "listedSince": { "type": "string", "description": "Only return listings that have been listed since the specified date. Strings of the format: yyyy-MM-dd are acceptable.", "format": "date-time", "nullable": true }, "propertyEstablishedType": { "enum": [ "Any", "New", "Established" ], "type": "string", "description": "Gets or Sets PropertyEstablishedType" }, "includeInspectionAggregations": { "type": "boolean", "description": "Gets or Sets IncludeInspectionAggregations", "nullable": true }, "tags": { "type": "array", "items": { "$ref": "#/components/schemas/SearchService.v2.DomainSearchWebApiV2ModelsTagQuery" }, "description": "
Filter listings based on a combination of tag value and inclusion/exclusion criteria. For all of the tags whose criteria is \\\"include\\\": include only those listings in the search results that have one or more of these tags. For all of the tags whose criteria is \\\"exclude\\\": exclude listings that have one or more of these tags from the search results.
Example: return only those listings that have the \\\"red\\\" or \\\"blue\\\" tags, but exclude any that also have a \\\"green\\\" tag. \\\"tags\\\": [ { \\\"criteria\\\": \\\"include\\\", \\\"Tag\\\": \\\"red\\\" }, { \\\"criteria\\\": \\\"include\\\", \\\"tag\\\": \\\"blue\\\" }, { \\\"criteria\\\": \\\"exclude\\\", \\\"tag\\\": \\\"green\\\" } ]
Summary of the available tags and their meanings. retirement Property is suitable for retirement. rural Rural listing. newdevelopment A newly-developed property. ", "nullable": true }, "aggregations": { "type": "array", "items": { "type": "string" }, "description": "Gets or Sets Aggregations", "nullable": true }, "soldFrom": { "type": "string", "description": "Filter listings with sold date on or from the date specified", "format": "date-time", "nullable": true }, "soldTo": { "type": "string", "description": "Filter listings with sold date on or before from the date specified", "format": "date-time", "nullable": true }, "pageSize": { "type": "integer", "description": "Gets or Sets PageSize", "format": "int32", "nullable": true } }, "additionalProperties": false, "description": "DomainSearchWebApiV2ModelsSoldSearchParameters", "x-data-access-level-info": { "Basic": [ "*" ], "Detailed": [ "*" ], "Full": [ "*" ] } }, "Domain.LocationProfilesService.v1.Model.LocationSurroundingSuburbs": { "type": "object", "properties": { "name": { "type": "string" }, "urlSlug": { "type": "string" } }, "x-data-access-level-info": { "Basic": [ "*" ], "Detailed": [ "*" ], "Full": [ "*" ] } }, "Domain.LocationProfilesService.v1.Model.LocationDataSalesGrowthList": { "type": "object", "properties": { "medianSoldPrice": { "type": "number", "format": "double" }, "annualGrowth": { "type": "number", "format": "double" }, "numberSold": { "type": "integer", "format": "int32" }, "year": { "type": "integer", "format": "int32" } }, "x-data-access-level-info": { "Basic": [ "*" ], "Detailed": [ "*" ], "Full": [ "*" ] } }, "Domain.LocationProfilesService.v1.Model.LocationDataPropertyCategories": { "type": "object", "properties": { "luxuryLevelPrice": { "type": "number", "format": "double" }, "numberSold": { "type": "integer", "format": "int32" }, "estimatedRepayments": { "type": "number", "format": "double" }, "forSale": { "type": "integer", "format": "int32" }, "medianSoldPrice": { "type": "number", "format": "double" }, "medianRentPrice": { "type": "number", "format": "double" }, "daysOnMarket": { "type": "number", "format": "double" }, "bedrooms": { "type": "integer", "format": "int32" }, "forRent": { "type": "integer", "format": "int32" }, "entryLevelPrice": { "type": "number", "format": "double" }, "salesGrowthList": { "type": "array", "items": { "$ref": "#/components/schemas/Domain.LocationProfilesService.v1.Model.LocationDataSalesGrowthList" } }, "auctionClearanceRate": { "type": "number", "format": "double" }, "propertyCategory": { "type": "string" }, "mostRecentSale": { "type": "string" } }, "x-data-access-level-info": { "Basic": [ "*" ], "Detailed": [ "*" ], "Full": [ "*" ] } }, "Domain.LocationProfilesService.v1.Model.LocationData": { "type": "object", "properties": { "studiosForRent": { "type": "integer", "format": "int32" }, "terracedHousesForSale": { "type": "integer", "format": "int32" }, "semiDetachedHousesForSale": { "type": "integer", "format": "int32" }, "townhousesForRent": { "type": "integer", "format": "int32" }, "apartmentsAndUnitsForSale": { "type": "integer", "format": "int32" }, "apartmentsAndUnitsForRent": { "type": "integer", "format": "int32" }, "villasForSale": { "type": "integer", "format": "int32" }, "duplexesForSale": { "type": "integer", "format": "int32" }, "semiDetachedHousesForRent": { "type": "integer", "format": "int32" }, "studiosForSale": { "type": "integer", "format": "int32" }, "singlePercentage": { "type": "number", "format": "double" }, "mostCommonAgeBracket": { "type": "string" }, "renterPercentage": { "type": "number", "format": "double" }, "penthousesForSale": { "type": "integer", "format": "int32" }, "villasForRent": { "type": "integer", "format": "int32" }, "duplexesForRent": { "type": "integer", "format": "int32" }, "housesForSale": { "type": "integer", "format": "int32" }, "ownerOccupierPercentage": { "type": "number", "format": "double" }, "propertyCategories": { "type": "array", "items": { "$ref": "#/components/schemas/Domain.LocationProfilesService.v1.Model.LocationDataPropertyCategories" } }, "population": { "type": "number", "format": "double" }, "penthousesForRent": { "type": "integer", "format": "int32" }, "townhousesForSale": { "type": "integer", "format": "int32" }, "terracedHousesForRent": { "type": "integer", "format": "int32" }, "marriedPercentage": { "type": "number", "format": "double" }, "housesForRent": { "type": "integer", "format": "int32" }, "blockOfUnitsForSale": { "type": "integer", "format": "int32" } }, "x-data-access-level-info": { "Basic": [ "*" ], "Detailed": [ "*" ], "Full": [ "*" ] } }, "Domain.LocationProfilesService.v1.Model.Location": { "type": "object", "properties": { "domainLocationId": { "type": "integer", "format": "int32" }, "postcode": { "type": "string" }, "pfLocationId": { "type": "string" }, "surroundingSuburbs": { "type": "array", "items": { "$ref": "#/components/schemas/Domain.LocationProfilesService.v1.Model.LocationSurroundingSuburbs" } }, "urlSlug": { "type": "string" }, "suburbName": { "type": "string" }, "data": { "$ref": "#/components/schemas/Domain.LocationProfilesService.v1.Model.LocationData" }, "apmLocationId": { "type": "integer", "format": "int32" }, "locationId": { "type": "integer", "format": "int32" }, "areaName": { "type": "string" }, "regionName": { "type": "string" }, "state": { "type": "string" } }, "x-data-access-level-info": { "Basic": [ "*" ], "Detailed": [ "*" ], "Full": [ "*" ] } }, "Me.V1.MyDetails": { "type": "object", "properties": { "authenticated": { "type": "boolean", "description": "True if the current request was successfully authenticated" }, "clientId": { "type": "string", "description": "The Client ID or API Key used to authenticated this request", "nullable": true }, "subjectId": { "type": "string", "description": "A unique user id, only if this request is authenticated as a user context.", "nullable": true }, "subjectEmail": { "type": "string", "description": "The users email address if available", "nullable": true } }, "additionalProperties": false, "x-data-access-level-info": { "Basic": [ "Authenticated", "ClientId", "SubjectId", "SubjectEmail" ], "Detailed": [ "Authenticated", "ClientId", "SubjectId", "SubjectEmail" ], "Full": [ "Authenticated", "ClientId", "SubjectId", "SubjectEmail" ] } }, "Me.V1.AgencySummary": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string", "nullable": true }, "admin": { "type": "boolean", "description": "True if this user is an admin of this agency", "nullable": true } }, "additionalProperties": false, "x-data-access-level-info": { "Basic": [ "Id", "Name" ], "Detailed": [ "Id", "Name" ], "Full": [ "Id", "Name", "Admin" ] } }, "Me.V1.ProviderSummary": { "type": "object", "properties": { "id": { "type": "string", "description": "Provider identifier - this will map to the username", "nullable": true }, "companyName": { "type": "string", "description": "Company name", "nullable": true }, "contactNameTechnical": { "type": "string", "description": "Contact person's name for technical related enquiries", "nullable": true }, "emailTechnical": { "type": "string", "description": "Email address to receive technical related emails", "nullable": true }, "phoneTechnical": { "type": "string", "description": "Phone to be contact for technical related enquiries", "nullable": true }, "contactNameBusiness": { "type": "string", "description": "Contact person's name for business related enquiries", "nullable": true }, "emailBusiness": { "type": "string", "description": "Email address to receive business related emails", "nullable": true }, "phoneBusiness": { "type": "string", "description": "Phone to be contact for business related enquiries", "nullable": true } }, "additionalProperties": false, "description": "Create provider response", "x-data-access-level-info": { "Basic": [ "*" ], "Detailed": [ "*" ], "Full": [ "*" ] } }, "PreMarket.v1.PrePortalListingStatus": { "enum": [ "preMarket", "sold", "listed", "withdrawn", "draft" ], "type": "string" }, "PreMarket.v1.State": { "enum": [ "nsw", "vic", "act", "sa", "wa", "tas", "qld", "nt" ], "type": "string", "description": "Australian states" }, "PreMarket.v1.Address": { "required": [ "postcode", "state", "street", "streetNumber", "suburb" ], "type": "object", "properties": { "streetNumber": { "maxLength": 20, "minLength": 1, "type": "string", "description": "Street (and possibly unit) number component of an address. E.g. 23, 1a, 11/1." }, "street": { "maxLength": 50, "minLength": 1, "type": "string", "description": "Street name, e.g. Punt Road." }, "suburb": { "maxLength": 50, "minLength": 1, "type": "string" }, "state": { "$ref": "#/components/schemas/PreMarket.v1.State" }, "postcode": { "minLength": 1, "pattern": "^[0-9]{3,4}$", "type": "string" } }, "additionalProperties": false }, "PreMarket.v1.Contact": { "required": [ "email", "firstName", "lastName" ], "type": "object", "properties": { "firstName": { "maxLength": 50, "minLength": 1, "type": "string", "description": "First name of the agent contact." }, "lastName": { "maxLength": 50, "minLength": 1, "type": "string", "description": "Last name of the agent contact." }, "email": { "maxLength": 100, "minLength": 1, "type": "string", "description": "Agent contact email. Valid email address.", "format": "email" }, "phone": { "maxLength": 20, "type": "string", "description": "Agent contact phone number. Valid phone number.", "nullable": true }, "mobile": { "maxLength": 20, "type": "string", "description": "Agent contact mobile number. Valid mobile number.", "nullable": true }, "fax": { "maxLength": 20, "type": "string", "nullable": true } }, "additionalProperties": false }, "PreMarket.v1.Price": { "required": [ "from", "to" ], "type": "object", "properties": { "from": { "minimum": 0, "type": "number", "description": "Lower end of the price range.", "format": "double" }, "to": { "minimum": 0, "type": "number", "description": "Upper end of the price range.", "format": "double" }, "displayText": { "maxLength": 80, "type": "string", "description": "When provided this will be shown instead of the price range, e.g.: \"Offers over $450K considered\"", "nullable": true } }, "additionalProperties": false }, "PreMarket.v1.PropertyType": { "enum": [ "house", "townhouse", "apartmentUnitFlat", "vacantLand" ], "type": "string" }, "PreMarket.v1.AuthorityType": { "enum": [ "privateSale", "auction", "expressionOfInterest" ], "type": "string" }, "PreMarket.v1.StatementOfInformation": { "required": [ "documentationUrl" ], "type": "object", "properties": { "documentationUrl": { "minLength": 1, "pattern": "^http[s]?:+.*", "type": "string", "description": "Link to the statement of information documentation file.\r\nMust be a PDF file.\r\nFile should be less than 10 MB in size\r\nThe Statement of Information must be updated if there is a change in the indicative selling price." } }, "additionalProperties": false }, "PreMarket.v1.ResourceType": { "enum": [ "photograph", "floorPlan" ], "type": "string" }, "PreMarket.v1.PropertyMedia": { "required": [ "resourceType", "url" ], "type": "object", "properties": { "resourceType": { "$ref": "#/components/schemas/PreMarket.v1.ResourceType" }, "url": { "minLength": 1, "pattern": "^http[s]?:+.*", "type": "string" } }, "additionalProperties": false }, "PreMarket.v1.SoldDetails": { "type": "object", "properties": { "soldPrice": { "maximum": 2147483647, "minimum": 0, "type": "integer", "description": "Price the property was sold for.", "format": "int32", "nullable": true }, "soldDate": { "type": "string", "description": "The date when the property was sold.\r\nThe date must comply with the ISO 8601 and be in the UTC format, e.g. 2021-10-15T13:45:30.0000000Z.", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "PreMarket.v1.ListingRequest": { "required": [ "address", "bathrooms", "bedrooms", "carspaces", "domainAgencyId", "estimatedSalePrice", "listingProvider", "listingStatus", "propertyTypes", "providerAdId" ], "type": "object", "properties": { "listingStatus": { "$ref": "#/components/schemas/PreMarket.v1.PrePortalListingStatus" }, "address": { "$ref": "#/components/schemas/PreMarket.v1.Address" }, "domainAgencyId": { "maximum": 2147483647, "minimum": 1, "type": "integer", "description": "The Domain agency ID. Must match an existing Domain agency ID.", "format": "int32" }, "listingProvider": { "maxLength": 50, "minLength": 1, "type": "string", "description": "A string identifying the source of the listing." }, "providerAdId": { "maxLength": 50, "minLength": 1, "type": "string", "description": "External Advertisement Id of up to 50 characters will be stored.\r\nThis value is correlated with actual Domain listing when it is created, and it should be unique for the listing provider.\r\nThis value is case-insensitive (meaning AAAA will update aaaa)." }, "contacts": { "type": "array", "items": { "$ref": "#/components/schemas/PreMarket.v1.Contact" }, "nullable": true }, "bedrooms": { "minimum": 0, "type": "number", "description": "Number of bedrooms divisible by 0.5.", "format": "float" }, "bathrooms": { "minimum": 0, "type": "number", "description": "Number of bathrooms divisible by 0.5.", "format": "float" }, "carspaces": { "minimum": 0, "type": "number", "description": "Number of car spaces divisible by 0.5.", "format": "float" }, "summary": { "maxLength": 250, "minLength": 0, "type": "string", "description": "Headline of the advertisement. Any HTML will be stripped out.", "nullable": true }, "description": { "maxLength": 6000, "minLength": 0, "type": "string", "description": "Description of the property.\r\nAllow up to 6000 characters in length. The following HTML elements are permitted: ```
,

,  ``` . HTML must be well-formed.\r\nCarriage Returns are interpreted as line breaks. Foreign characters must be HTML encoded, e.g., façade for façade", "nullable": true }, "authorityExecutedDate": { "type": "string", "description": "The date on which the authority contract was executed.\r\nThe date must comply with the ISO 8601 and be in the UTC format, e.g. 2009-06-15T13:45:30.0000000Z.", "format": "date-time", "nullable": true }, "reservePrice": { "minimum": 0, "type": "number", "description": "Vendor reserve price.", "format": "double", "nullable": true }, "estimatedSalePrice": { "$ref": "#/components/schemas/PreMarket.v1.Price" }, "propertyTypes": { "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/PreMarket.v1.PropertyType" }, "description": "The property types (e.g. house, apartment/unit/flat, etc.)." }, "authorityType": { "$ref": "#/components/schemas/PreMarket.v1.AuthorityType" }, "exclusivePeriodDays": { "maximum": 2147483647, "minimum": 0, "type": "integer", "description": "The time (in days) that the agent has exclusive authority to sell the property.", "format": "int32", "nullable": true }, "exclusiveContinuingPeriodDays": { "maximum": 2147483647, "minimum": 0, "type": "integer", "description": "The time (in days) that exclusive authority has been extended.", "format": "int32", "nullable": true }, "exclusivePeriodStartDate": { "type": "string", "description": "Start date of the exclusivity period.\r\nThe date must comply with the ISO 8601 and be in the UTC format, e.g. 2009-06-15T13:45:30.0000000Z.", "format": "date-time", "nullable": true }, "statementOfInformation": { "$ref": "#/components/schemas/PreMarket.v1.StatementOfInformation" }, "images": { "maxItems": 20, "type": "array", "items": { "$ref": "#/components/schemas/PreMarket.v1.PropertyMedia" }, "nullable": true }, "metadata": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Optional listing metadata.", "nullable": true }, "comment": { "maxLength": 100, "type": "string", "description": "Optional listing comment.", "nullable": true }, "soldDetails": { "$ref": "#/components/schemas/PreMarket.v1.SoldDetails" } }, "additionalProperties": false, "description": "Pre-portal listing request." }, "PreMarket.v1.CreateOrUpdateListingResponse": { "required": [ "id" ], "type": "object", "properties": { "id": { "minLength": 1, "type": "string", "description": "Pre-portal listing ID." } }, "additionalProperties": false, "description": "Create or update pre-portal listing response." }, "PreMarket.v1.ProblemDetails": { "type": "object", "properties": { "type": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "status": { "type": "integer", "format": "int32", "nullable": true }, "detail": { "type": "string", "nullable": true }, "instance": { "type": "string", "nullable": true } }, "additionalProperties": {} }, "PreMarket.v1.ProviderDetails": { "type": "object", "properties": { "providerSystem": { "type": "string", "description": "Identify the source of the listing", "nullable": true }, "providerAdID": { "type": "string", "description": "Unique ID within provider system", "nullable": true } }, "additionalProperties": false, "description": "Information for the listing provider" }, "PreMarket.v1.AddressResponse": { "required": [ "postcode", "slug", "state", "street", "streetNumber", "suburb" ], "type": "object", "properties": { "streetNumber": { "maxLength": 20, "minLength": 1, "type": "string", "description": "Street (and possibly unit) number component of an address. E.g. 23, 1a, 11/1." }, "street": { "maxLength": 50, "minLength": 1, "type": "string", "description": "Street name, e.g. Punt Road." }, "suburb": { "maxLength": 50, "minLength": 1, "type": "string" }, "state": { "$ref": "#/components/schemas/PreMarket.v1.State" }, "postcode": { "minLength": 1, "pattern": "^[0-9]{3,4}$", "type": "string" }, "slug": { "minLength": 1, "type": "string", "readOnly": true } }, "additionalProperties": false }, "PreMarket.v1.AdvertiserIdentifiers": { "required": [ "domainAgencyId" ], "type": "object", "properties": { "domainAgencyId": { "type": "integer", "description": "Domain Agency Id", "format": "int32" }, "contactIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Identifier of each contact the advertiser has associated with the listing", "nullable": true }, "agentIds": { "type": "array", "items": { "type": "string" }, "description": "Identifier of each agent the advertiser has associated with the listing", "nullable": true } }, "additionalProperties": false }, "PreMarket.v1.GeoLocation": { "type": "object", "properties": { "latitude": { "type": "number", "description": "Latitude of the property.", "format": "double" }, "longitude": { "type": "number", "description": "Longitude of the property.", "format": "double" } }, "additionalProperties": false, "description": "Encapsulates the details of a geo location." }, "PreMarket.v1.ListingResponse": { "required": [ "address", "bathrooms", "bedrooms", "carspaces", "estimatedSalePrice", "id", "listingStatus" ], "type": "object", "properties": { "id": { "minLength": 1, "type": "string", "description": "Pre-portal listing ID." }, "listingStatus": { "$ref": "#/components/schemas/PreMarket.v1.PrePortalListingStatus" }, "relatedAdId": { "type": "integer", "description": "The Domain Ad Id of the related listing.", "format": "int32", "nullable": true }, "providerDetails": { "$ref": "#/components/schemas/PreMarket.v1.ProviderDetails" }, "address": { "$ref": "#/components/schemas/PreMarket.v1.AddressResponse" }, "advertiserIdentifiers": { "$ref": "#/components/schemas/PreMarket.v1.AdvertiserIdentifiers" }, "bedrooms": { "type": "number", "description": "Total number of bedrooms in the property.", "format": "float" }, "bathrooms": { "type": "number", "description": "Total number of bathrooms in the property.", "format": "float" }, "carspaces": { "type": "number", "description": "Total number of car spaces in the property.", "format": "float" }, "headline": { "maximum": 250, "minimum": 0, "type": "string", "description": "The short description of the property provided by the advertiser.", "nullable": true }, "description": { "maximum": 6000, "minimum": 0, "type": "string", "description": "The long description of the property provided by the advertiser.", "nullable": true }, "authorityExecutedDate": { "type": "string", "description": "The date on which the authority contract was executed.\r\nThe date is compliant with the ISO 8601 and is in the UTC format, e.g. 2009-06-15T13:45:30.0000000Z.", "format": "date-time", "nullable": true }, "reservePrice": { "type": "number", "description": "Vendor reserve price.", "format": "double", "nullable": true }, "estimatedSalePrice": { "$ref": "#/components/schemas/PreMarket.v1.Price" }, "propertyTypes": { "type": "array", "items": { "$ref": "#/components/schemas/PreMarket.v1.PropertyType" }, "description": "The property types (e.g. house, apartment/unit/flat, etc.).", "nullable": true }, "authorityType": { "$ref": "#/components/schemas/PreMarket.v1.AuthorityType" }, "exclusivePeriodDays": { "type": "integer", "description": "The time (in days) that the agent has exclusive authority to sell the property.", "format": "int32", "nullable": true }, "exclusiveContinuingPeriodDays": { "type": "integer", "description": "The time (in days) that exclusive authority has been extended.", "format": "int32", "nullable": true }, "exclusivePeriodStartDate": { "type": "string", "description": "Start date of the exclusivity period.\r\nThe date is compliant with the ISO 8601 and is in the UTC format, e.g. 2009-06-15T13:45:30.0000000Z.", "format": "date-time", "nullable": true }, "geoLocation": { "$ref": "#/components/schemas/PreMarket.v1.GeoLocation" }, "mapCertainty": { "type": "integer", "description": "Map certainty of the property location.", "format": "int32" }, "media": { "type": "array", "items": { "$ref": "#/components/schemas/PreMarket.v1.PropertyMedia" }, "description": "The media associated with the property provided by the advertiser.", "nullable": true }, "propertyId": { "type": "string", "description": "The identifier which uniquely identifies the property being advertised.\r\nThis may be empty if the Address of property is poorly described.", "nullable": true }, "statementOfInformation": { "$ref": "#/components/schemas/PreMarket.v1.StatementOfInformation" }, "dateCreated": { "type": "string", "description": "The date/time the listing was created.\r\nThe date is compliant with the ISO 8601 and is in the UTC format, e.g. 2009-06-15T13:45:30.0000000Z.", "format": "date-time" }, "dateUpdated": { "type": "string", "description": "The date/time the listing was last updated.\r\nThe date is compliant with the ISO 8601 and is in the UTC format, e.g. 2009-06-15T13:45:30.0000000Z.", "format": "date-time" }, "datePreMarket": { "type": "string", "description": "The date/time the listing went pre-market.\r\nThe date is compliant with the ISO 8601 and is in the UTC format, e.g. 2009-06-15T13:45:30.0000000Z.", "format": "date-time", "nullable": true }, "dateListed": { "type": "string", "description": "The date/time the listing was listed.\r\nThe date is compliant with the ISO 8601 and is in the UTC format, e.g. 2009-06-15T13:45:30.0000000Z.", "format": "date-time", "nullable": true }, "dateSold": { "type": "string", "description": "The date/time when the listing status was changed to sold (it is NOT the date/time when the property was sold).\r\nThe date is compliant with the ISO 8601 and is in the UTC format, e.g. 2009-06-15T13:45:30.0000000Z.", "format": "date-time", "nullable": true }, "dateWithdrawn": { "type": "string", "description": "The date/time the listing was withdrawn.\r\nThe date is compliant with the ISO 8601 and is in the UTC format, e.g. 2009-06-15T13:45:30.0000000Z.", "format": "date-time", "nullable": true }, "dateDrafted": { "type": "string", "description": "The date/time the listing was drafted.\r\nThe date is compliant with the ISO 8601 and is in the UTC format, e.g. 2009-06-15T13:45:30.0000000Z.", "format": "date-time", "nullable": true }, "metadata": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Optional listing metadata.", "nullable": true }, "comment": { "type": "string", "description": "Optional listing comment.", "nullable": true }, "soldDetails": { "$ref": "#/components/schemas/PreMarket.v1.SoldDetails" } }, "additionalProperties": false, "description": "Pre-portal listing response." }, "PreMarket.v1.OperationType": { "enum": [ "add", "remove", "replace", "move", "copy", "test", "invalid" ], "type": "string" }, "PreMarket.v1.ListingRequestOperation": { "type": "object", "properties": { "operationType": { "$ref": "#/components/schemas/PreMarket.v1.OperationType" }, "path": { "type": "string", "nullable": true }, "op": { "type": "string", "nullable": true }, "from": { "type": "string", "nullable": true }, "value": { "nullable": true } }, "additionalProperties": false }, "PreMarket.v1.IContractResolver": { "type": "object", "additionalProperties": false }, "PreMarket.v1.ListingRequestJsonPatchDocument": { "type": "object", "properties": { "operations": { "type": "array", "items": { "$ref": "#/components/schemas/PreMarket.v1.ListingRequestOperation" }, "nullable": true, "readOnly": true }, "contractResolver": { "$ref": "#/components/schemas/PreMarket.v1.IContractResolver" } }, "additionalProperties": false }, "BookingV2Api.v1.UnreserveInventoryRequest": { "required": [ "cancelledBy" ], "type": "object", "properties": { "agencyId": { "type": "integer", "format": "int32" }, "cancelledBy": { "maxLength": 50, "minLength": 1, "type": "string" } }, "additionalProperties": false }, "BookingV2Api.v1.ProblemDetails": { "type": "object", "properties": { "type": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "status": { "type": "integer", "format": "int32", "nullable": true }, "detail": { "type": "string", "nullable": true }, "instance": { "type": "string", "nullable": true } }, "additionalProperties": {} }, "BookingV2Api.v1.LimitedInventoryProductType": { "enum": [ "TopSpot", "TopSpotRural", "ListingShowcase", "DreamHomes" ], "type": "string" }, "BookingV2Api.v1.LimitedInventoryListingCategory": { "enum": [ "Sale", "Lease" ], "type": "string" }, "BookingV2Api.v1.ProductTypeAndCategoryDto": { "type": "object", "properties": { "productType": { "$ref": "#/components/schemas/BookingV2Api.v1.LimitedInventoryProductType" }, "listingCategory": { "$ref": "#/components/schemas/BookingV2Api.v1.LimitedInventoryListingCategory" } }, "additionalProperties": false }, "BookingV2Api.v1.Channel": { "enum": [ "Residential", "Commercial", "Business" ], "type": "string" }, "BookingV2Api.v1.GetBatchLimitedInventoryAvailabilityRequest": { "required": [ "suburbSlug" ], "type": "object", "properties": { "suburbSlug": { "minLength": 1, "type": "string" }, "products": { "type": "array", "items": { "$ref": "#/components/schemas/BookingV2Api.v1.ProductTypeAndCategoryDto" }, "nullable": true }, "channel": { "$ref": "#/components/schemas/BookingV2Api.v1.Channel" }, "dateStart": { "type": "string", "format": "date-time" }, "numOfDurations": { "maximum": 60, "minimum": 1, "type": "integer", "format": "int32" }, "durationLimit": { "maximum": 60, "minimum": 1, "type": "integer", "format": "int32" } }, "additionalProperties": false }, "BookingV2Api.v1.DurationType": { "enum": [ "Weekly", "Monthly" ], "type": "string" }, "BookingV2Api.v1.ProductAvailabilityStatus": { "enum": [ "Unavailable", "Available" ], "type": "string" }, "BookingV2Api.v1.AgencyAvailabilityDetailsDto": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "agencyId": { "type": "integer", "format": "int32" }, "agencyName": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "reference": { "type": "string", "nullable": true }, "internalContractId": { "type": "integer", "format": "int32", "nullable": true }, "reservationId": { "type": "integer", "format": "int32", "nullable": true }, "assetReferenceId": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false }, "BookingV2Api.v1.ProductAvailabilityByDurationDto": { "type": "object", "properties": { "durationNo": { "type": "integer", "format": "int32" }, "startDate": { "type": "string", "format": "date-time" }, "sovAvailable": { "type": "number", "format": "double" }, "status": { "$ref": "#/components/schemas/BookingV2Api.v1.ProductAvailabilityStatus" }, "maxExclusiveAvailable": { "type": "integer", "format": "int32" }, "legacyId": { "type": "integer", "format": "int32", "nullable": true }, "agencies": { "type": "array", "items": { "$ref": "#/components/schemas/BookingV2Api.v1.AgencyAvailabilityDetailsDto" }, "nullable": true } }, "additionalProperties": false }, "BookingV2Api.v1.ProductAvailabilityDetailsDto": { "type": "object", "properties": { "productType": { "$ref": "#/components/schemas/BookingV2Api.v1.LimitedInventoryProductType" }, "suburb": { "type": "string", "nullable": true }, "state": { "type": "string", "nullable": true }, "postcode": { "type": "string", "nullable": true }, "listingCategory": { "$ref": "#/components/schemas/BookingV2Api.v1.LimitedInventoryListingCategory" }, "durationType": { "$ref": "#/components/schemas/BookingV2Api.v1.DurationType" }, "durations": { "type": "array", "items": { "$ref": "#/components/schemas/BookingV2Api.v1.ProductAvailabilityByDurationDto" }, "description": "Availability details grouped by the specified duration type.", "nullable": true }, "inventoryId": { "type": "integer", "description": "Standard inventory service will use this\r\nLegacy doesn't have this", "format": "int32", "nullable": true }, "error": { "type": "string", "description": "Populated when an error occurs during availability retrieval or processing.\r\nProvides details about the error encountered, allowing consumers to handle error scenarios appropriately.", "nullable": true } }, "additionalProperties": false }, "BookingV2Api.v1.BatchSummaryResponse": { "type": "object", "properties": { "requested": { "type": "integer", "format": "int32" }, "succeeded": { "type": "integer", "format": "int32" }, "failed": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "BookingV2Api.v1.GetBatchLimitedInventoryAvailabilityResponse": { "type": "object", "properties": { "results": { "type": "array", "items": { "$ref": "#/components/schemas/BookingV2Api.v1.ProductAvailabilityDetailsDto" }, "nullable": true }, "summary": { "$ref": "#/components/schemas/BookingV2Api.v1.BatchSummaryResponse" } }, "additionalProperties": false }, "BookingV2Api.v1.ListingFilterType": { "enum": [ "Residential", "NewDevelopment", "Project", "Rural" ], "type": "string", "description": "For Dreamhomes listing filters" }, "BookingV2Api.v1.DurationDto": { "type": "object", "properties": { "durationNo": { "type": "integer", "format": "int32" }, "dateStart": { "type": "string", "format": "date-time" }, "dateEnd": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "BookingV2Api.v1.ReserveInventoryRequest": { "required": [ "assetReferenceId" ], "type": "object", "properties": { "productType": { "$ref": "#/components/schemas/BookingV2Api.v1.LimitedInventoryProductType" }, "listingCategory": { "$ref": "#/components/schemas/BookingV2Api.v1.LimitedInventoryListingCategory" }, "listingFilterType": { "$ref": "#/components/schemas/BookingV2Api.v1.ListingFilterType" }, "channel": { "$ref": "#/components/schemas/BookingV2Api.v1.Channel" }, "suburbSlug": { "type": "string", "nullable": true }, "requestedBy": { "type": "string", "nullable": true }, "durations": { "maxItems": 60, "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/BookingV2Api.v1.DurationDto" }, "nullable": true }, "ipAddress": { "type": "string", "nullable": true }, "legacyContractId": { "type": "integer", "format": "int32", "nullable": true }, "assetReferenceId": { "type": "string", "format": "uuid" }, "isExclusive": { "type": "boolean" } }, "additionalProperties": false }, "BookingV2Api.v1.ReserveInventoryByBatchRequest": { "required": [ "requestedBy" ], "type": "object", "properties": { "agencyId": { "type": "integer", "format": "int32" }, "requestedBy": { "maxLength": 50, "minLength": 1, "type": "string" }, "reservations": { "maxItems": 10, "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/BookingV2Api.v1.ReserveInventoryRequest" }, "nullable": true } }, "additionalProperties": false }, "BookingV2Api.v1.ReservationResponse": { "type": "object", "properties": { "error": { "type": "string", "nullable": true }, "reservationId": { "type": "integer", "format": "int32" }, "agencyId": { "type": "integer", "format": "int32" }, "suburbSlug": { "type": "string", "nullable": true }, "productType": { "$ref": "#/components/schemas/BookingV2Api.v1.LimitedInventoryProductType" }, "listingCategory": { "$ref": "#/components/schemas/BookingV2Api.v1.LimitedInventoryListingCategory" }, "dateStart": { "type": "string", "format": "date-time" }, "dateEnd": { "type": "string", "format": "date-time" }, "noOfDurations": { "type": "integer", "format": "int32" }, "assetReferenceId": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false }, "BookingV2Api.v1.ReserveInventoryByBatchResponse": { "type": "object", "properties": { "results": { "type": "array", "items": { "$ref": "#/components/schemas/BookingV2Api.v1.ReservationResponse" }, "nullable": true }, "summary": { "$ref": "#/components/schemas/BookingV2Api.v1.BatchSummaryResponse" } }, "additionalProperties": false }, "BookingV2Api.v1.UnreserveInventoryByBatchRequest": { "required": [ "cancelledBy" ], "type": "object", "properties": { "agencyId": { "type": "integer", "format": "int32" }, "cancelledBy": { "maxLength": 50, "minLength": 1, "type": "string" }, "reservationIds": { "maxItems": 10, "minItems": 1, "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true } }, "additionalProperties": false }, "BookingV2Api.v1.UnreserveResponse": { "type": "object", "properties": { "error": { "type": "string", "nullable": true }, "reservationId": { "type": "integer", "format": "int32" }, "agencyId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "BookingV2Api.v1.UnreserveInventoryByBatchResponse": { "type": "object", "properties": { "results": { "type": "array", "items": { "$ref": "#/components/schemas/BookingV2Api.v1.UnreserveResponse" }, "nullable": true }, "summary": { "$ref": "#/components/schemas/BookingV2Api.v1.BatchSummaryResponse" } }, "additionalProperties": false }, "BookingV2Api.v1.ListingType": { "enum": [ "Sale", "Rent", "None" ], "type": "string", "description": "Sale=0 and Rent=1 to match the Objective and PropertyListingType enums" }, "BookingV2Api.v1.GetListingPriceQuoteByAgencyRequest": { "required": [ "agencyId", "listingPrice", "postcode", "state", "suburb" ], "type": "object", "properties": { "channel": { "$ref": "#/components/schemas/BookingV2Api.v1.Channel" }, "listingType": { "$ref": "#/components/schemas/BookingV2Api.v1.ListingType" }, "agencyId": { "maximum": 2147483647, "minimum": 1, "type": "integer", "format": "int32" }, "suburb": { "minLength": 1, "type": "string" }, "state": { "minLength": 1, "type": "string" }, "postcode": { "minLength": 1, "type": "string" }, "asAtDate": { "type": "string", "format": "date-time" }, "listingPrice": { "maximum": 2147483647, "minimum": 1, "type": "number", "format": "double" }, "agentId": { "type": "string", "nullable": true }, "isNewDevelopment": { "type": "boolean" }, "isRural": { "type": "boolean" } }, "additionalProperties": false }, "BookingV2Api.v1.ListingQuote": { "type": "object", "properties": { "listingType": { "type": "string", "nullable": true }, "durationInDays": { "type": "integer", "format": "int32" }, "costExGst": { "type": "number", "format": "double" }, "costIncGst": { "type": "number", "format": "double" }, "originalCostExGst": { "type": "number", "format": "double" }, "originalCostIncGst": { "type": "number", "format": "double" }, "appliedAdjustment": { "type": "number", "format": "double" }, "isDefault": { "type": "boolean" }, "isDowngrade": { "type": "boolean" }, "isUpgrade": { "type": "boolean" }, "name": { "type": "string", "nullable": true }, "tier": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BookingV2Api.v1.AddonQuote": { "type": "object", "properties": { "addonType": { "type": "string", "nullable": true }, "costExGst": { "type": "number", "format": "double" }, "costIncGst": { "type": "number", "format": "double" }, "originalCostExGst": { "type": "number", "format": "double" }, "originalCostIncGst": { "type": "number", "format": "double" }, "appliedAdjustment": { "type": "number", "format": "double" }, "durationInDays": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "tier": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BookingV2Api.v1.GetListingPriceQuoteByAgencyResponse": { "type": "object", "properties": { "channel": { "$ref": "#/components/schemas/BookingV2Api.v1.Channel" }, "adType": { "type": "string", "description": "Sale | Rent", "nullable": true }, "listings": { "type": "array", "items": { "$ref": "#/components/schemas/BookingV2Api.v1.ListingQuote" }, "nullable": true }, "addons": { "type": "array", "items": { "$ref": "#/components/schemas/BookingV2Api.v1.AddonQuote" }, "nullable": true }, "isSuccess": { "type": "boolean", "description": "Gets a value indicating whether the response was successful.\r\nThe response is considered successful if there are no errors.", "readOnly": true }, "errors": { "type": "array", "items": { "type": "string" }, "description": "Gets or sets a list of errors. If the list is empty, the response is considered successful.", "nullable": true }, "error": { "type": "string", "description": "Gets the first error message from the list of errors.", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "BookingV2Api.v1.ValidationProblemDetails": { "type": "object", "properties": { "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "nullable": true }, "type": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "status": { "type": "integer", "format": "int32", "nullable": true }, "detail": { "type": "string", "nullable": true }, "instance": { "type": "string", "nullable": true } }, "additionalProperties": {} }, "BookingV2Api.v1.AreaFilter": { "required": [ "state", "zone" ], "type": "object", "properties": { "state": { "minLength": 1, "type": "string" }, "zone": { "minLength": 1, "type": "string" } }, "additionalProperties": false }, "BookingV2Api.v1.BookingRule": { "enum": [ "All", "Casual", "Agent", "None", "RestrictedAll" ], "type": "string" }, "BookingV2Api.v1.EBrochureOptions": { "enum": [ "NoEbrochure", "Standard", "Platinum" ], "type": "string" }, "BookingV2Api.v1.GetQuoteListingPriceBySuburbsRequest": { "required": [ "areas", "duration", "tier" ], "type": "object", "properties": { "areas": { "maxItems": 20, "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/BookingV2Api.v1.AreaFilter" }, "description": "State and Zones selected" }, "tier": { "minLength": 1, "type": "string", "description": "Product tier e.g. Gold, Silver, Platinum" }, "duration": { "type": "integer", "description": "Duration in days of product", "format": "int32" }, "asAtDate": { "type": "string", "description": "Date of the quote. Can simulate past or future date but relying on data TP currently has (e.g. quote of a product before recorded expiry)", "format": "date-time" }, "contractType": { "$ref": "#/components/schemas/BookingV2Api.v1.BookingRule" }, "channel": { "$ref": "#/components/schemas/BookingV2Api.v1.Channel" }, "listingType": { "$ref": "#/components/schemas/BookingV2Api.v1.ListingType" }, "eBrochureOption": { "$ref": "#/components/schemas/BookingV2Api.v1.EBrochureOptions" }, "isNewDevelopment": { "type": "boolean" } }, "additionalProperties": false }, "BookingV2Api.v1.ZoneMapping": { "type": "object", "properties": { "zoneId": { "type": "integer", "format": "int32" }, "channel": { "$ref": "#/components/schemas/BookingV2Api.v1.Channel" }, "state": { "type": "string", "nullable": true }, "zone": { "type": "string", "nullable": true }, "zoneCode": { "type": "string", "nullable": true }, "fullName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BookingV2Api.v1.RateBand": { "type": "object", "properties": { "priceFrom": { "type": "number", "format": "double", "nullable": true }, "priceTo": { "type": "number", "format": "double", "nullable": true }, "costIncGst": { "type": "number", "format": "double" }, "costExGst": { "type": "number", "format": "double" }, "isBaseRate": { "type": "boolean" } }, "additionalProperties": false }, "BookingV2Api.v1.BookingRate": { "type": "object", "properties": { "bookingRule": { "type": "string", "nullable": true }, "channel": { "$ref": "#/components/schemas/BookingV2Api.v1.Channel" }, "listingType": { "$ref": "#/components/schemas/BookingV2Api.v1.ListingType" }, "tier": { "type": "string", "nullable": true }, "durationInDays": { "type": "integer", "format": "int32" }, "ebrochureType": { "type": "string", "nullable": true }, "isNewDevelopment": { "type": "boolean" }, "productCatalogId": { "type": "integer", "format": "int32" }, "zoneId": { "type": "integer", "format": "int32" }, "matrixVersionId": { "type": "string", "nullable": true }, "rateBands": { "type": "array", "items": { "$ref": "#/components/schemas/BookingV2Api.v1.RateBand" }, "nullable": true } }, "additionalProperties": false }, "BookingV2Api.v1.GetQuoteListingPriceBySuburbsResponse": { "type": "object", "properties": { "zoneMappings": { "type": "array", "items": { "$ref": "#/components/schemas/BookingV2Api.v1.ZoneMapping" }, "nullable": true }, "bookingRates": { "type": "array", "items": { "$ref": "#/components/schemas/BookingV2Api.v1.BookingRate" }, "nullable": true }, "isSuccess": { "type": "boolean", "description": "Gets a value indicating whether the response was successful.\r\nThe response is considered successful if there are no errors.", "readOnly": true }, "errors": { "type": "array", "items": { "type": "string" }, "description": "Gets or sets a list of errors. If the list is empty, the response is considered successful.", "nullable": true }, "error": { "type": "string", "description": "Gets the first error message from the list of errors.", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "Bookings.V2.RateForNewListingRequest": { "required": [ "agencyId", "agentEmail", "agentFirstName", "agentLastName", "channel", "isNewDevelopment", "listingType", "postcode", "price", "propertyType", "state", "suburb" ], "type": "object", "properties": { "agencyId": { "type": "integer", "description": "Id of the agency for whom rates are to be calculated.", "format": "int32" }, "agentFirstName": { "minLength": 1, "type": "string", "description": "The first name of the primary agent associated with the listing." }, "agentLastName": { "minLength": 1, "type": "string", "description": "The last name of the primary agent associated with the listing" }, "agentEmail": { "minLength": 1, "type": "string", "description": "The email of the primary agent associated with the listing." }, "suburb": { "minLength": 1, "type": "string", "description": "Suburb for which rates are to be calculated." }, "postcode": { "minLength": 1, "type": "string", "description": "Postcode for which rates are to be calculated." }, "state": { "minLength": 1, "type": "string", "description": "State for which rates are to be calculated" }, "propertyType": { "enum": [ "unknown", "accessoriesParts", "accommodationTourism", "accounting", "acreageSemiRural", "adult", "advertisingMarketing", "aerial", "aeronautical", "agedCare", "agricultural", "air", "aircraft", "alarms", "alcoholLiquor", "amusements", "animalRelated", "apartmentUnitFlat", "aquaculture", "aquaticMarineMarinaBerth", "artsCrafts", "autoElectrical", "automotive", "backpackerHostel", "bakery", "barsNightclubs", "beautyHealth", "beautyProducts", "beautySalon", "bikeAndMotorcycle", "blockOfUnits", "boardingKennels", "boatsMarineMarinaBerth", "bookkeeping", "brokerage", "builder", "buildingAndConstruction", "bus", "butcher", "cafeCoffeeShop", "car", "carBusTruck", "carDealership", "carRental", "carSpace", "carWash", "caravanPark", "carpenter", "catering", "childCare", "civil", "cleaning", "cleaningAndMaintenance", "clinicalPractice", "clothingAccessories", "clothingFootwear", "communication", "communications", "computerIT", "computerAndInternet", "construction", "convenienceStore", "copyLaminate", "courier", "cropHarvesting", "customs", "dairyFarming", "deli", "dental", "detailing", "developmentLand", "developmentSite", "distributors", "drivingSchools", "duplex", "educationTraining", "educational", "electrical", "employmentRecruitment", "entertainment", "entertainmentTechnology", "export", "farm", "farming", "fertiliser", "finance", "financialServices", "fishingForestry", "floristNursery", "foodBeverage", "foodBeverageHospitality", "franchiseBusinessOpportunities", "freight", "fruitVegFreshProduce", "fruitPicking", "functionCentre", "furnitureTimber", "gambling", "gardenHousehold", "gardenNurseries", "gardening", "glassCeramic", "guestHouseBB", "hairdresser", "healthBeauty", "healthSpa", "hire", "homeGarden", "homeBased", "newHomeDesigns", "homewareHardware", "hospital", "hotel", "hotelLeisure", "house", "newHouseLand", "huntingTrap", "import", "importExportWholesale", "industrialManufacturing", "industrialWarehouse", "insemination", "insurance", "internet", "irrigationServices", "juiceBar", "landClearing", "newLand", "landscaping", "laundryDryCleaning", "legal", "leisureEntertainment", "limousineTaxi", "livestock", "internationalCommercial", "machinery", "machineryMetal", "managementRights", "manufacturers", "manufacturingEngineering", "marine", "massage", "mechanicalRepair", "media", "medical", "medicalConsulting", "medicalPractice", "miningEarthMoving", "mobileServices", "motel", "motorcycle", "musicRelated", "mustering", "nails", "naturalTherapies", "newApartments", "newsagency", "nursery", "nursingHome", "offices", "officeSupplies", "oilGas", "panelBeating", "paperPrinting", "parkingCarSpace", "penthouse", "pestRelated", "pharmacies", "plastic", "plumbing", "poolWater", "postOffices", "printPhoto", "professional", "propertyRealEstate", "rail", "recreationSport", "recruitment", "repair", "resort", "restaurant", "retail", "retailer", "retirement", "retirementVillage", "road", "rural", "ruralCommercialFarming", "scientific", "sea", "security", "semiDetached", "serviceStation", "services", "shearing", "showroomsBulkyGoods", "specialistFarm", "sportsComplexGym", "studio", "supermarket", "takeawayFood", "taxi", "terrace", "themePark", "tours", "townhouse", "training", "transportDistribution", "travel", "truck", "vacantLand", "vending", "villa", "water", "welding", "wholesale", "wholesalers", "woolClassing", "wreckers", "servicedOffices", "other", "alcoholGrocery", "cafeRestaurants", "discountStore", "ecoFriendly", "green", "grocery", "specialityRetail", "storage", "travelAgency", "varietyStore", "chickenShop", "seafoodShop", "deliCafe", "cropping", "viticulture", "mixedFarming", "grazing", "horticulture", "equine", "farmlet", "orchard", "ruralLifestyle", "onlineBusiness" ], "type": "string", "description": "The property type of the listing e.g. House" }, "isNewDevelopment": { "type": "boolean", "description": "Whether to return the normal or new development rates" }, "listingType": { "enum": [ "sale", "rent" ], "type": "string", "description": "Type of the listing whether sale or rent" }, "price": { "type": "number", "description": "The value of the listing", "format": "double" }, "channel": { "enum": [ "residential", "commercial", "business" ], "type": "string", "description": "The intended channel of the listing." }, "bookingStartDate": { "type": "string", "description": "Date at which the booking will start. Defaults to today. Allows for returning future contracts/price changes.", "format": "date-time", "nullable": true } }, "additionalProperties": false, "description": "Provide a summary of the intended listing for which to calculate a rate.", "x-data-access-level-info": { "Basic": [ "*" ], "Detailed": [ "*" ], "Full": [ "*" ] } }, "Bookings.V2.RateForNewListing": { "type": "object", "properties": { "costExGst": { "type": "number", "description": "Gets or Sets CostExGst", "format": "double", "nullable": true }, "costIncGst": { "type": "number", "description": "Gets or Sets CostIncGst", "format": "double", "nullable": true }, "contractEndDate": { "type": "string", "description": "Gets or Sets ContractEndDate", "format": "date-time", "nullable": true }, "message": { "type": "string", "description": "Gets or Sets Message", "nullable": true }, "priceMatrixId": { "type": "integer", "description": "Gets or Sets PriceMatrixId", "format": "int32", "nullable": true }, "productName": { "type": "string", "description": "Gets or Sets ProductName", "nullable": true } }, "additionalProperties": false, "description": "NewListingRateResponse", "x-data-access-level-info": { "Basic": [ "*" ], "Detailed": [ "*" ], "Full": [ "*" ] } }, "SocialBoost.v1.RateForNewSocialBoostRequestModel": { "required": [ "agencyId", "agentEmail", "agentFirstName", "agentLastName", "channel", "isRural", "listingType", "postcode", "price", "propertyType", "state", "suburb" ], "type": "object", "properties": { "agencyId": { "type": "integer", "description": "Id of the agency for whom rates are to be calculated.", "format": "int32" }, "agentFirstName": { "minLength": 1, "type": "string", "description": "The first name of the primary agent associated with the listing." }, "agentLastName": { "minLength": 1, "type": "string", "description": "The last name of the primary agent associated with the listing" }, "agentEmail": { "minLength": 1, "type": "string", "description": "The email of the primary agent associated with the listing." }, "suburb": { "minLength": 1, "type": "string", "description": "Suburb for which rates are to be calculated." }, "postcode": { "minLength": 1, "type": "string", "description": "Postcode for which rates are to be calculated." }, "state": { "minLength": 1, "type": "string", "description": "State for which rates are to be calculated" }, "propertyType": { "enum": [ "Unknown", "AcreageSemiRural", "ApartmentUnitFlat", "Aquaculture", "BlockOfUnits", "Carspace", "DairyFarming", "DevelopmentSite", "Duplex", "Farm", "FishingForestry", "NewHomeDesigns", "House", "NewHouseLand", "IrrigationServices", "NewLand", "Livestock", "NewApartments", "Penthouse", "Retirement", "RetirementVillage", "Rural", "SemiDetached", "SpecialistFarm", "Studio", "Terrace", "Townhouse", "VacantLand", "Villa", "Cropping", "Viticulture", "MixedFarming", "Grazing", "Horticulture", "Equine", "Farmlet", "Orchard", "RuralLifestyle" ], "type": "string", "description": "The property type of the listing e.g. House" }, "isRural": { "type": "boolean", "description": "Whether to return the normal or rural rates" }, "listingType": { "enum": [ "Sale", "Rent", "None" ], "type": "string", "description": "Type of the listing whether sale or rent" }, "price": { "type": "number", "description": "The value of the listing", "format": "double" }, "channel": { "enum": [ "Residential", "Commercial", "Business" ], "type": "string", "description": "The intended channel of the listing." }, "bookingStartDate": { "type": "string", "description": "Date at which the booking will start. Defaults to today. Allows for returning future contracts/price changes.", "format": "date-time", "nullable": true } }, "additionalProperties": false, "x-data-access-level-info": { "Basic": [ "*" ], "Detailed": [ "*" ], "Full": [ "*" ] } }, "SocialBoost.v1.ContractInfo": { "type": "object", "properties": { "id": { "type": "integer", "description": "Gets or Sets Id", "format": "int32", "nullable": true }, "bookingProductId": { "type": "integer", "description": "Gets or Sets BookingProductId", "format": "int32", "nullable": true }, "agencyId": { "type": "integer", "description": "Gets or Sets AgencyId", "format": "int32", "nullable": true }, "startDate": { "type": "string", "description": "Gets or Sets StartDate", "format": "date-time", "nullable": true }, "endDate": { "type": "string", "description": "Gets or Sets EndDate", "format": "date-time", "nullable": true }, "finishedDate": { "type": "string", "description": "Gets or Sets FinishedDate", "format": "date-time", "nullable": true }, "attributes": { "type": "string", "description": "Gets or Sets Attributes", "nullable": true }, "agentId": { "type": "string", "description": "Gets or Sets AgentId", "nullable": true }, "isAgentContract": { "type": "boolean", "description": "Gets or Sets IsAgentContract", "nullable": true, "readOnly": true } }, "additionalProperties": false, "description": "ContractInfo", "x-data-access-level-info": { "Basic": [ "*" ], "Detailed": [ "*" ], "Full": [ "*" ] } }, "SocialBoost.v1.ListingRateInfo": { "type": "object", "properties": { "productListingLevel": { "enum": [ "None", "PlatinumExtend", "Platinum", "Gold", "Silver", "Branded", "Tier1", "Tier2", "Tier3" ], "type": "string", "description": "Gets or Sets ProductListingLevel", "nullable": true }, "productListingRule": { "enum": [ "None", "EarlyAccess", "SocialBoostAll", "SocialBoostCasual", "SocialBoostRuralAll", "SocialBoostRuralCasual", "SocialBoostAgent", "SocialBoostRuralAgent" ], "type": "string", "description": "Gets or Sets ProductListingRule", "nullable": true }, "bookingProductId": { "type": "integer", "description": "Gets or Sets BookingProductId", "format": "int32", "nullable": true }, "bookingProductRateId": { "type": "integer", "description": "Gets or Sets BookingProductRateId", "format": "int32", "nullable": true }, "bookingProductName": { "type": "string", "description": "Gets or Sets BookingProductName", "nullable": true }, "durationInDays": { "type": "integer", "description": "Gets or Sets DurationInDays", "format": "int32", "nullable": true }, "costExGst": { "type": "number", "description": "Gets or Sets CostExGst", "format": "double", "nullable": true }, "costIncGst": { "type": "number", "description": "Gets or Sets CostIncGst", "format": "double", "nullable": true }, "zoneId": { "type": "integer", "description": "Gets or Sets ZoneId", "format": "int32", "nullable": true }, "productAttributes": { "type": "string", "description": "Gets or Sets ProductAttributes", "nullable": true }, "rateAttributes": { "type": "string", "description": "Gets or Sets RateAttributes", "nullable": true }, "bookingMethod": { "type": "string", "description": "Gets or Sets BookingMethod", "nullable": true }, "productForRural": { "type": "boolean", "description": "Gets or Sets ProductForRural", "nullable": true } }, "additionalProperties": false, "description": "ListingRateInfo", "x-data-access-level-info": { "Basic": [ "*" ], "Detailed": [ "*" ], "Full": [ "*" ] } }, "SocialBoost.v1.RateForNewSocialBoost": { "type": "object", "properties": { "reason": { "enum": [ "BasedOnContract", "NoContractFound", "NoRateFound", "PropertyTypeExcluded" ], "type": "string", "description": "Gets or Sets Reason", "nullable": true }, "contract": { "$ref": "#/components/schemas/SocialBoost.v1.ContractInfo" }, "rate": { "$ref": "#/components/schemas/SocialBoost.v1.ListingRateInfo" } }, "additionalProperties": false, "description": "GetRatesForNewSocialBoostResponse", "x-data-access-level-info": { "Basic": [ "*" ], "Detailed": [ "*" ], "Full": [ "*" ] } }, "Listings.V2.ProjectAddressParts": { "type": "object", "properties": { "stateAbbreviation": { "enum": [ "nsw", "vic", "sa", "nt", "tas", "act", "qld", "wa" ], "type": "string", "description": "Gets or Sets StateAbbreviation", "nullable": true }, "displayType": { "enum": [ "fullAddress", "streetAndSuburb", "suburbOnly", "regionOnly", "areaOnly", "stateOnly" ], "type": "string", "description": "Gets or Sets DisplayType", "nullable": true }, "streetNumber": { "type": "string", "description": "Street number", "nullable": true }, "unitNumber": { "type": "string", "description": "Unit number.", "nullable": true }, "street": { "type": "string", "description": "Street address", "nullable": true }, "suburb": { "type": "string", "description": "Suburb of the address", "nullable": true }, "suburbId": { "type": "integer", "description": "Domain suburb identifier for address lookup via the domain location api", "format": "int32", "nullable": true }, "postcode": { "type": "string", "description": "Postcode of the address", "nullable": true }, "displayAddress": { "type": "string", "description": "Advertiser's preference in displaying their listing's address", "nullable": true }, "street2": { "type": "string", "description": "Street 2", "nullable": true }, "latitude": { "type": "number", "description": "Latitude", "format": "double", "nullable": true }, "longitude": { "type": "number", "description": "Longitude", "format": "double", "nullable": true } }, "additionalProperties": false, "description": "Project address parts", "x-data-access-level-info": { "Basic": [ "DisplayAddress", "DisplayType", "StateAbbreviation", "UnitNumber", "StreetNumber", "Street", "Street2", "Postcode", "Suburb", "SuburbId", "Latitude", "Longitude" ], "Detailed": [ "DisplayAddress", "DisplayType", "StateAbbreviation", "UnitNumber", "StreetNumber", "Street", "Street2", "Postcode", "Suburb", "SuburbId", "Latitude", "Longitude" ], "Full": [ "DisplayAddress", "DisplayType", "StateAbbreviation", "UnitNumber", "StreetNumber", "Street", "Street2", "Postcode", "Suburb", "SuburbId", "Latitude", "Longitude" ] } }, "Listings.V2.AdvertiserIdentifiers": { "type": "object", "properties": { "advertiserType": { "enum": [ "agency", "private" ], "type": "string", "description": "Gets or Sets AdvertiserType", "nullable": true }, "advertiserId": { "type": "integer", "description": "Advertiser's identifier", "format": "int32", "nullable": true }, "contactIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Identifier of each contact the advertiser has associated with the listing", "nullable": true }, "agentIds": { "type": "array", "items": { "type": "string" }, "description": "Identifier of each agent the advertiser has associated with the listing", "nullable": true }, "conjunctionContactIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Identifier of each conjunctional contact associated with the listing", "nullable": true }, "conjunctionAgentIds": { "type": "array", "items": { "type": "string" }, "description": "Identifier of each conjunctional agent associated with the listing", "nullable": true } }, "additionalProperties": false, "description": "Encapsulates the listing's advertiser identifiers", "x-data-access-level-info": { "Basic": [ "*" ], "Detailed": [ "*" ], "Full": [ "*" ] } }, "Listings.V2.ProviderDetails": { "type": "object", "properties": { "providerSystem": { "type": "string", "description": "Feed provider ID", "nullable": true }, "providerAdID": { "type": "string", "description": "Unique ID within provider system", "nullable": true } }, "additionalProperties": false, "description": "Information for the listing provider. e.g. bulkuploader information", "x-data-access-level-info": { "Basic": [ "*" ], "Detailed": [ "*" ], "Full": [ "*" ] } }, "Listings.v2.ProjectMedia": { "type": "object", "properties": { "category": { "enum": [ "image", "video", "others" ], "type": "string", "description": "Gets or Sets Category", "nullable": true }, "type": { "enum": [ "photo", "poster", "video", "virtualTour", "webLink" ], "type": "string", "description": "Gets or Sets Type", "nullable": true }, "url": { "type": "string", "description": "Url", "nullable": true }, "description": { "type": "string", "description": "Optional description", "nullable": true } }, "additionalProperties": false, "description": "Project Media", "x-data-access-level-info": { "Basic": [ "*" ], "Detailed": [ "*" ], "Full": [ "*" ] } }, "Listings.V2.PdfUpload": { "type": "object", "properties": { "type": { "enum": [ "commercialPdf", "newDevBrochurePdf", "floorplanPdf", "devProjectPdf", "devProjectMasterplanPdf" ], "type": "string", "description": "Gets or Sets Type", "nullable": true }, "url": { "type": "string", "description": "Url of the PDF", "nullable": true }, "filename": { "type": "string", "description": "Original file name of the PDF", "nullable": true }, "fileDescription": { "type": "string", "description": "Description of the PDF", "nullable": true } }, "additionalProperties": false, "description": "PDF file", "x-data-access-level-info": { "Basic": [ "*" ], "Detailed": [ "*" ], "Full": [ "*" ] } }, "Listings.V2.Inspection": { "type": "object", "properties": { "recurrence": { "enum": [ "none", "weekly" ], "type": "string", "description": "Gets or Sets Recurrence", "nullable": true }, "openingDateTime": { "type": "string", "description": "Opening date and time of the inspection. e.g. 2015-01-01T12:00:00. Not provided by bulk uploaded listings, in these cases refer to the inspection description field. DateTime is in a local timezone.", "format": "date-time", "nullable": true }, "closingDateTime": { "type": "string", "description": "Closing date and time of the inspection. e.g. 2015-01-01T12:00:00 Not provided by bulk uploaded listings, in these cases refer to the inspection description field. DateTime is in a local timezone.", "format": "date-time", "nullable": true }, "description": { "type": "string", "description": "Description of the inspection provided by the Advertiser. When listings are bulk uploaded, inspection times are provided as a string. Other inspection details will not be provided", "nullable": true } }, "additionalProperties": false, "description": "Encapsulates the details of a Listing's Inspection", "x-data-access-level-info": { "Basic": [ "*" ], "Detailed": [ "*" ], "Full": [ "*" ] } }, "Listings.V2.PropertyInspections": { "type": "object", "properties": { "inspections": { "type": "array", "items": { "$ref": "#/components/schemas/Listings.V2.Inspection" }, "description": "Inspection details for the property. e.g. opening and closing times", "nullable": true }, "pastInspections": { "type": "array", "items": { "$ref": "#/components/schemas/Listings.V2.Inspection" }, "description": "Inspection details for the property. e.g. opening and closing times", "nullable": true }, "isByAppointmentOnly": { "type": "boolean", "description": "True or False indicating whether the inspection is by appointment only", "nullable": true } }, "additionalProperties": false, "description": "Property Inspection(s) details", "x-data-access-level-info": { "Basic": [ "*" ], "Detailed": [ "*" ], "Full": [ "*" ] } }, "Listings.V2.Project": { "type": "object", "properties": { "projectProfileType": { "enum": [ "noProfile", "projectProfileStandard", "projectProfilePremium" ], "type": "string", "description": "Gets or Sets ProjectProfileType", "nullable": true }, "estimatedCompletionTertile": { "enum": [ "early", "mid", "late" ], "type": "string", "description": "Gets or Sets EstimatedCompletionTertile", "nullable": true }, "category": { "enum": [ "houseAndLand", "apartment", "retirement" ], "type": "string", "description": "Gets or Sets Category", "nullable": true }, "id": { "type": "integer", "description": "Project ID", "format": "int32", "nullable": true }, "name": { "type": "string", "description": "Project Name", "nullable": true }, "startDate": { "type": "string", "description": "Start date. DateTime is in a local timezone.", "format": "date-time", "nullable": true }, "endDate": { "type": "string", "description": "End date.DateTime is in a local timezone.", "format": "date-time", "nullable": true }, "address": { "$ref": "#/components/schemas/Listings.V2.ProjectAddressParts" }, "viewingAddress": { "$ref": "#/components/schemas/Listings.V2.ProjectAddressParts" }, "propertyTypes": { "type": "array", "items": { "enum": [ "unknown", "acreageSemiRural", "apartmentUnitFlat", "aquaculture", "blockOfUnits", "carspace", "dairyFarming", "developmentLand", "developmentSite", "duplex", "farm", "fishingForestry", "homeBased", "newHomeDesigns", "hotelLeisure", "house", "newHouseLand", "industrialWarehouse", "irrigationServices", "newLand", "livestock", "international", "medicalConsulting", "newApartments", "offices", "parkingCarSpace", "penthouse", "retail", "retirement", "rural", "ruralCommercialFarming", "semiDetached", "showroomsBulkyGoods", "specialistFarm", "studio", "terrace", "townhouse", "vacantLand", "villa", "servicedOffices", "other", "chickenShop", "seafoodShop", "deliCafe", "cropping", "viticulture", "mixedFarming", "grazing", "horticulture", "equine", "farmlet", "orchard", "ruralLifestyle", "onlineBusiness" ], "type": "string", "description": "Available types of Properties * `Unknown` - Unknown * `AcreageSemiRural` - Acreage-SemiRural * `ApartmentUnitFlat` - Apartment Unit Flat * `Aquaculture` - Aquaculture commercial/rural type * `BlockOfUnits` - Block Of Units * `Carspace` - Carspace * `DairyFarming` - Dairy Farming commercial/rural type * `DevelopmentLand` - Development / Land * `DevelopmentSite` - Development site * `Duplex` - Duplex * `Farm` - Farm * `FishingForestry` - Fishing / Forestry commercial/rural type * `HomeBased` - Home Based * `NewHomeDesigns` - New Home Designs * `HotelLeisure` - Hotel / Leisure commercial type * `House` - House * `NewHouseLand` - New House And Land * `IndustrialWarehouse` - Industrial / Warehouse commercial type * `IrrigationServices` - Irrigation Services commercial/rural type * `NewLand` - New Land * `Livestock` - Livestock commercial/rural type * `International` - International commercial type * `MedicalConsulting` - Medical / Consulting commercial type * `NewApartments` - New Apartments / Off the Plan * `Offices` - Offices commercial type * `ParkingCarSpace` - Parking / Car Space commercial type * `Penthouse` - Penthouse * `Retail` - Retail commercial type * `Retirement` - Retirement * `Rural` - Rural * `RuralCommercialFarming` - Rural / Commercial Farming commercial type * `SemiDetached` - Semi Detached * `ShowroomsBulkyGoods` - Showrooms / Bulky Goods commercial type * `SpecialistFarm` - The specialist farm * `Studio` - Studio * `Terrace` - Terrace * `Townhouse` - The townhouse * `VacantLand` - Vacant Land * `Villa` - Villa * `ServicedOffices` - Serviced Offices commercial type * `Other` - Other commercial type * `ChickenShop` - Chicken Shop commercial type * `SeafoodShop` - Seafood Shop commercial type * `DeliCafe` - Deli Cafe commercial type * `Cropping` - Cropping commercial/rural type * `Viticulture` - Viticulture commercial/rural type * `MixedFarming` - Mixed Farming commercial type * `Grazing` - Grazing commercial/rural type * `Horticulture` - Horticulture commercial/rural type * `Equine` - Equine commercial/rural type * `Farmlet` - Farmlet commercial/rural type * `Orchard` - Orchard commercial/rural type * `RuralLifestyle` - Rural Lifestyle commercial/rural type * `OnlineBusiness` - Online Business" }, "description": "Property types available at the project.", "nullable": true }, "displayableAddress": { "$ref": "#/components/schemas/Listings.V2.ProjectAddressParts" }, "enquiryEmailAddress": { "type": "string", "description": "Enquiry email address", "nullable": true }, "advertiserIdentifiers": { "$ref": "#/components/schemas/Listings.V2.AdvertiserIdentifiers" }, "providerDetails": { "$ref": "#/components/schemas/Listings.V2.ProviderDetails" }, "media": { "type": "array", "items": { "$ref": "#/components/schemas/Listings.v2.ProjectMedia" }, "description": "Images and videos", "nullable": true }, "projectUrl": { "type": "string", "description": "Project URL", "nullable": true }, "headline": { "type": "string", "description": "Headline", "nullable": true }, "tagline": { "type": "string", "description": "Tag line", "nullable": true }, "displayAsLastUpdated": { "type": "string", "description": "The 'last updated' date to show to customers. DateTime is in AEST (Australian Eastern Standard Time) or AEDT (Australian Eastern Daylight Time) timezone.", "format": "date-time", "nullable": true }, "modifiedBy": { "type": "string", "description": "Last updated by", "nullable": true }, "modifiedDate": { "type": "string", "description": "Last updated, used for auditing. DateTime is in AEST (Australian Eastern Standard Time) or AEDT (Australian Eastern Daylight Time) timezone.", "format": "date-time", "nullable": true }, "createdBy": { "type": "string", "description": "Created by", "nullable": true }, "createdDate": { "type": "string", "description": "Created date. DateTime is in AEST (Australian Eastern Standard Time) or AEDT (Australian Eastern Daylight Time) timezone.", "format": "date-time", "nullable": true }, "backgroundColour": { "type": "string", "description": "Background colour", "nullable": true }, "description": { "type": "string", "description": "Description", "nullable": true }, "appointmentRequired": { "type": "boolean", "description": "If inspections require an appointment.", "nullable": true }, "features": { "type": "array", "items": { "type": "string" }, "description": "Features", "nullable": true }, "priceFrom": { "type": "number", "description": "Price from", "format": "double", "nullable": true }, "priceTo": { "type": "number", "description": "Price to", "format": "double", "nullable": true }, "bannerUrl": { "type": "string", "description": "Banner URL", "nullable": true }, "bigBannerUrl": { "type": "string", "description": "Big banner URL", "nullable": true }, "smallBannerUrl": { "type": "string", "description": "Small banner URL", "nullable": true }, "logoUrl": { "type": "string", "description": "Logo URL", "nullable": true }, "pdfs": { "type": "array", "items": { "$ref": "#/components/schemas/Listings.V2.PdfUpload" }, "description": "PDF files, such as brochures etc.", "nullable": true }, "inspectionDetails": { "$ref": "#/components/schemas/Listings.V2.PropertyInspections" }, "numberOfFloors": { "type": "integer", "description": "Maximum number of floors", "format": "int32", "nullable": true }, "minNumberOfFloors": { "type": "integer", "description": "Minimum number of floors", "format": "int32", "nullable": true }, "minBuildingHeight": { "type": "integer", "description": "Minimum building height", "format": "int32", "nullable": true }, "maxBuildingHeight": { "type": "integer", "description": "Maximum building height", "format": "int32", "nullable": true }, "numberOfBuildings": { "type": "integer", "description": "Number of buildings", "format": "int32", "nullable": true }, "numberOfApartments": { "type": "integer", "description": "Number of apartments", "format": "int32", "nullable": true }, "estimatedCompletionDate": { "type": "string", "description": "Estimated completion date. DateTime in a local timezone.", "format": "date-time", "nullable": true }, "startingPrice": { "type": "number", "description": "Lowest child listing price", "format": "double", "nullable": true }, "childListingIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Child listing identifiers.", "nullable": true }, "linkedProjectIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Linked project identifiers.", "nullable": true } }, "additionalProperties": false, "description": "A structured representation of a Project", "x-data-access-level-info": { "Basic": [ "*" ], "Detailed": [ "*" ], "Full": [ "*" ] } }, "Listings.V2.AddressParts": { "type": "object", "properties": { "stateAbbreviation": { "enum": [ "nsw", "vic", "sa", "nt", "tas", "act", "qld", "wa" ], "type": "string", "description": "Gets or Sets StateAbbreviation", "nullable": true }, "displayType": { "enum": [ "fullAddress", "streetAndSuburb", "suburbOnly", "regionOnly", "areaOnly", "stateOnly" ], "type": "string", "description": "Gets or Sets DisplayType", "nullable": true }, "streetNumber": { "type": "string", "description": "Street number", "nullable": true }, "unitNumber": { "type": "string", "description": "Unit number.", "nullable": true }, "street": { "type": "string", "description": "Street address", "nullable": true }, "suburb": { "type": "string", "description": "Suburb of the address", "nullable": true }, "suburbId": { "type": "integer", "description": "Domain suburb identifier for address lookup via the domain location api", "format": "int32", "nullable": true }, "postcode": { "type": "string", "description": "Postcode of the address", "nullable": true }, "displayAddress": { "type": "string", "description": "Advertiser's preference in displaying their listing's address", "nullable": true } }, "additionalProperties": false, "description": "Encapsulates the parts that make up an Address", "x-data-access-level-info": { "Basic": [ "DisplayAddress", "DisplayType", "StateAbbreviation", "Postcode", "Suburb", "SuburbId", "UnitNumber", "StreetNumber", "Street" ], "Detailed": [ "DisplayAddress", "DisplayType", "StateAbbreviation", "Postcode", "Suburb", "SuburbId", "UnitNumber", "StreetNumber", "Street" ], "Full": [ "DisplayAddress", "DisplayType", "StateAbbreviation", "Postcode", "Suburb", "SuburbId", "UnitNumber", "StreetNumber", "Street" ] } }, "Listings.V2.AustralianPropertyMonitorsIdentifiers": { "type": "object", "properties": { "addressId": { "type": "integer", "description": "APM address identifier", "format": "int32", "nullable": true }, "streetId": { "type": "integer", "description": "APM street identifier", "format": "int32", "nullable": true }, "suburbId": { "type": "integer", "description": "APM suburb identifier", "format": "int32", "nullable": true }, "cadastreId": { "type": "integer", "description": "APM cadastre identifier", "format": "int64", "nullable": true }, "postcodeId": { "type": "integer", "description": "APM postcode identifier", "format": "int32", "nullable": true }, "stateId": { "type": "integer", "description": "State identifier", "format": "int32", "nullable": true }, "state": { "type": "string", "description": "APM State", "nullable": true }, "propertyTypeId": { "type": "integer", "description": "APM property type identifier", "format": "int32", "nullable": true }, "propertyTypeCategoryId": { "type": "integer", "description": "APM property category type identifier", "format": "int32", "nullable": true }, "streetNumber": { "type": "string", "description": "APM washed and standardized address component for the street number, (including any prefixes, suffixed and composite numbers e.g. \\\"2-4a\\\")", "nullable": true } }, "additionalProperties": false, "description": "APM Identifiers", "x-data-access-level-info": { "Basic": [], "Detailed": [ "SuburbId" ], "Full": [ "SuburbId", "AddressId", "CadastreId", "PostcodeId", "PropertyTypeCategoryId", "PropertyTypeId", "State", "StateId", "StreetId", "StreetNumber" ] } }, "Listings.V2.GeoLocation": { "type": "object", "properties": { "latitude": { "type": "number", "description": "Latitude of the property", "format": "double", "nullable": true }, "longitude": { "type": "number", "description": "Longitude of the property", "format": "double", "nullable": true } }, "additionalProperties": false, "description": "Encapsulates the details of a geo location, long/lat", "x-data-access-level-info": { "Basic": [ "*" ], "Detailed": [ "*" ], "Full": [ "*" ] } }, "Listings.V2.ListingMedia": { "required": [ "url" ], "type": "object", "properties": { "category": { "enum": [ "image", "video", "others" ], "type": "string", "description": "Gets or Sets Category", "nullable": true }, "type": { "enum": [ "photo", "mp4", "youtube", "floorplan", "vimeo", "notSpecified" ], "type": "string", "description": "Gets or Sets Type", "nullable": true }, "url": { "minLength": 1, "type": "string", "description": "The URL to the property media" } }, "additionalProperties": false, "description": "Encapsulates media associated with a Listing", "x-data-access-level-info": { "Basic": [ "*" ], "Detailed": [ "*" ], "Full": [ "*" ] } }, "Listings.V2.PriceDetails": { "type": "object", "properties": { "gstOption": { "enum": [ "na", "inc", "ex" ], "type": "string", "description": "Gets or Sets GstOption", "nullable": true }, "priceType": { "enum": [ "gross", "net" ], "type": "string", "description": "Gets or Sets PriceType", "nullable": true }, "priceUnit": { "enum": [ "totalAmount", "perSqm" ], "type": "string", "description": "Gets or Sets PriceUnit", "nullable": true }, "price": { "type": "number", "description": "Price of the property", "format": "double", "nullable": true }, "priceFrom": { "type": "integer", "description": "Price starting range of the property", "format": "int32", "nullable": true }, "priceTo": { "type": "integer", "description": "Upper price range of the property", "format": "int32", "nullable": true }, "pricePrefix": { "type": "string", "description": "Display price for the advertisement", "nullable": true }, "canDisplayPrice": { "type": "boolean", "description": "Flag indicating whether the advertiser has chosen to display the property price", "nullable": true }, "hiddenReasons": { "type": "array", "items": { "enum": [ "byAgency", "qldRestriction" ], "type": "string", "description": "Reason for price hidden * `ByAgency` - Agency doesn't want to show prcie * `QLDRestriction` - Price can not be shown due to QLD restrictions" }, "description": "Reasons when price need to be hidden", "nullable": true }, "displayPrice": { "type": "string", "description": "A string provided by the Advertiser representing the ByIdListingPriceQueryResult of the Listing e.g. Over $1,000,000 This should be the default price field for client to use", "nullable": true }, "bond": { "type": "number", "description": "Rental bond", "format": "double", "nullable": true }, "priceReduction": { "type": "boolean", "description": "Indicates if this property is under price reduction", "nullable": true } }, "additionalProperties": false, "description": "Encapsulates a listing's price information", "x-data-access-level-info": { "Basic": [ "DisplayPrice", "Bond", "CanDisplayPrice", "Price", "PriceFrom", "PriceTo", "PricePrefix" ], "Detailed": [ "DisplayPrice", "Bond", "CanDisplayPrice", "Price", "PriceFrom", "PriceTo", "PricePrefix" ], "Full": [ "DisplayPrice", "Bond", "CanDisplayPrice", "Price", "PriceFrom", "PriceTo", "PricePrefix", "HiddenReasons", "GstOption", "PriceUnit", "PriceType", "PriceReduction" ] } }, "Listings.V2.RentalDetails": { "type": "object", "properties": { "rentalMethod": { "enum": [ "notStated", "rent", "share", "holiday", "lease" ], "type": "string", "description": "Gets or Sets RentalMethod", "nullable": true }, "source": { "enum": [ "internal", "external" ], "type": "string", "description": "Gets or Sets Source", "nullable": true }, "leasedDate": { "type": "string", "description": "The Date the listing was leased. DateTime is in a local timezone.", "format": "date-time", "nullable": true }, "leasedPrice": { "type": "integer", "description": "The last leased price entered by the Advertiser This price will only be visible if allowed by the Advertiser and the listing as been leased", "format": "int32", "nullable": true }, "canDisplayPrice": { "type": "boolean", "description": "Indicates whether this instance can display price", "nullable": true }, "leasedMonths": { "type": "integer", "description": "The number of months the property was last leased for This will only be visible if the property has been leased", "format": "int32", "nullable": true }, "termOfLeaseFrom": { "type": "integer", "description": "Lease term range from", "format": "int32", "nullable": true }, "termOfLeaseTo": { "type": "integer", "description": "Lease term range to", "format": "int32", "nullable": true }, "leaseOutgoings": { "type": "integer", "description": "Outgoing cost of current lease", "format": "int32", "nullable": true } }, "additionalProperties": false, "description": "The rental detail's of the listing in case of it being for rent or leased", "x-data-access-level-info": { "Basic": [ "*" ], "Detailed": [ "*" ], "Full": [ "*" ] } }, "Listings.V2.SoldDetails": { "type": "object", "properties": { "soldAction": { "enum": [ "notStated", "auction", "privateTreaty", "withdrawn", "soldPriorToAuction" ], "type": "string", "description": "Gets or Sets SoldAction", "nullable": true }, "source": { "enum": [ "internal", "external" ], "type": "string", "description": "Gets or Sets Source", "nullable": true }, "soldPrice": { "type": "integer", "description": "The last sold price entered by the Advertiser. This price will only be visible if allowed by the Advertiser and the listing as been sold", "format": "int32", "nullable": true }, "governmentRecordedSoldPrice": { "type": "integer", "description": "The government recorded sold price sourced from APM", "format": "int32", "nullable": true }, "soldDate": { "type": "string", "description": "The Date the listing was sold. DateTime is in a local timezone.", "format": "date-time", "nullable": true }, "canDisplayPrice": { "type": "boolean", "description": "Indicates whether this instance can display price", "nullable": true } }, "additionalProperties": false, "description": "Sold details in the case of the listing being sold.", "x-data-access-level-info": { "Basic": [ "CanDisplayPrice", "SoldAction", "SoldPrice", "SoldDate", "Source" ], "Detailed": [ "CanDisplayPrice", "SoldAction", "SoldPrice", "SoldDate", "Source" ], "Full": [ "CanDisplayPrice", "SoldAction", "SoldPrice", "SoldDate", "Source", "GovernmentRecordedSoldPrice" ] } }, "Listings.V2.AuctionSchedule": { "type": "object", "properties": { "locationDescription": { "type": "string", "description": "Description and location of the auction provided by advertiser", "nullable": true }, "openingDateTime": { "type": "string", "description": "Opening date and time of the auction. e.g. 2015-01-01T12:00:00 DateTime is in a local timezone.", "format": "date-time", "nullable": true }, "terms": { "type": "string", "description": "Terms of the auction", "nullable": true }, "url": { "maxLength": 255, "type": "string", "description": "On-line URL of the auction", "nullable": true } }, "additionalProperties": false, "description": "Encapsulates the details of a Property being Auctioned.", "x-data-access-level-info": { "Basic": [ "*" ], "Detailed": [ "*" ], "Full": [ "*" ] } }, "Listings.V2.AuctionDetails": { "type": "object", "properties": { "auctionSchedule": { "$ref": "#/components/schemas/Listings.V2.AuctionSchedule" }, "auctionedPrice": { "type": "integer", "description": "The auctioned price entered by the Advertiser. This price will only be visible if allowed by the Advertiser and the listing as been auctioned", "format": "int32", "nullable": true }, "auctionedDate": { "type": "string", "description": "The listing's last auctioned date and time specified by the Advertiser. This will only be visible if the listing has been auctioned. DateTime is in a local timezone.", "format": "date-time", "nullable": true } }, "additionalProperties": false, "description": "The detail's of the auction in case of a listing for sale being auctioned or sold by auction", "x-data-access-level-info": { "Basic": [ "*" ], "Detailed": [ "*" ], "Full": [ "*" ] } }, "Listings.V2.TenderDetails": { "type": "object", "properties": { "tenderRecipientName": { "type": "string", "description": "Tender recipient name", "nullable": true }, "tenderAddress": { "type": "string", "description": "Tender address", "nullable": true }, "tenderEndDate": { "type": "string", "description": "Tender closing date. DateTime is in a local timezone.", "format": "date-time", "nullable": true } }, "additionalProperties": false, "description": "Tender details", "x-data-access-level-info": { "Basic": [ "*" ], "Detailed": [ "*" ], "Full": [ "*" ] } }, "Listings.V2.TenantDetails": { "type": "object", "properties": { "leaseDateVariable": { "type": "boolean", "description": "Is tenant lease date variable", "nullable": true }, "leaseOptions": { "type": "string", "description": "Leasing options available to a prospective tenant", "nullable": true }, "tenantInfoTermOfLeaseFrom": { "type": "integer", "description": "The from range of the tenant's current lease", "format": "int32", "nullable": true }, "tenantInfoTermOfLeaseTo": { "type": "integer", "description": "The to range of the tenant's current lease", "format": "int32", "nullable": true }, "tenantName": { "type": "string", "description": "Name of the current tenant of the property", "nullable": true }, "tenantRentDetails": { "type": "string", "description": "Information regarding current rental", "nullable": true }, "leaseStartDate": { "type": "string", "description": "The date on which the tenants lease began, or is due to begin. DateTime is in a local timezone.", "format": "date-time", "nullable": true }, "leaseEndDate": { "type": "string", "description": "The date on which the tenants lease is due to end. DateTime is in a local timezone.", "format": "date-time", "nullable": true } }, "additionalProperties": false, "description": "Tenant Details", "x-data-access-level-info": { "Basic": [ "*" ], "Detailed": [ "*" ], "Full": [ "*" ] } }, "Listings.V2.SaleDetails": { "type": "object", "properties": { "saleMethod": { "enum": [ "notStated", "auction", "privateTreaty", "tender", "expressionOfInterest" ], "type": "string", "description": "Gets or Sets SaleMethod", "nullable": true }, "soldDetails": { "$ref": "#/components/schemas/Listings.V2.SoldDetails" }, "auctionDetails": { "$ref": "#/components/schemas/Listings.V2.AuctionDetails" }, "tenderDetails": { "$ref": "#/components/schemas/Listings.V2.TenderDetails" }, "tenantDetails": { "$ref": "#/components/schemas/Listings.V2.TenantDetails" }, "annualReturn": { "type": "integer", "description": "Integer value of percentage return on this property or business", "format": "int32", "nullable": true }, "saleTerms": { "type": "string", "description": "Information relating to aspects of the sale, such as required deposit, settlement time", "nullable": true } }, "additionalProperties": false, "description": "The sale detail's of the listing in case of it being for sale or sold", "x-data-access-level-info": { "Basic": [ "*" ], "Detailed": [ "*" ], "Full": [ "*" ] } }, "Listings.V2.BasicPrice": { "type": "object", "properties": { "from": { "type": "integer", "description": "Lowest price the property is expected to sell/rent for to set search price.", "format": "int32", "nullable": true }, "to": { "type": "integer", "description": "Highest price the property is expected to sell/rent for to set search price.", "format": "int32", "nullable": true } }, "additionalProperties": false, "description": "Basic price information", "x-data-access-level-info": { "Basic": [ "*" ], "Detailed": [ "*" ], "Full": [ "*" ] } }, "Listings.V2.PastSaleData": { "type": "object", "properties": { "unitNumber": { "type": "string", "description": "Property unit number", "nullable": true }, "streetNumber": { "type": "string", "description": "Property street number", "nullable": true }, "street": { "type": "string", "description": "Property Street name", "nullable": true }, "suburb": { "type": "string", "description": "Property suburb name", "nullable": true }, "postcode": { "type": "string", "description": "Property postcode", "nullable": true }, "state": { "type": "string", "description": "Property state", "nullable": true }, "displayAddress": { "type": "string", "description": "display formatted address", "nullable": true, "readOnly": true }, "dateOfSale": { "type": "string", "description": "Registered date of the sale", "nullable": true }, "soldPrice": { "type": "integer", "description": "Property sold price", "format": "int64", "nullable": true } }, "additionalProperties": false, "description": "Information for past property sales", "x-data-access-level-info": { "Basic": [ "*" ], "Detailed": [ "*" ], "Full": [ "*" ] } }, "Listings.V2.ComparableData": { "type": "object", "properties": { "comparableProperty": { "type": "array", "items": { "$ref": "#/components/schemas/Listings.V2.PastSaleData" }, "description": "Comparable properties that are of a similar standard or condition to the property for sale", "nullable": true }, "declarationText": { "type": "string", "description": "Text description if there are less than three comparable sales available", "nullable": true } }, "additionalProperties": false, "description": "Information regarding the past comparable property sales that influenced the setting of the estimation price", "x-data-access-level-info": { "Basic": [ "*" ], "Detailed": [ "*" ], "Full": [ "*" ] } }, "Listings.V2.MedianPriceData": { "type": "object", "properties": { "priceType": { "enum": [ "house", "apartmentUnitFlat", "vacantLand" ], "type": "string", "description": "Gets or Sets PriceType", "nullable": true }, "suburb": { "type": "string", "description": "Name of the suburb median price is based on.", "nullable": true }, "postcode": { "type": "string", "description": "Postcode of the suburb", "nullable": true }, "medianPrice": { "type": "integer", "description": "Median price for the suburb.", "format": "int32", "nullable": true }, "source": { "type": "string", "description": "Where median price data comes from", "nullable": true }, "sourceDateFrom": { "type": "string", "description": "Start date of the median price source time period", "nullable": true }, "sourceDateTo": { "type": "string", "description": "End date of the median price source time period", "nullable": true }, "sourceCollectionDate": { "type": "string", "description": "The collection date of the median price source", "nullable": true } }, "additionalProperties": false, "description": "Information regarding median house/unit price for the suburb", "x-data-access-level-info": { "Basic": [ "*" ], "Detailed": [ "*" ], "Full": [ "*" ] } }, "Listings.V2.StatementOfInformation": { "type": "object", "properties": { "estimatedPrice": { "$ref": "#/components/schemas/Listings.V2.BasicPrice" }, "comparableData": { "$ref": "#/components/schemas/Listings.V2.ComparableData" }, "suburbMedianPrice": { "$ref": "#/components/schemas/Listings.V2.MedianPriceData" }, "documentationUrl": { "type": "string", "description": "Link to the statement of information documentation file", "nullable": true } }, "additionalProperties": false, "description": "Statement of Information Regarding sale listing", "x-data-access-level-info": { "Basic": [ "*" ], "Detailed": [ "*" ], "Full": [ "*" ] } }, "Listings.V2.Listing": { "required": [ "advertiserIdentifiers", "id", "propertyTypes" ], "type": "object", "properties": { "objective": { "enum": [ "sale", "rent" ], "type": "string", "description": "Gets or Sets Objective", "nullable": true }, "status": { "enum": [ "unknown", "archived", "underOffer", "sold", "leased", "newDevelopment", "recentlyUpdated", "new", "live", "pending", "depositTaken" ], "type": "string", "description": "Gets or Sets Status", "nullable": true }, "saleMode": { "enum": [ "buy", "rent", "share", "sold", "leased", "archived" ], "type": "string", "description": "Gets or Sets SaleMode", "nullable": true }, "channel": { "enum": [ "residential", "commercial", "business" ], "type": "string", "description": "Gets or Sets Channel", "nullable": true }, "id": { "type": "integer", "description": "The identifier which uniquely identifies the listing.", "format": "int32" }, "addressParts": { "$ref": "#/components/schemas/Listings.V2.AddressParts" }, "advertiserIdentifiers": { "$ref": "#/components/schemas/Listings.V2.AdvertiserIdentifiers" }, "apmIdentifiers": { "$ref": "#/components/schemas/Listings.V2.AustralianPropertyMonitorsIdentifiers" }, "bathrooms": { "type": "number", "description": "Total number of bathrooms in the property", "format": "float", "nullable": true }, "bedrooms": { "type": "number", "description": "Total number of bedrooms in the property; Studio apartments have a value of \\\"0\\\"", "format": "float", "nullable": true }, "buildingArea": { "type": "string", "description": "The building area display value of the property e.g. 160 ha", "nullable": true }, "buildingAreaSqm": { "type": "number", "description": "The properties building area in square meters", "format": "double", "nullable": true }, "carspaces": { "type": "number", "description": "Total number of car spaces in the property.", "format": "float", "nullable": true }, "dateAvailable": { "type": "string", "description": "The date the property is available. DateTime is in a local timezone.", "format": "date-time", "nullable": true }, "dateCreated": { "type": "string", "description": "The date/time the listing was created. DateTime is in AEST (Australian Eastern Standard Time) or AEDT (Australian Eastern Daylight Time) timezone.", "format": "date-time", "nullable": true }, "dateUpdated": { "type": "string", "description": "The date/time the listing had major update. DateTime is in AEST (Australian Eastern Standard Time) or AEDT (Australian Eastern Daylight Time) timezone.", "format": "date-time", "nullable": true }, "dateMinorUpdated": { "type": "string", "description": "When minor update applied to the listing. DateTime is in AEST (Australian Eastern Standard Time) or AEDT (Australian Eastern Daylight Time) timezone.", "format": "date-time", "nullable": true }, "datePurged": { "type": "string", "description": "The date/time the listing was purged. It's only returned for archived listings. DateTime is in AEST (Australian Eastern Standard Time) or AEDT (Australian Eastern Daylight Time) timezone.", "format": "date-time", "nullable": true }, "dateListed": { "type": "string", "description": "The date/time last listed. DateTime is in AEST (Australian Eastern Standard Time) or AEDT (Australian Eastern Daylight Time) timezone.", "format": "date-time", "nullable": true }, "description": { "type": "string", "description": "The long description of the property provided by the advertiser.", "nullable": true }, "devProjectId": { "type": "integer", "description": "The ID of the development project - null if no associated project", "format": "int32", "nullable": true }, "energyEfficiencyRating": { "type": "integer", "description": "Energy Efficiency Rating value for ACT properties", "format": "int32", "nullable": true }, "features": { "type": "array", "items": { "type": "string" }, "description": "The property features specified by the advertiser", "nullable": true }, "geoLocation": { "$ref": "#/components/schemas/Listings.V2.GeoLocation" }, "headline": { "type": "string", "description": "The short description of the property provided by the advertiser.", "nullable": true }, "inspectionDetails": { "$ref": "#/components/schemas/Listings.V2.PropertyInspections" }, "isNewDevelopment": { "type": "boolean", "description": "Indicates whether the property is a new development", "nullable": true }, "landArea": { "type": "string", "description": "The land area display string for the property e.g. 160 sqm", "nullable": true }, "landAreaSqm": { "type": "number", "description": "The properties land area in square meters", "format": "double", "nullable": true }, "media": { "type": "array", "items": { "$ref": "#/components/schemas/Listings.V2.ListingMedia" }, "description": "The media associated with the property provided by the advertiser", "nullable": true }, "priceDetails": { "$ref": "#/components/schemas/Listings.V2.PriceDetails" }, "propertyId": { "type": "string", "description": "The identifier which uniquely identifies the property being advertised. This may be empty if the Address of property is poorly described", "nullable": true }, "propertyTypes": { "type": "array", "items": { "enum": [ "unknown", "acreageSemiRural", "apartmentUnitFlat", "aquaculture", "blockOfUnits", "carspace", "dairyFarming", "developmentLand", "developmentSite", "duplex", "farm", "fishingForestry", "homeBased", "newHomeDesigns", "hotelLeisure", "house", "newHouseLand", "industrialWarehouse", "irrigationServices", "newLand", "livestock", "international", "medicalConsulting", "newApartments", "offices", "parkingCarSpace", "penthouse", "retail", "retirement", "rural", "ruralCommercialFarming", "semiDetached", "showroomsBulkyGoods", "specialistFarm", "studio", "terrace", "townhouse", "vacantLand", "villa", "servicedOffices", "other", "chickenShop", "seafoodShop", "deliCafe", "cropping", "viticulture", "mixedFarming", "grazing", "horticulture", "equine", "farmlet", "orchard", "ruralLifestyle", "onlineBusiness" ], "type": "string", "description": "Available types of Properties * `Unknown` - Unknown * `AcreageSemiRural` - Acreage-SemiRural * `ApartmentUnitFlat` - Apartment Unit Flat * `Aquaculture` - Aquaculture commercial/rural type * `BlockOfUnits` - Block Of Units * `Carspace` - Carspace * `DairyFarming` - Dairy Farming commercial/rural type * `DevelopmentLand` - Development / Land * `DevelopmentSite` - Development site * `Duplex` - Duplex * `Farm` - Farm * `FishingForestry` - Fishing / Forestry commercial/rural type * `HomeBased` - Home Based * `NewHomeDesigns` - New Home Designs * `HotelLeisure` - Hotel / Leisure commercial type * `House` - House * `NewHouseLand` - New House And Land * `IndustrialWarehouse` - Industrial / Warehouse commercial type * `IrrigationServices` - Irrigation Services commercial/rural type * `NewLand` - New Land * `Livestock` - Livestock commercial/rural type * `International` - International commercial type * `MedicalConsulting` - Medical / Consulting commercial type * `NewApartments` - New Apartments / Off the Plan * `Offices` - Offices commercial type * `ParkingCarSpace` - Parking / Car Space commercial type * `Penthouse` - Penthouse * `Retail` - Retail commercial type * `Retirement` - Retirement * `Rural` - Rural * `RuralCommercialFarming` - Rural / Commercial Farming commercial type * `SemiDetached` - Semi Detached * `ShowroomsBulkyGoods` - Showrooms / Bulky Goods commercial type * `SpecialistFarm` - The specialist farm * `Studio` - Studio * `Terrace` - Terrace * `Townhouse` - The townhouse * `VacantLand` - Vacant Land * `Villa` - Villa * `ServicedOffices` - Serviced Offices commercial type * `Other` - Other commercial type * `ChickenShop` - Chicken Shop commercial type * `SeafoodShop` - Seafood Shop commercial type * `DeliCafe` - Deli Cafe commercial type * `Cropping` - Cropping commercial/rural type * `Viticulture` - Viticulture commercial/rural type * `MixedFarming` - Mixed Farming commercial type * `Grazing` - Grazing commercial/rural type * `Horticulture` - Horticulture commercial/rural type * `Equine` - Equine commercial/rural type * `Farmlet` - Farmlet commercial/rural type * `Orchard` - Orchard commercial/rural type * `RuralLifestyle` - Rural Lifestyle commercial/rural type * `OnlineBusiness` - Online Business" }, "description": "Types of the property" }, "providerDetails": { "$ref": "#/components/schemas/Listings.V2.ProviderDetails" }, "rentalDetails": { "$ref": "#/components/schemas/Listings.V2.RentalDetails" }, "saleDetails": { "$ref": "#/components/schemas/Listings.V2.SaleDetails" }, "isWithdrawn": { "type": "boolean", "description": "Indicates if the property has been withdrawn from the market The value will be 'true' When a listing is taken off market without being sold or leased.", "nullable": true }, "seoUrl": { "type": "string", "description": "Listing SEO URL", "nullable": true }, "virtualTourUrl": { "type": "string", "description": "The Listing's Virtual Tour URL.", "nullable": true }, "homepassEnabled": { "type": "boolean", "description": "If Homepass is enabled for the listing (agency)", "nullable": true }, "statementOfInformation": { "$ref": "#/components/schemas/Listings.V2.StatementOfInformation" }, "numberOfDwellings": { "type": "integer", "description": "Number of dwellings for current listing", "format": "int32", "nullable": true }, "highlights": { "type": "array", "items": { "type": "string" }, "description": "Highlight items for the listing", "nullable": true } }, "additionalProperties": false, "description": "Represents a Property Listing", "x-data-access-level-info": { "Basic": [ "Id", "Status" ], "Detailed": [ "Id", "Status", "RentalDetails", "NumberOfDwellings", "PropertyId", "ApmIdentifiers", "AddressParts", "AdvertiserIdentifiers", "Bathrooms", "Bedrooms", "BuildingAreaSqm", "Carspaces", "Channel", "DateAvailable", "DateListed", "DateUpdated", "Description", "DevProjectId", "EnergyEfficiencyRating", "Features", "GeoLocation", "Headline", "Highlights", "InspectionDetails", "IsNewDevelopment", "LandAreaSqm", "Media", "Objective", "PriceDetails", "PropertyTypes", "SaleDetails", "SaleMode", "SeoUrl", "StatementOfInformation", "VirtualTourUrl" ], "Full": [ "Id", "Status", "RentalDetails", "NumberOfDwellings", "PropertyId", "ApmIdentifiers", "AddressParts", "AdvertiserIdentifiers", "Bathrooms", "Bedrooms", "BuildingAreaSqm", "Carspaces", "Channel", "DateAvailable", "DateListed", "DateUpdated", "Description", "DevProjectId", "EnergyEfficiencyRating", "Features", "GeoLocation", "Headline", "Highlights", "InspectionDetails", "IsNewDevelopment", "LandAreaSqm", "Media", "Objective", "PriceDetails", "PropertyTypes", "SaleDetails", "SaleMode", "SeoUrl", "StatementOfInformation", "VirtualTourUrl", "BuildingArea", "DateCreated", "DateMinorUpdated", "DatePurged", "ProviderDetails", "HomepassEnabled", "IsWithdrawn", "LandArea" ] } }, "ListingPerformance.v1.ProjectStatistics": { "type": "object", "properties": { "totalPhotoViews": { "type": "integer", "description": "Total number of photo views", "format": "int32", "nullable": true }, "totalFloorplanViews": { "type": "integer", "description": "Total number of floorplan views", "format": "int32", "nullable": true }, "totalMapViews": { "type": "integer", "description": "Total number of address map views", "format": "int32", "nullable": true }, "totalVideoViews": { "type": "integer", "description": "Total number of video views", "format": "int32", "nullable": true }, "totalAgentDetailViews": { "type": "integer", "description": "Total number of agent detail views", "format": "int32", "nullable": true }, "totalSearchCarouselViews": { "type": "integer", "description": "Total number of views under search carousel", "format": "int32", "nullable": true }, "totalAgentPhoneNumberReveals": { "type": "integer", "description": "Total number of times the agent phone number was revealed for contact", "format": "int32", "nullable": true }, "totalEnquiries": { "type": "integer", "description": "Total number of email enquiries", "format": "int32", "nullable": true }, "totalEmailToFriend": { "type": "integer", "description": "Total number of times the link was emailed", "format": "int32", "nullable": true }, "totalSharedViaSocialMedia": { "type": "integer", "description": "Total number of shares via social media", "format": "int32", "nullable": true }, "totalInspectionTimeSaving": { "type": "integer", "description": "Total number of times when the inspection was saved to calendar", "format": "int32", "nullable": true }, "totalCallToAgentFromMobile": { "type": "integer", "description": "Total number of calls made to agent", "format": "int32", "nullable": true }, "devProjectId": { "type": "integer", "description": "Domain Advertisement Id", "format": "int64", "nullable": true }, "totalViews": { "type": "integer", "description": "Total number of views", "format": "int32", "nullable": true }, "totalIndividualImageViews": { "type": "integer", "description": "Total number of individual image views", "format": "int32", "nullable": true }, "totalAdClick": { "type": "integer", "description": "Total number of ads clicked", "format": "int32", "nullable": true }, "totalClicksToProjectListing": { "type": "integer", "description": "Total number of click throughs to project listings", "format": "int32", "nullable": true }, "totalExternalWebsiteViews": { "type": "integer", "description": "Total number of external website view", "format": "int32", "nullable": true }, "totalEmailEnquiries": { "type": "integer", "description": "Total number of email enquiries", "format": "int32", "nullable": true } }, "additionalProperties": false, "x-data-access-level-info": { "Basic": [ "*" ], "Detailed": [ "*" ], "Full": [ "*" ] } }, "ListingPerformance.v1.DailyProjectStatistics": { "type": "object", "properties": { "totalPhotoViews": { "type": "integer", "description": "Total number of photo views", "format": "int32", "nullable": true }, "totalFloorplanViews": { "type": "integer", "description": "Total number of floorplan views", "format": "int32", "nullable": true }, "totalMapViews": { "type": "integer", "description": "Total number of address map views", "format": "int32", "nullable": true }, "totalVideoViews": { "type": "integer", "description": "Total number of video views", "format": "int32", "nullable": true }, "totalAgentDetailViews": { "type": "integer", "description": "Total number of agent detail views", "format": "int32", "nullable": true }, "totalSearchCarouselViews": { "type": "integer", "description": "Total number of views under search carousel", "format": "int32", "nullable": true }, "totalAgentPhoneNumberReveals": { "type": "integer", "description": "Total number of times the agent phone number was revealed for contact", "format": "int32", "nullable": true }, "totalEnquiries": { "type": "integer", "description": "Total number of email enquiries", "format": "int32", "nullable": true }, "totalEmailToFriend": { "type": "integer", "description": "Total number of times the link was emailed", "format": "int32", "nullable": true }, "totalSharedViaSocialMedia": { "type": "integer", "description": "Total number of shares via social media", "format": "int32", "nullable": true }, "totalInspectionTimeSaving": { "type": "integer", "description": "Total number of times when the inspection was saved to calendar", "format": "int32", "nullable": true }, "totalCallToAgentFromMobile": { "type": "integer", "description": "Total number of calls made to agent", "format": "int32", "nullable": true }, "devProjectId": { "type": "integer", "description": "Domain Advertisement Id", "format": "int64", "nullable": true }, "totalViews": { "type": "integer", "description": "Total number of views", "format": "int32", "nullable": true }, "totalIndividualImageViews": { "type": "integer", "description": "Total number of individual image views", "format": "int32", "nullable": true }, "totalAdClick": { "type": "integer", "description": "Total number of ads clicked", "format": "int32", "nullable": true }, "totalClicksToProjectListing": { "type": "integer", "description": "Total number of click throughs to project listings", "format": "int32", "nullable": true }, "totalExternalWebsiteViews": { "type": "integer", "description": "Total number of external website view", "format": "int32", "nullable": true }, "totalEmailEnquiries": { "type": "integer", "description": "Total number of email enquiries", "format": "int32", "nullable": true }, "eventDate": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false, "x-data-access-level-info": { "Basic": [ "*" ], "Detailed": [ "*" ], "Full": [ "*" ] } }, "ListingPerformance.v1.ProjectListingStatistics": { "type": "object", "properties": { "totalPhotoViews": { "type": "integer", "description": "Total number of photo views", "format": "int32", "nullable": true }, "totalFloorplanViews": { "type": "integer", "description": "Total number of floorplan views", "format": "int32", "nullable": true }, "totalMapViews": { "type": "integer", "description": "Total number of address map views", "format": "int32", "nullable": true }, "totalVideoViews": { "type": "integer", "description": "Total number of video views", "format": "int32", "nullable": true }, "totalAgentDetailViews": { "type": "integer", "description": "Total number of agent detail views", "format": "int32", "nullable": true }, "totalSearchCarouselViews": { "type": "integer", "description": "Total number of views under search carousel", "format": "int32", "nullable": true }, "totalAgentPhoneNumberReveals": { "type": "integer", "description": "Total number of times the agent phone number was revealed for contact", "format": "int32", "nullable": true }, "totalEnquiries": { "type": "integer", "description": "Total number of email enquiries", "format": "int32", "nullable": true }, "totalEmailToFriend": { "type": "integer", "description": "Total number of times the link was emailed", "format": "int32", "nullable": true }, "totalSharedViaSocialMedia": { "type": "integer", "description": "Total number of shares via social media", "format": "int32", "nullable": true }, "totalInspectionTimeSaving": { "type": "integer", "description": "Total number of times when the inspection was saved to calendar", "format": "int32", "nullable": true }, "totalCallToAgentFromMobile": { "type": "integer", "description": "Total number of calls made to agent", "format": "int32", "nullable": true }, "devProjectId": { "type": "integer", "description": "Domain Advertisement Id", "format": "int64", "nullable": true }, "totalViews": { "type": "integer", "description": "Total number of views", "format": "int32", "nullable": true }, "totalIndividualImageViews": { "type": "integer", "description": "Total number of individual image views", "format": "int32", "nullable": true }, "totalAdClick": { "type": "integer", "description": "Total number of ads clicked", "format": "int32", "nullable": true }, "totalClicksToProjectListing": { "type": "integer", "description": "Total number of click throughs to project listings", "format": "int32", "nullable": true }, "totalExternalWebsiteViews": { "type": "integer", "description": "Total number of external website view", "format": "int32", "nullable": true }, "totalEmailEnquiries": { "type": "integer", "description": "Total number of email enquiries", "format": "int32", "nullable": true }, "totalShortlisted": { "type": "integer", "description": "Total number of times the listing was short listed", "format": "int32", "nullable": true }, "totalStatementOfInformationDownloads": { "type": "integer", "description": "Total number of times when statement of information download", "format": "int32", "nullable": true }, "totalStatementOfInformationReveals": { "type": "integer", "description": "Total number of times when statement of information reveals", "format": "int32", "nullable": true }, "totalAddedNotes": { "type": "integer", "description": "Total number of times when notes added", "format": "int32", "nullable": true }, "totalCompletedInspectionChecklist": { "type": "integer", "description": "Total number of completed inspection checklist", "format": "int32", "nullable": true }, "totalVirtualTourViews": { "type": "integer", "description": "Total number of views from virtual tours", "format": "int32", "nullable": true }, "listingId": { "type": "integer", "format": "int32" } }, "additionalProperties": false, "x-data-access-level-info": { "Basic": [ "*" ], "Detailed": [ "*" ], "Full": [ "*" ] } }, "ListingPerformance.v1.ProjectListingStatisticsReport": { "type": "object", "properties": { "summary": { "$ref": "#/components/schemas/ListingPerformance.v1.ProjectStatistics" }, "dailyBreakdown": { "type": "array", "items": { "$ref": "#/components/schemas/ListingPerformance.v1.DailyProjectStatistics" }, "description": "Listing statistic breakdown for the period by days", "nullable": true }, "listingBreakdown": { "type": "array", "items": { "$ref": "#/components/schemas/ListingPerformance.v1.ProjectListingStatistics" }, "description": "Listing statistic breakdown for the period by listings", "nullable": true } }, "additionalProperties": false, "x-data-access-level-info": { "Basic": [ "*" ], "Detailed": [ "*" ], "Full": [ "*" ] } }, "ListingPerformance.v1.ProjectStatisticsReport": { "type": "object", "properties": { "summary": { "$ref": "#/components/schemas/ListingPerformance.v1.ProjectStatistics" }, "dailyBreakdown": { "type": "array", "items": { "$ref": "#/components/schemas/ListingPerformance.v1.DailyProjectStatistics" }, "description": "Listing statistic breakdown for the period by days", "nullable": true } }, "additionalProperties": false, "x-data-access-level-info": { "Basic": [ "*" ], "Detailed": [ "*" ], "Full": [ "*" ] } }, "TypeAhead.v2.PropertiesSuggest": { "type": "array", "items": { "type": "object", "properties": { "address": { "type": "string" }, "addressComponents": { "type": "object", "properties": { "unitNumber": { "type": "string" }, "streetNumber": { "type": "string" }, "streetName": { "type": "string" }, "streetType": { "type": "string" }, "streetTypeLong": { "type": "string" }, "suburb": { "type": "string" }, "postCode": { "type": "string" }, "state": { "type": "string" } } }, "id": { "type": "string" }, "relativeScore": { "type": "integer" } } } }, "Property.Enrichment.v2.coordinates": { "type": "object", "properties": { "lat": { "type": "number", "nullable": true }, "lon": { "type": "number", "nullable": true } }, "description": "Longitude/Latitude coordinates" }, "Property.Enrichment.v2.Advert": { "type": "object", "properties": { "onMarketTypes": { "type": "array", "items": { "enum": [ "Unknown", "Rent", "Sale", "Share" ], "type": "string" }, "nullable": true }, "advertId": { "type": "integer", "nullable": true }, "agency": { "type": "string", "nullable": true }, "agencyId": { "type": "integer", "nullable": true }, "url": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "Advert of properties" }, "Property.Enrichment.v2.Claim": { "type": "object", "properties": { "claimant": { "enum": [ "Owner", "Tenant", "Investor", "Unspecified" ], "type": "string", "nullable": true } }, "description": "Advert of properties" }, "Property.Enrichment.v2.PropertyId-ActivityBoundary": { "type": "object", "properties": { "advertisedDate": { "type": "string", "format": "date-time", "nullable": true }, "advertisedPrice": { "type": "integer", "nullable": true }, "agency": { "type": "string", "nullable": true }, "agencyId": { "type": "integer", "nullable": true }, "source": { "type": "string", "nullable": true }, "suppressDetails": { "type": "boolean", "nullable": true }, "suppressPrice": { "type": "boolean", "nullable": true }, "type": { "type": "string", "nullable": true }, "url": { "type": "string", "nullable": true }, "listingId": { "type": "integer", "nullable": true } }, "additionalProperties": false, "description": "Property History Activity Record" }, "Property.Enrichment.v2.PropertyId-Sales": { "type": "object", "properties": { "advertId": { "type": "string", "nullable": true }, "agency": { "type": "string", "nullable": true }, "agencyId": { "type": "integer", "nullable": true }, "agencyUrl": { "type": "string", "nullable": true }, "apmAgencyId": { "type": "integer", "nullable": true }, "date": { "type": "string", "format": "date", "nullable": true }, "daysOnMarket": { "type": "number", "format": "double", "nullable": true }, "documentedAsSold": { "type": "boolean", "nullable": true }, "price": { "type": "integer", "nullable": true }, "reportedAsSold": { "type": "boolean", "nullable": true }, "suppressDetails": { "type": "boolean", "nullable": true }, "suppressPrice": { "type": "boolean", "nullable": true }, "type": { "type": "string", "nullable": true }, "url": { "type": "string", "nullable": true }, "first": { "$ref": "#/components/schemas/Property.Enrichment.v2.PropertyId-ActivityBoundary" }, "id": { "type": "integer", "format": "int64", "nullable": true }, "last": { "$ref": "#/components/schemas/Property.Enrichment.v2.PropertyId-ActivityBoundary" }, "propertyType": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Property.Enrichment.v2.PropertyId-History": { "type": "object", "properties": { "rentals": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "first": { "$ref": "#/components/schemas/Property.Enrichment.v2.PropertyId-ActivityBoundary" }, "last": { "$ref": "#/components/schemas/Property.Enrichment.v2.PropertyId-ActivityBoundary" }, "propertyType": { "type": "string", "nullable": true } } } }, "sales": { "type": "array", "items": { "$ref": "#/components/schemas/Property.Enrichment.v2.PropertyId-Sales" } } }, "description": "Array of Rental and History Items" }, "Property.Enrichment.v2.PropertyId-Photo": { "type": "object", "properties": { "imageType": { "enum": [ "Property", "Floorplan", "GoogleStreetView" ], "type": "string", "nullable": true }, "advertId": { "type": "integer", "nullable": true }, "date": { "type": "string", "format": "date", "nullable": true }, "fullUrl": { "type": "string", "nullable": true }, "rank": { "type": "integer", "nullable": true } }, "additionalProperties": false }, "Property.Enrichment.v2.Property": { "type": "object", "properties": { "cadastreType": { "enum": [ "Point", "MultiPoint", "LineString", "MultiLineString", "Polygon", "MultiPolygon", "GeometryCollection", "Feature", "FeatureCollection" ], "type": "string", "nullable": true }, "onMarketTypes": { "type": "array", "items": { "enum": [ "Sale", "Rent", "Share", "Unknown", null ], "type": "string" }, "nullable": true }, "status": { "enum": [ "OffMarket", "OnMarket" ], "type": "string" }, "address": { "type": "string" }, "addressCoordinate": { "$ref": "#/components/schemas/Property.Enrichment.v2.coordinates" }, "addressId": { "type": "integer" }, "adverts": { "type": "array", "items": { "$ref": "#/components/schemas/Property.Enrichment.v2.Advert" } }, "bathrooms": { "type": "integer", "nullable": true }, "bedrooms": { "type": "integer", "nullable": true }, "carSpaces": { "type": "integer", "nullable": true }, "claim": { "$ref": "#/components/schemas/Property.Enrichment.v2.Claim" }, "created": { "type": "string", "nullable": true }, "features": { "type": "array", "items": { "type": "string" }, "nullable": true }, "flatNumber": { "type": "string", "nullable": true }, "history": { "$ref": "#/components/schemas/Property.Enrichment.v2.PropertyId-History" }, "id": { "type": "string", "nullable": true }, "internalArea": { "type": "string", "nullable": true }, "yearBuilt": { "type": "number", "nullable": true }, "isResidential": { "type": "boolean", "nullable": true }, "landUse": { "type": "string", "nullable": true }, "lotNumber": { "type": "string", "nullable": true }, "photos": { "type": "array", "items": { "$ref": "#/components/schemas/Property.Enrichment.v2.PropertyId-Photo" } }, "planNumber": { "type": "string", "nullable": true }, "postcode": { "type": "string", "nullable": true }, "propertyCategory": { "type": "string", "nullable": true }, "propertyCategoryId": { "type": "integer", "nullable": true }, "propertyType": { "type": "string", "nullable": true }, "propertyTypeId": { "type": "integer", "nullable": true }, "state": { "type": "string", "nullable": true }, "storeys": { "type": "string", "nullable": true }, "streetAddress": { "type": "string", "nullable": true }, "streetName": { "type": "string", "nullable": true }, "streetNumber": { "type": "string", "nullable": true }, "streetType": { "type": "string", "nullable": true }, "streetTypeLong": { "type": "string", "nullable": true }, "suburb": { "type": "string", "nullable": true }, "suburbId": { "type": "integer", "nullable": true }, "title": { "type": "string", "nullable": true }, "updated": { "type": "string", "format": "date", "nullable": true }, "urlSlug": { "type": "string", "nullable": true }, "urlSlugShort": { "type": "string", "nullable": true }, "zone": { "type": "string", "nullable": true }, "gnafIds": { "type": "array", "items": { "type": "object", "properties": { "monthNo": { "type": "integer", "nullable": true }, "yearNo": { "type": "integer", "nullable": true }, "gnafPID": { "type": "string", "nullable": true } } } }, "areaSize": { "type": "integer", "nullable": true }, "canonicalUrl": { "type": "string", "nullable": true }, "hasStrata": { "type": "boolean", "nullable": true } } }, "DomainAvm.PI.v1.ConfidenceEnum": { "enum": [ "high", "medium", "low" ], "type": "string" }, "DomainAvm.PI.v1.PropertyPriceEstimateHistory": { "type": "object", "properties": { "confidence": { "$ref": "#/components/schemas/DomainAvm.PI.v1.ConfidenceEnum" }, "date": { "type": "string", "nullable": true }, "lowerPrice": { "type": "number", "format": "double", "nullable": true }, "midPrice": { "type": "number", "format": "double", "nullable": true }, "source": { "type": "string", "nullable": true }, "upperPrice": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false, "x-data-access-level-info": { "Basic": [ "*" ], "Detailed": [ "*" ], "Full": [ "*" ] } }, "DomainAvm.PI.v1.PropertyPriceEstimate": { "type": "object", "properties": { "date": { "type": "string", "nullable": true }, "lowerPrice": { "type": "number", "format": "double", "nullable": true }, "midPrice": { "type": "number", "format": "double", "nullable": true }, "priceConfidence": { "$ref": "#/components/schemas/DomainAvm.PI.v1.ConfidenceEnum" }, "source": { "type": "string", "nullable": true }, "upperPrice": { "type": "number", "format": "double", "nullable": true }, "history": { "type": "array", "items": { "$ref": "#/components/schemas/DomainAvm.PI.v1.PropertyPriceEstimateHistory" }, "nullable": true } }, "additionalProperties": false, "x-data-access-level-info": { "Basic": [ "*" ], "Detailed": [ "*" ], "Full": [ "*" ] } }, "DomainAvm.PI.v1.ProblemDetails": { "type": "object", "properties": { "type": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "status": { "type": "integer", "format": "int32", "nullable": true }, "detail": { "type": "string", "nullable": true }, "instance": { "type": "string", "nullable": true } }, "additionalProperties": {} }, "DomainAvm.PI.v1.RentalEstimate": { "type": "object", "properties": { "weeklyRentEstimate": { "type": "integer", "format": "int32", "nullable": true }, "percentYieldRentEstimate": { "type": "number", "format": "double", "nullable": true }, "rentalFsd": { "type": "number", "format": "double", "nullable": true }, "estimateDate": { "type": "string", "nullable": true }, "propertyType": { "type": "string", "nullable": true } }, "additionalProperties": false, "x-data-access-level-info": { "Basic": [ "*" ], "Detailed": [ "*" ], "Full": [ "*" ] } }, "Property.Enrichment.v2.PropertyAddress-v2": { "required": [ "streetNumber", "streetName", "suburb", "postcode", "state" ], "type": "object", "properties": { "flatNumber": { "type": "string", "nullable": true }, "streetNumber": { "type": "string" }, "streetName": { "type": "string" }, "streetType": { "type": "string", "nullable": true }, "streetTypeLong": { "type": "string", "nullable": true }, "suburb": { "type": "string" }, "postcode": { "type": "string" }, "state": { "type": "string" } }, "description": "Address of property" }, "Property.Enrichment.v2.ImageTypes": { "enum": [ "ListingPhoto", "OldFloorPlanPhoto", "NewFloorPlanPhoto", "BuildingPhoto", "NewDevelopmentLandPhoto", "NewDevelopmentLumierePhoto", "NewDevelopmentFeaturedPhoto", "ConjunctionAgentLogo", "NewDevelopmentRegionalPhoto", "AdvertiserImage", "YouWishClip", "AgentCarousel", "DevelopmentProjectGalleryPhoto", "DevelopmentProjectAdvertisementPhoto" ] }, "Property.Enrichment.v2.ImageUrl": { "type": "object", "properties": { "advertId": { "type": "integer", "description": "Internal Domain advertisement identifier" }, "advertDate": { "type": "string", "description": "The date when advertisement was created in YYYY-MM-DD format", "format": "date", "nullable": true }, "images": { "type": "array", "items": { "type": "object", "properties": { "imageUrl": { "type": "string", "description": "URL of image source" }, "imageType": { "$ref": "#/components/schemas/Property.Enrichment.v2.ImageTypes" } }, "additionalProperties": false } } }, "additionalProperties": false, "description": "Description of advertisement image" }, "Property.Enrichment.v2.ImageResults": { "type": "object", "properties": { "propertyId": { "type": "string", "description": "Unique ID for the property" }, "addressComponents": { "$ref": "#/components/schemas/Property.Enrichment.v2.PropertyAddress-v2" }, "adverts": { "type": "array", "items": { "$ref": "#/components/schemas/Property.Enrichment.v2.ImageUrl" } } } }, "Property.Enrichment.v2.AddressBasic": { "type": "object", "properties": { "flatNumber": { "type": "string", "nullable": true }, "streetNumber": { "type": "string" }, "streetName": { "type": "string" }, "streetType": { "type": "string", "nullable": true }, "streetTypeLong": { "type": "string", "nullable": true }, "suburb": { "type": "string" }, "postcode": { "type": "string" }, "state": { "type": "string" } }, "additionalProperties": false, "description": "Address of property" }, "Property.Enrichment.v2.MultiplePropertyResults": { "type": "object", "properties": { "properties": { "type": "array", "items": { "type": "object", "properties": { "propertyId": { "type": "string" }, "addressComponents": { "$ref": "#/components/schemas/Property.Enrichment.v2.AddressBasic" } } } } } }, "Property.Enrichment.v2.saleListingHistory": { "type": "object", "properties": { "id": { "type": "string" }, "agencyId": { "type": "integer", "nullable": true }, "agencyName": { "type": "string", "nullable": true }, "firstListedDate": { "type": "string", "description": "First listed in YYYY-MM-DD format", "format": "date", "nullable": true }, "lastListedDate": { "type": "string", "description": "Last listed in YYYY-MM-DD format", "format": "date", "nullable": true }, "lastListedPrice": { "type": "integer", "nullable": true }, "daysOnMarket": { "type": "integer", "nullable": true }, "soldDate": { "type": "string", "description": "Sold date in YYYY-MM-DD format", "format": "date", "nullable": true }, "soldPrice": { "type": "number", "description": "sold price", "nullable": true }, "saleType": { "type": "string", "nullable": true }, "withdrawn": { "type": "boolean", "nullable": true } }, "additionalProperties": false, "description": "property listing history object" }, "Property.Enrichment.v2.rentListingHistory": { "type": "object", "properties": { "id": { "type": "string" }, "agencyId": { "type": "integer", "nullable": true }, "agencyName": { "type": "string", "nullable": true }, "firstListedDate": { "type": "string", "description": "First listed date in YYYY-MM-DD format", "format": "date", "nullable": true }, "lastListedDate": { "type": "string", "description": "last listed date in YYYY-MM-DD format", "format": "date", "nullable": true }, "lastListedPrice": { "type": "number", "nullable": true }, "daysOnMarket": { "type": "integer", "nullable": true } }, "additionalProperties": false, "description": "property listing history object" }, "Property.Enrichment.v2.PropertyListingResults": { "type": "object", "properties": { "propertyId": { "type": "string" }, "addressComponents": { "$ref": "#/components/schemas/Property.Enrichment.v2.AddressBasic" }, "salesListingHistory": { "type": "array", "items": { "$ref": "#/components/schemas/Property.Enrichment.v2.saleListingHistory" } }, "rentListingHistory": { "type": "array", "items": { "$ref": "#/components/schemas/Property.Enrichment.v2.rentListingHistory" } } }, "description": "property listing history object" }, "Property.Enrichment.v2.SaleHistoryListing": { "type": "object", "properties": { "id": { "type": "string" }, "agencyName": { "type": "string", "nullable": true }, "agencyId": { "type": "integer", "nullable": true }, "firstListedDate": { "type": "string", "description": "First activity date in YYYY-MM-DD format", "format": "date", "nullable": true }, "lastListedDate": { "type": "string", "description": "Last activity date in YYYY-MM-DD format", "format": "date", "nullable": true }, "lastListedPrice": { "type": "number", "nullable": true }, "daysOnMarket": { "type": "integer", "nullable": true }, "soldDate": { "type": "string", "description": "Sold date in YYYY-MM-DD format", "format": "date", "nullable": true }, "soldPrice": { "type": "number", "description": "sold price", "nullable": true }, "saleType": { "type": "string", "description": "Sale type ['Auction', 'Private Treaty']", "nullable": true } } }, "Property.Enrichment.v2.RentHistoryListing": { "type": "object", "properties": { "id": { "type": "string" }, "agencyName": { "type": "string", "nullable": true }, "agencyId": { "type": "integer", "nullable": true }, "firstListedDate": { "type": "string", "description": "First activity date in YYYY-MM-DD format", "format": "date", "nullable": true }, "lastListedDate": { "type": "string", "description": "Last activity date in YYYY-MM-DD format", "format": "date", "nullable": true }, "lastListedPrice": { "type": "number", "nullable": true }, "daysOnMarket": { "type": "integer", "nullable": true } } }, "Property.Enrichment.v2.SaleHistory": { "type": "object", "properties": { "propertyId": { "type": "string", "description": "Unique ID for the property" }, "addressComponents": { "$ref": "#/components/schemas/Property.Enrichment.v2.AddressBasic" }, "salesHistory": { "type": "array", "items": { "$ref": "#/components/schemas/Property.Enrichment.v2.SaleHistoryListing" }, "description": "An array of the sale histories for the listing" }, "rentalHistory": { "type": "array", "items": { "$ref": "#/components/schemas/Property.Enrichment.v2.RentHistoryListing" }, "description": "An array of the rent histories for the listing" } } }, "Property.Enrichment.v2.Property.SummaryFull": { "type": "object", "properties": { "propertyType": { "type": "string", "nullable": true }, "bedrooms": { "type": "string", "nullable": true }, "bathrooms": { "type": "string", "nullable": true }, "carSpaces": { "type": "string", "nullable": true }, "landSize": { "type": "string", "nullable": true }, "buildingSize": { "type": "string", "nullable": true }, "hasStrata": { "type": "boolean", "nullable": true }, "internalArea": { "type": "string", "nullable": true }, "yearBuilt": { "type": "number", "nullable": true } }, "additionalProperties": false, "description": "Property summary (not currently in EVENT-SCHEMAS project)" }, "Property.Enrichment.v2.Property.SummaryBasic": { "type": "object", "properties": { "propertyType": { "type": "string", "nullable": true }, "bedrooms": { "type": "string", "nullable": true }, "bathrooms": { "type": "string", "nullable": true }, "carSpaces": { "type": "string", "nullable": true }, "landSize": { "type": "string", "nullable": true }, "hasStrata": { "type": "boolean", "nullable": true }, "internalArea": { "type": "string", "nullable": true }, "yearBuilt": { "type": "number", "nullable": true } }, "additionalProperties": false, "description": "Property summary (not currently in EVENT-SCHEMAS project)" }, "Property.Enrichment.v2.Property.Activity.SummaryFull": { "type": "object", "properties": { "lastRentedDate": { "type": "string", "nullable": true }, "lastRentedPrice": { "type": "number", "nullable": true }, "lastSoldDate": { "type": "string", "nullable": true }, "lastSoldPrice": { "type": "number", "nullable": true }, "lastListedDateRent": { "type": "string", "nullable": true }, "lastListedPriceRent": { "type": "number", "nullable": true }, "lastListedDateSale": { "type": "string", "nullable": true }, "lastListedPriceSale": { "type": "number", "nullable": true }, "ownerRenter": { "enum": [ "Owner", "Renter" ], "type": "string", "nullable": true }, "marketStatus": { "enum": [ "on-market", "off-market" ], "type": "string", "nullable": true } }, "additionalProperties": false, "description": "Property activity summary derived from property activity events (not currently in EVENT-SCHEMAS project)" }, "Property.Enrichment.v2.Property.Activity.SummaryBasic": { "type": "object", "properties": { "lastRentedDate": { "type": "string", "nullable": true }, "lastSoldDate": { "type": "string", "nullable": true }, "lastListedDateRent": { "type": "string", "nullable": true }, "lastListedDateSale": { "type": "string", "nullable": true }, "ownerRenter": { "enum": [ "Owner", "Renter" ], "type": "string", "description": "Whether the most recent known activity indicates that the current resident is the owner or renter", "nullable": true }, "marketStatus": { "enum": [ "on-market", "off-market" ], "type": "string" } }, "additionalProperties": false, "description": "Property activity summary derived from property activity events (not currently in EVENT-SCHEMAS project)" }, "Property.Enrichment.v2.PropertyResults": { "type": "object", "properties": { "propertyId": { "type": "string", "description": "Unique ID for the property" }, "addressComponents": { "$ref": "#/components/schemas/Property.Enrichment.v2.AddressBasic" }, "propertySummary": { "oneOf": [ { "$ref": "#/components/schemas/Property.Enrichment.v2.Property.SummaryFull" }, { "$ref": "#/components/schemas/Property.Enrichment.v2.Property.SummaryBasic" } ], "description": "Summary of property information", "x-data-access-level-info": { "Basic": [ "propertyType", "bedrooms", "bathrooms", "carSpaces", "landSize", "internalArea", "yearBuilt" ], "Detailed": [ "propertyType", "bedrooms", "bathrooms", "carSpaces", "landSize", "buildingSize", "internalArea", "yearBuilt" ], "Full": [ "*" ] } }, "activitySummary": { "oneOf": [ { "$ref": "#/components/schemas/Property.Enrichment.v2.Property.Activity.SummaryFull" }, { "$ref": "#/components/schemas/Property.Enrichment.v2.Property.Activity.SummaryBasic" } ], "description": "Summary of latest rental and sale records", "x-data-access-level-info": { "Basic": [ "lastRentedDate", "lastSoldDate", "lastListedDateRent", "lastListedDateSale", "ownerRenter", "marketStatus" ], "Detailed": [ "lastListedDate", "lastSoldDate", "lastRentedDate", "lastListedPrice", "lastSoldPrice", "lastRentedPrice", "ownerRenter" ], "Full": [ "*" ] } } } }, "Domain.PropertyReportService.v1.Model.WashedLocation": { "type": "object", "properties": { "unitNumber": { "type": "string" }, "streetNumber": { "type": "string" }, "streetName": { "type": "string" }, "streetType": { "type": "string" }, "suburb": { "type": "string" }, "postcode": { "type": "string" }, "state": { "type": "string" } }, "x-data-access-level-info": { "Basic": [ "*" ], "Detailed": [ "*" ], "Full": [ "*" ] } }, "Domain.PropertyReportService.v1.Model.PropertyReportContainer": { "type": "object", "properties": { "mimeType": { "type": "string" }, "content": { "type": "string", "format": "byte" } }, "x-data-access-level-info": { "Basic": [ "*" ], "Detailed": [ "*" ], "Full": [ "*" ] } }, "Domain.PropertyReportService.v1.Model.PropertyReportGenerationResult": { "type": "object", "properties": { "washedLocation": { "$ref": "#/components/schemas/Domain.PropertyReportService.v1.Model.WashedLocation" }, "report": { "$ref": "#/components/schemas/Domain.PropertyReportService.v1.Model.PropertyReportContainer" } }, "x-data-access-level-info": { "Basic": [ "*" ], "Detailed": [ "*" ], "Full": [ "*" ] } }, "DomainAvm.v1.Address": { "type": "object", "properties": { "unitNumber": { "type": "string", "description": "The unit number of the address.", "nullable": true }, "streetNumber": { "type": "string", "description": "The street number of the address.", "nullable": true }, "streetName": { "type": "string", "description": "The street name of the address.", "nullable": true }, "streetType": { "type": "string", "description": "The street type of the address.", "nullable": true }, "locality": { "type": "string", "description": "The suburb/locality of the address.", "nullable": true }, "postcode": { "pattern": "^[0-9]{3,4}$", "type": "string", "description": "The postcode of the address.", "nullable": true }, "state": { "pattern": "^[A-Za-z]{2,3}$", "type": "string", "description": "The defined State or Territory in Australia (in abbreviated format) where the specific address is located.", "nullable": true } }, "additionalProperties": false, "description": "The Address model used." }, "DomainAvm.v1.AddressCoordinate": { "type": "object", "properties": { "lat": { "type": "number", "description": "The angular distance of a place north or south of the Equator.", "format": "double", "nullable": true }, "lon": { "type": "number", "description": "Te angular distance of a place east or west of the Greenwich meridian.", "format": "double", "nullable": true } }, "additionalProperties": false, "description": "A model used for coordinate data." }, "DomainAvm.v1.ActivityBoundary": { "type": "object", "properties": { "advertisedDate": { "type": "string", "description": "The date.", "nullable": true }, "advertisedPrice": { "type": "integer", "description": "The price.", "format": "int32", "nullable": true }, "agency": { "type": "string", "description": "The agency.", "nullable": true }, "suppressPrice": { "type": "boolean", "description": "Flag to suppress price.", "nullable": true } }, "additionalProperties": false, "description": "A model used to return property rental and sale history." }, "DomainAvm.v1.RentalActivity": { "type": "object", "properties": { "first": { "$ref": "#/components/schemas/DomainAvm.v1.ActivityBoundary" }, "last": { "$ref": "#/components/schemas/DomainAvm.v1.ActivityBoundary" }, "rentedPrice": { "type": "integer", "description": "The rental price.", "format": "int32", "nullable": true }, "status": { "type": "string", "description": "The rental status.", "nullable": true } }, "additionalProperties": false, "description": "A model used to return property rental activity." }, "DomainAvm.v1.SaleActivity": { "type": "object", "properties": { "date": { "type": "string", "description": "The sale date.", "nullable": true }, "price": { "type": "integer", "description": "The sale price.", "format": "int32", "nullable": true }, "type": { "type": "string", "description": "The sale type.", "nullable": true } }, "additionalProperties": false, "description": "A model used to return property sale activity.\r\n///" }, "DomainAvm.v1.History": { "type": "object", "properties": { "rentals": { "type": "array", "items": { "$ref": "#/components/schemas/DomainAvm.v1.RentalActivity" }, "description": "The list of rental activity.", "nullable": true }, "sales": { "type": "array", "items": { "$ref": "#/components/schemas/DomainAvm.v1.SaleActivity" }, "description": "The list of sale activity.", "nullable": true } }, "additionalProperties": false, "description": "A model used to return property rental and sale history." }, "DomainAvm.v1.Photo": { "type": "object", "properties": { "fullUrl": { "type": "string", "description": "Full Url of the image.", "nullable": true }, "rank": { "type": "integer", "description": "The viewing order.", "format": "int32", "nullable": true } }, "additionalProperties": false, "description": "A model used to return photo url and rank." }, "DomainAvm.v1.RentalAvm": { "type": "object", "properties": { "estimateDate": { "type": "string", "description": "The date the estimate was generated.", "nullable": true }, "percentYieldRentEstimate": { "type": "number", "description": "The yield rent estimate as a percentage.", "format": "double", "nullable": true }, "rentalFsd": { "type": "number", "description": "The forecast standard deviation of the rent.", "format": "double", "nullable": true }, "weeklyRentEstimate": { "type": "integer", "description": "The weekly estimated rent.", "format": "int32", "nullable": true } }, "additionalProperties": false, "description": "A model used to return rental valuation." }, "DomainAvm.v1.SaleAvm": { "type": "object", "properties": { "confidenceLevel": { "type": "string", "description": "Level of certainty of a property valuation. Valid values [High, Medium, Low].", "nullable": true }, "estimate": { "type": "integer", "description": "The estimate.", "format": "int32", "nullable": true }, "estimateDate": { "type": "string", "description": "The date the estimates were generated.", "nullable": true }, "estimateHigh": { "type": "integer", "description": "The estimate high range.", "format": "int32", "nullable": true }, "estimateLow": { "type": "integer", "description": "The estimate low range.", "format": "int32", "nullable": true }, "percentFsd": { "type": "number", "description": "The forecast standard deviation of the property.", "format": "double", "nullable": true } }, "additionalProperties": false, "description": "A model used to return sale valuation." }, "DomainAvm.v1.Advert": { "type": "object", "properties": { "displayPrice": { "type": "string", "description": "The property price that appears in advertisements.", "nullable": true }, "status": { "type": "string", "description": "The status of the property listing. Valid values: [Live, UnderOffer].", "nullable": true } }, "additionalProperties": false, "description": "A model used to return advertisement/listing data" }, "DomainAvm.v1.Sale": { "type": "object", "properties": { "date": { "type": "string", "description": "The date of sale", "nullable": true }, "price": { "type": "integer", "description": "The price of sale", "format": "int32", "nullable": true }, "type": { "type": "string", "description": "The type of sale", "nullable": true } }, "additionalProperties": false, "description": "A model used to return sale history." }, "DomainAvm.v1.Item": { "type": "object", "properties": { "address": { "type": "string", "description": "The address of the property.", "nullable": true }, "addressCoordinate": { "$ref": "#/components/schemas/DomainAvm.v1.AddressCoordinate" }, "adverts": { "type": "array", "items": { "$ref": "#/components/schemas/DomainAvm.v1.Advert" }, "description": "Property listing data (advertisement).", "nullable": true }, "areaSize": { "type": "number", "description": "Land area in square meters to be used when estimating value of property, for houses only not units.", "format": "double", "nullable": true }, "bathrooms": { "type": "integer", "description": "The amount of bathrooms.", "format": "int32", "nullable": true }, "bedrooms": { "type": "integer", "description": "The amount of bedrooms.", "format": "int32", "nullable": true }, "buildingArea": { "type": "number", "description": "Building area in square meters to be used when estimating value of property, for houses only not units.", "format": "double", "nullable": true }, "carSpaces": { "type": "integer", "description": "The amount of carparks.", "format": "int32", "nullable": true }, "lastSaleActivity": { "$ref": "#/components/schemas/DomainAvm.v1.Sale" }, "id": { "type": "string", "description": "The Unique Domain Property Id of the property.", "nullable": true }, "photos": { "type": "array", "items": { "$ref": "#/components/schemas/DomainAvm.v1.Photo" }, "description": "An list of ranked property photos.", "nullable": true }, "priceHeading": { "type": "string", "description": "The price heading.", "nullable": true } }, "additionalProperties": false, "description": "A model used for property data." }, "DomainAvm.v1.SalesGrowth": { "type": "object", "properties": { "annualGrowth": { "type": "number", "description": "The annual growth", "format": "double", "nullable": true }, "medianSoldPrice": { "type": "integer", "description": "The median sold price", "format": "int32", "nullable": true }, "numberSold": { "type": "integer", "description": "Number of sales.", "format": "int32", "nullable": true }, "year": { "type": "string", "description": "Year.", "nullable": true } }, "additionalProperties": false, "description": "A model used to group sales growth" }, "DomainAvm.v1.PropertyCategory": { "type": "object", "properties": { "auctionClearanceRate": { "type": "number", "description": "Auction clearances rate.", "format": "double", "nullable": true }, "bedrooms": { "type": "integer", "description": "Number of bedrooms in the dwelling.", "format": "int32", "nullable": true }, "daysOnMarket": { "type": "integer", "description": "Average days on market.", "format": "int32", "nullable": true }, "entryLevelPrice": { "type": "integer", "description": "The entry level price.", "format": "int32", "nullable": true }, "luxuryLevelPrice": { "type": "integer", "description": "The luxury level price.", "format": "int32", "nullable": true }, "medianRentPrice": { "type": "integer", "description": "The median rental price.", "format": "int32", "nullable": true }, "medianSoldPrice": { "type": "integer", "description": "The median sold price", "format": "int32", "nullable": true }, "numberSold": { "type": "integer", "description": "Number of sales.", "format": "int32", "nullable": true }, "propertyCategory": { "type": "string", "description": "The property category.", "nullable": true }, "salesGrowthList": { "type": "array", "items": { "$ref": "#/components/schemas/DomainAvm.v1.SalesGrowth" }, "description": "The sales growth for last 6 years.", "nullable": true } }, "additionalProperties": false, "description": "A model used to group sales growth for a property category" }, "DomainAvm.v1.AvmResponse": { "type": "object", "properties": { "address": { "$ref": "#/components/schemas/DomainAvm.v1.Address" }, "addressCoordinate": { "$ref": "#/components/schemas/DomainAvm.v1.AddressCoordinate" }, "areaSize": { "type": "number", "description": "Land area in square meters to be used when estimating value of property, for houses only not units.", "format": "double", "nullable": true }, "bathrooms": { "type": "integer", "description": "The amount of bathrooms.", "format": "int32", "nullable": true }, "bedrooms": { "type": "integer", "description": "The amount of bedrooms.", "format": "int32", "nullable": true }, "buildingArea": { "type": "number", "description": "Building area in square meters to be used when estimating value of property, for houses only not units.", "format": "double", "nullable": true }, "carSpaces": { "type": "integer", "description": "The amount of carparks.", "format": "int32", "nullable": true }, "history": { "$ref": "#/components/schemas/DomainAvm.v1.History" }, "legalParcel": { "type": "string", "description": "Legal parcel for detailed and full packages.", "nullable": true }, "photos": { "type": "array", "items": { "$ref": "#/components/schemas/DomainAvm.v1.Photo" }, "description": "An array of ranked property photographs provided for full packages.", "nullable": true }, "propertyId": { "type": "string", "description": "The Unique Property Id of the target property", "nullable": true }, "propertyType": { "type": "string", "description": "Property type used when estimating the value of property. Valid values: [House, Unit].", "nullable": true }, "rentalAvm": { "$ref": "#/components/schemas/DomainAvm.v1.RentalAvm" }, "saleAvm": { "$ref": "#/components/schemas/DomainAvm.v1.SaleAvm" }, "similarListings": { "type": "array", "items": { "$ref": "#/components/schemas/DomainAvm.v1.Item" }, "description": "Similar listings properties provided for detailed and full packages.", "nullable": true }, "similarRentals": { "type": "array", "items": { "$ref": "#/components/schemas/DomainAvm.v1.Item" }, "description": "Similar rental properties provided for detailed and full packages.", "nullable": true }, "similarSolds": { "type": "array", "items": { "$ref": "#/components/schemas/DomainAvm.v1.Item" }, "description": "Similar sold properties provided for detailed and full packages", "nullable": true }, "suburbPerformance": { "$ref": "#/components/schemas/DomainAvm.v1.PropertyCategory" }, "yearBuilt": { "type": "integer", "description": "The year of construction.", "format": "int32", "nullable": true } }, "additionalProperties": false, "description": "The response model used to provide the detailed bank grade valuation data." }, "DomainAvm.v1.ProblemDetails": { "type": "object", "properties": { "type": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "status": { "type": "integer", "format": "int32", "nullable": true }, "detail": { "type": "string", "nullable": true }, "instance": { "type": "string", "nullable": true } }, "additionalProperties": {} }, "DomainAvm.v1.AvmReportResponse": { "type": "object", "properties": { "address": { "$ref": "#/components/schemas/DomainAvm.v1.Address" }, "propertyId": { "type": "string", "description": "The Unique Property Id of the target property", "nullable": true }, "report": { "type": "string", "description": "The B64 encoded pdf of the valuation report.", "nullable": true } }, "additionalProperties": false, "description": "The response model used to provide the valuation report." }, "Property.Enrichment.v2.PropertyFeatures": { "type": "object", "properties": { "propertyId": { "type": "string" }, "addressComponents": { "$ref": "#/components/schemas/Property.Enrichment.v2.AddressBasic" }, "features": { "type": "object", "properties": { "solarPvSystem": { "type": "boolean" }, "solarHotWater": { "type": "boolean" }, "pool": { "type": "boolean" }, "tennisCourt": { "type": "boolean" }, "heating": { "type": "boolean" }, "heatingGas": { "type": "boolean" }, "airConditioning": { "type": "boolean" }, "airConditioningDucted": { "type": "boolean" }, "alarmSystem": { "type": "boolean" }, "vacuumSystem": { "type": "boolean" }, "intercom": { "type": "boolean" }, "spa": { "type": "boolean" }, "waterTank": { "type": "boolean" }, "greyWaterSystem": { "type": "boolean" }, "builtInRobes": { "type": "boolean" }, "deck": { "type": "boolean" }, "courtyard": { "type": "boolean" }, "shed": { "type": "boolean" }, "fullyFenced": { "type": "boolean" }, "openFirePlace": { "type": "boolean" }, "floorboards": { "type": "boolean" }, "gym": { "type": "boolean" }, "openPlanLiving": { "type": "boolean" }, "study": { "type": "boolean" }, "balcony": { "type": "boolean" }, "rumpusRoom": { "type": "boolean" }, "workshop": { "type": "boolean" }, "remoteGarage": { "type": "boolean" }, "primaryRoofMaterial": { "type": "string", "nullable": true } } } }, "additionalProperties": false }, "Property.Enrichment.v2.MultipleAddressBasic": { "type": "array", "items": { "type": "object", "properties": { "propertyId": { "type": "string" }, "addressComponents": { "type": "object", "properties": { "flatNumber": { "type": "string", "nullable": true }, "streetNumber": { "type": "string" }, "streetName": { "type": "string" }, "streetType": { "type": "string", "nullable": true }, "streetTypeLong": { "type": "string", "nullable": true }, "suburb": { "type": "string" }, "postcode": { "type": "string" }, "state": { "type": "string" } }, "additionalProperties": false, "description": "Address of property" } }, "additionalProperties": false } }, "Property.Enrichment.v2.SearchItemOutput": { "type": "object", "properties": { "propertyid": { "type": "string" }, "listingid": { "type": "integer", "nullable": true }, "addresscomponents": { "$ref": "#/components/schemas/Property.Enrichment.v2.AddressBasic" }, "bedrooms": { "type": "integer", "nullable": true }, "bathrooms": { "type": "integer", "nullable": true }, "carspaces": { "type": "integer", "nullable": true }, "landarea": { "type": "integer", "nullable": true }, "images": { "type": "array", "items": { "type": "object", "properties": { "image_url": { "type": "string", "description": "URL of image source" }, "image_type": { "$ref": "#/components/schemas/Property.Enrichment.v2.ImageTypes" } } } }, "eventdate": { "type": "string", "description": "date of the event in YYYY-MM-DD format.", "format": "date", "nullable": true, "example": "2024-08-22" }, "eventprice": { "type": "number", "nullable": true }, "distance": { "type": "number" } } }, "PropertyActivityAPI.v1.PortfolioDetails": { "type": "object", "anyOf": [ { "required": [ "PropertyIds" ] }, { "required": [ "GnafIds" ] } ], "properties": { "PropertyIds": { "maxItems": 5000, "type": "array", "items": { "pattern": "^[A-Z]{2}-\\d{4}-[A-Z]{2}$", "type": "string" }, "description": "Array of property id's in format XX-9999-XX", "example": [ "AB-2872-NY", "RF-8884-AK" ] }, "GnafIds": { "maxItems": 5000, "type": "array", "items": { "pattern": "^\\S+$", "type": "string" }, "description": "Array of gnaf id's", "example": [ "GAVIC419677979", "GANSW710292212" ] } }, "additionalProperties": false, "description": "Portfolio Details" }, "PropertyActivityAPI.v1.PortfolioCreated": { "type": "object", "properties": { "PortfolioId": { "type": "string", "description": "Unique ID for the portfolio", "example": "PORTFOLIO_7eedc8e01b2942eaaa396de4b512f6a1" } } }, "PropertyActivityAPI.v1.PortfolioList": { "type": "object", "properties": { "Portfolios": { "type": "array", "items": { "type": "object", "properties": { "PortfolioId": { "type": "string", "example": "PORTFOLIO_7eedc8e01b2942eaaa396de4b512f6a1" }, "PropertyIdCount": { "type": "integer", "description": "Total number of property ids defined" }, "GnafIdCount": { "type": "integer", "description": "Total number of gnaf ids defined" } } } } } }, "Property.Enrichment.v2.PointRadiusPropertyId": { "required": [ "propertyId" ], "type": "object", "properties": { "propertyId": { "type": "string", "description": "Property ID of property to use as the center of the search radius." } } }, "Property.Enrichment.v2.PointRadiusParams": { "type": "object", "properties": { "radius": { "maximum": 50, "type": "number", "description": "Radius of the search in KM. Default is 5km.", "default": 5 }, "propertyType": { "enum": [ "House", "Unit" ], "type": "string", "description": "Type of property." }, "startDate": { "type": "string", "description": "Start date for filtering based on the date in YYYY-MM-DD format. Valid only for search type 'sold'.", "format": "date", "example": "2024-08-22" }, "endDate": { "type": "string", "description": "End date for filtering based on the date in YYYY-MM-DD format. Valid only for search type 'sold'.", "format": "date", "example": "2024-08-22" }, "priceMin": { "type": "number", "description": "Minimum price for the search." }, "priceMax": { "type": "number", "description": "Maximum price for the search." }, "bedroomMin": { "type": "integer", "description": "Minimum number of bedrooms." }, "bedroomMax": { "type": "integer", "description": "Maximum number of bedrooms." }, "bathroomMin": { "type": "integer", "description": "Minimum number of bathrooms." }, "bathroomMax": { "type": "integer", "description": "Maximum number of bathrooms." }, "carSpacesMin": { "type": "integer", "description": "Minimum number of car spaces." }, "carSpacesMax": { "type": "integer", "description": "Maximum number of car spaces." }, "landSizeMin": { "type": "integer", "description": "Minimum land size in square meters." }, "landSizeMax": { "type": "integer", "description": "Maximum land size in square meters." } } }, "Property.Enrichment.v2.PointRadiusGnafId": { "required": [ "gnafId" ], "type": "object", "properties": { "gnafId": { "type": "string", "description": "Gnaf ID of property to use as the center of the search radius." } } }, "Property.Enrichment.v2.PointRadiusLatLon": { "required": [ "latitude", "longitude" ], "type": "object", "properties": { "latitude": { "type": "number", "description": "latitude of the coordinates to use as the center of the search radius." }, "longitude": { "type": "number", "description": "longitude of the coordinates to use as the center of the search radius." } } }, "Property.Enrichment.v2.PropertyPerils": { "type": "object", "properties": { "propertyId": { "type": "string" }, "addressComponents": { "$ref": "#/components/schemas/Property.Enrichment.v2.AddressBasic" }, "bushfireZone": { "type": "boolean", "nullable": true }, "floodZone": { "type": "boolean", "nullable": true }, "heritageZone": { "type": "boolean", "nullable": true }, "zoning": { "type": "string", "nullable": true }, "permittedUse": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AuctionResults.v1.infoResponse": { "type": "object", "properties": { "auctionedDate": { "type": "string", "description": "Date of auction event", "format": "date" }, "lastModifiedDateTime": { "type": "string", "description": "Date when results were published", "format": "date-time" } }, "additionalProperties": false, "description": "Retrieves metadata regarding sales result data of the latest Saturday" }, "AuctionResults.v1.summaryResponse": { "type": "object", "properties": { "auctionedDate": { "type": "string", "format": "date", "nullable": true }, "lastModifiedDateTime": { "type": "string", "format": "date-time", "nullable": true }, "numberListedForAuction": { "type": "number", "nullable": true }, "numberWithdrawn": { "type": "number", "nullable": true }, "numberUnreported": { "type": "number", "nullable": true }, "numberSold": { "type": "number", "nullable": true }, "totalSales": { "type": "number", "nullable": true }, "median": { "type": "number", "nullable": true }, "adjClearanceRate": { "type": "number", "nullable": true } }, "additionalProperties": false, "description": "Get report stats" }, "AuctionResults.v1.listingEventItem": { "type": "object", "properties": { "unitNumber": { "type": "string", "nullable": true }, "streetNumber": { "type": "string", "nullable": true }, "streetName": { "type": "string", "nullable": true }, "streetType": { "type": "string", "nullable": true }, "suburb": { "type": "string", "nullable": true }, "postcode": { "type": "string", "nullable": true }, "state": { "type": "string", "nullable": true }, "geoLocation": { "type": "object", "nullable": true }, "propertyType": { "type": "string", "nullable": true }, "bedrooms": { "type": "number", "nullable": true }, "bathrooms": { "type": "number", "nullable": true }, "carspaces": { "type": "number", "nullable": true }, "price": { "type": "number", "nullable": true }, "result": { "type": "string", "nullable": true }, "agent": { "type": "string", "nullable": true }, "agencyName": { "type": "string", "nullable": true }, "agencyProfilePageUrl": { "type": "string", "nullable": true }, "id": { "type": "number", "nullable": true }, "agencyId": { "type": "number", "nullable": true }, "propertyDetailsUrl": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "Listing event details" }, "AuctionResults.v1.propertySaleDetails": { "title": "Property Sale Details", "type": "object", "properties": { "price": { "type": "number", "description": "Final sale price of the property" }, "address": { "type": "string", "description": "Full address of the property", "example": "123 Story Street, NSW" }, "bathrooms": { "type": "number", "nullable": true }, "bedrooms": { "type": "number", "nullable": true }, "carSpaces": { "type": "number", "nullable": true } } }, "AuctionResults.v1.saturdayAuctionItem": { "required": [ "region", "scheduled", "reported", "sold", "clearanceRate", "mostExpensiveSale", "leastExpensiveSale", "top5" ], "type": "object", "properties": { "region": { "enum": [ "Sydney", "Melbourne", "Brisbane", "Adelaide", "Perth", "Canberra", "Hobart", "Darwin" ], "type": "string" }, "scheduled": { "type": "number" }, "reported": { "type": "number" }, "sold": { "type": "number" }, "clearanceRate": { "type": "number", "nullable": true }, "mostExpensiveSale": { "oneOf": [ { "$ref": "#/components/schemas/AuctionResults.v1.propertySaleDetails" }, { "type": "null" } ] }, "leastExpensiveSale": { "oneOf": [ { "$ref": "#/components/schemas/AuctionResults.v1.propertySaleDetails" }, { "type": "null" } ] }, "top5": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false, "description": "Saturday auction result item" }, "AuctionResults.v1.saturdayAuctionResultResponse": { "type": "object", "properties": { "auctionDate": { "type": "string", "format": "date" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/AuctionResults.v1.saturdayAuctionItem" } } }, "additionalProperties": false, "description": "Saturday auction results response" }, "AuctionResults.v1.weeklyMediaItem": { "required": [ "region", "scheduled", "reported", "sold", "soldPrior", "withdrawn", "passedIn", "medianPrice", "totalSoldPrice", "clearanceRate", "clearanceRateLastYear" ], "type": "object", "properties": { "region": { "enum": [ "Sydney", "Melbourne", "Brisbane", "Adelaide", "Perth", "Canberra", "Hobart", "Darwin", "National" ], "type": "string" }, "scheduled": { "type": "number" }, "reported": { "type": "number" }, "sold": { "type": "number" }, "soldPrior": { "type": "number" }, "withdrawn": { "type": "number" }, "passedIn": { "type": "number" }, "privateSales": { "type": "number", "nullable": true }, "medianPrice": { "type": "number", "nullable": true }, "totalSoldPrice": { "type": "number", "nullable": true }, "clearanceRate": { "type": "number", "nullable": true }, "clearanceRateLastYear": { "type": "number", "nullable": true }, "mostExpensiveSale": { "oneOf": [ { "$ref": "#/components/schemas/AuctionResults.v1.propertySaleDetails" }, { "type": "null" } ] }, "leastExpensiveSale": { "oneOf": [ { "$ref": "#/components/schemas/AuctionResults.v1.propertySaleDetails" }, { "type": "null" } ] } }, "additionalProperties": false, "description": "Email Weekly Media Report details" }, "AuctionResults.v1.weeklyMediaResultResponse": { "type": "object", "properties": { "auctionDate": { "type": "string", "format": "date" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/AuctionResults.v1.weeklyMediaItem" } } }, "additionalProperties": false, "description": "Weekly media report response" }, "Schools.V2.SchoolProfile": { "type": "object", "properties": { "url": { "type": "string", "description": "Website for the school", "nullable": true }, "yearRange": { "type": "string", "description": "The range of year levels offered by the school.", "nullable": true }, "icsea": { "type": "integer", "description": "The Index of Community Socio-Educational Advantage score for the school. This score is derived from a number of variables including parental school and non-school education and occupation, the school’s geographical location and proportion of Indigenous students.", "format": "int32", "nullable": true }, "bottomSeaQuarter": { "type": "integer", "description": "The percentage of students positioned in the lowest socio-educational advantage quarter.", "format": "int32", "nullable": true }, "lowerMiddleSeaQuarter": { "type": "integer", "description": "The percentage of students positioned in the lower middle socio-educational advantage quarter.", "format": "int32", "nullable": true }, "upperMiddleSeaQuarter": { "type": "integer", "description": "The percentage of students positioned in the higher middle socio-educational advantage quarter.", "format": "int32", "nullable": true }, "topSeaQuarter": { "type": "integer", "description": "The percentage of students positioned in the highest socio-educational advantage quarter.", "format": "int32", "nullable": true }, "totalEnrolments": { "type": "integer", "description": "The total number of students, including both full-time and part-time students, who are enrolled at the school in the calendar year specified.", "format": "int32", "nullable": true }, "girlsEnrolments": { "type": "integer", "description": "The total number of female students, including both full-time and part-time students, who are enrolled at the school in the calendar year specified.", "format": "int32", "nullable": true }, "boysEnrolments": { "type": "integer", "description": "The total number of male students, including full-time and part-time students, who are enrolled at the school in the calendar year specified.", "format": "int32", "nullable": true } }, "additionalProperties": false, "description": "SchoolProfile", "x-data-access-level-info": { "Basic": [ "Url", "YearRange", "GirlsEnrolments", "BoysEnrolments", "TotalEnrolments", "TopSeaQuarter", "UpperMiddleSeaQuarter", "LowerMiddleSeaQuarter", "BottomSeaQuarter", "Icsea" ], "Detailed": [ "Url", "YearRange", "GirlsEnrolments", "BoysEnrolments", "TotalEnrolments", "TopSeaQuarter", "UpperMiddleSeaQuarter", "LowerMiddleSeaQuarter", "BottomSeaQuarter", "Icsea" ], "Full": [ "Url", "YearRange", "GirlsEnrolments", "BoysEnrolments", "TotalEnrolments", "TopSeaQuarter", "UpperMiddleSeaQuarter", "LowerMiddleSeaQuarter", "BottomSeaQuarter", "Icsea" ] } }, "Schools.V2.SchoolCatchment": { "type": "object", "properties": { "type": { "enum": [ "Primary", "Secondary" ], "type": "string", "description": "Gets or Sets Type", "nullable": true } }, "additionalProperties": false, "description": "SchoolCatchment", "x-data-access-level-info": { "Basic": [], "Detailed": [], "Full": [ "Type" ] } }, "Schools.V2.School": { "type": "object", "properties": { "schoolSector": { "enum": [ "Catholic", "Government", "Independent" ], "type": "string", "description": "Gets or Sets SchoolSector", "nullable": true }, "schoolType": { "enum": [ "Combined", "Primary", "Secondary", "Special" ], "type": "string", "description": "Gets or Sets SchoolType", "nullable": true }, "gender": { "enum": [ "Boys", "Girls", "CoEd" ], "type": "string", "description": "Gets or Sets Gender", "nullable": true }, "name": { "type": "string", "description": "Gets or Sets Name", "nullable": true }, "suburb": { "type": "string", "description": "Gets or Sets Suburb", "nullable": true }, "state": { "type": "string", "description": "Gets or Sets State", "nullable": true }, "postcode": { "type": "string", "description": "Gets or Sets Postcode", "nullable": true }, "centroid": { "type": "string", "description": "Gets or Sets Centroid", "nullable": true }, "profile": { "$ref": "#/components/schemas/Schools.V2.SchoolProfile" }, "catchments": { "type": "array", "items": { "$ref": "#/components/schemas/Schools.V2.SchoolCatchment" }, "description": "Gets or Sets Catchments", "nullable": true }, "domainId": { "type": "integer", "description": "Gets or Sets DomainId", "format": "int32", "nullable": true } }, "additionalProperties": false, "description": "School", "x-data-access-level-info": { "Basic": [ "DomainId", "Name", "Profile", "SchoolSector", "State", "SchoolType", "Suburb", "Postcode", "Centroid", "Gender" ], "Detailed": [ "DomainId", "Name", "Profile", "SchoolSector", "State", "SchoolType", "Suburb", "Postcode", "Centroid", "Gender" ], "Full": [ "DomainId", "Name", "Profile", "SchoolSector", "State", "SchoolType", "Suburb", "Postcode", "Centroid", "Gender", "Catchments" ] } }, "Schools.V2.SchoolWithDistance": { "type": "object", "properties": { "distance": { "type": "number", "description": "Gets or Sets Distance", "format": "double", "nullable": true }, "school": { "$ref": "#/components/schemas/Schools.V2.School" } }, "additionalProperties": false, "description": "SchoolWithDistance", "x-data-access-level-info": { "Basic": [ "*" ], "Detailed": [ "*" ], "Full": [ "*" ] } }, "SuburbSummaryAndHistorical": { "type": "object", "properties": { "header": { "type": "object", "properties": { "suburb": { "type": "string" }, "state": { "type": "string" }, "postcode": { "type": "string" }, "propertyCategory": { "type": "string" } } }, "series": { "type": "object", "properties": { "seriesInfo": { "type": "array", "items": { "type": "object", "properties": { "bedrooms": { "type": "integer" }, "year": { "type": "integer" }, "month": { "type": "integer" }, "values": { "type": "object", "properties": { "numberSold": { "type": "integer" }, "medianSoldPrice": { "type": "integer" }, "highestSoldPrice": { "type": "integer" }, "lowestSoldPrice": { "type": "integer" }, "numberSaleListing": { "type": "integer" }, "medianSaleListingPrice": { "type": "integer" }, "highestSaleListingPrice": { "type": "integer" }, "lowestSaleListingPrice": { "type": "integer" }, "daysOnMarket": { "type": "integer" }, "meanRentYield": { "type": "number", "format": "float" }, "numberRentListing": { "type": "integer" }, "medianRentListingPrice": { "type": "integer" }, "highestRentListingPrice": { "type": "integer" }, "lowestRentListingPrice": { "type": "integer" }, "lowestDiscount": { "type": "number", "format": "float" }, "medianDiscount": { "type": "number", "format": "float" }, "highestDiscount": { "type": "number", "format": "float" } } } } } } } } } }, "SuburbPerformance": { "type": "object", "properties": { "header": { "type": "object", "properties": { "suburb": { "type": "string" }, "state": { "type": "string" }, "propertyCategory": { "type": "string" } } }, "series": { "type": "object", "properties": { "seriesInfo": { "type": "array", "items": { "type": "object", "properties": { "year": { "type": "integer" }, "month": { "type": "integer" }, "values": { "type": "object", "properties": { "medianSoldPrice": { "type": "integer" }, "numberSold": { "type": "integer" }, "highestSoldPrice": { "type": "integer" }, "lowestSoldPrice": { "type": "integer" }, "5thPercentileSoldPrice": { "type": "integer" }, "25thPercentileSoldPrice": { "type": "integer" }, "75thPercentileSoldPrice": { "type": "integer" }, "95thPercentileSoldPrice": { "type": "integer" }, "medianSaleListingPrice": { "type": "integer" }, "numberSaleListing": { "type": "integer" }, "highestSaleListingPrice": { "type": "integer" }, "lowestSaleListingPrice": { "type": "integer" }, "auctionNumberAuctioned": { "type": "integer" }, "auctionNumberSold": { "type": "integer" }, "auctionNumberWithdrawn": { "type": "integer" }, "daysOnMarket": { "type": "integer" }, "discountPercentage": { "type": "number", "format": "float" }, "medianRentListingPrice": { "type": "integer" }, "numberRentListing": { "type": "integer" }, "highestRentListingPrice": { "type": "integer" }, "lowestRentListingPrice": { "type": "integer" }, "meanRentYield": { "type": "number", "format": "float" } } } } } } } } } }, "Webhooks.v1.WebhookSubscription": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "createdBy": { "type": "string", "description": "Gets or Sets CreatedBy", "nullable": true }, "created": { "type": "string", "description": "Gets or Sets Created", "format": "date-time", "nullable": true }, "updatedBy": { "type": "string", "description": "Gets or Sets UpdatedBy", "nullable": true }, "updated": { "type": "string", "description": "Gets or Sets Updated", "format": "date-time", "nullable": true }, "deletedBy": { "type": "string", "description": "Gets or Sets DeletedBy", "nullable": true }, "deleted": { "type": "string", "description": "Gets or Sets Deleted", "format": "date-time", "nullable": true }, "subscriptionId": { "type": "string", "description": "Gets or Sets SubscriptionId", "nullable": true }, "subscriberId": { "type": "string", "description": "Gets or Sets SubscriberId", "nullable": true }, "ownerType": { "type": "string", "description": "Gets or Sets OwnerType", "nullable": true }, "ownerId": { "type": "string", "description": "Gets or Sets OwnerId", "nullable": true }, "resourceType": { "type": "string", "description": "Gets or Sets ResourceType", "nullable": true } }, "additionalProperties": false, "x-data-access-level-info": { "Basic": [ "*" ], "Detailed": [ "*" ], "Full": [ "*" ] } }, "Webhooks.v1.AddSubscriptionRequest": { "required": [ "ownerId", "ownerType", "resourceType" ], "type": "object", "properties": { "resourceType": { "minLength": 1, "type": "string", "description": "Gets or Sets ResourceType" }, "ownerType": { "minLength": 1, "type": "string", "description": "Gets or Sets OwnerType" }, "ownerId": { "minLength": 1, "type": "string", "description": "Gets or Sets OwnerId" } }, "additionalProperties": false, "description": "AddSubscriptionRequest", "x-data-access-level-info": { "Basic": [ "*" ], "Detailed": [ "*" ], "Full": [ "*" ] } } }, "securitySchemes": { "apikey": { "type": "apiKey", "description": "API Key in Header", "name": "x-api-key", "in": "header" }, "oauth2": { "type": "oauth2", "description": "OAuth 2", "flows": { "clientCredentials": { "tokenUrl": "https://auth.domain.com.au/v1/connect/token", "scopes": { "api_addresslocators_read": "api_addresslocators_read", "api_agencies_read": "api_agencies_read", "api_agencies_write": "api_agencies_write", "api_authorities_write": "api_authorities_write", "api_avm_read": "api_avm_read", "api_campaignperformance_read": "api_campaignperformance_read", "api_dataset_read": "api_dataset_read", "api_demographics_read": "api_demographics_read", "api_enquiries_read": "api_enquiries_read", "api_enquiries_write": "api_enquiries_write", "api_listingperformance_read": "api_listingperformance_read", "api_listings_read": "api_listings_read", "api_listings_write": "api_listings_write", "api_locations_read": "api_locations_read", "api_projectperformance_read": "api_projectperformance_read", "api_properties_read": "api_properties_read", "api_propertyportfolio_read": "api_propertyportfolio_read", "api_propertyportfolio_write": "api_propertyportfolio_write", "api_propertyreports_read": "api_propertyreports_read", "api_salesresults_read": "api_salesresults_read", "api_statistics_write": "api_statistics_write", "api_suburbhistorical_read": "api_suburbhistorical_read", "api_suburbperformance_read": "api_suburbperformance_read", "api_suburbsummary_read": "api_suburbsummary_read", "api_webhooks_write": "api_webhooks_write" } }, "authorizationCode": { "authorizationUrl": "https://auth.domain.com.au/v1/connect/authorize", "tokenUrl": "https://auth.domain.com.au/v1/connect/token", "refreshUrl": "https://auth.domain.com.au/v1/connect/token", "scopes": { "api_addresslocators_read": "api_addresslocators_read", "api_agencies_read": "api_agencies_read", "api_agencies_write": "api_agencies_write", "api_authorities_write": "api_authorities_write", "api_avm_read": "api_avm_read", "api_campaignperformance_read": "api_campaignperformance_read", "api_dataset_read": "api_dataset_read", "api_demographics_read": "api_demographics_read", "api_enquiries_read": "api_enquiries_read", "api_enquiries_write": "api_enquiries_write", "api_listingperformance_read": "api_listingperformance_read", "api_listings_read": "api_listings_read", "api_listings_write": "api_listings_write", "api_locations_read": "api_locations_read", "api_projectperformance_read": "api_projectperformance_read", "api_properties_read": "api_properties_read", "api_propertyportfolio_read": "api_propertyportfolio_read", "api_propertyportfolio_write": "api_propertyportfolio_write", "api_propertyreports_read": "api_propertyreports_read", "api_salesresults_read": "api_salesresults_read", "api_statistics_write": "api_statistics_write", "api_suburbhistorical_read": "api_suburbhistorical_read", "api_suburbperformance_read": "api_suburbperformance_read", "api_suburbsummary_read": "api_suburbsummary_read", "api_webhooks_write": "api_webhooks_write" } } } } } } }