Skip to content

Commit

Permalink
Merge pull request #60 from tranpl/master
Browse files Browse the repository at this point in the history 
Fix bug with DeleteRecordsAsync method
  • Loading branch information
@tranpl
tranpl authored Jul 24, 2018
2 parents aa4b107 + 3bbfea4 commit 14863f7
Show file tree
Hide file tree
Showing 4 changed files with 201 additions and 84 deletions.
6 changes: 5 additions & 1 deletion RedcapApi/Api/Redcap.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1760,7 +1760,11 @@ public async Task<string> DeleteRecordsAsync(string token, string content, strin
{ "action", action}
};
// Required
payload.Add("records", await this.ConvertArraytoString(records));
//payload.Add("records", await this.ConvertArraytoString(records));
for (var i = 0; i < records.Length; i++)
{
payload.Add($"records[{i}]", records[i]);
}

// Optional
payload.Add("arm", arm?.ToString());
Expand Down
15 changes: 9 additions & 6 deletions RedcapApi/Redcap.csproj
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,25 +7,28 @@
<GeneratePackageOnBuild>True</GeneratePackageOnBuild>
<RepositoryUrl>https://github.com/cctrbic/redcap-api</RepositoryUrl>
<PackageProjectUrl>https://github.com/cctrbic/redcap-api</PackageProjectUrl>
<Description>This library allows applications on .NET to make calls to REDCap instances.</Description>
<Description>This library allows applications on the .NET platform to make http calls to REDCap instances.</Description>
<Product>Redcap Api Library</Product>
<PackageId>RedcapAPI</PackageId>
<Version>1.0.1-beta</Version>
<AssemblyVersion>1.0.1.0</AssemblyVersion>
<PackageTags>redcap</PackageTags>
<PackageReleaseNotes>100% API Method Coverage</PackageReleaseNotes>
<Version>1.0.2-beta</Version>
<AssemblyVersion>1.0.2.0</AssemblyVersion>
<PackageTags>redcap api library</PackageTags>
<PackageReleaseNotes>1. Fixed bug with DeleteRecordsAsync method
2. Added additional tests and demo
</PackageReleaseNotes>
<PackageRequireLicenseAcceptance>false</PackageRequireLicenseAcceptance>
<ApplicationIcon />
<OutputType>Library</OutputType>
<StartupObject />
<NeutralLanguage>en</NeutralLanguage>
</PropertyGroup>

<PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|AnyCPU'">
<Optimize>true</Optimize>
<DocumentationFile>bin\Debug\netcoreapp2.0\Redcap.xml</DocumentationFile>
<DebugType>portable</DebugType>
<DebugSymbols>true</DebugSymbols>
<PlatformTarget>x64</PlatformTarget>
<PlatformTarget>AnyCPU</PlatformTarget>
</PropertyGroup>

<PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release|AnyCPU'">
Expand Down
98 changes: 74 additions & 24 deletions RedcapApiDemo/Program.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,16 +3,29 @@
using Redcap.Models;
using System;
using System.Collections.Generic;
using System.Linq;

