Phoenix Developers

Creates a new Report object required to authenticate end users

Request Parameters

Name	Type	Description	Required?
EntrySetId	System.Int32	Unavailable	Not Required
Data	Report[]	Unavailable	Required
ProjectId	System.Int32	Unavailable	Required
ProjectId	System.Int32	Unavailable	Required

Validation

Name	Type	Description	Required?
ProjectId	System.Int32	Id	Required

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:CreateReport xmlns:api1="http://api.phoenixplatform.com">
         <api1:request>
             <tig:Id>1</tig:Id>
             <tig:ReportTypeId>1</tig:ReportTypeId>
             <tig:EntrySetId>1</tig:EntrySetId>
             <tig:ReportName>TestValue[74a70de6f5b44c2d9072b281f2afe68d]</tig:ReportName>
             <tig:ReportPath>TestValue[4aa3275011a44a2c8c79d9946290305e]</tig:ReportPath>
             <tig:ModifyDate>2018-10-15T22:18:08.6237009+00:00</tig:ModifyDate>
         </api1:request>
      </api1:CreateReport>
   </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:Report>
                <b:CreateDate>2018-10-15T22:18:08.6237009Z</b:CreateDate>
                <b:EntrySetId>0</b:EntrySetId>
                <b:ModifyDate>2018-10-15T22:18:08.6237009Z</b:ModifyDate>
                <b:ReportName i:nil="true" />
                <b:ReportPath i:nil="true" />
                <b:ReportTypeId>0</b:ReportTypeId>
  </b:Report>
</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}/reports? HTTP/1.1
Accept-Encoding: gzip,deflate
Content-Type: application/json; charset=utf-8
Authorization: Bearer [YOUR SUPER SECURE TOKEN]
Content-Length: 482
Host: [CallHost]
Connection: Keep-Alive
User-Agent: Apache-HttpClient/4.1.1 (java 1.5)-
 
[{
 "Id" : 1,
 "ReportTypeId" : 1,
 "EntrySetId" : 1,
 "ReportName" : "TestValue[72e3c2e132414ae5aba131bd0dee7abe]",
 "ReportPath" : "TestValue[78497b2059404ee0bf0f554926c13fad]",
 "ModifyDate" : "2018-10-15T22:18:08.6237009+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

[{
  "ReportTypeId": 0,
  "EntrySetId": 0,
  "ReportName": null,
  "ReportPath": null,
  "CreateDate": "2018-10-15T22:21:01.2490622Z",
  "ModifyDate": "2018-10-15T22:21:01.2490622Z"
}]

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.CreateReport(new PhoenixService.CreateReportRequest() 
{ 
    Data = new[] 
    { 
        new PhoenixService.Report() 
        {
          Id = 1,
          ReportTypeId = 1,
          EntrySetId = 1,
          ReportName = "TestValue["Guid.NewGuid().ToString().Replace("-",string.Empty)+"]",
          ReportPath = "TestValue["Guid.NewGuid().ToString().Replace("-",string.Empty)+"]",
          ModifyDate = DateTime.UtcNow
        }
    } 
}));