Agentivity API

BookingDetailsByRef

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

**BookingDetailsByRef** Parameters:
Name	Parameter	Data Type	Required	Description
AgentivityRef	query	integer	No	Agentivity Booking Reference
LoadOptions	query	string	No	Options to retrieve booking details (valid values are: Passengers, Itinerary, DiEntries, Phones, Notepads, VendorRemarks, Tickets, Versions, VendorLocators, CustomFields, Emails, AccountValue, EventDetails or EmailTrails). The option All can be used to get entire booking data.
RecordLocator	query	string	No	Record locator
PNRCreationDate	query	string	No	Date in format YYYYMMDD
RequestConsultantID	query	string	No	Request Consultant ID (sign on)

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

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

**BookingDetails** Parameters:
Name	Parameter	Data Type	Required
RecordLocator	form	string	No
PNRCreationDate	form	string	No
CreationDate	form	DateTime?	No
PNRTicketed	form	string	No
Account	form	string	No
OwningConsultantID	form	string	No
OwningConsultant	form	string	No
CrsDescription	form	string	No
LastActionConsultantID	form	string	No
LastActionAgencyLocationID	form	string	No
OwningAgencyLocationID	form	string	No
CreatingAgencyIata	form	string	No
CompanyID	form	int?	No
Passengers	form	List<PassengerDetails>	No
Phones	form	List<BookingPhone>	No
Notepads	form	List<BookingNotepad>	No
VendorRemarks	form	List<VendorRemark>	No
DiEntries	form	List<DiEntry>	No
Tickets	form	List<BookingTicket>	No
Versions	form	List<BookingVersion>	No
VendorLocators	form	List<BookingVendorLocator>	No
CustomFields	form	List<CustomFieldValue>	No
Emails	form	List<BookingEmail>	No
EventDetails	form	List<BookingEventDetail>	No
AccountLocations	form	List<BookingAccountLocation>	No
EmailTrails	form	List<BookingEmailTrail>	No
AgentivityWarnings	form	List<BookingDetailsWarning>	No
AirlineTicketingDues	form	List<BookingDetailsAirTicketingDue>	No
CTCE	form	string	No
CTCM	form	string	No
CarbonTonnage	form	double?	No
CarbonEmissions	form	List<CarbonEmission>	No
OwningCompanyCode	form	string	No
AgentivityRef	form	int	No
Itinerary	form	ItinerarySegmentsCollection	No
ItineraryFormatted	form	string	No

**PassengerDetails** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
FirstName	form	string	No
LastName	form	string	No
FrequentFlyers	form	List<FrequentFlyerDetails>	No
SequenceNbr	form	int	No
LastNameElement	form	int	No
IsVip	form	bool	No

**FrequentFlyerDetails** Parameters:
Name	Parameter	Data Type	Required
Vendor	form	string	No
Number	form	string	No
FullNumber	form	string	No

**BookingPhone** Parameters:
Name	Parameter	Data Type	Required
PhoneType	form	string	No
City	form	string	No
Number	form	string	No
SequenceNbr	form	int	No

**BookingNotepad** Parameters:
Name	Parameter	Data Type	Required
Remark	form	string	No
CreatedDate	form	DateTime?	No
CreatedTime	form	string	No
Qualifier	form	string	No
SequenceNbr	form	int	No

**VendorRemark** Parameters:
Name	Parameter	Data Type	Required	Description
VendorRemarkID	form	int	No

**VendorRemarkBase** Parameters:
Name	Parameter	Data Type	Required
TravelOrderIdentifier	form	int?	No
RmkNum	form	int?	No
DateStamp	form	DateTime?	No
TimeStamp	form	string	No
RemarkType	form	string	No
VendorType	form	string	No
Vendor	form	string	No
Remark	form	string	No

**DiEntry** Parameters:
Name	Parameter	Data Type	Required
SequenceNbr	form	int	No
Keyword	form	string	No
Remark	form	string	No

**BookingTicket** Parameters:
Name	Parameter	Data Type	Required
SegmentNbr	form	int	No
TicketNumber	form	string	No
TicketType	form	string	No
TicketDetailsAvailable	form	bool	No

