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}
import java.math.*;
import java.util.*;
import net.servicestack.client.*;
import com.google.gson.annotations.*;
import com.google.gson.reflect.*;

public class dtos
{

    public static class ResSummaryRequest
    {
        public String cendynPropertyId = null;
        public ReservationQueryType query = null;
        public String id = null;
        public String firstName = null;
        public String lastName = null;
        public Date startDate = null;
        public Date endDate = null;
        @DataMember(Name="Limit")
        @SerializedName("Limit")
        public Integer pageSize = null;

        @DataMember(Name="Page")
        @SerializedName("Page")
        public Integer pageNumber = null;
        
        public String getCendynPropertyId() { return cendynPropertyId; }
        public ResSummaryRequest setCendynPropertyId(String value) { this.cendynPropertyId = value; return this; }
        public ReservationQueryType getQuery() { return query; }
        public ResSummaryRequest setQuery(ReservationQueryType value) { this.query = value; return this; }
        public String getId() { return id; }
        public ResSummaryRequest setId(String value) { this.id = value; return this; }
        public String getFirstName() { return firstName; }
        public ResSummaryRequest setFirstName(String value) { this.firstName = value; return this; }
        public String getLastName() { return lastName; }
        public ResSummaryRequest setLastName(String value) { this.lastName = value; return this; }
        public Date getStartDate() { return startDate; }
        public ResSummaryRequest setStartDate(Date value) { this.startDate = value; return this; }
        public Date getEndDate() { return endDate; }
        public ResSummaryRequest setEndDate(Date value) { this.endDate = value; return this; }
        public Integer getPageSize() { return pageSize; }
        public ResSummaryRequest setPageSize(Integer value) { this.pageSize = value; return this; }
        public Integer getPageNumber() { return pageNumber; }
        public ResSummaryRequest setPageNumber(Integer value) { this.pageNumber = value; return this; }
    }

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

    public static class ResSummaryResponse extends CenResResponse
    {
        public ArrayList<ReservationSummary> records = null;
        
        public ArrayList<ReservationSummary> getRecords() { return records; }
        public ResSummaryResponse setRecords(ArrayList<ReservationSummary> value) { this.records = value; return this; }
    }

    public static class CenResResponse
    {
        public RequestStatus status = null;
        public String statusMessage = null;
        public Integer recordsReturned = null;
        public Integer recordsAvailable = null;
        public Integer pageNumber = null;
        public Integer pageSize = null;
        
        public RequestStatus getStatus() { return status; }
        public CenResResponse setStatus(RequestStatus value) { this.status = value; return this; }
        public String getStatusMessage() { return statusMessage; }
        public CenResResponse setStatusMessage(String value) { this.statusMessage = value; return this; }
        public Integer getRecordsReturned() { return recordsReturned; }
        public CenResResponse setRecordsReturned(Integer value) { this.recordsReturned = value; return this; }
        public Integer getRecordsAvailable() { return recordsAvailable; }
        public CenResResponse setRecordsAvailable(Integer value) { this.recordsAvailable = value; return this; }
        public Integer getPageNumber() { return pageNumber; }
        public CenResResponse setPageNumber(Integer value) { this.pageNumber = value; return this; }
        public Integer getPageSize() { return pageSize; }
        public CenResResponse setPageSize(Integer value) { this.pageSize = value; return this; }
    }

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

    public static class ReservationSummary
    {
        public String firstName = null;
        public String lastName = null;
        public String externalProfileId = null;
        public String externalProfileId2 = null;
        public String externalResID1 = null;
        public String externalResID2 = null;
        public String cendynPropertyId = null;
        public String propertyName = null;
        public String resTypeCode = null;
        public String resStatusCode = null;
        public String confirmationNum = null;
        public String centralResNum = null;
        public Date resArriveDate = null;
        public Date resDepartDate = null;
        public Integer numRooms = null;
        public String roomTypeCode = null;
        public String roomNumber = null;
        public String rateCode = null;
        public String marketSegmentCode = null;
        public String marketCodeCategory = null;
        public String marketRegionCode = null;
        public String companyName = null;
        public Integer numAdults = null;
        public Integer numYouths = null;
        public Integer numChildren = null;
        public Integer totalRoomNights = null;
        public String cancellationID = null;
        public Date cancellationDate = null;
        public BigDecimal totalOtherRevenue = null;
        public BigDecimal totalRoomRevenue = null;
        public BigDecimal totalTax = null;
        public BigDecimal totalRevenue = null;
        public Date lastUpdated = null;
        
