DOdomain
Authorities

full update an existing authority.

Changed on

Executes a full update on an existing authority.

put/v1/authorities/{id}

Request

  • Base URL
    https://api.domain.com.au
  • Auth
    • API key in header x-api-key
    • or OAuth 2
      Authorization codehttps://auth.domain.com.au/v1/connect/authorize
      Client credentials
      Token URLhttps://auth.domain.com.au/v1/connect/token
      Scopesapi_authorities_write
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Path parameters

idstring uuid required

Request body

idstring uuid required
bathroomsinteger required
bedroomsinteger required
parkinginteger required
propertyTypestring required

Available options are: ApartmentUnitFlat, House, Townhouse, VacantLand

createdstring date-time
modifiedstring date-time
statusstring

Available options are: draft, missing sign, executed

createdAtstring date-time
updatedAtstring date-time
administrationFeestring
agentDetailsDatestring date-time
auctionDatestring date-time
auctionTypestring
chattelsExcludedstring
chattelsIncludedstring[]
continuingPeriodnumber
espRangeHighernumber
espRangeLowernumber
exclusivePeriodnumber
exclusivePeriodStartDatestring date-time
exclusiveSoldAsstring nullable

Available options are: Private Sale, Expression of Interest with the reserve to be advised prior to closing date

isOwnersCorporationManagedboolean
isPropertyTenantedboolean
occupationStatestring nullable

Available options are: With vacant possession, Subject to any tenancy, Both

optOutInformationboolean
payableInstring[]
paymentMethodstring nullable

Available options are: Full purchase price, Payment of full deposit

paymentSumnumber
reservePricenumber
salePriceGstTypestring
saleSignPermissionboolean
searchCriteriaAmountnumber
searchCriteriaPriceTypestring

Available options are: amount, range, other

transactionTypestring
typestring required

Available options are: Exclusive Auction, Exclusive Sale, General Sale, Appraisal

vendorMktPriceNaboolean
waivedCoolingOffboolean
lotstring
planstring
titleReferencestring
certificateOfTitleTypestring

This field is unique to SA

certificateOfTitleFoliostring

This field is unique to SA

certificateOfTitleVolumestring

This field is unique to SA

improvedLandboolean

This field is unique to SA

Example request

{
  "id": "cf52bbf4-8d00-45e5-917a-8f27631a7da0",
  "address": {
    "country": "Australia",
    "number": "123123/45",
    "postcode": "2000",
    "state": "New South Wales",
    "street": "Sample St",
    "suburb": "Sydney"
  },
  "marketingCampaigns": [
    {
      "advertising": "3000.00",
      "campaignType": "Paper Based",
      "marketingCampaignItems": [
        {
          "finalPrice": "4000.00",
          "vendorPrice": "4000.00",
          "id": "0557934b-b9f8-4d88-bd5a-9c69d5bf0beb"
        }
      ],
      "comments": "{\"children\":[{\"children\":null,\"hidden\":false,\"hides_children\":false,\"placeholders\":null,\"remove_css_class\":null,\"selected\":false,\"tag_key\":null,\"text\":\"Written Request\",\"text_convertible\":true,\"type\":\"option_radio\"}],\"hidden\":false,\"placeholders\":null,\"required\":false,\"text\":null,\"text_convertible\":true,\"type\":\"group_radio\"}",
      "discountAmount": "1000.00",
      "discountPercent": "10.00",
      "expense": "Signing of this Authority",
      "other": "1000.00",
      "payableOn": "2016-10-22",
      "total": "4000.00",
      "realhubQuoteId": "1234567890",
      "id": "0557934b-b9f8-4d88-bd5a-9c69d5bf0beb"
    }
  ],
  "vendors": [
    {
      "id": "cf52bbf4-8d00-45e5-917a-8f27631a7da0",
      "contact": {
        "id": "cf52bbf4-8d00-45e5-917a-8f27631a7da0",
        "address": {
          "country": "Australia",
          "number": "123123/45",
          "postcode": "2000",
          "state": "New South Wales",
          "street": "Sample St",
          "suburb": "Sydney"
        },
        "dateOfBirth": "2022-07-16",
        "email": "johndoe@email.com",
        "firstName": "John",
        "lastName": "Smith",
        "middleName": "Doe",
        "mobile": "1234567890",
        "phoneNumber": "1234567890",
        "type": "individual"
      },
      "contactRepresented": {
        "id": "cf52bbf4-8d00-45e5-917a-8f27631a7da0",
        "address": {
          "country": "Australia",
          "number": "123123/45",
          "postcode": "2000",
          "state": "New South Wales",
          "street": "Sample St",
          "suburb": "Sydney"
        },
        "email": "johndoe@email.com",
        "name": "Company Name",
        "phoneNumber": "1234567890",
        "fax": "1234567890",
        "abn": "1234567890",
        "acn": "1234567890",
        "type": "company"
      },
      "nature": "Legal Representative",
      "order": 1,
      "authorityAttachments": [
        "ceb22e1d-419a-480f-a1df-ce53914acf5e"
      ]
    }
  ],
  "agents": [
    {
      "id": "cf52bbf4-8d00-45e5-917a-8f27631a7da0",
      "name": "John Doe",
      "email": "johndoe@email.com",
      "user": "cf52bbf4-8d00-45e5-917a-8f27631a7da0",
      "mobile": "0123456789",
      "officeNumber": "0123456789",
      "licenseNumber": "0123456789"
    }
  ],
  "bathrooms": 2,
  "bedrooms": 3,
  "parking": 1,
  "propertyType": "ApartmentUnitFlat",
  "created": "2016-10-22T09:29:24.8137700+11:00",
  "modified": "2016-10-22T09:29:24.8137700+11:00",
  "status": "executed",
  "createdAt": "2016-10-22T09:29:24.8137700+11:00",
  "updatedAt": "2016-10-22T09:29:24.8137700+11:00",
  "agentDetailsDate": "2016-08-29T09:12:33.0010000+00:00",
  "auctionDate": "2016-08-29T09:12:33.0010000+00:00",
  "auctionType": "Onsite",
  "chattelsExcluded": "Value",
  "chattelsIncluded": [
    "value"
  ],
  "continuingPeriod": 90,
  "espRangeHigher": 200000,
  "espRangeLower": 100000,
  "exclusivePeriod": 60,
  "exclusivePeriodStartDate": "2016-08-29T09:12:33.0010000+00:00",
  "exclusiveSoldAs": "Private Sale",
  "occupationState": "Both",
  "payableIn": [
    "30"
  ],
  "paymentMethod": "Payment of full deposit",
  "paymentSum": 100000,
  "reservePrice": 100000,
  "salePriceGstType": "l",
  "searchCriteriaAmount": 100000,
  "searchCriteriaPriceType": "amount",
  "transactionType": "AUTH",
  "type": "Exclusive Sale",
  "vendorMktPriceNa": true,
  "crmDetails": {
    "type": "D",
    "id": "1234567890"
  }
}

