Click or drag to resize

Tse.EasyBook.Server.DataContracts Namespace

Service data contract classes.
Classes
  ClassDescription
Public classAccountEntrySummaryWeb
Data contract class for a entry on a business partner's internal account(s)
Public classAccountEntryWeb
Data contract class for a entry on a business partner's internal account(s)
Public classAccountWeb
Data contract class for an account on a business partner's internal account(s)
Public classAddCaseCriteria
Add a new case.
Public classAddCustomerReviewCriteria
Data contract for the input criteria to the "AddCustomerReview" service.
Public classAddCustomerReviewOwnerMessageCriteriaWeb
Data contract for the input criteria to create a new CustomerReview with ReviewType=Owner.
Public classAddressWeb
Data contract address
Public classAgeIntervalListItem
Public classAgeIntervalWeb
Public classAreaWeb
An area is always part of a region. An area can either be directly part of a region or indirectly by acting as a sub-area of another larger area. Areas can be modelled as a hierachy where areas are made up of larger areas.
Public classArrival
Vacant arrival date interval. The interval include both Start and End . If End is null the interval only contains the Start date. All dates included in the interval are vacant arrival date(s) for rental interval(s) of the duration specified in the field Days.
Public classArrivalDepartureTimesWeb
An date interval for arrival- and departure-times.
Public classArticleBaseWeb
Base class for an article that are used in conjunction with a booking to enable additional sales.
Public classArticleOrderWeb
Data contract for the aticle item attached to a OrderWeb
Public classArticlesCriteria
Criteria class used in the "Articles" service method.
Public classArticlesResult
Data contract for the output of the "Articles" service
Public classArticleWeb
Data contract for an aticle item that can be sold for a specific rental object.
Public classAssessmentCriteriaGradeWeb
Data contract class for a rental object assessment grade. Assessments are used to calculate the rental object category.
Public classAssessmentWeb
Data contract class for a rental object assessment. Assessments are used to calculate the rental object category.
Public classAttractionsCriteria
Data contract for the input criteria to the "Attractions" service
Public classAttractionWeb
Contains information about an attraction.
Public classAttributeBaseWeb
Attribute base class for attribute search criteria and attribute values.
Public classAttributeGroupTextWeb
Holds an autogenerated text for a specific attribute group. Autogenerated texts are created based on the values of the associated attributes on a rental object. Thus, the resulting text is a product of the configured attributes on a rental object. It is unlikely that all attribute groups has an associated automatic text.
Public classAttributeGroupWeb
Group item for an attribute
Public classAttributeWeb
Holds a rental object attribute value for specific interval.
Public classAvailabilityCriteria
Data contract for the input criteria for the "Availability" service
Public classAvailabilityResult
Data contract for the resulting output of the "Availability" service
Public classBankInfoCriteria
Data contract for the bank info item attached to a booking
Public classBankInfoWeb
Data contract for a bank info item
Public classBookingCriteria
Data contract for the input to the online booking service method
Public classBookingFormOfPaymentWeb
The form of payments which can be used to to pay a booking with.
Public classBusinessPartnerWeb
Data contract contact info.
Public classCalendarEntryConsumptionWeb
The consumption for one consumption meter during the rental period on the rental agreement.
Public classCalendarEntryRentalAgreementInfoWeb
Data contract for Rental Object Calendar Rental Agreement info
Public classCalendarEntryWeb
Data contract for vacancy of a standard week.
Public classCalendarResult
Data contract for the resulting output of the "AccountDetails" service method.
Public classCalendarWeb

Data contract Rental calendar and possible arrival/departure dates.

The primary goal of an arrival and departure calendar is to correctly identify on which days what vacation types (booking lengths) are available.

RentalObjectCalendarWeb.ArrivalDays and RentalObjectCalendarWeb.DepartureDays contains possible arrival and departure days for the following vacation types:

  • Standard vacation (A): 7, 14, 21 or 28 days
  • Optional Arrival (O): 7-28 days
  • Multi Week Discount (M): 14-28 days
  • Short Stay (S): 2-6 days

The calendar also contains the following vacancy details

  • A: Free and available standard vacation arrival day (see above)
  • a: Available
  • b: blocked. Not available, but a blocked day should not count against the winter 13 week (max) rental rule
  • B: Booked
If the rental object is blocked for winter rental then the winter period will be marked as blocked (b) on both calendars.

