Agentivity API

<back to all web services

GetPassengerDepartures

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

        /**
        * Name of the class
        */
        @DataMember
        public ArrayList<String> ClassName = null;

        /**
        * Carrier name
        */
        @DataMember
        public ArrayList<String> Carrier = null;

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

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

        /**
        * Include items with SMS sent in response
        */
        @DataMember
        public Boolean WithSMS = null;

        /**
        * Add transfers
        */
        @DataMember
        public Boolean AddVouchers = null;

        /**
        * Add transfers
        */
        @DataMember
        public Boolean AddTransfers = null;

        /**
        * Include Itinerary in the response
        */
        @DataMember
        public Boolean IncludeItinerary = null;

        /**
        * Return only PNRs that are or are not flagged as VIP bookings
        */
        @DataMember
        public Boolean IsVip = null;

        /**
        * Show SMS
        */
        @DataMember
        public Boolean ShowSMS = null;

        /**
        * Indicates the required formatting: 0=None(Default); 1= Html; 2 = Chart
        */
        @DataMember
        public FormattingStyle ItineraryFormatting = null;
        
        public ArrayList<String> getAccount() { return Account; }
        public GetPassengerDepartures setAccount(ArrayList<String> value) { this.Account = value; return this; }
        public ArrayList<String> getClassName() { return ClassName; }
        public GetPassengerDepartures setClassName(ArrayList<String> value) { this.ClassName = value; return this; }
        public ArrayList<String> getCarrier() { return Carrier; }
        public GetPassengerDepartures setCarrier(ArrayList<String> value) { this.Carrier = value; return this; }
        public String getTravelDateStart() { return TravelDateStart; }
        public GetPassengerDepartures setTravelDateStart(String value) { this.TravelDateStart = value; return this; }
        public String getTravelDateEnd() { return TravelDateEnd; }
        public GetPassengerDepartures setTravelDateEnd(String value) { this.TravelDateEnd = value; return this; }
        public Boolean isWithSMS() { return WithSMS; }
        public GetPassengerDepartures setWithSMS(Boolean value) { this.WithSMS = value; return this; }
        public Boolean isAddVouchers() { return AddVouchers; }
        public GetPassengerDepartures setAddVouchers(Boolean value) { this.AddVouchers = value; return this; }
        public Boolean isAddTransfers() { return AddTransfers; }
        public GetPassengerDepartures setAddTransfers(Boolean value) { this.AddTransfers = value; return this; }
        public Boolean isIncludeItinerary() { return IncludeItinerary; }
        public GetPassengerDepartures setIncludeItinerary(Boolean value) { this.IncludeItinerary = value; return this; }
        public Boolean getIsVip() { return IsVip; }
        public GetPassengerDepartures setIsVip(Boolean value) { this.IsVip = value; return this; }
        public Boolean isShowSMS() { return ShowSMS; }
        public GetPassengerDepartures setShowSMS(Boolean value) { this.ShowSMS = value; return this; }
        public FormattingStyle getItineraryFormatting() { return ItineraryFormatting; }
        public GetPassengerDepartures setItineraryFormatting(FormattingStyle value) { this.ItineraryFormatting = 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 PassengerDeparturesItemResponse extends ItemResponse<PassengerDeparture, PassengerDeparturesResponseReport>
    {
        
    }

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

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

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

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

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

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

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

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

        @DataMember(Order=60)
        public Date TravelDate = null;

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

        @DataMember(Order=75)
        public String TicketedStatus = null;

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

        @DataMember(Order=85)
        public String SMS = null;

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

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

        @DataMember(Order=110)
        public Boolean IsVip = null;

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

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

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

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

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

        @DataMember(Order=200)
        public ItinerarySegmentsCollection Itinerary = null;

        @DataMember(Order=210)
        public String ItineraryFormatted = null;
        
        public Integer getAgentivityRef() { return AgentivityRef; }
        public PassengerDeparture setAgentivityRef(Integer value) { this.AgentivityRef = value; return this; }
        public String getRecordLocator() { return RecordLocator; }
        public PassengerDeparture setRecordLocator(String value) { this.RecordLocator = value; return this; }
        public String getOwningAgencyLocationID() { return OwningAgencyLocationID; }
        public PassengerDeparture setOwningAgencyLocationID(String value) { this.OwningAgencyLocationID = value; return this; }
        public String getOwningConsultant() { return OwningConsultant; }
        public PassengerDeparture setOwningConsultant(String value) { this.OwningConsultant = value; return this; }
        public String getOwningConsultantID() { return OwningConsultantID; }
        public PassengerDeparture setOwningConsultantID(String value) { this.OwningConsultantID = value; return this; }
        public String getGdsCode() { return GdsCode; }
        public PassengerDeparture setGdsCode(String value) { this.GdsCode = value; return this; }
        public String getPassenger() { return Passenger; }
        public PassengerDeparture setPassenger(String value) { this.Passenger = value; return this; }
        public String getAccount() { return Account; }
        public PassengerDeparture setAccount(String value) { this.Account = value; return this; }
        public Date getTravelDate() { return TravelDate; }
        public PassengerDeparture setTravelDate(Date value) { this.TravelDate = value; return this; }
        public String getTicketedStatusCode() { return TicketedStatusCode; }
        public PassengerDeparture setTicketedStatusCode(String value) { this.TicketedStatusCode = value; return this; }
        public String getTicketedStatus() { return TicketedStatus; }
        public PassengerDeparture setTicketedStatus(String value) { this.TicketedStatus = value; return this; }
        public String getSupplierReference() { return SupplierReference; }
        public PassengerDeparture setSupplierReference(String value) { this.SupplierReference = value; return this; }
        public String getSms() { return SMS; }
        public PassengerDeparture setSms(String value) { this.SMS = value; return this; }
        public String getVouchers() { return Vouchers; }
        public PassengerDeparture setVouchers(String value) { this.Vouchers = value; return this; }
        public String getTransfers() { return Transfers; }
        public PassengerDeparture setTransfers(String value) { this.Transfers = value; return this; }
        public Boolean getIsVip() { return IsVip; }
        public PassengerDeparture setIsVip(Boolean value) { this.IsVip = value; return this; }
        public String getPhoneNbr() { return PhoneNbr; }
        public PassengerDeparture setPhoneNbr(String value) { this.PhoneNbr = value; return this; }
        public String getEmailAddress() { return EmailAddress; }
        public PassengerDeparture setEmailAddress(String value) { this.EmailAddress = value; return this; }
        public String getDestinationCities() { return DestinationCities; }
        public PassengerDeparture setDestinationCities(String value) { this.DestinationCities = value; return this; }
        public String getDestinationCountries() { return DestinationCountries; }
        public PassengerDeparture setDestinationCountries(String value) { this.DestinationCountries = value; return this; }
        public String getConnections() { return Connections; }
        public PassengerDeparture setConnections(String value) { this.Connections = value; return this; }
        public ItinerarySegmentsCollection getItinerary() { return Itinerary; }
        public PassengerDeparture setItinerary(ItinerarySegmentsCollection value) { this.Itinerary = value; return this; }
        public String getItineraryFormatted() { return ItineraryFormatted; }
        public PassengerDeparture setItineraryFormatted(String value) { this.ItineraryFormatted = value; return this; }
    }

    public static class ItinerarySegmentsCollection extends ArrayList<ItinerarySegment>
    {
        
    }

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

        @DataMember
        public Integer SegmentNbr = null;

        @DataMember
        public String BoardPoint = null;

        @DataMember
        public String OffPoint = null;

        @DataMember
        public String OperatorCode = null;

        @DataMember
        public String OperatorService = null;

        @DataMember
        public String SegmentStatus = null;

        @DataMember
        public String DepartureTimeFormatted = null;

        @DataMember
        public String ArrivalTimeFormatted = null;

        @DataMember
        public String ChangeOfDayFormatted = null;

        @DataMember
        public String ServiceCode = null;

        @DataMember
        public String StartDate = null;

        @DataMember
        public String EndDate = null;

        @DataMember
        public String TicketNumber = null;

        /**
        * Comma separated list of vendor locators
        */
        @DataMember
        public String VendorLocators = null;

        @DataMember
        public String EquipmentCode = null;

        @DataMember
        public String Equipment = null;
        
        public String getSegmentType() { return SegmentType; }
        public ItinerarySegment setSegmentType(String value) { this.SegmentType = value; return this; }
        public Integer getSegmentNbr() { return SegmentNbr; }
        public ItinerarySegment setSegmentNbr(Integer value) { this.SegmentNbr = value; return this; }
        public String getBoardPoint() { return BoardPoint; }
        public ItinerarySegment setBoardPoint(String value) { this.BoardPoint = value; return this; }
        public String getOffPoint() { return OffPoint; }
        public ItinerarySegment setOffPoint(String value) { this.OffPoint = value; return this; }
        public String getOperatorCode() { return OperatorCode; }
        public ItinerarySegment setOperatorCode(String value) { this.OperatorCode = value; return this; }
        public String getOperatorService() { return OperatorService; }
        public ItinerarySegment setOperatorService(String value) { this.OperatorService = value; return this; }
        public String getSegmentStatus() { return SegmentStatus; }
        public ItinerarySegment setSegmentStatus(String value) { this.SegmentStatus = value; return this; }
        public String getDepartureTimeFormatted() { return DepartureTimeFormatted; }
        public ItinerarySegment setDepartureTimeFormatted(String value) { this.DepartureTimeFormatted = value; return this; }
        public String getArrivalTimeFormatted() { return ArrivalTimeFormatted; }
        public ItinerarySegment setArrivalTimeFormatted(String value) { this.ArrivalTimeFormatted = value; return this; }
        public String getChangeOfDayFormatted() { return ChangeOfDayFormatted; }
        public ItinerarySegment setChangeOfDayFormatted(String value) { this.ChangeOfDayFormatted = value; return this; }
        public String getServiceCode() { return ServiceCode; }
        public ItinerarySegment setServiceCode(String value) { this.ServiceCode = value; return this; }
        public String getStartDate() { return StartDate; }
        public ItinerarySegment setStartDate(String value) { this.StartDate = value; return this; }
        public String getEndDate() { return EndDate; }
        public ItinerarySegment setEndDate(String value) { this.EndDate = value; return this; }
        public String getTicketNumber() { return TicketNumber; }
        public ItinerarySegment setTicketNumber(String value) { this.TicketNumber = value; return this; }
        public String getVendorLocators() { return VendorLocators; }
        public ItinerarySegment setVendorLocators(String value) { this.VendorLocators = value; return this; }
        public String getEquipmentCode() { return EquipmentCode; }
        public ItinerarySegment setEquipmentCode(String value) { this.EquipmentCode = value; return this; }
        public String getEquipment() { return Equipment; }
        public ItinerarySegment setEquipment(String value) { this.Equipment = value; return this; }
    }

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

    @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 GetPassengerDepartures 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 /PassengerDepartures HTTP/1.1 
