Agentivity API

<back to all web services

TicketCouponsIssued

// @DataContract(Name="Metadata", Namespace="schemas.agentivity.com/types")
export class PagingMetadata
{
    /** @description Starting Record */
    // @DataMember
    // @ApiMember(DataType="string", Description="Starting Record", Name="Offset", ParameterType="query")
    public Offset: string;

    /** @description Number of records to return (PageSize) */
    // @DataMember
    // @ApiMember(DataType="string", Description="Number of records to return (PageSize)", Name="Limit", ParameterType="query")
    public Limit: string;

    /** @description Total Number of Records in a Full Reponse (if no paging) */
    // @DataMember
    // @ApiMember(DataType="string", Description="Total Number of Records in a Full Reponse (if no paging)", Name="TotalRecords", ParameterType="query")
    public TotalRecords: number;

    /** @description Total Number of Records in this Reponse (on this page) */
    // @DataMember
    // @ApiMember(DataType="string", Description="Total Number of Records in this Reponse (on this page)", Name="ResponseRecords", ParameterType="query")
    public ResponseRecords: number;

    public constructor(init?: Partial<PagingMetadata>) { (Object as any).assign(this, init); }
}

// @DataContract(Name="TicketCoupon", Namespace="schemas.agentivity.com/types")
export class TicketCouponIssued
{
    // @DataMember(Order=10)
    public RecordLocator: string;

    // @DataMember(Order=20)
    public PNRCreationDate?: string;

    // @DataMember(Order=30)
    public TktNumber: string;

    // @DataMember(Order=40)
    public Passenger: string;

    // @DataMember(Order=50)
    public VendorIssueDate?: string;

    // @DataMember(Order=60)
    public FOP: string;

    // @DataMember(Order=70)
    public FOPCurrncy: string;

    // @DataMember(Order=80)
    public FOPFare: string;

    // @DataMember(Order=90)
    public CouponSequenceNbr: string;

    // @DataMember(Order=100)
    public FlightDate?: string;

    // @DataMember(Order=110)
    public Routing: string;

    // @DataMember(Order=120)
    public FlightServiceClass: string;

    // @DataMember(Order=130)
    public FareBasis: string;

    // @DataMember(Order=140)
    public Carrier: string;

    // @DataMember(Order=150)
    public Account: string;

    // @DataMember(Order=160)
    public OwningAgencyLocationID: string;

    // @DataMember(Order=170)
    public FlightCouponStatus: string;

    // @DataMember(Order=180)
    public DateLastChecked: string;

    // @DataMember(Order=190)
    public OwningConsultantID: string;

    // @DataMember(Order=200)
    public TicketingAgent: string;

    public constructor(init?: Partial<TicketCouponIssued>) { (Object as any).assign(this, init); }
}

// @DataContract(Namespace="schemas.agentivity.com/types")
export class Report<TItemResponse, TItem>
{
    // @DataMember(Order=1, EmitDefaultValue=false)
    public Item: TItem;

    public constructor(init?: Partial<Report<TItemResponse, TItem>>) { (Object as any).assign(this, init); }
}

// @DataContract(Name="TicketCouponIssued", Namespace="schemas.agentivity.com/types")
export class TicketCouponsIssuedResponseReport extends Report<TicketCouponsIssuedItemResponse, TicketCouponIssued>
{

    public constructor(init?: Partial<TicketCouponsIssuedResponseReport>) { super(init); (Object as any).assign(this, init); }
}

// @DataContract(Name="CacheMetadata", Namespace="schemas.agentivity.com/types")
export class CacheMetadata
{
    // @DataMember(Order=1)
    public CachedAt: string;

    // @DataMember(Order=2)
    public CacheExpiresAt: string;

    // @DataMember(Order=0)
    public IsFromCache: boolean;

    public constructor(init?: Partial<CacheMetadata>) { (Object as any).assign(this, init); }
}

