Agentivity API

<back to all web services

TicketCouponsIssued

The following routes are available for this service:
GET/TicketCouponsIssued
import 'package:servicestack/servicestack.dart';

// @DataContract(Name="Metadata", Namespace="schemas.agentivity.com/types")
class PagingMetadata implements IConvertible
{
    /**
    * Starting Record
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="Starting Record", Name="Offset", ParameterType="query")
    String? Offset;

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

    /**
    * 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")
    int? TotalRecords;

    /**
    * 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")
    int? ResponseRecords;

    PagingMetadata({this.Offset,this.Limit,this.TotalRecords,this.ResponseRecords});
    PagingMetadata.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Offset = json['Offset'];
        Limit = json['Limit'];
        TotalRecords = json['TotalRecords'];
        ResponseRecords = json['ResponseRecords'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Offset': Offset,
        'Limit': Limit,
        'TotalRecords': TotalRecords,
        'ResponseRecords': ResponseRecords
    };

    getTypeName() => "PagingMetadata";
    TypeContext? context = _ctx;
}

// @DataContract(Name="TicketCoupon", Namespace="schemas.agentivity.com/types")
class TicketCouponIssued implements IConvertible
{
    // @DataMember(Order=10)
    String? RecordLocator;

    // @DataMember(Order=20)
    DateTime? PNRCreationDate;

    // @DataMember(Order=30)
    String? TktNumber;

    // @DataMember(Order=40)
    String? Passenger;

    // @DataMember(Order=50)
    DateTime? VendorIssueDate;

    // @DataMember(Order=60)
    String? FOP;

    // @DataMember(Order=70)
    String? FOPCurrncy;

    // @DataMember(Order=80)
    String? FOPFare;

    // @DataMember(Order=90)
    String? CouponSequenceNbr;

    // @DataMember(Order=100)
    DateTime? FlightDate;

    // @DataMember(Order=110)
    String? Routing;

    // @DataMember(Order=120)
    String? FlightServiceClass;

    // @DataMember(Order=130)
    String? FareBasis;

    // @DataMember(Order=140)
    String? Carrier;

    // @DataMember(Order=150)
    String? Account;

    // @DataMember(Order=160)
    String? OwningAgencyLocationID;

    // @DataMember(Order=170)
    String? FlightCouponStatus;

    // @DataMember(Order=180)
    DateTime? DateLastChecked;

    // @DataMember(Order=190)
    String? OwningConsultantID;

    // @DataMember(Order=200)
    String? TicketingAgent;

    TicketCouponIssued({this.RecordLocator,this.PNRCreationDate,this.TktNumber,this.Passenger,this.VendorIssueDate,this.FOP,this.FOPCurrncy,this.FOPFare,this.CouponSequenceNbr,this.FlightDate,this.Routing,this.FlightServiceClass,this.FareBasis,this.Carrier,this.Account,this.OwningAgencyLocationID,this.FlightCouponStatus,this.DateLastChecked,this.OwningConsultantID,this.TicketingAgent});
    TicketCouponIssued.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        RecordLocator = json['RecordLocator'];
        PNRCreationDate = JsonConverters.fromJson(json['PNRCreationDate'],'DateTime',context!);
        TktNumber = json['TktNumber'];
        Passenger = json['Passenger'];
        VendorIssueDate = JsonConverters.fromJson(json['VendorIssueDate'],'DateTime',context!);
        FOP = json['FOP'];
        FOPCurrncy = json['FOPCurrncy'];
        FOPFare = json['FOPFare'];
        CouponSequenceNbr = json['CouponSequenceNbr'];
        FlightDate = JsonConverters.fromJson(json['FlightDate'],'DateTime',context!);
        Routing = json['Routing'];
        FlightServiceClass = json['FlightServiceClass'];
        FareBasis = json['FareBasis'];
        Carrier = json['Carrier'];
        Account = json['Account'];
        OwningAgencyLocationID = json['OwningAgencyLocationID'];
        FlightCouponStatus = json['FlightCouponStatus'];
        DateLastChecked = JsonConverters.fromJson(json['DateLastChecked'],'DateTime',context!);
        OwningConsultantID = json['OwningConsultantID'];
        TicketingAgent = json['TicketingAgent'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'RecordLocator': RecordLocator,
        'PNRCreationDate': JsonConverters.toJson(PNRCreationDate,'DateTime',context!),
        'TktNumber': TktNumber,
        'Passenger': Passenger,
        'VendorIssueDate': JsonConverters.toJson(VendorIssueDate,'DateTime',context!),
        'FOP': FOP,
        'FOPCurrncy': FOPCurrncy,
        'FOPFare': FOPFare,
        'CouponSequenceNbr': CouponSequenceNbr,
        'FlightDate': JsonConverters.toJson(FlightDate,'DateTime',context!),
        'Routing': Routing,
        'FlightServiceClass': FlightServiceClass,
        'FareBasis': FareBasis,
        'Carrier': Carrier,
        'Account': Account,
        'OwningAgencyLocationID': OwningAgencyLocationID,
        'FlightCouponStatus': FlightCouponStatus,
        'DateLastChecked': JsonConverters.toJson(DateLastChecked,'DateTime',context!),
        'OwningConsultantID': OwningConsultantID,
        'TicketingAgent': TicketingAgent
    };

    getTypeName() => "TicketCouponIssued";
    TypeContext? context = _ctx;
}

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

    Report({this.Item});
    Report.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Item = JsonConverters.fromJson(json['Item'],'TItem',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Item': JsonConverters.toJson(Item,'TItem',context!)
    };

    getTypeName() => "Report<$TItemResponse,$TItem>";
    TypeContext? context = _ctx;
}

// @DataContract(Name="TicketCouponIssued", Namespace="schemas.agentivity.com/types")
class TicketCouponsIssuedResponseReport extends Report<TicketCouponsIssuedItemResponse,TicketCouponIssued> implements IConvertible
{
    TicketCouponsIssuedResponseReport();
    TicketCouponsIssuedResponseReport.fromJson(Map<String, dynamic> json) : super.fromJson(json);
    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson();
    getTypeName() => "TicketCouponsIssuedResponseReport";
    TypeContext? context = _ctx;
}

// @DataContract(Name="CacheMetadata", Namespace="schemas.agentivity.com/types")
class CacheMetadata implements IConvertible
{
    // @DataMember(Order=1)
    DateTime? CachedAt;

    // @DataMember(Order=2)
    DateTime? CacheExpiresAt;

    // @DataMember(Order=0)
    bool? IsFromCache;

    CacheMetadata({this.CachedAt,this.CacheExpiresAt,this.IsFromCache});
    CacheMetadata.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        CachedAt = JsonConverters.fromJson(json['CachedAt'],'DateTime',context!);
        CacheExpiresAt = JsonConverters.fromJson(json['CacheExpiresAt'],'DateTime',context!);
        IsFromCache = json['IsFromCache'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'CachedAt': JsonConverters.toJson(CachedAt,'DateTime',context!),
        'CacheExpiresAt': JsonConverters.toJson(CacheExpiresAt,'DateTime',context!),
        'IsFromCache': IsFromCache
    };

    getTypeName() => "CacheMetadata";
    TypeContext? context = _ctx;
}

// @DataContract(Name="ResponseMetadata", Namespace="schemas.agentivity.com/types")
class ResponseMetadata implements IConvertible
{
    // @DataMember(Order=0)
    bool? Success;

    // @DataMember(Order=1)
    bool? HasCache;

    // @DataMember(Order=2)
    bool? HasPaging;

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

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

    ResponseMetadata({this.Success,this.HasCache,this.HasPaging,this.CacheMetadata,this.PagingMetadata});
    ResponseMetadata.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Success = json['Success'];
        HasCache = json['HasCache'];
        HasPaging = json['HasPaging'];
        CacheMetadata = JsonConverters.fromJson(json['CacheMetadata'],'CacheMetadata',context!);
        PagingMetadata = JsonConverters.fromJson(json['PagingMetadata'],'PagingMetadata',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Success': Success,
        'HasCache': HasCache,
        'HasPaging': HasPaging,
        'CacheMetadata': JsonConverters.toJson(CacheMetadata,'CacheMetadata',context!),
        'PagingMetadata': JsonConverters.toJson(PagingMetadata,'PagingMetadata',context!)
    };

    getTypeName() => "ResponseMetadata";
    TypeContext? context = _ctx;
}

// @DataContract(Name="ResponseMetadata", Namespace="schemas.agentivity.com/types")
class AgentivityError implements IConvertible
{
    // @DataMember
    String? ErrorCode;

    // @DataMember
    String? Message;

    // @DataMember
    String? StatusCode;

    // @DataMember
    String? VerboseMessage;

    AgentivityError({this.ErrorCode,this.Message,this.StatusCode,this.VerboseMessage});
    AgentivityError.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        ErrorCode = json['ErrorCode'];
        Message = json['Message'];
        StatusCode = json['StatusCode'];
        VerboseMessage = json['VerboseMessage'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'ErrorCode': ErrorCode,
        'Message': Message,
        'StatusCode': StatusCode,
        'VerboseMessage': VerboseMessage
    };

    getTypeName() => "AgentivityError";
    TypeContext? context = _ctx;
}

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

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

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

    ItemResponse({this.ResponseMetadata,this.ResponseReport,this.ResponseError});
    ItemResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        ResponseMetadata = JsonConverters.fromJson(json['ResponseMetadata'],'ResponseMetadata',context!);
        ResponseReport = JsonConverters.fromJson(json['ResponseReport'],'TReport',context!);
        ResponseError = JsonConverters.fromJson(json['ResponseError'],'AgentivityError',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'ResponseMetadata': JsonConverters.toJson(ResponseMetadata,'ResponseMetadata',context!),
        'ResponseReport': JsonConverters.toJson(ResponseReport,'TReport',context!),
        'ResponseError': JsonConverters.toJson(ResponseError,'AgentivityError',context!)
    };

    getTypeName() => "ItemResponse<$TItem,$TReport>";
    TypeContext? context = _ctx;
}

// @DataContract(Name="AgentivityResponse", Namespace="schemas.agentivity.com/types")
class TicketCouponsIssuedItemResponse extends ItemResponse<TicketCouponIssued,TicketCouponsIssuedResponseReport> implements IConvertible
{
    TicketCouponsIssuedItemResponse();
    TicketCouponsIssuedItemResponse.fromJson(Map<String, dynamic> json) : super.fromJson(json);
    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson();
    getTypeName() => "TicketCouponsIssuedItemResponse";
    TypeContext? context = _ctx;
}

// @DataContract(Namespace="schemas.agentivity.com/types")
class TicketCouponsIssued extends PagingMetadata implements IConvertible
{
    /**
    * Comma Delimited List of Accounts
    */
    // @DataMember
    List<String>? Account;

