PUT v1/SearchFieldsSetting

User roles allowed to make this request: DomainAdministrator

Permissions required to make this request: SearchFieldSetting.Write SearchFieldSetting.Read

Update the domain's search fields.

Request Information

URI Parameters

None.

Body Parameters

Fields where search for respondent data. The maximum number of fields is 5.

SearchFieldsSetting

Name	Description	Type	Additional information
Fields	Fields where search for respondent data	Collection of string	None.

Request Formats

application/json, text/json

Sample:

{
  "Fields": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample:

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

application/x-www-form-urlencoded

Sample:

Fields=IEnumerable`1

multipart/form-data

Sample:

Sample not available.

Response Information

Resource Description

Response Message

SearchFieldsSetting

Name	Description	Type	Additional information
Fields	Fields where search for respondent data	Collection of string	None.

Response Formats

application/json, text/json

Sample:

{
  "Fields": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample:

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