Agentivity API

<back to all web services

GetBookingsWithActiveSegments

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(Name="VendorLocator", Namespace="schemas.agentivity.com/types")
class BookingExtVendorLocator implements IBookingIdentifier, IConvertible
{
    // @DataMember(Order=10)
    String? CarrierCode;

    // @DataMember(Order=20)
    String? VendorLocator;

    BookingExtVendorLocator({this.CarrierCode,this.VendorLocator});
    BookingExtVendorLocator.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        CarrierCode = json['CarrierCode'];
        VendorLocator = json['VendorLocator'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'CarrierCode': CarrierCode,
        'VendorLocator': VendorLocator
    };

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

// @DataContract(Name="BookingWithActiveSegments", Namespace="schemas.agentivity.com/types")
class BookingWithActiveSegments implements IBookingIdentifier, ITicketNumbers, IVendorLocators, IConvertible
{
    // @DataMember(Order=10)
    int? AgentivityRef;

    // @DataMember(Order=20)
    String? RecordLocator;

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

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

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

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

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

    // @DataMember(Order=80)
    DateTime? TravelDate;

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

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

    // @DataMember(Order=100)
    String? EmailAddress;

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

    // @DataMember(Order=120)
    bool? HasAir;

    // @DataMember(Order=130)
    bool? HasHtl;

    // @DataMember(Order=140)
    bool? HasCar;

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

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

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

    // @DataMember(Order=180)
    String? FlightNumbers;

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

    // @DataMember(Order=200)
    List<String>? TicketNumbers;

    // @DataMember(Order=210)
    List<BookingExtVendorLocator>? VendorLocators;

    BookingWithActiveSegments({this.AgentivityRef,this.RecordLocator,this.PNRCreationDate,this.OwningAgencyLocationID,this.Account,this.OwningConsultantID,this.OwningConsultant,this.TravelDate,this.Passenger,this.PNRTicketed,this.EmailAddress,this.PhoneNbr,this.HasAir,this.HasHtl,this.HasCar,this.DestinationCities,this.Connections,this.CarrierCodes,this.FlightNumbers,this.IataCodes,this.TicketNumbers,this.VendorLocators});
    BookingWithActiveSegments.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        AgentivityRef = json['AgentivityRef'];
        RecordLocator = json['RecordLocator'];
        PNRCreationDate = JsonConverters.fromJson(json['PNRCreationDate'],'DateTime',context!);
        OwningAgencyLocationID = json['OwningAgencyLocationID'];
        Account = json['Account'];
        OwningConsultantID = json['OwningConsultantID'];
        OwningConsultant = json['OwningConsultant'];
        TravelDate = JsonConverters.fromJson(json['TravelDate'],'DateTime',context!);
        Passenger = json['Passenger'];
        PNRTicketed = json['PNRTicketed'];
        EmailAddress = json['EmailAddress'];
        PhoneNbr = json['PhoneNbr'];
        HasAir = json['HasAir'];
        HasHtl = json['HasHtl'];
        HasCar = json['HasCar'];
        DestinationCities = json['DestinationCities'];
        Connections = json['Connections'];
        CarrierCodes = json['CarrierCodes'];
        FlightNumbers = json['FlightNumbers'];
        IataCodes = json['IataCodes'];
        TicketNumbers = JsonConverters.fromJson(json['TicketNumbers'],'List<String>',context!);
        VendorLocators = JsonConverters.fromJson(json['VendorLocators'],'List<BookingExtVendorLocator>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'AgentivityRef': AgentivityRef,
        'RecordLocator': RecordLocator,
        'PNRCreationDate': JsonConverters.toJson(PNRCreationDate,'DateTime',context!),
        'OwningAgencyLocationID': OwningAgencyLocationID,
        'Account': Account,
        'OwningConsultantID': OwningConsultantID,
        'OwningConsultant': OwningConsultant,
        'TravelDate': JsonConverters.toJson(TravelDate,'DateTime',context!),
        'Passenger': Passenger,
        'PNRTicketed': PNRTicketed,
        'EmailAddress': EmailAddress,
        'PhoneNbr': PhoneNbr,
        'HasAir': HasAir,
        'HasHtl': HasHtl,
        'HasCar': HasCar,
        'DestinationCities': DestinationCities,
        'Connections': Connections,
        'CarrierCodes': CarrierCodes,
        'FlightNumbers': FlightNumbers,
        'IataCodes': IataCodes,
        'TicketNumbers': JsonConverters.toJson(TicketNumbers,'List<String>',context!),
        'VendorLocators': JsonConverters.toJson(VendorLocators,'List<BookingExtVendorLocator>',context!)
    };

    getTypeName() => "BookingWithActiveSegments";
    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="BookingWithActiveSegments", Namespace="schemas.agentivity.com/types")
class GetBookingsWithActiveSegmentsResponseReport extends Report<GetBookingsWithActiveSegmentsItemResponse,BookingWithActiveSegments> implements IConvertible
{
    GetBookingsWithActiveSegmentsResponseReport();
    GetBookingsWithActiveSegmentsResponseReport.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() => "GetBookingsWithActiveSegmentsResponseReport";
    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 GetBookingsWithActiveSegmentsItemResponse extends ItemResponse<BookingWithActiveSegments,GetBookingsWithActiveSegmentsResponseReport> implements IConvertible
{
    GetBookingsWithActiveSegmentsItemResponse();
    GetBookingsWithActiveSegmentsItemResponse.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() => "GetBookingsWithActiveSegmentsItemResponse";
    TypeContext? context = _ctx;
}

// @DataContract(Namespace="schemas.agentivity.com/types")
class GetBookingsWithActiveSegments extends CompanyLevelRequestBase implements IConvertible
{
    /**
    * Date in format YYYYMMDD
    */
    // @DataMember
    String? TravelDateStart;

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

