Saved Searches: Tags
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
All Tags
/<API Version>/savedsearches/tags
| HTTP Method | Description | Conditional | Notes |
|---|---|---|---|
| GET | Returns all existing tags for Saved Searches | 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:
- None
GET Response
{
"D": {
"Success": true,
"Results": [
{
"ResourceUri": "/v1/savedsearches/tags/Favorites",
"Tag": "Favorites"
},
{
"ResourceUri": "/v1/savedsearches/tags/Recent",
"Tag": "Recent"
},
]
}
}
All Searches with Tag
/<API Version>/savedsearches/tags/<Tag>
| HTTP Method | Description | Conditional | Notes |
|---|---|---|---|
| GET | Returns all Saved Searches with a specified Tag. | No | See the expansions for the Saved Search resource. |
| 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 |
|---|---|---|
| Standard expansion parameters | No |
GET Response
See the GET request section for for the Saved Searches service.
Tags Description
Below are the supported tag Types.
| Type | Description |
|---|---|
Favorites |
One of the user's favorited searches. |
Recent |
The user's most recent search. The Saved Search with this tag
reflects the last search a user performed, and only one search may be tagged as such a time. The search
must not have any other tags associated with it. These searches will also be omitted from the all saved searches response response for VOW and portal roles. |
Expansions
None.
API Explorer
Interact with this service using the API Explorer.