Agentivity API

<back to all web services

GetItineraryChangeEvents

The following routes are available for this service:
GET/ItineraryChangeEvents
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 GetItineraryChangeEvents extends PagingMetadata
    {
        /**
        * Comma Delimited List of Accounts
        */
        @DataMember
        public ArrayList<String> Account = null;

        /**
        * UserName in form of an email address
        */
        @DataMember
        public String UserName = null;

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

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

        /**
        * Return only PNRs that are ticketed/all
        */
        @DataMember
        public String PNRTicketed = null;

        /**
        * Add document information line 
        */
        @DataMember
        public Boolean AddDILine = null;

        /**
        * Comma Delimited List of Event Type Details. Valid values are: AirBkgCodeChanged, AirRouteChanged, AirStatusChanged, AirSupplierChanged, AirTimingsChanged, CarDatesTimingsChanged, CarLocationChanged, CarStatusChanged, CarSupplierChanged, CarTypeCodeChanged, FewerAirSegs, FewerCar_PSegs, FewerCarSegs, FewerHtl_PSegs, FewerHtlSegs, FewerTrn_PSegs, FlightNbrChanged, Htl_PChainChanged, Htl_PDatesChanged, Htl_PLocationChanged, Htl_PTextChanged, HtlChainChanged, HtlDatesChanged, HtlLocationChanged, HtlPropertyChanged, HtlRateCodeChanged, HtlRoomCodeChanged, HtlStatusChanged, MoreAirSegs, MoreCar_PSegs, MoreCarSegs, MoreHtl_PSegs, MoreHtlSegs, MoreTrn_PSegs, TrainDatesChanged
        */
        @DataMember
        public ArrayList<String> EventTypeDetail = null;
        
        public ArrayList<String> getAccount() { return Account; }
        public GetItineraryChangeEvents setAccount(ArrayList<String> value) { this.Account = value; return this; }
        public String getUserName() { return UserName; }
        public GetItineraryChangeEvents setUserName(String value) { this.UserName = value; return this; }
        public String getChangeDateStart() { return ChangeDateStart; }
        public GetItineraryChangeEvents setChangeDateStart(String value) { this.ChangeDateStart = value; return this; }
        public String getChangeDateEnd() { return ChangeDateEnd; }
        public GetItineraryChangeEvents setChangeDateEnd(String value) { this.ChangeDateEnd = value; return this; }
        public String getPnrTicketed() { return PNRTicketed; }
        public GetItineraryChangeEvents setPnrTicketed(String value) { this.PNRTicketed = value; return this; }
        public Boolean isAddDILine() { return AddDILine; }
        public GetItineraryChangeEvents setAddDILine(Boolean value) { this.AddDILine = value; return this; }
        public ArrayList<String> getEventTypeDetail() { return EventTypeDetail; }
        public GetItineraryChangeEvents setEventTypeDetail(ArrayList<String> value) { this.EventTypeDetail = 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 ItineraryChangeEventsItemResponse extends ItemResponse<ItineraryChangeEvent, ItineraryChangeEventsResponseReport>
    {
        
    }

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

        @DataMember(Order=20)
        public String RecordLocator = null;

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

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

        @DataMember(Order=50)
        public Date EventDateTime = null;

        @DataMember(Order=55)
        public String EventDateTimeFormatted = null;

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

        @DataMember(Order=65)
        public String EventTypeGroup = null;

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

        @DataMember(Order=80)
        public String NewData = null;

        @DataMember(Order=90)
        public String PNRTicketed = null;

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

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

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

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

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

        @DataMember(Order=150)
        public String AccountCode = null;
        
        public String getAgentivityRef() { return AgentivityRef; }
        public ItineraryChangeEvent setAgentivityRef(String value) { this.AgentivityRef = value; return this; }
        public String getRecordLocator() { return RecordLocator; }
        public ItineraryChangeEvent setRecordLocator(String value) { this.RecordLocator = value; return this; }
        public String getLastActionConsultant() { return LastActionConsultant; }
        public ItineraryChangeEvent setLastActionConsultant(String value) { this.LastActionConsultant = value; return this; }
        public String getPassengers() { return Passengers; }
        public ItineraryChangeEvent setPassengers(String value) { this.Passengers = value; return this; }
        public Date getEventDateTime() { return EventDateTime; }
        public ItineraryChangeEvent setEventDateTime(Date value) { this.EventDateTime = value; return this; }
        public String getEventDateTimeFormatted() { return EventDateTimeFormatted; }
        public ItineraryChangeEvent setEventDateTimeFormatted(String value) { this.EventDateTimeFormatted = value; return this; }
        public String getEventTypeDetail() { return EventTypeDetail; }
        public ItineraryChangeEvent setEventTypeDetail(String value) { this.EventTypeDetail = value; return this; }
        public String getEventTypeGroup() { return EventTypeGroup; }
        public ItineraryChangeEvent setEventTypeGroup(String value) { this.EventTypeGroup = value; return this; }
        public String getOldData() { return OldData; }
        public ItineraryChangeEvent setOldData(String value) { this.OldData = value; return this; }
        public String getNewData() { return NewData; }
        public ItineraryChangeEvent setNewData(String value) { this.NewData = value; return this; }
        public String getPnrTicketed() { return PNRTicketed; }
        public ItineraryChangeEvent setPnrTicketed(String value) { this.PNRTicketed = value; return this; }
        public String getFirstDILine() { return FirstDILine; }
        public ItineraryChangeEvent setFirstDILine(String value) { this.FirstDILine = value; return this; }
        public String getAccount() { return Account; }
        public ItineraryChangeEvent setAccount(String value) { this.Account = value; return this; }
        public String getPurchaseOrder() { return PurchaseOrder; }
        public ItineraryChangeEvent setPurchaseOrder(String value) { this.PurchaseOrder = value; return this; }
        public String getDivisionCode() { return DivisionCode; }
        public ItineraryChangeEvent setDivisionCode(String value) { this.DivisionCode = value; return this; }
        public String getBusinessUnit() { return BusinessUnit; }
        public ItineraryChangeEvent setBusinessUnit(String value) { this.BusinessUnit = value; return this; }
        public String getAccountCode() { return AccountCode; }
        public ItineraryChangeEvent setAccountCode(String value) { this.AccountCode = value; return this; }
    }

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

    @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 GetItineraryChangeEvents 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 /ItineraryChangeEvents 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>String</AgentivityRef>
      <RecordLocator>String</RecordLocator>
      <LastActionConsultant>String</LastActionConsultant>
      <Passengers>String</Passengers>
      <EventDateTime>0001-01-01T00:00:00</EventDateTime>
      <EventDateTimeFormatted>String</EventDateTimeFormatted>
      <EventTypeDetail>String</EventTypeDetail>
      <EventTypeGroup>String</EventTypeGroup>
      <OldData>String</OldData>
      <NewData>String</NewData>
      <PNRTicketed>String</PNRTicketed>
      <FirstDILine>String</FirstDILine>
      <Account>String</Account>
      <PurchaseOrder>String</PurchaseOrder>
      <DivisionCode>String</DivisionCode>
      <BusinessUnit>String</BusinessUnit>
      <AccountCode>String</AccountCode>
    </Item>
  </ResponseReport>
  <ResponseError>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StatusCode>String</StatusCode>
    <VerboseMessage>String</VerboseMessage>
  </ResponseError>
</AgentivityResponse>