namespace RedcapApiDemo
{
public class Demographic
{
[JsonRequired]
[JsonProperty("record_id")]
public string RecordId { get; set; }

[JsonProperty("first_name")]
public string FirstName { get; set; }

[JsonProperty("last_name")]
public string LastName { get; set; }
}
class Program
{
/*
* Change this token for your demo project
* Using one created from a local dev instance
*/
private const string _token = "A8E6949EF4380F1111C66D5374E1AE6C";
private const string _token = "4AAE216218B33700456A30898F2D6417";
/*
* Change this token for your demo project
* Using one created from a local dev instance
Expand Down Expand Up @@ -53,6 +66,7 @@ static void Main(string[] args)
var redcapApi = new RedcapApi(_token, _uri);

Console.WriteLine("Calling API Methods < 1.0.0");

Console.WriteLine("Calling GetRecordAsync() . . .");
var GetRecordAsync = redcapApi.GetRecordAsync("1", ReturnFormat.json, RedcapDataType.flat, OnErrorFormat.json, null, null, null, null).Result;
var GetRecordAsyncData = JsonConvert.DeserializeObject(GetRecordAsync);
Expand Down Expand Up @@ -129,36 +143,72 @@ static void Main(string[] args)
// Make a sound!
Console.Beep();

Console.WriteLine("Starting demo for API Version 1.0.0");



Console.WriteLine("-----------------------------Starting API Version 1.0.2-------------");
Console.WriteLine("Starting demo for API Version 1.0.0+");

Console.ReadLine();
Console.WriteLine("----------------------------Press Enter to Continue-------------");







Console.WriteLine("Creating a new instance of RedcapApi");
var redcap_api_1_0_0 = new RedcapApi(_uri);
var redcap_api_1_0_2 = new RedcapApi(_uri);

#region ImportRecordsAsync()
Console.WriteLine("Calling ImportRecordsAsync() . . .");
/*
* Create a list of object of type instrument or fields. Add its properties then add it to the list.
* record_id is required
*/
var data = new List<Demographic> { new Demographic {FirstName = "Jon", LastName = "Doe", RecordId = "1" } };
Console.WriteLine($"Importing record {string.Join(",", data.Select(x=>x.RecordId).ToList())} . . .");
var ImportRecordsAsync = redcapApi.ImportRecordsAsync(_token, null, ReturnFormat.json, RedcapDataType.flat, OverwriteBehavior.normal, false, data, "MDY", ReturnContent.count, OnErrorFormat.json).Result;
var ImportRecordsAsyncData = JsonConvert.DeserializeObject(ImportRecordsAsync);
Console.WriteLine($"ImportRecordsAsync Result: {ImportRecordsAsyncData}");
#endregion ImportRecordsAsync()


#region DeleteRecordsAsync()
Console.WriteLine("Calling DeleteRecordsAsync() . . .");
var records = new string[] { "1" };
Console.WriteLine($"Deleting record {string.Join(",", records)} . . .");
var DeleteRecordsAsync = redcapApi.DeleteRecordsAsync(_token, null, null, records, 1).Result;
var DeleteRecordsAsyncData = JsonConvert.DeserializeObject(DeleteRecordsAsync);
Console.WriteLine($"DeleteRecordsAsync Result: {DeleteRecordsAsyncData}");
#endregion DeleteRecordsAsync()

#region ExportArmsAsync()
var arms = new string[] {};
Console.WriteLine("Calling ExportArmsAsync()");
var ExportArmsAsyncResult = redcap_api_1_0_0.ExportArmsAsync(_token, "arm", ReturnFormat.json, arms, OnErrorFormat.json).Result;
var ExportArmsAsyncResult = redcap_api_1_0_2.ExportArmsAsync(_token, "arm", ReturnFormat.json, arms, OnErrorFormat.json).Result;
Console.WriteLine($"ExportArmsAsyncResult: {ExportArmsAsyncResult}");
#endregion ExportArmsAsync()

#region ImportArmsAsync()
var ImportArmsAsyncData = new List<RedcapArm>{ new RedcapArm {arm_num = "1", name = "hooo" }, new RedcapArm { arm_num = "2", name = "heee" }, new RedcapArm { arm_num = "3", name = "hawww" } };
Console.WriteLine("Calling ImportArmsAsync()");
var ImportArmsAsyncResult = redcap_api_1_0_0.ImportArmsAsync(_token, "arm", Override.False, null, ReturnFormat.json, ImportArmsAsyncData, OnErrorFormat.json).Result;
var ImportArmsAsyncResult = redcap_api_1_0_2.ImportArmsAsync(_token, "arm", Override.False, null, ReturnFormat.json, ImportArmsAsyncData, OnErrorFormat.json).Result;
Console.WriteLine($"ImportArmsAsyncResult: {ImportArmsAsyncResult}");
#endregion ImportArmsAsync()

#region DeleteArmsAsync()
var DeleteArmsAsyncData = new string[] {"3"};
Console.WriteLine("Calling DeleteArmsAsync()");
var DeleteArmsAsyncResult = redcap_api_1_0_0.DeleteArmsAsync(_token, "arm", "delete", DeleteArmsAsyncData).Result;
var DeleteArmsAsyncResult = redcap_api_1_0_2.DeleteArmsAsync(_token, "arm", "delete", DeleteArmsAsyncData).Result;
Console.WriteLine($"DeleteArmsAsyncResult: {DeleteArmsAsyncResult}");
#endregion DeleteArmsAsync()

#region ExportEventsAsync()
var ExportEventsAsyncData = new string[] { "1" };
Console.WriteLine("Calling ExportEventsAsync()");
var ExportEventsAsyncResult = redcap_api_1_0_0.ExportEventsAsync(_token, "event", ReturnFormat.json, ExportEventsAsyncData, OnErrorFormat.json).Result;
var ExportEventsAsyncResult = redcap_api_1_0_2.ExportEventsAsync(_token, "event", ReturnFormat.json, ExportEventsAsyncData, OnErrorFormat.json).Result;
Console.WriteLine($"ExportEventsAsyncResult: {ExportEventsAsyncResult}");
#endregion ExportEventsAsync()

Expand All @@ -184,20 +234,20 @@ static void Main(string[] args)
custom_event_label = "hello clinical"
}
};
var ImportEventsAsyncResult = redcap_api_1_0_0.ImportEventsAsync(_token, "event", "import", Override.False, ReturnFormat.json, eventList, OnErrorFormat.json).Result;
var ImportEventsAsyncResult = redcap_api_1_0_2.ImportEventsAsync(_token, "event", "import", Override.False, ReturnFormat.json, eventList, OnErrorFormat.json).Result;
Console.WriteLine($"ImportEventsAsyncResult: {ImportEventsAsyncResult}");
#endregion ImportEventsAsync()