    /**
    * All future date
    */
    // @DataMember
    bool? AllFutureDate;

    /**
    * Comma Delimited List of Accounts
    */
    // @DataMember
    List<String>? Account;

    GetBookingsWithActiveSegments({this.TravelDateStart,this.TravelDateEnd,this.AllFutureDate,this.Account});
    GetBookingsWithActiveSegments.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'TravelDateStart': TravelDateStart,
        'TravelDateEnd': TravelDateEnd,
        'AllFutureDate': AllFutureDate,
        'Account': JsonConverters.toJson(Account,'List<String>',context!)
    });

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

TypeContext _ctx = TypeContext(library: 'api.agentivity.com', types: <String, TypeInfo> {
    'PagingMetadata': TypeInfo(TypeOf.Class, create:() => PagingMetadata()),
    'CompanyLevelRequestBase': TypeInfo(TypeOf.AbstractClass),
    'BookingExtVendorLocator': TypeInfo(TypeOf.Class, create:() => BookingExtVendorLocator()),
    'BookingWithActiveSegments': TypeInfo(TypeOf.Class, create:() => BookingWithActiveSegments()),
    'List<BookingExtVendorLocator>': TypeInfo(TypeOf.Class, create:() => <BookingExtVendorLocator>[]),
    'Report<TItemResponse,TItem>': TypeInfo(TypeOf.GenericDef,create:() => Report()),
    'GetBookingsWithActiveSegmentsResponseReport': TypeInfo(TypeOf.Class, create:() => GetBookingsWithActiveSegmentsResponseReport()),
    '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()),
    'GetBookingsWithActiveSegmentsItemResponse': TypeInfo(TypeOf.Class, create:() => GetBookingsWithActiveSegmentsItemResponse()),
    'GetBookingsWithActiveSegments': TypeInfo(TypeOf.Class, create:() => GetBookingsWithActiveSegments()),
});

Dart GetBookingsWithActiveSegments DTOs

POST /BookingsWithActiveSegments HTTP/1.1 
Host: api.agentivity.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GetBookingsWithActiveSegments xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="schemas.agentivity.com/types">
  <Limit>String</Limit>
  <Offset>String</Offset>
  <ResponseRecords>0</ResponseRecords>
  <TotalRecords>0</TotalRecords>
  <OwningCompanyCode xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </OwningCompanyCode>
  <UserName>String</UserName>
  <Account xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Account>
  <AllFutureDate>false</AllFutureDate>
  <TravelDateEnd>String</TravelDateEnd>
  <TravelDateStart>String</TravelDateStart>
</GetBookingsWithActiveSegments>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<AgentivityResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="schemas.agentivity.com/types">
  <ResponseMetadata>
    <Success>false</Success>
    <HasCache>false</HasCache>
    <HasPaging>false</HasPaging>
    <CacheMetadata>
      <IsFromCache>false</IsFromCache>
      <CachedAt>0001-01-01T00:00:00</CachedAt>
      <CacheExpiresAt>0001-01-01T00:00:00</CacheExpiresAt>
    </CacheMetadata>
    <PagingMetadata>
      <Limit>String</Limit>
      <Offset>String</Offset>
      <ResponseRecords>0</ResponseRecords>
      <TotalRecords>0</TotalRecords>
    </PagingMetadata>
  </ResponseMetadata>
  <ResponseReport>
    <Item>
      <AgentivityRef>0</AgentivityRef>
      <RecordLocator>String</RecordLocator>
      <PNRCreationDate>0001-01-01T00:00:00</PNRCreationDate>
      <OwningAgencyLocationID>String</OwningAgencyLocationID>
      <Account>String</Account>
      <OwningConsultantID>String</OwningConsultantID>
      <OwningConsultant>String</OwningConsultant>
      <TravelDate>0001-01-01T00:00:00</TravelDate>
      <Passenger>String</Passenger>
      <PNRTicketed>String</PNRTicketed>
      <EmailAddress>String</EmailAddress>
      <PhoneNbr>String</PhoneNbr>
      <HasAir>false</HasAir>
      <HasHtl>false</HasHtl>
      <HasCar>false</HasCar>
      <DestinationCities>String</DestinationCities>
      <Connections>String</Connections>
      <CarrierCodes>String</CarrierCodes>
      <FlightNumbers>String</FlightNumbers>
      <IataCodes>String</IataCodes>
      <TicketNumbers xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </TicketNumbers>
      <VendorLocators>
        <VendorLocator>
          <CarrierCode>String</CarrierCode>
          <VendorLocator>String</VendorLocator>
        </VendorLocator>
      </VendorLocators>
    </Item>
  </ResponseReport>
  <ResponseError>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StatusCode>String</StatusCode>
    <VerboseMessage>String</VerboseMessage>
  </ResponseError>
</AgentivityResponse>