Agentivity API

<back to all web services

GetCancelledHotelSegments

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 GetCancelledHotelSegments extends CompanyLevelRequestBase
    {
        /**
        * Date in format YYYYMMDD
        */
        @DataMember
        public String CancelledDateStart = null;

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

        /**
        * Comma Delimited List of CountryCodes
        */
        @DataMember
        public ArrayList<String> OwningAgencyCountryCode = null;

        /**
        * Return only PNRs with/without an Cancellation Reference
        */
        @DataMember
        public Boolean HasCancellationRemark = null;
        
        public String getCancelledDateStart() { return CancelledDateStart; }
        public GetCancelledHotelSegments setCancelledDateStart(String value) { this.CancelledDateStart = value; return this; }
        public String getCancelledDateEnd() { return CancelledDateEnd; }
        public GetCancelledHotelSegments setCancelledDateEnd(String value) { this.CancelledDateEnd = value; return this; }
        public ArrayList<String> getOwningAgencyCountryCode() { return OwningAgencyCountryCode; }
        public GetCancelledHotelSegments setOwningAgencyCountryCode(ArrayList<String> value) { this.OwningAgencyCountryCode = value; return this; }
        public Boolean isHasCancellationRemark() { return HasCancellationRemark; }
        public GetCancelledHotelSegments setHasCancellationRemark(Boolean value) { this.HasCancellationRemark = 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; }
    }

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

    @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="Segment", Namespace="schemas.agentivity.com/types")
    public static class CancelledHotelSegment
    {
        @DataMember(Order=10)
        public String RecordLocator = null;

        @DataMember(Order=20)
        public Date PNRCreationDate = null;

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

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

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

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

        @DataMember(Order=70)
        public String StatusCode = null;

        @DataMember(Order=80)
        public Date ArrivalDate = null;

        @DataMember(Order=90)
        public Date DepartureDate = null;

        @DataMember(Order=100)
        public String PropertyName = null;

        @DataMember(Order=110)
        public String Chain = null;

        @DataMember(Order=120)
        public String City = null;

        @DataMember(Order=130)
        public String Passenger = null;

        @DataMember(Order=140)
        public String ConfirmationNbr = null;

        @DataMember(Order=150)
        public String Currency = null;

        @DataMember(Order=160)
        public String Rate = null;

        @DataMember(Order=170)
        public String RoomBookingCode = null;

        @DataMember(Order=180)
        public Integer NbrNights = null;

        @DataMember(Order=190)
        public String MultiLevelRateCode = null;

        @DataMember(Order=200)
        public Integer NbrRooms = null;

        @DataMember(Order=210)
        public String BookedInName = null;

        @DataMember(Order=220)
        public String ServiceInformation = null;

        @DataMember(Order=230)
        public Date CancellationDate = null;

        @DataMember(Order=240)
        public String CancellationRemark = null;
        
        public String getRecordLocator() { return RecordLocator; }
        public CancelledHotelSegment setRecordLocator(String value) { this.RecordLocator = value; return this; }
        public Date getPnrCreationDate() { return PNRCreationDate; }
        public CancelledHotelSegment setPnrCreationDate(Date value) { this.PNRCreationDate = value; return this; }
        public String getOwningAgencyLocationID() { return OwningAgencyLocationID; }
        public CancelledHotelSegment setOwningAgencyLocationID(String value) { this.OwningAgencyLocationID = value; return this; }
        public String getAccount() { return Account; }
        public CancelledHotelSegment setAccount(String value) { this.Account = value; return this; }
        public String getOwningConsultantID() { return OwningConsultantID; }
        public CancelledHotelSegment setOwningConsultantID(String value) { this.OwningConsultantID = value; return this; }
        public String getOwningConsultant() { return OwningConsultant; }
        public CancelledHotelSegment setOwningConsultant(String value) { this.OwningConsultant = value; return this; }
        public String getStatusCode() { return StatusCode; }
        public CancelledHotelSegment setStatusCode(String value) { this.StatusCode = value; return this; }
        public Date getArrivalDate() { return ArrivalDate; }
        public CancelledHotelSegment setArrivalDate(Date value) { this.ArrivalDate = value; return this; }
        public Date getDepartureDate() { return DepartureDate; }
        public CancelledHotelSegment setDepartureDate(Date value) { this.DepartureDate = value; return this; }
        public String getPropertyName() { return PropertyName; }
        public CancelledHotelSegment setPropertyName(String value) { this.PropertyName = value; return this; }
        public String getChain() { return Chain; }
        public CancelledHotelSegment setChain(String value) { this.Chain = value; return this; }
        public String getCity() { return City; }
        public CancelledHotelSegment setCity(String value) { this.City = value; return this; }
        public String getPassenger() { return Passenger; }
        public CancelledHotelSegment setPassenger(String value) { this.Passenger = value; return this; }
        public String getConfirmationNbr() { return ConfirmationNbr; }
        public CancelledHotelSegment setConfirmationNbr(String value) { this.ConfirmationNbr = value; return this; }
        public String getCurrency() { return Currency; }
        public CancelledHotelSegment setCurrency(String value) { this.Currency = value; return this; }
        public String getRate() { return Rate; }
        public CancelledHotelSegment setRate(String value) { this.Rate = value; return this; }
        public String getRoomBookingCode() { return RoomBookingCode; }
        public CancelledHotelSegment setRoomBookingCode(String value) { this.RoomBookingCode = value; return this; }
        public Integer getNbrNights() { return NbrNights; }
        public CancelledHotelSegment setNbrNights(Integer value) { this.NbrNights = value; return this; }
        public String getMultiLevelRateCode() { return MultiLevelRateCode; }
        public CancelledHotelSegment setMultiLevelRateCode(String value) { this.MultiLevelRateCode = value; return this; }
        public Integer getNbrRooms() { return NbrRooms; }
        public CancelledHotelSegment setNbrRooms(Integer value) { this.NbrRooms = value; return this; }
        public String getBookedInName() { return BookedInName; }
        public CancelledHotelSegment setBookedInName(String value) { this.BookedInName = value; return this; }
        public String getServiceInformation() { return ServiceInformation; }
        public CancelledHotelSegment setServiceInformation(String value) { this.ServiceInformation = value; return this; }
        public Date getCancellationDate() { return CancellationDate; }
        public CancelledHotelSegment setCancellationDate(Date value) { this.CancellationDate = value; return this; }
        public String getCancellationRemark() { return CancellationRemark; }
        public CancelledHotelSegment setCancellationRemark(String value) { this.CancellationRemark = value; return this; }
    }

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

    @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 GetCancelledHotelSegments DTOs

