Agentivity API

EventBookingsRequest

The following routes are available for this service:
GET	/EventBookings

**EventBookingsRequest** Parameters:
Name	Parameter	Data Type	Required	Description
UserName	query	string	Yes	UserName in form of an email address
EventCode	query	string	No	Event code
SplitMultiplePassengers	query	boolean	No	Split multiple passengers
IncludeNotes	query	boolean	No	Include notes in the response
IncludeArrivalDepartures	query	boolean	No	Include arrival departures
FormattingStyle	query	integer	No	Indicate the required formatting: 0=None(Default), 1=Html, 2=Chart
ItinerarySegmentsToShow	query	string	No	Itinerary segments to show

**PagingMetadata** Parameters:
Name	Parameter	Data Type	Required	Description
Offset	query	string	No	Starting Record
Limit	query	string	No	Number of records to return (PageSize)
TotalRecords	query	string	No	Total Number of Records in a Full Reponse (if no paging)
ResponseRecords	query	string	No	Total Number of Records in this Reponse (on this page)

**ItemResponse<TItem, TReport>** Parameters:
Name	Parameter	Data Type	Required
ResponseMetadata	form	ResponseMetadata	No
ResponseReport	form	TReport	No
ResponseError	form	AgentivityError	No

**ResponseMetadata** Parameters:
Name	Parameter	Data Type	Required
Success	form	bool	No
HasCache	form	bool	No
HasPaging	form	bool	No
CacheMetadata	form	CacheMetadata	No
PagingMetadata	form	PagingMetadata	No

**CacheMetadata** Parameters:
Name	Parameter	Data Type	Required
CachedAt	form	DateTime	No
CacheExpiresAt	form	DateTime	No
IsFromCache	form	bool	No

**AgentivityError** Parameters:
Name	Parameter	Data Type	Required
ErrorCode	form	string	No
Message	form	string	No
StatusCode	form	string	No
VerboseMessage	form	string	No

**EventBooking** Parameters:
Name	Parameter	Data Type	Required
RecordLocator	form	string	No
PNRCreationDate	form	DateTime	No
PaxList	form	string	No
PaxCount	form	int	No
InboundAirline	form	string	No
InboundFlightNumber	form	string	No
InboundArrivalCity	form	string	No
InboundArrivalDate	form	DateTime?	No
InboundArrivalTime	form	string	No
OutboundAirline	form	string	No
OutboundFlightNumber	form	string	No
OutboundDepartureCity	form	string	No
OutboundDepartureDate	form	DateTime?	No
OutboundDepartureTime	form	string	No
Notes	form	string	No
Emails	form	string	No
Mobile	form	string	No
TotalTicketedValue	form	string	No
AgentivityRef	form	int	No
ItineraryFormatted	form	string	No
Itinerary	form	ItinerarySegmentsCollection	No

**ItinerarySegment** Parameters:
Name	Parameter	Data Type	Required	Description
SegmentType	form	string	No
SegmentNbr	form	int	No
BoardPoint	form	string	No
OffPoint	form	string	No
OperatorCode	form	string	No
OperatorService	form	string	No
SegmentStatus	form	string	No
DepartureTimeFormatted	form	string	No
ArrivalTimeFormatted	form	string	No
ChangeOfDayFormatted	form	string	No
ServiceCode	form	string	No
StartDate	form	string	No
EndDate	form	string	No
TicketNumber	form	string	No
VendorLocators	query	string	No	Comma separated list of vendor locators
EquipmentCode	form	string	No
Equipment	form	string	No

**Report<TItemResponse, TItem>** Parameters:
Name	Parameter	Data Type	Required	Description
Item	form	TItem	No

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>