GET /external/api/v3/questionnaire

Get a questionnaire by id or evaluate by data.

Request Information

URI Parameters

Name	Description	Type	Additional information	Nullable
Id		globally unique identifier	None	True
Data	List of customer data that is to be evaluated.	Collection of CustomerData	None	False
LanguageCode		string	None	False
IncludeArchived	Include archived pages en questions in response, default false.	boolean	None	False

Body Parameters

None.

Response Information

Resource Description

GetQuestionnaireResponse

Name	Description	Type	Additional information	Nullable
Questionnaire		Questionnaire	None	False

Response Formats

application/json, text/json

Sample:

{
  "Questionnaire": {
    "Pages": [
      {
        "Questions": [
          {
            "Id": "73eb8319-8d39-4ed9-8e59-24c976a3f32f",
            "BaseQuestionId": 2,
            "Type": "sample string 3",
            "Content": "sample string 4",
            "Description": "sample string 5",
            "Scale": {
              "Positions": [
                {
                  "Id": 1,
                  "Label": "sample string 1",
                  "Value": 1,
                  "Ranking": 1
                },
                {
                  "Id": 1,
                  "Label": "sample string 1",
                  "Value": 1,
                  "Ranking": 1
                }
              ]
            },
            "Order": 6,
            "VerticalOrientation": true,
            "Text": "sample string 8",
            "ScaleBehavior": "sample string 9",
            "CustomerDataColumnId": 1,
            "Required": true,
            "IsArchived": true
          },
          {
            "Id": "73eb8319-8d39-4ed9-8e59-24c976a3f32f",
            "BaseQuestionId": 2,
            "Type": "sample string 3",
            "Content": "sample string 4",
            "Description": "sample string 5",
            "Scale": {
              "Positions": [
                {
                  "Id": 1,
                  "Label": "sample string 1",
                  "Value": 1,
                  "Ranking": 1
                },
                {
                  "Id": 1,
                  "Label": "sample string 1",
                  "Value": 1,
                  "Ranking": 1
                }
              ]
            },
            "Order": 6,
            "VerticalOrientation": true,
            "Text": "sample string 8",
            "ScaleBehavior": "sample string 9",
            "CustomerDataColumnId": 1,
            "Required": true,
            "IsArchived": true
          }
        ],
        "IsArchived": true
      },
      {
        "Questions": [
          {
            "Id": "73eb8319-8d39-4ed9-8e59-24c976a3f32f",
            "BaseQuestionId": 2,
            "Type": "sample string 3",
            "Content": "sample string 4",
            "Description": "sample string 5",
            "Scale": {
              "Positions": [
                {
                  "Id": 1,
                  "Label": "sample string 1",
                  "Value": 1,
                  "Ranking": 1
                },
                {
                  "Id": 1,
                  "Label": "sample string 1",
                  "Value": 1,
                  "Ranking": 1
                }
              ]
            },
            "Order": 6,
            "VerticalOrientation": true,
            "Text": "sample string 8",
            "ScaleBehavior": "sample string 9",
            "CustomerDataColumnId": 1,
            "Required": true,
            "IsArchived": true
          },
          {
            "Id": "73eb8319-8d39-4ed9-8e59-24c976a3f32f",
            "BaseQuestionId": 2,
            "Type": "sample string 3",
            "Content": "sample string 4",
            "Description": "sample string 5",
            "Scale": {
              "Positions": [
                {
                  "Id": 1,
                  "Label": "sample string 1",
                  "Value": 1,
                  "Ranking": 1
                },
                {
                  "Id": 1,
                  "Label": "sample string 1",
                  "Value": 1,
                  "Ranking": 1
                }
              ]
            },
            "Order": 6,
            "VerticalOrientation": true,
            "Text": "sample string 8",
            "ScaleBehavior": "sample string 9",
            "CustomerDataColumnId": 1,
            "Required": true,
            "IsArchived": true
          }
        ],
        "IsArchived": true
      }
    ],
    "Id": "46d41411-c91e-40dc-a733-ef4f5d158251",
    "Name": "sample string 2",
    "LastModifiedDate": "2024-11-21T10:16:34.3824694+01:00",
    "IsConcept": true
  }
}

application/xml, text/xml

Sample:

<GetQuestionnaireResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Expoints.API.Extern.V1.Responses">
  <Questionnaire xmlns:d2p1="http://schemas.datacontract.org/2004/07/Expoints.API.Extern.V1.Models">
    <Id xmlns="http://schemas.datacontract.org/2004/07/Expoints.API.Extern.Models">46d41411-c91e-40dc-a733-ef4f5d158251</Id>
    <IsConcept xmlns="http://schemas.datacontract.org/2004/07/Expoints.API.Extern.Models">true</IsConcept>
    <LastModifiedDate xmlns="http://schemas.datacontract.org/2004/07/Expoints.API.Extern.Models">2024-11-21T10:16:34.3824694+01:00</LastModifiedDate>
    <Name xmlns="http://schemas.datacontract.org/2004/07/Expoints.API.Extern.Models">sample string 2</Name>
    <d2p1:Pages>
      <d2p1:Page>
        <d2p1:IsArchived>true</d2p1:IsArchived>
        <d2p1:Questions>
          <d2p1:Question>
            <d2p1:BaseQuestionId>2</d2p1:BaseQuestionId>
            <d2p1:Content>sample string 4</d2p1:Content>
            <d2p1:CustomerDataColumnId>1</d2p1:CustomerDataColumnId>
            <d2p1:Description>sample string 5</d2p1:Description>
            <d2p1:Id>73eb8319-8d39-4ed9-8e59-24c976a3f32f</d2p1:Id>
            <d2p1:IsArchived>true</d2p1:IsArchived>
            <d2p1:Order>6</d2p1:Order>
            <d2p1:Required>true</d2p1:Required>
            <d2p1:Scale xmlns:d7p1="http://schemas.datacontract.org/2004/07/Expoints.API.Extern.Models">
              <d7p1:Positions>
                <d7p1:ScalePosition>
                  <d7p1:Id>1</d7p1:Id>
                  <d7p1:Label>sample string 1</d7p1:Label>
                  <d7p1:Ranking>1</d7p1:Ranking>
                  <d7p1:Value>1</d7p1:Value>
                </d7p1:ScalePosition>
                <d7p1:ScalePosition>
                  <d7p1:Id>1</d7p1:Id>
                  <d7p1:Label>sample string 1</d7p1:Label>
                  <d7p1:Ranking>1</d7p1:Ranking>
                  <d7p1:Value>1</d7p1:Value>
                </d7p1:ScalePosition>
              </d7p1:Positions>
            </d2p1:Scale>
            <d2p1:ScaleBehavior>sample string 9</d2p1:ScaleBehavior>
            <d2p1:Text>sample string 8</d2p1:Text>
            <d2p1:Type>sample string 3</d2p1:Type>
            <d2p1:VerticalOrientation>true</d2p1:VerticalOrientation>
          </d2p1:Question>
          <d2p1:Question>
            <d2p1:BaseQuestionId>2</d2p1:BaseQuestionId>
            <d2p1:Content>sample string 4</d2p1:Content>
            <d2p1:CustomerDataColumnId>1</d2p1:CustomerDataColumnId>
            <d2p1:Description>sample string 5</d2p1:Description>
            <d2p1:Id>73eb8319-8d39-4ed9-8e59-24c976a3f32f</d2p1:Id>
            <d2p1:IsArchived>true</d2p1:IsArchived>
            <d2p1:Order>6</d2p1:Order>
            <d2p1:Required>true</d2p1:Required>
            <d2p1:Scale xmlns:d7p1="http://schemas.datacontract.org/2004/07/Expoints.API.Extern.Models">
              <d7p1:Positions>
                <d7p1:ScalePosition>
                  <d7p1:Id>1</d7p1:Id>
                  <d7p1:Label>sample string 1</d7p1:Label>
                  <d7p1:Ranking>1</d7p1:Ranking>
                  <d7p1:Value>1</d7p1:Value>
                </d7p1:ScalePosition>
                <d7p1:ScalePosition>
                  <d7p1:Id>1</d7p1:Id>
                  <d7p1:Label>sample string 1</d7p1:Label>
                  <d7p1:Ranking>1</d7p1:Ranking>
                  <d7p1:Value>1</d7p1:Value>
                </d7p1:ScalePosition>
              </d7p1:Positions>
            </d2p1:Scale>
            <d2p1:ScaleBehavior>sample string 9</d2p1:ScaleBehavior>
            <d2p1:Text>sample string 8</d2p1:Text>
            <d2p1:Type>sample string 3</d2p1:Type>
            <d2p1:VerticalOrientation>true</d2p1:VerticalOrientation>
          </d2p1:Question>
        </d2p1:Questions>
      </d2p1:Page>
      <d2p1:Page>
        <d2p1:IsArchived>true</d2p1:IsArchived>
        <d2p1:Questions>
          <d2p1:Question>
            <d2p1:BaseQuestionId>2</d2p1:BaseQuestionId>
            <d2p1:Content>sample string 4</d2p1:Content>
            <d2p1:CustomerDataColumnId>1</d2p1:CustomerDataColumnId>
            <d2p1:Description>sample string 5</d2p1:Description>
            <d2p1:Id>73eb8319-8d39-4ed9-8e59-24c976a3f32f</d2p1:Id>
            <d2p1:IsArchived>true</d2p1:IsArchived>
            <d2p1:Order>6</d2p1:Order>
            <d2p1:Required>true</d2p1:Required>
            <d2p1:Scale xmlns:d7p1="http://schemas.datacontract.org/2004/07/Expoints.API.Extern.Models">
              <d7p1:Positions>
                <d7p1:ScalePosition>
                  <d7p1:Id>1</d7p1:Id>
                  <d7p1:Label>sample string 1</d7p1:Label>
                  <d7p1:Ranking>1</d7p1:Ranking>
                  <d7p1:Value>1</d7p1:Value>
                </d7p1:ScalePosition>
                <d7p1:ScalePosition>
                  <d7p1:Id>1</d7p1:Id>
                  <d7p1:Label>sample string 1</d7p1:Label>
                  <d7p1:Ranking>1</d7p1:Ranking>
                  <d7p1:Value>1</d7p1:Value>
                </d7p1:ScalePosition>
              </d7p1:Positions>
            </d2p1:Scale>
            <d2p1:ScaleBehavior>sample string 9</d2p1:ScaleBehavior>
            <d2p1:Text>sample string 8</d2p1:Text>
            <d2p1:Type>sample string 3</d2p1:Type>
            <d2p1:VerticalOrientation>true</d2p1:VerticalOrientation>
          </d2p1:Question>
          <d2p1:Question>
            <d2p1:BaseQuestionId>2</d2p1:BaseQuestionId>
            <d2p1:Content>sample string 4</d2p1:Content>
            <d2p1:CustomerDataColumnId>1</d2p1:CustomerDataColumnId>
            <d2p1:Description>sample string 5</d2p1:Description>
            <d2p1:Id>73eb8319-8d39-4ed9-8e59-24c976a3f32f</d2p1:Id>
            <d2p1:IsArchived>true</d2p1:IsArchived>
            <d2p1:Order>6</d2p1:Order>
            <d2p1:Required>true</d2p1:Required>
            <d2p1:Scale xmlns:d7p1="http://schemas.datacontract.org/2004/07/Expoints.API.Extern.Models">
              <d7p1:Positions>
                <d7p1:ScalePosition>
                  <d7p1:Id>1</d7p1:Id>
                  <d7p1:Label>sample string 1</d7p1:Label>
                  <d7p1:Ranking>1</d7p1:Ranking>
                  <d7p1:Value>1</d7p1:Value>
                </d7p1:ScalePosition>
                <d7p1:ScalePosition>
                  <d7p1:Id>1</d7p1:Id>
                  <d7p1:Label>sample string 1</d7p1:Label>
                  <d7p1:Ranking>1</d7p1:Ranking>
                  <d7p1:Value>1</d7p1:Value>
                </d7p1:ScalePosition>
              </d7p1:Positions>
            </d2p1:Scale>
            <d2p1:ScaleBehavior>sample string 9</d2p1:ScaleBehavior>
            <d2p1:Text>sample string 8</d2p1:Text>
            <d2p1:Type>sample string 3</d2p1:Type>
            <d2p1:VerticalOrientation>true</d2p1:VerticalOrientation>
          </d2p1:Question>
        </d2p1:Questions>
      </d2p1:Page>
    </d2p1:Pages>
  </Questionnaire>
</GetQuestionnaireResponse>

Response Status Codes

Status Code	Name	Description
200	OK	The request has succeeded.
400	Bad Request	Fulfilling the request would cause an invalid state. Request needs modification.
401	Unauthorized	Missing or invalid authentication token.
403	Forbidden	Server refuses to authorize the request.
408	Request Timeout	The server timed out waiting for the request.
429	Too Many Requests	Too many requests in a given amount of time.
500	Internal Server Error	The server encountered an unexpected condition which prevented it from fulfilling the request.
503	Service Unavailable	The server is unable to proces the request at the moment, try again later.