C# Class TourCMS.Utils.marketplaceWrapper

Wrapper class for the XML REST based TourCMS Marketplace API
Datei anzeigen Open project: TourCMS/tourcms-dotnet Class Usage Examples

Protected Properties

Property Type Description
_baseUrl string
_marketplaceId int
_privateKey string

Public Methods

Method Description
ApiRateLimitStatus ( ) : XmlDocument

Check how many requests are left before throttling, handy for checking API connectivity

ApiRateLimitStatus ( int channelId ) : XmlDocument

Check how many requests are left before throttling, handy for checking API connectivity

ChannelPerformance ( ) : XmlDocument

Get the statistics on the top 50 performing Channels (Suppliers)

ChannelPerformance ( int channel ) : XmlDocument

Show details on a specific Channel (Supplier)

CheckCustomerLogin ( string username, string password, int channelId ) : XmlDocument

Validate a Customer Username and Password, retrieve their Name and User ID

CheckTourAvailability ( string queryString, int tourId, int channelId ) : XmlDocument

Check Tour/Hotel availability for a specific number of people on specific rates on a specific date, generally used when making a booking

CommitNewBooking ( XmlDocument bookingData, int channelId ) : XmlDocument

Convert a temporary booking to a confirmed booking

CreateCustomer ( XmlDocument customerData, int channelId ) : XmlDocument

Create a new customer record, optionally include some enquiry data

CreateDeparture ( XmlDocument departureData, int channelId ) : XmlDocument

Create a new departure

CreateEnquiry ( XmlDocument enquiryData, int channelId ) : XmlDocument

Create an enquiry, either with a new customer record or associated with an existing one

CreatePayment ( XmlDocument paymentData, int channelId ) : XmlDocument

Log details of a payment/refund on a booking sales ledger

DeleteDeparture ( int departure, int tourId, int channelId ) : XmlDocument

Update an existing departure

GetBookingRedirectUrl ( XmlDocument urlData, int channelId ) : XmlDocument

Get a redirect URL from TourCMS, send the customer via it to retrieve a booking key, Tour Op use only

ListChannels ( ) : XmlDocument

List all connected Channels (Suppliers)

ListTourImages ( ) : XmlDocument

Get a list of Image URLs, use this if you want to bulk-mirror product images on your own hosting

ListTourImages ( int channelId ) : XmlDocument

Get a list of Image URLs for a specific Channel (Company), use this if you want to bulk-mirror product images on your own hosting

ListTourImages ( string queryString ) : XmlDocument

Get a list of Image URLs for a specific Channel (Company), use this if you want to bulk-mirror product images on your own hosting

ListTourImages ( string queryString, int channelId ) : XmlDocument

Get a list of Image URLs for a specific Channel (Company), use this if you want to bulk-mirror product images on your own hosting

ListTourLocations ( ) : XmlDocument

Retrieve a list of connected tour locations

ListTourLocations ( int channelId ) : XmlDocument

Retrieve a list of connected tour locations for a specific Channel (Company)

ListTourLocations ( string queryString ) : XmlDocument

Retrieve a list of connected tour locations on any connected Channel, with a queryString

ListTourLocations ( string queryString, int channelId ) : XmlDocument

Retrieve a list of connected tour locations for a specific Channel (Company)

ListTours ( ) : XmlDocument

Get a list of Tours with only very basic information. Probably most useful when bulk importing. For a more detailed list use SearchTours

ListTours ( int channelId ) : XmlDocument

Get a list of Tours with only very basic information. Probably most useful when bulk importing. For a more detailed list use SearchTours

ListTours ( int channelId, string queryString ) : XmlDocument

Get a list of Tours with only very basic information. Probably most useful when bulk importing. For a more detailed list use SearchTours

ListTours ( string queryString ) : XmlDocument

Get a list of Tours with only very basic information. Probably most useful when bulk importing. For a more detailed list use SearchTours

LogFailedPayment ( XmlDocument paymentData, int channelId ) : XmlDocument

Log details of a payment/refund on a booking sales ledger

Request ( string path ) : XmlDocument

Make a generic request to the API, most documented calls will have wrappers for this

Request ( string path, int channelId ) : XmlDocument

Make a generic request to the API, most documented calls will have wrappers for this

Request ( string path, int channelId, string verb ) : XmlDocument

Make a generic request to the API, most documented calls will have wrappers for this

Request ( string path, int channelId, string verb, XmlDocument postData ) : XmlDocument

Make a generic request to the API, most documented calls will have wrappers for this

SearchBookings ( ) : XmlDocument

Get a list of all bookings, optionally filter by channel / querystring

SearchBookings ( string queryString ) : XmlDocument

Get a list of all bookings, optionally filter by channel / querystring

SearchBookings ( string queryString, int channelId ) : XmlDocument

Get a list of all bookings, optionally filter by channel / querystring

SearchEnquiries ( ) : XmlDocument

Get a list of enquiries, filter by date, channel etc

SearchEnquiries ( String queryString ) : XmlDocument

Get a list of enquiries, filter by date, channel etc

SearchEnquiries ( String queryString, int channelId ) : XmlDocument

Get a list of enquiries, filter by date, channel etc

SearchHotelsByRange ( ) : XmlDocument

Search Hotel type tours by a date range, optionally filter by a search querystring and/or limit to a specific channel

SearchHotelsByRange ( string queryString ) : XmlDocument

Search Hotel type tours by a date range, optionally filter by a search querystring and/or limit to a specific channel

SearchHotelsByRange ( string queryString, string tour ) : XmlDocument

Search Hotel type tours by a date range, optionally filter by a search querystring and/or limit to a specific channel

SearchHotelsByRange ( string queryString, string tour, int channelId ) : XmlDocument

Search Hotel type tours by a date range, optionally filter by a search querystring and/or limit to a specific channel

SearchHotelsBySpecific ( ) : XmlDocument

Search Hotel type tours for specific dates/occupancy, optionally filter by a search querystring and/or limit to a specific channel

SearchHotelsBySpecific ( string queryString ) : XmlDocument

Search Hotel type tours for specific dates/occupancy, optionally filter by a search querystring and/or limit to a specific channel

SearchHotelsBySpecific ( string queryString, string tour ) : XmlDocument

Search Hotel type tours for specific dates/occupancy, optionally filter by a search querystring and/or limit to a specific channel

SearchHotelsBySpecific ( string queryString, string tour, int channelId ) : XmlDocument

Search Hotel type tours for specific dates/occupancy, optionally filter by a search querystring and/or limit to a specific channel

SearchRawDepartures ( int tourId, int channelId ) : XmlDocument

Get a list of "Raw" Departures for a particular Tour

SearchTours ( ) : XmlDocument

Get a list of Tours, optionally filter by a search querystring and/or limit to a specific channel

SearchTours ( string queryString ) : XmlDocument

Get a list of Tours, optionally filter by a search querystring and/or limit to a specific channel

SearchTours ( string queryString, int channelId ) : XmlDocument

Get a list of Tours, optionally filter by a search querystring and/or limit to a specific channel

ShowBooking ( int bookingId, int channelId ) : XmlDocument

Get details on a particular booking

ShowChannel ( int channel ) : XmlDocument

Show details on a specific Channel (Supplier)

ShowCustomer ( int customerId, int channelId ) : XmlDocument

Get information on a particular Customer, by passing their ID and Channel

ShowEnquiry ( int enquiryId, int channelId ) : XmlDocument

Get information on a particular enquiry, by passing it's ID and Channel

ShowPromo ( string promo, int channel ) : XmlDocument

Check a promo code is valid for a Channel and view some info

ShowSupplier ( int supplierId, int channelId ) : XmlDocument

Get details on an internal Supplier ID (For Operator use only, not for Marketplace Partner use)

ShowTour ( int tourId, int ChannelId ) : XmlDocument

Show all of the details on a specific Tour, all descriptions and other content etc

ShowTour ( int tourId, int ChannelId, bool showOptions ) : XmlDocument

Show all of the details on a specific Tour, all descriptions and other content etc

ShowTour ( int tourId, int ChannelId, string queryString ) : XmlDocument

Show all of the details on a specific Tour, all descriptions and other content etc

ShowTourDatesAndDeals ( int tourId, int channelId ) : XmlDocument

Get a list of dates and deals/special offers for a particular Tour

ShowTourDepartures ( int tourId, int channelId ) : XmlDocument

Get a list of all future Departures for a specific Tour/Hotel, useful if bulk importing availability information