To correctly parse the calendar the following steps should be taken: Start by identifying an arrival day of interest on the arrival calendar. To do this, use the offset date on the calendar and calculate how many groups (days) to skip to find the group of interest. Once found, the contents of the arrival day group can be used to calculate allowed arrival days. The goal is to find out what lengths between 2 and 28 days are possible for this specific arrival day.

Here are the possible values to help determine an allowed departure day:

  • B or b: No arrival is possible on this date.
Standard vacation (A):
  • Allowed length is 7, 14, 21 or 28 days.
  • The arrival day must contain an A on the arrival calendar.
  • The departure day must contain an A on the departure calendar.
  • Every day in between must contain an uninterrupted A/a on either the arrival or departure calendar.*
Optional Arrival (O):
  • Allowed length is between 7-28 days.
  • The arrival day must contain an O on the arrival calendar.
  • The departure day must contain an O on the departure calendar.
  • Every day in between must contain an uninterrupted O on either the arrival or departure calendar.*
Short Stay (S):
  • Allowed length is between 2-6 days.
  • The arrival day must contain an S on the arrival calendar.
  • The departure day must contain an S on the departure calendar.
  • Every day in between must contain an uninterrupted S on either the arrival or departure calendar.*
Multi week discount (M):
  • Allowed length is 14, 21 and 28 days.
  • The arrival day must contain an M on the arrival calendar.
  • The departure day must contain an M on the departure calendar.
  • Every day in between must contain an uninterrupted M on either the arrival or departure calendar and A/a.*
  • For lengths other than whole weeks (15-20 and 22-27 days) every day in between must contain an uninterrupted M on either the arrival or departure calendar and O. *

*When checking if a character is either on the arrival or departure calendar, start by looping the arrival calendar and check for that character. If a day is reached where the characters is no longer there, then continue from that day on the departure calendar, and continue checking for that character until the desired departure date is reached.

Please note
Please be aware that the calendar string format described above is obsolete and is only available to avoid breaking the contract with old client proxies.
Please use the new duration based format in stead. The description of this duration based format can be found in the comments to the field ArrivalDays
If the field IncludeCalendarDurations is set to true, a CalendarWeb instance containing the duration based format, will be returned in the field CalendarDurations. The field Calendar always contains the old obsolete format.

