Phoenix

CreateForum

Creates a new Forum object required to authenticate end users

Request Parameters

Name Type Description Required?
DataForum[]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:CreateForum xmlns:api1="http://api.phoenixplatform.com">
         <api1:request>
             <tig:Id>1</tig:Id>
             <tig:ModifyDate>2019-11-14T12:38:24.9178001+00:00</tig:ModifyDate>
             <tig:Name>TestValue[62bd4b49694b4ed8984cc6797a3bd178]</tig:Name>
             <tig:MetaDataParameters>new List<KeyValuePair<string, string>>().ToArray()</tig:MetaDataParameters>
             <tig:DefaultCommentStatusTypeId>Pending</tig:DefaultCommentStatusTypeId>
             <tig:ProjectId>1</tig:ProjectId>
         </api1:request>
      </api1:CreateForum>
   </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>
      <ForumResponse xmlns="http://api.phoenixplatform.com">
         <ForumResult 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.Forum.Model">
              <b:Forum>
                <b:CreateDate>2019-11-14T12:38:24.9178001Z</b:CreateDate>
                <b:ModifyDate>2019-11-14T12:38:24.9178001Z</b:ModifyDate>
                <b:Name i:nil="true" />
                <b:ProjectId>0</b:ProjectId>
  </b:Forum>
</b:Data>
            <TotalRecords xmlns="http://schemas.datacontract.org/2004/07/Tigerspike.Phoenix.Services">1</TotalRecords>
         </ForumResult>
      </ForumResponse>
   </s:Body>
</s:Envelope>
Resource URL

Sample Request

POST /projects/{projectId}/forums? HTTP/1.1
Accept-Encoding: gzip,deflate
Content-Type: application/json; charset=utf-8
Authorization: Bearer [YOUR SUPER SECURE TOKEN]
Content-Length: 540
Host: [CallHost]
Connection: Keep-Alive
User-Agent: Apache-HttpClient/4.1.1 (java 1.5)-
 
[{
 "Id" : 1,
 "ModifyDate" : "2019-11-14T12:38:24.9167996+00:00",
 "Name" : "TestValue[e519f272595c43e39f71b457f88fa5ad]",
 "MetaDataParameters" : new List<KeyValuePair<string, string>>().ToArray(),
 "DefaultCommentStatusTypeId" : "Approved",
 "ProjectId" : 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

[{
  "CreateDate": "2019-11-14T13:26:31.0453821Z",
  "ModifyDate": "2019-11-14T13:26:31.0453821Z",
  "Name": null,
  "ProjectId": 0
}]

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.PhoenixForum.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.IPhoenixForumService>(configuration);
var response = proxy.Execute(request, o => o.CreateForum(new PhoenixService.CreateForumRequest() 
{ 
    Data = new[] 
    { 
        new PhoenixService.Forum() 
        {
          Id = 1,
          ModifyDate = DateTime.UtcNow,
          Name = "TestValue["Guid.NewGuid().ToString().Replace("-",string.Empty)+"]",
          MetaDataParameters = new List<KeyValuePair<string, string>>().ToArray(),
          DefaultCommentStatusTypeId = PhoenixService.StatusTypeEnum.PreApproved,
          ProjectId = 1
        }
    } 
}));