Name | Type | Description | Required? |
---|---|---|---|
SubscribedOnly | System.Boolean | Unavailable | Not Required |
SectionFilter | SectionProperties | Unavailable | Not Required |
EditionFilter | EditionProperties | Unavailable | Not Required |
SearchTerm | System.String | Unavailable | Not Required |
PageSize | System.Int32 | the maximum number of results to return | Not Required |
PageNum | System.Int32 | the 0-based page index of the results to return | Not Required |
Expand | System.String[] | The collection to expand and return in the response | Not Required |
Filter | ArticleProperties | Filter set that can be applied to the request | Not Required |
Ordering | ArticleOrdering | Ordering that can be applied to the request | Not Required |
ProjectId | System.Int32 | Unavailable | Required |
ProjectId | System.Int32 | Unavailable | Required |
Name | Type | Description | Required? | ProjectId | System.Int32 | Id | Required |
---|
<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:ListArticle xmlns:api1="http://api.phoenixplatform.com"> <api1:request> <tig:Filter> <tig:FilterSetOfArticleProperties> <tig:FilterRules> <tig:FilterRuleOfArticleProperties> <tig:FilterBy>PublishDate</tig:FilterBy> <tig:FilterOperator>IsEqualTo</tig:FilterOperator> <tig:FilterValue>2019-02-16T21:31:42.7776753+00:00</tig:FilterValue> </tig:FilterRuleOfArticleProperties> </tig:FilterRules> </tig:FilterSetOfArticleProperties> </tig:Filter> <tig:Ordering> <tig1:Direction>DESC</tig1:Direction> <tig1:SortBy>CreateDate</tig1:SortBy> </tig:Ordering> <tig:PageNum>1</tig:PageNum> <tig:PageSize>25</tig:PageSize> </api1:request> </api1:ListArticle> </soapenv:Body> </soapenv:Envelope>
<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> <SyndicateResponse xmlns="http://api.phoenixplatform.com"> <SyndicateResult 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.Syndicate.Model"> <b:Article> <b:Assets /> <b:CommentCount_Overall>0</b:CommentCount_Overall> <b:ContentData i:nil="true" /> <b:CreateDate>2019-02-16T21:31:42.7776753Z</b:CreateDate> <b:IsActive>false</b:IsActive> <b:ModifyDate>2019-02-16T21:31:42.7776753Z</b:ModifyDate> <b:ProjectId>0</b:ProjectId> <b:PublishDate>0001-01-01T00:00:00</b:PublishDate> <b:Rating_Overall>0</b:Rating_Overall> <b:Title i:nil="true" /> <b:ViewCount_Overall>0</b:ViewCount_Overall> <b:VoteCount_Overall>0</b:VoteCount_Overall> </b:Article> </b:Data> <TotalRecords xmlns="http://schemas.datacontract.org/2004/07/Tigerspike.Phoenix.Services">1</TotalRecords> </SyndicateResult> </SyndicateResponse> </s:Body> </s:Envelope>
Sample Request
GET /projects/{projectid}/articles?filter=CommentCount_Overall eq '"1"&sortby=CommentCount_Overall&sortdir=desc&pageNum=1&pageSize=25 HTTP/1.1 Accept-Encoding: gzip,deflate Content-Type: application/json; charset=utf-8 Authorization: Bearer [YOUR SUPER SECURE TOKEN] Content-Length: 0 Host: [CallHost] Connection: Keep-Alive User-Agent: Apache-HttpClient/4.1.1 (java 1.5)-
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 [{ "Title": null, "ContentData": null, "PublishDate": "0001-01-01T00:00:00", "IsActive": false, "ViewCount_Overall": 0, "VoteCount_Overall": 0, "Rating_Overall": 0.0, "CommentCount_Overall": 0, "CreateDate": "2019-02-17T02:36:32.7417065Z", "ModifyDate": "2019-02-17T02:36:32.7417065Z", "ProjectId": 0, "Assets": [] }]
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.PhoenixSyndicate.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.IPhoenixSyndicateService>(configuration); var response = proxy.Execute(request, o => o.ListArticle(new PhoenixService.ListArticleRequest() { Filter = new[] { new FilterSetOfArticleProperties { FilterRules = new[] { new FilterRuleOfArticleProperties { FilterBy = ArticleProperties.Title, FilterOperator = ComparisonOperators.IsEqualTo, FilterValue = "TestValue["Guid.NewGuid().ToString().Replace("-",string.Empty)+"]" } } } }, Ordering = new OrderingByArticleProperties() { Direction = OrderBy.DESC, SortBy = ArticleProperties.VoteCount_Overall } PageNum = 3, PageSize = 50 }));