ShowTourDepartures ( int tourId, int channelId, string queryString ) : XmlDocument

Get a list of all future Departures for a specific Tour/Hotel, useful if bulk importing availability information

ShowTourFeesale ( int tourId, int channelId ) : XmlDocument

Get a list of all future Freesale Seasons for a specific Tour/Hotel, useful if bulk importing availability information

StartNewBooking ( XmlDocument bookingData, int channelId ) : XmlDocument

Create a temporary booking

UpdateBooking ( XmlDocument bookingData, int channelId ) : XmlDocument

Update some of the details on a booking

UpdateCustomer ( XmlDocument customerData, int channelId ) : XmlDocument

Update an existing customer record, e.g. contact details

UpdateDeparture ( XmlDocument departureData, int channelId ) : XmlDocument

Update an existing departure

UpdateTour ( XmlDocument tourData, int channelId ) : XmlDocument

Update a Tour/Hotel

UpdateTourUrl ( int tourId, int channelId, string tourUrl ) : XmlDocument

Update the "Product URL" on a Tour/Hotel

marketplaceWrapper ( int marketplaceId, string privateKey ) : System

Create a new instance of the TourCMS Marketplace wrapper, pass Marketplace ID and Key

Protected Methods

Method Description
DateTimeToStamp ( DateTime value ) : int

Convert a DateTime object (in UTC) to a Unix Timestapm, generally you won't neeed to call this directly

GenerateSignature ( string path, string verb, int channelId, DateTime outboundTime ) : string

Create an encrypted signature for a particular request, generally you won't neeed to call this directly

StampToDateTime ( int value ) : DateTime

Convert a Unix Timestamp to a UTC DateTime object, generally you won't need to call this directly

Method Details

ApiRateLimitStatus() public method

Check how many requests are left before throttling, handy for checking API connectivity
public ApiRateLimitStatus ( ) : XmlDocument
return System.Xml.XmlDocument

ApiRateLimitStatus() public method

Check how many requests are left before throttling, handy for checking API connectivity
public ApiRateLimitStatus ( int channelId ) : XmlDocument
channelId int
return System.Xml.XmlDocument

ChannelPerformance() public method

Get the statistics on the top 50 performing Channels (Suppliers)
public ChannelPerformance ( ) : XmlDocument
return XmlDocument

ChannelPerformance() public method

Show details on a specific Channel (Supplier)
public ChannelPerformance ( int channel ) : XmlDocument
channel int
return XmlDocument

CheckCustomerLogin() public method

Validate a Customer Username and Password, retrieve their Name and User ID
public CheckCustomerLogin ( string username, string password, int channelId ) : XmlDocument
username string
password string
channelId int
return XmlDocument

CheckTourAvailability() public method

Check Tour/Hotel availability for a specific number of people on specific rates on a specific date, generally used when making a booking
public CheckTourAvailability ( string queryString, int tourId, int channelId ) : XmlDocument
queryString string
tourId int
channelId int
return XmlDocument

CommitNewBooking() public method

Convert a temporary booking to a confirmed booking
public CommitNewBooking ( XmlDocument bookingData, int channelId ) : XmlDocument
bookingData XmlDocument
channelId int
return XmlDocument

CreateCustomer() public method

Create a new customer record, optionally include some enquiry data
public CreateCustomer ( XmlDocument customerData, int channelId ) : XmlDocument
customerData XmlDocument
channelId int
return XmlDocument

CreateDeparture() public method

Create a new departure
public CreateDeparture ( XmlDocument departureData, int channelId ) : XmlDocument
departureData XmlDocument
channelId int
return XmlDocument

CreateEnquiry() public method

Create an enquiry, either with a new customer record or associated with an existing one
public CreateEnquiry ( XmlDocument enquiryData, int channelId ) : XmlDocument
enquiryData XmlDocument
channelId int
return XmlDocument

CreatePayment() public method

Log details of a payment/refund on a booking sales ledger
public CreatePayment ( XmlDocument paymentData, int channelId ) : XmlDocument
paymentData XmlDocument
channelId int
return XmlDocument

DateTimeToStamp() protected method

Convert a DateTime object (in UTC) to a Unix Timestapm, generally you won't neeed to call this directly
protected DateTimeToStamp ( DateTime value ) : int
value DateTime
return int

DeleteDeparture() public method

