Custom Fields: Groups

  1. Supported Roles
  2. Available Services
    1. Custom Field Groups
  3. Custom Fields: Groups Description
  4. Expansions
  5. API Explorer

Supported Roles

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

Available Services

Custom Field Groups

URI: /<API Version>/customfields/groups

URI: /<API Version>/mls/<MlsId>/customfields/groups

HTTP Method Description Conditional Notes
GET Returns all custom field groups for a given MLS No
POST Returns HTTP 405 (Method Not Allowed) No Not implemented
PUT Returns HTTP 405 (Method Not Allowed) No Not implemented
DELETE Returns HTTP 405 (Method Not Allowed) No Not implemented

GET Request

Parameters:
Parameter Required Notes
_mls No

GET Response

{
    "D": {
        "Success": true,
        "Results": [
            {
                "ListingInfo": {
                  "DefaultBooleanOperator": "And",
                  "Detail": false
                }
            }
        ]
    }
}

Custom Fields: Groups Description

Attribute Data Type Description
DefaultBooleanOperator Character Either And or Or. Specifies how fields in this group should be connected when searching listings.
Detail Boolean true if the group resides in the Details sub-attribute (as opposed to Main) in the CustomFields data for a listing.

Expansions

None.

API Explorer

Interact with this service using the API Explorer.