API List Filters

This API provides a list of all current filters.

Resource URL

http://valt.example.com/api/v3/filters

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

JSON Response

data
	This call returns an array of JSON objects.
	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?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"
}
},
{
"id": 4,
"name": "Test",
"fields":[
{
"id": 7,
"name": "record",
"text": "Card Recording",
"field_id": "record"
},
{
"id": 8,
"name": "regular",
"text": null,
"field_id": null
}
],
"date":{
"type": "none"
}
}
]
}

Failure Response

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