Public classCancellationAndRateWeb
Data contract for and cancellaton date combined with a possible cancellation discount rate applicable for the date of cancellation
Public classCaseCauseWeb
Data class for past correspondence details froma business entity
Public classCaseStatusReasonWeb
Data class for a case status reason: (New, Processing, Rejected, etc..)
Public classCaseWeb
Data class for showing a case on the web.
Public classCategoryWeb
Category for a RentalObject
Public classCheckPostalCodeResult
Data contract for the resulting output of the "CheckPostalCode" service
Public classCleaningPricesWeb
Data contract for cleaning price within a fixed range of currencies
Public classCommentWeb
Comment
Public classCompanyWeb
Data contract for a company customer in the "Booking" service.
Public classConsumptionArticleOrderWeb
Data contract for specific details about consumption articles on an invoice (orderweb).
Public classConsumptionMeterWeb
Data contract for specific details about a consumption meter of a rental object.
Public classContactWeb
Data contract contact info.
Public classCorrespondenceInfoWeb
Data class for past correspondence details froma business entity
Public classCustomerReviewCategoryWeb
Customer Review Category for the web client
Public classCustomerReviewGradeWeb
Customer Review Grade for the web client
Public classCustomerReviewStatisticsWeb
Customer Review grade averages per rental object
Public classCustomerReviewWeb
Customer Review for the web client
Public classDataContractEntityWeb
Base class for all web entities.
Public classDeleteOrderCriteria
Datacontract for the input criteria used to delete an order using the "DeleteOrder" web service.
Public classDetailsCriteria
Data contract for the input criteria for the "Details" service.
Public classDetailsResult
Data contract for the resulting output of the "Details" service.
Public classEncodedDocumentWeb
Data contract class for an encoded (Base64) document from the document archive.
Public classGeographyCriteria
Data contract containing input criteria used to perform a geographic related rental object search.
Public classGetCasesResult
Data contract contaning a list of cases
Public classGpsCoordinateWeb
Gps coordinate of a POI like a rental object, attraction, office etc.
Public classInstallmentWeb
Invoice installment.
Public classIntermediationAgreementBaseWeb
Data contract base class for common information about an owner intermediation agreeement
Public classIntermediationAgreementWeb
Data contract base class for details concerning an intermediation agreement between the rental agency and an owner.
Public classIntervalExtraWeb
An date interval for arrival- and departure-times.
Public classIntervalWeb
An date interval that has a nullable end date.
Public classKeyDeliveryLocationWeb
Data contract for the key delivery location for the specified date interval.
Public classLocalizedEntityWeb
Contains localized strings in the supported customer languages of the agency (consumer).
Public classOrderInfoCriteria
Datacontract for identifying an existing customer and order in EasyBook.NET.
Public classOrderListCriteria
Data contract for the criteria for the "PartnerOrders" service method. Orders are always returned sorted by the created date descending.
Public classOrderListItem
Data transport class for orders and invoices.
Public classOrderListResult
Data contract for the result of the PartnerOrders service method.
Public classOrderSummaryWeb
Data contract for a partner order
Public classOrderWeb
Data class for order which is a result of a booking or an additional sale through the "UpdateOrder" service.
Public classOwnerAccessBaseCriteria
Data contract for the input criteria for the "OwnerAccess" webservice.
Public classOwnerAccessIntervalCriteria
Data contract for the input criteria for the "OwnerAccess" webservice.
Public classOwnerCategoryWeb
An owners category is calculated on preset dates. Owners are assigned a category based on the rules that are fulfilled in the different owner categories.
Public classOwnerWeb
Data contract class for an account on a business partner's internal account(s)
Public classPersonWeb
Data contract for the input of a customer to the online booking service method
Public classPictureBaseWeb
Data contract for a web picture base class.
Public classPictureMasterWeb
Data contract for a web picture base class.
Public classPictureWeb
Data contract for a web picture specialized class.
Public classPostalCodeWeb
Public classPriceAdjustmentWeb
Data class for a rental object price adjustment
Public classPriceC
A set of price amounts for one currency, common across all the listed intervals in Arrivals.
Public classPriceExampleWeb
Data contract for article price examples. Contains different prices for different count values.
Public classPriceIntervalWeb
Data contract for price for a single week for a rental object.
Public classPricesAndArrivals
Vacant arrival date intervals combined with one set of prices per possible currency. These prices are common across all the listed intervals in Arrivals .
Public classPricesDays
The vacant arrival date intervals and prices for rental intervals of the specified duration.
Public classPricesWeb
Data contract for price within a fixed range of currencies
Public classPriceWeb
Data contract for a curerncy and a price.
Public classRecordingDetailWeb
Data contract class for a entry on a business partner's internal account(s)
Public classRegionWeb
A country is typically divided into several large regions. Each region contains 1-n areas which again can hold additional areas. A region can not contain other regions.
Public classRentalAgreementWeb
Data class for a web rental agreement. A rental agreement containts the specific details about a tennancy that can be referenced by an OrderWeb.
Public classRentalIntervalWeb
Data contract Rental interval
Public classRentalObjectArticleWeb
Data contract that holds information about which article numbers are available for a rental object.
Public classRentalObjectBaseWeb
Base class for for web rental object entities
Public classRentalObjectCategoryWeb
Category for a rental object.
Public classRentalObjectCombinedWeb
Rental object information for partner feed. Combines data from data contracts RentalObjectWeb, RentalObjectPictureWeb, RentalObjectTextWeb and RentalObjectArticleWeb for the matching rental objects.
Public classRentalObjectCommentWeb
Comment for a rental object covering a specific date interval.
Public classRentalObjectKeyDeliveryWeb
Rental object key delivery location information
Public classRentalObjectOwnerWeb
Rental object information for owner site
Public classRentalObjectPictureWeb
Rental object picture information for partner feed
Public classRentalObjectPriceChangeWeb
Holds information on a periodic price change on a rental object. Price changes can be updated on the rental object by sending them back into the "UpdateRentalObject" service method. Please note that the "Rejected" value is the ONLY value that can be altered on a price change!
Public classRentalObjectPrices
Defines vacancies and prices for one rental object for following price file feeds: compressed/json/{partnerCode}/{consumerId}/price and compressed/xml/{partnerCode}/{consumerId}/price. The price file feeds are described here: Partner feeds are available as RESTful services.
Public classRentalObjectPriceWeb
Data contract for rental object prices and vacation types. Hence everything needed to calculate the rental price.
Public classRentalObjectRoomWeb
Rental object room information for partner feed
Public classRentalObjectsArticlesResult
Data contract that holds information about which article numbers are available for a list of rental objects.
Public classRentalObjectsCalendarCriteria
Criteria for partner feed methods for returning calendar data.
Public classRentalObjectsCombinedWebResult
Rental object information for partner feed
Public classRentalObjectsCustomerReviewsCriteria
Data contract containing search criterias for customer reviews
Public classRentalObjectSearchItemWeb
Data contract containing a rental object search result.
Public classRentalObjectSearchResultBase
Data contract base class for a specific rental object in a search result
Public classRentalObjectsIntervalCriteria
Criteria for partner feed methods requiring an interval of RentalObject numbers and date interval
Public classRentalObjectSortExpressionWeb
Holds a rental object sort expression.
Public classRentalObjectTextWeb
Rental object text information for partner feed
Public classRentalObjectTypeWeb
Represents a rental obect type such as "Apartment", "Holiday Home", "Estate", etc.
Public classRentalObjectVacancyWeb
The rental object calendar.
Public classRentalObjectWeb
Rental object information for partner feed
Public classRepeatedRentalIntervalWeb
Data contract for holding a repeated rental interval. Repeated rental intervals are used on intermediation agreement to register repeated owner blockings across intermediation agreements.
Public classRoomAttributeWeb
Holds a rental object attribute value for a specific room. For instance the number of double beds.
Public classRoomWeb
This object contains information for a room in a rental object.
Public classSearchCriteria
Search criteria used in the "Search" service.
Public classSearchCustomerReviewsCriteria
Data contract containing search criterias for customer reviews
Public classSearchCustomerReviewsResult
Data contract containing result for a search for customer reviews
Public classSearchCustomersResult
Data contract for the search result of the SeachCustomers method
Public classSearchInitializeResult
Datacontract for the resulting output from the "SearchInitialize" service.
Public classSearchItemWeb
Data contract containing a rental object condensed search result.
Public classSearchOrdersCriteria
Class containing search criteria for order search
Public classSearchResult
Datacontract Search results
Public classSearchStatistic
Statistic for a Rental Object Search
Public classSearchStatisticWeb
Statistic for a Rental Object Search
Public classSeasonIntervalWeb
Data contract Season interval
Public classServiceOptionWeb
The service agreement option is included in the intermediation agreement interval
Public classShortStayRuleWeb
Data class for a web vacation type rule for short stay a.k.a. "Mini vacation"
Public classSupplierCategoryWeb
Data contract class for a service supplier category.
Public classSupplierWeb
Data contract class for a serviec supplier on a rental object.
Public classTextIntervalWeb
Data contract for a loacalized text.
Public classTextWeb
Data contract for a translated text.
Public classTicketArticleWeb
Data contract for the aticle item attached to a rental object
Public classTipWeb
Tip for the web client.
Public classUpdateAccountCriteria
Data contract class for saving bank account details of an account
Public classUpdateCalendarCriteria
Data contract class for saving bank account details of an account
Public classUpdateCustomerCriteria
Data contract for the input of the online update customer service method
Public classUpdateCustomerResult
Data contract for the output of the online update customer service method
Public classUpdateIntermediationAgreementCriteria
Data contract class for saving certain information about an intermediation agreement.
Public classUpdateOrderCriteria
Data contract for the input criteria to the "UpdateOrder" service.
Public classUpdateOrderPaymentCriteria
Data contract for the input criteria to the "UpdateOrderPayment" service.
Public classUpdateOwnerCriteria
Data contract class for saving certain information about an owner. Depending on the value of the propoerties the server updates the owner accordingly. Please see the individial property comments for specfic details.
Public classUpdateRentalObjectCriteria
Data contract class for saving details on a rental object
Public classVacancyOptionsWeb
Data contract for vacancy search options
Public classVacationTypeConfigurationWeb
Data class for a web vacation type
Public classVacationTypeListItem
Data class for a vacation type list item
Public classVacationTypeWeb
Data class for a web vacation type
Enumerations
  EnumerationDescription
Public enumerationCalendarEntryTypeEnumWeb
Possible char codes for days on the vacancy calendar