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>Integer</tig:ParamTypeId>
             <tig:Name>TestValue[589d625343ad428cb8e60461b6d1bf74]</tig:Name>
             <tig:ReportDisplayRank>1</tig:ReportDisplayRank>
             <tig:IsMandatory>true</tig:IsMandatory>
             <tig:IsReported>true</tig:IsReported>
             <tig:ValidationParam>TestValue[9c3b3232fed041a19636fdff1950c482]</tig:ValidationParam>
             <tig:DisplayParam>TestValue[fff60f38d4324597a9f776dd6f9d7b52]</tig:DisplayParam>
             <tig:Description>TestValue[c9d03a728cb647d8bdb1ea1b8e55261e]</tig:Description>
             <tig:ValidationError>TestValue[2d11939c77ec4b52b5efd1066b4794db]</tig:ValidationError>
             <tig:IsSummary>true</tig:IsSummary>
             <tig:ModifyDate>2018-10-15T22:18:08.5926970+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>2018-10-15T22:18:08.592697Z</b:CreateDate>
                <b:EntrySetId>0</b:EntrySetId>
                <b:IsMandatory>false</b:IsMandatory>
                <b:IsReported>false</b:IsReported>
                <b:IsSummary>false</b:IsSummary>
                <b:ModifyDate>2018-10-15T22:18:08.592697Z</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: 1080
Host: [CallHost]
Connection: Keep-Alive
User-Agent: Apache-HttpClient/4.1.1 (java 1.5)-
 
[{
 "Id" : 1,
 "EntrySetId" : 1,
 "ParamTypeId" : "File",
 "Name" : "TestValue[a83cfd745f3d47de8a3da5d5a0a2e401]",
 "ReportDisplayRank" : 1,
 "IsMandatory" : true,
 "IsReported" : true,
 "ValidationParam" : "TestValue[e41e81f7248f48ed95b26b14662b476a]",
 "DisplayParam" : "TestValue[5c55a117e6284628a9ec0cc266322438]",
 "Description" : "TestValue[7ec6825ee9e14b56b7d9fa7dcb3fc011]",
 "ValidationError" : "TestValue[5cadbce66b67479eaf8fab00a05c01b7]",
 "IsSummary" : true,
 "ModifyDate" : "2018-10-15T22:18:08.5916972+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": "2018-10-15T22:22:38.4887947Z",
  "ModifyDate": "2018-10-15T22:22:38.4887947Z"
}]

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.Image,
          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
        }
    } 
}));