Create a new screen for a Survey

Request Parameters

Name Type Description Required?
DataScreen[]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:CreateScreen xmlns:api1="http://api.phoenixplatform.com">
         <api1:request>
             <tig:Id>1</tig:Id>
             <tig:SurveyId>1</tig:SurveyId>
             <tig:Progress>1</tig:Progress>
             <tig:ModifyDate>2018-12-16T11:50:53.2230879+00:00</tig:ModifyDate>
             <tig:ScreenId>1</tig:ScreenId>
             <tig:ScreenName>TestValue[29d1079753864d7694637314cbdf8f90]</tig:ScreenName>
             <tig:Title>TestValue[dec9084fddea46ae986ec28bda35f2f1]</tig:Title>
             <tig:Text>TestValue[c920c2fc1e4d4fcdb8d01f9e1d1df094]</tig:Text>
             <tig:Required>true</tig:Required>
             <tig:DrawFromSet>1</tig:DrawFromSet>
             <tig:SetId>1</tig:SetId>
         </api1:request>
      </api1:CreateScreen>
   </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:Screen>
                <b:CreateDate>2018-12-16T11:50:53.2230879Z</b:CreateDate>
                <b:ModifyDate>2018-12-16T11:50:53.2230879Z</b:ModifyDate>
                <b:SurveyId>0</b:SurveyId>
  </b:Screen>
</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}/screens? HTTP/1.1
Accept-Encoding: gzip,deflate
Content-Type: application/json; charset=utf-8
Authorization: Bearer [YOUR SUPER SECURE TOKEN]
Content-Length: 726
Host: [CallHost]
Connection: Keep-Alive
User-Agent: Apache-HttpClient/4.1.1 (java 1.5)-
 
[{
 "Id" : 1,
 "SurveyId" : 1,
 "Progress" : 1,
 "ModifyDate" : "2018-12-16T11:50:53.2230879+00:00",
 "ScreenId" : 1,
 "ScreenName" : "TestValue[b4181781a555481ea4b89119acf1e8d7]",
 "Title" : "TestValue[062b89050c724e548a3d86132682156e]",
 "Text" : "TestValue[99f04ac323c542c993f6a71d6202581b]",
 "Required" : true,
 "DrawFromSet" : 1,
 "SetId" : 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": "2018-12-16T16:25:43.3993437Z",
  "ModifyDate": "2018-12-16T16:25:43.3993437Z"
}]

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.CreateScreen(new PhoenixService.CreateScreenRequest() 
{ 
    Data = new[] 
    { 
        new PhoenixService.Screen() 
        {
          Id = 1,
          SurveyId = 1,
          Progress = 1,
          ModifyDate = DateTime.UtcNow,
          ScreenId = 1,
          ScreenName = "TestValue["Guid.NewGuid().ToString().Replace("-",string.Empty)+"]",
          Title = "TestValue["Guid.NewGuid().ToString().Replace("-",string.Empty)+"]",
          Text = "TestValue["Guid.NewGuid().ToString().Replace("-",string.Empty)+"]",
          Required = true,
          DrawFromSet = 1,
          SetId = 1
        }
    } 
}));