API Filter Details

This API provides a details for a specified filter.

Resource URL

http://valt.example.com/api/v3/filters/{filterid}

Replace {filterid} with the actual id number of the filter. Filters are numbered sequentially when added to VALT.

Resource Information

Method	GET
Response Type	JSON
Authentication Required	Yes

Parameters

No parameters can be passed to this call.

Response

Code	Reason
200	Request Successful
401	Unauthorized
404	Filter ID Not Found

JSON Response

data
id				Filter ID
name				Filter Name
fields				Array of fields utilized in the filter.
	id			Field ID
	name			Field Name
	text			Filter search criteria for specified field
	field_id			? but definitely not the field ID
rooms				Rooms included in filter.
	id			Room ID
	name			Room Name
author				Users and Groups included in filter.
	users			User IDs
	user_groups			Group IDs
date				Time frame for filter.
	type			Date filter type (Valid Values: none, days, weeks, range)
	days			Number of days (only included if filter type is days)
	weeks			Number of weeks (only included if filter type is weeks)
	range			Date range for filter. (only included if filter type is range)
		start
			date	Filter start date
			timezone_type
			timezone	Timezone for specified date range
		end
			date	Filter end date.
			timezone_type
			timezone	Timezone for specified date range

Examples

Request

https://ivstest1.ad.ipivs.com/api/v3/filters/1?access_token=e82632d19c523678fea3d1016c6df9e9

Successful Response

Sample response is shown with line breaks to make it more readable. Actual responses will not include line breaks.

{
"data":{
"id": 1,
"name": "ddd",
"fields":[
{
"id": 1,
"name": "regular",
"text": null,
"field_id": null
}
],
"date":{
"type": "none"
}
}
}

Failure Response

{"error":{"code":401,"message":"No API key provided"}}