POST v1/Surveys/{surveyId}/RespondentDataEncrypt

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

Permissions required to make this request: RespondentData.Encrypt Survey.Read

Has survey type usage restrictions online

Gets asynchronously the decrypted data to encrypt it

Request Information

URI Parameters

Name	Description	Type	Additional information
surveyId	The survey identifier	string	Required

Body Parameters

The decrypted text in modeled object format and it's, optional, initialization vector. The model in JSON format must look like {"Iv": "XXXXXXX","Data":{"Data1":"Value1","Data2":"Value2", "Data3":"Value3"}}

RespondentDataCryptographyModel

Name	Description	Type	Additional information
IV	The initialization vector used in cryptography operations. It must be a valid random or pseudorandom value. When used in the cryptography operation, it must be converted to Base64 byte[]	string	None.
Data	The data dictionary that will be encrypted/decrypted.	Dictionary of string [key] and string [value]	None.

Request Formats

application/json, text/json

Sample:

{
  "IV": "sample string 1",
  "Data": {
    "sample string 1": "sample string 2",
    "sample string 3": "sample string 4"
  }
}

application/xml, text/xml

Sample:

<RespondentDataCryptographyModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NipoSoftware.Nfield.Manager.Api.Models">
  <Data xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:Value>sample string 2</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 3</d2p1:Key>
      <d2p1:Value>sample string 4</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Data>
  <IV>sample string 1</IV>
</RespondentDataCryptographyModel>

application/x-www-form-urlencoded

Sample:

IV=sample&Data={}

multipart/form-data

Sample:

Sample not available.

Response Information

Resource Description

A message with the IV, not encrypted but encoded, and the Data, encrypted and url encoded

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.