Agentivity API

GetBookingsCreatedAndSegments

The following routes are available for this service:
All Verbs	/BookingsCreatedAndSegments

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

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

    CompanyLevelRequestBase({this.OwningCompanyCode,this.UserName});
    CompanyLevelRequestBase.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'OwningCompanyCode': JsonConverters.toJson(OwningCompanyCode,'List<String>',context!),
        'UserName': UserName
    });

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

// @DataContract(Namespace="schemas.agentivity.com/types")
class GetBookingsCreatedAndSegments extends CompanyLevelRequestBase implements IConvertible
{
    /**
    * Comma Delimited List of PCCs
    */
    // @DataMember
    List<String>? OwningAgencyLocationID;

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

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

    /**
    * When set to true, filters the results to only include air segments where the associated PNR has been ticketed. Other segments types are unaffected by this filter
    */
    // @DataMember
    bool? AirSegmentsMustBeTicketed;

    GetBookingsCreatedAndSegments({this.OwningAgencyLocationID,this.PNRCreationDateStart,this.PNRCreationDateEnd,this.AirSegmentsMustBeTicketed});
    GetBookingsCreatedAndSegments.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        OwningAgencyLocationID = JsonConverters.fromJson(json['OwningAgencyLocationID'],'List<String>',context!);
        PNRCreationDateStart = json['PNRCreationDateStart'];
        PNRCreationDateEnd = json['PNRCreationDateEnd'];
        AirSegmentsMustBeTicketed = json['AirSegmentsMustBeTicketed'];
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'OwningAgencyLocationID': JsonConverters.toJson(OwningAgencyLocationID,'List<String>',context!),
        'PNRCreationDateStart': PNRCreationDateStart,
        'PNRCreationDateEnd': PNRCreationDateEnd,
        'AirSegmentsMustBeTicketed': AirSegmentsMustBeTicketed
    });

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

TypeContext _ctx = TypeContext(library: 'apidemo.agentivity.com', types: <String, TypeInfo> {
    'PagingMetadata': TypeInfo(TypeOf.Class, create:() => PagingMetadata()),
    'CompanyLevelRequestBase': TypeInfo(TypeOf.AbstractClass),
    'GetBookingsCreatedAndSegments': TypeInfo(TypeOf.Class, create:() => GetBookingsCreatedAndSegments()),
});

Dart GetBookingsCreatedAndSegments 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

HTTP + JSON

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

POST /BookingsCreatedAndSegments HTTP/1.1 
Host: apidemo.agentivity.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"OwningAgencyLocationID":["String"],"PNRCreationDateStart":"String","PNRCreationDateEnd":"String","AirSegmentsMustBeTicketed":false,"OwningCompanyCode":["String"],"UserName":"String","Offset":"String","Limit":"String","TotalRecords":0,"ResponseRecords":0}