GET v1/Surveys/{surveyId}/PublicIds

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

Permissions required to make this request: SurveyInterviewLink.Read.Test Survey.Read SurveyInterviewLink.Read.Live

This method retrieves the list of public ids (internal test, external test and live) based on a survey. This list can be filtered and sorted using standard OData syntax.

Request Information

URI Parameters

Name	Description	Type	Additional information
surveyId	The id of the survey	string	Required

Body Parameters

None.

Response Information

Resource Description

Response Message

Collection of SurveyPublicIdModel

Name	Description	Type	Additional information
Id	The public id that is used to link to the survey	string	None.
LinkType	The link type. The value maps to but it's not done directly because EF isn't good with enums	string	None.
Active	Whether this id is active	boolean	None.
Url	Start interview URL	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "Id": "sample string 1",
    "LinkType": "sample string 2",
    "Active": true,
    "Url": "sample string 4"
  },
  {
    "Id": "sample string 1",
    "LinkType": "sample string 2",
    "Active": true,
    "Url": "sample string 4"
  }
]

application/xml, text/xml

Sample:

<ArrayOfSurveyPublicIdModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NipoSoftware.Nfield.Manager.Api.Models">
  <SurveyPublicIdModel>
    <Active>true</Active>
    <Id>sample string 1</Id>
    <LinkType>sample string 2</LinkType>
    <Url>sample string 4</Url>
  </SurveyPublicIdModel>
  <SurveyPublicIdModel>
    <Active>true</Active>
    <Id>sample string 1</Id>
    <LinkType>sample string 2</LinkType>
    <Url>sample string 4</Url>
  </SurveyPublicIdModel>
</ArrayOfSurveyPublicIdModel>