Host: api.agentivity.com 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"ResponseMetadata":{"Success":false,"HasCache":false,"HasPaging":false,"CacheMetadata":{"IsFromCache":false,"CachedAt":"\/Date(-62135596800000-0000)\/","CacheExpiresAt":"\/Date(-62135596800000-0000)\/"},"PagingMetadata":{"Offset":"String","Limit":"String","TotalRecords":0,"ResponseRecords":0}},"ResponseReport":{"Item":{"AgentivityRef":0,"RecordLocator":"String","OwningAgencyLocationID":"String","OwningConsultant":"String","OwningConsultantID":"String","GdsCode":"String","Passenger":"String","Account":"String","TravelDate":"\/Date(-62135596800000-0000)\/","TicketedStatusCode":"String","TicketedStatus":"String","SupplierReference":"String","SMS":"String","Vouchers":"String","Transfers":"String","IsVip":false,"PhoneNbr":"String","EmailAddress":"String","DestinationCities":"String","DestinationCountries":"String","Connections":"String","Itinerary":[{"SegmentType":"String","SegmentNbr":0,"BoardPoint":"String","OffPoint":"String","OperatorCode":"String","OperatorService":"String","SegmentStatus":"String","DepartureTimeFormatted":"String","ArrivalTimeFormatted":"String","ChangeOfDayFormatted":"String","ServiceCode":"String","StartDate":"String","EndDate":"String","TicketNumber":"String","VendorLocators":"String","EquipmentCode":"String","Equipment":"String"}],"ItineraryFormatted":"String"}},"ResponseError":{"ErrorCode":"String","Message":"String","StatusCode":"String","VerboseMessage":"String"}}