curl --request POST \
--url https://api.ionworks.com/protocols/check_name \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"protocol": "<string>",
"name_from_file": false
}
'import requests
url = "https://api.ionworks.com/protocols/check_name"
payload = {
"name": "<string>",
"protocol": "<string>",
"name_from_file": False
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({name: '<string>', protocol: '<string>', name_from_file: false})
};
fetch('https://api.ionworks.com/protocols/check_name', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.ionworks.com/protocols/check_name",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'protocol' => '<string>',
'name_from_file' => false
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.ionworks.com/protocols/check_name"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"protocol\": \"<string>\",\n \"name_from_file\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.ionworks.com/protocols/check_name")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"protocol\": \"<string>\",\n \"name_from_file\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ionworks.com/protocols/check_name")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"protocol\": \"<string>\",\n \"name_from_file\": false\n}"
response = http.request(request)
puts response.read_body{
"verdict": "<string>",
"confidence": 123,
"mismatches": [
{
"aspect": "<string>",
"claim": "<string>",
"actual": "<string>"
}
],
"summary": "",
"suggested_name": ""
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Check Protocol Name Endpoint
Check whether a protocol’s name describes what the protocol does.
Advisory only. A ‘mismatch’ never blocks saving a protocol — the name is the user’s to choose, and a model that misreads a naming convention must not be able to stop work.
Returns ‘uncheckable’ for a name that makes no claim (a codename like “ETR874”, a generic “Test”, or a name carried in from an uploaded vendor file), so callers can render nothing at all in those cases.
Parameters
body : CheckProtocolNameRequest The name, the protocol it names, and whether the name came from a file.
Returns
CheckProtocolNameResponse The verdict, its confidence, the specific contradictions, and a suggested name.
curl --request POST \
--url https://api.ionworks.com/protocols/check_name \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"protocol": "<string>",
"name_from_file": false
}
'import requests
url = "https://api.ionworks.com/protocols/check_name"
payload = {
"name": "<string>",
"protocol": "<string>",
"name_from_file": False
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({name: '<string>', protocol: '<string>', name_from_file: false})
};
fetch('https://api.ionworks.com/protocols/check_name', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.ionworks.com/protocols/check_name",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'protocol' => '<string>',
'name_from_file' => false
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.ionworks.com/protocols/check_name"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"protocol\": \"<string>\",\n \"name_from_file\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.ionworks.com/protocols/check_name")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"protocol\": \"<string>\",\n \"name_from_file\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ionworks.com/protocols/check_name")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"protocol\": \"<string>\",\n \"name_from_file\": false\n}"
response = http.request(request)
puts response.read_body{
"verdict": "<string>",
"confidence": 123,
"mismatches": [
{
"aspect": "<string>",
"claim": "<string>",
"actual": "<string>"
}
],
"summary": "",
"suggested_name": ""
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Body
Request body for checking a protocol name against its protocol.
Response
Successful Response
The verdict on whether a name describes its protocol.
Was this page helpful?