// @DataContract(Name="ResponseMetadata", Namespace="schemas.agentivity.com/types")
export class ResponseMetadata
{
    // @DataMember(Order=0)
    public Success: boolean;

    // @DataMember(Order=1)
    public HasCache: boolean;

    // @DataMember(Order=2)
    public HasPaging: boolean;

    // @DataMember(Order=3, EmitDefaultValue=false)
    public CacheMetadata: CacheMetadata;

    // @DataMember(Order=4, EmitDefaultValue=false)
    public PagingMetadata: PagingMetadata;

    public constructor(init?: Partial<ResponseMetadata>) { (Object as any).assign(this, init); }
}

// @DataContract(Name="ResponseMetadata", Namespace="schemas.agentivity.com/types")
export class AgentivityError
{
    // @DataMember
    public ErrorCode: string;

    // @DataMember
    public Message: string;

    // @DataMember
    public StatusCode: string;

    // @DataMember
    public VerboseMessage: string;

    public constructor(init?: Partial<AgentivityError>) { (Object as any).assign(this, init); }
}

// @DataContract(Name="AgentivityResponse", Namespace="schemas.agentivity.com/types")
export class ItemResponse<TItem, TReport>
{
    // @DataMember(Order=1)
    public ResponseMetadata: ResponseMetadata;

    // @DataMember(Order=2, EmitDefaultValue=false)
    public ResponseReport: TReport;

    // @DataMember(Order=3, EmitDefaultValue=false)
    public ResponseError: AgentivityError;

    public constructor(init?: Partial<ItemResponse<TItem, TReport>>) { (Object as any).assign(this, init); }
}

// @DataContract(Name="AgentivityResponse", Namespace="schemas.agentivity.com/types")
export class TicketCouponsIssuedItemResponse extends ItemResponse<TicketCouponIssued, TicketCouponsIssuedResponseReport>
{

    public constructor(init?: Partial<TicketCouponsIssuedItemResponse>) { super(init); (Object as any).assign(this, init); }
}

// @DataContract(Namespace="schemas.agentivity.com/types")
export class TicketCouponsIssued extends PagingMetadata
{
    /** @description Comma Delimited List of Accounts */
    // @DataMember
    public Account: string[];

    /** @description UserName in form of an email address */
    // @DataMember
    public UserName: string;

    /** @description Date in format YYYYMMDD */
    // @DataMember
    public IssueDateStart: string;

    /** @description Date in format YYYYMMDD */
    // @DataMember
    public IssueDateEnd: string;

    /** @description ID of a travel agent */
    // @DataMember
    public TravelAgentID: string;

    /** @description One letter code for flight coupon status */
    // @DataMember
    public FlightCouponStatus: string;

    /** @description Format style */
    // @DataMember
    public FormatStyle: string;

    public constructor(init?: Partial<TicketCouponsIssued>) { super(init); (Object as any).assign(this, init); }
}

TypeScript TicketCouponsIssued DTOs

GET /TicketCouponsIssued HTTP/1.1 
Host: api.agentivity.com 
Accept: text/csv

HTTP/1.1 200 OK
Content-Type: text/csv
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":{"RecordLocator":"String","PNRCreationDate":"\/Date(-62135596800000-0000)\/","TktNumber":"String","Passenger":"String","VendorIssueDate":"\/Date(-62135596800000-0000)\/","FOP":"String","FOPCurrncy":"String","FOPFare":"String","CouponSequenceNbr":"String","FlightDate":"\/Date(-62135596800000-0000)\/","Routing":"String","FlightServiceClass":"String","FareBasis":"String","Carrier":"String","Account":"String","OwningAgencyLocationID":"String","FlightCouponStatus":"String","DateLastChecked":"\/Date(-62135596800000-0000)\/","OwningConsultantID":"String","TicketingAgent":"String"}},"ResponseError":{"ErrorCode":"String","Message":"String","StatusCode":"String","VerboseMessage":"String"}}