Update an existing departure
public DeleteDeparture ( int departure, int tourId, int channelId ) : XmlDocument
departure int
tourId int
channelId int
return XmlDocument

GenerateSignature() protected method

Create an encrypted signature for a particular request, generally you won't neeed to call this directly
protected GenerateSignature ( string path, string verb, int channelId, DateTime outboundTime ) : string
path string
verb string
channelId int
outboundTime DateTime
return string

GetBookingRedirectUrl() public method

Get a redirect URL from TourCMS, send the customer via it to retrieve a booking key, Tour Op use only
public GetBookingRedirectUrl ( XmlDocument urlData, int channelId ) : XmlDocument
urlData XmlDocument
channelId int
return XmlDocument

ListChannels() public method

List all connected Channels (Suppliers)
public ListChannels ( ) : XmlDocument
return XmlDocument

ListTourImages() public method

Get a list of Image URLs, use this if you want to bulk-mirror product images on your own hosting
public ListTourImages ( ) : XmlDocument
return XmlDocument

ListTourImages() public method

Get a list of Image URLs for a specific Channel (Company), use this if you want to bulk-mirror product images on your own hosting
public ListTourImages ( int channelId ) : XmlDocument
channelId int
return XmlDocument

ListTourImages() public method

Get a list of Image URLs for a specific Channel (Company), use this if you want to bulk-mirror product images on your own hosting
public ListTourImages ( string queryString ) : XmlDocument
queryString string
return XmlDocument

ListTourImages() public method

Get a list of Image URLs for a specific Channel (Company), use this if you want to bulk-mirror product images on your own hosting
public ListTourImages ( string queryString, int channelId ) : XmlDocument
queryString string
channelId int
return XmlDocument

ListTourLocations() public method

Retrieve a list of connected tour locations
public ListTourLocations ( ) : XmlDocument
return XmlDocument

ListTourLocations() public method

Retrieve a list of connected tour locations for a specific Channel (Company)
public ListTourLocations ( int channelId ) : XmlDocument
channelId int
return XmlDocument

ListTourLocations() public method

Retrieve a list of connected tour locations on any connected Channel, with a queryString
public ListTourLocations ( string queryString ) : XmlDocument
queryString string
return XmlDocument

ListTourLocations() public method

Retrieve a list of connected tour locations for a specific Channel (Company)
public ListTourLocations ( string queryString, int channelId ) : XmlDocument
queryString string
channelId int
return XmlDocument

ListTours() public method

Get a list of Tours with only very basic information. Probably most useful when bulk importing. For a more detailed list use SearchTours
public ListTours ( ) : XmlDocument
return XmlDocument

ListTours() public method

Get a list of Tours with only very basic information. Probably most useful when bulk importing. For a more detailed list use SearchTours
public ListTours ( int channelId ) : XmlDocument
channelId int
return XmlDocument

ListTours() public method

Get a list of Tours with only very basic information. Probably most useful when bulk importing. For a more detailed list use SearchTours
public ListTours ( int channelId, string queryString ) : XmlDocument
channelId int
queryString string
return XmlDocument

ListTours() public method

Get a list of Tours with only very basic information. Probably most useful when bulk importing. For a more detailed list use SearchTours
public ListTours ( string queryString ) : XmlDocument
queryString string
return XmlDocument

LogFailedPayment() public method

Log details of a payment/refund on a booking sales ledger
public LogFailedPayment ( XmlDocument paymentData, int channelId ) : XmlDocument
paymentData XmlDocument
channelId int
return XmlDocument

Request() public method

Make a generic request to the API, most documented calls will have wrappers for this
public Request ( string path ) : XmlDocument
path string
return XmlDocument

Request() public method

Make a generic request to the API, most documented calls will have wrappers for this
public Request ( string path, int channelId ) : XmlDocument
path string
channelId int
return XmlDocument

Request() public method

Make a generic request to the API, most documented calls will have wrappers for this
public Request ( string path, int channelId, string verb ) : XmlDocument
path string
channelId int
verb string
return XmlDocument

Request() public method

Make a generic request to the API, most documented calls will have wrappers for this
public Request ( string path, int channelId, string verb, XmlDocument postData ) : XmlDocument
path string
channelId int
verb string
postData XmlDocument
return XmlDocument

SearchBookings() public method

