Create a new recipient for a Survey

Request Parameters

Name Type Description Required?
DataRecipient[]UnavailableRequired
ProjectIdSystem.Int32UnavailableRequired
ProjectIdSystem.Int32UnavailableRequired

Validation

Name Type Description Required?
ProjectIdSystem.Int32IdRequired

Endpoints

Sample Request
 <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:api="http://api.phoenixplatform.net" xmlns:tig="http://schemas.datacontract.org/2004/07/Tigerspike.Phoenix.Services" xmlns:arr="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns:tig1="http://schemas.datacontract.org/2004/07/Tigerspike.Phoenix.Services.Filters">
    <soapenv:Header>
      <PhoenixHeader xmlns="http://api.phoenixplatform.com" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
         <AccessToken>[YOUR ACCESS TOKEN]</AccessToken>
         <Phoenix-ProjectId>1</Phoenix-ProjectId>
      </PhoenixHeader>
   </soapenv:Header>
   <soapenv:Body>
      <api1:CreateRecipient xmlns:api1="http://api.phoenixplatform.com">
         <api1:request>
             <tig:Id>1</tig:Id>
             <tig:SurveyId>1</tig:SurveyId>
             <tig:FirstName>TestValue[4bf3d086f086446095435934032942b7]</tig:FirstName>
             <tig:LastName>TestValue[7a75403aef384c679f55a4e61bd649d3]</tig:LastName>
             <tig:SentDate>2021-01-27T11:00:06.1323894+00:00</tig:SentDate>
             <tig:SubmissionId>1</tig:SubmissionId>
             <tig:Uuid>TestValue[5f8d34842c8041649aef229c39ea7b83]</tig:Uuid>
             <tig:ShortLink>TestValue[9d9c6ae6d66e4c8bad4dc13714407ab0]</tig:ShortLink>
             <tig:ModifyDate>2021-01-27T11:00:06.1323894+00:00</tig:ModifyDate>
             <tig:Email>TestValue[43c77219c1204e4fa07859ff7a8ad0d1]</tig:Email>
             <tig:MetaDataParameters>new List<KeyValuePair<string, string>>().ToArray()</tig:MetaDataParameters>
             <tig:NotificationAddresses>TestValue[a36affff58a54a66a42c4301073134cd]</tig:NotificationAddresses>
             <tig:IsSingleUse>true</tig:IsSingleUse>
             <tig:OpenedDate>2021-01-27T11:00:06.1323894+00:00</tig:OpenedDate>
             <tig:SubmissionDate>2021-01-27T11:00:06.1323894+00:00</tig:SubmissionDate>
             <tig:PhoenixMessaging_RecipientId>1</tig:PhoenixMessaging_RecipientId>
         </api1:request>
      </api1:CreateRecipient>
   </soapenv:Body>
</soapenv:Envelope>
Sample Response
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Header>
      <ActivityId CorrelationId="d088e8c6-bf1e-4a9d-9e96-3f5faf232af5" xmlns="http://schemas.microsoft.com/2004/09/ServiceModel/Diagnostics">17abb643-6b2f-4485-b4ff-0afc30697b7d</ActivityId>
   </s:Header>
   <s:Body>
      <SurveyResponse xmlns="http://api.phoenixplatform.com">
         <SurveyResult xmlns:a="http://schemas.datacontract.org/2004/07/Tigerspike.Phoenix.Syndicate.Services.Contracts.Article" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
            <b:Data xmlns="http://schemas.datacontract.org/2004/07/Tigerspike.Phoenix.Services" xmlns:b="http://schemas.datacontract.org/2004/07/Tigerspike.Phoenix.Survey.Model">
              <b:Recipient>
                <b:CreateDate>2021-01-27T11:00:06.1323894Z</b:CreateDate>
                <b:ModifyDate>2021-01-27T11:00:06.1323894Z</b:ModifyDate>
                <b:SurveyId>0</b:SurveyId>
  </b:Recipient>
</b:Data>
            <TotalRecords xmlns="http://schemas.datacontract.org/2004/07/Tigerspike.Phoenix.Services">1</TotalRecords>
         </SurveyResult>
      </SurveyResponse>
   </s:Body>
</s:Envelope>
Resource URL

Sample Request

