StarRezConnector 1.0.1

.NET 8.0 This package targets .NET 8.0. The package is compatible with this framework or higher. 
dotnet add package StarRezConnector --version 1.0.1
                    


                    

                
NuGet\Install-Package StarRezConnector -Version 1.0.1
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="StarRezConnector" Version="1.0.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="StarRezConnector" Version="1.0.1" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="StarRezConnector" />
                    


                            Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package. 
paket add StarRezConnector --version 1.0.1
                    


                    

                
#r "nuget: StarRezConnector, 1.0.1"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
#:package StarRezConnector@1.0.1
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package. 
#addin nuget:?package=StarRezConnector&version=1.0.1
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=StarRezConnector&version=1.0.1
                    


                            Install as a Cake Tool

The StarRezConnector is something I created to make interfacing with the StarRez RestAPI a easier as it is something I do a lot.

Also please forgive the fact I'm terrible at writing documentation.

To use the connector you first must declare a connector and what it is to be used for, an example is: StarRezRequest srRequest = new StarRezRequest("APIURL", "Action", "APIUsername", "APIKey", "Table", "Item");

The elements are: APIURL - This is normally "https://company.starrezhousing.com/StarRezREST" where company is replaced by your company name or abbrivation, you can get this from StarCare if you are unsure. Action - There are "select", "update", "create", "report", "function" (More details below). APIUsername - This is exactly what you expect APIKey - This is exactly what you expect Table - This is used for the create, update and function actions to select the table to run on and is not required in other cases. Item - This is used in the update and function actions to select the record and is not required in other cases.

The actions do as follows: select - For passing StarQL statements update - Updates a record create - Creates a record report - Retrives a report created in the Report Generator (version 1 or 2) function - Runs a function such as check in

The functions available are "GetResponse" and "XMLtoTable". XMLtoTable converts the XML response to a datatable and cannot be run until after "GetResponse". "GetResponse" handles the actual communication with StarRez and has the following arguments.

srRequest.GetResponse("ReportId", "Function", "Poststring")

A full example to get a specific Entry would be.

StarRezRequest srGetEntry = new StarRezRequest("https://company.starrezhousing.com/StarRezREST", "select", "Username", "Key"); var Testvar = await srGetEntry.GetResponse(poststring: @"SELECT EntryId FROM Entry WHERE EntryId = 1"); srGetEntry.XMLtoTable();

You can then access the response table with: srGetEntry.ResponseTable

Hopefully that makes sense if it doesn't tell me and I'll rewrite this.

Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

  • net8.0

    • No dependencies.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
1.0.1 228 2/25/2025