PUT v1/Surveys/{surveyId}/PublicIds

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

Permissions required to make this request: SurveyInterviewLink.Activate

Update the survey public ids

Request Information

URI Parameters

Name	Description	Type	Additional information
surveyId	The survey id	string	Required

Body Parameters

The list of survey public ids

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.

Request 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>

application/x-www-form-urlencoded

Sample:

[Id=sample&LinkType=sample&Active=true&Url=sample]

multipart/form-data

Sample:

Sample not available.

Response Information

Resource Description

Response Message

HttpResponseMessage

Name	Type	Additional information
Version	Version	None.
Content	HttpContent	None.
StatusCode	HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.