POST /projects/{projectId}/surveys/{surveyId}/recipients? HTTP/1.1
Accept-Encoding: gzip,deflate
Content-Type: application/json; charset=utf-8
Authorization: Bearer [YOUR SUPER SECURE TOKEN]
Content-Length: 1588
Host: [CallHost]
Connection: Keep-Alive
User-Agent: Apache-HttpClient/4.1.1 (java 1.5)-
 
[{
 "Id" : 1,
 "SurveyId" : 1,
 "FirstName" : "TestValue[6fd7754f5f8b462cb4d3b1001bfb09a8]",
 "LastName" : "TestValue[48e2a683ce9d492c809d41f7254890d8]",
 "SentDate" : "2021-01-27T11:00:06.1323894+00:00",
 "SubmissionId" : 1,
 "Uuid" : "TestValue[975a83951d4447ba887021d4d730bda4]",
 "ShortLink" : "TestValue[844ddbd7ca814ababfd82f6b26502839]",
 "ModifyDate" : "2021-01-27T11:00:06.1323894+00:00",
 "Email" : "TestValue[30f0189a57654454a4816a32ec2a6284]",
 "MetaDataParameters" : new List<KeyValuePair<string, string>>().ToArray(),
 "NotificationAddresses" : "TestValue[fc6433df922c43b4841ca80c41eee885]",
 "IsSingleUse" : true,
 "OpenedDate" : "2021-01-27T11:00:06.1323894+00:00",
 "SubmissionDate" : "2021-01-27T11:00:06.1323894+00:00",
 "PhoenixMessaging_RecipientId" : 1
}] 
Sample Response
HTTP/1.1 200 OK
Cache-Control: private
Content-Length: 200
Content-Type: application/json; charset=utf-8
Server: Microsoft-IIS/8.5
X-AspNet-Version: 4.0.30319
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET,PUT,POST,DELETE,OPTIONS
Access-Control-Allow-Headers: Content-Type

[{
  "SurveyId": 0,
  "CreateDate": "2021-01-27T11:22:44.4323151Z",
  "ModifyDate": "2021-01-27T11:22:44.4323151Z"
}]

Nuget

PM> Install-Package PhoenixServiceHelper

PhoenixServiceHelper Sample

using System;
using System.Collections.Generic;

using Tigerspike.Phoenix.Services.Api.ServiceConfiguration;
using Tigerspike.Phoenix.Services.Api.ServiceRequest;
using PhoenixService = Tigerspike.PhoenixSurvey.V1;
using Tigerspike.Phoenix.Services.Api;

var request = new SoapServiceRequest() { Token = "[YOUR SUPER SECURE TOKEN]", ProjectId = 1 };
var configuration = CustomConfigurationFactory.CreateServiceConfiguration(Assembly.GetExecutingAssembly());

var proxy = new PhoenixServiceHelper<PhoenixService.IPhoenixSurveyService>(configuration);
var response = proxy.Execute(request, o => o.CreateRecipient(new PhoenixService.CreateRecipientRequest() 
{ 
    Data = new[] 
    { 
        new PhoenixService.Recipient() 
        {
          Id = 1,
          SurveyId = 1,
          FirstName = "TestValue["Guid.NewGuid().ToString().Replace("-",string.Empty)+"]",
          LastName = "TestValue["Guid.NewGuid().ToString().Replace("-",string.Empty)+"]",
          SentDate = DateTime.UtcNow,
          SubmissionId = 1,
          Uuid = "TestValue["Guid.NewGuid().ToString().Replace("-",string.Empty)+"]",
          ShortLink = "TestValue["Guid.NewGuid().ToString().Replace("-",string.Empty)+"]",
          ModifyDate = DateTime.UtcNow,
          Email = "TestValue["Guid.NewGuid().ToString().Replace("-",string.Empty)+"]",
          MetaDataParameters = new List<KeyValuePair<string, string>>().ToArray(),
          NotificationAddresses = "TestValue["Guid.NewGuid().ToString().Replace("-",string.Empty)+"]",
          IsSingleUse = true,
          OpenedDate = DateTime.UtcNow,
          SubmissionDate = DateTime.UtcNow,
          PhoenixMessaging_RecipientId = 1
        }
    } 
}));