Creates a new Param object required to authenticate end users

Request Parameters

Name Type Description Required?
EntrySetIdSystem.Int32UnavailableNot Required
DataParam[]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:CreateParam xmlns:api1="http://api.phoenixplatform.com">
         <api1:request>
             <tig:Id>1</tig:Id>
             <tig:EntrySetId>1</tig:EntrySetId>
             <tig:ParamTypeId>File</tig:ParamTypeId>
             <tig:Name>TestValue[967b274705424d0883ff02e48e4baae8]</tig:Name>
             <tig:ReportDisplayRank>1</tig:ReportDisplayRank>
             <tig:IsMandatory>true</tig:IsMandatory>
             <tig:IsReported>true</tig:IsReported>
             <tig:ValidationParam>TestValue[bf06a2303d254672ac5bae7378e05314]</tig:ValidationParam>
             <tig:DisplayParam>TestValue[5dc48f535cd542bea8046145332f5481]</tig:DisplayParam>
             <tig:Description>TestValue[d4ffbdac4f2142ce82de4a705e6e89d5]</tig:Description>
             <tig:ValidationError>TestValue[204ca848280a45b4a5fe10f5eeb76097]</tig:ValidationError>
             <tig:IsSummary>true</tig:IsSummary>
             <tig:ModifyDate>2019-11-17T04:05:54.8130754+00:00</tig:ModifyDate>
         </api1:request>
      </api1:CreateParam>
   </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>
      <DataCaptureResponse xmlns="http://api.phoenixplatform.com">
         <DataCaptureResult 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.DataCapture.Model">
              <b:Param>
                <b:CreateDate>2019-11-17T04:05:54.8130754Z</b:CreateDate>
                <b:EntrySetId>0</b:EntrySetId>
                <b:IsMandatory>false</b:IsMandatory>
                <b:IsReported>false</b:IsReported>
                <b:IsSummary>false</b:IsSummary>
                <b:ModifyDate>2019-11-17T04:05:54.8130754Z</b:ModifyDate>
                <b:Name i:nil="true" />
                <b:ReportDisplayRank>0</b:ReportDisplayRank>
  </b:Param>
</b:Data>
            <TotalRecords xmlns="http://schemas.datacontract.org/2004/07/Tigerspike.Phoenix.Services">1</TotalRecords>
         </DataCaptureResult>
      </DataCaptureResponse>
   </s:Body>
</s:Envelope>
Resource URL

Sample Request

POST /projects/{projectid}/entrysets/{entrysetid}/params? HTTP/1.1
Accept-Encoding: gzip,deflate
Content-Type: application/json; charset=utf-8
Authorization: Bearer [YOUR SUPER SECURE TOKEN]
Content-Length: 1086
Host: [CallHost]
Connection: Keep-Alive
User-Agent: Apache-HttpClient/4.1.1 (java 1.5)-
 
[{
 "Id" : 1,
 "EntrySetId" : 1,
 "ParamTypeId" : "Integer",
 "Name" : "TestValue[cf4cfab4449440d8bf2bbe4ee78f0ee6]",
 "ReportDisplayRank" : 1,
 "IsMandatory" : true,
 "IsReported" : true,
 "ValidationParam" : "TestValue[15cbf257f5084d18921a6f4c4e4d3785]",
 "DisplayParam" : "TestValue[79d5682f916b428d8b5d7a262a139787]",
 "Description" : "TestValue[00e72a24123a463bab37de4c64042a83]",
 "ValidationError" : "TestValue[f383a8dddffc4a3e8c23ee19f75e9391]",
 "IsSummary" : true,
 "ModifyDate" : "2019-11-17T04:05:54.8130754+00:00"
}] 
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

[{
  "EntrySetId": 0,
  "Name": null,
  "ReportDisplayRank": 0,
  "IsMandatory": false,
  "IsReported": false,
  "IsSummary": false,
  "CreateDate": "2019-11-17T05:46:20.4492659Z",
  "ModifyDate": "2019-11-17T05:46:20.4492659Z"
}]

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.PhoenixDataCapture.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.IPhoenixDataCaptureService>(configuration);
var response = proxy.Execute(request, o => o.CreateParam(new PhoenixService.CreateParamRequest() 
{ 
    Data = new[] 
    { 
        new PhoenixService.Param() 
        {
          Id = 1,
          EntrySetId = 1,
          ParamTypeId = PhoenixService.ParamTypeEnum.HTML,
          Name = "TestValue["Guid.NewGuid().ToString().Replace("-",string.Empty)+"]",
          ReportDisplayRank = 1,
          IsMandatory = true,
          IsReported = true,
          ValidationParam = "TestValue["Guid.NewGuid().ToString().Replace("-",string.Empty)+"]",
          DisplayParam = "TestValue["Guid.NewGuid().ToString().Replace("-",string.Empty)+"]",
          Description = "TestValue["Guid.NewGuid().ToString().Replace("-",string.Empty)+"]",
          ValidationError = "TestValue["Guid.NewGuid().ToString().Replace("-",string.Empty)+"]",
          IsSummary = true,
          ModifyDate = DateTime.UtcNow
        }
    } 
}));