Agentivity API

<back to all web services

AirSegmentsWithVendorLocatorsByUser

The following routes are available for this service:
GET/AirSegmentsWithVendorLocators
AirSegmentsWithVendorLocatorsByUser Parameters:
NameParameterData TypeRequiredDescription
AccountquerystringNoComma Delimited List of Accounts
DepartureDateStartquerystringYesDate in format YYYYMMDD
DepartureDateEndquerystringNoDate in format YYYYMMDD
IsVipquerybooleanNoReturn only PNRs that are or are not flagged as VIP bookings
CompanyLevelRequestBase Parameters:
NameParameterData TypeRequiredDescription
OwningCompanyCodequerystringNoComma Delimited List of Owning Company Codes
UserNamequerystringNoUserName in form of an email address
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
AirSegmentWithVendorLocators Parameters:
NameParameterData TypeRequiredDescription
RecordLocatorformstringNo
PNRCreationDateformDateTime?No
AgentivityRefformintNo
AccountformstringNo
OwningConsultantIDformstringNo
OwningConsultantformstringNo
OwningAgencyLocationIDformstringNo
PaxListformstringNo
AirSegmentNbrformintNo
SegmentStatusformstringNo
BoardPointformstringNo
OffPointformstringNo
DepartureDateformstringNo
DepartureTimeformstringNo
ArrivalTimeformstringNo
ChangeOfDayformstringNo
CarrierCodeformstringNo
FlightNbrformstringNo
BookingCodeformstringNo
PNRTicketedformstringNo
VendorLocatorformstringNo
CheckInURLformstringNo
IsVipformboolNo
PhoneNbrformstringNo
EmailAddressformstringNo
TicketNumberformstringNo
TicketCouponStatusformstringNo
TicketCouponDateLastCheckedformDateTime?No
OperatingCarrierNameformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /AirSegmentsWithVendorLocators HTTP/1.1 
Host: api.agentivity.com 
Accept: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
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":[{"RecordLocator":"String","PNRCreationDate":"\/Date(-62135596800000-0000)\/","AgentivityRef":0,"Account":"String","OwningConsultantID":"String","OwningConsultant":"String","OwningAgencyLocationID":"String","PaxList":"String","AirSegmentNbr":0,"SegmentStatus":"String","BoardPoint":"String","OffPoint":"String","DepartureDate":"String","DepartureTime":"String","ArrivalTime":"String","ChangeOfDay":"String","CarrierCode":"String","FlightNbr":"String","BookingCode":"String","PNRTicketed":"String","VendorLocator":"String","CheckInURL":"String","IsVip":false,"PhoneNbr":"String","EmailAddress":"String","TicketNumber":"String","TicketCouponStatus":"String","TicketCouponDateLastChecked":"\/Date(-62135596800000-0000)\/","OperatingCarrierName":"String"}],"ResponseError":{"ErrorCode":"String","Message":"String","StatusCode":"String","VerboseMessage":"String"}}