Response

authority updated

idstring uuid required
bathroomsinteger required
bedroomsinteger required
parkinginteger required
propertyTypestring required

Available options are: ApartmentUnitFlat, House, Townhouse, VacantLand

createdstring date-time
modifiedstring date-time
statusstring

Available options are: draft, missing sign, executed

createdAtstring date-time
updatedAtstring date-time
administrationFeestring
agentDetailsDatestring date-time
auctionDatestring date-time
auctionTypestring
chattelsExcludedstring
chattelsIncludedstring[]
continuingPeriodnumber
espRangeHighernumber
espRangeLowernumber
exclusivePeriodnumber
exclusivePeriodStartDatestring date-time
exclusiveSoldAsstring nullable

Available options are: Private Sale, Expression of Interest with the reserve to be advised prior to closing date

isOwnersCorporationManagedboolean
isPropertyTenantedboolean
occupationStatestring nullable

Available options are: With vacant possession, Subject to any tenancy, Both

optOutInformationboolean
payableInstring[]
paymentMethodstring nullable

Available options are: Full purchase price, Payment of full deposit

paymentSumnumber
reservePricenumber
salePriceGstTypestring
saleSignPermissionboolean
searchCriteriaAmountnumber
searchCriteriaPriceTypestring

Available options are: amount, range, other

transactionTypestring
typestring required

Available options are: Exclusive Auction, Exclusive Sale, General Sale, Appraisal

vendorMktPriceNaboolean
waivedCoolingOffboolean
lotstring
planstring
titleReferencestring
certificateOfTitleTypestring

This field is unique to SA

certificateOfTitleFoliostring

This field is unique to SA

certificateOfTitleVolumestring

This field is unique to SA

improvedLandboolean

This field is unique to SA

Example response

