Agentivity API

<back to all web services

PassiveSegmentsByUser

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="PassiveSegmentWithOwningInformation", Namespace="schemas.agentivity.com/types")
class PassiveSegmentWithOwningInformation implements IConvertible
{
    // @DataMember
    int? AgentivityRef;

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

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

    // @DataMember
    String? OwningConsultantID;

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

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

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

    // @DataMember
    String? StartDate;

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

    // @DataMember
    String? NbrNights;

    // @DataMember
    String? VendorCode;

    // @DataMember
    String? CityCode;

    // @DataMember
    String? SegmentType;

    // @DataMember
    String? Text;

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

    // @DataMember
    String? Address;

    // @DataMember
    String? BookingReasonCode;

    // @DataMember
    String? BookingSource;

    // @DataMember
    String? CommissionInformation;

    // @DataMember
    String? ConfirmationNumber;

    // @DataMember
    String? RateCode;

    // @DataMember
    String? RateQuoted;

    // @DataMember
    String? RateAccessCode;

    // @DataMember
    String? PropertyName;

    // @DataMember
    String? PropertyNumber;

    // @DataMember
    String? ServiceInformation;

    // @DataMember
    String? TotalAirSegs;

    // @DataMember
    String? HotelCommission;

    // @DataMember
    String? CountryName;

    PassiveSegmentWithOwningInformation({this.AgentivityRef,this.OwningAgencyLocationID,this.RecordLocator,this.OwningConsultantID,this.OwningConsultant,this.Account,this.SegmentStatus,this.StartDate,this.DepartureDate,this.NbrNights,this.VendorCode,this.CityCode,this.SegmentType,this.Text,this.Passenger,this.Address,this.BookingReasonCode,this.BookingSource,this.CommissionInformation,this.ConfirmationNumber,this.RateCode,this.RateQuoted,this.RateAccessCode,this.PropertyName,this.PropertyNumber,this.ServiceInformation,this.TotalAirSegs,this.HotelCommission,this.CountryName});
    PassiveSegmentWithOwningInformation.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        AgentivityRef = json['AgentivityRef'];
        OwningAgencyLocationID = json['OwningAgencyLocationID'];
        RecordLocator = json['RecordLocator'];
        OwningConsultantID = json['OwningConsultantID'];
        OwningConsultant = json['OwningConsultant'];
        Account = json['Account'];
        SegmentStatus = json['SegmentStatus'];
        StartDate = json['StartDate'];
        DepartureDate = json['DepartureDate'];
        NbrNights = json['NbrNights'];
        VendorCode = json['VendorCode'];
        CityCode = json['CityCode'];
        SegmentType = json['SegmentType'];
        Text = json['Text'];
        Passenger = json['Passenger'];
        Address = json['Address'];
        BookingReasonCode = json['BookingReasonCode'];
        BookingSource = json['BookingSource'];
        CommissionInformation = json['CommissionInformation'];
        ConfirmationNumber = json['ConfirmationNumber'];
        RateCode = json['RateCode'];
        RateQuoted = json['RateQuoted'];
        RateAccessCode = json['RateAccessCode'];
        PropertyName = json['PropertyName'];
        PropertyNumber = json['PropertyNumber'];
        ServiceInformation = json['ServiceInformation'];
        TotalAirSegs = json['TotalAirSegs'];
        HotelCommission = json['HotelCommission'];
        CountryName = json['CountryName'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'AgentivityRef': AgentivityRef,
        'OwningAgencyLocationID': OwningAgencyLocationID,
        'RecordLocator': RecordLocator,
        'OwningConsultantID': OwningConsultantID,
        'OwningConsultant': OwningConsultant,
        'Account': Account,
        'SegmentStatus': SegmentStatus,
        'StartDate': StartDate,
        'DepartureDate': DepartureDate,
        'NbrNights': NbrNights,
        'VendorCode': VendorCode,
        'CityCode': CityCode,
        'SegmentType': SegmentType,
        'Text': Text,
        'Passenger': Passenger,
        'Address': Address,
        'BookingReasonCode': BookingReasonCode,
        'BookingSource': BookingSource,
        'CommissionInformation': CommissionInformation,
        'ConfirmationNumber': ConfirmationNumber,
        'RateCode': RateCode,
        'RateQuoted': RateQuoted,
        'RateAccessCode': RateAccessCode,
        'PropertyName': PropertyName,
        'PropertyNumber': PropertyNumber,
        'ServiceInformation': ServiceInformation,
        'TotalAirSegs': TotalAirSegs,
        'HotelCommission': HotelCommission,
        'CountryName': CountryName
    };

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

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

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

