Listings: Listing Notes

The Listing Notes sub-service allows agents and contacts to share notes about a listing with one another.
  1. Supported Roles
  2. Available Services
    1. Listing Notes
    2. Listing Notes For All Contacts
    3. Listing Note For Specified Contact
  3. Response Description
  4. Expansions
  5. API Explorer

Supported Roles

Role Reads Writes
IDX Yes No
VOW Yes Yes
Private Yes Yes
More information about roles may be found here.

Available Services

Listing Notes

URI: /<API Version>/listings/<Listing.Id>/shared/notes

Note: this service is available only under a VOW session.
HTTP Method Description Notes
GET Retrieve agent/contact shared notes for a specified listing.
POST Returns HTTP 405 (Method Not Allowed) Not implemented
PUT Replace an existing shared note.
DELETE Deletes an existing shared note.

GET Request

Parameters:
  • None

GET Response

Example:
{
    "D": {
        "Success": true,
        "Results": [
            {
                "ResourceUri": "/v1/listings/20100815153524571646000000/shared/notes/contacts/20100912536192756362000000/",
                "Note": "Great home, wondering if seller is willing to include hot tub."
            }
        ]
    }
}

PUT Request

Request body:
{
    "D": {
        "Note": "Great home, wondering if seller is willing to include hot tub and washer/dryer."
    }
}

PUT Response

The standard success/fail response is returned.

DELETE Request

Parameters:
  • None

DELETE Response

The standard success/fail response is returned.

Listing Notes For All Contacts

URI: /<API Version>/listings/<Listing.Id>/shared/notes/contacts

Note: this service is available only under a Private session.
HTTP Method Description Notes
GET Retrieve agent/contact shared notes for all contacts regarding a specified listing.
POST Returns HTTP 405 (Method Not Allowed) Not implemented
PUT Returns HTTP 405 (Method Not Allowed) Not implemented
DELETE Returns HTTP 405 (Method Not Allowed) Not implemented

GET Request

Parameters:
  • None

GET Response

The GET response is identical to the GET response above.

Listing Note For Specified Contact

URI: /<API Version>/listings/<Listing.Id>/shared/notes/contacts/<Contact.Id>

Note: this service is available only under a Private session.
HTTP Method Description Notes
GET Retrieve agent/contact shared notes for a specified listing and contact.
POST Returns HTTP 405 (Method Not Allowed) Not implemented
PUT Replace an existing shared note for a specified contact.
DELETE Deletes an existing shared note for a specified contact.

GET Request

Parameters:
  • None

GET Response

The GET response is identical to the GET response above.

PUT Request

The PUT body is identical to the PUT body above.

PUT Response

The standard success/fail response is returned.

DELETE Request

Parameters:
  • None

DELETE Response

The standard success/fail response is returned.

Listing Note Description

Attribute Data Type Writeable Required Description
ResourceUri Character No No The resource URI to the note.
Note Character Yes Yes The listing note text.

Expansions

None.

API Explorer

The API Explorer does not currently support this service.