Agentivity API

<back to all web services

GetPNRSegments

The following routes are available for this service:
GET/PNRSegments
GetPNRSegments Parameters:
NameParameterData TypeRequiredDescription
RecordLocatorquerystringYesRecord locator
PNRCreationDatequerystringNoDate in format YYYYMMDD
SegmentTypequerystringNoType of segment
PassiveSegmentTypequerystringNoType of passive segment
PagingMetadata Parameters:
NameParameterData TypeRequiredDescription
OffsetquerystringNoStarting Record
LimitquerystringNoNumber of records to return (PageSize)
TotalRecordsquerystringNoTotal Number of Records in a Full Reponse (if no paging)
ResponseRecordsquerystringNoTotal Number of Records in this Reponse (on this page)
CollectionResponse<TItem> Parameters:
NameParameterData TypeRequiredDescription
ResponseMetadataformResponseMetadataNo
ResponseReportformList<ApiRequestPerHour>No
ResponseErrorformAgentivityErrorNo
ResponseMetadata Parameters:
NameParameterData TypeRequiredDescription
SuccessformboolNo
HasCacheformboolNo
HasPagingformboolNo
CacheMetadataformCacheMetadataNo
PagingMetadataformPagingMetadataNo
CacheMetadata Parameters:
NameParameterData TypeRequiredDescription
CachedAtformDateTimeNo
CacheExpiresAtformDateTimeNo
IsFromCacheformboolNo
ApiRequestPerHour Parameters:
NameParameterData TypeRequiredDescription
RequestDateformDateTimeNo
Hour0formintNo
Hour1formintNo
Hour2formintNo
Hour3formintNo
Hour4formintNo
Hour5formintNo
Hour6formintNo
Hour7formintNo
Hour8formintNo
Hour9formintNo
Hour10formintNo
Hour11formintNo
Hour12formintNo
Hour13formintNo
Hour14formintNo
Hour15formintNo
Hour16formintNo
Hour17formintNo
Hour18formintNo
Hour19formintNo
Hour20formintNo
Hour21formintNo
Hour22formintNo
Hour23formintNo
AgentivityError Parameters:
NameParameterData TypeRequiredDescription
ErrorCodeformstringNo
MessageformstringNo
StatusCodeformstringNo
VerboseMessageformstringNo
PNRSegments Parameters:
NameParameterData TypeRequiredDescription
SummaryformPNRSummaryNo
SegmentsformSegmentsNo
PNRSummary Parameters:
NameParameterData TypeRequiredDescription
RecordLocatorformstringNo
AirlineReferencesformAirlineReferencesNo
TicketsformPNRSummaryTicketsNo
HostSystem Parameters:
NameParameterData TypeRequiredDescription
VendorformstringNo
VendorLocatorformstringNo
PNRSummaryTicket Parameters:
NameParameterData TypeRequiredDescription
TktNumberformstringNo
PassengerformPassengerNameNo
CouponsformCouponsNo
PassengerName Parameters:
NameParameterData TypeRequiredDescription
LastNameformstringNo
FirstNameformstringNo
Coupon Parameters:
NameParameterData TypeRequiredDescription
CouponSequenceNbrformstringNo
CouponBoardPointformstringNo
CouponOffPointformstringNo
CarrierformstringNo
FlightNbrformstringNo
FlightDateformstringNo
FlightTimeformstringNo
Segments Parameters:
NameParameterData TypeRequiredDescription
AirSegmentsformList<AirSegment>No
CarSegmentsformList<CarSegment>No
HotelSegmentsformList<HotelSegmentDepreciated>No
PassiveSegmentsformList<PassiveSegment>No
AirSegment Parameters:
NameParameterData TypeRequiredDescription
AirSegmentNbrformintNo
SegmentStatusformstringNo
DepartureDateformstringNo
DepartureTimeformstringNo
CarrierCodeformstringNo
BoardPointformstringNo
OffPointformstringNo
FlightNbrformstringNo
BookingCodeformstringNo
ArrivalTimeformstringNo
ChangeOfDayformstringNo
ConnectionIndicatorformstringNo
OperatingCarrierCodeformstringNo
OperatingCarrierNameformstringNo
JourneyTimeformstringNo
NbrSeatsformintNo
SeatingDataformSeatingDataNo
Seat Parameters:
NameParameterData TypeRequiredDescription
SeatLocationformstringNo
SeatStatusCodeformstringNo
CarSegment Parameters:
NameParameterData TypeRequiredDescription
CarSegmentNbrformintNo
SegmentStatusformstringNo
PickUpDateformstringNo
PickUpTimeformstringNo
AirportCodeformstringNo
CarLocationCategoryformstringNo
DropOffDateformstringNo
DropOffTimeformstringNo
ConfirmationNbrformstringNo
CarVendorCodeformstringNo
CarRateTypeformstringNo
CarRateCodeformstringNo
CarTypeformstringNo
CarYieldManagementNbrformstringNo
RateAmountformstringNo
RateGuaranteeIndicatorformstringNo
MilesKilometerIndicatorformstringNo
DistanceAllowanceformstringNo
DistanceRateAmountformstringNo
CurrencyCodeformstringNo
NbrOfCarsformintNo
HotelSegmentDepreciated Parameters:
NameParameterData TypeRequiredDescription
HotelSegmentNbrformstringNo
StatusCodeformstringNo
ArrivalDateformstringNo
DepartureDateformstringNo
PropertyNameformstringNo
ConfirmationNbrformstringNo
CurrencyformstringNo
RateformstringNo
RoomBookingCodeformstringNo
NbrNightsformintNo
MultiLevelRateCodeformstringNo
NbrRoomsformintNo
BookedInNameformstringNo
ServiceInformationformstringNo
PropertyCityCodeformstringNo
SegmentStatusformstringNo
HotelVendorCodeformstringNo
PassiveSegment Parameters:
NameParameterData TypeRequiredDescription
SegmentStatusformstringNo
StartDateformstringNo
DepartureDateformstringNo
NbrNightsformstringNo
VendorCodeformstringNo
CityCodeformstringNo
SegmentTypeformstringNo
TextformstringNo
PassengerformstringNo
AddressformstringNo
BookingReasonCodeformstringNo
BookingSourceformstringNo
CommissionInformationformstringNo
ConfirmationNumberformstringNo
RateCodeformstringNo
RateQuotedformstringNo
RateAccessCodeformstringNo
PropertyNameformstringNo
PropertyNumberformstringNo
ServiceInformationformstringNo

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 /PNRSegments 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":[{"Summary":{"RecordLocator":"String","AirlineReferences":[{"Vendor":"String","VendorLocator":"String"}],"Tickets":[{"TktNumber":"String","Passenger":{"LastName":"String","FirstName":"String"},"Coupons":[{"CouponSequenceNbr":"String","CouponBoardPoint":"String","CouponOffPoint":"String","Carrier":"String","FlightNbr":"String","FlightDate":"String","FlightTime":"String"}]}]},"Segments":{"AirSegments":[{"AirSegmentNbr":0,"SegmentStatus":"String","DepartureDate":"String","DepartureTime":"String","CarrierCode":"String","BoardPoint":"String","OffPoint":"String","FlightNbr":"String","BookingCode":"String","ArrivalTime":"String","ChangeOfDay":"String","ConnectionIndicator":"String","OperatingCarrierCode":"String","OperatingCarrierName":"String","JourneyTime":"String","NbrSeats":0,"SeatingData":[{"SeatLocation":"String","SeatStatusCode":"String"}]}],"CarSegments":[{"CarSegmentNbr":0,"SegmentStatus":"String","PickUpDate":"String","PickUpTime":"String","AirportCode":"String","CarLocationCategory":"String","DropOffDate":"String","DropOffTime":"String","ConfirmationNbr":"String","CarVendorCode":"String","CarRateType":"String","CarRateCode":"String","CarType":"String","CarYieldManagementNbr":"String","RateAmount":"String","RateGuaranteeIndicator":"String","MilesKilometerIndicator":"String","DistanceAllowance":"String","DistanceRateAmount":"String","CurrencyCode":"String","NbrOfCars":0}],"HotelSegments":[{"HotelSegmentNbr":"String","StatusCode":"String","ArrivalDate":"String","DepartureDate":"String","PropertyName":"String","ConfirmationNbr":"String","Currency":"String","Rate":"String","RoomBookingCode":"String","NbrNights":0,"MultiLevelRateCode":"String","NbrRooms":0,"BookedInName":"String","ServiceInformation":"String","PropertyCityCode":"String","SegmentStatus":"String","HotelVendorCode":"String"}],"PassiveSegments":[{"SegmentStatus":"String","StartDate":"String","DepartureDate":"String","NbrNights":"String","VendorCode":"String","CityCode":"String","SegmentType":"String","Text":"String","Passenger":"String","Address":"String","BookingReasonCode":"String","BookingSource":"String","CommissionInformation":"String","ConfirmationNumber":"String","RateCode":"String","RateQuoted":"String","RateAccessCode":"String","PropertyName":"String","PropertyNumber":"String","ServiceInformation":"String"}]}}],"ResponseError":{"ErrorCode":"String","Message":"String","StatusCode":"String","VerboseMessage":"String"}}