| GET | /TicketDetails/User | Depreciated, please use ticketdetails | |
|---|---|---|---|
| GET | /TicketDetails |
namespace AgentivityAPI.ServiceModel
open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
[<DataContract(Name="TicketInfoFlightCoupon", Namespace="schemas.agentivity.com/types")>]
[<AllowNullLiteral>]
type TicketInfoFlightCoupon() =
[<DataMember(Order=10)>]
member val TktNumber:String = null with get,set
[<DataMember(Order=20)>]
member val CouponSequenceNbr:Int32 = new Int32() with get,set
[<DataMember(Order=20)>]
member val Carrier:String = null with get,set
[<DataMember(Order=30)>]
member val FlightNbr:String = null with get,set
[<DataMember(Order=40)>]
member val BoardPoint:String = null with get,set
[<DataMember(Order=50)>]
member val OffPoint:String = null with get,set
[<DataMember(Order=60)>]
member val FlightServiceClass:String = null with get,set
[<DataMember(Order=70)>]
member val FlightDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
[<DataMember(Order=80)>]
member val FlightCouponStatus:String = null with get,set
[<DataMember(Order=90)>]
member val DateLastChecked:Nullable<DateTime> = new Nullable<DateTime>() with get,set
[<DataMember(Order=100)>]
member val AirTktSegId:Int32 = new Int32() with get,set
[<DataMember(Order=110)>]
member val EligibleForRefund:Boolean = new Boolean() with get,set
[<DataMember(Order=120)>]
member val EligibleForCovidStatus:Boolean = new Boolean() with get,set
[<DataMember(Order=130)>]
member val FareBasis:String = null with get,set
[<DataContract(Name="Exchange", Namespace="schemas.agentivity.com/types")>]
[<AllowNullLiteral>]
type TicketExchange() =
[<DataMember(Order=10)>]
member val OriginalTktNumber:String = null with get,set
[<DataContract(Name="TaxElement", Namespace="schemas.agentivity.com/types")>]
[<AllowNullLiteral>]
type TicketTaxElement() =
[<DataMember(Order=10)>]
member val Amt:Nullable<Decimal> = new Nullable<Decimal>() with get,set
[<DataMember(Order=20)>]
member val PrintedAmt:String = null with get,set
[<DataMember(Order=30)>]
member val Code:String = null with get,set
[<DataContract(Name="Tax", Namespace="schemas.agentivity.com/types")>]
[<AllowNullLiteral>]
type TicketTaxDetails() =
[<DataMember(Order=10)>]
member val TotalAmt:Nullable<Decimal> = new Nullable<Decimal>() with get,set
[<DataMember(Order=20)>]
member val TaxElements:ResizeArray<TicketTaxElement> = null with get,set
[<DataContract(Name="TicketInfo", Namespace="schemas.agentivity.com/types")>]
[<AllowNullLiteral>]
type TicketInfo() =
[<DataMember(Order=5)>]
member val PassengerTicketID:Int32 = new Int32() with get,set
[<DataMember(Order=10)>]
member val TktNumber:String = null with get,set
[<DataMember(Order=20)>]
member val RecordLocator:String = null with get,set
[<DataMember(Order=30)>]
member val PNRCreationDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
[<DataMember(Order=40)>]
member val TktIssueDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
[<DataMember(Order=50)>]
member val PlatingCarrier:String = null with get,set
[<DataMember(Order=60)>]
member val Status:String = null with get,set
[<DataMember(Order=70)>]
member val BAR:String = null with get,set
[<DataMember(Order=80)>]
member val PAR:String = null with get,set
[<DataMember(Order=90)>]
member val LastName:String = null with get,set
[<DataMember(Order=100)>]
member val FirstName:String = null with get,set
[<DataMember(Order=110)>]
member val TicketExpiryDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
[<DataMember(Order=120)>]
member val FOP:String = null with get,set
[<DataMember(Order=130)>]
member val FopFare:String = null with get,set
[<DataMember(Order=140)>]
member val FOPCurrency:String = null with get,set
[<DataMember(Order=150)>]
member val PrintedCurrency:String = null with get,set
[<DataMember(Order=160)>]
member val PrintedFare:String = null with get,set
[<DataMember(Order=170)>]
member val CreditCardFOPAcct:String = null with get,set
[<DataMember(Order=180)>]
member val OwningAgencyLocationID:String = null with get,set
[<DataMember(Order=190)>]
member val IATA:String = null with get,set
[<DataMember(Order=200)>]
member val Coupons:ResizeArray<TicketInfoFlightCoupon> = null with get,set
[<DataMember(Order=210)>]
member val EligibleForRefund:Boolean = new Boolean() with get,set
[<DataMember(Order=220)>]
member val EligibleForCovidStatus:Boolean = new Boolean() with get,set
[<DataMember(Order=230)>]
member val TicketExchanges:ResizeArray<TicketExchange> = null with get,set
[<DataMember(Order=240)>]
member val Tax:TicketTaxDetails = null with get,set
[<DataMember(Order=500)>]
member val OwningCompanyCode:String = null with get,set
[<DataContract(Namespace="schemas.agentivity.com/types")>]
[<AllowNullLiteral>]
type Report<TItemResponse, TItem>() =
[<DataMember(Order=1, EmitDefaultValue=false)>]
member val Item:TItem = null with get,set
[<DataContract(Name="TicketInfo", Namespace="schemas.agentivity.com/types")>]
[<AllowNullLiteral>]
type TicketDetailsResponseReport() =
inherit Report<TicketDetailsItemResponse, TicketInfo>()
[<DataContract(Name="CacheMetadata", Namespace="schemas.agentivity.com/types")>]
[<AllowNullLiteral>]
type CacheMetadata() =
[<DataMember(Order=1)>]
member val CachedAt:DateTime = new DateTime() with get,set
[<DataMember(Order=2)>]
member val CacheExpiresAt:DateTime = new DateTime() with get,set
[<DataMember(Order=0)>]
member val IsFromCache:Boolean = new Boolean() with get,set
[<DataContract(Name="Metadata", Namespace="schemas.agentivity.com/types")>]
[<AllowNullLiteral>]
type PagingMetadata() =
///<summary>
///Starting Record
///</summary>
[<DataMember>]
[<ApiMember(DataType="string", Description="Starting Record", Name="Offset", ParameterType="query")>]
member val Offset:String = null with get,set
///<summary>
///Number of records to return (PageSize)
///</summary>
[<DataMember>]
[<ApiMember(DataType="string", Description="Number of records to return (PageSize)", Name="Limit", ParameterType="query")>]
member val Limit:String = null with get,set
///<summary>
///Total Number of Records in a Full Reponse (if no paging)
///</summary>
[<DataMember>]
[<ApiMember(DataType="string", Description="Total Number of Records in a Full Reponse (if no paging)", Name="TotalRecords", ParameterType="query")>]
member val TotalRecords:Int32 = new Int32() with get,set
///<summary>
///Total Number of Records in this Reponse (on this page)
///</summary>
[<DataMember>]
[<ApiMember(DataType="string", Description="Total Number of Records in this Reponse (on this page)", Name="ResponseRecords", ParameterType="query")>]
member val ResponseRecords:Int32 = new Int32() with get,set
[<DataContract(Name="ResponseMetadata", Namespace="schemas.agentivity.com/types")>]
[<AllowNullLiteral>]
type ResponseMetadata() =
[<DataMember(Order=0)>]
member val Success:Boolean = new Boolean() with get,set
[<DataMember(Order=1)>]
member val HasCache:Boolean = new Boolean() with get,set
[<DataMember(Order=2)>]
member val HasPaging:Boolean = new Boolean() with get,set
[<DataMember(Order=3, EmitDefaultValue=false)>]
member val CacheMetadata:CacheMetadata = null with get,set
[<DataMember(Order=4, EmitDefaultValue=false)>]
member val PagingMetadata:PagingMetadata = null with get,set
[<DataContract(Name="ResponseMetadata", Namespace="schemas.agentivity.com/types")>]
[<AllowNullLiteral>]
type AgentivityError() =
[<DataMember>]
member val ErrorCode:String = null with get,set
[<DataMember>]
member val Message:String = null with get,set
[<DataMember>]
member val StatusCode:String = null with get,set
[<DataMember>]
member val VerboseMessage:String = null with get,set
[<DataContract(Name="AgentivityResponse", Namespace="schemas.agentivity.com/types")>]
[<AllowNullLiteral>]
type ItemResponse<TItem, TReport>() =
[<DataMember(Order=1)>]
member val ResponseMetadata:ResponseMetadata = null with get,set
[<DataMember(Order=2, EmitDefaultValue=false)>]
member val ResponseReport:TReport = null with get,set
[<DataMember(Order=3, EmitDefaultValue=false)>]
member val ResponseError:AgentivityError = null with get,set
[<DataContract(Name="AgentivityResponse", Namespace="schemas.agentivity.com/types")>]
[<AllowNullLiteral>]
type TicketDetailsItemResponse() =
inherit ItemResponse<TicketInfo, TicketDetailsResponseReport>()
[<DataContract(Namespace="schemas.agentivity.com/types")>]
[<AllowNullLiteral>]
type CompanyLevelRequestBase() =
inherit PagingMetadata()
///<summary>
///Comma Delimited List of Owning Company Codes
///</summary>
[<DataMember>]
member val OwningCompanyCode:String[] = null with get,set
///<summary>
///UserName in form of an email address
///</summary>
[<DataMember>]
member val UserName:String = null with get,set
[<DataContract(Namespace="schemas.agentivity.com/types")>]
[<AllowNullLiteral>]
type GetTicketDetails() =
inherit CompanyLevelRequestBase()
///<summary>
///Ticket number
///</summary>
[<DataMember>]
member val TktNumber:String = null with get,set
///<summary>
///Cache Guid
///</summary>
[<DataMember>]
member val CacheGuid:String = null with get,set
///<summary>
///Request Consultant ID (sign on)
///</summary>
[<DataMember>]
member val RequestConsultantID:String = null with get,set
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
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/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<AgentivityResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="schemas.agentivity.com/types">
<ResponseMetadata>
<Success>false</Success>
<HasCache>false</HasCache>
<HasPaging>false</HasPaging>
<CacheMetadata>
<IsFromCache>false</IsFromCache>
<CachedAt>0001-01-01T00:00:00</CachedAt>
<CacheExpiresAt>0001-01-01T00:00:00</CacheExpiresAt>
</CacheMetadata>
<PagingMetadata>
<Limit>String</Limit>
<Offset>String</Offset>
<ResponseRecords>0</ResponseRecords>
<TotalRecords>0</TotalRecords>
</PagingMetadata>
</ResponseMetadata>
<ResponseReport>
<Item>
<PassengerTicketID>0</PassengerTicketID>
<TktNumber>String</TktNumber>
<RecordLocator>String</RecordLocator>
<PNRCreationDate>0001-01-01T00:00:00</PNRCreationDate>
<TktIssueDate>0001-01-01T00:00:00</TktIssueDate>
<PlatingCarrier>String</PlatingCarrier>
<Status>String</Status>
<BAR>String</BAR>
<PAR>String</PAR>
<LastName>String</LastName>
<FirstName>String</FirstName>
<TicketExpiryDate>0001-01-01T00:00:00</TicketExpiryDate>
<FOP>String</FOP>
<FopFare>String</FopFare>
<FOPCurrency>String</FOPCurrency>
<PrintedCurrency>String</PrintedCurrency>
<PrintedFare>String</PrintedFare>
<CreditCardFOPAcct>String</CreditCardFOPAcct>
<OwningAgencyLocationID>String</OwningAgencyLocationID>
<IATA>String</IATA>
<Coupons>
<TicketInfoFlightCoupon>
<TktNumber>String</TktNumber>
<Carrier>String</Carrier>
<CouponSequenceNbr>0</CouponSequenceNbr>
<FlightNbr>String</FlightNbr>
<BoardPoint>String</BoardPoint>
<OffPoint>String</OffPoint>
<FlightServiceClass>String</FlightServiceClass>
<FlightDate>0001-01-01T00:00:00</FlightDate>
<FlightCouponStatus>String</FlightCouponStatus>
<DateLastChecked>0001-01-01T00:00:00</DateLastChecked>
<AirTktSegId>0</AirTktSegId>
<EligibleForRefund>false</EligibleForRefund>
<EligibleForCovidStatus>false</EligibleForCovidStatus>
<FareBasis>String</FareBasis>
</TicketInfoFlightCoupon>
</Coupons>
<EligibleForRefund>false</EligibleForRefund>
<EligibleForCovidStatus>false</EligibleForCovidStatus>
<TicketExchanges>
<Exchange>
<OriginalTktNumber>String</OriginalTktNumber>
</Exchange>
</TicketExchanges>
<Tax>
<TotalAmt>0</TotalAmt>
<TaxElements>
<TaxElement>
<Amt>0</Amt>
<PrintedAmt>String</PrintedAmt>
<Code>String</Code>
</TaxElement>
</TaxElements>
</Tax>
<OwningCompanyCode>String</OwningCompanyCode>
</Item>
</ResponseReport>
<ResponseError>
<ErrorCode>String</ErrorCode>
<Message>String</Message>
<StatusCode>String</StatusCode>
<VerboseMessage>String</VerboseMessage>
</ResponseError>
</AgentivityResponse>