    /**
    * UserName in form of an email address
    */
    // @DataMember
    String? UserName;

    /**
    * Date in format YYYYMMDD
    */
    // @DataMember
    String? IssueDateStart;

    /**
    * Date in format YYYYMMDD
    */
    // @DataMember
    String? IssueDateEnd;

    /**
    * ID of a travel agent
    */
    // @DataMember
    String? TravelAgentID;

    /**
    * One letter code for flight coupon status
    */
    // @DataMember
    String? FlightCouponStatus;

    /**
    * Format style
    */
    // @DataMember
    String? FormatStyle;

    TicketCouponsIssued({this.Account,this.UserName,this.IssueDateStart,this.IssueDateEnd,this.TravelAgentID,this.FlightCouponStatus,this.FormatStyle});
    TicketCouponsIssued.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        Account = JsonConverters.fromJson(json['Account'],'List<String>',context!);
        UserName = json['UserName'];
        IssueDateStart = json['IssueDateStart'];
        IssueDateEnd = json['IssueDateEnd'];
        TravelAgentID = json['TravelAgentID'];
        FlightCouponStatus = json['FlightCouponStatus'];
        FormatStyle = json['FormatStyle'];
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'Account': JsonConverters.toJson(Account,'List<String>',context!),
        'UserName': UserName,
        'IssueDateStart': IssueDateStart,
        'IssueDateEnd': IssueDateEnd,
        'TravelAgentID': TravelAgentID,
        'FlightCouponStatus': FlightCouponStatus,
        'FormatStyle': FormatStyle
    });

    getTypeName() => "TicketCouponsIssued";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'api.agentivity.com', types: <String, TypeInfo> {
    'PagingMetadata': TypeInfo(TypeOf.Class, create:() => PagingMetadata()),
    'TicketCouponIssued': TypeInfo(TypeOf.Class, create:() => TicketCouponIssued()),
    'Report<TItemResponse,TItem>': TypeInfo(TypeOf.GenericDef,create:() => Report()),
    'TicketCouponsIssuedResponseReport': TypeInfo(TypeOf.Class, create:() => TicketCouponsIssuedResponseReport()),
    'CacheMetadata': TypeInfo(TypeOf.Class, create:() => CacheMetadata()),
    'ResponseMetadata': TypeInfo(TypeOf.Class, create:() => ResponseMetadata()),
    'AgentivityError': TypeInfo(TypeOf.Class, create:() => AgentivityError()),
    'ItemResponse<TItem,TReport>': TypeInfo(TypeOf.GenericDef,create:() => ItemResponse()),
    'TicketCouponsIssuedItemResponse': TypeInfo(TypeOf.Class, create:() => TicketCouponsIssuedItemResponse()),
    'TicketCouponsIssued': TypeInfo(TypeOf.Class, create:() => TicketCouponsIssued()),
});

Dart TicketCouponsIssued 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 /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"}}