Phoenix

CreateComment

Creates a new Comment object required to authenticate end users

Request Parameters

Name Type Description Required?
DataComment[]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:CreateComment xmlns:api1="http://api.phoenixplatform.com">
         <api1:request>
             <tig:Id>1</tig:Id>
             <tig:ProjectId>1</tig:ProjectId>
             <tig:TopicId>1</tig:TopicId>
             <tig:ParentCommentId>1</tig:ParentCommentId>
             <tig:StatusTypeId>Approved</tig:StatusTypeId>
             <tig:PhoenixIdentity_UserId>1</tig:PhoenixIdentity_UserId>
             <tig:Text>TestValue[eacef396a69f437da90096742b4e995e]</tig:Text>
             <tig:Rating_Overall>1</tig:Rating_Overall>
             <tig:ModifyDate>2018-10-15T22:18:09.2117478+00:00</tig:ModifyDate>
             <tig:VoteCount_Overall>1</tig:VoteCount_Overall>
             <tig:Author>TestValue[86ef3a79d3034ba8814513a53f9195f6]</tig:Author>
         </api1:request>
      </api1:CreateComment>
   </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:Comment>
                <b:CreateDate>2018-10-15T22:18:09.2117478Z</b:CreateDate>
                <b:ModifyDate>2018-10-15T22:18:09.2117478Z</b:ModifyDate>
                <b:ProjectId>0</b:ProjectId>
                <b:Rating_Overall>0</b:Rating_Overall>
                <b:Text i:nil="true" />
                <b:TopicId>0</b:TopicId>
                <b:VoteCount_Overall>0</b:VoteCount_Overall>
  </b:Comment>
</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}/comments? HTTP/1.1
Accept-Encoding: gzip,deflate
Content-Type: application/json; charset=utf-8
Authorization: Bearer [YOUR SUPER SECURE TOKEN]
Content-Length: 734
Host: [CallHost]
Connection: Keep-Alive
User-Agent: Apache-HttpClient/4.1.1 (java 1.5)-
 
[{
 "Id" : 1,
 "ProjectId" : 1,
 "TopicId" : 1,
 "ParentCommentId" : 1,
 "StatusTypeId" : "PreApproved",
 "PhoenixIdentity_UserId" : 1,
 "Text" : "TestValue[ead8062c4a7c4396a3cf5237c1864766]",
 "Rating_Overall" : 1,
 "ModifyDate" : "2018-10-15T22:18:09.2107476+00:00",
 "VoteCount_Overall" : 1,
 "Author" : "TestValue[29602544bcce496299a9f0eb38ce5777]"
}]
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

[{
  "ProjectId": 0,
  "TopicId": 0,
  "Text": null,
  "Rating_Overall": 0.0,
  "CreateDate": "2018-10-15T22:21:34.2333814Z",
  "ModifyDate": "2018-10-15T22:21:34.2333814Z",
  "VoteCount_Overall": 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.CreateComment(new PhoenixService.CreateCommentRequest() 
{ 
    Data = new[] 
    { 
        new PhoenixService.Comment() 
        {
          Id = 1,
          ProjectId = 1,
          TopicId = 1,
          ParentCommentId = 1,
          StatusTypeId = PhoenixService.StatusTypeEnum.Pending,
          PhoenixIdentity_UserId = 1,
          Text = "TestValue["Guid.NewGuid().ToString().Replace("-",string.Empty)+"]",
          Rating_Overall = 1,
          ModifyDate = DateTime.UtcNow,
          VoteCount_Overall = 1,
          Author = "TestValue["Guid.NewGuid().ToString().Replace("-",string.Empty)+"]"
        }
    } 
}));