GET Api/Questionnaire/{questionnaireId}

Returns a specific questionnaire Throws HTTP404 if the specified questionnaire is not found. Throws HTTP403 if the specified questionnaire is not accesible.

Request Information

URI Parameters

Name	Description	Type	Additional information
questionnaireId	The ID of the questionnaire.	integer	Required

Body Parameters

None.

Response Information

Resource Description

All the metadata required to display a questionnaire.

QuestionnaireResponse

Name	Type	Additional information
Id	integer	None.
Name	string	None.
Description	string	None.
Location	QuestionnaireLocation	None.
Items	Collection of QuestionnaireItemResponse	None.

Response Formats

application/json, text/json

Sample:

{
  "Id": 1,
  "Name": "sample string 2",
  "Description": "sample string 3",
  "Location": 0,
  "Items": [
    {
      "Id": 1,
      "Title": "sample string 2",
      "Description": "sample string 3",
      "IsRequired": true,
      "Type": 0,
      "CustomField": {
        "Name": "sample string 1",
        "Title": "sample string 2",
        "GroupName": "sample string 3",
        "Type": 0,
        "Target": 0,
        "IsPublic": true,
        "PossibleValues": [
          "sample string 1",
          "sample string 2"
        ],
        "DefaultValue": "sample string 5"
      },
      "Language": "sample string 5",
      "Knowledge": "sample string 6",
      "KnowledgeGroup": "sample string 7",
      "ApplicantDocumentType": "sample string 8"
    },
    {
      "Id": 1,
      "Title": "sample string 2",
      "Description": "sample string 3",
      "IsRequired": true,
      "Type": 0,
      "CustomField": {
        "Name": "sample string 1",
        "Title": "sample string 2",
        "GroupName": "sample string 3",
        "Type": 0,
        "Target": 0,
        "IsPublic": true,
        "PossibleValues": [
          "sample string 1",
          "sample string 2"
        ],
        "DefaultValue": "sample string 5"
      },
      "Language": "sample string 5",
      "Knowledge": "sample string 6",
      "KnowledgeGroup": "sample string 7",
      "ApplicantDocumentType": "sample string 8"
    }
  ]
}

application/xml, text/xml

Sample:

<QuestionnaireResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/eRecruiter.Api.Responses">
  <Description>sample string 3</Description>
  <Id>1</Id>
  <Items>
    <QuestionnaireItemResponse>
      <ApplicantDocumentType>sample string 8</ApplicantDocumentType>
      <CustomField>
        <DefaultValue>sample string 5</DefaultValue>
        <GroupName>sample string 3</GroupName>
        <IsPublic>true</IsPublic>
        <Name>sample string 1</Name>
        <PossibleValues xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>sample string 1</d5p1:string>
          <d5p1:string>sample string 2</d5p1:string>
        </PossibleValues>
        <Target>Applicant</Target>
        <Title>sample string 2</Title>
        <Type>TextMultiLine</Type>
      </CustomField>
      <Description>sample string 3</Description>
      <Id>1</Id>
      <IsRequired>true</IsRequired>
      <Knowledge>sample string 6</Knowledge>
      <KnowledgeGroup>sample string 7</KnowledgeGroup>
      <Language>sample string 5</Language>
      <Title>sample string 2</Title>
      <Type>SingleLanguage</Type>
    </QuestionnaireItemResponse>
    <QuestionnaireItemResponse>
      <ApplicantDocumentType>sample string 8</ApplicantDocumentType>
      <CustomField>
        <DefaultValue>sample string 5</DefaultValue>
        <GroupName>sample string 3</GroupName>
        <IsPublic>true</IsPublic>
        <Name>sample string 1</Name>
        <PossibleValues xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>sample string 1</d5p1:string>
          <d5p1:string>sample string 2</d5p1:string>
        </PossibleValues>
        <Target>Applicant</Target>
        <Title>sample string 2</Title>
        <Type>TextMultiLine</Type>
      </CustomField>
      <Description>sample string 3</Description>
      <Id>1</Id>
      <IsRequired>true</IsRequired>
      <Knowledge>sample string 6</Knowledge>
      <KnowledgeGroup>sample string 7</KnowledgeGroup>
      <Language>sample string 5</Language>
      <Title>sample string 2</Title>
      <Type>SingleLanguage</Type>
    </QuestionnaireItemResponse>
  </Items>
  <Location>OnFirstPage</Location>
  <Name>sample string 2</Name>
</QuestionnaireResponse>