| GET | /TicketCouponsByStatusCode |
|---|
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="CustomField", Namespace="schemas.agentivity.com/types")>]
[<AllowNullLiteral>]
type CustomFieldData() =
[<DataMember(Order=20)>]
member val FieldName:String = null with get,set
[<DataMember(Order=30)>]
member val FieldValue:String = null with get,set
[<AllowNullLiteral>]
type CustomFieldsCollection() =
inherit ResizeArray<CustomFieldData>()
[<DataContract(Name="TicketCouponsByStatusCode", Namespace="schemas.agentivity.com/types")>]
[<AllowNullLiteral>]
type TicketCouponsByStatusCode() =
[<DataMember(Order=5)>]
member val CompanyName:String = null with get,set
[<DataMember(Order=10)>]
member val TktNumber:String = null with get,set
[<DataMember(Order=20)>]
member val RN:String = null with get,set
[<DataMember(Order=30)>]
member val AirTktSegId:String = null with get,set
[<DataMember(Order=35)>]
member val VndIssueDt:Nullable<DateTime> = new Nullable<DateTime>() with get,set
[<DataMember(Order=40)>]
member val RecordLocator:String = null with get,set
[<DataMember(Order=45)>]
member val Passenger:String = null with get,set
[<DataMember(Order=51)>]
member val TravAgntID:String = null with get,set
[<DataMember(Order=60)>]
member val OwningConsultantID:String = null with get,set
[<DataMember(Order=70)>]
member val FOPFare:String = null with get,set
[<DataMember(Order=80)>]
member val BaseFare:String = null with get,set
[<DataMember(Order=90)>]
member val FOP:String = null with get,set
[<DataMember(Order=110)>]
member val TotalTax:String = null with get,set
[<DataMember(Order=120)>]
member val Tax1Code:String = null with get,set
[<DataMember(Order=130)>]
member val Tax1Amt:String = null with get,set
[<DataMember(Order=140)>]
member val Tax2Code:String = null with get,set
[<DataMember(Order=150)>]
member val Tax2Amt:String = null with get,set
[<DataMember(Order=160)>]
member val Tax3Code:String = null with get,set
[<DataMember(Order=170)>]
member val Tax3Amt:String = null with get,set
[<DataMember(Order=180)>]
member val Tax4Code:String = null with get,set
[<DataMember(Order=180)>]
member val Tax4Amt:String = null with get,set
[<DataMember(Order=200)>]
member val Tax5Code:String = null with get,set
[<DataMember(Order=210)>]
member val Tax5Amt:String = null with get,set
[<DataMember(Order=220)>]
member val Account:String = null with get,set
[<DataMember(Order=230)>]
member val ExchangedForTicket:String = null with get,set
[<DataMember(Order=240)>]
member val CouponSequenceNbr:String = null with get,set
[<DataMember(Order=250)>]
member val Carrier:String = null with get,set
[<DataMember(Order=260)>]
member val BoardPoint:String = null with get,set
[<DataMember(Order=270)>]
member val OffPoint:String = null with get,set
[<DataMember(Order=280)>]
member val FlightDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
[<DataMember(Order=290)>]
member val FlightServiceClass:String = null with get,set
[<DataMember(Order=300)>]
member val FareBasis:String = null with get,set
[<DataMember(Order=310)>]
member val FlightCouponStatus:String = null with get,set
[<DataMember(Order=320)>]
member val DateLastChecked:Nullable<DateTime> = new Nullable<DateTime>() with get,set
[<DataMember(Order=330)>]
member val PCC:String = null with get,set
[<DataMember(Order=340)>]
member val AirlineCode:String = null with get,set
[<DataMember(Order=500)>]
member val OwningCompanyCode:String = null with get,set
[<DataMember(Order=510)>]
member val CreditCurrency:String = null with get,set
[<DataMember(Order=520)>]
member val CreditValue:Nullable<Decimal> = new Nullable<Decimal>() with get,set
[<DataMember(Order=530)>]
member val FlightServiceClassName:String = null with get,set
[<DataMember(Order=540)>]
member val FlownKM:Nullable<Int32> = new Nullable<Int32>() with get,set
[<DataMember(Order=550)>]
member val BAR:String = null with get,set
[<DataMember(Order=560)>]
member val PNRCreationDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
[<DataMember(Order=570)>]
member val AgentivityRef:Int32 = new Int32() with get,set
[<DataMember(Order=580)>]
member val CustomFields:CustomFieldsCollection = null with get,set
[<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="ApiRequestPerHour", Namespace="schemas.agentivity.com/types")>]
[<AllowNullLiteral>]
type ApiRequestPerHour() =
[<DataMember(Order=10)>]
member val RequestDate:DateTime = new DateTime() with get,set
[<DataMember(Order=100)>]
member val Hour0:Int32 = new Int32() with get,set
[<DataMember(Order=110)>]
member val Hour1:Int32 = new Int32() with get,set
[<DataMember(Order=120)>]
member val Hour2:Int32 = new Int32() with get,set
[<DataMember(Order=130)>]
member val Hour3:Int32 = new Int32() with get,set
[<DataMember(Order=140)>]
member val Hour4:Int32 = new Int32() with get,set
[<DataMember(Order=150)>]
member val Hour5:Int32 = new Int32() with get,set
[<DataMember(Order=160)>]
member val Hour6:Int32 = new Int32() with get,set
[<DataMember(Order=170)>]
member val Hour7:Int32 = new Int32() with get,set
[<DataMember(Order=180)>]
member val Hour8:Int32 = new Int32() with get,set
[<DataMember(Order=190)>]
member val Hour9:Int32 = new Int32() with get,set
[<DataMember(Order=200)>]
member val Hour10:Int32 = new Int32() with get,set
[<DataMember(Order=210)>]
member val Hour11:Int32 = new Int32() with get,set
[<DataMember(Order=220)>]
member val Hour12:Int32 = new Int32() with get,set
[<DataMember(Order=230)>]
member val Hour13:Int32 = new Int32() with get,set
[<DataMember(Order=240)>]
member val Hour14:Int32 = new Int32() with get,set
[<DataMember(Order=250)>]
member val Hour15:Int32 = new Int32() with get,set
[<DataMember(Order=260)>]
member val Hour16:Int32 = new Int32() with get,set
[<DataMember(Order=270)>]
member val Hour17:Int32 = new Int32() with get,set
[<DataMember(Order=280)>]
member val Hour18:Int32 = new Int32() with get,set
[<DataMember(Order=290)>]
member val Hour19:Int32 = new Int32() with get,set
[<DataMember(Order=300)>]
member val Hour20:Int32 = new Int32() with get,set
[<DataMember(Order=310)>]
member val Hour21:Int32 = new Int32() with get,set
[<DataMember(Order=320)>]
member val Hour22:Int32 = new Int32() with get,set
[<DataMember(Order=330)>]
member val Hour23:Int32 = new Int32() 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 CollectionResponse<TItem>() =
[<DataMember(Order=1)>]
member val ResponseMetadata:ResponseMetadata = null with get,set
[<DataMember(Order=2, EmitDefaultValue=false)>]
member val ResponseReport:ResizeArray<ApiRequestPerHour> = 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 TicketCouponsByStatusCodeResponse() =
inherit CollectionResponse<TicketCouponsByStatusCode>()
[<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 GetTicketCouponsByStatusCode() =
inherit CompanyLevelRequestBase()
///<summary>
///Date in format YYYYMMDD
///</summary>
[<DataMember>]
member val DateStart:String = null with get,set
///<summary>
///Date in format YYYYMMDD
///</summary>
[<DataMember>]
member val DateEnd:String = null with get,set
///<summary>
///Travel agent ID
///</summary>
[<DataMember>]
member val TravAgntID:String = null with get,set
///<summary>
///Comma Delimited List of Accounts
///</summary>
[<DataMember>]
member val Account:String[] = null with get,set
///<summary>
///Comma Delimited List of PCCs
///</summary>
[<DataMember>]
member val OwningAgencyLocationID:String[] = null with get,set
///<summary>
///Coupon code group ("ALL OPEN") or any Coupon Status eg USED, OPEN
///</summary>
[<DataMember>]
member val CouponCodeGroup:String = null with get,set
///<summary>
///Date range type. A single character: I = Issue date, T = Travel date, E = Expiry date
///</summary>
[<DataMember>]
member val DateTracker:String = null with get,set
///<summary>
///Repeat
///</summary>
[<DataMember>]
member val Repeat:Boolean = new Boolean() with get,set
///<summary>
///Lists only segments that are not active
///</summary>
[<DataMember>]
member val NoActiveSegments:Boolean = new Boolean() with get,set
///<summary>
///Include partial matches
///</summary>
[<DataMember>]
member val IncludePartialMatches:Boolean = new Boolean() with get,set
///<summary>
///Show Matching Coupons Only
///</summary>
[<DataMember>]
member val ShowMatchingCouponsOnly:Boolean = new Boolean() with get,set
///<summary>
///Pax surname
///</summary>
[<DataMember>]
member val PaxSurname:String = null with get,set
///<summary>
///Two letter code for carrier
///</summary>
[<DataMember>]
member val CarrierCode:String = null with get,set
///<summary>
///Comma delimited list of 3-character plating carriers
///</summary>
[<DataMember>]
member val ExcludedPlatingCarrier:String[] = null with get,set
///<summary>
///Id of the owning consultant
///</summary>
[<DataMember>]
member val OwningConsultantID:String = null with get,set
///<summary>
///Cache Guid
///</summary>
[<DataMember>]
member val CacheGuid:String = null with get,set
///<summary>
///Agentivity Traveller GUID
///</summary>
[<DataMember>]
member val TravellerGUID:String = null with get,set
///<summary>
///Request Consultant ID (sign on)
///</summary>
[<DataMember>]
member val RequestConsultantID:String = null with get,set
[<DataMember>]
member val CRMCode:Int32 = new Int32() with get,set
[<DataMember>]
member val CRMID:String = null with get,set
F# GetTicketCouponsByStatusCode DTOs
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 /TicketCouponsByStatusCode 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>
<TicketCouponsByStatusCode>
<CompanyName>String</CompanyName>
<TktNumber>String</TktNumber>
<RN>String</RN>
<AirTktSegId>String</AirTktSegId>
<VndIssueDt>0001-01-01T00:00:00</VndIssueDt>
<RecordLocator>String</RecordLocator>
<Passenger>String</Passenger>
<TravAgntID>String</TravAgntID>
<OwningConsultantID>String</OwningConsultantID>
<FOPFare>String</FOPFare>
<BaseFare>String</BaseFare>
<FOP>String</FOP>
<TotalTax>String</TotalTax>
<Tax1Code>String</Tax1Code>
<Tax1Amt>String</Tax1Amt>
<Tax2Code>String</Tax2Code>
<Tax2Amt>String</Tax2Amt>
<Tax3Code>String</Tax3Code>
<Tax3Amt>String</Tax3Amt>
<Tax4Amt>String</Tax4Amt>
<Tax4Code>String</Tax4Code>
<Tax5Code>String</Tax5Code>
<Tax5Amt>String</Tax5Amt>
<Account>String</Account>
<ExchangedForTicket>String</ExchangedForTicket>
<CouponSequenceNbr>String</CouponSequenceNbr>
<Carrier>String</Carrier>
<BoardPoint>String</BoardPoint>
<OffPoint>String</OffPoint>
<FlightDate>0001-01-01T00:00:00</FlightDate>
<FlightServiceClass>String</FlightServiceClass>
<FareBasis>String</FareBasis>
<FlightCouponStatus>String</FlightCouponStatus>
<DateLastChecked>0001-01-01T00:00:00</DateLastChecked>
<PCC>String</PCC>
<AirlineCode>String</AirlineCode>
<OwningCompanyCode>String</OwningCompanyCode>
<CreditCurrency>String</CreditCurrency>
<CreditValue>0</CreditValue>
<FlightServiceClassName>String</FlightServiceClassName>
<FlownKM>0</FlownKM>
<BAR>String</BAR>
<PNRCreationDate>0001-01-01T00:00:00</PNRCreationDate>
<AgentivityRef>0</AgentivityRef>
<CustomFields>
<CustomField>
<FieldName>String</FieldName>
<FieldValue>String</FieldValue>
</CustomField>
</CustomFields>
</TicketCouponsByStatusCode>
</ResponseReport>
<ResponseError>
<ErrorCode>String</ErrorCode>
<Message>String</Message>
<StatusCode>String</StatusCode>
<VerboseMessage>String</VerboseMessage>
</ResponseError>
</AgentivityResponse>