POST v1/Surveys/{surveyId}/Distribute

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

Permissions required to make this request: SurveyWorkPackage.Distribute SurveyWorkPackage.Read

Has survey type usage restrictions capi

Distributes workpackage for survey.

Request Information

URI Parameters

Name	Description	Type	Additional information
surveyId	The survey ID.	string	Required

Body Parameters

The survey interviewer distribution model.

SurveyInterviewerDistributeModel

Name	Description	Type	Additional information
Description	Description	string	Max length: 4096
SurveyGrossTargetToDistribute	Survey Gross Target To Distribute	integer	None.
InterviewerIds	Interviewer Ids	Collection of string	None.

Request Formats

application/json, text/json

Sample:

{
  "Description": "sample string 1",
  "SurveyGrossTargetToDistribute": 2,
  "InterviewerIds": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample:

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

application/x-www-form-urlencoded

Sample:

Description=sample&SurveyGrossTargetToDistribute=1&InterviewerIds=[]

multipart/form-data

Sample:

Sample not available.

Response Information

Resource Description

Message indicating the status of the request

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.