GET /CancelledHotelSegments HTTP/1.1 
Host: servicestack.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>
      <RecordLocator>String</RecordLocator>
      <PNRCreationDate>0001-01-01T00:00:00</PNRCreationDate>
      <OwningAgencyLocationID>String</OwningAgencyLocationID>
      <Account>String</Account>
      <OwningConsultantID>String</OwningConsultantID>
      <OwningConsultant>String</OwningConsultant>
      <StatusCode>String</StatusCode>
      <ArrivalDate>0001-01-01T00:00:00</ArrivalDate>
      <DepartureDate>0001-01-01T00:00:00</DepartureDate>
      <PropertyName>String</PropertyName>
      <Chain>String</Chain>
      <City>String</City>
      <Passenger>String</Passenger>
      <ConfirmationNbr>String</ConfirmationNbr>
      <Currency>String</Currency>
      <Rate>String</Rate>
      <RoomBookingCode>String</RoomBookingCode>
      <NbrNights>0</NbrNights>
      <MultiLevelRateCode>String</MultiLevelRateCode>
      <NbrRooms>0</NbrRooms>
      <BookedInName>String</BookedInName>
      <ServiceInformation>String</ServiceInformation>
      <CancellationDate>0001-01-01T00:00:00</CancellationDate>
      <CancellationRemark>String</CancellationRemark>
    </Item>
  </ResponseReport>
  <ResponseError>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StatusCode>String</StatusCode>
    <VerboseMessage>String</VerboseMessage>
  </ResponseError>
</AgentivityResponse>