IVSWikiBlue: Created page with "This API call will return a list of all templates for the VALT instance. ===Resource URL===

http://valt.example.com/api/v3/admin/templates

===Resource Informatio..."

2020-04-14T19:26:39Z

Created page with "This API call will return a list of all templates for the VALT instance. ===Resource URL=== <pre>http://valt.example.com/api/v3/admin/templates</pre> ===Resource Informatio..."

New page

This API call will return a list of all templates for the VALT instance.

===Resource URL===
<pre>http://valt.example.com/api/v3/admin/templates</pre>

===Resource Information===
{|class="wikitable"
|'''Method'''
|GET
|-
|'''Response Type'''
|JSON
|-
|'''Authentication Required'''
|Yes
|}

===Parameters===

No parameters can be passed to this call.

===Response===

{|class="wikitable"
!Code
!Reason
|-
|200
|Request Successful
|-
|401
|Unauthorized
|}

{|class="wikitable"
|+JSON Response
!colspan="4"|data
|-
|colspan="3"|
|This API returns an array of JSON objects
|-
|
|colspan="2"|'''id'''
|Template ID Number
|-
|
|colspan="2"|'''name'''
|Template Name
|-
|
|colspan="2"|'''type'''
|Template Type (Information, Marker, Evaluation or Email)
|-
|
|colspan="2"|'''hidden'''
|True = Template is hidden from view, False = Template is visible in web gui.
|-
|
|colspan="2"|'''entity name'''
|Default Field Name (Recording Name)
|-
|
|
|'''title'''
|Field name, if renamed.
|-
|
|
|'''value'''
|Default value, if specified.
|-
|
|
|'''type'''
|Type of Field (Text or Drop Down)
|}

==Examples==
===Request===
<pre>https://ivstest1.ad.ipivs.com/api/v3/admin/templates?access_token=e82632d19c523678fea3d1016c6df9e9</pre>

===Successful Response===
Sample response is shown with line breaks to make it more readable. Actual responses will not include line breaks.
<nowiki>
{
"data":[
{
"id": 1,
"name": "Basic Information",
"type": "info",
"hidden": false,
"entity_name":{
"title": "",
"value": "",
"type": "Text"
}
},
{
"id": 2,
"name": "Basic Marker",
"type": "marker",
"hidden": false,
"entity_name":{"title": "", "value": "", "type": "Text"}
},
{
"id": 3,
"name": "Law Enforcement Info",
"type": "info",
"hidden": false,
"entity_name":{"title": "", "value": "", "type": "Text"},
"fields":[{"id": 1, "on": true, "required": true, "type": "text",…]
},
{
"id": 4,
"name": "Law Enforcement Marker",
"type": "marker",
"hidden": false,
"entity_name":{"title": "", "value": "", "type": "Text"},
"fields":[{"id": 9, "on": true, "required": true, "type": "text",…]
},
{
"id": 5,
"name": "Speech Info",
"type": "info",
"hidden": false,
"entity_name":{"title": "", "value": "", "type": "Text"},
"fields":[{"id": 11, "on": true, "required": true, "type": "text",…]
}
]
}
</nowiki>

===Failure Response===
Sample response is shown with line breaks to make it more readable. Actual responses will not include line breaks.
<nowiki>
{
"error":{
"code": 401,
"message": "No API key provided"
}
}
</nowiki>

API List Templates - Revision history

IVSWikiBlue: Created page with "This API call will return a list of all templates for the VALT instance. ===Resource URL===
http://valt.example.com/api/v3/admin/templates
===Resource Informatio..."