Get a list of all bookings, optionally filter by channel / querystring
public SearchBookings ( ) : XmlDocument
return XmlDocument

SearchBookings() public method

Get a list of all bookings, optionally filter by channel / querystring
public SearchBookings ( string queryString ) : XmlDocument
queryString string
return XmlDocument

SearchBookings() public method

Get a list of all bookings, optionally filter by channel / querystring
public SearchBookings ( string queryString, int channelId ) : XmlDocument
queryString string
channelId int
return XmlDocument

SearchEnquiries() public method

Get a list of enquiries, filter by date, channel etc
public SearchEnquiries ( ) : XmlDocument
return XmlDocument

SearchEnquiries() public method

Get a list of enquiries, filter by date, channel etc
public SearchEnquiries ( String queryString ) : XmlDocument
queryString String
return XmlDocument

SearchEnquiries() public method

Get a list of enquiries, filter by date, channel etc
public SearchEnquiries ( String queryString, int channelId ) : XmlDocument
queryString String
channelId int
return XmlDocument

SearchHotelsByRange() public method

Search Hotel type tours by a date range, optionally filter by a search querystring and/or limit to a specific channel
public SearchHotelsByRange ( ) : XmlDocument
return XmlDocument

SearchHotelsByRange() public method

Search Hotel type tours by a date range, optionally filter by a search querystring and/or limit to a specific channel
public SearchHotelsByRange ( string queryString ) : XmlDocument
queryString string
return XmlDocument

SearchHotelsByRange() public method

Search Hotel type tours by a date range, optionally filter by a search querystring and/or limit to a specific channel
public SearchHotelsByRange ( string queryString, string tour ) : XmlDocument
queryString string
tour string
return XmlDocument

SearchHotelsByRange() public method

Search Hotel type tours by a date range, optionally filter by a search querystring and/or limit to a specific channel
public SearchHotelsByRange ( string queryString, string tour, int channelId ) : XmlDocument
queryString string
tour string
channelId int
return XmlDocument

SearchHotelsBySpecific() public method

Search Hotel type tours for specific dates/occupancy, optionally filter by a search querystring and/or limit to a specific channel
public SearchHotelsBySpecific ( ) : XmlDocument
return XmlDocument

SearchHotelsBySpecific() public method

Search Hotel type tours for specific dates/occupancy, optionally filter by a search querystring and/or limit to a specific channel
public SearchHotelsBySpecific ( string queryString ) : XmlDocument
queryString string
return XmlDocument

SearchHotelsBySpecific() public method

Search Hotel type tours for specific dates/occupancy, optionally filter by a search querystring and/or limit to a specific channel
public SearchHotelsBySpecific ( string queryString, string tour ) : XmlDocument
queryString string
tour string
return XmlDocument

SearchHotelsBySpecific() public method

Search Hotel type tours for specific dates/occupancy, optionally filter by a search querystring and/or limit to a specific channel
public SearchHotelsBySpecific ( string queryString, string tour, int channelId ) : XmlDocument
queryString string
tour string
channelId int
return XmlDocument

SearchRawDepartures() public method

Get a list of "Raw" Departures for a particular Tour
public SearchRawDepartures ( int tourId, int channelId ) : XmlDocument
tourId int
channelId int
return XmlDocument

SearchTours() public method

Get a list of Tours, optionally filter by a search querystring and/or limit to a specific channel
public SearchTours ( ) : XmlDocument
return XmlDocument

SearchTours() public method

Get a list of Tours, optionally filter by a search querystring and/or limit to a specific channel
public SearchTours ( string queryString ) : XmlDocument
queryString string
return XmlDocument

SearchTours() public method

Get a list of Tours, optionally filter by a search querystring and/or limit to a specific channel
public SearchTours ( string queryString, int channelId ) : XmlDocument
queryString string
channelId int
return XmlDocument

ShowBooking() public method

Get details on a particular booking
public ShowBooking ( int bookingId, int channelId ) : XmlDocument
bookingId int
channelId int
return XmlDocument

ShowChannel() public method

Show details on a specific Channel (Supplier)
public ShowChannel ( int channel ) : XmlDocument
channel int
return XmlDocument

ShowCustomer() public method

Get information on a particular Customer, by passing their ID and Channel
public ShowCustomer ( int customerId, int channelId ) : XmlDocument
customerId int
channelId int
return XmlDocument

