API Filter Template Information
This API provides a list of all possible metadata fields that can be utilized in filters.
Contents
Resource URL
http://valt.example.com/api/v3/filters/template_fields
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 |
data | ||
---|---|---|
fields | Array of JSON objects containing metadatafields. | |
id | Field ID | |
name | Field Name |
Examples
Request
https://ivstest1.ad.ipivs.com/api/v3/filters/template_fields?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":{ "fields":[ { "id": "information", "name": "Information" }, {"id": "record", "name": "Record Name"}, {"id": "Case Number", "name": 1}, {"id": "Charge", "name": 2}, {"id": "Subject", "name": 3}, {"id": "Subject Age", "name": 4}, {"id": "Subject Type", "name": 5}, {"id": "Interviewer 1", "name": 6}, {"id": "Interviewer 2", "name": 7}, {"id": "Case Notes", "name": 8}, {"id": "Client", "name": 11}, {"id": "Client Type", "name": 12}, {"id": "Supervisor", "name": 13}, {"id": "Student Clinician", "name": 14}, {"id": "Session", "name": 15}, {"id": "Format", "name": 16}, {"id": "Disorder", "name": 17}, {"id": "Primary Category", "name": 18}, {"id": "Specific Disorders ", "name": 19}, {"id": "RN#", "name": 23}, {"id": "Period", "name": 24}, {"id": "Shave Number", "name": 25}, {"id": "Study Type", "name": 26}, {"id": "Study Title", "name": 27}, {"id": "Requestor Name", "name": 28}, {"id": "Study Manager Name", "name": 29}, {"id": "Study Start", "name": 30}, {"id": "Study End", "name": 31}, {"id": "PC", "name": 32}, {"id": "Product Name", "name": 33}, {"id": "Product Description", "name": 34}, {"id": "PC2", "name": 35}, {"id": "PC2 Product Name", "name": 36}, {"id": "PC2 Product Description", "name": 37}, {"id": "Files", "name": 49}, {"id": "Note", "name": 50}, {"id": "Files", "name": 73}, {"id": "Note", "name": 74}, {"id": "Files", "name": 78}, {"id": "Note", "name": 79}, {"id": "Supervisor", "name": 80}, {"id": "Files", "name": 81}, {"id": "Note", "name": 82}, {"id": "Supervisor", "name": 83}, {"id": "Files", "name": 126}, {"id": "Note", "name": 127}, {"id": "Supervisor", "name": 128}, {"id": "Drop Down", "name": 146}, {"id": "Audio", "name": 147}, {"id": "Note", "name": 148}, {"id": "Quick Record", "name": 149}, {"id": "File", "name": 150}, {"id": "Multi", "name": 151}, {"id": "Text", "name": 152}, {"id": "Patients", "name": 158}, {"id": "marker", "name": "Marker"}, {"id": "event", "name": "Event"}, {"id": "Marker Name", "name": 9}, {"id": "Notes", "name": 10}, {"id": "Hand washing good", "name": 51}, {"id": "Hand Washing Bad", "name": 52}, {"id": "PPE Good", "name": 53}, {"id": "PPE Bad", "name": 54}, {"id": "Body Mechanics Good", "name": 55}, {"id": "Body Mechanics Bad", "name": 56}, {"id": "Saftey good", "name": 57}, {"id": "Saftey Bad", "name": 58}, {"id": "Communication Good", "name": 59}, {"id": "Communication Bad", "name": 60}, {"id": "Teamwork Good", "name": 61}, {"id": "Teamwork Bad", "name": 62}, {"id": "Medication Good", "name": 63}, {"id": "Medication Bad", "name": 64}, {"id": "Technique Good", "name": 65}, {"id": "Technique Bad", "name": 66}, {"id": "Note", "name": 67}, {"id": "Case Conceptualization", "name": 90}, {"id": "Treatment Planning", "name": 91}, {"id": "Collaborative Agenda and Goal Setting", "name": 92}, {"id": "Presentation/illustration of ACT/CBT (EBT) principle", "name": 93}, {"id": "Application of ACT/CBT (EBT) principle", "name": 94}, {"id": "Use of active learning strategy", "name": 95}, {"id": "Barrier to implementation", "name": 96}, {"id": "Use of personal example", "name": 97}, {"id": "Concern", "name": 98}, {"id": "Additional notes", "name": 99}, {"id": "Good job", "name": 133}, {"id": "Bad job", "name": 134}, {"id": "What's your name", "name": 135}, {"id": "How do you feel", "name": 136}, {"id": "What are your favorite Rush songs", "name": 137}, {"id": "Note", "name": 138}, {"id": "Good", "name": 139}, {"id": "Bad", "name": 140}, {"id": "Ugley", "name": 141}, {"id": "Note", "name": 142}, {"id": "John", "name": 143}, {"id": "Nathaniel", "name": 144}, {"id": "What up!", "name": 145}, {"id": "Drop Down", "name": 153}, {"id": "Audio", "name": 154}, {"id": "Note", "name": 155}, {"id": "Quick Marker", "name": 156}, {"id": "Multiselect", "name": 157} ] } }
Failure Response
{"error":{"code":401,"message":"No API key provided"}}