Agentivity API

GetTicketDetails

The following routes are available for this service:
GET	/TicketDetails/User		Depreciated, please use ticketdetails
GET	/TicketDetails

**GetTicketDetails** Parameters:
Name	Parameter	Data Type	Required	Description
TktNumber	query	string	Yes	Ticket number
CacheGuid	query	string	No	Cache Guid
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)

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

**TicketInfo** Parameters:
Name	Parameter	Data Type	Required
TktNumber	form	string	No
RecordLocator	form	string	No
PNRCreationDate	form	DateTime?	No
TktIssueDate	form	DateTime?	No
PlatingCarrier	form	string	No
Status	form	string	No
BAR	form	string	No
PAR	form	string	No
LastName	form	string	No
FirstName	form	string	No
TicketExpiryDate	form	DateTime?	No
FOP	form	string	No
FopFare	form	string	No
FOPCurrency	form	string	No
PrintedCurrency	form	string	No
PrintedFare	form	string	No
CreditCardFOPAcct	form	string	No
OwningAgencyLocationID	form	string	No
IATA	form	string	No
Coupons	form	List<TicketInfoFlightCoupon>	No
EligibleForRefund	form	bool	No
EligibleForCovidStatus	form	bool	No
TicketExchanges	form	List<TicketExchange>	No
Tax	form	TicketTaxDetails	No
OwningCompanyCode	form	string	No

**TicketInfoFlightCoupon** Parameters:
Name	Parameter	Data Type	Required
TktNumber	form	string	No
CouponSequenceNbr	form	int	No
Carrier	form	string	No
FlightNbr	form	string	No
BoardPoint	form	string	No
OffPoint	form	string	No
FlightServiceClass	form	string	No
FlightDate	form	DateTime?	No
FlightCouponStatus	form	string	No
DateLastChecked	form	DateTime?	No
AirTktSegId	form	int	No
EligibleForRefund	form	bool	No
EligibleForCovidStatus	form	bool	No
FareBasis	form	string	No

**TicketExchange** Parameters:
Name	Parameter	Data Type	Required	Description
OriginalTktNumber	form	string	No

**TicketTaxDetails** Parameters:
Name	Parameter	Data Type	Required	Description
TotalAmt	form	decimal?	No
TaxElements	form	List<TicketTaxElement>	No

**TicketTaxElement** Parameters:
Name	Parameter	Data Type	Required
Amt	form	decimal?	No
PrintedAmt	form	string	No
Code	form	string	No

**Report<TItemResponse, TItem>** Parameters:
Name	Parameter	Data Type	Required	Description
Item	form	TItem	No

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"}}