#region DeleteEventsAsync()
var DeleteEventsAsyncData = new string[] { "baseline_arm_1" };
Console.WriteLine("Calling DeleteEventsAsync()");
var DeleteEventsAsyncResult = redcap_api_1_0_0.DeleteEventsAsync(_token, "event", "delete", DeleteEventsAsyncData ).Result;
var DeleteEventsAsyncResult = redcap_api_1_0_2.DeleteEventsAsync(_token, "event", "delete", DeleteEventsAsyncData ).Result;
Console.WriteLine($"DeleteEventsAsyncResult: {DeleteEventsAsyncResult}");
#endregion DeleteEventsAsync()

#region ExportFieldNamesAsync()
Console.WriteLine("Calling ExportFieldNamesAsync(), first_name");
var ExportFieldNamesAsyncResult = redcap_api_1_0_0.ExportFieldNamesAsync(_token, "exportFieldNames", ReturnFormat.json, "first_name", OnErrorFormat.json).Result;
var ExportFieldNamesAsyncResult = redcap_api_1_0_2.ExportFieldNamesAsync(_token, "exportFieldNames", ReturnFormat.json, "first_name", OnErrorFormat.json).Result;
Console.WriteLine($"ExportFieldNamesAsyncResult: {ExportFieldNamesAsyncResult}");
#endregion ExportFieldNamesAsync()

Expand All @@ -208,67 +258,67 @@ static void Main(string[] args)
var eventName = "clinical_arm_1";
var fileUploadPath = @"C:\redcap_upload_files";
Console.WriteLine($"Calling ImportFileAsync(), {fileName}");
var ImportFileAsyncResult = redcap_api_1_0_0.ImportFileAsync(_token, "file", "import", recordId, fieldName, eventName, null, fileName, fileUploadPath, OnErrorFormat.json).Result;
var ImportFileAsyncResult = redcap_api_1_0_2.ImportFileAsync(_token, "file", "import", recordId, fieldName, eventName, null, fileName, fileUploadPath, OnErrorFormat.json).Result;
Console.WriteLine($"ImportFileAsyncResult: {ImportFileAsyncResult}");
#endregion ImportFileAsync()


#region ExportFileAsync()
Console.WriteLine($"Calling ExportFileAsync(), {fileName} for field name {fieldName}, not save the file.");
var ExportFileAsyncResult = redcap_api_1_0_0.ExportFileAsync(_token, "file", "export", recordId, fieldName, eventName, null, OnErrorFormat.json).Result;
var ExportFileAsyncResult = redcap_api_1_0_2.ExportFileAsync(_token, "file", "export", recordId, fieldName, eventName, null, OnErrorFormat.json).Result;
Console.WriteLine($"ExportFileAsyncResult: {ExportFileAsyncResult}");
#endregion ExportFileAsync()


#region ExportFileAsync()
var filedDownloadPath = @"C:\redcap_download_files";
Console.WriteLine($"Calling ExportFileAsync(), {fileName} for field name {fieldName}, saving the file.");
var ExportFileAsyncResult2 = redcap_api_1_0_0.ExportFileAsync(_token, "file", "export", recordId, fieldName, eventName, null, OnErrorFormat.json, filedDownloadPath).Result;
var ExportFileAsyncResult2 = redcap_api_1_0_2.ExportFileAsync(_token, "file", "export", recordId, fieldName, eventName, null, OnErrorFormat.json, filedDownloadPath).Result;
Console.WriteLine($"ExportFileAsyncResult2: {ExportFileAsyncResult2}");
#endregion ExportFileAsync()

