| GET | /TicketCouponsByStatusCode |
|---|
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using AgentivityAPI.ServiceModel.Types;
using AgentivityAPI.ServiceModel.Base;
using AgentivityAPI.ServiceModel;
namespace AgentivityAPI.ServiceModel
{
[DataContract(Name="AgentivityResponse", Namespace="schemas.agentivity.com/types")]
public partial class CollectionResponse<TItem>
{
[DataMember(Order=1)]
public virtual ResponseMetadata ResponseMetadata { get; set; }
[DataMember(Order=2, EmitDefaultValue=false)]
public virtual List<ApiRequestPerHour> ResponseReport { get; set; }
[DataMember(Order=3, EmitDefaultValue=false)]
public virtual AgentivityError ResponseError { get; set; }
}
}
namespace AgentivityAPI.ServiceModel.Base
{
[DataContract(Namespace="schemas.agentivity.com/types")]
public partial class CompanyLevelRequestBase
: PagingMetadata, IMemberUsername, IMemberOwningCompanyCode
{
///<summary>
///Comma Delimited List of Owning Company Codes
///</summary>
[DataMember]
public virtual string[] OwningCompanyCode { get; set; }
///<summary>
///UserName in form of an email address
///</summary>
[DataMember]
public virtual string UserName { get; set; }
}
}
namespace AgentivityAPI.ServiceModel.Types
{
[DataContract(Name="ResponseMetadata", Namespace="schemas.agentivity.com/types")]
public partial class AgentivityError
{
[DataMember]
public virtual string ErrorCode { get; set; }
[DataMember]
public virtual string Message { get; set; }
[DataMember]
public virtual string StatusCode { get; set; }
[DataMember]
public virtual string VerboseMessage { get; set; }
}
[DataContract(Name="ApiRequestPerHour", Namespace="schemas.agentivity.com/types")]
public partial class ApiRequestPerHour
{
[DataMember(Order=10)]
public virtual DateTime RequestDate { get; set; }
[DataMember(Order=100)]
public virtual int Hour0 { get; set; }
[DataMember(Order=110)]
public virtual int Hour1 { get; set; }
[DataMember(Order=120)]
public virtual int Hour2 { get; set; }
[DataMember(Order=130)]
public virtual int Hour3 { get; set; }
[DataMember(Order=140)]
public virtual int Hour4 { get; set; }
[DataMember(Order=150)]
public virtual int Hour5 { get; set; }
[DataMember(Order=160)]
public virtual int Hour6 { get; set; }
[DataMember(Order=170)]
public virtual int Hour7 { get; set; }
[DataMember(Order=180)]
public virtual int Hour8 { get; set; }
[DataMember(Order=190)]
public virtual int Hour9 { get; set; }
[DataMember(Order=200)]
public virtual int Hour10 { get; set; }
[DataMember(Order=210)]
public virtual int Hour11 { get; set; }
[DataMember(Order=220)]
public virtual int Hour12 { get; set; }
[DataMember(Order=230)]
public virtual int Hour13 { get; set; }
[DataMember(Order=240)]
public virtual int Hour14 { get; set; }
[DataMember(Order=250)]
public virtual int Hour15 { get; set; }
[DataMember(Order=260)]
public virtual int Hour16 { get; set; }
[DataMember(Order=270)]
public virtual int Hour17 { get; set; }
[DataMember(Order=280)]
public virtual int Hour18 { get; set; }
[DataMember(Order=290)]
public virtual int Hour19 { get; set; }
[DataMember(Order=300)]
public virtual int Hour20 { get; set; }
[DataMember(Order=310)]
public virtual int Hour21 { get; set; }
[DataMember(Order=320)]
public virtual int Hour22 { get; set; }
[DataMember(Order=330)]
public virtual int Hour23 { get; set; }
}
[DataContract(Name="CacheMetadata", Namespace="schemas.agentivity.com/types")]
public partial class CacheMetadata
{
[DataMember(Order=1)]
public virtual DateTime CachedAt { get; set; }
[DataMember(Order=2)]
public virtual DateTime CacheExpiresAt { get; set; }
[DataMember(Order=0)]
public virtual bool IsFromCache { get; set; }
}
[DataContract(Name="CustomField", Namespace="schemas.agentivity.com/types")]
public partial class CustomFieldData
{
[DataMember(Order=20)]
public virtual string FieldName { get; set; }
[DataMember(Order=30)]
public virtual string FieldValue { get; set; }
}
public partial class CustomFieldsCollection
: List<CustomFieldData>
{
}
[DataContract(Namespace="schemas.agentivity.com/types")]
public partial class GetTicketCouponsByStatusCode
: CompanyLevelRequestBase, IRequestConsultantID
{
///<summary>
///Date in format YYYYMMDD
///</summary>
[DataMember]
public virtual string DateStart { get; set; }
///<summary>
///Date in format YYYYMMDD
///</summary>
[DataMember]
public virtual string DateEnd { get; set; }
///<summary>
///Travel agent ID
///</summary>
[DataMember]
public virtual string TravAgntID { get; set; }
///<summary>
///Comma Delimited List of Accounts
///</summary>
[DataMember]
public virtual string[] Account { get; set; }
///<summary>
///Comma Delimited List of PCCs
///</summary>
[DataMember]
public virtual string[] OwningAgencyLocationID { get; set; }
///<summary>
///Coupon code group ("ALL OPEN") or any Coupon Status eg USED, OPEN
///</summary>
[DataMember]
public virtual string CouponCodeGroup { get; set; }
///<summary>
///Date range type. A single character: I = Issue date, T = Travel date, E = Expiry date
///</summary>
[DataMember]
public virtual string DateTracker { get; set; }
///<summary>
///Repeat
///</summary>
[DataMember]
public virtual bool Repeat { get; set; }
///<summary>
///Lists only segments that are not active
///</summary>
[DataMember]
public virtual bool NoActiveSegments { get; set; }
///<summary>
///Include partial matches
///</summary>
[DataMember]
public virtual bool IncludePartialMatches { get; set; }
///<summary>
///Show Matching Coupons Only
///</summary>
[DataMember]
public virtual bool ShowMatchingCouponsOnly { get; set; }
///<summary>
///Pax surname
///</summary>
[DataMember]
public virtual string PaxSurname { get; set; }
///<summary>
///Two letter code for carrier
///</summary>
[DataMember]
public virtual string CarrierCode { get; set; }
///<summary>
///Comma delimited list of 3-character plating carriers
///</summary>
[DataMember]
public virtual string[] ExcludedPlatingCarrier { get; set; }
///<summary>
///Id of the owning consultant
///</summary>
[DataMember]
public virtual string OwningConsultantID { get; set; }
///<summary>
///Cache Guid
///</summary>
[DataMember]
public virtual string CacheGuid { get; set; }
///<summary>
///Agentivity Traveller GUID
///</summary>
[DataMember]
public virtual string TravellerGUID { get; set; }
///<summary>
///Request Consultant ID (sign on)
///</summary>
[DataMember]
public virtual string RequestConsultantID { get; set; }
[DataMember]
public virtual int CRMCode { get; set; }
[DataMember]
public virtual string CRMID { get; set; }
}
[DataContract(Name="Metadata", Namespace="schemas.agentivity.com/types")]
public partial class PagingMetadata
{
///<summary>
///Starting Record
///</summary>
[DataMember]
[ApiMember(DataType="string", Description="Starting Record", Name="Offset", ParameterType="query")]
public virtual string Offset { 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")]
public virtual string Limit { 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")]
public virtual int TotalRecords { 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")]
public virtual int ResponseRecords { get; set; }
}
[DataContract(Name="ResponseMetadata", Namespace="schemas.agentivity.com/types")]
public partial class ResponseMetadata
{
[DataMember(Order=0)]
public virtual bool Success { get; set; }
[DataMember(Order=1)]
public virtual bool HasCache { get; set; }
[DataMember(Order=2)]
public virtual bool HasPaging { get; set; }
[DataMember(Order=3, EmitDefaultValue=false)]
public virtual CacheMetadata CacheMetadata { get; set; }
[DataMember(Order=4, EmitDefaultValue=false)]
public virtual PagingMetadata PagingMetadata { get; set; }
}
[DataContract(Name="TicketCouponsByStatusCode", Namespace="schemas.agentivity.com/types")]
public partial class TicketCouponsByStatusCode
: IBookingIdentifier, ICustomFields
{
[DataMember(Order=5)]
public virtual string CompanyName { get; set; }
[DataMember(Order=10)]
public virtual string TktNumber { get; set; }
[DataMember(Order=20)]
public virtual string RN { get; set; }
[DataMember(Order=30)]
public virtual string AirTktSegId { get; set; }
[DataMember(Order=35)]
public virtual DateTime? VndIssueDt { get; set; }
[DataMember(Order=40)]
public virtual string RecordLocator { get; set; }
[DataMember(Order=45)]
public virtual string Passenger { get; set; }
[DataMember(Order=51)]
public virtual string TravAgntID { get; set; }
[DataMember(Order=60)]
public virtual string OwningConsultantID { get; set; }
[DataMember(Order=70)]
public virtual string FOPFare { get; set; }
[DataMember(Order=80)]
public virtual string BaseFare { get; set; }
[DataMember(Order=90)]
public virtual string FOP { get; set; }
[DataMember(Order=110)]
public virtual string TotalTax { get; set; }
[DataMember(Order=120)]
public virtual string Tax1Code { get; set; }
[DataMember(Order=130)]
public virtual string Tax1Amt { get; set; }
[DataMember(Order=140)]
public virtual string Tax2Code { get; set; }
[DataMember(Order=150)]
public virtual string Tax2Amt { get; set; }
[DataMember(Order=160)]
public virtual string Tax3Code { get; set; }
[DataMember(Order=170)]
public virtual string Tax3Amt { get; set; }
[DataMember(Order=180)]
public virtual string Tax4Code { get; set; }
[DataMember(Order=180)]
public virtual string Tax4Amt { get; set; }
[DataMember(Order=200)]
public virtual string Tax5Code { get; set; }
[DataMember(Order=210)]
public virtual string Tax5Amt { get; set; }
[DataMember(Order=220)]
public virtual string Account { get; set; }
[DataMember(Order=230)]
public virtual string ExchangedForTicket { get; set; }
[DataMember(Order=240)]
public virtual string CouponSequenceNbr { get; set; }
[DataMember(Order=250)]
public virtual string Carrier { get; set; }
[DataMember(Order=260)]
public virtual string BoardPoint { get; set; }
[DataMember(Order=270)]
public virtual string OffPoint { get; set; }
[DataMember(Order=280)]
public virtual DateTime? FlightDate { get; set; }
[DataMember(Order=290)]
public virtual string FlightServiceClass { get; set; }
[DataMember(Order=300)]
public virtual string FareBasis { get; set; }
[DataMember(Order=310)]
public virtual string FlightCouponStatus { get; set; }
[DataMember(Order=320)]
public virtual DateTime? DateLastChecked { get; set; }
[DataMember(Order=330)]
public virtual string PCC { get; set; }
[DataMember(Order=340)]
public virtual string AirlineCode { get; set; }
[DataMember(Order=500)]
public virtual string OwningCompanyCode { get; set; }
[DataMember(Order=510)]
public virtual string CreditCurrency { get; set; }
[DataMember(Order=520)]
public virtual decimal? CreditValue { get; set; }
[DataMember(Order=530)]
public virtual string FlightServiceClassName { get; set; }
[DataMember(Order=540)]
public virtual int? FlownKM { get; set; }
[DataMember(Order=550)]
public virtual string BAR { get; set; }
[DataMember(Order=560)]
public virtual DateTime? PNRCreationDate { get; set; }
[DataMember(Order=570)]
public virtual int AgentivityRef { get; set; }
[DataMember(Order=580)]
public virtual CustomFieldsCollection CustomFields { get; set; }
}
[DataContract(Name="AgentivityResponse", Namespace="schemas.agentivity.com/types")]
public partial class TicketCouponsByStatusCodeResponse
: CollectionResponse<TicketCouponsByStatusCode>
{
}
}
C# GetTicketCouponsByStatusCode DTOs
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
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/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":[{"CompanyName":"String","TktNumber":"String","RN":"String","AirTktSegId":"String","VndIssueDt":"\/Date(-62135596800000-0000)\/","RecordLocator":"String","Passenger":"String","TravAgntID":"String","OwningConsultantID":"String","FOPFare":"String","BaseFare":"String","FOP":"String","TotalTax":"String","Tax1Code":"String","Tax1Amt":"String","Tax2Code":"String","Tax2Amt":"String","Tax3Code":"String","Tax3Amt":"String","Tax4Code":"String","Tax4Amt":"String","Tax5Code":"String","Tax5Amt":"String","Account":"String","ExchangedForTicket":"String","CouponSequenceNbr":"String","Carrier":"String","BoardPoint":"String","OffPoint":"String","FlightDate":"\/Date(-62135596800000-0000)\/","FlightServiceClass":"String","FareBasis":"String","FlightCouponStatus":"String","DateLastChecked":"\/Date(-62135596800000-0000)\/","PCC":"String","AirlineCode":"String","OwningCompanyCode":"String","CreditCurrency":"String","CreditValue":0,"FlightServiceClassName":"String","FlownKM":0,"BAR":"String","PNRCreationDate":"\/Date(-62135596800000-0000)\/","AgentivityRef":0,"CustomFields":[{"FieldName":"String","FieldValue":"String"}]}],"ResponseError":{"ErrorCode":"String","Message":"String","StatusCode":"String","VerboseMessage":"String"}}