IVSWikiBlue: Created page with "This API call will return the default information and marker templates for the VALT instance. This is typically the first information and marker template created. This will be..."

2020-04-14T19:26:18Z

Created page with "This API call will return the default information and marker templates for the VALT instance. This is typically the first information and marker template created. This will be..."

New page

This API call will return the default information and marker templates for the VALT instance. This is typically the first information and marker template created. This will be the information and marker template utilized for any new groups if one is not specified upon creation.

===Resource URL===
<pre>http://valt.example.com/api/v3/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"|'''info_template'''
|Default information template
|-
|
|colspan="2"|'''id'''
|Information Template ID Number
|-
|
|colspan="2"|'''name'''
|Information Template Name
|-
|
|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)
|-
|colspan="3"|'''marker_template'''
|Default marker template
|-
|
|colspan="2"|'''id'''
|Marker Template ID Number
|-
|
|colspan="2"|'''name'''
|Marker Template Name
|-
|
|colspan="2"|'''entity name'''
|Default Field Name (Marker 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/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":{
"info_template":{
"id": 1,
"name": "Basic Information",
"entity_name":{
"title": "",
"value": "",
"type": "Text"
}
},
"marker_template":{
"id": 2,
"name": "Basic Marker",
"entity_name":{
"title": "",
"value": "",
"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 Templates - Revision history

IVSWikiBlue: Created page with "This API call will return the default information and marker templates for the VALT instance. This is typically the first information and marker template created. This will be..."