GET v1/Surveys/{surveyId}/Package?type={type}

User roles allowed to make this request: DomainAdministrator PowerUser RegularUser Supervisor LimitedUser SampleManager

Permissions required to make this request: SurveyWorkPackage.Read

Get the specified type of package for the specified survey.

Request Information

URI Parameters

Name	Description	Type	Additional information
surveyId	is of the survey	string	Required
type	type of package to get	InterviewPackageType	Required

Body Parameters

None.

Response Information

Resource Description

the requested package

Response Message

SurveyPackageModel

Name	Description	Type	Additional information
SurveyName	The name of the survey when this package was published	string	None.
ETag	The Etag for the package	integer	None.
Description	The description of the survey when this package was published	string	None.
ClientName	The client of the survey when this package was published	string	None.
Owner	The owner of the survey when this package was published	string	None.
InterviewerInstructionText	The instruction text of the survey when this package was published	string	None.
ResponseCodes	Survey response codes.	Collection of SurveyResponseCodeModel	None.
Languages	The defined languages and translations of the survey when this package was published	Collection of SurveyPackageLanguageModel	None.
Relocations	The relocations of the survey when this package was published	Collection of SurveyPackageRelocationModel	None.
Settings	The settings of the survey when this package was published	Collection of SurveySettingModel	None.
InstructionFile	The instruction file of the survey when this package was published	SurveyPackageFileModel	None.
MediaFiles	The media files of the survey when this package was published	Collection of SurveyPackageFileModel	None.
QuestionnaireMd5	The md5 of the questionnaire when this package was published	string	None.

Response Formats

application/json, text/json

Sample:

{
  "SurveyName": "sample string 1",
  "ETag": 2,
  "Description": "sample string 3",
  "ClientName": "sample string 4",
  "Owner": "sample string 5",
  "InterviewerInstructionText": "sample string 6",
  "ResponseCodes": [
    {
      "ResponseCode": 1,
      "Description": "sample string 2",
      "IsDefinite": true,
      "IsSelectable": true,
      "AllowAppointment": true,
      "RelocationUrl": "sample string 3"
    },
    {
      "ResponseCode": 1,
      "Description": "sample string 2",
      "IsDefinite": true,
      "IsSelectable": true,
      "AllowAppointment": true,
      "RelocationUrl": "sample string 3"
    }
  ],
  "Languages": [
    {
      "Id": 1,
      "Name": "sample string 2",
      "Translations": [
        {
          "Name": "sample string 1",
          "Text": "sample string 2"
        },
        {
          "Name": "sample string 1",
          "Text": "sample string 2"
        }
      ]
    },
    {
      "Id": 1,
      "Name": "sample string 2",
      "Translations": [
        {
          "Name": "sample string 1",
          "Text": "sample string 2"
        },
        {
          "Name": "sample string 1",
          "Text": "sample string 2"
        }
      ]
    }
  ],
  "Relocations": [
    {
      "Reason": "sample string 1",
      "Url": "sample string 2"
    },
    {
      "Reason": "sample string 1",
      "Url": "sample string 2"
    }
  ],
  "Settings": [
    {
      "Name": "sample string 1",
      "Value": "sample string 2"
    },
    {
      "Name": "sample string 1",
      "Value": "sample string 2"
    }
  ],
  "InstructionFile": {
    "FileName": "sample string 1",
    "Md5": "sample string 2",
    "Size": 3
  },
  "MediaFiles": [
    {
      "FileName": "sample string 1",
      "Md5": "sample string 2",
      "Size": 3
    },
    {
      "FileName": "sample string 1",
      "Md5": "sample string 2",
      "Size": 3
    }
  ],
  "QuestionnaireMd5": "sample string 7"
}

application/xml, text/xml

Sample:

<SurveyPackageModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NipoSoftware.Nfield.Manager.Api.Models">
  <ClientName>sample string 4</ClientName>
  <Description>sample string 3</Description>
  <ETag>2</ETag>
  <InstructionFile>
    <FileName>sample string 1</FileName>
    <Md5>sample string 2</Md5>
    <Size>3</Size>
  </InstructionFile>
  <InterviewerInstructionText>sample string 6</InterviewerInstructionText>
  <Languages>
    <SurveyPackageLanguageModel>
      <Id>1</Id>
      <Name>sample string 2</Name>
      <Translations>
        <SurveyTranslationModel>
          <Name>sample string 1</Name>
          <Text>sample string 2</Text>
        </SurveyTranslationModel>
        <SurveyTranslationModel>
          <Name>sample string 1</Name>
          <Text>sample string 2</Text>
        </SurveyTranslationModel>
      </Translations>
    </SurveyPackageLanguageModel>
    <SurveyPackageLanguageModel>
      <Id>1</Id>
      <Name>sample string 2</Name>
      <Translations>
        <SurveyTranslationModel>
          <Name>sample string 1</Name>
          <Text>sample string 2</Text>
        </SurveyTranslationModel>
        <SurveyTranslationModel>
          <Name>sample string 1</Name>
          <Text>sample string 2</Text>
        </SurveyTranslationModel>
      </Translations>
    </SurveyPackageLanguageModel>
  </Languages>
  <MediaFiles>
    <SurveyPackageFileModel>
      <FileName>sample string 1</FileName>
      <Md5>sample string 2</Md5>
      <Size>3</Size>
    </SurveyPackageFileModel>
    <SurveyPackageFileModel>
      <FileName>sample string 1</FileName>
      <Md5>sample string 2</Md5>
      <Size>3</Size>
    </SurveyPackageFileModel>
  </MediaFiles>
  <Owner>sample string 5</Owner>
  <QuestionnaireMd5>sample string 7</QuestionnaireMd5>
  <Relocations>
    <SurveyPackageRelocationModel>
      <Reason>sample string 1</Reason>
      <Url>sample string 2</Url>
    </SurveyPackageRelocationModel>
    <SurveyPackageRelocationModel>
      <Reason>sample string 1</Reason>
      <Url>sample string 2</Url>
    </SurveyPackageRelocationModel>
  </Relocations>
  <ResponseCodes>
    <SurveyResponseCodeModel>
      <AllowAppointment>true</AllowAppointment>
      <Description>sample string 2</Description>
      <IsDefinite>true</IsDefinite>
      <IsSelectable>true</IsSelectable>
      <RelocationUrl>sample string 3</RelocationUrl>
      <ResponseCode>1</ResponseCode>
    </SurveyResponseCodeModel>
    <SurveyResponseCodeModel>
      <AllowAppointment>true</AllowAppointment>
      <Description>sample string 2</Description>
      <IsDefinite>true</IsDefinite>
      <IsSelectable>true</IsSelectable>
      <RelocationUrl>sample string 3</RelocationUrl>
      <ResponseCode>1</ResponseCode>
    </SurveyResponseCodeModel>
  </ResponseCodes>
  <Settings>
    <SurveySettingModel>
      <Name>sample string 1</Name>
      <Value>sample string 2</Value>
    </SurveySettingModel>
    <SurveySettingModel>
      <Name>sample string 1</Name>
      <Value>sample string 2</Value>
    </SurveySettingModel>
  </Settings>
  <SurveyName>sample string 1</SurveyName>
</SurveyPackageModel>