#region DeleteFileAsync()
Console.WriteLine($"Calling DeleteFileAsync(), deleting file: {fileName} for field: {fieldName}");
var DeleteFileAsyncResult = redcap_api_1_0_0.DeleteFileAsync(_token, "file", "delete", recordId, fieldName, eventName, "1", OnErrorFormat.json).Result;
var DeleteFileAsyncResult = redcap_api_1_0_2.DeleteFileAsync(_token, "file", "delete", recordId, fieldName, eventName, "1", OnErrorFormat.json).Result;
Console.WriteLine($"DeleteFileAsyncResult: {DeleteFileAsyncResult}");
#endregion DeleteFileAsync()

#region ExportInstrumentsAsync()
Console.WriteLine($"Calling DeleteFileAsync()");
var ExportInstrumentsAsyncResult = redcap_api_1_0_0.ExportInstrumentsAsync(_token, "instrument", ReturnFormat.json).Result;
var ExportInstrumentsAsyncResult = redcap_api_1_0_2.ExportInstrumentsAsync(_token, "instrument", ReturnFormat.json).Result;
Console.WriteLine($"ExportInstrumentsAsyncResult: {ExportInstrumentsAsyncResult}");
#endregion ExportInstrumentsAsync()

#region ExportPDFInstrumentsAsync()
Console.WriteLine($"Calling ExportPDFInstrumentsAsync(), returns raw");
var ExportPDFInstrumentsAsyncResult = redcap_api_1_0_0.ExportPDFInstrumentsAsync(_token, "pdf", recordId, eventName, "demographics", true, OnErrorFormat.json).Result;
var ExportPDFInstrumentsAsyncResult = redcap_api_1_0_2.ExportPDFInstrumentsAsync(_token, "pdf", recordId, eventName, "demographics", true, OnErrorFormat.json).Result;
Console.WriteLine($"ExportInstrumentsAsyncResult: {JsonConvert.SerializeObject(ExportPDFInstrumentsAsyncResult)}");
#endregion ExportPDFInstrumentsAsync()


#region ExportPDFInstrumentsAsync()
Console.WriteLine($"Calling ExportPDFInstrumentsAsync(), saving pdf file to {filedDownloadPath}");
var ExportPDFInstrumentsAsyncResult2 = redcap_api_1_0_0.ExportPDFInstrumentsAsync(_token, "pdf", recordId, eventName, "demographics", true, filedDownloadPath, OnErrorFormat.json).Result;
var ExportPDFInstrumentsAsyncResult2 = redcap_api_1_0_2.ExportPDFInstrumentsAsync(_token, "pdf", recordId, eventName, "demographics", true, filedDownloadPath, OnErrorFormat.json).Result;
Console.WriteLine($"ExportPDFInstrumentsAsyncResult2: {ExportPDFInstrumentsAsyncResult2}");
#endregion ExportPDFInstrumentsAsync()


#region ExportInstrumentMappingAsync()
Console.WriteLine($"Calling ExportInstrumentMappingAsync()");
var ExportInstrumentMappingAsyncResult = redcap_api_1_0_0.ExportInstrumentMappingAsync(_token, "formEventMapping", ReturnFormat.json, arms, OnErrorFormat.json).Result;
var ExportInstrumentMappingAsyncResult = redcap_api_1_0_2.ExportInstrumentMappingAsync(_token, "formEventMapping", ReturnFormat.json, arms, OnErrorFormat.json).Result;
Console.WriteLine($"ExportInstrumentMappingAsyncResult: {ExportInstrumentMappingAsyncResult}");
#endregion ExportInstrumentMappingAsync()

#region ImportInstrumentMappingAsync()
var importInstrumentMappingData = new List<FormEventMapping>{new FormEventMapping {arm_num = "1", unique_event_name = "clinical_arm_1", form= "demographics" } };
Console.WriteLine($"Calling ImportInstrumentMappingAsync()");
var ImportInstrumentMappingAsyncResult = redcap_api_1_0_0.ImportInstrumentMappingAsync(_token, "formEventMapping", ReturnFormat.json, importInstrumentMappingData, OnErrorFormat.json).Result;
var ImportInstrumentMappingAsyncResult = redcap_api_1_0_2.ImportInstrumentMappingAsync(_token, "formEventMapping", ReturnFormat.json, importInstrumentMappingData, OnErrorFormat.json).Result;
Console.WriteLine($"ImportInstrumentMappingAsyncResult: {ImportInstrumentMappingAsyncResult}");
#endregion ImportInstrumentMappingAsync()

