openapi: 3.2.0 info: title: Domain Group Listings API contact: name: Domain Developer Support email: api@domain.com.au termsOfService: https://developer.domain.com.au/docs/latest/support/terms version: '1.0' description: 'Operations tagged Listings across 3 of this provider''s published API definitions: domain-group-openapi-latest.json, domain-group-openapi-v1.json, domain-group-openapi-v2.json. Each path carries the servers of the definition it was published in.' servers: - url: https://api.domain.com.au/ description: Primary - url: https://api.domain.com.au/sandbox/ description: Sandbox tags: - name: Listings paths: /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 servers: - url: https://api.domain.com.au/ description: Primary - url: https://api.domain.com.au/sandbox/ description: Sandbox /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 servers: - url: https://api.domain.com.au/ description: Primary - url: https://api.domain.com.au/sandbox/ description: Sandbox /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 servers: - url: https://api.domain.com.au/ description: Primary - url: https://api.domain.com.au/sandbox/ description: Sandbox /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 servers: - url: https://api.domain.com.au/ description: Primary - url: https://api.domain.com.au/sandbox/ description: Sandbox /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 servers: - url: https://api.domain.com.au/ description: Primary - url: https://api.domain.com.au/sandbox/ description: Sandbox /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 servers: - url: https://api.domain.com.au/ description: Primary - url: https://api.domain.com.au/sandbox/ description: Sandbox /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 servers: - url: https://api.domain.com.au/ description: Primary - url: https://api.domain.com.au/sandbox/ description: Sandbox /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 servers: - url: https://api.domain.com.au/ description: Primary - url: https://api.domain.com.au/sandbox/ description: Sandbox /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 servers: - url: https://api.domain.com.au/ description: Primary - url: https://api.domain.com.au/sandbox/ description: Sandbox /v1/listings/locations: get: tags: - Listings summary: Suggests listing locations description: 'The resulting suggested location can be of type "suburb" / "area" / "region". The `name` property corresponds to the type of location returned. The 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 servers: - url: https://api.domain.com.au/ description: Primary - url: https://api.domain.com.au/sandbox/ description: Sandbox /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 servers: - url: https://api.domain.com.au/ description: Primary - url: https://api.domain.com.au/sandbox/ description: Sandbox /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 servers: - url: https://api.domain.com.au/ description: Primary - url: https://api.domain.com.au/sandbox/ description: Sandbox /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 servers: - url: https://api.domain.com.au/ description: Primary - url: https://api.domain.com.au/sandbox/ description: Sandbox /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. If 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 servers: - url: https://api.domain.com.au/ description: Primary - url: https://api.domain.com.au/sandbox/ description: Sandbox /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 servers: - url: https://api.domain.com.au/ description: Primary - url: https://api.domain.com.au/sandbox/ description: Sandbox /v1/listings/{id}/offmarket: post: tags: - Listings summary: Takes a listing offmarket operationId: Listings_UpdateOffmarketDetails parameters: - name: id in: path description: Listing identifier required: true schema: type: integer format: int32 requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/Domain.ListingAdminService.v1.Model.OffMarketDetails' text/json: schema: $ref: '#/components/schemas/Domain.ListingAdminService.v1.Model.OffMarketDetails' text/html: schema: $ref: '#/components/schemas/Domain.ListingAdminService.v1.Model.OffMarketDetails' application/xml: schema: $ref: '#/components/schemas/Domain.ListingAdminService.v1.Model.OffMarketDetails' text/xml: schema: $ref: '#/components/schemas/Domain.ListingAdminService.v1.Model.OffMarketDetails' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Domain.ListingAdminService.v1.Model.OffMarketDetails' required: true x-bodyName: offMarketDetails 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' deprecated: true security: - apikey: [] - oauth2: - api_listings_write x-domain-usercontextrequired: false x-domain-endpointcost: 1 x-domain-environment: Any servers: - url: https://api.domain.com.au/ description: Primary - url: https://api.domain.com.au/sandbox/ description: Sandbox /v1/listings/commercial: put: tags: - Listings summary: Creates or updates a commercial listing operationId: Listings_UpsertCommercialListing requestBody: description: The commercial listing content: application/json: schema: $ref: '#/components/schemas/Domain.ListingAdminService.v1.Model.CommercialListing' text/json: schema: $ref: '#/components/schemas/Domain.ListingAdminService.v1.Model.CommercialListing' text/html: schema: $ref: '#/components/schemas/Domain.ListingAdminService.v1.Model.CommercialListing' application/xml: schema: $ref: '#/components/schemas/Domain.ListingAdminService.v1.Model.CommercialListing' text/xml: schema: $ref: '#/components/schemas/Domain.ListingAdminService.v1.Model.CommercialListing' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Domain.ListingAdminService.v1.Model.CommercialListing' 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 servers: - url: https://api.domain.com.au/ description: Primary - url: https://api.domain.com.au/sandbox/ description: Sandbox /v1/listings/statistics: get: tags: - Listings summary: Retrieves stats for the residential listings of a given agent. operationId: Listings_GetListingStatisticsByAgentId parameters: - name: agentId in: query 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`' required: true schema: enum: - last7Days - last90Days - wholeCampaign type: string description: Defines StatisticsTimePeriod - name: statusFilter in: query description: Listing filter required: true schema: enum: - live - liveAndArchived type: string description: Which listings to filter based on status in lifecycle - 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' deprecated: true security: - apikey: [] - oauth2: - api_listings_read x-domain-endpointcost: 1 x-domain-usercontextrequired: true x-domain-environment: Primary servers: - url: https://api.domain.com.au/ description: Primary - url: https://api.domain.com.au/sandbox/ description: Sandbox components: schemas: 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 Listings.V1.Listing: required: - advertiserIdentifiers - id - propertyTypes type: object properties: objective: enum: - sale - rent type: - string - 'null' description: Gets or Sets Objective status: enum: - unknown - archived - underOffer - sold - leased - newDevelopment - recentlyUpdated - new - live - pending - depositTaken type: - string - 'null' description: Gets or Sets Status saleMode: enum: - buy - rent - share - sold - leased - archived type: - string - 'null' description: Gets or Sets SaleMode channel: enum: - residential - commercial - business type: - string - 'null' description: Gets or Sets Channel 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 - 'null' description: Total number of bathrooms in the property format: float bedrooms: type: - number - 'null' description: Total number of bedrooms in the property; Studio apartments have a value of \"0\" format: float buildingArea: type: - string - 'null' description: The building area display value of the property e.g. 160 ha buildingAreaSqm: type: - number - 'null' description: The properties building area in square meters format: double carspaces: type: - number - 'null' description: Total number of car spaces in the property. format: float dateAvailable: type: - string - 'null' description: The date the property is available. DateTime is in a local timezone. format: date-time dateCreated: type: - string - 'null' 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 dateUpdated: type: - string - 'null' 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 dateMinorUpdated: type: - string - 'null' 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 datePurged: type: - string - 'null' 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 dateListed: type: - string - 'null' description: The date/time last listed. DateTime is in AEST (Australian Eastern Standard Time) or AEDT (Australian Eastern Daylight Time) timezone. format: date-time description: type: - string - 'null' description: The long description of the property provided by the advertiser. devProjectId: type: - integer - 'null' description: The ID of the development project - null if no associated project format: int32 energyEfficiencyRating: type: - integer - 'null' description: Energy Efficiency Rating value for ACT properties format: int32 features: type: - array - 'null' items: type: string description: The property features specified by the advertiser geoLocation: $ref: '#/components/schemas/Listings.v1.GeoLocation' headline: type: - string - 'null' description: The short description of the property provided by the advertiser. inspectionDetails: $ref: '#/components/schemas/Listings.v1.PropertyInspections' isNewDevelopment: type: - boolean - 'null' description: Indicates whether the property is a new development landArea: type: - string - 'null' description: The land area display string for the property e.g. 160 sqm landAreaSqm: type: - number - 'null' description: The properties land area in square meters format: double media: type: - array - 'null' items: $ref: '#/components/schemas/Listings.v1.ListingMedia' description: The media associated with the property provided by the advertiser priceDetails: $ref: '#/components/schemas/Listings.V1.PriceDetails' propertyId: type: - string - 'null' description: The identifier which uniquely identifies the property being advertised. This may be empty if the Address of property is poorly described 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 - 'null' 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. seoUrl: type: - string - 'null' description: Listing SEO URL virtualTourUrl: type: - string - 'null' description: The Listing's Virtual Tour URL. homepassEnabled: type: - boolean - 'null' description: If Homepass is enabled for the listing (agency) statementOfInformation: $ref: '#/components/schemas/Listings.v1.StatementOfInformation' numberOfDwellings: type: - integer - 'null' description: Number of dwellings for current listing format: int32 highlights: type: - array - 'null' items: type: string description: Highlight items for the listing 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 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. \nThis rating is measured in increments of .5 and can range from 0 to 6. \nThe NABERS rating is required for spaces within office buildings of 1000 square metres or more.\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. Mandatory when updating a listing that belongs to an agency that is 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.
This value is used to identify an Advertisement for updates and should be unique for listing provider.
This 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. 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: maxLength: 6000 minLength: 0 type: string description: 'Description of the property. 6000 characters in length. The following HTML elements are permitted: <br />, <p></p>, &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: 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. 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 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 *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: 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 Enquiries.V1.Recipient: required: - address type: object properties: recipientType: enum: - primary - secondary - hidden type: - string - 'null' description: Gets or Sets RecipientType 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: - '*' 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 The only difference to normal contacts is agent contacts needs to have their agency specified' 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.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 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 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.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.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.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.DomainSearchWebApiV2ModelsCircle: type: object properties: center: $ref: '#/components/schemas/Domain.SearchService.v2.Model.DomainSearchWebApiV2ModelsGeoPoint' radiusInMeters: type: integer format: int32 Domain.SearchService.v2.Model.DomainSearchContractsV2Contact: type: object properties: name: type: string photoUrl: type: string 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 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.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.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. Supported image file formats: AVIF, BMP, GIF, HEIF/HEIC, JPEG, JPEG 2000, PNG, TIFF, WebP. The file size is restricted to maximum 100MB. We recommend against using transparent backgrounds. Some 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. By 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 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.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 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 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 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
''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. Supported image file formats: AVIF, BMP, GIF, HEIF/HEIC, JPEG, JPEG 2000, PNG, TIFF, WebP. The file size is restricted to maximum 100MB. We recommend against using transparent backgrounds. Some 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. By 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 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.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 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. Supported image file formats: AVIF, BMP, GIF, HEIF/HEIC, JPEG, JPEG 2000, PNG, TIFF, WebP. The file size is restricted to maximum 100MB. We recommend against using transparent backgrounds. Some 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. By 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 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.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.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.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.SearchService.v2.Model.DomainSearchContractsV2Inspection: type: object properties: openingTime: type: string format: date-time closingTime: type: string format: date-time 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 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 - 'null' description: Link to the statement of information documentation file additionalProperties: false description: Statement of Information Regarding sale listing x-data-access-level-info: Basic: - '*' Detailed: - '*' Full: - '*' 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.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.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 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 Listings.V1.RentalDetails: type: object properties: rentalMethod: enum: - notStated - rent - share - holiday - lease type: - string - 'null' description: Gets or Sets RentalMethod source: enum: - internal - external type: - string - 'null' description: Gets or Sets Source leasedDate: type: - string - 'null' description: The Date the listing was leased. DateTime is in a local timezone. format: date-time leasedPrice: type: - integer - 'null' 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 canDisplayPrice: type: - boolean - 'null' description: Indicates whether this instance can display price leasedMonths: type: - integer - 'null' description: The number of months the property was last leased for This will only be visible if the property has been leased format: int32 termOfLeaseFrom: type: - integer - 'null' description: Lease term range from format: int32 termOfLeaseTo: type: - integer - 'null' description: Lease term range to format: int32 leaseOutgoings: type: - integer - 'null' description: Outgoing cost of current lease format: int32 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.BasicPrice: type: object properties: from: type: - integer - 'null' description: Lowest price the property is expected to sell/rent for to set search price. format: int32 to: type: - integer - 'null' description: Highest price the property is expected to sell/rent for to set search price. format: int32 additionalProperties: false description: Basic price information x-data-access-level-info: Basic: - '*' Detailed: - '*' Full: - '*' 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 Listings.v1.ComparableData: type: object properties: comparableProperty: type: - array - 'null' items: $ref: '#/components/schemas/Listings.v1.PastSaleData' description: Comparable properties that are of a similar standard or condition to the property for sale declarationText: type: - string - 'null' description: Text description if there are less than three comparable sales available 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.AuctionDetails: type: object properties: auctionSchedule: $ref: '#/components/schemas/Listings.v1.AuctionSchedule' auctionedPrice: type: - integer - 'null' 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 auctionedDate: type: - string - 'null' 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 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: - '*' 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.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 Listings.v1.Inspection: type: object properties: recurrence: enum: - none - weekly type: - string - 'null' description: Gets or Sets Recurrence openingDateTime: type: - string - 'null' 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 closingDateTime: type: - string - 'null' 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 description: type: - string - 'null' 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 additionalProperties: false description: Encapsulates the details of a Listing's Inspection x-data-access-level-info: Basic: - '*' Detailed: - '*' Full: - '*' Listings.V1.AddressParts: type: object properties: stateAbbreviation: enum: - nsw - vic - sa - nt - tas - act - qld - wa type: - string - 'null' description: Gets or Sets StateAbbreviation displayType: enum: - fullAddress - streetAndSuburb - suburbOnly - regionOnly - areaOnly - stateOnly type: - string - 'null' description: Gets or Sets DisplayType streetNumber: type: - string - 'null' description: Street number unitNumber: type: - string - 'null' description: Unit number. street: type: - string - 'null' description: Street address suburb: type: - string - 'null' description: Suburb of the address suburbId: type: - integer - 'null' description: Domain suburb identifier for address lookup via the domain location api format: int32 postcode: type: - string - 'null' description: Postcode of the address displayAddress: type: - string - 'null' description: Advertiser's preference in displaying their listing's address 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 Domain.SearchService.v2.Model.DomainSearchContractsV2AuctionSchedule: type: object properties: time: type: string format: date-time auctionLocation: type: string Enquiries.V1.RecipientDeliveryStatus: type: object properties: deliveryStatus: enum: - queued - delivered - failed - deferred type: - string - 'null' description: Gets or Sets DeliveryStatus recipient: $ref: '#/components/schemas/Enquiries.V1.Recipient' date: type: - string - 'null' description: Last time when the email delivery status was polled format: date-time additionalProperties: false description: Used for reporting enquiry delivery statusses to recipients x-data-access-level-info: Basic: - '*' Detailed: - '*' Full: - '*' 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: - '*' 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 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 Listings.v1.AdvertiserIdentifiers: type: object properties: advertiserType: enum: - agency - private type: - string - 'null' description: Gets or Sets AdvertiserType advertiserId: type: - integer - 'null' description: Advertiser's identifier format: int32 contactIds: type: - array - 'null' items: type: integer format: int32 description: Identifier of each contact the advertiser has associated with the listing agentIds: type: - array - 'null' items: type: string description: Identifier of each agent the advertiser has associated with the listing conjunctionContactIds: type: - array - 'null' items: type: integer format: int32 description: Identifier of each conjunctional contact associated with the listing conjunctionAgentIds: type: - array - 'null' items: type: string description: Identifier of each conjunctional agent associated with the listing additionalProperties: false description: Encapsulates the listing's advertiser identifiers x-data-access-level-info: Basic: - '*' Detailed: - '*' Full: - '*' 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. \nThis rating is measured in increments of .5 and can range from 0 to 6. \nThe NABERS rating is required for spaces within office buildings of 1000 square metres or more.\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.
This value is used to identify an Advertisement for updates and should be unique for listing provider.
This value is case-insensitive (meaning AAAA will update aaaa).' description: maxLength: 6000 minLength: 0 type: string description: 'Description of the property. 6000 characters in length. The following HTML elements are permitted: <br />, <p></p>, &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: 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. 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.' 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 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 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.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.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.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: - '*' 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.
This value is used to identify an Advertisement for updates and should be unique for listing provider.
This value is case-insensitive (meaning AAAA will update aaaa).' description: maxLength: 6000 minLength: 0 type: string description: 'Description of the property. 6000 characters in length. The following HTML elements are permitted: <br />, <p></p>, &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: 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. 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.' 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 Listings.v1.PropertyInspections: type: object properties: inspections: type: - array - 'null' items: $ref: '#/components/schemas/Listings.v1.Inspection' description: Inspection details for the property. e.g. opening and closing times pastInspections: type: - array - 'null' items: $ref: '#/components/schemas/Listings.v1.Inspection' description: Inspection details for the property. e.g. opening and closing times isByAppointmentOnly: type: - boolean - 'null' description: True or False indicating whether the inspection is by appointment only additionalProperties: false description: Property Inspection(s) details x-data-access-level-info: Basic: - '*' Detailed: - '*' Full: - '*' 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.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.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.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 Listings.v1.AuctionSchedule: type: object properties: locationDescription: type: - string - 'null' description: Description and location of the auction provided by advertiser openingDateTime: type: - string - 'null' description: Opening date and time of the auction. e.g. 2015-01-01T12:00:00 DateTime is in a local timezone. format: date-time terms: type: - string - 'null' description: Terms of the auction url: maxLength: 255 type: - string - 'null' description: On-line URL of the auction additionalProperties: false description: Encapsulates the details of a Property being Auctioned. x-data-access-level-info: Basic: - '*' Detailed: - '*' Full: - '*' 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 ListingPerformance.v1.StatisticReport: type: object properties: summary: $ref: '#/components/schemas/ListingPerformance.v1.Statistics' dailyBreakdown: type: - array - 'null' items: $ref: '#/components/schemas/ListingPerformance.v1.DailyStatistics' description: Listing statistic breakdown for the period additionalProperties: false description: Statistics report for single listing x-data-access-level-info: Basic: - '*' Detailed: - '*' Full: - '*' 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 Enquiries.V1.Sender: type: object properties: firstName: type: - string - 'null' lastName: type: - string - 'null' email: type: - string - 'null' phoneNumber: type: - string - 'null' postcode: type: - string - 'null' additionalProperties: false x-data-access-level-info: Basic: - '*' Detailed: - '*' Full: - '*' ListingPerformance.v1.DailyStatistics: type: object properties: listingId: type: - integer - 'null' description: Domain Advertisement Id format: int64 readOnly: true totalListingViews: type: - integer - 'null' description: Total number of views for the listing details format: int32 readOnly: true totalPhotoViews: type: - integer - 'null' description: Total number of listing photo views format: int32 readOnly: true totalPhotoGalleryViews: type: - integer - 'null' description: Total number of listing photo gallery views format: int32 readOnly: true totalFloorplanViews: type: - integer - 'null' description: Total number of floorplan views format: int32 readOnly: true totalMapViews: type: - integer - 'null' description: Total number of address map views format: int32 readOnly: true totalVideoViews: type: - integer - 'null' description: Total number of vedio views format: int32 readOnly: true totalEbrochureViews: type: - integer - 'null' description: Total number of Ebrochure views format: int32 readOnly: true totalAgentDetailViews: type: - integer - 'null' description: Total number of agent detail views format: int32 readOnly: true totalShortlisted: type: - integer - 'null' description: Total number of times the listing was shortlisted format: int32 readOnly: true totalPrinted: type: - integer - 'null' description: Total number of time the listing detail was printed format: int32 readOnly: true totalAgentPhoneNumberReveals: type: - integer - 'null' description: Total number of times the agent phone number was revealed for contact format: int32 readOnly: true totalEnquiries: type: - integer - 'null' description: Total number of enquiries format: int32 readOnly: true totalEmailToFriend: type: - integer - 'null' description: Total number of times the listing link was emailed format: int32 readOnly: true totalSharedViaSocialMedia: type: - integer - 'null' description: Total number of shares via social media format: int32 readOnly: true totalInspectionTimeSaving: type: - integer - 'null' description: Total numnber of times when the inspection was saved to calendar format: int32 readOnly: true totalCallToAgentFromMobile: type: - integer - 'null' description: Total number of calls made to agent from inside the listing format: int32 readOnly: true percentageWebsiteViews: type: - number - 'null' description: Percentage of total views from website format: double readOnly: true percentageMobileSiteViews: type: - number - 'null' description: Percentage of total views from mobile site format: double readOnly: true percentageSmartPhoneViews: type: - number - 'null' description: Percentage of total views from smart phone apps format: double readOnly: true percentageTabletViews: type: - number - 'null' description: Percentage of total views from tablets format: double readOnly: true eventDate: type: - string - 'null' description: Date of statistics events format: date-time additionalProperties: false x-data-access-level-info: Basic: - '*' Detailed: - '*' Full: - '*' 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: - '*' 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.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.SearchService.v2.Model.DomainSearchWebApiV2ModelsCustomSort: type: object properties: elements: type: array items: $ref: '#/components/schemas/Domain.SearchService.v2.Model.DomainSearchWebApiV2ModelsCustomSortElement' boostPrimarySuburbs: type: boolean 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. \nFor a fixed price, set this value the same as From" format: int32 description: Commercial component for price 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.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.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.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.SearchService.v2.Model.DomainSearchWebApiV2ModelsTagQuery: type: object properties: criteria: enum: - Include - Exclude type: string tag: type: string 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: - '*' Listings.V1.AustralianPropertyMonitorsIdentifiers: type: object properties: addressId: type: - integer - 'null' description: APM address identifier format: int32 streetId: type: - integer - 'null' description: APM street identifier format: int32 suburbId: type: - integer - 'null' description: APM suburb identifier format: int32 cadastreId: type: - integer - 'null' description: APM cadastre identifier format: int64 postcodeId: type: - integer - 'null' description: APM postcode identifier format: int32 stateId: type: - integer - 'null' description: State identifier format: int32 state: type: - string - 'null' description: APM State propertyTypeId: type: - integer - 'null' description: APM property type identifier format: int32 propertyTypeCategoryId: type: - integer - 'null' description: APM property category type identifier format: int32 streetNumber: type: - string - 'null' description: APM washed and standardized address component for the street number, (including any prefixes, suffixed and composite numbers e.g. \"2-4a\") additionalProperties: false description: APM Identifiers x-data-access-level-info: Basic: [] Detailed: - SuburbId Full: - SuburbId - AddressId - CadastreId - PostcodeId - PropertyTypeCategoryId - PropertyTypeId - State - StateId - StreetId - StreetNumber Domain.SearchService.v2.Model.DomainSearchWebApiV2ModelsGeoPoint: type: object properties: lat: type: number format: double lon: type: number format: double 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.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.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.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 Listings.V1.SoldDetails: type: object properties: soldAction: enum: - notStated - auction - privateTreaty - withdrawn - soldPriorToAuction type: - string - 'null' description: Gets or Sets SoldAction source: enum: - internal - external type: - string - 'null' description: Gets or Sets Source soldPrice: type: - integer - 'null' 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 governmentRecordedSoldPrice: type: - integer - 'null' description: The government recorded sold price sourced from APM format: int32 soldDate: type: - string - 'null' description: The Date the listing was sold. DateTime is in a local timezone. format: date-time canDisplayPrice: type: - boolean - 'null' description: Indicates whether this instance can display price 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 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.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 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 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 Listings.v1.ProviderDetails: type: object properties: providerSystem: type: - string - 'null' description: Feed provider ID providerAdID: type: - string - 'null' description: Unique ID within provider system additionalProperties: false description: Information for the listing provider. e.g. bulkuploader information x-data-access-level-info: Basic: - '*' Detailed: - '*' Full: - '*' 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.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.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 ListingAdmin.v2.ListingResponse: type: object properties: id: type: string description: "The listing job Id. \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. 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 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.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 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.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.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.SearchService.v2.Model.DomainSearchContractsV2Media: type: object properties: category: enum: - Image type: string url: 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' Listings.V1.SaleDetails: type: object properties: saleMethod: enum: - notStated - auction - privateTreaty - tender - expressionOfInterest type: - string - 'null' description: Gets or Sets SaleMethod 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 - 'null' description: Integer value of percentage return on this property or business format: int32 saleTerms: type: - string - 'null' description: Information relating to aspects of the sale, such as required deposit, settlement time 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: - '*' 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. Supported image file formats: AVIF, BMP, GIF, HEIF/HEIC, JPEG, JPEG 2000, PNG, TIFF, WebP. The file size is restricted to maximum 100MB. We recommend against using transparent backgrounds. Some 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. By 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 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 Listings.v1.ListingMedia: required: - url type: object properties: category: enum: - image - video - others type: - string - 'null' description: Gets or Sets Category type: enum: - photo - mp4 - youtube - floorplan - vimeo - notSpecified type: - string - 'null' description: Gets or Sets Type 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: - '*' ListingPerformance.v1.Statistics: type: object properties: listingId: type: - integer - 'null' description: Domain Advertisement Id format: int64 readOnly: true totalListingViews: type: - integer - 'null' description: Total number of views for the listing details format: int32 readOnly: true totalPhotoViews: type: - integer - 'null' description: Total number of listing photo views format: int32 readOnly: true totalPhotoGalleryViews: type: - integer - 'null' description: Total number of listing photo gallery views format: int32 readOnly: true totalFloorplanViews: type: - integer - 'null' description: Total number of floorplan views format: int32 readOnly: true totalMapViews: type: - integer - 'null' description: Total number of address map views format: int32 readOnly: true totalVideoViews: type: - integer - 'null' description: Total number of vedio views format: int32 readOnly: true totalEbrochureViews: type: - integer - 'null' description: Total number of Ebrochure views format: int32 readOnly: true totalAgentDetailViews: type: - integer - 'null' description: Total number of agent detail views format: int32 readOnly: true totalShortlisted: type: - integer - 'null' description: Total number of times the listing was shortlisted format: int32 readOnly: true totalPrinted: type: - integer - 'null' description: Total number of time the listing detail was printed format: int32 readOnly: true totalAgentPhoneNumberReveals: type: - integer - 'null' description: Total number of times the agent phone number was revealed for contact format: int32 readOnly: true totalEnquiries: type: - integer - 'null' description: Total number of enquiries format: int32 readOnly: true totalEmailToFriend: type: - integer - 'null' description: Total number of times the listing link was emailed format: int32 readOnly: true totalSharedViaSocialMedia: type: - integer - 'null' description: Total number of shares via social media format: int32 readOnly: true totalInspectionTimeSaving: type: - integer - 'null' description: Total numnber of times when the inspection was saved to calendar format: int32 readOnly: true totalCallToAgentFromMobile: type: - integer - 'null' description: Total number of calls made to agent from inside the listing format: int32 readOnly: true percentageWebsiteViews: type: - number - 'null' description: Percentage of total views from website format: double readOnly: true percentageMobileSiteViews: type: - number - 'null' description: Percentage of total views from mobile site format: double readOnly: true percentageSmartPhoneViews: type: - number - 'null' description: Percentage of total views from smart phone apps format: double readOnly: true percentageTabletViews: type: - number - 'null' description: Percentage of total views from tablets format: double readOnly: true additionalProperties: false description: Listing statistics x-data-access-level-info: Basic: - '*' Detailed: - '*' Full: - '*' 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 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 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 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' 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 Listings.v1.TenderDetails: type: object properties: tenderRecipientName: type: - string - 'null' description: Tender recipient name tenderAddress: type: - string - 'null' description: Tender address tenderEndDate: type: - string - 'null' description: Tender closing date. DateTime is in a local timezone. format: date-time additionalProperties: false description: Tender details x-data-access-level-info: Basic: - '*' Detailed: - '*' Full: - '*' 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 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.
This value is used to identify an Advertisement for updates and should be unique for listing provider.
This value is case-insensitive (meaning AAAA will update aaaa).' description: maxLength: 6000 minLength: 0 type: string description: 'Description of the property. 6000 characters in length. The following HTML elements are permitted: <br />, <p></p>, &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: 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. 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.' 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 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.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 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.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.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 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 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 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) 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 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 Listings.v1.MedianPriceData: type: object properties: priceType: enum: - house - apartmentUnitFlat - vacantLand type: - string - 'null' description: Gets or Sets PriceType suburb: type: - string - 'null' description: Name of the suburb median price is based on. postcode: type: - string - 'null' description: Postcode of the suburb medianPrice: type: - integer - 'null' description: Median price for the suburb. format: int32 source: type: - string - 'null' description: Where median price data comes from sourceDateFrom: type: - string - 'null' description: Start date of the median price source time period sourceDateTo: type: - string - 'null' description: End date of the median price source time period sourceCollectionDate: type: - string - 'null' description: The collection date of the median price source additionalProperties: false description: Information regarding median house/unit price for the suburb x-data-access-level-info: Basic: - '*' Detailed: - '*' Full: - '*' ProblemDetails: type: object properties: type: type: - string - 'null' title: type: - string - 'null' status: type: - integer - 'null' format: int32 detail: type: - string - 'null' instance: type: - string - 'null' additionalProperties: {} x-data-access-level-info: Basic: - '*' Detailed: - '*' Full: - '*' Enquiries.V1.EnquiryReport: type: object properties: deliveryMethod: enum: - email - sms type: - string - 'null' enquiryType: enum: - listing - devProject - newDevLanding - agencyProfile - agentProfile - contractRequest - vendorEnquiry - prePortalListing - suburbVendorEnquiry type: - string - 'null' id: type: - string - 'null' message: type: - string - 'null' metaData: type: - object - 'null' additionalProperties: type: string x-data-access-level-info: Basic: - '*' Detailed: - '*' Full: - '*' recipientsDeliveryStatus: type: - array - 'null' items: $ref: '#/components/schemas/Enquiries.V1.RecipientDeliveryStatus' referenceId: type: - integer - 'null' format: int32 sender: $ref: '#/components/schemas/Enquiries.V1.Sender' dateReceived: type: - string - 'null' format: date-time agencyId: type: - integer - 'null' format: int32 additionalProperties: false x-data-access-level-info: Basic: - '*' Detailed: - '*' Full: - '*' 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 Listings.v1.TenantDetails: type: object properties: leaseDateVariable: type: - boolean - 'null' description: Is tenant lease date variable leaseOptions: type: - string - 'null' description: Leasing options available to a prospective tenant tenantInfoTermOfLeaseFrom: type: - integer - 'null' description: The from range of the tenant's current lease format: int32 tenantInfoTermOfLeaseTo: type: - integer - 'null' description: The to range of the tenant's current lease format: int32 tenantName: type: - string - 'null' description: Name of the current tenant of the property tenantRentDetails: type: - string - 'null' description: Information regarding current rental leaseStartDate: type: - string - 'null' description: The date on which the tenants lease began, or is due to begin. DateTime is in a local timezone. format: date-time leaseEndDate: type: - string - 'null' description: The date on which the tenants lease is due to end. DateTime is in a local timezone. format: date-time additionalProperties: false description: Tenant Details x-data-access-level-info: Basic: - '*' Detailed: - '*' Full: - '*' Domain.SearchService.v2.Model.DomainSearchWebApiV2ModelsSchoolCatchment: type: object properties: name: type: string state: type: string postcode: type: string 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 Listings.v1.PastSaleData: type: object properties: unitNumber: type: - string - 'null' description: Property unit number streetNumber: type: - string - 'null' description: Property street number street: type: - string - 'null' description: Property Street name suburb: type: - string - 'null' description: Property suburb name postcode: type: - string - 'null' description: Property postcode state: type: - string - 'null' description: Property state displayAddress: type: - string - 'null' description: display formatted address readOnly: true dateOfSale: type: - string - 'null' description: Registered date of the sale soldPrice: type: - integer - 'null' description: Property sold price format: int64 additionalProperties: false description: Information for past property sales x-data-access-level-info: Basic: - '*' Detailed: - '*' Full: - '*' 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.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' 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 Listings.V1.PriceDetails: type: object properties: gstOption: enum: - na - inc - ex type: - string - 'null' description: Gets or Sets GstOption priceType: enum: - gross - net type: - string - 'null' description: Gets or Sets PriceType priceUnit: enum: - totalAmount - perSqm type: - string - 'null' description: Gets or Sets PriceUnit price: type: - number - 'null' description: Price of the property format: double priceFrom: type: - integer - 'null' description: Price starting range of the property format: int32 priceTo: type: - integer - 'null' description: Upper price range of the property format: int32 pricePrefix: type: - string - 'null' description: Display price for the advertisement canDisplayPrice: type: - boolean - 'null' description: Flag indicating whether the advertiser has chosen to display the property price hiddenReasons: type: - array - 'null' 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 displayPrice: type: - string - 'null' 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 bond: type: - number - 'null' description: Rental bond format: double priceReduction: type: - boolean - 'null' description: Indicates if this property is under price reduction 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 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.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 Listings.v1.GeoLocation: type: object properties: latitude: type: - number - 'null' description: Latitude of the property format: double longitude: type: - number - 'null' description: Longitude of the property format: double additionalProperties: false description: Encapsulates the details of a geo location, long/lat x-data-access-level-info: Basic: - '*' Detailed: - '*' Full: - '*' 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 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.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.SearchService.v2.Model.DomainSearchWebApiV2ModelsPolygon: type: object properties: points: type: array items: $ref: '#/components/schemas/Domain.SearchService.v2.Model.DomainSearchWebApiV2ModelsGeoPoint' 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 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.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. \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 Domain.ListingAdminService.v1.Model.OffMarketDetails: type: object properties: listingAction: enum: - sale - rent type: string description: Sale or Rent. Optional if Domain Ad ID is provided. offMarketAction: enum: - withDrawn - sold - leased type: string description: Off Market Action listingProvider: type: string description: A string identifying the data provider domainAgencyID: type: integer description: Domain Agency ID. Optional if Domain Ad ID is provided. format: int32 providerAdId: type: string description: External Advertisement ID. Optional if Domain Ad ID is provided. actionDate: type: string description: The date property was sold, leased or withdrawn format: date-time soldDetails: $ref: '#/components/schemas/Domain.ListingAdminService.v1.Model.SoldDetails' leasedDetails: $ref: '#/components/schemas/Domain.ListingAdminService.v1.Model.LeasedDetails' comment: type: string description: Extra details for off market action description: Shows offmarket info Domain.ListingAdminService.v1.Model.SoldDetails: type: object properties: soldType: enum: - auction - privateTreaty - priorToAuction type: string description: Sold Type soldPrice: 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 Domain.ListingAdminService.v1.Model.Lease: type: object properties: termOfLeaseFrom: type: integer description: Integer value of lease term range from format: int32 termOfLeaseTo: type: integer description: Integer value of lease term range to format: int32 leaseOutgoings: type: integer description: Outgoing cost of current lease format: int32 description: Properties for lease listings Domain.ListingAdminService.v1.Model.CommercialListing: type: object properties: occupancyType: enum: - tenanted - vacant type: string description: Occupancy. Can be 'Tenanted', 'Vacant' 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. price: $ref: '#/components/schemas/Domain.ListingAdminService.v1.Model.CommercialPrice' lease: $ref: '#/components/schemas/Domain.ListingAdminService.v1.Model.Lease' eoi: $ref: '#/components/schemas/Domain.ListingAdminService.v1.Model.EOI' tenant: $ref: '#/components/schemas/Domain.ListingAdminService.v1.Model.Tenant' tender: $ref: '#/components/schemas/Domain.ListingAdminService.v1.Model.Tender' annualReturn: type: integer description: Integer value of percentage return on this property or business. format: int32 unitsOffered: type: integer description: Integer value of units offered for sale or lease format: int32 unitDetails: type: array items: $ref: '#/components/schemas/Domain.ListingAdminService.v1.Model.SpecificUnitDetail' description: Units details 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 saleTerms: 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/Domain.ListingAdminService.v1.Model.CommercialAuction' propertyDetails: $ref: '#/components/schemas/Domain.ListingAdminService.v1.Model.CommercialProperty' conjunctionAgents: type: array items: $ref: '#/components/schemas/Domain.ListingAdminService.v1.Model.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: 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: Commercial Listing V1 Domain.ListingAdminService.v1.Model.SpecificUnitDetail: type: object properties: occupancy: enum: - tenanted - vacant type: string description: Occupancy type priceUnit: enum: - totalAmount - perSqm type: string description: Price unit type name: type: string description: Unit number size: type: integer description: Unit size format: int32 price: type: number description: Unit price format: double notes: type: string description: Additional notes isSoldOrLeased: type: boolean description: Is it available? leasePriceForSaleorLease: type: number description: Lease price for sale or lease format: double description: offered units details Domain.ListingAdminService.v1.Model.EOI: type: object properties: address: type: string description: Street address, up to 100 characters endDate: type: string description: End date of EOI format: date-time recipientName: type: string description: The recipient name of the EOI, up to 50 characters description: Express of Interest Domain.ListingAdminService.v1.Model.CommercialProperty: 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/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' landArea: $ref: '#/components/schemas/Domain.ListingAdminService.v1.Model.LandArea' description: Commercial Property Domain.ListingAdminService.v1.Model.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: type: string description: Name of the current tenant of the property, up to 100 characters rentalDetails: type: string description: Information regarding current rental, up to 100 characters leaseOptions: type: string description: Leasing options available to a prospective tenant, up to 100 characters tenantInfoTermOfLeaseFrom: type: integer description: The from range of the tenant's current lease format: int32 tenantInfoTermOfLeaseTo: 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 Domain.ListingAdminService.v1.Model.LeasedDetails: type: object properties: leasedPrice: type: integer description: Optional. The weekly rental price. format: int32 leasedDuration: type: integer description: The duration of the lease in weeks. format: int32 description: Leased Details Domain.ListingAdminService.v1.Model.CommercialAuction: type: object properties: auctionTerms: 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: 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: Commercial Auction Details Domain.ListingAdminService.v1.Model.CommercialPrice: 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: 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: Commercial component for price Domain.ListingAdminService.v1.Model.AgentContact: 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 The only difference to normal contacts is agent contacts needs to have their agency specified Domain.ListingAdminService.v1.Model.Tender: type: object properties: recipientName: type: string description: The recipient name of the tender, up to 50 characters address: type: string description: Street address, up to 100 characters. endDate: type: string description: Closing Date format: date-time description: Tender Information 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 x-refined-from: - domain-group-openapi-latest.json - domain-group-openapi-v1.json - domain-group-openapi-v2.json