Agentivity API

<back to all web services

EventBookingsRequest

The following routes are available for this service:
GET/EventBookings
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 EventBookingsRequest extends PagingMetadata
    {
        /**
        * UserName in form of an email address
        */
        @DataMember
        public String UserName = null;

        /**
        * Event code
        */
        @DataMember
        public String EventCode = null;

        /**
        * Split multiple passengers
        */
        @DataMember
        public Boolean SplitMultiplePassengers = null;

        /**
        * Include notes in the response
        */
        @DataMember
        public Boolean IncludeNotes = null;

        /**
        * Include arrival departures
        */
        @DataMember
        public Boolean IncludeArrivalDepartures = null;

        /**
        * Indicate the required formatting: 0=None(Default), 1=Html, 2=Chart
        */
        @DataMember
        public Integer FormattingStyle = null;

        /**
        * Itinerary segments to show
        */
        @DataMember
        public String ItinerarySegmentsToShow = null;
        
        public String getUserName() { return UserName; }
        public EventBookingsRequest setUserName(String value) { this.UserName = value; return this; }
        public String getEventCode() { return EventCode; }
        public EventBookingsRequest setEventCode(String value) { this.EventCode = value; return this; }
        public Boolean isSplitMultiplePassengers() { return SplitMultiplePassengers; }
        public EventBookingsRequest setSplitMultiplePassengers(Boolean value) { this.SplitMultiplePassengers = value; return this; }
        public Boolean isIncludeNotes() { return IncludeNotes; }
        public EventBookingsRequest setIncludeNotes(Boolean value) { this.IncludeNotes = value; return this; }
        public Boolean isIncludeArrivalDepartures() { return IncludeArrivalDepartures; }
        public EventBookingsRequest setIncludeArrivalDepartures(Boolean value) { this.IncludeArrivalDepartures = value; return this; }
        public Integer getFormattingStyle() { return FormattingStyle; }
        public EventBookingsRequest setFormattingStyle(Integer value) { this.FormattingStyle = value; return this; }
        public String getItinerarySegmentsToShow() { return ItinerarySegmentsToShow; }
        public EventBookingsRequest setItinerarySegmentsToShow(String value) { this.ItinerarySegmentsToShow = 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 EventBookingsItemResponse extends ItemResponse<EventBooking, EventBookingsResponseReport>
    {
        
    }

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

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

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

        @DataMember(Order=35)
        public Integer PaxCount = null;

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

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

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

        @DataMember(Order=100)
        public Date InboundArrivalDate = null;

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

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

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

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

        @DataMember(Order=150)
        public Date OutboundDepartureDate = null;

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

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

        @DataMember(Order=180)
        public String Emails = null;

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

        @DataMember(Order=200)
        public String TotalTicketedValue = null;

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

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

        @DataMember(Order=60)
        public ItinerarySegmentsCollection Itinerary = null;
        
        public String getRecordLocator() { return RecordLocator; }
        public EventBooking setRecordLocator(String value) { this.RecordLocator = value; return this; }
        public Date getPnrCreationDate() { return PNRCreationDate; }
        public EventBooking setPnrCreationDate(Date value) { this.PNRCreationDate = value; return this; }
        public String getPaxList() { return PaxList; }
        public EventBooking setPaxList(String value) { this.PaxList = value; return this; }
        public Integer getPaxCount() { return PaxCount; }
        public EventBooking setPaxCount(Integer value) { this.PaxCount = value; return this; }
        public String getInboundAirline() { return InboundAirline; }
        public EventBooking setInboundAirline(String value) { this.InboundAirline = value; return this; }
        public String getInboundFlightNumber() { return InboundFlightNumber; }
        public EventBooking setInboundFlightNumber(String value) { this.InboundFlightNumber = value; return this; }
        public String getInboundArrivalCity() { return InboundArrivalCity; }
        public EventBooking setInboundArrivalCity(String value) { this.InboundArrivalCity = value; return this; }
        public Date getInboundArrivalDate() { return InboundArrivalDate; }
        public EventBooking setInboundArrivalDate(Date value) { this.InboundArrivalDate = value; return this; }
        public String getInboundArrivalTime() { return InboundArrivalTime; }
        public EventBooking setInboundArrivalTime(String value) { this.InboundArrivalTime = value; return this; }
        public String getOutboundAirline() { return OutboundAirline; }
        public EventBooking setOutboundAirline(String value) { this.OutboundAirline = value; return this; }
        public String getOutboundFlightNumber() { return OutboundFlightNumber; }
        public EventBooking setOutboundFlightNumber(String value) { this.OutboundFlightNumber = value; return this; }
        public String getOutboundDepartureCity() { return OutboundDepartureCity; }
        public EventBooking setOutboundDepartureCity(String value) { this.OutboundDepartureCity = value; return this; }
        public Date getOutboundDepartureDate() { return OutboundDepartureDate; }
        public EventBooking setOutboundDepartureDate(Date value) { this.OutboundDepartureDate = value; return this; }
        public String getOutboundDepartureTime() { return OutboundDepartureTime; }
        public EventBooking setOutboundDepartureTime(String value) { this.OutboundDepartureTime = value; return this; }
        public String getNotes() { return Notes; }
        public EventBooking setNotes(String value) { this.Notes = value; return this; }
        public String getEmails() { return Emails; }
        public EventBooking setEmails(String value) { this.Emails = value; return this; }
        public String getMobile() { return Mobile; }
        public EventBooking setMobile(String value) { this.Mobile = value; return this; }
        public String getTotalTicketedValue() { return TotalTicketedValue; }
        public EventBooking setTotalTicketedValue(String value) { this.TotalTicketedValue = value; return this; }
        public Integer getAgentivityRef() { return AgentivityRef; }
        public EventBooking setAgentivityRef(Integer value) { this.AgentivityRef = value; return this; }
        public String getItineraryFormatted() { return ItineraryFormatted; }
        public EventBooking setItineraryFormatted(String value) { this.ItineraryFormatted = value; return this; }
        public ItinerarySegmentsCollection getItinerary() { return Itinerary; }
        public EventBooking setItinerary(ItinerarySegmentsCollection value) { this.Itinerary = 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="EventBooking", Namespace="schemas.agentivity.com/types")
    public static class EventBookingsResponseReport extends Report<EventBookingsItemResponse, EventBooking>
    {
        
    }

    @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 EventBookingsRequest 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 /EventBookings 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>
      <RecordLocator>String</RecordLocator>
      <PNRCreationDate>0001-01-01T00:00:00</PNRCreationDate>
      <PaxList>String</PaxList>
      <PaxCount>0</PaxCount>
      <AgentivityRef>0</AgentivityRef>
      <ItineraryFormatted>String</ItineraryFormatted>
      <Itinerary>
        <ItinerarySegment>
          <ArrivalTimeFormatted>String</ArrivalTimeFormatted>
          <BoardPoint>String</BoardPoint>
          <ChangeOfDayFormatted>String</ChangeOfDayFormatted>
          <DepartureTimeFormatted>String</DepartureTimeFormatted>
          <EndDate>String</EndDate>
          <Equipment>String</Equipment>
          <EquipmentCode>String</EquipmentCode>
          <OffPoint>String</OffPoint>
          <OperatorCode>String</OperatorCode>
          <OperatorService>String</OperatorService>
          <SegmentNbr>0</SegmentNbr>
          <SegmentStatus>String</SegmentStatus>
          <SegmentType>String</SegmentType>
          <ServiceCode>String</ServiceCode>
          <StartDate>String</StartDate>
          <TicketNumber>String</TicketNumber>
          <VendorLocators>String</VendorLocators>
        </ItinerarySegment>
      </Itinerary>
      <InboundAirline>String</InboundAirline>
      <InboundFlightNumber>String</InboundFlightNumber>
      <InboundArrivalCity>String</InboundArrivalCity>
      <InboundArrivalDate>0001-01-01T00:00:00</InboundArrivalDate>
      <InboundArrivalTime>String</InboundArrivalTime>
      <OutboundAirline>String</OutboundAirline>
      <OutboundFlightNumber>String</OutboundFlightNumber>
      <OutboundDepartureCity>String</OutboundDepartureCity>
      <OutboundDepartureDate>0001-01-01T00:00:00</OutboundDepartureDate>
      <OutboundDepartureTime>String</OutboundDepartureTime>
      <Notes>String</Notes>
      <Emails>String</Emails>
      <Mobile>String</Mobile>
      <TotalTicketedValue>String</TotalTicketedValue>
    </Item>
  </ResponseReport>
  <ResponseError>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StatusCode>String</StatusCode>
    <VerboseMessage>String</VerboseMessage>
  </ResponseError>
</AgentivityResponse>