IVSWikiBlue at 17:00, 7 March 2025

2025-03-07T17:00:44Z

IVSWikiBlue at 17:00, 7 March 2025

2025-03-07T17:00:25Z

IVSWikiBlue: Created page with "This API call will update an existing field on an existing template. ===Resource URL===

http://valt.example.com/api/v3/admin/templates/{templateid}/fields/{fieldid}/edit..."

2020-04-14T19:36:06Z

Created page with "This API call will update an existing field on an existing template. ===Resource URL=== <pre>http://valt.example.com/api/v3/admin/templates/{templateid}/fields/{fieldid}/edit..."

New page

This API call will update an existing field on an existing template.

===Resource URL===
<pre>http://valt.example.com/api/v3/admin/templates/{templateid}/fields/{fieldid}/edit</pre>
''Replace {templateid} with the actual id number of the template. Templates are numbered sequentially when added to VALT.''

''Replace {fieldid} with the actual id number of the fields. Fields are numbered sequentially when added to VALT.''

===Resource Information===
{|class="wikitable"
|'''Method'''
|POST
|-
|'''Headers'''
|Content-Type:application/json
|-
|'''Response Type'''
|JSON
|-
|'''Authentication Required'''
|Yes
|}

===Parameters===
The JSON body must be properly formatted. All fields and values should be enclosed in double quotes and separated by a colon.
{|class="wikitable"
!Field Name
!Description
!Required
!Example
|-
|'''on'''
|Field is Enabled (True or False)
|no
|true
|-
|'''required'''
|Field is Required (True or False)
|no
|false
|-
|'''type'''
|Field Type ([[Template Field Types|Valid Values]])
|no
|text
|-
|'''name'''
|Field Name
|no
|Patient Name
|-
|'''data'''
|Default Field Value
|no
|Jane Doe
|}

===Response===

{|class="wikitable"
!Code
!Reason
|-
|200
|Template Created Successfully
|-
|400
|Invalid Request (See Response for Specific Error)
|-
|401
|Unauthorized
|-
|404
|Template Not Found
|-
|500
|JSON Body Formatted Incorrectly
|}

{|class="wikitable"
|+JSON Response
!colspan="2"|data
|-
|'''id'''
|Field ID
|-
|'''on'''
|Field is Enabled (True or False)
|-
|'''req'''
|Field is Required (True or False)
|-
|'''type'''
|Field Type ([[Template Field Types|Valid Values]])
|-
|'''name'''
|Field Name
|-
|'''data'''
|Default Field Value
|}

==Examples==
===Request===
The sample JSON body below is formatted with line breaks and indentation to make it easier to read. This is '''not''' required.
<pre>https://ivstest1.ad.ipivs.com/api/v3/admin/templates/52/fields/158/edit?access_token=e82632d19c523678fea3d1016c6df9e9</pre>
<nowiki>
{
"on":true,
"required":true,
"type":"text",
"name":"Patient",
"data":"John Doe"
}
</nowiki>

===Successful Response===
Sample response is shown with line breaks to make it more readable. Actual responses will not include line breaks.
<nowiki>
{
"data":{
"id": 158,
"on": true,
"req": true,
"type": "text",
"name": "Patient",
"data": "John Doe"
}
}
</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": 500,
"message": "Internal Server Error"
}
}

</nowiki>

API Update Template Fields - Revision history

IVSWikiBlue at 17:00, 7 March 2025

IVSWikiBlue at 17:00, 7 March 2025

IVSWikiBlue: Created page with "This API call will update an existing field on an existing template. ===Resource URL===
http://valt.example.com/api/v3/admin/templates/{templateid}/fields/{fieldid}/edit..."

@@ Line 41: / Line 41: @@
 |-
 |'''type'''
-|Field Type ([[Template Field Types|Valid Values]])
+|Field Type
 |no
 |text