Skip to content
This repository has been archived by the owner on Feb 28, 2024. It is now read-only.

.Net NuGet package that allows connecting to GMC's read-only REST web services.

Notifications You must be signed in to change notification settings

Compassion/GmcRestServicesClient

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

27 Commits
 
 
 
 
 
 
 
 

Repository files navigation

GmcRestServicesClient

.Net NuGet package that allows connecting to GMC's Mashery read-only REST web services. For GMC's new Compassion Connect web services, a new package has been created.

Installation

  1. Add Compassion Australia's MyGet feed as a NuGet package source in Visual Studio.
  1. Install the package "GMC Rest Services Client".
  2. Configure settings in App.config. The NuGet package will try to add two appSettings configuration keys. It may fail, though, in which case these will need to be added manually. The settings are:
  • "GmcRestServicesUrl" - This is the URL of the Marshery web service. Defaults to the test environment ("https://api2.compassion.com/iptest/ci/v1/").
  • "GmcRestServicesClientApiKey" - The Mashery API key to access the web service. Default is empty.

Usage

To use, simply instantiate the GmcRestService class. All methods documented in the Private REST Services documentation on Mashery should be implemented.

Issues

  • A lot of data fields are typed as strings when they might be possible to be parsed as ints, decimals, etc.
  • The REST service returns date/times with the GMC timezone in them. This has been stripped, because in most cases only the date is important. The client web service library we use, RestSharp, converts the dates to the local timezone, which sometimes meant dates changed days.

About

.Net NuGet package that allows connecting to GMC's read-only REST web services.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •