Agentivity API

GetBookingsCreated

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

**GetBookingsCreated** Parameters:
Name	Parameter	Data Type	Required	Description
IncludeCTFields	query	string	No	Includes CTCM and CTCE in results
Account	query	string	No	Comma Delimited List of Accounts
HasAccount	query	boolean	No	Return only PNRs with/without an account
HasEmail	query	boolean	No	Return only PNRs with/without an email address
HasHotel	query	boolean	No	Return only PNRs with/without a hotel
HasMobile	query	boolean	No	Return only PNRs with/without a mobile number
IncludeItinerary	query	boolean	No	Include Itinerary in the response
IsVip	query	boolean	No	Return only PNRs that are or are not flagged as VIP bookings
ItineraryFormatting	query	integer	No	Indicates the required formatting: 0=None(Default); 1= Html; 2 = Chart
MinSegments	query	integer	No	Return only PNRs that equal or exceed a certain number of segments
MissingEmailOrPhone	query	boolean	No	Return only PNRs with/without an email address OR a mobile number
PNRCreationDateEnd	query	string	Yes	Date in format YYYYMMDD
PNRCreationDateStart	query	string	Yes	Date in format YYYYMMDD
PNRCancelled	query	boolean	No	Return only PNRs that are cancelled(Y)/not cancelled(N)/all
OwningAgencyLocationID	query	string	No	Comma Delimited List of PCCs

**CompanyLevelRequestBase** Parameters:
Name	Parameter	Data Type	Required	Description
OwningCompanyCode	query	string	No	Comma Delimited List of Owning Company Codes
UserName	query	string	No	UserName in form of an email address

**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)

**FormattingStyle** Enum:
Name	Value
None	0
Html	1
Charting	2

**CollectionResponse<TItem>** Parameters:
Name	Parameter	Data Type	Required
ResponseMetadata	form	ResponseMetadata	No
ResponseReport	form	List<ApiRequestPerHour>	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

**ApiRequestPerHour** Parameters:
Name	Parameter	Data Type	Required
RequestDate	form	DateTime	No
Hour0	form	int	No
Hour1	form	int	No
Hour2	form	int	No
Hour3	form	int	No
Hour4	form	int	No
Hour5	form	int	No
Hour6	form	int	No
Hour7	form	int	No
Hour8	form	int	No
Hour9	form	int	No
Hour10	form	int	No
Hour11	form	int	No
Hour12	form	int	No
Hour13	form	int	No
Hour14	form	int	No
Hour15	form	int	No
Hour16	form	int	No
Hour17	form	int	No
Hour18	form	int	No
Hour19	form	int	No
Hour20	form	int	No
Hour21	form	int	No
Hour22	form	int	No
Hour23	form	int	No

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

**BookingCreated** Parameters:
Name	Parameter	Data Type	Required
AgentivityRef	form	int	No
RecordLocator	form	string	No
PNRCreationDate	form	DateTime?	No
OwningAgencyLocationID	form	string	No
Account	form	string	No
OwningConsultantID	form	string	No
OwningConsultant	form	string	No
PNRTicketed	form	string	No
PNRTicketedDate	form	DateTime?	No
PNRCancelled	form	string	No
TravelDate	form	DateTime?	No
CancelledTravelDate	form	DateTime?	No
Passengers	form	string	No
Mobile	form	string	No
Emails	form	string	No
DestinationCount	form	int	No
IsVip	form	bool	No
CTCM	form	string	No
CTCE	form	string	No
Itinerary	form	ItinerarySegmentsCollection	No
ItineraryFormatted	form	string	No
CarbonTonnage	form	double?	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

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 /BookingsCreated 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>
    <BookingCreated>
      <AgentivityRef>0</AgentivityRef>
      <RecordLocator>String</RecordLocator>
      <PNRCreationDate>0001-01-01T00:00:00</PNRCreationDate>
      <OwningAgencyLocationID>String</OwningAgencyLocationID>
      <Account>String</Account>
      <OwningConsultantID>String</OwningConsultantID>
      <OwningConsultant>String</OwningConsultant>
      <PNRTicketed>String</PNRTicketed>
      <PNRTicketedDate>0001-01-01T00:00:00</PNRTicketedDate>
      <PNRCancelled>String</PNRCancelled>
      <TravelDate>0001-01-01T00:00:00</TravelDate>
      <CancelledTravelDate>0001-01-01T00:00:00</CancelledTravelDate>
      <Passengers>String</Passengers>
      <Mobile>String</Mobile>
      <Emails>String</Emails>
      <DestinationCount>0</DestinationCount>
      <IsVip>false</IsVip>
      <CTCM>String</CTCM>
      <CTCE>String</CTCE>
      <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>
      <ItineraryFormatted>String</ItineraryFormatted>
      <CarbonTonnage>0</CarbonTonnage>
    </BookingCreated>
  </ResponseReport>
  <ResponseError>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StatusCode>String</StatusCode>
    <VerboseMessage>String</VerboseMessage>
  </ResponseError>
</AgentivityResponse>