        public String getFirstName() { return firstName; }
        public ReservationSummary setFirstName(String value) { this.firstName = value; return this; }
        public String getLastName() { return lastName; }
        public ReservationSummary setLastName(String value) { this.lastName = value; return this; }
        public String getExternalProfileId() { return externalProfileId; }
        public ReservationSummary setExternalProfileId(String value) { this.externalProfileId = value; return this; }
        public String getExternalProfileId2() { return externalProfileId2; }
        public ReservationSummary setExternalProfileId2(String value) { this.externalProfileId2 = value; return this; }
        public String getExternalResID1() { return externalResID1; }
        public ReservationSummary setExternalResID1(String value) { this.externalResID1 = value; return this; }
        public String getExternalResID2() { return externalResID2; }
        public ReservationSummary setExternalResID2(String value) { this.externalResID2 = value; return this; }
        public String getCendynPropertyId() { return cendynPropertyId; }
        public ReservationSummary setCendynPropertyId(String value) { this.cendynPropertyId = value; return this; }
        public String getPropertyName() { return propertyName; }
        public ReservationSummary setPropertyName(String value) { this.propertyName = value; return this; }
        public String getResTypeCode() { return resTypeCode; }
        public ReservationSummary setResTypeCode(String value) { this.resTypeCode = value; return this; }
        public String getResStatusCode() { return resStatusCode; }
        public ReservationSummary setResStatusCode(String value) { this.resStatusCode = value; return this; }
        public String getConfirmationNum() { return confirmationNum; }
        public ReservationSummary setConfirmationNum(String value) { this.confirmationNum = value; return this; }
        public String getCentralResNum() { return centralResNum; }
        public ReservationSummary setCentralResNum(String value) { this.centralResNum = value; return this; }
        public Date getResArriveDate() { return resArriveDate; }
        public ReservationSummary setResArriveDate(Date value) { this.resArriveDate = value; return this; }
        public Date getResDepartDate() { return resDepartDate; }
        public ReservationSummary setResDepartDate(Date value) { this.resDepartDate = value; return this; }
        public Integer getNumRooms() { return numRooms; }
        public ReservationSummary setNumRooms(Integer value) { this.numRooms = value; return this; }
        public String getRoomTypeCode() { return roomTypeCode; }
        public ReservationSummary setRoomTypeCode(String value) { this.roomTypeCode = value; return this; }
        public String getRoomNumber() { return roomNumber; }
        public ReservationSummary setRoomNumber(String value) { this.roomNumber = value; return this; }
        public String getRateCode() { return rateCode; }
        public ReservationSummary setRateCode(String value) { this.rateCode = value; return this; }
        public String getMarketSegmentCode() { return marketSegmentCode; }
        public ReservationSummary setMarketSegmentCode(String value) { this.marketSegmentCode = value; return this; }
        public String getMarketCodeCategory() { return marketCodeCategory; }
        public ReservationSummary setMarketCodeCategory(String value) { this.marketCodeCategory = value; return this; }
        public String getMarketRegionCode() { return marketRegionCode; }
        public ReservationSummary setMarketRegionCode(String value) { this.marketRegionCode = value; return this; }
        public String getCompanyName() { return companyName; }
        public ReservationSummary setCompanyName(String value) { this.companyName = value; return this; }
        public Integer getNumAdults() { return numAdults; }
        public ReservationSummary setNumAdults(Integer value) { this.numAdults = value; return this; }
        public Integer getNumYouths() { return numYouths; }
        public ReservationSummary setNumYouths(Integer value) { this.numYouths = value; return this; }
        public Integer getNumChildren() { return numChildren; }
        public ReservationSummary setNumChildren(Integer value) { this.numChildren = value; return this; }
        public Integer getTotalRoomNights() { return totalRoomNights; }
        public ReservationSummary setTotalRoomNights(Integer value) { this.totalRoomNights = value; return this; }
        public String getCancellationID() { return cancellationID; }
        public ReservationSummary setCancellationID(String value) { this.cancellationID = value; return this; }
        public Date getCancellationDate() { return cancellationDate; }
        public ReservationSummary setCancellationDate(Date value) { this.cancellationDate = value; return this; }
        public BigDecimal getTotalOtherRevenue() { return totalOtherRevenue; }
        public ReservationSummary setTotalOtherRevenue(BigDecimal value) { this.totalOtherRevenue = value; return this; }
        public BigDecimal getTotalRoomRevenue() { return totalRoomRevenue; }
        public ReservationSummary setTotalRoomRevenue(BigDecimal value) { this.totalRoomRevenue = value; return this; }
        public BigDecimal getTotalTax() { return totalTax; }
        public ReservationSummary setTotalTax(BigDecimal value) { this.totalTax = value; return this; }
        public BigDecimal getTotalRevenue() { return totalRevenue; }
        public ReservationSummary setTotalRevenue(BigDecimal value) { this.totalRevenue = value; return this; }
        public Date getLastUpdated() { return lastUpdated; }
        public ReservationSummary setLastUpdated(Date value) { this.lastUpdated = value; return this; }
    }

}

Java 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>