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 .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"records":[{"firstName":"String","lastName":"String","externalProfileId":"String","externalProfileId2":"String","externalResID1":"String","externalResID2":"String","cendynPropertyId":"String","propertyName":"String","resTypeCode":"String","resStatusCode":"String","confirmationNum":"String","centralResNum":"String","resArriveDate":"0001-01-01T00:00:00.0000000","resDepartDate":"0001-01-01T00:00:00.0000000","numRooms":0,"roomTypeCode":"String","roomNumber":"String","rateCode":"String","marketSegmentCode":"String","marketCodeCategory":"String","marketRegionCode":"String","companyName":"String","numAdults":0,"numYouths":0,"numChildren":0,"totalRoomNights":0,"cancellationID":"String","cancellationDate":"0001-01-01T00:00:00.0000000","totalOtherRevenue":0,"totalRoomRevenue":0,"totalTax":0,"totalRevenue":0,"lastUpdated":"0001-01-01T00:00:00.0000000"}],"status":"Success","statusMessage":"String","recordsReturned":0,"recordsAvailable":0,"pageNumber":0,"pageSize":0}