Obtener cuestionario por externalId

curl --request GET \
  --url https://{your-prod-endpoint}/api/v1/questionnaires/external/{externalId} \
  --header 'X-Api-Key: <api-key>'

import requests

url = "https://{your-prod-endpoint}/api/v1/questionnaires/external/{externalId}"

headers = {"X-Api-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'X-Api-Key': '<api-key>'}};

fetch('https://{your-prod-endpoint}/api/v1/questionnaires/external/{externalId}', 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://{your-prod-endpoint}/api/v1/questionnaires/external/{externalId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-Api-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://{your-prod-endpoint}/api/v1/questionnaires/external/{externalId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Api-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://{your-prod-endpoint}/api/v1/questionnaires/external/{externalId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-Api-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "success": true,
  "data": {
    "title": {
      "es": "Seguimiento postconsulta",
      "en": "Post-visit follow up"
    },
    "questions": [
      {
        "questionText": {
          "es": "Seguimiento postconsulta",
          "en": "Post-visit follow up"
        },
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "clarificationText": {
          "es": "Seguimiento postconsulta",
          "en": "Post-visit follow up"
        },
        "externalId": "<string>",
        "options": [
          {
            "value": "<string>",
            "label": {
              "es": "Seguimiento postconsulta",
              "en": "Post-visit follow up"
            },
            "score": 123
          }
        ],
        "isRequired": true,
        "displayOrder": 123,
        "metadata": {},
        "questionnaireId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z"
      }
    ],
    "description": {
      "es": "Seguimiento postconsulta",
      "en": "Post-visit follow up"
    },
    "defaultLanguage": "es",
    "version": 123,
    "externalId": "<string>",
    "metadata": {},
    "templateVariables": [
      {
        "key": "<string>",
        "label": "<string>",
        "required": true
      }
    ],
    "edges": [
      {
        "id": "<string>",
        "questionnaireId": "<string>",
        "sourceQuestionId": "<string>",
        "targetQuestionId": "<string>",
        "conditionValue": "<string>",
        "edgeOrder": 123,
        "label": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z"
      }
    ],
    "scoreClasses": [
      {
        "min": 123,
        "max": 123,
        "level": 123,
        "label": "<string>"
      }
    ],
    "webhooks": {},
    "scheduling": {
      "startDate": "<string>",
      "endDate": "<string>",
      "frequency": {
        "every": 2
      },
      "timeSlots": [
        {
          "key": "<string>",
          "label": "<string>",
          "startTime": "<string>",
          "endTime": "<string>"
        }
      ],
      "allowedDaysOfWeek": [
        3
      ],
      "maxInstances": 2,
      "maxRetries": 1,
      "retryWindow": {
        "every": 2
      },
      "frequencyOverrides": [
        {
          "every": 2,
          "scoreLevel": 123
        }
      ]
    },
    "protocolActions": [
      {
        "title": "<string>",
        "displayOrder": 123,
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "options": [
          {
            "label": "<string>",
            "value": "<string>"
          }
        ],
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z"
      }
    ],
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}

{
  "status": "error",
  "code": 123,
  "error_code": "<string>",
  "message": "<string>"
}

GET

api

questionnaires

external

{externalId}

Obtener cuestionario por externalId

curl --request GET \
  --url https://{your-prod-endpoint}/api/v1/questionnaires/external/{externalId} \
  --header 'X-Api-Key: <api-key>'

import requests

url = "https://{your-prod-endpoint}/api/v1/questionnaires/external/{externalId}"

headers = {"X-Api-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'X-Api-Key': '<api-key>'}};

fetch('https://{your-prod-endpoint}/api/v1/questionnaires/external/{externalId}', 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://{your-prod-endpoint}/api/v1/questionnaires/external/{externalId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-Api-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://{your-prod-endpoint}/api/v1/questionnaires/external/{externalId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Api-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://{your-prod-endpoint}/api/v1/questionnaires/external/{externalId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-Api-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "success": true,
  "data": {
    "title": {
      "es": "Seguimiento postconsulta",
      "en": "Post-visit follow up"
    },
    "questions": [
      {
        "questionText": {
          "es": "Seguimiento postconsulta",
          "en": "Post-visit follow up"
        },
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "clarificationText": {
          "es": "Seguimiento postconsulta",
          "en": "Post-visit follow up"
        },
        "externalId": "<string>",
        "options": [
          {
            "value": "<string>",
            "label": {
              "es": "Seguimiento postconsulta",
              "en": "Post-visit follow up"
            },
            "score": 123
          }
        ],
        "isRequired": true,
        "displayOrder": 123,
        "metadata": {},
        "questionnaireId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z"
      }
    ],
    "description": {
      "es": "Seguimiento postconsulta",
      "en": "Post-visit follow up"
    },
    "defaultLanguage": "es",
    "version": 123,
    "externalId": "<string>",
    "metadata": {},
    "templateVariables": [
      {
        "key": "<string>",
        "label": "<string>",
        "required": true
      }
    ],
    "edges": [
      {
        "id": "<string>",
        "questionnaireId": "<string>",
        "sourceQuestionId": "<string>",
        "targetQuestionId": "<string>",
        "conditionValue": "<string>",
        "edgeOrder": 123,
        "label": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z"
      }
    ],
    "scoreClasses": [
      {
        "min": 123,
        "max": 123,
        "level": 123,
        "label": "<string>"
      }
    ],
    "webhooks": {},
    "scheduling": {
      "startDate": "<string>",
      "endDate": "<string>",
      "frequency": {
        "every": 2
      },
      "timeSlots": [
        {
          "key": "<string>",
          "label": "<string>",
          "startTime": "<string>",
          "endTime": "<string>"
        }
      ],
      "allowedDaysOfWeek": [
        3
      ],
      "maxInstances": 2,
      "maxRetries": 1,
      "retryWindow": {
        "every": 2
      },
      "frequencyOverrides": [
        {
          "every": 2,
          "scoreLevel": 123
        }
      ]
    },
    "protocolActions": [
      {
        "title": "<string>",
        "displayOrder": 123,
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "options": [
          {
            "label": "<string>",
            "value": "<string>"
          }
        ],
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z"
      }
    ],
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}

{
  "status": "error",
  "code": 123,
  "error_code": "<string>",
  "message": "<string>"
}

Autorizaciones

X-Api-Key

string

header

requerido

API Key proporcionada por Omniloy. La misma key se usa para llamadas entrantes y salientes.

Parámetros de ruta

externalId

string

requerido

Respuesta

Datos del cuestionario

success

boolean

data

object

Show child attributes

Eventos e integraciones

Referencia de API

Obtener cuestionario por externalId

Autorizaciones

Parámetros de ruta

Respuesta