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<TItem>No
ResponseErrorformAgentivityErrorNo
ResponseMetadata Parameters:
NameParameterData TypeRequiredDescription
SuccessformboolNo
HasCacheformboolNo
HasPagingformboolNo
CacheMetadataformCacheMetadataNo
PagingMetadataformPagingMetadataNo
CacheMetadata Parameters:
NameParameterData TypeRequiredDescription
CachedAtformDateTimeNo
CacheExpiresAtformDateTimeNo
IsFromCacheformboolNo
AgentivityError Parameters:
NameParameterData TypeRequiredDescription
ErrorCodeformstringNo
MessageformstringNo
StatusCodeformstringNo
VerboseMessageformstringNo
AirSegmentWithVendorLocators Parameters:
NameParameterData TypeRequiredDescription
RecordLocatorformstringNo
PNRCreationDateformstringNo
AgentivityRefformstringNo
AccountformstringNo
OwningConsultantIDformstringNo
OwningConsultantformstringNo
OwningAgencyLocationIDformstringNo
PaxListformstringNo
AirSegmentNbrformstringNo
SegmentStatusformstringNo
BoardPointformstringNo
OffPointformstringNo
DepartureDateformstringNo
DepartureTimeformstringNo
ArrivalTimeformstringNo
ChangeOfDayformstringNo
CarrierCodeformstringNo
FlightNbrformstringNo
BookingCodeformstringNo
PNRTicketedformstringNo
VendorLocatorformstringNo
CheckInURLformstringNo
IsVipformboolNo
PhoneNbrformstringNo
EmailAddressformstringNo

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

HTTP + CSV

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/csv

HTTP/1.1 200 OK
Content-Type: text/csv
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":"String","AgentivityRef":"String","Account":"String","OwningConsultantID":"String","OwningConsultant":"String","OwningAgencyLocationID":"String","PaxList":"String","AirSegmentNbr":"String","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"}],"ResponseError":{"ErrorCode":"String","Message":"String","StatusCode":"String","VerboseMessage":"String"}}