Saved Searches: Provided

Provided Searches belong to an agent, but are provided to Portal users so they may view the results of the search.

  1. Supported Roles
  2. Available Services
    1. All Provided Searches
    2. Individual Provided Search
    3. All Contacts Provided a Search
  3. Provided Search Description
  4. Expansions
  5. API Explorer

Supported Roles

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

Available Services

All Provided Searches

URI: /<API Version>/provided/savedsearches

HTTP Method Description Conditional Notes
GET Returns all provided searches for the current VOW/Portal user No VOW and Portal roles only
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:
  • None

GET Response

See the GET request section for for the saved searches service.

Individual Provided Search

URI: /<API Version>/provided/savedsearches/<Id>

HTTP Method Description Conditional Notes
GET Returns an individual provided search No VOW and Portal roles only
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:
  • None

GET Response

See the GET request section for for the saved searches service.

All Contacts Provided a Search

URI: /<API Version>/savedsearches/<Id>/contacts

HTTP Method Description Conditional Notes
GET All contacts provided with a given search. See the ContactIds attribute for the Saved Searches service. No Private role only
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:
  • None

GET Response

See the GET request section for for the contacts service.

Provided Search Description

See the response description for Saved Searches.

Expansions

None.

API Explorer

The API Explorer does not currently support this service.