{
  "id": "cf52bbf4-8d00-45e5-917a-8f27631a7da0",
  "address": {
    "country": "Australia",
    "number": "123123/45",
    "postcode": "2000",
    "state": "New South Wales",
    "street": "Sample St",
    "suburb": "Sydney"
  },
  "marketingCampaigns": [
    {
      "advertising": "3000.00",
      "campaignType": "Paper Based",
      "marketingCampaignItems": [
        {
          "finalPrice": "4000.00",
          "vendorPrice": "4000.00",
          "id": "0557934b-b9f8-4d88-bd5a-9c69d5bf0beb"
        }
      ],
      "comments": "{\"children\":[{\"children\":null,\"hidden\":false,\"hides_children\":false,\"placeholders\":null,\"remove_css_class\":null,\"selected\":false,\"tag_key\":null,\"text\":\"Written Request\",\"text_convertible\":true,\"type\":\"option_radio\"}],\"hidden\":false,\"placeholders\":null,\"required\":false,\"text\":null,\"text_convertible\":true,\"type\":\"group_radio\"}",
      "discountAmount": "1000.00",
      "discountPercent": "10.00",
      "expense": "Signing of this Authority",
      "other": "1000.00",
      "payableOn": "2016-10-22",
      "total": "4000.00",
      "realhubQuoteId": "1234567890",
      "id": "0557934b-b9f8-4d88-bd5a-9c69d5bf0beb"
    }
  ],
  "vendors": [
    {
      "id": "cf52bbf4-8d00-45e5-917a-8f27631a7da0",
      "contact": {
        "id": "cf52bbf4-8d00-45e5-917a-8f27631a7da0",
        "address": {
          "country": "Australia",
          "number": "123123/45",
          "postcode": "2000",
          "state": "New South Wales",
          "street": "Sample St",
          "suburb": "Sydney"
        },
        "dateOfBirth": "2022-07-16",
        "email": "johndoe@email.com",
        "firstName": "John",
        "lastName": "Smith",
        "middleName": "Doe",
        "mobile": "1234567890",
        "phoneNumber": "1234567890",
        "type": "individual"
      },
      "contactRepresented": {
        "id": "cf52bbf4-8d00-45e5-917a-8f27631a7da0",
        "address": {
          "country": "Australia",
          "number": "123123/45",
          "postcode": "2000",
          "state": "New South Wales",
          "street": "Sample St",
          "suburb": "Sydney"
        },
        "email": "johndoe@email.com",
        "name": "Company Name",
        "phoneNumber": "1234567890",
        "fax": "1234567890",
        "abn": "1234567890",
        "acn": "1234567890",
        "type": "company"
      },
      "nature": "Legal Representative",
      "order": 1,
      "authorityAttachments": [
        "ceb22e1d-419a-480f-a1df-ce53914acf5e"
      ]
    }
  ],
  "agents": [
    {
      "id": "cf52bbf4-8d00-45e5-917a-8f27631a7da0",
      "name": "John Doe",
      "email": "johndoe@email.com",
      "user": "cf52bbf4-8d00-45e5-917a-8f27631a7da0",
      "mobile": "0123456789",
      "officeNumber": "0123456789",
      "licenseNumber": "0123456789"
    }
  ],
  "bathrooms": 2,
  "bedrooms": 3,
  "parking": 1,
  "propertyType": "ApartmentUnitFlat",
  "created": "2016-10-22T09:29:24.8137700+11:00",
  "modified": "2016-10-22T09:29:24.8137700+11:00",
  "status": "executed",
  "createdAt": "2016-10-22T09:29:24.8137700+11:00",
  "updatedAt": "2016-10-22T09:29:24.8137700+11:00",
  "agentDetailsDate": "2016-08-29T09:12:33.0010000+00:00",
  "auctionDate": "2016-08-29T09:12:33.0010000+00:00",
  "auctionType": "Onsite",
  "chattelsExcluded": "Value",
  "chattelsIncluded": [
    "value"
  ],
  "continuingPeriod": 90,
  "espRangeHigher": 200000,
  "espRangeLower": 100000,
  "exclusivePeriod": 60,
  "exclusivePeriodStartDate": "2016-08-29T09:12:33.0010000+00:00",
  "exclusiveSoldAs": "Private Sale",
  "occupationState": "Both",
  "payableIn": [
    "30"
  ],
  "paymentMethod": "Payment of full deposit",
  "paymentSum": 100000,
  "reservePrice": 100000,
  "salePriceGstType": "l",
  "searchCriteriaAmount": 100000,
  "searchCriteriaPriceType": "amount",
  "transactionType": "AUTH",
  "type": "Exclusive Sale",
  "vendorMktPriceNa": true,
  "crmDetails": {
    "type": "D",
    "id": "1234567890"
  }
}

Changes

  • eee76e147314Revision changes
    • breaking

      the request property ////// became required

    • breaking

      the request property ////// became required

    • warning

      removed the optional property ////// from the response with the status

    • warning

      removed the optional property ////// from the response with the status

    • info

      added the new optional request property ////

    • info

      added the new optional request property ////

    • info

      added the new optional request property ////

    • info

      added the new optional request property ////

    • info

      added the new optional request property ////

    • info

      added the new optional request property ////

    • info

      added the new optional request property ////

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      the response property ////// became required for the status

    • info

      the response property ////// became required for the status

  • 87cc19527acfRevision changes
    • breaking

      the response property ////// became optional for the status

    • breaking

      the response property ////// became optional for the status

    • warning

      removed the request property //////

    • warning

      removed the request property //////

    • warning

      removed the request property //

    • warning

      removed the request property //////

    • warning

      removed the request property //////

    • warning

      removed the optional property ////// from the response with the status

    • warning

      removed the optional property ////// from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property ////// from the response with the status

    • warning

      removed the optional property ////// from the response with the status

    • info

      added the new optional request property

    • info

      added the new optional request property ////

    • info

      added the new optional request property //////

    • info

      added the new optional request property //////

    • info

      added the new optional request property //

    • info

      the request property ////// became optional

    • info

      the request property ////// became optional

    • info

      added the optional property to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property // to the response with the status