#region ExportMetaDataAsync()
Console.WriteLine($"Calling ExportMetaDataAsync()");
var ExportMetaDataAsyncResult = redcap_api_1_0_0.ExportMetaDataAsync(_token, "metadata", ReturnFormat.json, null, null, OnErrorFormat.json).Result;
var ExportMetaDataAsyncResult = redcap_api_1_0_2.ExportMetaDataAsync(_token, "metadata", ReturnFormat.json, null, null, OnErrorFormat.json).Result;
Console.WriteLine($"ExportMetaDataAsyncResult: {ExportMetaDataAsyncResult}");
#endregion ExportMetaDataAsync()

Expand All @@ -278,30 +328,30 @@ static void Main(string[] args)
*/
var importMetaData = new List<RedcapMetaData> { new RedcapMetaData { field_name = "first_name", form_name = "demographics", field_type = "text", field_label = "First Name" } };
Console.WriteLine($"Not calling ImportMetaDataAsync(), still change data dictionary to include 1 field");
//var ImportMetaDataAsyncResult = redcap_api_1_0_0.ImportMetaDataAsync(_token, "metadata", ReturnFormat.json, importMetaData, OnErrorFormat.json).Result;
//var ImportMetaDataAsyncResult = redcap_api_1_0_2.ImportMetaDataAsync(_token, "metadata", ReturnFormat.json, importMetaData, OnErrorFormat.json).Result;
//Console.WriteLine($"ImportMetaDataAsyncResult: {ImportMetaDataAsyncResult}");
#endregion ImportMetaDataAsync()

#region CreateProjectAsync()
var projectData = new List<RedcapProject> { new RedcapProject {project_title = "Amazing Project ", purpose = ProjectPurpose.Other, purpose_other = "Test"} };
Console.WriteLine($"Calling CreateProjectAsync(), creating a new project with Amazing Project as title, purpose 1 (other) ");
Console.WriteLine($"-----------------------Notice the use of SUPER TOKEN------------------------");
var CreateProjectAsyncResult = redcap_api_1_0_0.CreateProjectAsync(_superToken, "project", ReturnFormat.json, projectData, OnErrorFormat.json, null).Result;
var CreateProjectAsyncResult = redcap_api_1_0_2.CreateProjectAsync(_superToken, "project", ReturnFormat.json, projectData, OnErrorFormat.json, null).Result;
Console.WriteLine($"CreateProjectAsyncResult: {CreateProjectAsyncResult}");
#endregion CreateProjectAsync()


#region ImportProjectInfoAsync()
var projectInfo = new RedcapProjectInfo { project_title = "Updated Amazing Project ", purpose = ProjectPurpose.QualityImprovement, surveys_enabled = 1 };
Console.WriteLine($"Calling ImportProjectInfoAsync()");
var ImportProjectInfoAsyncResult = redcap_api_1_0_0.ImportProjectInfoAsync(_token, "project_settings", ReturnFormat.json, projectInfo).Result;
var ImportProjectInfoAsyncResult = redcap_api_1_0_2.ImportProjectInfoAsync(_token, "project_settings", ReturnFormat.json, projectInfo).Result;
Console.WriteLine($"ImportProjectInfoAsyncResult: {ImportProjectInfoAsyncResult}");
#endregion ImportProjectInfoAsync()


#region ExportProjectInfoAsync()
Console.WriteLine($"Calling ExportProjectInfoAsync()");
var ExportProjectInfoAsyncResult = redcap_api_1_0_0.ExportProjectInfoAsync(_token, "project_settings", ReturnFormat.json).Result;
var ExportProjectInfoAsyncResult = redcap_api_1_0_2.ExportProjectInfoAsync(_token, "project_settings", ReturnFormat.json).Result;
Console.WriteLine($"ExportProjectInfoAsyncResult: {ExportProjectInfoAsyncResult}");
#endregion ExportProjectInfoAsync()

Expand Down
Loading

0 comments on commit 14863f7

Please sign in to comment.