**BookingVersion** Parameters:
Name	Parameter	Data Type	Required
AgentivityRef	form	int?	No
DataBaseTimeStamp	form	DateTime?	No
EventType	form	string	No
PnrTicketed	form	string	No
LastActionAgentId	form	string	No
AirSegs	form	int	No
AirPSegs	form	int	No
HtlSegs	form	int	No
HtlPSegs	form	int	No
CarSegs	form	int	No
CarPSegs	form	int	No
TrnPSegs	form	int	No
OwningAgencyLocationID	form	string	No

**BookingVendorLocator** Parameters:
Name	Parameter	Data Type	Required
AirSegmentNbr	form	int?	No
CarrierCode	form	string	No
VendorLocator	form	string	No

**CustomFieldValue** Parameters:
Name	Parameter	Data Type	Required
PNRPropertiesCustomFieldID	form	string	No
RecordLocator	form	string	No
PNRCreationDate	form	DateTime	No
FieldName	form	string	No
FieldValue	form	string	No
CustomFieldID	form	int?	No
CreationDateTime	form	DateTime?	No
ElementNumber	form	int?	No
GDS	form	string	No

**BookingEmail** Parameters:
Name	Parameter	Data Type	Required
SequenceNbr	form	int	No
EmailType	form	string	No
Email	form	string	No

**BookingEventDetail** Parameters:
Name	Parameter	Data Type	Required
ItineraryEventTypeDetailID	form	int	No
AgentivityRef	form	int	No
EventTypeDetail	form	string	No
OldData	form	string	No
NewData	form	string	No
DateTimeStamp	form	DateTime?	No
EventTypeDetailID	form	int?	No

**BookingAccountLocation** Parameters:
Name	Parameter	Data Type	Required
PrimaryAccountLocation	form	string	No
SecondaryAccountLocation	form	string	No
Valid	form	bool	No
ExactMatch	form	bool	No
GDS	form	string	No

**BookingEmailTrail** Parameters:
Name	Parameter	Data Type	Required
RecipientEmail	form	string	No
DeliveryDetails	form	string	No
MailSentDateTime	form	DateTime?	No
RecipientLastActivityEvent	form	string	No
EmailId	form	int?	No
UserId	form	int?	No
SentResponseMessage	form	string	No
SentResponseErrorCode	form	int?	No
DeliveredBookingID	form	int	No

**BookingDetailsWarning** Parameters:
Name	Parameter	Data Type	Required
Message	form	string	No
Vendor	form	string	No
WarningDateTime	form	DateTime?	No
OriginalRemark	form	string	No
ClearedDateTime	form	DateTime?	No
ClearedByConsultantID	form	string	No
PropertiesList	form	List<BookingWarningProperty>	No

**BookingWarningProperty** Parameters:
Name	Parameter	Data Type	Required	Description
Name	form	string	No
Value	form	string	No

**BookingDetailsAirTicketingDue** Parameters:
Name	Parameter	Data Type	Required
Airline	form	string	No
DueDate	form	DateTime?	No
DueTime	form	string	No

**CarbonEmission** Parameters:
Name	Parameter	Data Type	Required
Value	form	double?	No
Unit	form	MeasurementUnit	No
Provider	form	AssessmentProvider	No
CalculationDateTime	form	DateTime?	No
CalculationDetails	form	CarbonCalculationDetails	No

**MeasurementUnit** Parameters:
Name	Parameter	Data Type	Required
Id	form	short	No
Symbol	form	string	No
Name	form	string	No

**AssessmentProvider** Parameters:
Name	Parameter	Data Type	Required
Id	form	short	No
Name	form	string	No
Description	form	string	No
LogoPath	form	string	No

