Agentivity API

<back to all web services

GetTicketDetails

The following routes are available for this service:
GET/TicketDetails/UserDepreciated, please use ticketdetails
GET/TicketDetails
GetTicketDetails Parameters:
NameParameterData TypeRequiredDescription
TktNumberquerystringYesTicket number
CacheGuidquerystringNoCache Guid
RequestConsultantIDquerystringNoRequest Consultant ID (sign on)
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)
ItemResponse<TItem, TReport> Parameters:
NameParameterData TypeRequiredDescription
ResponseMetadataformResponseMetadataNo
ResponseReportformTReportNo
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
TicketInfo Parameters:
NameParameterData TypeRequiredDescription
TktNumberformstringNo
RecordLocatorformstringNo
PNRCreationDateformDateTime?No
TktIssueDateformDateTime?No
PlatingCarrierformstringNo
StatusformstringNo
BARformstringNo
PARformstringNo
LastNameformstringNo
FirstNameformstringNo
TicketExpiryDateformDateTime?No
FOPformstringNo
FopFareformstringNo
FOPCurrencyformstringNo
PrintedCurrencyformstringNo
PrintedFareformstringNo
CreditCardFOPAcctformstringNo
OwningAgencyLocationIDformstringNo
IATAformstringNo
CouponsformList<TicketInfoFlightCoupon>No
EligibleForRefundformboolNo
EligibleForCovidStatusformboolNo
TicketExchangesformList<TicketExchange>No
TaxformTicketTaxDetailsNo
OwningCompanyCodeformstringNo
TicketInfoFlightCoupon Parameters:
NameParameterData TypeRequiredDescription
TktNumberformstringNo
CouponSequenceNbrformintNo
CarrierformstringNo
FlightNbrformstringNo
BoardPointformstringNo
OffPointformstringNo
FlightServiceClassformstringNo
FlightDateformDateTime?No
FlightCouponStatusformstringNo
DateLastCheckedformDateTime?No
AirTktSegIdformintNo
EligibleForRefundformboolNo
EligibleForCovidStatusformboolNo
FareBasisformstringNo
TicketExchange Parameters:
NameParameterData TypeRequiredDescription
OriginalTktNumberformstringNo
TicketTaxDetails Parameters:
NameParameterData TypeRequiredDescription
TotalAmtformdecimal?No
TaxElementsformList<TicketTaxElement>No
TicketTaxElement Parameters:
NameParameterData TypeRequiredDescription
Amtformdecimal?No
PrintedAmtformstringNo
CodeformstringNo
Report<TItemResponse, TItem> Parameters:
NameParameterData TypeRequiredDescription
ItemformTItemNo

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 //TicketDetails/User 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":{"Item":{"TktNumber":"String","RecordLocator":"String","PNRCreationDate":"\/Date(-62135596800000-0000)\/","TktIssueDate":"\/Date(-62135596800000-0000)\/","PlatingCarrier":"String","Status":"String","BAR":"String","PAR":"String","LastName":"String","FirstName":"String","TicketExpiryDate":"\/Date(-62135596800000-0000)\/","FOP":"String","FopFare":"String","FOPCurrency":"String","PrintedCurrency":"String","PrintedFare":"String","CreditCardFOPAcct":"String","OwningAgencyLocationID":"String","IATA":"String","Coupons":[{"TktNumber":"String","CouponSequenceNbr":0,"Carrier":"String","FlightNbr":"String","BoardPoint":"String","OffPoint":"String","FlightServiceClass":"String","FlightDate":"\/Date(-62135596800000-0000)\/","FlightCouponStatus":"String","DateLastChecked":"\/Date(-62135596800000-0000)\/","AirTktSegId":0,"EligibleForRefund":false,"EligibleForCovidStatus":false,"FareBasis":"String"}],"EligibleForRefund":false,"EligibleForCovidStatus":false,"TicketExchanges":[{"OriginalTktNumber":"String"}],"Tax":{"TotalAmt":0,"TaxElements":[{"Amt":0,"PrintedAmt":"String","Code":"String"}]},"OwningCompanyCode":"String"}},"ResponseError":{"ErrorCode":"String","Message":"String","StatusCode":"String","VerboseMessage":"String"}}