Name | Type | Description | 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 | ModuleProperties | Filter set that can be applied to the request | Not Required |
Ordering | ModuleOrdering | Ordering that can be applied to the request | Not 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:ListProjectModule xmlns:api1="http://api.phoenixplatform.com"> <api1:request> <tig:Filter> <tig:FilterSetOfModuleProperties> <tig:FilterRules> <tig:FilterRuleOfModuleProperties> <tig:FilterBy>Id</tig:FilterBy> <tig:FilterOperator>IsEqualTo</tig:FilterOperator> <tig:FilterValue>Location</tig:FilterValue> </tig:FilterRuleOfModuleProperties> </tig:FilterRules> </tig:FilterSetOfModuleProperties> </tig:Filter> <tig:Ordering> <tig1:Direction>DESC</tig1:Direction> <tig1:SortBy>Id</tig1:SortBy> </tig:Ordering> <tig:PageNum>1</tig:PageNum> <tig:PageSize>25</tig:PageSize> </api1:request> </api1:ListProjectModule> </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> <ProjectResponse xmlns="http://api.phoenixplatform.com"> <ProjectResult 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.Project.Model"> <b:Module xmlns="http://schemas.datacontract.org/2004/07/Tigerspike.Phoenix.Identity.Model"> <b:CreateDate>2021-03-01T21:25:34.6020143Z</b:CreateDate> <b:IsVisibleInPhoenix>false</b:IsVisibleInPhoenix> <b:ModifyDate>2021-03-01T21:25:34.6020143Z</b:ModifyDate> <b:Name i:nil="true" /> <b:Rank>0</b:Rank> <b:Reference i:nil="true" /> </b:Module> </b:Data> <TotalRecords xmlns="http://schemas.datacontract.org/2004/07/Tigerspike.Phoenix.Services">1</TotalRecords> </ProjectResult> </ProjectResponse> </s:Body> </s:Envelope>
Sample Request
GET ?filter=IsVisibleInPhoenix eq 'true&sortby=Id&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 [{ "Name": null, "Reference": null, "IsVisibleInPhoenix": false, "Rank": 0, "CreateDate": "2021-03-01T22:08:06.0537071Z", "ModifyDate": "2021-03-01T22:08:06.0537071Z" }]
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.PhoenixProject.V1; using Tigerspike.Phoenix.Services.Api; var request = new SoapServiceRequest() { Token = "[YOUR SUPER SECURE TOKEN]" }; var configuration = CustomConfigurationFactory.CreateServiceConfiguration(Assembly.GetExecutingAssembly()); var proxy = new PhoenixServiceHelper<PhoenixService.IPhoenixProjectService>(configuration); var response = proxy.Execute(request, o => o.ListProjectModule(new PhoenixService.ListProjectModuleRequest() { Filter = new[] { new FilterSetOfModuleProperties { FilterRules = new[] { new FilterRuleOfModuleProperties { FilterBy = ModuleProperties.Id, FilterOperator = ComparisonOperators.IsEqualTo, FilterValue = PhoenixService.ModuleEnum.Custom } } } }, Ordering = new OrderingByModuleProperties() { Direction = OrderBy.DESC, SortBy = ModuleProperties.Rank } PageNum = 3, PageSize = 50 }));