Skip to content

Commit 74091cd

Browse files
authored
Merge pull request #11 from tranpl/master
doc change
2 parents 3a1541d + ac5bcd9 commit 74091cd

File tree

2 files changed

+18
-2
lines changed

2 files changed

+18
-2
lines changed

README.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,18 @@ __Usage__:
88
3. Add "using Redcap.Interfaces" namespace (contains some enums for redcap optional params)
99
4. instantiate a new instance of the redcapapi object
1010

11-
```C# __var rc = new Redcap.RedcapApi("redcap token here", "your redcap api endpoint here")__```
11+
__Example__
12+
```C#
1213

13-
```C# __var version = await rc.GetRedcapVersionAsync(RedcapFormat.json, RedcapDataType.flat);__```
14+
var rc = new Redcap.RedcapApi("redcap token here", "your redcap api endpoint here")
15+
16+
```
17+
18+
```C#
19+
20+
var version = await rc.GetRedcapVersionAsync(RedcapFormat.json, RedcapDataType.flat);
21+
22+
```
1423

1524
__Install directly in Package Manager Console__
1625

RedcapApi/Api/Redcap.cs

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -156,6 +156,13 @@ public async Task<string> GetMetaDataAsync(RedcapFormat? redcapFormat, ReturnFor
156156
return String.Empty;
157157
}
158158
}
159+
///
160+
/// <summary>
161+
///The method hands the return content from a request, the response.
162+
/// The method allows the calling method to choose a return type.
163+
/// </summary>
164+
/// <param name="returnContent"></param>
165+
/// <returns></returns>
159166
private async Task<string> HandleReturnContent(ReturnContent returnContent = ReturnContent.count)
160167
{
161168
try

0 commit comments

Comments
 (0)