Agentivity API

<back to all web services

GetHotelBookingsByRateCode

The following routes are available for this service:
GET/HotelBookings
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    @DataContract(Namespace="schemas.agentivity.com/types")
    public static class GetHotelBookingsByRateCode extends CompanyLevelRequestBase
    {
        /**
        * Account
        */
        @DataMember
        public String Account = null;

        /**
        * Date in format YYYYMMDD
        */
        @DataMember
        public String PNRCreationDateStart = null;

        /**
        * Date in format YYYYMMDD
        */
        @DataMember
        public String PNRCreationDateEnd = null;

        /**
        * Return only PNRs with/without a Rate code
        */
        @DataMember
        public Boolean HasRateCode = null;

        /**
        * Indicate the required formatting: 0=None(Default), 1= Html, 2 = Chart
        */
        @DataMember
        public FormattingStyle Formatting = null;
        
        public String getAccount() { return Account; }
        public GetHotelBookingsByRateCode setAccount(String value) { this.Account = value; return this; }
        public String getPnrCreationDateStart() { return PNRCreationDateStart; }
        public GetHotelBookingsByRateCode setPnrCreationDateStart(String value) { this.PNRCreationDateStart = value; return this; }
        public String getPnrCreationDateEnd() { return PNRCreationDateEnd; }
        public GetHotelBookingsByRateCode setPnrCreationDateEnd(String value) { this.PNRCreationDateEnd = value; return this; }
        public Boolean isHasRateCode() { return HasRateCode; }
        public GetHotelBookingsByRateCode setHasRateCode(Boolean value) { this.HasRateCode = value; return this; }
        public FormattingStyle getFormatting() { return Formatting; }
        public GetHotelBookingsByRateCode setFormatting(FormattingStyle value) { this.Formatting = value; return this; }
    }

    @DataContract(Namespace="schemas.agentivity.com/types")
    public static class CompanyLevelRequestBase extends PagingMetadata implements IMemberUsername, IMemberOwningCompanyCode
    {
        /**
        * Comma Delimited List of Owning Company Codes
        */
        @DataMember
        public ArrayList<String> OwningCompanyCode = null;

        /**
        * UserName in form of an email address
        */
        @DataMember
        public String UserName = null;
        
        public ArrayList<String> getOwningCompanyCode() { return OwningCompanyCode; }
        public CompanyLevelRequestBase setOwningCompanyCode(ArrayList<String> value) { this.OwningCompanyCode = value; return this; }
        public String getUserName() { return UserName; }
        public CompanyLevelRequestBase setUserName(String value) { this.UserName = value; return this; }
    }

    @DataContract(Name="Metadata", Namespace="schemas.agentivity.com/types")
    public static class PagingMetadata
    {
        /**
        * Starting Record
        */
        @DataMember
        @ApiMember(DataType="string", Description="Starting Record", Name="Offset", ParameterType="query")
        public String Offset = null;

        /**
        * Number of records to return (PageSize)
        */
        @DataMember
        @ApiMember(DataType="string", Description="Number of records to return (PageSize)", Name="Limit", ParameterType="query")
        public String Limit = null;

        /**
        * Total Number of Records in a Full Reponse (if no paging)
        */
        @DataMember
        @ApiMember(DataType="string", Description="Total Number of Records in a Full Reponse (if no paging)", Name="TotalRecords", ParameterType="query")
        public Integer TotalRecords = null;

        /**
        * Total Number of Records in this Reponse (on this page)
        */
        @DataMember
        @ApiMember(DataType="string", Description="Total Number of Records in this Reponse (on this page)", Name="ResponseRecords", ParameterType="query")
        public Integer ResponseRecords = null;
        
        public String getOffset() { return Offset; }
        public PagingMetadata setOffset(String value) { this.Offset = value; return this; }
        public String getLimit() { return Limit; }
        public PagingMetadata setLimit(String value) { this.Limit = value; return this; }
        public Integer getTotalRecords() { return TotalRecords; }
        public PagingMetadata setTotalRecords(Integer value) { this.TotalRecords = value; return this; }
        public Integer getResponseRecords() { return ResponseRecords; }
        public PagingMetadata setResponseRecords(Integer value) { this.ResponseRecords = value; return this; }
    }

    @Flags()
    public static enum FormattingStyle
    {
        @SerializedName("0") None(0),
        @SerializedName("1") Html(1),
        @SerializedName("2") Charting(2);

        private final int value;
        FormattingStyle(final int intValue) { value = intValue; }
        public int getValue() { return value; }
    }

    @DataContract(Name="AgentivityResponse", Namespace="schemas.agentivity.com/types")
    public static class HotelBookingsByRateCodeItemResponse extends ItemResponse<HotelBooking, HotelBookingsByRateCodeResponseReport>
    {
        
    }

    @DataContract(Name="AgentivityResponse", Namespace="schemas.agentivity.com/types")
    public static class ItemResponse<TItem, TReport>
    {
        @DataMember(Order=1)
        public ResponseMetadata ResponseMetadata = null;

        @DataMember(Order=2, EmitDefaultValue=false)
        public TReport ResponseReport = null;

        @DataMember(Order=3, EmitDefaultValue=false)
        public AgentivityError ResponseError = null;
        
        public ResponseMetadata getResponseMetadata() { return ResponseMetadata; }
        public ItemResponse<TItem, TReport> setResponseMetadata(ResponseMetadata value) { this.ResponseMetadata = value; return this; }
        public TReport getResponseReport() { return ResponseReport; }
        public ItemResponse<TItem, TReport> setResponseReport(TReport value) { this.ResponseReport = value; return this; }
        public AgentivityError getResponseError() { return ResponseError; }
        public ItemResponse<TItem, TReport> setResponseError(AgentivityError value) { this.ResponseError = value; return this; }
    }

    @DataContract(Name="ResponseMetadata", Namespace="schemas.agentivity.com/types")
    public static class ResponseMetadata
    {
        @DataMember(Order=0)
        public Boolean Success = null;

        @DataMember(Order=1)
        public Boolean HasCache = null;

        @DataMember(Order=2)
        public Boolean HasPaging = null;

        @DataMember(Order=3, EmitDefaultValue=false)
        public CacheMetadata CacheMetadata = null;

        @DataMember(Order=4, EmitDefaultValue=false)
        public PagingMetadata PagingMetadata = null;
        
        public Boolean isSuccess() { return Success; }
        public ResponseMetadata setSuccess(Boolean value) { this.Success = value; return this; }
        public Boolean isHasCache() { return HasCache; }
        public ResponseMetadata setHasCache(Boolean value) { this.HasCache = value; return this; }
        public Boolean isHasPaging() { return HasPaging; }
        public ResponseMetadata setHasPaging(Boolean value) { this.HasPaging = value; return this; }
        public CacheMetadata getCacheMetadata() { return CacheMetadata; }
        public ResponseMetadata setCacheMetadata(CacheMetadata value) { this.CacheMetadata = value; return this; }
        public PagingMetadata getPagingMetadata() { return PagingMetadata; }
        public ResponseMetadata setPagingMetadata(PagingMetadata value) { this.PagingMetadata = value; return this; }
    }

    @DataContract(Name="CacheMetadata", Namespace="schemas.agentivity.com/types")
    public static class CacheMetadata
    {
        @DataMember(Order=1)
        public Date CachedAt = null;

        @DataMember(Order=2)
        public Date CacheExpiresAt = null;

        @DataMember(Order=0)
        public Boolean IsFromCache = null;
        
        public Date getCachedAt() { return CachedAt; }
        public CacheMetadata setCachedAt(Date value) { this.CachedAt = value; return this; }
        public Date getCacheExpiresAt() { return CacheExpiresAt; }
        public CacheMetadata setCacheExpiresAt(Date value) { this.CacheExpiresAt = value; return this; }
        public Boolean getIsFromCache() { return IsFromCache; }
        public CacheMetadata setIsFromCache(Boolean value) { this.IsFromCache = value; return this; }
    }

    @DataContract(Name="ResponseMetadata", Namespace="schemas.agentivity.com/types")
    public static class AgentivityError
    {
        @DataMember
        public String ErrorCode = null;

        @DataMember
        public String Message = null;

        @DataMember
        public String StatusCode = null;

        @DataMember
        public String VerboseMessage = null;
        
        public String getErrorCode() { return ErrorCode; }
        public AgentivityError setErrorCode(String value) { this.ErrorCode = value; return this; }
        public String getMessage() { return Message; }
        public AgentivityError setMessage(String value) { this.Message = value; return this; }
        public String getStatusCode() { return StatusCode; }
        public AgentivityError setStatusCode(String value) { this.StatusCode = value; return this; }
        public String getVerboseMessage() { return VerboseMessage; }
        public AgentivityError setVerboseMessage(String value) { this.VerboseMessage = value; return this; }
    }

    @DataContract(Name="HotelBooking", Namespace="schemas.agentivity.com/types")
    public static class HotelBooking implements IBookingItinerary
    {
        @DataMember(Order=20)
        public String RecordLocator = null;

        @DataMember(Order=30)
        public String PNRCreationDate = null;

        @DataMember(Order=40)
        public String Passengers = null;

        @DataMember(Order=50)
        public String Account = null;

        @DataMember(Order=60)
        public String OwningConsultant = null;

        @DataMember(Order=10)
        public Integer AgentivityRef = null;

        @DataMember(Order=80)
        public String ItineraryFormatted = null;
        
        public String getRecordLocator() { return RecordLocator; }
        public HotelBooking setRecordLocator(String value) { this.RecordLocator = value; return this; }
        public String getPnrCreationDate() { return PNRCreationDate; }
        public HotelBooking setPnrCreationDate(String value) { this.PNRCreationDate = value; return this; }
        public String getPassengers() { return Passengers; }
        public HotelBooking setPassengers(String value) { this.Passengers = value; return this; }
        public String getAccount() { return Account; }
        public HotelBooking setAccount(String value) { this.Account = value; return this; }
        public String getOwningConsultant() { return OwningConsultant; }
        public HotelBooking setOwningConsultant(String value) { this.OwningConsultant = value; return this; }
        public Integer getAgentivityRef() { return AgentivityRef; }
        public HotelBooking setAgentivityRef(Integer value) { this.AgentivityRef = value; return this; }
        public String getItineraryFormatted() { return ItineraryFormatted; }
        public HotelBooking setItineraryFormatted(String value) { this.ItineraryFormatted = value; return this; }
    }

    @DataContract(Name="HotelBooking", Namespace="schemas.agentivity.com/types")
    public static class HotelBookingsByRateCodeResponseReport extends Report<HotelBookingsByRateCodeItemResponse, HotelBooking>
    {
        
    }

    @DataContract(Namespace="schemas.agentivity.com/types")
    public static class Report<TItemResponse, TItem>
    {
        @DataMember(Order=1, EmitDefaultValue=false)
        public TItem Item = null;
        
        public TItem getItem() { return Item; }
        public Report<TItemResponse, TItem> setItem(TItem value) { this.Item = value; return this; }
    }

}

