Saved Searches: Provided
Provided Searches belong to an agent, but are provided to Portal users so they may view the results of the search.
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
/<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
/<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
/<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.