ShowEnquiry() public method

Get information on a particular enquiry, by passing it's ID and Channel
public ShowEnquiry ( int enquiryId, int channelId ) : XmlDocument
enquiryId int
channelId int
return XmlDocument

ShowPromo() public method

Check a promo code is valid for a Channel and view some info
public ShowPromo ( string promo, int channel ) : XmlDocument
promo string
channel int
return XmlDocument

ShowSupplier() public method

Get details on an internal Supplier ID (For Operator use only, not for Marketplace Partner use)
public ShowSupplier ( int supplierId, int channelId ) : XmlDocument
supplierId int
channelId int
return XmlDocument

ShowTour() public method

Show all of the details on a specific Tour, all descriptions and other content etc
public ShowTour ( int tourId, int ChannelId ) : XmlDocument
tourId int
ChannelId int
return XmlDocument

ShowTour() public method

Show all of the details on a specific Tour, all descriptions and other content etc
public ShowTour ( int tourId, int ChannelId, bool showOptions ) : XmlDocument
tourId int
ChannelId int
showOptions bool
return XmlDocument

ShowTour() public method

Show all of the details on a specific Tour, all descriptions and other content etc
public ShowTour ( int tourId, int ChannelId, string queryString ) : XmlDocument
tourId int
ChannelId int
queryString string
return XmlDocument

ShowTourDatesAndDeals() public method

Get a list of dates and deals/special offers for a particular Tour
public ShowTourDatesAndDeals ( int tourId, int channelId ) : XmlDocument
tourId int
channelId int
return XmlDocument

ShowTourDepartures() public method

Get a list of all future Departures for a specific Tour/Hotel, useful if bulk importing availability information
public ShowTourDepartures ( int tourId, int channelId ) : XmlDocument
tourId int
channelId int
return XmlDocument

ShowTourDepartures() public method

Get a list of all future Departures for a specific Tour/Hotel, useful if bulk importing availability information
public ShowTourDepartures ( int tourId, int channelId, string queryString ) : XmlDocument
tourId int
channelId int
queryString string
return XmlDocument

ShowTourFeesale() public method

Get a list of all future Freesale Seasons for a specific Tour/Hotel, useful if bulk importing availability information
public ShowTourFeesale ( int tourId, int channelId ) : XmlDocument
tourId int
channelId int
return XmlDocument

StampToDateTime() protected method

Convert a Unix Timestamp to a UTC DateTime object, generally you won't need to call this directly
protected StampToDateTime ( int value ) : DateTime
value int
return DateTime

StartNewBooking() public method

Create a temporary booking
public StartNewBooking ( XmlDocument bookingData, int channelId ) : XmlDocument
bookingData XmlDocument
channelId int
return XmlDocument

UpdateBooking() public method

Update some of the details on a booking
public UpdateBooking ( XmlDocument bookingData, int channelId ) : XmlDocument
bookingData XmlDocument
channelId int
return XmlDocument

UpdateCustomer() public method

Update an existing customer record, e.g. contact details
public UpdateCustomer ( XmlDocument customerData, int channelId ) : XmlDocument
customerData XmlDocument
channelId int
return XmlDocument

UpdateDeparture() public method

Update an existing departure
public UpdateDeparture ( XmlDocument departureData, int channelId ) : XmlDocument
departureData XmlDocument
channelId int
return XmlDocument

UpdateTour() public method

Update a Tour/Hotel
public UpdateTour ( XmlDocument tourData, int channelId ) : XmlDocument
tourData XmlDocument
channelId int
return XmlDocument

UpdateTourUrl() public method

Update the "Product URL" on a Tour/Hotel
public UpdateTourUrl ( int tourId, int channelId, string tourUrl ) : XmlDocument
tourId int
channelId int
tourUrl string
return XmlDocument

marketplaceWrapper() public method

Create a new instance of the TourCMS Marketplace wrapper, pass Marketplace ID and Key
public marketplaceWrapper ( int marketplaceId, string privateKey ) : System
marketplaceId int
privateKey string
return System

Property Details

_baseUrl protected_oe property

API base URL
protected string _baseUrl
return string

_marketplaceId protected_oe property

Marketplace ID, set via the constructor
protected int _marketplaceId
return int

_privateKey protected_oe property

API Private Key, set via the constructor
protected string _privateKey
return string