Agentivity API

<back to all web services

GetTicketsIssued

The following routes are available for this service:
GET/TicketsIssued

// @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(Namespace="schemas.agentivity.com/types")
export class CompanyLevelRequestBase extends PagingMetadata implements IMemberUsername, IMemberOwningCompanyCode
{
    /** @description Comma Delimited List of Owning Company Codes */
    // @DataMember
    public OwningCompanyCode: string[];

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    public constructor(init?: Partial<TicketsIssued>) { (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="TicketsIssuedByNumber", Namespace="schemas.agentivity.com/types")
export class TicketsIssuedByNumber
{
    // @DataMember(Order=10)
    public RecordLocator: string;

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

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

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

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

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

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

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

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

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

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

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

    public constructor(init?: Partial<TicketsIssuedByNumber>) { (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 CollectionResponse<TItem>
{
    // @DataMember(Order=1)
    public ResponseMetadata: ResponseMetadata;

    // @DataMember(Order=2, EmitDefaultValue=false)
    public ResponseReport: TicketsIssuedByNumber[];

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

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

// @DataContract(Name="AgentivityResponse", Namespace="schemas.agentivity.com/types")
export class TicketsIssuedResponse extends CollectionResponse<TicketsIssued>
{

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

// @DataContract(Namespace="schemas.agentivity.com/types")
export class GetTicketsIssued extends CompanyLevelRequestBase
{
    /** @description Date in format YYYYMMDD */
    // @DataMember
    public DateStart: string;

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

    /** @description IATA code */
    // @DataMember
    public IATA: string;

    /** @description Comma Delimited List of PCCs */
    // @DataMember
    public OwningAgencyLocationID: string[];

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

TypeScript GetTicketsIssued DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /TicketsIssued 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":[{"RecordLocator":"String","TktNumber":"String","FOP":"String","Passenger":"String","Consultant":"String","RemarkText":"String","AirlineCode":"String","TravAgntID":"String","PCC":"String","PrintedCurrency":"String","FOPFare":"String","Date":"\/Date(-62135596800000-0000)\/","DueDate":"\/Date(-62135596800000-0000)\/","TicketingAgentID":"String","TicketingAgent":"String"}],"ResponseError":{"ErrorCode":"String","Message":"String","StatusCode":"String","VerboseMessage":"String"}}