GET v1/Surveys/{surveyId}/Script

User roles allowed to make this request: DomainAdministrator PowerUser RegularUser Scripter LimitedUser OperationsUser DemoUser

Permissions required to make this request: SurveyQuestionnaire.Read Survey.Read

Supports blueprint surveys

Supports survey simulations

This method retrieves the ODIN script of a specific survey.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
surveyId

The id of the survey

 string

Required

Body Parameters

None.

Response Information

Resource Description

Model containing the ODIN script

Response Message

SurveyGetScriptModel
NameDescriptionTypeAdditional information
Script

Gets the odin script.

 string

None.
FileName

The file name for script file

 string

None.
WarningMessages

Warning messages that resulted from the parse

 Collection of string

None.

Response Formats

application/json, text/json

Sample: 
{
  "Script": "sample string 1",
  "FileName": "sample string 2",
  "WarningMessages": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample: 
<SurveyGetScriptModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NipoSoftware.Nfield.Manager.Api.Models">
  <FileName>sample string 2</FileName>
  <Script>sample string 1</Script>
  <WarningMessages xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </WarningMessages>
</SurveyGetScriptModel>