**CarbonCalculationDetails** Parameters:
Name	Parameter	Data Type	Required	Description
Id	form	short	No
Name	form	string	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 //BookingDetails 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>
    <BookingDetails>
      <AgentivityRef>0</AgentivityRef>
      <RecordLocator>String</RecordLocator>
      <PNRCreationDate>String</PNRCreationDate>
      <CreationDate>0001-01-01T00:00:00</CreationDate>
      <PNRTicketed>String</PNRTicketed>
      <Account>String</Account>
      <OwningConsultantID>String</OwningConsultantID>
      <OwningConsultant>String</OwningConsultant>
      <CrsDescription>String</CrsDescription>
      <LastActionConsultantID>String</LastActionConsultantID>
      <LastActionAgencyLocationID>String</LastActionAgencyLocationID>
      <OwningAgencyLocationID>String</OwningAgencyLocationID>
      <CreatingAgencyIata>String</CreatingAgencyIata>
      <CompanyID>0</CompanyID>
      <Passengers>
        <Passenger>
          <Id>0</Id>
          <FirstName>String</FirstName>
          <LastName>String</LastName>
          <FrequentFlyers>
            <FrequentFlyer>
              <Vendor>String</Vendor>
              <Number>String</Number>
              <FullNumber>String</FullNumber>
            </FrequentFlyer>
          </FrequentFlyers>
          <SequenceNbr>0</SequenceNbr>
          <LastNameElement>0</LastNameElement>
          <IsVip>false</IsVip>
        </Passenger>
      </Passengers>
      <Phones>
        <Phone>
          <PhoneType>String</PhoneType>
          <City>String</City>
          <Number>String</Number>
          <SequenceNbr>0</SequenceNbr>
        </Phone>
      </Phones>
      <Notepads>
        <Notepad>
          <Remark>String</Remark>
          <CreatedDate>0001-01-01T00:00:00</CreatedDate>
          <CreatedTime>String</CreatedTime>
          <Qualifier>String</Qualifier>
          <SequenceNbr>0</SequenceNbr>
        </Notepad>
      </Notepads>
      <VendorRemarks>
        <VendorRemark>
          <DateStamp>0001-01-01T00:00:00</DateStamp>
          <Remark>String</Remark>
          <RemarkType>String</RemarkType>
          <RmkNum>0</RmkNum>
          <TimeStamp>String</TimeStamp>
          <TravelOrderIdentifier>0</TravelOrderIdentifier>
          <Vendor>String</Vendor>
          <VendorType>String</VendorType>
          <VendorRemarkID>0</VendorRemarkID>
        </VendorRemark>
      </VendorRemarks>
      <DiEntries>
        <DIEntry>
          <SequenceNbr>0</SequenceNbr>
          <Keyword>String</Keyword>
          <Remark>String</Remark>
        </DIEntry>
      </DiEntries>
      <Tickets>
        <Ticket>
          <SegmentNbr>0</SegmentNbr>
          <TicketNumber>String</TicketNumber>
          <TicketType>String</TicketType>
          <TicketDetailsAvailable>false</TicketDetailsAvailable>
        </Ticket>
      </Tickets>
      <Versions>
        <Version>
          <AgentivityRef>0</AgentivityRef>
          <DataBaseTimeStamp>0001-01-01T00:00:00</DataBaseTimeStamp>
          <EventType>String</EventType>
          <PnrTicketed>String</PnrTicketed>
          <LastActionAgentId>String</LastActionAgentId>
          <AirSegs>0</AirSegs>
          <AirPSegs>0</AirPSegs>
          <HtlSegs>0</HtlSegs>
          <HtlPSegs>0</HtlPSegs>
          <CarSegs>0</CarSegs>
          <CarPSegs>0</CarPSegs>
          <TrnPSegs>0</TrnPSegs>
          <OwningAgencyLocationID>String</OwningAgencyLocationID>
        </Version>
      </Versions>
      <VendorLocators>
        <VendorLocator>
          <AirSegmentNbr>0</AirSegmentNbr>
          <CarrierCode>String</CarrierCode>
          <VendorLocator>String</VendorLocator>
        </VendorLocator>
      </VendorLocators>
      <CustomFields>
        <CustomFieldValue>
          <PNRPropertiesCustomFieldID>String</PNRPropertiesCustomFieldID>
          <RecordLocator>String</RecordLocator>
          <PNRCreationDate>0001-01-01T00:00:00</PNRCreationDate>
          <FieldName>String</FieldName>
          <FieldValue>String</FieldValue>
          <CustomFieldID>0</CustomFieldID>
          <CreationDateTime>0001-01-01T00:00:00</CreationDateTime>
          <ElementNumber>0</ElementNumber>
          <GDS>String</GDS>
        </CustomFieldValue>
      </CustomFields>
      <Emails>
        <Email>
          <SequenceNbr>0</SequenceNbr>
          <EmailType>String</EmailType>
          <Email>String</Email>
        </Email>
      </Emails>
      <EventDetails>
        <EventDetail>
          <ItineraryEventTypeDetailID>0</ItineraryEventTypeDetailID>
          <AgentivityRef>0</AgentivityRef>
          <EventTypeDetail>String</EventTypeDetail>
          <OldData>String</OldData>
          <NewData>String</NewData>
          <DateTimeStamp>0001-01-01T00:00:00</DateTimeStamp>
          <EventTypeDetailID>0</EventTypeDetailID>
        </EventDetail>
      </EventDetails>
      <AccountLocations>
        <AccountLocation>
          <PrimaryAccountLocation>String</PrimaryAccountLocation>
          <SecondaryAccountLocation>String</SecondaryAccountLocation>
          <Valid>false</Valid>
          <ExactMatch>false</ExactMatch>
          <GDS>String</GDS>
        </AccountLocation>
      </AccountLocations>
      <EmailTrails>
        <BookingEmailTrail>
          <RecipientEmail>String</RecipientEmail>
          <DeliveryDetails>String</DeliveryDetails>
          <MailSentDateTime>0001-01-01T00:00:00</MailSentDateTime>
          <RecipientLastActivityEvent>String</RecipientLastActivityEvent>
          <EmailId>0</EmailId>
          <UserId>0</UserId>
          <SentResponseMessage>String</SentResponseMessage>
          <SentResponseErrorCode>0</SentResponseErrorCode>
          <DeliveredBookingID>0</DeliveredBookingID>
        </BookingEmailTrail>
      </EmailTrails>
      <AgentivityWarnings>
        <Warning>
          <Message>String</Message>
          <Vendor>String</Vendor>
          <WarningDateTime>0001-01-01T00:00:00</WarningDateTime>
          <OriginalRemark>String</OriginalRemark>
          <ClearedDateTime>0001-01-01T00:00:00</ClearedDateTime>
          <ClearedByConsultantID>String</ClearedByConsultantID>
          <PropertiesList>
            <Property>
              <Name>String</Name>
              <Value>String</Value>
            </Property>
          </PropertiesList>
        </Warning>
      </AgentivityWarnings>
      <AirlineTicketingDues>
        <TicketingDue>
          <Airline>String</Airline>
          <DueDate>0001-01-01T00:00:00</DueDate>
          <DueTime>String</DueTime>
        </TicketingDue>
      </AirlineTicketingDues>
      <CTCE>String</CTCE>
      <CTCM>String</CTCM>
      <CarbonTonnage>0</CarbonTonnage>
      <CarbonEmissions>
        <CarbonEmission>
          <Value>0</Value>
          <Unit>
            <Id>0</Id>
            <Symbol>String</Symbol>
            <Name>String</Name>
          </Unit>
          <Provider>
            <Id>0</Id>
            <Name>String</Name>
            <Description>String</Description>
            <LogoPath>String</LogoPath>
          </Provider>
          <CalculationDateTime>0001-01-01T00:00:00</CalculationDateTime>
          <CalculationDetails>
            <Id>0</Id>
            <Name>String</Name>
          </CalculationDetails>
        </CarbonEmission>
      </CarbonEmissions>
      <OwningCompanyCode>String</OwningCompanyCode>
      <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>
    </BookingDetails>
  </ResponseReport>
  <ResponseError>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StatusCode>String</StatusCode>
    <VerboseMessage>String</VerboseMessage>
  </ResponseError>
</AgentivityResponse>