CenResService

<back to all web services

ResSummaryRequest

The following routes are available for this service:
GET/v2/reservation/summary/{Query}
GET/v2/reservation/summary/{Query}/{CendynPropertyId}
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using CenResSS.ServiceModel;
using Cendyn.CenRes.DataLib.ViewModels;

namespace Cendyn.CenRes.DataLib.ViewModels
{
    public partial class ReservationSummary
    {
        public virtual string FirstName { get; set; }
        public virtual string LastName { get; set; }
        public virtual string ExternalProfileId { get; set; }
        public virtual string ExternalProfileId2 { get; set; }
        public virtual string ExternalResID1 { get; set; }
        public virtual string ExternalResID2 { get; set; }
        public virtual string CendynPropertyId { get; set; }
        public virtual string PropertyName { get; set; }
        public virtual string ResTypeCode { get; set; }
        public virtual string ResStatusCode { get; set; }
        public virtual string ConfirmationNum { get; set; }
        public virtual string CentralResNum { get; set; }
        public virtual DateTime? ResArriveDate { get; set; }
        public virtual DateTime? ResDepartDate { get; set; }
        public virtual int? NumRooms { get; set; }
        public virtual string RoomTypeCode { get; set; }
        public virtual string RoomNumber { get; set; }
        public virtual string RateCode { get; set; }
        public virtual string MarketSegmentCode { get; set; }
        public virtual string MarketCodeCategory { get; set; }
        public virtual string MarketRegionCode { get; set; }
        public virtual string CompanyName { get; set; }
        public virtual int? NumAdults { get; set; }
        public virtual int? NumYouths { get; set; }
        public virtual int? NumChildren { get; set; }
        public virtual int? TotalRoomNights { get; set; }
        public virtual string CancellationID { get; set; }
        public virtual DateTime? CancellationDate { get; set; }
        public virtual decimal? TotalOtherRevenue { get; set; }
        public virtual decimal? TotalRoomRevenue { get; set; }
        public virtual decimal? TotalTax { get; set; }
        public virtual decimal? TotalRevenue { get; set; }
        public virtual DateTime LastUpdated { get; set; }
    }

}

namespace CenResSS.ServiceModel
{
    public partial class CenResResponse
    {
        public virtual RequestStatus Status { get; set; }
        public virtual string StatusMessage { get; set; }
        public virtual int RecordsReturned { get; set; }
        public virtual int RecordsAvailable { get; set; }
        public virtual int PageNumber { get; set; }
        public virtual int PageSize { get; set; }
    }

    public enum RequestStatus
    {
        Success,
        Warning,
        Error,
        NotAuthorized,
        Failure,
    }

    public enum ReservationQueryType
    {
        ResId,
        ProfileId,
        Name,
        LastUpdated,
        ArrivalDate,
        DepartureDate,
        StayDate,
        DatePMSResUpdated,
    }

    public partial class ResSummaryRequest
    {
        public virtual string CendynPropertyId { get; set; }
        public virtual ReservationQueryType Query { get; set; }
        public virtual string Id { get; set; }
        public virtual string FirstName { get; set; }
        public virtual string LastName { get; set; }
        public virtual DateTime? StartDate { get; set; }
        public virtual DateTime? EndDate { get; set; }
        [DataMember(Name="Limit")]
        public virtual int PageSize { get; set; }

        [DataMember(Name="Page")]
        public virtual int PageNumber { get; set; }
    }

    public partial class ResSummaryResponse
        : CenResResponse
    {
        public ResSummaryResponse()
        {
            Records = new List<ReservationSummary>{};
        }

        public virtual List<ReservationSummary> Records { get; set; }
    }

}

C# ResSummaryRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /v2/reservation/summary/{Query} HTTP/1.1 
Host: cert.cendyn.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ResSummaryResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CenResSS.ServiceModel">
  <PageNumber>0</PageNumber>
  <PageSize>0</PageSize>
  <RecordsAvailable>0</RecordsAvailable>
  <RecordsReturned>0</RecordsReturned>
  <Status>Success</Status>
  <StatusMessage>String</StatusMessage>
  <Records xmlns:d2p1="http://schemas.datacontract.org/2004/07/Cendyn.CenRes.DataLib.ViewModels">
    <d2p1:ReservationSummary>
      <d2p1:CancellationDate>0001-01-01T00:00:00</d2p1:CancellationDate>
      <d2p1:CancellationID>String</d2p1:CancellationID>
      <d2p1:CendynPropertyId>String</d2p1:CendynPropertyId>
      <d2p1:CentralResNum>String</d2p1:CentralResNum>
      <d2p1:CompanyName>String</d2p1:CompanyName>
      <d2p1:ConfirmationNum>String</d2p1:ConfirmationNum>
      <d2p1:ExternalProfileId>String</d2p1:ExternalProfileId>
      <d2p1:ExternalProfileId2>String</d2p1:ExternalProfileId2>
      <d2p1:ExternalResID1>String</d2p1:ExternalResID1>
      <d2p1:ExternalResID2>String</d2p1:ExternalResID2>
      <d2p1:FirstName>String</d2p1:FirstName>
      <d2p1:LastName>String</d2p1:LastName>
      <d2p1:LastUpdated>0001-01-01T00:00:00</d2p1:LastUpdated>
      <d2p1:MarketCodeCategory>String</d2p1:MarketCodeCategory>
      <d2p1:MarketRegionCode>String</d2p1:MarketRegionCode>
      <d2p1:MarketSegmentCode>String</d2p1:MarketSegmentCode>
      <d2p1:NumAdults>0</d2p1:NumAdults>
      <d2p1:NumChildren>0</d2p1:NumChildren>
      <d2p1:NumRooms>0</d2p1:NumRooms>
      <d2p1:NumYouths>0</d2p1:NumYouths>
      <d2p1:PropertyName>String</d2p1:PropertyName>
      <d2p1:RateCode>String</d2p1:RateCode>
      <d2p1:ResArriveDate>0001-01-01T00:00:00</d2p1:ResArriveDate>
      <d2p1:ResDepartDate>0001-01-01T00:00:00</d2p1:ResDepartDate>
      <d2p1:ResStatusCode>String</d2p1:ResStatusCode>
      <d2p1:ResTypeCode>String</d2p1:ResTypeCode>
      <d2p1:RoomNumber>String</d2p1:RoomNumber>
      <d2p1:RoomTypeCode>String</d2p1:RoomTypeCode>
      <d2p1:TotalOtherRevenue>0</d2p1:TotalOtherRevenue>
      <d2p1:TotalRevenue>0</d2p1:TotalRevenue>
      <d2p1:TotalRoomNights>0</d2p1:TotalRoomNights>
      <d2p1:TotalRoomRevenue>0</d2p1:TotalRoomRevenue>
      <d2p1:TotalTax>0</d2p1:TotalTax>
    </d2p1:ReservationSummary>
  </Records>
</ResSummaryResponse>