    /**
    * Type of segment
    */
    // @DataMember
    String? SegmentType;

    /**
    * Account
    */
    // @DataMember
    String? Account;

    /**
    * 3 letter city code
    */
    // @DataMember
    String? CityCode;

    /**
    * Date search type option, a single character (T to search by segment start dates, C to search by booking creation dates).
    */
    // @DataMember
    String? DateSearchType;

    PassiveSegmentsByUser({this.ArrivalDateEnd,this.ArrivalDateStart,this.SegmentType,this.Account,this.CityCode,this.DateSearchType});
    PassiveSegmentsByUser.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        ArrivalDateEnd = json['ArrivalDateEnd'];
        ArrivalDateStart = json['ArrivalDateStart'];
        SegmentType = json['SegmentType'];
        Account = json['Account'];
        CityCode = json['CityCode'];
        DateSearchType = json['DateSearchType'];
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'ArrivalDateEnd': ArrivalDateEnd,
        'ArrivalDateStart': ArrivalDateStart,
        'SegmentType': SegmentType,
        'Account': Account,
        'CityCode': CityCode,
        'DateSearchType': DateSearchType
    });

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

TypeContext _ctx = TypeContext(library: 'api.agentivity.com', types: <String, TypeInfo> {
    'PagingMetadata': TypeInfo(TypeOf.Class, create:() => PagingMetadata()),
    'CompanyLevelRequestBase': TypeInfo(TypeOf.AbstractClass),
    'PassiveSegmentWithOwningInformation': TypeInfo(TypeOf.Class, create:() => PassiveSegmentWithOwningInformation()),
    'Report<TItemResponse,TItem>': TypeInfo(TypeOf.GenericDef,create:() => Report()),
    'PassiveSegmentsByUserResponseReport': TypeInfo(TypeOf.Class, create:() => PassiveSegmentsByUserResponseReport()),
    '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()),
    'PassiveSegmentsResponse': TypeInfo(TypeOf.Class, create:() => PassiveSegmentsResponse()),
    'PassiveSegmentsByUser': TypeInfo(TypeOf.Class, create:() => PassiveSegmentsByUser()),
});

Dart PassiveSegmentsByUser DTOs

GET /PassiveSegments HTTP/1.1 
Host: api.agentivity.com 
Accept: application/xml

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>
      <Address>String</Address>
      <AgentivityRef>0</AgentivityRef>
      <BookingReasonCode>String</BookingReasonCode>
      <BookingSource>String</BookingSource>
      <CityCode>String</CityCode>
      <CommissionInformation>String</CommissionInformation>
      <ConfirmationNumber>String</ConfirmationNumber>
      <CountryName>String</CountryName>
      <HotelCommission>String</HotelCommission>
      <NbrNights>String</NbrNights>
      <OwningConsultantID>String</OwningConsultantID>
      <PropertyName>String</PropertyName>
      <PropertyNumber>String</PropertyNumber>
      <RateAccessCode>String</RateAccessCode>
      <RateCode>String</RateCode>
      <RateQuoted>String</RateQuoted>
      <SegmentType>String</SegmentType>
      <ServiceInformation>String</ServiceInformation>
      <StartDate>String</StartDate>
      <Text>String</Text>
      <TotalAirSegs>String</TotalAirSegs>
      <VendorCode>String</VendorCode>
      <RecordLocator>String</RecordLocator>
      <OwningAgencyLocationID>String</OwningAgencyLocationID>
      <OwningConsultant>String</OwningConsultant>
      <Account>String</Account>
      <Passenger>String</Passenger>
      <DepartureDate>String</DepartureDate>
      <SegmentStatus>String</SegmentStatus>
    </Item>
  </ResponseReport>
  <ResponseError>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StatusCode>String</StatusCode>
    <VerboseMessage>String</VerboseMessage>
  </ResponseError>
</AgentivityResponse>