Java GetHotelBookingsByRateCode 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 /HotelBookings HTTP/1.1 
Host: api.agentivity.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<AgentivityResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="schemas.agentivity.com/types">
  <ResponseMetadata>
    <Success>false</Success>
    <HasCache>false</HasCache>
    <HasPaging>false</HasPaging>
    <CacheMetadata>
      <IsFromCache>false</IsFromCache>
      <CachedAt>0001-01-01T00:00:00</CachedAt>
      <CacheExpiresAt>0001-01-01T00:00:00</CacheExpiresAt>
    </CacheMetadata>
    <PagingMetadata>
      <Limit>String</Limit>
      <Offset>String</Offset>
      <ResponseRecords>0</ResponseRecords>
      <TotalRecords>0</TotalRecords>
    </PagingMetadata>
  </ResponseMetadata>
  <ResponseReport>
    <Item>
      <AgentivityRef>0</AgentivityRef>
      <RecordLocator>String</RecordLocator>
      <PNRCreationDate>String</PNRCreationDate>
      <Passengers>String</Passengers>
      <Account>String</Account>
      <OwningConsultant>String</OwningConsultant>
      <ItineraryFormatted>String</ItineraryFormatted>
    </Item>
  </ResponseReport>
  <ResponseError>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StatusCode>String</StatusCode>
    <VerboseMessage>String</VerboseMessage>
  </ResponseError>
</AgentivityResponse>